search

jpatokal / mediawiki-gateway

Ruby framework for MediaWiki API manipulation
Other
133 stars 50 forks source link

Allow forcing of bot flag to false #94

Open MusikAnimal opened 8 years ago

MusikAnimal commented 8 years ago

The default settings for recent changes and watchlists usually hides bot edits, however sometimes bots may want to show up in these feeds but still retain the bot flag for other API operations (so as to not hit throttle limits, etc). Here we check if options[:bot] != false meaning it was explicitly passed in as false, as opposed to nil

MusikAnimal commented 8 years ago

Also shouldn't we bump the gem version, at least for my other recent PR that merged in?

jpatokal commented 8 years ago

I don't understand this change at all? @options[:bot]will return false for both "false" and "nil", so tagging options[:bot] != false && to the front makes no difference.

Going forward, please submit tests along with any changes you make to demonstrate that they actually do something.

MusikAnimal commented 8 years ago

Sorry, allow me to explain. First off @options are those set when you first instantiate MediaWiki::Gateway, correct? So in this use case I have @options[:bot] set to true as I don't want to hit throttles with the API, but I also don't want to edit as a bot. So in that case I'll never be able to pass in options[:bot] as false because it will see that @options[:bot] is true.

With this change it will see options[:bot] is false and short-circuit the if statement as false, never getting to the (@options[:bot] || options[:bot]) part. Otherwise if it's nil (developer didn't pass in a value) or true it will default to normal behaviour. Hopefully that makes sense.

Writing tests is my weakness... but I shall try!