wielder_of_anor 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0f08a4a73db94f9e44b7764c819655e2f14361c1
-  data.tar.gz: f504c95bc2412f9964f410a532df44a999b36571
+  metadata.gz: 47f95532e9ef0f162cee99d705e5ff57d76e603f
+  data.tar.gz: 19b253f236f65500cc08ed86a79b4292d2e7ad1c
 SHA512:
-  metadata.gz: 0451030755baf95f3303803b9f0be8c41950d85f2261c826000a4d22357dd9a7da9fe9463399abb3b75b1248119cde5ec50a50d5ebdeab0f88a1d0d4cca86b5f
-  data.tar.gz: 9dc546b61a21472022dad1c0d627096e036525ed583d78e4d95ce7ccad4019af3d2952474f2fdb38cb28581324b4121a29bfe2f08d917bbea75d5edda5aabef4
+  metadata.gz: cb7b6cdaeaf0762b20bdb52bf95d0129ff7b61060859f2b6872c8ba913c6bbc087777cf95ced720bdd2e2cf66ff4671711ca6d04034886d24ea14dc45b58caf4
+  data.tar.gz: f7aadde722183cd655b094feaee85aa976a24ad2bbdaa75eab375ddb5f3d05ec096d8eca3993f61a6057a1cf4fa9a0f913636fd0b3e7d2129c992f854218dd02

data/.gitignore

@@ -1,6 +1,6 @@
-docs/forbidden_words
-docs/files_changed
-config/config.yaml
-Gemfile.lock
-.idea
+docs/forbidden_words
+docs/files_changed
+config/config.yaml
+Gemfile.lock
+.idea
 .bundle

data/LICENSE.txt

@@ -1,21 +1,21 @@
-The MIT License (MIT)
-
-Copyright (c) 2016 iamsellek
-
-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.
+The MIT License (MIT)
+
+Copyright (c) 2016 iamsellek
+
+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.

data/README.md

@@ -1,115 +1,115 @@
-# 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)
-
-Copyright (c) 2016 Chris Sellek
-
-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
+# 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)
+
+Copyright (c) 2016 Chris Sellek
+
+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.

data/bin/wielder_of_anor

@@ -1,17 +1,17 @@
-#!/usr/bin/env ruby
-
-require 'wielder_of_anor'
-
-woa = WielderOfAnor::WielderOfAnor.new
-
-woa.help if ARGV[0] == 'help'
-
-woa.first_run if ARGV[0] == 'config'
-
-woa.output_forbidden_words if ARGV[0] == 'words'
-
-woa.add_forbidden_word(ARGV[1]) if ARGV[0] == 'add'
-
-woa.prepare(ARGV[0], ARGV[1])
-
-woa.wielder_of_anor
+#!/usr/bin/env ruby
+
+require 'wielder_of_anor'
+
+woa = WielderOfAnor::WielderOfAnor.new
+
+woa.help if ARGV[0] == 'help'
+
+woa.first_run if ARGV[0] == 'config'
+
+woa.output_forbidden_words if ARGV[0] == 'words'
+
+woa.add_forbidden_word(ARGV[1]) if ARGV[0] == 'add'
+
+woa.prepare(ARGV[0], ARGV[1])
+
+woa.wielder_of_anor

data/lib/wielder_of_anor.rb

@@ -1,383 +1,389 @@
-require 'shellwords'
-require 'yaml'
-require 'rainbow'
-require 'fileutils'
-
-require_relative 'wielder_of_anor/version'
-
-module WielderOfAnor
-  class WielderOfAnor
-    include WielderOfAnorVersion
-
-    def initialize
-      set_app_directory
-
-      @forbidden_words = []
-    end
-
-    ##############################################################################
-    ##############################################################################
-    ##                                                                          ##
-    ## commit_message is the git commit message the user would like to send     ##
-    ## once we have verified that there are no forbidden words present in their ##
-    ## code.                                                                    ##
-    ##                                                                          ##
-    ## force_commit is either '1' or nil. If it's 1, we will commit later even  ##
-    ## if there are forbidden words present.                                    ##
-    ##                                                                          ##
-    ##############################################################################
-    ##############################################################################
-
-    def prepare(commit_message, force_commit)
-      # If there's just one, it's the current version. Don't run if the current config is present.
-      restore_settings if Dir.glob("#{@app_directory.chomp("/wielder_of_anor-#{VERSION}")}/wielder_of_anor*").length > 1 &&
-                          !(File.exists?("#{@app_directory}/lib/config.yaml"))
-      first_run unless File.exists?("#{@app_directory}/lib/config.yaml")
-
-      config = YAML.load_file("#{@app_directory}/lib/config.yaml")
-      @commit_message = commit_message
-      @force_commit = force_commit
-      @current_directory = Dir.pwd
-      @files_changed_file_location = config['files_changed_file_location']
-      @commit_for_user = config['commit_for_user']
-
-      # Don't want to use a previous version.
-      File.delete(@files_changed_file_location) if File.exists?(@files_changed_file_location)
-
-      git_diff
-
-      @files_changed_file = File.open(@files_changed_file_location, "r")
-      @forbidden_words = config['forbidden_words']
-    end
-
-    def help
-      lines_pretty_print 'Wielder of Anor can accept up to two parameters on run. The first parameter can be:'
-
-      single_space
-
-      lines_pretty_print '- Your eventual commit message (in quotes). This is ignored if you have not allowed '\
-           'Wielder of Anor to commit for you.'
-      lines_pretty_print '- help - You should already know what this does :).'
-      lines_pretty_print '- config - Re-runs the initial set up.'
-
-      single_space
-
-      lines_pretty_print 'And your second parameter can only be \'1\', and it\'ll be ignored unless all of the '\
-                         'following is true:'
-
-      single_space
-
-      lines_pretty_print '- You have allowed Wielder of Anor to run commits for you.'
-      lines_pretty_print '- Your first parameter is your commit message.'
-
-      abort
-    end
-
-    def output_forbidden_words
-      set_app_directory
-      config = YAML.load_file("#{@app_directory}/lib/config.yaml")
-
-      unless config && config['forbidden_words']
-        lines_pretty_print Rainbow('You have yet to set your forbidden words! Please run the app with the parameter '\
-                                   '\'config\' to set up your configurations and forbidden words.').red
-
-        abort
-      end
-
-      lines_pretty_print Rainbow('Your forbidden words are:').yellow
-
-      single_space
-
-      config['forbidden_words'].each do |word|
-        lines_pretty_print Rainbow(word).yellow
-      end
-
-      single_space
-
-      abort
-    end
-
-    # Attempt to restore settings from previous version.
-    def restore_settings
-      lines_pretty_print 'I see that you have a previous wielder_of_anor installation on this machine.'
-      lines_pretty_print Rainbow('Would you like to restore its settings?').yellow
-
-      answered = false
-
-      until answered
-        answer = STDIN.gets.strip!
-
-        single_space
-
-        if answer == 'yes' || answer == 'y' || answer == 'no' || answer == 'n'
-          answered = true
-        else
-          lines_pretty_print Rainbow('Please input either \'yes\' or \'no\'.').yellow
-        end
-      end
-
-      return if answer == 'no' || answer == 'n'
-
-      lines_pretty_print 'One moment, please.'
-
-      single_space
-
-      all_gems = Dir.glob("#{@app_directory.chomp("/wielder_of_anor-#{VERSION}")}/wielder_of_anor*")
-
-      # glob orders things in the array alphabetically, so the second-to-last one in the array is the
-      # most recent version that is not the current version.
-      previous_config_file = "#{all_gems[-2]}/lib/config.yaml"
-      FileUtils.copy_file(previous_config_file, "#{@app_directory}/lib/config.yaml")
-
-      lines_pretty_print 'Done! Please run me again when you\'re ready.'
-
-      abort
-    end
-
-    def first_run
-      lines_pretty_print 'Thanks for downloading Wielder of Anor! Let\'s run through the '\
-           'initial setup!'
-
-      STDIN.gets
-
-      files_changed_file_location = "#{@app_directory}/lib/files_changed"
-
-      commit_for_user = set_commit_for_user
-
-      single_space
-
-      forbidden_words = set_forbidden_words
-
-      set_configs(files_changed_file_location, forbidden_words, commit_for_user)
-    end
-
-    def set_commit_for_user
-      lines_pretty_print 'Would you like Wielder of Anor to run your commits for you once you'\
-           ' have verified that your code is free of forbidden words?'
-      lines_pretty_print Rainbow('(Type \'yes\' or \'no\'. Just hitting enter defaults to no.)').yellow
-
-      commit_for_user = STDIN.gets.strip!.downcase
-      commit_for_user = 'no' if commit_for_user == ''
-
-      until commit_for_user == 'yes' || commit_for_user =='y' || commit_for_user == 'no' || commit_for_user == 'n' do
-        lines_pretty_print Rainbow('Please type either \'yes\' or \'no\'.').yellow
-        commit_for_user = STDIN.gets.strip!.downcase
-      end
-
-      commit_for_user
-    end
-
-    def set_configs(files_changed_file_location, forbidden_words, commit_for_user)
-      config = {}
-      config['files_changed_file_location'] = files_changed_file_location
-
-      if commit_for_user == 'yes' || commit_for_user == 'y'
-        config['commit_for_user'] = true
-      else
-        config['commit_for_user'] = false
-      end
-
-      config['forbidden_words'] = forbidden_words
-
-      file = File.open("#{@app_directory}/lib/config.yaml", 'w')
-      YAML.dump(config, file)
-      file.close
-
-      lines_pretty_print 'And with that, we\'re done! Feel free to run Wielder of Anor again if'\
-           ' you\'d like to check your code now!'
-
-      abort
-    end
-
-    def set_forbidden_words
-      forbidden_words = []
-
-      done = false
-
-      lines_pretty_print 'Great! Now that we\'re done with the files, let\'s add your forbidden '\
-                         'words from here!'
-      single_space
-
-      until done do
-        lines_pretty_print Rainbow('Enter a forbidden word and hit enter. If you are done entering '\
-                           'forbidden words, type \'x211\' and hit enter instead.').yellow unless forbidden_words.count > 0
-
-        lines_pretty_print Rainbow('Added! Enter another forbidden word and hit enter. If you are done '\
-                                   'entering forbidden words, type \'x211\' and hit enter instead.').yellow unless forbidden_words.count == 0
-        word = STDIN.gets.strip!
-
-        single_space
-
-        if word == 'x211'
-          done = true
-        else
-          forbidden_words << word
-        end
-      end
-
-      forbidden_words
-    end
-
-    def git_diff
-      bash("git diff HEAD --name-only --staged > #{@files_changed_file_location}")
-    end
-
-    def add_forbidden_word(word)
-      set_app_directory
-      config_yaml = YAML.load_file("#{@app_directory}/lib/config.yaml")
-      config_file = File.open("#{@app_directory}/lib/config.yaml", 'w')
-
-      if word.nil?
-        lines_pretty_print Rainbow('Please submit your word as a second parameter.').red
-
-        abort
-      end
-
-      if config_yaml['forbidden_words'].include?(word)
-        lines_pretty_print Rainbow("''#{word}'' is already a forbidden word!").red
-
-        abort
-      end
-
-      config_yaml['forbidden_words'] << word
-
-      YAML.dump(config_yaml, config_file)
-
-      lines_pretty_print 'Added!'
-
-      abort
-    end
-
-    def wielder_of_anor
-      found_forbidden = false
-      count = File.foreach(@files_changed_file).inject(0) {|c, line| c+1}
-
-      if count == 0
-        single_space
-
-        lines_pretty_print Rainbow('No files have been added. Please use the git add command to add files to your '\
-                             'commit.').red
-
-        single_space
-
-        abort
-      end
-
-      # If we're forcing the commit, don't bother checking for forbidden words.
-      unless @force_commit
-        single_space
-
-        print_header_footer
-
-        single_space
-
-        @files_changed_file.each_line do |files_changed_line|
-          code_file = File.open("#{@current_directory}/#{files_changed_line.strip}", "r")
-          index = 0
-
-          code_file.each_line do |line|
-            index += 1
-            @forbidden_words.each do |word|
-              if line.include?(word)
-                found_forbidden = true
-                lines_pretty_print Rainbow("-- FORBIDDEN WORD FOUND ON LINE #{index} IN #{files_changed_line.strip}: --").red
-                lines_pretty_print Rainbow("   #{line}").yellow
-                double_space
-              end
-            end
-          end
-
-          code_file.close
-        end
-
-        single_space
-
-        print_header_footer
-
-        single_space
-      else
-        lines_pretty_print Rainbow('NOT SEARCHING FOR FORBIDDEN WORDS, PER USER INPUT.').red
-        single_space
-      end
-
-      @files_changed_file.close
-
-      results(found_forbidden)
-    end
-
-    def results(found_forbidden)
-      if found_forbidden
-        single_space
-        lines_pretty_print 'Remove offending line(s) and re-run commit statement or run this '\
-                           'app again with \'1\' as your second argument to force the commit.'
-
-        single_space
-        lines_pretty_print Rainbow('**ONLY FORCE THE COMMIT IF YOU ARE SURE YOU ARE 100% SURE YOU WANT '\
-                                   'TO COMMIT THE ABOVE LINES TO YOUR BRANCH!!**').red
-        File.delete(@files_changed_file)
-        abort
-      else
-        unless @force_commit
-          lines_pretty_print Rainbow('Found 0 forbidden words!').green
-
-          single_space
-        end
-
-        File.delete(@files_changed_file)
-        commit if @commit_for_user
-      end
-    end
-
-    def print_header_footer
-      puts '***************************************************************************'
-    end
-
-    def commit
-      if @force_commit
-        lines_pretty_print 'Skipped checking for forbidden words. Ready to commit now?'
-        lines_pretty_print Rainbow('**WARNING: YOU ARE FORCING THE COMMIT WITHOUT CHECKING FOR FORBIDDEN WORDS.**').red
-
-        single_space
-      else
-        lines_pretty_print 'Okay to commit! Should I go ahead and run the actual commit now?'
-      end
-
-      lines_pretty_print 'Please type \'yes\' OR \'y\' to continue. Any other input will be treated as a \'no\'.'
-
-      input = STDIN.gets.chomp.downcase
-
-      single_space
-
-      if input == 'yes' || input == 'y'
-        bash(%Q[git commit -m "#{@commit_message}"])
-        single_space
-        lines_pretty_print 'Committed.'
-        single_space
-      end
-    end
-
-    def bash(command)
-      # Dir.chdir ensures all bash commands are being run from the correct
-      # directory.
-      Dir.chdir(@current_directory) { system "#{command}" }
-    end
-
-    def set_app_directory
-      @app_directory = File.expand_path(File.dirname(__FILE__)).chomp('/lib')
-    end
-
-    def lines_pretty_print(string)
-      lines = string.scan(/\S.{0,70}\S(?=\s|$)|\S+/)
-
-      lines.each { |line| puts line }
-    end
-
-    def single_space
-      puts ''
-    end
-
-    def double_space
-      puts "\n\n"
-    end
-  end
+require 'shellwords'
+require 'yaml'
+require 'rainbow'
+require 'fileutils'
+
+require_relative 'wielder_of_anor/version'
+
+module WielderOfAnor
+  class WielderOfAnor
+    include WielderOfAnorVersion
+
+    def initialize
+      set_app_directory
+
+      @forbidden_words = []
+    end
+
+    ##############################################################################
+    ##############################################################################
+    ##                                                                          ##
+    ## commit_message is the git commit message the user would like to send     ##
+    ## once we have verified that there are no forbidden words present in their ##
+    ## code.                                                                    ##
+    ##                                                                          ##
+    ## force_commit is either '1' or nil. If it's 1, we will commit later even  ##
+    ## if there are forbidden words present.                                    ##
+    ##                                                                          ##
+    ##############################################################################
+    ##############################################################################
+
+    def prepare(commit_message, force_commit)
+      # If there's just one, it's the current version. Don't run if the current config is present.
+      restore_settings if Dir.glob("#{@app_directory.chomp("/wielder_of_anor-#{VERSION}")}/wielder_of_anor*").length > 1 &&
+                          !(File.exists?("#{@app_directory}/lib/config.yaml"))
+      first_run unless File.exists?("#{@app_directory}/lib/config.yaml")
+
+      config = YAML.load_file("#{@app_directory}/lib/config.yaml")
+      @commit_message = commit_message
+      @force_commit = force_commit
+      @current_directory = Dir.pwd
+      @files_changed_file_location = config['files_changed_file_location']
+      @commit_for_user = config['commit_for_user']
+
+      # Don't want to use a previous version.
+      File.delete(@files_changed_file_location) if File.exists?(@files_changed_file_location)
+
+      git_diff
+
+      @files_changed_file = File.open(@files_changed_file_location, "r")
+      @forbidden_words = config['forbidden_words']
+    end
+
+    def help
+      lines_pretty_print 'Wielder of Anor can accept up to two parameters on run. The first parameter can be:'
+
+      single_space
+
+      lines_pretty_print '- Your eventual commit message (in quotes). This is ignored if you have not allowed '\
+           'Wielder of Anor to commit for you.'
+      lines_pretty_print '- help - You should already know what this does :).'
+      lines_pretty_print '- config - Re-runs the initial set up.'
+
+      single_space
+
+      lines_pretty_print 'And your second parameter can only be \'1\', and it\'ll be ignored unless all of the '\
+                         'following is true:'
+
+      single_space
+
+      lines_pretty_print '- You have allowed Wielder of Anor to run commits for you.'
+      lines_pretty_print '- Your first parameter is your commit message.'
+
+      abort
+    end
+
+    def output_forbidden_words
+      set_app_directory
+      config = YAML.load_file("#{@app_directory}/lib/config.yaml")
+
+      unless config && config['forbidden_words']
+        lines_pretty_print Rainbow('You have yet to set your forbidden words! Please run the app with the parameter '\
+                                   '\'config\' to set up your configurations and forbidden words.').red
+
+        abort
+      end
+
+      lines_pretty_print Rainbow('Your forbidden words are:').yellow
+
+      single_space
+
+      config['forbidden_words'].each do |word|
+        lines_pretty_print Rainbow(word).yellow
+      end
+
+      single_space
+
+      abort
+    end
+
+    # Attempt to restore settings from previous version.
+    def restore_settings
+      lines_pretty_print 'I see that you have a previous wielder_of_anor installation on this machine.'
+      lines_pretty_print Rainbow('Would you like to restore its settings?').yellow
+
+      answered = false
+
+      until answered
+        answer = STDIN.gets.strip!
+
+        single_space
+
+        if answer == 'yes' || answer == 'y' || answer == 'no' || answer == 'n'
+          answered = true
+        else
+          lines_pretty_print Rainbow('Please input either \'yes\' or \'no\'.').yellow
+        end
+      end
+
+      return if answer == 'no' || answer == 'n'
+
+      lines_pretty_print 'One moment, please.'
+
+      single_space
+
+      all_gems = Dir.glob("#{@app_directory.chomp("/wielder_of_anor-#{VERSION}")}/wielder_of_anor*")
+
+      # glob orders things in the array alphabetically, so the second-to-last one in the array is the
+      # most recent version that is not the current version.
+      previous_config_file = "#{all_gems[-2]}/lib/config.yaml"
+      config = YAML.load_file(previous_config_file)
+      new_config_file = File.open("#{@app_directory}/lib/config.yaml", 'w')
+
+      YAML.dump(config, new_config_file)
+      new_config_file.close
+
+      lines_pretty_print 'Done! Please run me again when you\'re ready.'
+
+      abort
+    end
+
+    def first_run
+      lines_pretty_print 'Thanks for downloading Wielder of Anor! Let\'s run through the '\
+           'initial setup!'
+
+      STDIN.gets
+
+      files_changed_file_location = "#{@app_directory}/lib/files_changed"
+
+      commit_for_user = set_commit_for_user
+
+      single_space
+
+      forbidden_words = set_forbidden_words
+
+      set_configs(files_changed_file_location, forbidden_words, commit_for_user)
+    end
+
+    def set_commit_for_user
+      lines_pretty_print 'Would you like Wielder of Anor to run your commits for you once you'\
+           ' have verified that your code is free of forbidden words?'
+      lines_pretty_print Rainbow('(Type \'yes\' or \'no\'. Just hitting enter defaults to no.)').yellow
+
+      commit_for_user = STDIN.gets.strip!.downcase
+      commit_for_user = 'no' if commit_for_user == ''
+
+      until commit_for_user == 'yes' || commit_for_user =='y' || commit_for_user == 'no' || commit_for_user == 'n' do
+        lines_pretty_print Rainbow('Please type either \'yes\' or \'no\'.').yellow
+        commit_for_user = STDIN.gets.strip!.downcase
+      end
+
+      commit_for_user
+    end
+
+    def set_configs(files_changed_file_location, forbidden_words, commit_for_user)
+      config = {}
+      config['files_changed_file_location'] = files_changed_file_location
+
+      if commit_for_user == 'yes' || commit_for_user == 'y'
+        config['commit_for_user'] = true
+      else
+        config['commit_for_user'] = false
+      end
+
+      config['forbidden_words'] = forbidden_words
+
+      file = File.open("#{@app_directory}/lib/config.yaml", 'w')
+      YAML.dump(config, file)
+      file.close
+
+      lines_pretty_print 'And with that, we\'re done! Feel free to run Wielder of Anor again if'\
+           ' you\'d like to check your code now!'
+
+      abort
+    end
+
+    def set_forbidden_words
+      forbidden_words = []
+
+      done = false
+
+      lines_pretty_print 'Great! Now that we\'re done with the files, let\'s add your forbidden '\
+                         'words from here!'
+      single_space
+
+      until done do
+        lines_pretty_print Rainbow('Enter a forbidden word and hit enter. If you are done entering '\
+                           'forbidden words, type \'x211\' and hit enter instead.').yellow unless forbidden_words.count > 0
+
+        lines_pretty_print Rainbow('Added! Enter another forbidden word and hit enter. If you are done '\
+                                   'entering forbidden words, type \'x211\' and hit enter instead.').yellow unless forbidden_words.count == 0
+        word = STDIN.gets.strip!
+
+        single_space
+
+        if word == 'x211'
+          done = true
+        else
+          forbidden_words << word
+        end
+      end
+
+      forbidden_words
+    end
+
+    def git_diff
+      bash("git diff HEAD --name-only --staged > #{@files_changed_file_location}")
+    end
+
+    def add_forbidden_word(word)
+      set_app_directory
+      config_yaml = YAML.load_file("#{@app_directory}/lib/config.yaml")
+      config_file = File.open("#{@app_directory}/lib/config.yaml", 'w')
+
+      if word.nil?
+        lines_pretty_print Rainbow('Please submit your word as a second parameter.').red
+
+        abort
+      end
+
+      if config_yaml['forbidden_words'].include?(word)
+        lines_pretty_print Rainbow("''#{word}'' is already a forbidden word!").red
+
+        abort
+      end
+
+      config_yaml['forbidden_words'] << word
+
+      YAML.dump(config_yaml, config_file)
+
+      lines_pretty_print 'Added!'
+
+      abort
+    end
+
+    def wielder_of_anor
+      found_forbidden = false
+      count = File.foreach(@files_changed_file).inject(0) {|c, line| c+1}
+
+      if count == 0
+        single_space
+
+        lines_pretty_print Rainbow('No files have been added. Please use the git add command to add files to your '\
+                             'commit.').red
+
+        single_space
+
+        abort
+      end
+
+      # If we're forcing the commit, don't bother checking for forbidden words.
+      unless @force_commit
+        single_space
+
+        print_header_footer
+
+        single_space
+
+        @files_changed_file.each_line do |files_changed_line|
+          file_path = "#{@current_directory}/#{files_changed_line.strip}"
+          code_file = File.open(file_path, "r") if File.exists?(file_path)
+          index = 0
+          next unless code_file
+
+          code_file.each_line do |line|
+            index += 1
+            @forbidden_words.each do |word|
+              if line.include?(word)
+                found_forbidden = true
+                lines_pretty_print Rainbow("-- FORBIDDEN WORD FOUND ON LINE #{index} IN #{files_changed_line.strip}: --").red
+                lines_pretty_print Rainbow("   #{line}").yellow
+                double_space
+              end
+            end
+          end
+
+          code_file.close
+        end
+
+        single_space
+
+        print_header_footer
+
+        single_space
+      else
+        lines_pretty_print Rainbow('NOT SEARCHING FOR FORBIDDEN WORDS, PER USER INPUT.').red
+        single_space
+      end
+
+      @files_changed_file.close
+
+      results(found_forbidden)
+    end
+
+    def results(found_forbidden)
+      if found_forbidden
+        single_space
+        lines_pretty_print 'Remove offending line(s) and re-run commit statement or run this '\
+                           'app again with \'1\' as your second argument to force the commit.'
+
+        single_space
+        lines_pretty_print Rainbow('**ONLY FORCE THE COMMIT IF YOU ARE SURE YOU ARE 100% SURE YOU WANT '\
+                                   'TO COMMIT THE ABOVE LINES TO YOUR BRANCH!!**').red
+        File.delete(@files_changed_file)
+        abort
+      else
+        unless @force_commit
+          lines_pretty_print Rainbow('Found 0 forbidden words!').green
+
+          single_space
+        end
+
+        File.delete(@files_changed_file)
+        commit if @commit_for_user
+      end
+    end
+
+    def print_header_footer
+      puts '***************************************************************************'
+    end
+
+    def commit
+      if @force_commit
+        lines_pretty_print 'Skipped checking for forbidden words. Ready to commit now?'
+        lines_pretty_print Rainbow('**WARNING: YOU ARE FORCING THE COMMIT WITHOUT CHECKING FOR FORBIDDEN WORDS.**').red
+
+        single_space
+      else
+        lines_pretty_print 'Okay to commit! Should I go ahead and run the actual commit now?'
+      end
+
+      lines_pretty_print 'Please type \'yes\' OR \'y\' to continue. Any other input will be treated as a \'no\'.'
+
+      input = STDIN.gets.chomp.downcase
+
+      single_space
+
+      if input == 'yes' || input == 'y'
+        bash(%Q[git commit -m "#{@commit_message}"])
+        single_space
+        lines_pretty_print 'Committed.'
+        single_space
+      end
+    end
+
+    def bash(command)
+      # Dir.chdir ensures all bash commands are being run from the correct
+      # directory.
+      Dir.chdir(@current_directory) { system "#{command}" }
+    end
+
+    def set_app_directory
+      @app_directory = File.expand_path(File.dirname(__FILE__)).chomp('/lib')
+    end
+
+    def lines_pretty_print(string)
+      lines = string.scan(/\S.{0,70}\S(?=\s|$)|\S+/)
+
+      lines.each { |line| puts line }
+    end
+
+    def single_space
+      puts ''
+    end
+
+    def double_space
+      puts "\n\n"
+    end
+  end
 end

data/lib/wielder_of_anor/version.rb

@@ -1,3 +1,3 @@
-module WielderOfAnorVersion
-  VERSION = "0.3.2"
+module WielderOfAnorVersion
+  VERSION = "0.4.0"
 end

data/wielder_of_anor.gemspec

@@ -1,27 +1,27 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'wielder_of_anor/version'
-
-Gem::Specification.new do |spec|
-  spec.name           = 'wielder_of_anor'
-  spec.version        = WielderOfAnorVersion::VERSION
-  spec.authors        = ['Chris Sellek']
-  spec.email          = ['iamsellek@gmail.com']
-
-  spec.summary        = '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.'
-  spec.description    = 'See GitHub page for longer description.'
-  spec.homepage       = 'https://github.com/iamsellek/wielder_of_anor'
-  spec.license        = 'MIT'
-
-  spec.files          = `git ls-files`.split($/)
-  spec.executables    = ['wielder_of_anor']
-  spec.test_files     = []
-  spec.require_paths  = ['lib']
-
-  spec.add_dependency 'rainbow'
-
-  spec.add_development_dependency 'bundler', '~> 1.12'
-  spec.add_development_dependency 'rake', '~> 10.0'
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'wielder_of_anor/version'
+
+Gem::Specification.new do |spec|
+  spec.name           = 'wielder_of_anor'
+  spec.version        = WielderOfAnorVersion::VERSION
+  spec.authors        = ['Chris Sellek']
+  spec.email          = ['iamsellek@gmail.com']
+
+  spec.summary        = '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.'
+  spec.description    = 'See GitHub page for longer description.'
+  spec.homepage       = 'https://github.com/iamsellek/wielder_of_anor'
+  spec.license        = 'MIT'
+
+  spec.files          = `git ls-files`.split($/)
+  spec.executables    = ['wielder_of_anor']
+  spec.test_files     = []
+  spec.require_paths  = ['lib']
+
+  spec.add_dependency 'rainbow'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake', '~> 10.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: wielder_of_anor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Chris Sellek
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-17 00:00:00.000000000 Z
+date: 2017-01-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -91,7 +91,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14.1
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Checks a user's staged files for 'forbidden' words (as determined by the