Wielder of Anor

Checks a user's staged files for "forbidden" words (as determined by the user) and, if any are found, alerts the user to the locations of said words.

Longer Description

I am absent-minded. Very absent-minded. Absent-minded to the point that I'll throw some "puts" or "console.log" commands into my code for debugging purposes only to completely forget about them and then happily push all my code to master branch without a care in the world. This...is not okay. Yet despite my constant reminders to my brain that it most certainly is not okay, it keeps quite happily forgetting everything about everything when it's time to commit my code. And since I (apparently) can't magically fix the way my brain works, I figured I'd make my computer double-check me since, you know, that is the entire reason we invented computers to begin with. Enter Wielder of Anor.

Wielder of Anor is a quick and easy way to ensure that you aren't pushing your code to production (or anywhere else it shouldn't be) with "forbidden words" you don't want there. You yourself determine which words are forbidden, so this app should be helpful to anyone wanting to prevent certain text from making it past your dev environment. Maybe you're like me and you can never remember to pull your debugging commands out of your code before committing. Maybe you're a code master and commit swaths of code at a time, laughing at the mere mortals around you who commit smaller chunks of work several times a day, and you can't be bothered to check through your tens of thousands of lines of code to ensure you didn't leave some debugging command in there somewhere. Or maybe your code gets more and more filled with swear words the more frustrating a problem gets and you just can't let one of those slip to production again because seriously it'd be like the third or fourth time and you like working here and can't imagine staying here if you slip up another time or two and...

Ahem. Sorry.

So. If you need to prevent anything in your code from making it past your dev environment and need a reliable way to do this, use Wielder of Anor.

Installation

Installation is simple! Just run a gem install wielder_of_anor, then run wielder_of_anor and follow the instructions. You're now good to go!

Use/What It Does

To use Wielder of Anor, just run it from within the code directory you want to run the forbidden words checks against (this is important). From your code directory, just type wielder_of_anor followed by your arguments. You can pass in a couple of arguments here.

The first argument can be:

Your eventual commit message (in quotes), if you've chosen to allow Wielder of Anor itself to run your commits for you. If you've chosen to not allow it to run your commits for you, this argument will be ignored.
'help' - This will simply print out shorter versions of the options you are currently reading.
'config' - This will re-run the configuration process. IF YOU SET ANY OF YOUR FILE LOCATIONS TO POINT TO PREVIOUSLY EXISTING FILES, THOSE FILES WILL BE OVERWRITTEN.
'words' - This will spit out all of the forbidden words that you currently are checking for.

There is currently only one option for the second argument:

The second argument can only be '1' and will be ignored unless there is a commit message as the first argument. If this argument is passed, Wielder of Anor will skip checking for any forbidden words whatsoever and jump straight to the commit portion of the app. This is mainly here so that you can easily force a commit after Wielder of Anor tells you of some forbidden words that you've decided to allow for whatever reason. For instance, say 'puts' is one of your forbidden words and there's a commented-out puts statement in your code that you didn't put there and that, as such, you don't want to delete. It's the only forbidden word showing up, so the rest of your code is clean. So, instead of now having to type out a full git commit command, you can now just hit your up arrow, hit the spacebar, type a '1' and hit enter.

Once run, Wielder of Anor will run a bash command that'll export the result of a git diff HEAD --staged --name-only (so all files that you have 'git add'ed since git HEAD) to a file. It'll then check every line in every one of those files for any of your forbidden words and print out the locations of any and every one it finds.

If it found none (or if you've skipped the search and are forcing a commit), you are good to go and can tell the app to then run the git commit command, if you've opted to allow it to do so. At this point, Wielder of Anor will run a git commit -m followed by your commit message (your first argument when running the app). Once it prints out "COMMITTED.", execution will end. Don't forget to run your git push!

Wielder of Anor? Wut.

You know, the thing Gandalf calls himself to the Balrog as he's all "YOU SHALL NOT PASS!" over and over? When he's, you know, preventing the Balrog from getting past him? He...he prevents a forbidden thing from...

A gatekeeper. This app is a gatekeeper. Gandalf was a Gatekeeper that one time. It's artistic. Or something.

License

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.