watson-ruby 1.0.5 → 1.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6b4391c99a0dd023f21d0ad73d7f2039535dcd25
-  data.tar.gz: 9090225bbc8a47e6141cdfcb9ea6470db5c5325e
+  metadata.gz: 44137e243624ca9f33b847d08d8a64789e89142d
+  data.tar.gz: 75194b81af02f48dfcdda8dea4e4ae4a00e42d87
 SHA512:
-  metadata.gz: ea1a1ef3ed493d9e5f4b6e1be760c8a7f91797f600954f42c820666b860190bcbe5e5f986af96b103e0c1975aa6d85bed582f1e23c96b422d3517dd5de38b0f5
-  data.tar.gz: e8095a23ed2f569fd8cb015764c30c8ff3e59ee72299b9cac3667f8b6b091ca78573e359fb24f99dfa897a9aad4a2aa653a17af7f70a925f37012d68afd6f19e
+  metadata.gz: c3bece662ec2a55e7f7b25a1970537144eb22b6eda44d1e9f964141c2c5106f6092aa4c22ef6891c01017b8e9f4216aa3b9c7638f6d57d7eecb08ee934b13f20
+  data.tar.gz: be581a10fddb3dc38c23dfeb5063314c06dad67759a9fa928f5fba8af28f6d29fe2dc6d91d9e80242d1f5e8761c42751eff4375188c196eeaeadac8fc617ea47

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    watson-ruby (1.0.5)
+    watson-ruby (1.0.6)
       json
 
 GEM

data/README.md

@@ -1,6 +1,6 @@
-# watson-ruby  
+# watson-ruby [![Build Status](https://travis-ci.org/nhmood/watson-ruby.png?branch=master)](https://travis-ci.org/nhmood/watson-ruby)
 ### an inline issue manager
-[watson](http://goosecode.com/watson) ([mirror](http://nhmood.github.io/watson-ruby)) is a tool for creating and tracking bug reports, issues, and internal notes in code.    
+[watson](http://goosecode.com/watson) ([mirror](http://nhmood.github.io/watson-ruby)) is a tool for creating and tracking bug reports, issues, and internal notes in code.  
 It is avaliable in two flavors, [watson-ruby](http://github.com/nhmood/watson-ruby) and [watson-perl](http://github.com/nhmood/watson-perl)
 
 ### See watson in action [here](http://goosecode.com/watson) ([mirror](http://nhmood.github.io/watson-ruby))
@@ -8,7 +8,7 @@ It is avaliable in two flavors, [watson-ruby](http://github.com/nhmood/watson-ru
 
 ## Installation
 watson-ruby has been tested with **Ruby v2.0.0p247** and **RubyGems v2.0.3** (on **Arch Linux**)  
-watson-ruby requires the ```json``` gem 
+watson-ruby requires the ```json``` gem
 
 ### From Repo
 watson-ruby is avaliable as a RubyGems ([link](https://rubygems.org/gems/watson-ruby)).  
@@ -22,12 +22,33 @@ Or you can clone this repo and install with Rake
 git clone https://github.com/nhmood/watson-ruby.git .
 cd watson-ruby
 bundle install
-bundle exec rake 
+bundle exec rake
 ```
-  
+
 ## Usage
 For a quick idea of how to use watson, check out the [app demo](http://goosecode.com/watson)! ([mirror](http://nhmood.github.io/watson-ruby))  
-See below for a description of what all the command line arguments do.
+See below for a description of what all the command line arguments do.  
+
+### Supported Languages
+If you see something missing from the list please either file an issue or  
+submit a pull request (comment parsing happens in **lib/watson/paser.rb**)
+
+- **C / C++**
+- **Objective C**
+- **C#**
+- **Java**
+- **Javascript**
+- **PHP**
+- **Go**
+- **Scala**
+- **Erlang**
+- **Haskell**
+- **Bash / Zsh**
+- **Ruby**
+- **Perl**
+- **Python**
+- **Coffeescript**
+- **Clojure**
 
 ## Command line arguments
 ```
@@ -55,14 +76,14 @@ watson home page: <http://goosecode.com/projects/watson>
 [goosecode] labs | 2012-2013
 
 ```
-### All file/directory/tag related parameters support relative as well as absolute paths.   
+### All file/directory/tag related parameters support relative as well as absolute paths.
 
 ### -c, --context-lines [LINES]
 This parameter specifies how many lines of context watson should include when posting issues to remote repos.  
 When this parameter is set from the command line, the .watsonrc config file is written with the value; the command line option effectively sets the default value for this feature in the current directory.  
-The default value is set to 15 (and can be found in the lib/watson/command.rb file).
+The default value is set to 15 (and can be found in the lib/watson/command.rb file).  
 
-### -d, --dirs [DIRS]  
+### -d, --dirs [DIRS]
 This parameter specifies which directories watson should parse through.  
 It should be followed by a space separated list of directories that should be parsed.  
 If watson is run without this parameter, the current directory is parsed.  
@@ -74,20 +95,20 @@ It should be followed by a space separated list of files that should be parsed.
 
 
 ### -h, --help
-This parameter displays the list of avaliable options for watson.
+This parameter displays the list of avaliable options for watson.  
 
 
 ### -i, --ignore [IGNORES]
 This parameter specifies which files and directories watson should ignore when parsing.  
 It should be followed by a space separated list of files and/or directories to be ignored.  
-This parameter should be used as an opposite to -d/-f, when there are more files that should be parsed in a directory than should be ignored.
+This parameter should be used as an opposite to -d/-f, when there are more files that should be parsed in a directory than should be ignored.  
 
 
 ### -p, --parse-depth [PARSE_DEPTH]
 This parameter specifies how deep watson should recursively parse directories.  
 The 'depth' is defined as how many levels deep from the top-most specified directory to parse.  
 If individual directories are passed with the -d (--dirs) flag, each will be parsed PARSE_DEPTH layers, regardless of their depth from the current directory.  
-If watson is run without this parameter, the parsing depth is unlimited and will search through all subdirectories found.
+If watson is run without this parameter, the parsing depth is unlimited and will search through all subdirectories found.  
 
 
 ### -r, --remote [GITHUB, BITBUCKET]
@@ -104,10 +125,10 @@ The tag currently supports any regular character and number combination, no spec
 ### -u, --update
 This parameter is used to update remote repos with new issues.  
 watson **does not** post new issues by default therefore this parameter is required to push up to GitHub/Bitbucket.  
-watson **does** pull issue status by default, therefore you will always be notified of resolved issues on GitHub/Bitbucket.
+watson **does** pull issue status by default, therefore you will always be notified of resolved issues on GitHub/Bitbucket.  
 
 ### -v, --version
-This parameter displays the current version of watson you are running.
+This parameter displays the current version of watson you are running.  
 
 
 ## .watsonrc
@@ -117,30 +138,30 @@ The .watsonrc is placed in every directory that watson is run from as opposed to
 For example, a C/C++ project might want to look in src/ and ignore obj/ whereas a Ruby project might want to look in lib/ and ignore assets/.  
 
 The .watsonrc file is fairly straightforward...  
-**[dirs]** - This is a newline separated list of directories to look in while parsing.
+**[dirs]** - This is a newline separated list of directories to look in while parsing.  
 
-**[tags]** - This is a newline separated list of tags to look for while parsing.
+**[tags]** - This is a newline separated list of tags to look for while parsing.  
 
-**[ignore]** - This is a newline separated list of files / folders to ignore while parsing.  
-This supports wildcard type selecting by providing .filename (no * required)
+**[ignore]** - This is a newline separated list of files / folders to ignore while parsing.    
+This supports wildcard type selecting by providing .filename (no * required)  
 
-**[context_depth]** - This value determines how many lines of context should be grabbed for each issue when posting to a remote.
+**[context_depth]** - This value determines how many lines of context should be grabbed for each issue when posting to a remote.  
 
 **[(github/bitbucket)]** - If a remote is established, the API key for the corresponding remote is stored here.  
-Currently, OAuth has yet to be implemented for Bitbucket so the Bitbucket username is stored here.
+Currently, OAuth has yet to be implemented for Bitbucket so the Bitbucket username is stored here.  
 
 **[(github/bitbucket)_repo]** - The repo name / path is stored here.  
 
-The remote related .watsonrc options shouldn't need to be edited manually, as they are automatically populated when the -r, --remote setup is called.
+The remote related .watsonrc options shouldn't need to be edited manually, as they are automatically populated when the -r, --remote setup is called.  
 
 ## Special Thanks
 Special thanks to [@samirahmed](http://github.com/samirahmed) for his super Ruby help and encouraging the Ruby port!  
 Special thanks to [@eugenekolo](http://twitter.com/eugenekolo) [[email](eugenek@bu.edu)] for his super Perl help!  
-Special thanks to [@crowell](http://github.com/crowell) for testing out watson-ruby!
+Special thanks to [@crowell](http://github.com/crowell) for testing out watson-ruby!  
 
 ## FAQ
 - **Why Ruby?**  
-  I wanted to learn Ruby and this seemed like a pretty decent project.  
+  I wanted to learn Ruby and this seemed like a pretty decent project.
 
 - **Why is the Ruby version different from the Perl version?**  
   The Ruby version was developed after the Perl version was made. Because of this, it was a lot easier to add on features that were thought of while/after making the Perl version as the plumbing was still being setup.  

data/assets/defaultConf

@@ -1,15 +1,15 @@
 # watson rc
 # watson - inline issue manager
-# [goosecode] labs 
+# [goosecode] labs
 
 
-# Directories 
-[dirs] 
+# Directories
+[dirs]
 ./
 
- 
-# Tags 
-[tags] 
+
+# Tags
+[tags]
 fix
 review
 todo

data/bin/watson

@@ -2,7 +2,7 @@
 # coding: utf-8
 
 # [review] - Using own funky path loading because traditional way seems wrong?
-# Commented out version is traditional, seen in many apps. If you use that and 
+# Commented out version is traditional, seen in many apps. If you use that and
 # look at load_path you get path/../lib (I'd expect those to be separate?)
 # My funky version adds path/., path/bin, path/assets separately
 # Maybe I don't get how the load path is supposed to look though...

data/lib/watson.rb

@@ -11,59 +11,59 @@ module Watson
   # [todo] - Replace all regex parentheses() with brackets[] if not matching
   #        Was using () to group things together for syntax instead of []
   #        Replace so we can get cleaner matches and don't need to keep track of matches
-  
+
   # [todo] - Change debug_print to provide its own \n
-  
-  # [todo] - Add ability to pass "IDENTIFY" to debug_print to auto print method entry info 
-  
+
+  # [todo] - Add ability to pass "IDENTIFY" to debug_print to auto print method entry info
+
   # [todo] - Make sure all methods have proper return at end
-  
+
   # [review] - Method input arg always renamed from arg to _arg inside method, change this?
-  #        Not sure if I should just make input arg _arg or if explicit _ is useful 
-  
+  #        Not sure if I should just make input arg _arg or if explicit _ is useful
+
   # [todo] - Add option to save output to specified file
   # [todo] - Replace Identify line in each method with method_added call
   #      http://ruby-doc.org/core-2.0.0/Module.html#method-i-method_added
 
-  # Separate ON and OFF so we can force state and still let 
+  # Separate ON and OFF so we can force state and still let
   # individual classes have some control over their prints
 
   # Global flag to turn ON debugging across all files
   GLOBAL_DEBUG_ON = false
   # Gllobal flag to turn OFF debugging across all files
-  GLOBAL_DEBUG_OFF = false 
+  GLOBAL_DEBUG_OFF = false
 
   # [review] - Not sure if module_function is proper way to scope
   # I want to be able to call debug_print without having to use the scope
-  # operator (Watson::Printer.debug_print) so it is defined here as a 
+  # operator (Watson::Printer.debug_print) so it is defined here as a
   # module_function instead of having it in the Printer class
   # Gets included into every class individually
   module_function
-  
+
   ###########################################################
-  # Global debug print that prints based on local file DEBUG flag as well as GLOBAL debug flag 
+  # Global debug print that prints based on local file DEBUG flag as well as GLOBAL debug flag
   def debug_print(msg)
   # [todo] - If input msg is a Hash, use pp to dump it
 
-    # Print only if DEBUG flag of calling class is true OR 
+    # Print only if DEBUG flag of calling class is true OR
     # GLOBAL_DEBUG_ON of Watson module (defined above) is true
     # AND GLOBAL_DEBUG_OFF of Watson module (Defined above) is false
 
     # Sometimes we call debug_print from a static method (class << self)
-    # and other times from a class method, and ::DEBUG is accessed differently 
+    # and other times from a class method, and ::DEBUG is accessed differently
     # from a class vs object, so lets take care of that
     _DEBUG = (self.is_a? Class) ? self::DEBUG : self.class::DEBUG
 
     print "=> #{msg}" if ( (_DEBUG == true || GLOBAL_DEBUG_ON == true) && (GLOBAL_DEBUG_OFF == false))
-  end 
+  end
 
 
   ###########################################################
-  # Perform system check to see if we are able to use unix less for printing 
+  # Perform system check to see if we are able to use unix less for printing
   def check_less
     # Check if system has less (so we can print out to it to allow scrolling)
     # [todo] - Implement this scrolling thing inside watson with ncurses
-    return system("which less > /dev/null 2>&1")  
+    return system("which less > /dev/null 2>&1")
   end
 
 end

data/lib/watson/bitbucket.rb

@@ -4,29 +4,29 @@ module Watson
     # Contains all necessary methods to obtain access to, get issue list,
     # and post issues to Bitbucket
     class Bitbucket
-    
+
     # 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
     # [todo] - Wrap Bitbucket password grabbing into separate method
-  
+
     # Include for debug_print
     include Watson
-  
-    ############################################################################# 
+
+    #############################################################################
     # Setup remote access to Bitbucket
     # 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 +  "Attempting to access Bitbucket...\n" + RESET
-      
+
       # Check config to make sure no previous repo info exists
       unless config.bitbucket_api.empty? && config.bitbucket_repo.empty?
         Printer.print_status "!", RED
@@ -52,7 +52,7 @@ module Watson
       # [todo] - Bitbucket OAuth not implemented yet so warn user about HTTP Auth
       # Bitbucket doesn't have nonOAuth flow that GitHub does :(
       # Even if I use OAuth lib, still need to validate from webview which is lame
-      Printer.print_status "!", RED 
+      Printer.print_status "!", RED
       print BOLD + "Bitbucket OAuth not implemented yet.\n" + RESET;
       print "      Basic HTTP Auth in use, will request PW entry every time.\n\n"
 
@@ -70,7 +70,7 @@ module Watson
       print "\n"
 
       # Get repo information, if blank give error
-      Printer.print_status "!", YELLOW 
+      Printer.print_status "!", YELLOW
       print BOLD + "Repo information required\n" + RESET
       print "      Please provide owner that repo is under followed by repo name\n"
       print "      e.g. owner: nhmood, repo: watson (case sensitive)\n"
@@ -109,11 +109,11 @@ module Watson
         return false
       end
 
-      # HTTP Request to check if Repo exists and user has access 
-      # http://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs 
+      # HTTP Request to check if Repo exists and user has access
+      # http://confluence.atlassian.com/display/BITBUCKET/Use+the+Bitbucket+REST+APIs
 
-      # Create options hash to pass to Remote::http_call 
-      # Endpoint for accessing Repo as User with SSL 
+      # Create options hash to pass to Remote::http_call
+      # Endpoint for accessing Repo as User with SSL
       # Basic auth with user input
       opts = {:url        => "https://bitbucket.org/api/1.0/repositories/#{_owner}/#{_repo}",
           :ssl        => true,
@@ -136,9 +136,9 @@ module Watson
         print "      Check that credentials are correct and repository exists under user\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n\n"
         return false
-      end 
+      end
+
 
-  
       # No OAuth for Bitbucket yet so just store username in api for config
       # This will let us just prompt for PW
       config.bitbucket_api = _username
@@ -147,7 +147,7 @@ module Watson
       debug_print " \n"
 
       # 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 Bitbucket info\n"
       config.update_conf("bitbucket_api", "bitbucket_repo")
 
@@ -160,17 +160,17 @@ module Watson
 
       return true
 
-    end 
+    end
 
 
     ###########################################################
-    # Get all remote Bitbucket issues and store into Config container class  
+    # Get all remote Bitbucket 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.bitbucket_api.empty?
         debug_print "No API found, this shouldn't be called...\n"
         return false
@@ -182,7 +182,7 @@ module Watson
         Printer.print_status "!", YELLOW
         print BOLD + "Bitbucket password required for remote checking/posting.\n" + RESET
         print "      Password: "
-        
+
         # Block output to tty to prevent PW showing, Linux/Unix only :(
         system "stty -echo"
         _password = $stdin.gets.chomp
@@ -199,7 +199,7 @@ module Watson
 
 
       # Get all open tickets (anything but resolved)
-      # Create options hash to pass to Remote::http_call 
+      # Create options hash to pass to Remote::http_call
       # Issues URL for Bitbucket + SSL
       opts = {:url        => "https://bitbucket.org/api/1.0/repositories/#{ config.bitbucket_repo }/issues?status=!resolved",
           :ssl        => true,
@@ -209,8 +209,8 @@ module Watson
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
-      
-      
+
+
       # Check response to validate repo access
       if _resp.code != "200"
         Printer.print_status "x", RED
@@ -224,19 +224,19 @@ module Watson
         return false
       end
 
-      
+
 
       config.bitbucket_issues[:open] = _json["issues"].empty? ? Hash.new : _json["issues"]
       config.bitbucket_valid = true
-      
+
       # Get all closed tickets
-      # Create options hash to pass to Remote::http_call 
+      # Create options hash to pass to Remote::http_call
       # Issues URL for Bitbucket + SSL
       opts = {:url        => "https://bitbucket.org/api/1.0/repositories/#{ config.bitbucket_repo }/issues?status=resolved",
           :ssl        => true,
           :method     => "GET",
           :basic_auth => [config.bitbucket_api, config.bitbucket_pw],
-          :verbose    => false 
+          :verbose    => false
            }
 
       _json, _resp  = Watson::Remote.http_call(opts)
@@ -246,31 +246,31 @@ 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 "Bitbucket invalid, setting config var\n"
         config.bitbucket_valid = false
         return false
       end
 
-      config.bitbucket_issues[:closed] = _json["issues"].empty? ? Hash.new : _json["issues"] 
+      config.bitbucket_issues[:closed] = _json["issues"].empty? ? Hash.new : _json["issues"]
       config.bitbucket_valid = true
       return true
-    end 
+    end
 
 
     ###########################################################
-    # Post given issue to remote Bitbucket repo 
+    # Post given issue to remote Bitbucket 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.bitbucket_api.empty?
         debug_print "No API found, this shouldn't be called...\n"
         return false
@@ -283,16 +283,16 @@ 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.bitbucket_issues[:open].each do | _open | 
+      config.bitbucket_issues[:open].each do | _open |
         if _open["content"].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.bitbucket_issues[:closed].each do  | _closed | 
+      config.bitbucket_issues[:closed].each do  | _closed |
         if _closed["content"].include?(issue[:md5])
           debug_print "Found in #{ _closed["title"] }, not posting\n"
           return false
@@ -307,7 +307,7 @@ module Watson
         Printer.print_status "!", YELLOW
         print BOLD + "Bitbucket password required for remote checking/posting.\n" + RESET
         print "      Password: "
-        
+
         # Block output to tty to prevent PW showing, Linux/Unix only :(
         print "Password: "
         system "stty -echo"
@@ -325,17 +325,17 @@ module Watson
 
 
 
-    
+
       # 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 }"
-      
+
       # Create option hash to pass to Remote::http_call
       # Issues URL for GitHub + SSL
       # No tag or label concept in Bitbucket unfortunately :(
@@ -345,25 +345,25 @@ module Watson
           :basic_auth => [config.bitbucket_api, config.bitbucket_pw],
           :data   => [{"title" => issue[:title] + " [#{ issue[:path] }]",
                   "content" => _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 != "200"
         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