watson-ruby 1.0.5 → 1.0.6

data/lib/watson/command.rb

@@ -2,16 +2,16 @@ module Watson
   # Command line parser class
   # Controls program flow and parses options given by command line
   class Command
-    
+
     # Debug printing for this class
     DEBUG = false
-    
+
     class << self
 
     # Include for debug_print
     include Watson
 
-  
+
     ###########################################################
     # Command line controller
     # Manages program flow from given command line arguments
@@ -21,7 +21,7 @@ module Watson
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-    
+
       # List of possible flags, used later in parsing and for user reference
       _flag_list = ["-c", "--context-depth",
               "-d", "--dirs",
@@ -55,7 +55,7 @@ module Watson
       @config   = Watson::Config.new
       @parser   = Watson::Parser.new(@config)
       @printer  = Watson::Printer.new(@config)
-  
+
       # Capture Ctrl+C interrupt for clean exit
       # [review] - Not sure this is the correct place to put the Ctrl+C capture
       trap("INT") do
@@ -65,18 +65,18 @@ module Watson
 
       # Parse command line options
       # Begin by slicing off until we reach a valid flag
-      
+
       # Always look at first array element in case and then slice off what we need
       # Accept parameters to be added / overwritten if called twice
       # Slice out from argument until next argument
-    
-      # Clean up argument list by removing elements until the first valid flag  
+
+      # Clean up argument list by removing elements until the first valid flag
       until _flag_list.include?(args[0]) || args.length == 0
         # [review] - Make this non-debug print to user?
         debug_print "Unrecognized flag #{ args[0] }\n"
         args.slice!(0)
       end
-    
+
       # Parse command line options
       # Grab flag (should be first arg) then slice off args until next flag
       # Repeat until all args have been dealt with
@@ -87,20 +87,20 @@ module Watson
 
         debug_print "Current Flag: #{ _flag }\n"
 
-        # Go through args until we find the next valid flag or all args are parsed 
+        # Go through args until we find the next valid flag or all args are parsed
         _i = 0
-        until _flag_list.include?(args[_i]) ||  _i > (args.length - 1) 
+        until _flag_list.include?(args[_i]) ||  _i > (args.length - 1)
           debug_print "Arg: #{ args[_i] }\n"
-          _i = _i + 1 
+          _i = _i + 1
         end
-          
+
         # Slice off the args for the flag (inclusive) using index from above
         # [review] - This is a bit messy (to slice by _i - 1) when we have control
         # over the _i index above but I don't want to
         # think about the logic right now so look at later
         _flag_args = args.slice!(0..(_i-1))
 
-        case _flag 
+        case _flag
         when "-c", "--context-depth"
           debug_print "Found -c/--context-depth argument\n"
           set_context(_flag_args)
@@ -108,7 +108,7 @@ module Watson
         when "-d", "--dirs"
           debug_print "Found -d/--dirs argument\n"
           set_dirs(_flag_args)
-        
+
         when "-f", "--files"
           debug_print "Found -f/--files argument\n"
           set_files(_flag_args)
@@ -120,7 +120,7 @@ module Watson
         when "-p", "--parse-depth"
           debug_print "Found -r/--parse-depth argument\n"
           set_parse_depth(_flag_args)
-        
+
         when "-r", "--remote"
           debug_print "Found -r/--remote argument\n"
           # Run config to populate all the fields and such
@@ -128,10 +128,10 @@ module Watson
           @config.check_conf
           @config.read_conf
           setup_remote(_flag_args)
-          
+
           # If setting up remote, exit afterwards
           exit true
-        
+
         when "-t", "--tags"
           debug_print "Found -t/--tags argument\n"
           set_tags(_flag_args)
@@ -154,13 +154,13 @@ module Watson
 
 
     ###########################################################
-    # Print help for watson 
+    # Print help for watson
     def help
     # [todo] - Add bold and colored printing
-      
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       print BOLD;
       print "Usage: watson [OPTION]...\n"
         print "Running watson with no arguments will parse with settings in RC file\n"
@@ -188,7 +188,7 @@ module Watson
         print "watson home page: <http://goosecode.com/projects/watson>\n"
         print "[goosecode] labs | 2012-2013\n"
         print RESET;
-    
+
         return true
 
     end
@@ -197,16 +197,16 @@ module Watson
     ###########################################################
     # Print version information about watson
     def version
-    
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-    
+
       print "watson v1.0\n"
       print "Copyright (c) 2012-2013 goosecode labs\n"
       print "Licensed under MIT, see LICENSE for details\n"
       print "\n"
 
-      print "Written by nhmood, see <http://goosecode.com/projects/watson>\n"   
+      print "Written by nhmood, see <http://goosecode.com/projects/watson>\n"
       return true
     end
 
@@ -214,11 +214,11 @@ module Watson
     ###########################################################
     # set_context
     # Set context_depth parameter in config
-    def set_context(args) 
-    
+    def set_context(args)
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # Need at least one dir in args
       if args.length <= 0
         # [review] - Make this a non-debug print to user?
@@ -226,12 +226,12 @@ module Watson
         return false
       end
 
-    
+
       # For context_depth we do NOT append to RC, ALWAYS overwrite
-      # For each argument passed, make sure valid, then set @config.parse_depth 
+      # For each argument passed, make sure valid, then set @config.parse_depth
       args.each do | _context_depth |
         if _context_depth.match(/^(\d+)/)
-          debug_print "Setting #{ _context_depth } to config context_depth\n" 
+          debug_print "Setting #{ _context_depth } to config context_depth\n"
           @config.context_depth = _context_depth.to_i
         else
           debug_print "#{ _context_depth } invalid depth, ignoring\n"
@@ -239,7 +239,7 @@ module Watson
       end
 
       # Doesn't make much sense to set context_depth for each individual post
-      # When you use this command line arg, it writes the config parameter  
+      # When you use this command line arg, it writes the config parameter
       @config.update_conf("context_depth")
 
       debug_print "Updated context_depth: #{ @config.context_depth }\n"
@@ -248,13 +248,13 @@ module Watson
 
 
     ###########################################################
-    # set_dirs  
-    # Set directories to be parsed by watson  
-    def set_dirs(args) 
+    # set_dirs
+    # Set directories to be parsed by watson
+    def set_dirs(args)
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # Need at least one dir in args
       if args.length <= 0
         # [review] - Make this a non-debug print to user?
@@ -263,9 +263,9 @@ module Watson
       end
 
       # Set config flag for CL entryset  in config
-      @config.cl_entry_set = true 
+      @config.cl_entry_set = true
       debug_print "Updated cl_entry_set flag: #{ @config.cl_entry_set }\n"
-      
+
       # [review] - Should we clean the dir before adding here?
       # For each argument passed, make sure valid, then add to @config.dir_list
       args.each do | _dir |
@@ -288,13 +288,13 @@ module Watson
 
 
     ###########################################################
-    # set_files  
-    # Set files to be parsed by watson  
-    def set_files(args) 
+    # set_files
+    # Set files to be parsed by watson
+    def set_files(args)
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # Need at least one file in args
       if args.length <= 0
         debug_print "No args passed, exiting\n"
@@ -302,7 +302,7 @@ module Watson
       end
 
       # Set config flag for CL entryset  in config
-      @config.cl_entry_set = true 
+      @config.cl_entry_set = true
       debug_print "Updated cl_entry_set flag: #{ @config.cl_entry_set }\n"
 
       # For each argument passed, make sure valid, then add to @config.file_list
@@ -323,12 +323,12 @@ module Watson
 
     ###########################################################
     # set_ignores
-    # Set files and dirs to be ignored when parsing by watson 
+    # Set files and dirs to be ignored when parsing by watson
     def set_ignores(args)
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # Need at least one ignore in args
       if args.length <= 0
         debug_print "No args passed, exiting\n"
@@ -336,11 +336,11 @@ module Watson
       end
 
       # Set config flag for CL ignore set in config
-      @config.cl_ignore_set = true  
+      @config.cl_ignore_set = true
       debug_print "Updated cl_ignore_set flag: #{ @config.cl_ignore_set }\n"
 
 
-      # For ignores we do NOT overwrite RC, just append 
+      # For ignores we do NOT overwrite RC, just append
       # For each argument passed, add to @config.ignore_list
       args.each do | _ignore |
         debug_print "Adding #{ _ignore } to config ignore_list\n"
@@ -353,13 +353,13 @@ module Watson
 
 
     ###########################################################
-    # set_parse_depth 
+    # set_parse_depth
     # Set how deep to recursively parse directories
     def set_parse_depth(args)
-    
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # This should be a single, numeric, value
       # If they pass more, just take the last valid value
       if args.length <= 0
@@ -367,11 +367,11 @@ module Watson
         return false
       end
 
-      # For max_dpeth we do NOT append to RC, ALWAYS overwrite  
-      # For each argument passed, make sure valid, then set @config.parse_depth 
+      # For max_dpeth we do NOT append to RC, ALWAYS overwrite
+      # For each argument passed, make sure valid, then set @config.parse_depth
       args.each do | _parse_depth |
         if _parse_depth.match(/^(\d+)/)
-          debug_print "Setting #{ _parse_depth } to config parse_depth\n" 
+          debug_print "Setting #{ _parse_depth } to config parse_depth\n"
           @config.parse_depth = _parse_depth
         else
           debug_print "#{ _parse_depth } invalid depth, ignoring\n"
@@ -385,20 +385,20 @@ module Watson
 
     ###########################################################
     # set_tags
-    # Set tags to look for when parsing files and folders 
+    # Set tags to look for when parsing files and folders
     def set_tags(args)
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-      
+
       # Need at least one tag in args
       if args.length <= 0
         debug_print "No args passed, exiting\n"
         return false
       end
-      
+
       # Set config flag for CL tag set in config
-      @config.cl_tag_set = true 
+      @config.cl_tag_set = true
       debug_print "Updated cl_tag_set flag: #{ @config.cl_tag_set }\n"
 
       # If set from CL, we overwrite the RC parameters
@@ -415,16 +415,16 @@ module Watson
 
     ###########################################################
     # setup_remote
-    # Handle setup of remote issue posting for GitHub and Bitbucket 
+    # Handle setup of remote issue posting for GitHub and Bitbucket
     def setup_remote(args)
 
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-    
+
       Printer.print_header
-    
+
       print BOLD + "Existing Remotes:\n" + RESET
-  
+
       # Check the config for any remote entries (GitHub or Bitbucket) and print
       # We *should* always have a repo + API together, but API should be enough
       if @config.github_api.empty? && @config.bitbucket_api.empty?
@@ -444,16 +444,16 @@ module Watson
 
       # If github or bitbucket passed, setup
       # If just -r (0 args) do nothing and only have above printed
-      # If more than 1 arg is passed, unrecognized, warn user 
+      # If more than 1 arg is passed, unrecognized, warn user
       if args.length == 1
         case args[0].downcase
         when "github"
           debug_print "GitHub setup called from CL\n"
-          Watson::Remote::GitHub.setup(@config) 
-        
+          Watson::Remote::GitHub.setup(@config)
+
         when "bitbucket"
           debug_print "Bitbucket setup called from CL\n"
-          Watson::Remote::Bitbucket.setup(@config) 
+          Watson::Remote::Bitbucket.setup(@config)
         end
       elsif args.length > 1
         Printer.print_status "x", RED
@@ -464,7 +464,7 @@ module Watson
         return false
       end
     end
-    
+
     end
   end
 end

data/lib/watson/config.rb

@@ -6,40 +6,40 @@ module Watson
 
     # Include for debug_print
     include Watson
-    
+
     # Debug printing for this class
-    DEBUG = false     
-    
+    DEBUG = false
+
     # [review] - Combine into single statement (for performance or something?)
     # [todo] - Add config options (rc file) for default max depth and context lines
 
-    # List of all files/folders to ignore when parsing  
+    # List of all files/folders to ignore when parsing
     attr_accessor :ignore_list
-    # List of directories to parse  
+    # List of directories to parse
     attr_accessor :dir_list
     # List of all files to parse
-    attr_accessor :file_list    
+    attr_accessor :file_list
     # List of tags to look for when parsing
-    attr_accessor :tag_list     
+    attr_accessor :tag_list
     # Number of directories to parse recursively
     attr_accessor :parse_depth
     # Number of lines of issue context to grab
-    attr_accessor :context_depth  
+    attr_accessor :context_depth
 
     # Flag for command line setting of file/dir to parse
     attr_accessor :cl_entry_set
     # Flag for command line setting of file/dir to ignore
     attr_accessor :cl_ignore_set
     # Flag for command line setting of tag to parse for
-    attr_accessor :cl_tag_set   
+    attr_accessor :cl_tag_set
 
     # Flag for whether less is avaliable to print results
     attr_reader   :use_less
     # Flag for where the temp file for printing is located
-    attr_reader   :tmp_file     
+    attr_reader   :tmp_file
 
     # Flag for whether remote access is avaliable
-    attr_accessor :remote_valid   
+    attr_accessor :remote_valid
 
     # Flag for whether GitHub access is avaliable
     attr_accessor :github_valid
@@ -47,7 +47,7 @@ module Watson
     attr_accessor :github_api
     # GitHub repo associated with current directory + watson config
     attr_accessor :github_repo
-    # Hash to hold list of all GitHub issues associated with repo 
+    # Hash to hold list of all GitHub issues associated with repo
     attr_accessor :github_issues
 
 
@@ -56,12 +56,12 @@ module Watson
     # Bitbucket API key generated from Remote::Bitbucket setup (username for now)
     attr_accessor :bitbucket_api
     # Bitbucket password for access until OAuth is implemented for Bitbucket
-    attr_accessor :bitbucket_pw 
+    attr_accessor :bitbucket_pw
     # Bitbucket repo associated with current directory + watson config
     attr_accessor :bitbucket_repo
-    # Hash to hold list of all Bitbucket issues associated with repo  
-    attr_accessor :bitbucket_issues 
-    
+    # Hash to hold list of all Bitbucket issues associated with repo
+    attr_accessor :bitbucket_issues
+
 
     ###########################################################
     # Config initialization method to setup necessary parameters, states, and vars
@@ -69,8 +69,8 @@ module Watson
 
     # [review] - Read and store rc FP inside initialize?
     # This way we don't need to keep reopening the FP to use it
-    # but then we need a way to reliably close the FP when done 
-    
+    # but then we need a way to reliably close the FP when done
+
       # Identify method entry
       debug_print "#{self.class} : #{__method__}\n"
 
@@ -95,10 +95,10 @@ module Watson
       @dir_list     = Array.new()
       @file_list    = Array.new()
       @tag_list     = Array.new()
-       
+
       # Remote options
       @remote_valid   = false
-      
+
       @github_valid   = false
       @github_api   = ""
       @github_repo  = ""
@@ -118,17 +118,17 @@ module Watson
 
 
     ###########################################################
-    # Parse through configuration and obtain remote info if necessary 
+    # Parse through configuration and obtain remote info if necessary
     def run
-    
+
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
-      
-      # check_conf should create if no conf found, exit entirely if can't do either 
+
+      # check_conf should create if no conf found, exit entirely if can't do either
       exit if check_conf == false
       read_conf
-      
-      unless @github_api.empty? && @github_api.empty?
+
+      unless @github_api.empty? && @github_repo.empty?
         Remote::GitHub.get_issues(self)
       end
 
@@ -153,13 +153,13 @@ module Watson
       if !Watson::FS.check_file(@rc_file)
         debug_print "#{ @rc_file } not found\n"
         debug_print "Creating default #{ @rc_file }\n"
-        
+
         # Create default .rc and return create_conf (true if created,
         # false if not)
         return create_conf
       else
         debug_print "#{ @rc_file } found\n"
-        return true 
+        return true
       end
     end
 
@@ -169,16 +169,16 @@ module Watson
     # Copies default config from /assets/defaultConf to the current directory
     def create_conf
     # [review] - Not sure if I should use the open/read/write or Fileutils.cp
-    
+
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
-      
+
       # Generate full path since File doesn't care about the LOAD_PATH
-      # [review] - gsub uses (.?)+ to grab anything after lib (optional), better regex? 
+      # [review] - gsub uses (.?)+ to grab anything after lib (optional), better regex?
       _full_path = __dir__.gsub(%r!/lib/watson(.?)+!, '') + "/assets/defaultConf"
       debug_print "Full path to defaultConf (in gem): #{ _full_path }\n"
-      
+
       # Check to make sure we can access the default file
       if !Watson::FS.check_file(_full_path)
         print "Unable to open #{ _full_path }\n"
@@ -192,24 +192,24 @@ module Watson
         # Open rc file in current directory in write mode and write default
         _output = File.open(@rc_file, 'w')
         _output.write(_default)
-        
+
         # Close both default and new rc files
         _input.close
         _output.close
 
         debug_print "Successfully wrote defaultConf to current directory\n"
         return true
-      end 
+      end
     end
 
 
     ###########################################################
-    # Read configuration file and populate Config container class 
+    # Read configuration file and populate Config container class
     def read_conf
 
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
-      
+
 
       debug_print "Reading #{ @rc_file }\n"
       if !Watson::FS.check_file(@rc_file)
@@ -224,11 +224,11 @@ module Watson
       @use_less = check_less
 
 
-      # Add all the standard items to ignorelist  
+      # Add all the standard items to ignorelist
       # This gets added regardless of ignore list specified
       # [review] - Keep *.swp in there?
       # [todo] - Add conditional to @rc_file such that if passed by -f we accept it
-      # [todo] - Add current file (watson) to avoid accidentally printing app tags 
+      # [todo] - Add current file (watson) to avoid accidentally printing app tags
       @ignore_list.push(".")
       @ignore_list.push("..")
       @ignore_list.push("*.swp")
@@ -238,12 +238,12 @@ module Watson
       # Open and read rc
       # [review] - Not sure if explicit file close is required here
       _rc = File.open(@rc_file, 'r').read
-      
-      debug_print "\n\n"  
-      
+
+      debug_print "\n\n"
+
       # Create temp section var to keep track of what we are populating in config
       _section = ""
-      
+
       # Keep index to print what line we are on
       # Could fool around with Enumerable + each_with_index but oh well
       _i = 0;
@@ -261,15 +261,15 @@ module Watson
           # [review] - More "Ruby" way of going to next line?
           next
         end
-  
-  
+
+
         # [review] - Use if with match so we can call next on the line reading loop
         # Tried using match(){|_mtch|} as well as do |_mtch| but those don't seem to
         # register the next call to the outer loop, so this way will do for now
 
         # Regex on line to find out if we are in a new [section] of
         # config parameters. If so, store it into section var and move
-        # to next line 
+        # to next line
         _mtch = _line.match(/^\[(\w+)\]/)
         if _mtch
           debug_print "Found section #{ _mtch[1] }\n"
@@ -280,13 +280,13 @@ module Watson
 
         case _section
         when "context_depth"
-          # No need for regex on context value, command should read this in only as a # 
+          # No need for regex on context value, command should read this in only as a #
           # Chomp to get rid of any nonsense
           @context_depth = _line.chomp!
 
 
         when "parse_depth"
-          # No need for regex on parse value, command should read this in only as a # 
+          # No need for regex on parse value, command should read this in only as a #
           # Chomp to get rid of any nonsense
           @parse_depth = _line.chomp!
 
@@ -297,26 +297,26 @@ module Watson
           # [review] - Populate @dirs/files_list first, then check size instead
           if @cl_entry_set
             debug_print "Directories or files set from command line ignoring rc [dirs]\n"
-            next 
+            next
           end
-          
+
           # Regex to grab directory
           # Then substitute trailing / (necessary for later formatting)
           # Then push to @dir_list
           _mtch = _line.match(/^((\w+)?\.?\/?)+/)[0].gsub(/(\/)+$/, "")
           if !_mtch.empty?
-            @dir_list.push(_mtch) 
+            @dir_list.push(_mtch)
             debug_print "#{ _mtch } added to @dir_list\n"
           end
           debug_print "@dir_list --> #{ @dir_list }\n"
-          
+
 
         when "tags"
-          # Same as previous for tags 
+          # Same as previous for tags
           # [review] - Populate @tag_list, then check size instead
           if @cl_tag_set
             debug_print "Tags set from command line, ignoring rc [tags]\n"
-            next 
+            next
           end
 
           # Same as previous for tags
@@ -329,36 +329,36 @@ module Watson
             debug_print "#{ _mtch } added to @tag_list\n"
           end
           debug_print "@tag_list --> #{ @tag_list }\n"
-        
+
 
         when "ignore"
           # Same as previous for ignores
           # [review] - Populate @tag_list, then check size instead
-          
+
           if @cl_ignore_set
             debug_print "Ignores set from command line, ignoring rc [ignores]\n"
             next
           end
-          
+
           # Same as previous for ignores (regex same as dirs)
           # Don't eliminate trailing / because not sure if dir can have
           # same name as file (Linux it can't, but not sure about Win/Mac)
           # [review] - Can Win/Mac have dir + file with same name in same dir?
           _mtch = _line.match(/^((\w+)?\.?\/?)+/)[0]
           if !_mtch.empty?
-            @ignore_list.push(_mtch) 
+            @ignore_list.push(_mtch)
             debug_print "#{ _mtch } added to @ignore_list\n"
           end
           debug_print "@ignore_list --> #{ @ignore_list }\n"
 
-        
+
         when "github_api"
           # No need for regex on API key, GitHub setup should do this properly
           # Chomp to get rid of any nonsense
           @github_api = _line.chomp!
           debug_print "GitHub API: #{ @github_api }\n"
 
-        
+
         when "github_repo"
           # Same as above
           @github_repo = _line.chomp!
@@ -368,17 +368,17 @@ module Watson
         when "bitbucket_api"
           # Same as GitHub parse above
           @bitbucket_api = _line.chomp!
-          debug_print "Bitbucket API: #{ @bitbucket_api }\n"  
-  
-  
+          debug_print "Bitbucket API: #{ @bitbucket_api }\n"
+
+
         when "bitbucket_repo"
           # Same as GitHub repo parse above
           @bitbucket_repo = _line.chomp!
           debug_print "Bitbucket Repo: #{ @bitbucket_repo }\n"
 
 
-        else  
-          debug_print "Unknown tag found #{_section}\n"           
+        else
+          debug_print "Unknown tag found #{_section}\n"
         end
 
       end
@@ -411,20 +411,20 @@ module Watson
           debug_print "Check your input(s) to update_conf\n"
           params.slice!(_i)
         end
-      end 
+      end
+
 
-      
       # Read in currently saved RC and go through it line by line
       # Only update params that were passed to update_conf
       # This allows us to clean up the config file at the same time
 
-      
+
       # Open and read rc
       # [review] - Not sure if explicit file close is required here
       _rc = File.open(@rc_file, 'r').read
       _update = File.open(@rc_file, 'w')
-      
-      
+
+
       # Keep index to print what line we are on
       # Could fool around with Enumerable + each_with_index but oh well
       _i = 0;
@@ -440,7 +440,7 @@ module Watson
         debug_print "#{ _i }: #{ _line }"
         _i = _i + 1
 
-        
+
         # Look for sections and set section var
         _mtch = _line.match(/^\[(\w+)\]/)
         if _mtch
@@ -464,7 +464,7 @@ module Watson
           debug_print "Current section NOT a param to update\n"
           debug_print "Writing to new rc\n"
           _update.write(_line)
-          
+
           # Reset newline
           _nlc = 0
         end
@@ -483,8 +483,8 @@ module Watson
         _update.write("[#{ _param }]\n")
         _update.write("#{ self.instance_variable_get("@#{ _param }") }")
         _update.write("\n\n\n")
-      end 
-      
+      end
+
       _update.close
     end