watson-ruby 1.0.5 → 1.0.6

data/lib/watson/fs.rb

@@ -1,11 +1,11 @@
 module Watson
-  # File system utility function class 
-  # Contains all methods for file access in watson 
-  class FS 
-    
+  # File system utility function class
+  # Contains all methods for file access in watson
+  class FS
+
     # Debug printing for this class
     DEBUG = false
-  
+
     class << self
     # [todo] - Not sure whether to make check* methods return FP
     #      Makes it nice to get it returned and use it but
@@ -14,17 +14,17 @@ module Watson
 
     # Include for debug_print
     include Watson
-    
+
     ###########################################################
     # Check if file exists and can be opened
     def check_file(file)
-      
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-    
+
       # Error check for input
       if file.length == 0
-        debug_print "No file specified\n" 
+        debug_print "No file specified\n"
         return false
       end
 
@@ -35,31 +35,31 @@ module Watson
       else
         debug_print "Could not open #{ file }, skipping\n"
         return false
-      end         
+      end
     end
 
 
     ###########################################################
-    # Check if directory exists and can be opened 
+    # Check if directory exists and can be opened
     def check_dir(dir)
-      
+
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
-  
+
       # Error check for input
       if dir.length == 0
         debug_print "No directory specified\n"
         return false
       end
 
-      # Check if directory exists 
+      # Check if directory exists
       if Dir.exists?(dir)
         debug_print "#{ dir } exists and opened succesfully\n"
         return true
       else
         debug_print "Could not open #{ dir }, skipping\n"
         return false
-      end 
+      end
     end
 
     end

data/lib/watson/github.rb

@@ -2,34 +2,34 @@ module Watson
   class Remote
     # GitHub remote access class
     # Contains all necessary methods to obtain access to, get issue list,
-    # and post issues to GitHub 
+    # and post issues to GitHub
     class GitHub
-    
+
     # Debug printing for this class
-    DEBUG = false   
+    DEBUG = false
 
     class << self
 
     # [todo] - Allow closing of issues from watson? Don't like that idea but maybe
-    # [review] - Properly scope Printer class so we dont need the Printer. for 
+    # [review] - Properly scope Printer class so we dont need the Printer. for
     #      method calls?
     # [todo] - Keep asking for user data until valid instead of leaving app
 
 
     # Include for debug_print
     include Watson
-    
-    ############################################################################# 
-    # Setup remote access to GitHub 
+
+    #############################################################################
+    # Setup remote access to GitHub
     # Get Username, Repo, and PW and perform necessary HTTP calls to check validity
     def setup(config)
 
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
-    
+
       Printer.print_status "+", GREEN
       print BOLD + "Obtaining OAuth Token for GitHub...\n" + RESET
-      
+
       # Check config to make sure no previous API exists
       unless config.github_api.empty? && config.github_repo.empty?
         Printer.print_status "!", RED
@@ -78,7 +78,7 @@ module Watson
       # HTTP Request to get OAuth Token
       # GitHub API v3 - http://developer.github.com/v3/
 
-      # Create options hash to pass to Remote::http_call 
+      # Create options hash to pass to Remote::http_call
       # Auth URL for GitHub + SSL
       # Repo scope + notes for watson
       # Basic auth with user input
@@ -86,9 +86,9 @@ module Watson
           :ssl        => true,
           :method     => "POST",
           :basic_auth => [_username, _password],
-          :data       => {"scopes" => ["repo"], 
-                      "note" => "watson", 
-                      "note_url" => "http://watson.goosecode.com/" }, 
+          :data       => {"scopes" => ["repo"],
+                      "note" => "watson",
+                      "note_url" => "http://watson.goosecode.com/" },
           :verbose    => false
            }
 
@@ -103,8 +103,8 @@ module Watson
         print BOLD + "Unable to obtain OAuth Token\n" + RESET
         print "      Status: #{ _resp.code } - #{ _resp.message }\n\n"
         return false
-      end 
-  
+      end
+
       # Store API key obtained from POST to @config.github_api
       config.github_api = _json["token"]
       debug_print "Config GitHub API Key updated to: #{ config.github_api }\n"
@@ -139,23 +139,23 @@ module Watson
       # Make call to GitHub API to create new label for Issues
       # If status returns not 404, then we have access to repo (+ it exists)
       # If 422, then (most likely) the label already exists
-    
-      # Create options hash to pass to Remote::http_call 
+
+      # Create options hash to pass to Remote::http_call
       # Label URL for GitHub + SSL
-      #  
+      #
       # Auth token
       opts = {:url        => "https://api.github.com/repos/#{ _owner }/#{ _repo }/labels",
           :ssl        => true,
           :method     => "POST",
-          :auth   => config.github_api, 
-          :data       => {"name" => "watson", 
-                      "color" => "00AEEF" }, 
+          :auth   => config.github_api,
+          :data       => {"name" => "watson",
+                      "color" => "00AEEF" },
           :verbose    => false
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
-    
-      # [review] - This is pretty messy, maybe clean it up later  
+
+      # [review] - This is pretty messy, maybe clean it up later
       # Check response to validate repo access
       if _resp.code == "404"
         print "\n"
@@ -172,12 +172,12 @@ module Watson
         Printer.print_status "o", GREEN
         print BOLD + "Repo successfully accessed\n\n" + RESET
       end
-  
+
       # Store owner/repo obtained from POST to @config.github_repo
       config.github_repo = "#{ _owner }/#{ _repo }"
       debug_print "Config GitHub API Key updated to: #{ config.github_repo }\n"
 
-      # Inform user of label creation status (created above) 
+      # Inform user of label creation status (created above)
       Printer.print_status "+", GREEN
       print BOLD + "Creating label for watson on GitHub...\n" + RESET
       if _resp.code == "201"
@@ -193,7 +193,7 @@ module Watson
       end
 
       # All setup has been completed, need to update RC
-      # Call config updater/writer from @config to write config 
+      # Call config updater/writer from @config to write config
       debug_print "Updating config with new GitHub info\n"
       config.update_conf("github_api", "github_repo")
 
@@ -211,14 +211,14 @@ module Watson
 
 
     ###########################################################
-    # Get all remote GitHub issues and store into Config container class  
+    # Get all remote GitHub issues and store into Config container class
 
     def get_issues(config)
 
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
-      # Only attempt to get issues if API is specified 
+      # Only attempt to get issues if API is specified
       if config.github_api.empty?
         debug_print "No API found, this shouldn't be called...\n"
         return false
@@ -226,18 +226,18 @@ module Watson
 
 
       # Get all open tickets
-      # Create options hash to pass to Remote::http_call 
+      # Create options hash to pass to Remote::http_call
       # Issues URL for GitHub + SSL
       opts = {:url        => "https://api.github.com/repos/#{ config.github_repo }/issues?labels=watson&state=open",
           :ssl        => true,
           :method     => "GET",
-          :auth   => config.github_api, 
-          :verbose    => false 
+          :auth   => config.github_api,
+          :verbose    => false
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
-      
-      
+
+
       # Check response to validate repo access
       if _resp.code != "200"
         Printer.print_status "x", RED
@@ -252,15 +252,15 @@ module Watson
 
       config.github_issues[:open] = _json.empty? ? Hash.new : _json
       config.github_valid = true
-      
+
       # Get all closed tickets
       # Create option hash to pass to Remote::http_call
       # Issues URL for GitHub + SSL
       opts = {:url        => "https://api.github.com/repos/#{ config.github_repo }/issues?labels=watson&state=closed",
           :ssl        => true,
           :method     => "GET",
-          :auth   => config.github_api, 
-          :verbose    => false 
+          :auth   => config.github_api,
+          :verbose    => false
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
@@ -270,9 +270,9 @@ module Watson
       if _resp.code != "200"
         Printer.print_status "x", RED
         print BOLD + "Unable to get closed issues.\n" + RESET
-        print "      Since the open issues were obtained, something is probably wrong and you should file a bug report or something...\n" 
+        print "      Since the open issues were obtained, something is probably wrong and you should file a bug report or something...\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n"
-        
+
         debug_print "GitHub invalid, setting config var\n"
         config.github_valid = false
         return false
@@ -281,20 +281,20 @@ module Watson
       config.github_issues[:closed] = _json.empty? ? Hash.new : _json
       config.github_valid = true
       return true
-    end 
+    end
 
 
     ###########################################################
-    # Post given issue to remote GitHub repo 
+    # Post given issue to remote GitHub repo
     def post_issue(issue, config)
     # [todo] - Better way to identify/compare remote->local issues than md5
     #        Current md5 based on some things that easily can change, need better ident
 
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
-  
-        
-      # Only attempt to get issues if API is specified 
+
+
+      # Only attempt to get issues if API is specified
       if config.github_api.empty?
         debug_print "No API found, this shouldn't be called...\n"
         return false
@@ -307,62 +307,62 @@ module Watson
       #      call exec and turn it into a real hash for parsing in watson
       #      Makes watson code cleaner but not as readable comment on GitHub...?
       debug_print "Checking open issues to see if already posted\n"
-      config.github_issues[:open].each do | _open | 
+      config.github_issues[:open].each do | _open |
         if _open["body"].include?(issue[:md5])
           debug_print "Found in #{ _open["title"] }, not posting\n"
           return false
         end
         debug_print "Did not find in #{ _open["title"] }\n"
-      end 
-      
-      
+      end
+
+
       debug_print "Checking closed issues to see if already posted\n"
-      config.github_issues[:closed].each do  | _closed | 
+      config.github_issues[:closed].each do  | _closed |
         if _closed["body"].include?(issue[:md5])
           debug_print "Found in #{ _closed["title"] }, not posting\n"
           return false
         end
         debug_print "Did not find in #{ _closed["title"] }\n"
       end
-    
+
       # We didn't find the md5 for this issue in the open or closed issues, so safe to post
-    
+
       # Create the body text for the issue here, too long to fit nicely into opts hash
       # [review] - Only give relative path for privacy when posted
       _body = "__filename__ : #{ issue[:path] }\n" +
-          "__line #__ : #{ issue[:line_number] }\n" + 
+          "__line #__ : #{ issue[:line_number] }\n" +
           "__tag__ : #{ issue[:tag] }\n" +
           "__md5__ : #{ issue[:md5] }\n\n" +
           "#{ issue[:context].join }\n"
-      
+
       # Create option hash to pass to Remote::http_call
       # Issues URL for GitHub + SSL
       opts = {:url        => "https://api.github.com/repos/#{ config.github_repo }/issues",
           :ssl        => true,
           :method     => "POST",
-          :auth   => config.github_api, 
+          :auth   => config.github_api,
           :data   => { "title" => issue[:title] + " [#{ issue[:path] }]",
                    "labels" => [issue[:tag], "watson"],
                    "body" => _body },
-          :verbose    => false 
+          :verbose    => false
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
-    
-        
+
+
       # Check response to validate repo access
       # Shouldn't be necessary if we passed the last check but just to be safe
       if _resp.code != "201"
         Printer.print_status "x", RED
         print BOLD + "Post unsuccessful. \n" + RESET
-        print "      Since the open issues were obtained earlier, something is probably wrong and you should let someone know...\n" 
+        print "      Since the open issues were obtained earlier, something is probably wrong and you should let someone know...\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n"
         return false
       end
-    
-      return true 
+
+      return true
     end
-    
+
     end
     end
   end

data/lib/watson/parser.rb

@@ -209,10 +209,10 @@ module Watson
         _data.push(_line)
         _line.encode('UTF-8', :invalid => :replace)
       end
-  
-      # Initialize issue list hash 
+
+      # Initialize issue list hash
       _issue_list = Hash.new()
-      _issue_list[:relative_path] = _relative_path 
+      _issue_list[:relative_path] = _relative_path
       _issue_list[:absolute_path] = _absolute_path
       _issue_list[:has_issues] = false
       @config.tag_list.each do | _tag |
@@ -368,6 +368,34 @@ module Watson
       # Create _mtch var so we can access it outside of the do loop
 
 
+
+      _ext = { '.cpp'     => ['//', '/*'],        # C++
+               '.cc'      => ['//', '/*'],
+               '.hpp'     => ['//', '/*'],
+               '.c'       => ['//', '/*'],        # C
+               '.h'       => ['//', '/*'],
+               '.java'    => ['//', '/*', '/**'], # Java
+               '.class'   => ['//', '/*', '/**'],
+               '.cs'      => ['//', '/*'],        # C#
+               '.js'      => ['//', '/*'],        # JavaScript
+               '.php'     => ['//', '/*', '#'],   # PHP
+               '.m'       => ['//', '/*'],        # ObjectiveC
+               '.mm'      => ['//', '/*'],
+               '.go'      => ['//', '/*'],        # Go(lang)
+               '.scala'   => ['//', '/*'],        # Scala
+               '.erl'     => ['%%', '%'],         # Erlang
+               '.hs'      => ['--'],              # Haskell
+               '.sh'      => ['#'],               # Bash
+               '.rb'      => ['#'],               # Ruby
+               '.pl'      => ['#'],               # Perl
+               '.pm'      => ['#'],
+               '.t'       => ['#'],
+               '.py'      => ['#'],               # Python
+               '.coffee'  => ['#'],               # CoffeeScript
+               '.zsh'     => ['#'],               # Zsh
+               '.clj'     => [';;']               # Clojure
+             }
+
       loop do
         _mtch = filename.match(/(\.(\w+))$/)
         debug_print "Extension: #{ _mtch }\n"
@@ -375,35 +403,12 @@ module Watson
         # Break if we don't find a match
         break if _mtch.nil?
 
-        # Determine file type
-        case _mtch[0]
-          # C / C++, Java, C#
-          # [todo] - Add /* style comment
-          when '.cpp', '.cc', '.c', '.hpp', '.h',
-              '.java', '.class', '.cs', '.js', '.php',
-              '.m', '.mm', '.go'
-            debug_print "Comment type is: //\n"
-            return '//'
-
-          when '.hs'
-            debug_print "Comment type is: --\n"
-            return '--'
-
-          when '.erl'
-            debug_print "Comment type is: %\n"
-            return '%'
-
-          # Bash, Ruby, Perl, Python
-          when '.sh', '.rb', '.pl', '.py', '.coffee'
-            debug_print "Comment type is: #\n"
-            return '#'
-
-          # Can't recognize extension, keep looping in case of .bk, .#, ect
-          else
-            filename = filename.gsub(/(\.(\w+))$/, '')
-            debug_print "Didn't recognize, searching #{ filename }\n"
+        return _ext[_mtch[0]] if _ext.has_key?(_mtch[0])
+
+        # Can't recognize extension, keep looping in case of .bk, .#, ect
+        filename = filename.gsub(/(\.(\w+))$/, '')
+        debug_print "Didn't recognize, searching #{ filename }\n"
 
-        end
       end
 
       # We didn't find any matches from the filename, return error (0)