watson-ruby 1.4.3 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c13ba5881255f027628ecb4d0c2b89c001e4940e
-  data.tar.gz: 406069b4a52de7d481b5907a59bb35c8dd6abe6a
+  metadata.gz: da9382974aee60af64d71f1cc6a63f594330cc12
+  data.tar.gz: 7cb4dbb672ffa04412ae1198ac79c97f0bab6643
 SHA512:
-  metadata.gz: 74bcaa0ac025a657062122bc02df3146cc3189b6ae579eb6ca4f52f3a5a4782076be2c30d206c308f288b2986671db0c81cd89c97b7364da761d9e20faf94af2
-  data.tar.gz: 6098f8440287d51898970381aa1583e8186ae88fed76fd6fa0568c589d146279b835c1f6708ec427b186b999fe066c7248cb33c37c3e8ba65c7cd2606306e9f5
+  metadata.gz: f5646b1f3b0db3fd820369e7dcb6727d235cec7bdc5be8bcb3fb2d4656265b5611f8be47dc48603f89e8a5206a3156e972b914e6b600b5fcc0b256d8baf16a6b
+  data.tar.gz: 3f17083485b7efee7672483ca889ba23af2fa2811573d2834d31ba2bb5c47f28dee279c5e338627004cdfb7605efa4dc12382ec1cf4c6e132d7884c962fe6248

data/Gemfile.lock

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

data/README.md

@@ -27,8 +27,9 @@ bundle exec rake
 
 
 ## Recent Updates
+  - watson now supports [GitLab](http://gitlab.com)
   - [vim-unite-watson.vim](https://github.com/alpaca-tc/vim-unite-watson.vim) integrates watson right into vim!
-  - watson now supports multiple export modes 
+  - watson now supports multiple export modes
       - JSON output allows you to integrate watson parse data into your own apps
       - Silent output allows you to use watson without a printout; tie it to git hooks for streamlined issue posting
 
@@ -50,6 +51,11 @@ submit a pull request (comment parsing happens in **lib/watson/paser.rb**)
 - **Go**
 - **Scala**
 - **Erlang**
+- **Fortran**
+- **SQL / PL**
+- **Lua**
+- **HTML**
+- **SASS SCSS**
 - **Haskell**
 - **Bash / Zsh**
 - **Ruby**
@@ -58,24 +64,30 @@ submit a pull request (comment parsing happens in **lib/watson/paser.rb**)
 - **Coffeescript**
 - **Clojure**
 
+
 ## Command line arguments
 ```
 Usage: watson [OPTION]...
 Running watson with no arguments will parse with settings in RC file
 If no RC file exists, default RC file will be created
 
-   -c, --context-depth   number of lines of context to provide with posted issue
+   -c, --context-depth   lines of context to provide with posted issue
    -d, --dirs            list of directories to search in
    -f, --files           list of files to search in
-   --format              set output format for watson [print, json, unite, silent]
+   --format              set output format for watson
+                         [print, json, unite, silent]
    -h, --help            print help
    -i, --ignore          list of files, directories, or types to ignore
    -p, --parse-depth     depth to recursively parse directories
-   -r, --remote          list / create tokens for Bitbucket/GitHub
+   -r, --remote          list / create tokens for remote posting
+                         [github, bitbucket, gitlab]
+   -s, --show            filter results (files listed) based on issue status
+                         [all, clean, dirty]
    -t, --tags            list of tags to search for
    -u, --update          update remote repos with current issues
    -v, --version         print watson version and info
 
+
 Any number of files, tags, dirs, and ignores can be listed after flag
 Ignored files should be space separated
 To use *.filetype identifier, encapsulate in "" to avoid shell substitutions
@@ -116,8 +128,8 @@ If passed with `unite`, the output will be compatible with the unite.vim plugin
 
 If passed with `silent`, watson will have no output.  
 
-- This particular option is useful if remote posting to GitHub or Bitbucket is desired without the visual component of watson.  
-- For example, you could set up a **git commit hook** to post issues to GitHub/Bitbucket, but avoid the giant print out every time.
+- This particular option is useful if remote posting to GitHub, Bitbucket, or GitLab is desired without the visual component of watson.  
+- For example, you could set up a **git commit hook** to post issues to GitHub/Bitbucket/GitLab, but avoid the giant print out every time.
 
 
 ### -h, --help
@@ -137,10 +149,10 @@ If individual directories are passed with the -d (--dirs) flag, each will be par
 If watson is run without this parameter, the parsing depth is unlimited and will search through all subdirectories found.  
 
 
-### -r, --remote [GITHUB, BITBUCKET]
+### -r, --remote [GITHUB, BITBUCKET, GITLAB]
 This parameter is used to both list currently established remotes as well as setup new ones.  
 If passed without any options, the currently established remotes will be listed.  
-If passed with a github or bitbucket argument, watson will proceed to ask some questions to set up the corresponding remote.  
+If passed with a github, bitbucket, gitlab argument, watson will proceed to ask some questions to set up the corresponding remote.  
 
 
 ### -s, --show [ALL, CLEAN, DIRTY]
@@ -158,7 +170,7 @@ 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 not** post new issues by default therefore this parameter is required to push up to GitHub/Bitbucket/GitLab.  
 watson **does** pull issue status by default, therefore you will always be notified of resolved issues on GitHub/Bitbucket.  
 
 ### -v, --version
@@ -181,10 +193,12 @@ 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.  
 
-**[(github/bitbucket)]** - If a remote is established, the API key for the corresponding remote is stored here.  
+**[(github/bitbucket/gitlab)_api]** - 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.  
 
-**[(github/bitbucket)_repo]** - The repo name / path is stored here.  
+**[(github/bitbucket/gitlab)_repo]** - The repo name / path is stored here.  
+
+**[(github/gitlab)_endpoint]** - The endpoint in case of GitHub Enterprise of GitLab configuration.
 
 The remote related .watsonrc options shouldn't need to be edited manually, as they are automatically populated when the -r, --remote setup is called.  
 
@@ -208,6 +222,9 @@ Special thanks to [@eugenekolo](http://twitter.com/eugenekolo) [[email](eugenek@
 Special thanks to [@crowell](http://github.com/crowell) for testing out watson-ruby!  
 
 ## FAQ
+- ** Will inline issues get deleted if I close them on GitHub/Bitbucket/GitLab?**
+  No, watson won't touch your source code, it will only inform you that issues have been closed remotely.
+
 - **Why Ruby?**  
   I wanted to learn Ruby and this seemed like a pretty decent project.
 

data/lib/watson.rb

@@ -7,6 +7,7 @@ require_relative 'watson/formatters'
 require_relative 'watson/remote'
 require_relative 'watson/github'
 require_relative 'watson/bitbucket'
+require_relative 'watson/gitlab'
 require_relative 'watson/version'
 
 module Watson

data/lib/watson/bitbucket.rb

@@ -116,12 +116,13 @@ module Watson
       # 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,
-          :method     => "GET",
-          :basic_auth => [_username, _password],
-          :verbose    => false
-           }
+      opts = {
+        :url        => "https://bitbucket.org/api/1.0/repositories/#{_owner}/#{_repo}",
+        :ssl        => true,
+        :method     => "GET",
+        :basic_auth => [_username, _password],
+        :verbose    => false
+      }
 
       _json, _resp  = Watson::Remote.http_call(opts)
 
@@ -208,12 +209,13 @@ module Watson
       # Get all open tickets (anything but resolved)
       # 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
-           }
+      opts = {
+        :url        => "https://bitbucket.org/api/1.0/repositories/#{ config.bitbucket_repo }/issues",
+        :ssl        => true,
+        :method     => "GET",
+        :basic_auth => [config.bitbucket_api, config.bitbucket_pw],
+        :verbose    => false
+      }
 
       _json, _resp  = Watson::Remote.http_call(opts)
 
@@ -232,38 +234,23 @@ module Watson
       end
 
 
+      # Create hash entry from each returned issue
+      # MD5 of issue serves as hash key
+      # Hash value is another hash of info we will use
+      _json["issues"].each do |issue|
 
-      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
-      # 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
-           }
-
-      _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"
-        formatter.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 "      Status: #{ _resp.code } - #{ _resp.message }\n"
+        # Skip this issue if it doesn't have watson md5 tag
+        next if (_md5 = issue["content"].match(/__md5__ : (\w+)/)).nil?
 
-        debug_print "Bitbucket invalid, setting config var\n"
-        config.bitbucket_valid = false
-        return false
+        # If it does, use md5 as hash key and populate values with our info
+        config.bitbucket_issues[_md5[1]] = {
+          :title => issue["title"],
+          :id    => issue["local_id"],
+          :state => issue["status"]
+        }
       end
 
-      config.bitbucket_issues[:closed] = _json["issues"].empty? ? Hash.new : _json["issues"]
       config.bitbucket_valid = true
-      return true
     end
 
 
@@ -288,29 +275,10 @@ module Watson
         return false
       end
 
-      # Check that issue hasn't been posted already by comparing md5s
-      # Go through all open issues, if there is a match in md5, return out of method
-      # [todo] - Play with idea of making body of GitHub issue hash format to be exec'd
-      #      Store pieces in text as :md5 => "whatever" so when we get issues we can
-      #      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 |
-        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
 
-      debug_print "Checking closed issues to see if already posted\n"
-      config.bitbucket_issues[:closed].each do  | _closed |
-        if _closed["content"].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
+      # If issue exists in list we already obtained, skip posting
+      return false if config.bitbucket_issues.key?(issue[:md5])
+      debug_print "#{issue[:md5]} not found in remote issues, posting\n"
 
 
       # If we haven't obtained the pw from user yet, do it
@@ -342,7 +310,8 @@ module Watson
 
       # 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" +
+      _body =
+          "__filename__ : #{ issue[:path] }  \n" +
           "__line #__ : #{ issue[:line_number] }  \n" +
           "__tag__ : #{ issue[:tag] }  \n" +
           "__md5__ : #{ issue[:md5] }  \n\n" +
@@ -351,14 +320,15 @@ module Watson
       # Create option hash to pass to Remote::http_call
       # Issues URL for GitHub + SSL
       # No tag or label concept in Bitbucket unfortunately :(
-      opts = {:url        => "https://bitbucket.org/api/1.0/repositories/#{ config.bitbucket_repo }/issues",
-          :ssl        => true,
-          :method     => "POST",
-          :basic_auth => [config.bitbucket_api, config.bitbucket_pw],
-          :data   => [{"title" => issue[:title] + " [#{ issue[:path] }]",
-                  "content" => _body }],
-          :verbose    => false
-           }
+      opts = {
+        :url        => "https://bitbucket.org/api/1.0/repositories/#{ config.bitbucket_repo }/issues",
+        :ssl        => true,
+        :method     => "POST",
+        :basic_auth => [config.bitbucket_api, config.bitbucket_pw],
+        :data       => [{"title" => issue[:title] + " [#{ issue[:path] }]",
+                         "content" => _body }],
+        :verbose    => false
+      }
 
       _json, _resp  = Watson::Remote.http_call(opts)
 
@@ -373,6 +343,14 @@ module Watson
         return false
       end
 
+
+      # Parse response and append issue hash so we are up to date
+      config.bitbucket_issues[issue[:md5]] = {
+        :title => _json["title"],
+        :id    => _json["local_id"],
+        :state => _json["state"]
+      }
+
       return true
     end
 

data/lib/watson/command.rb

@@ -356,6 +356,7 @@ module Watson
       # For each argument passed, add to @config.ignore_list
       args.each do | _ignore |
         debug_print "Adding #{ _ignore } to config ignore_list\n"
+        _ignore = Regexp.escape(_ignore).gsub(/\\\*/, ".+")
         @config.ignore_list.push(_ignore)
       end
 
@@ -455,6 +456,11 @@ module Watson
         print BOLD + "Bitbucket Repo : " + RESET + "#{ @config.bitbucket_repo }\n\n" + RESET
       end
 
+      if !@config.gitlab_api.empty?
+        print BOLD + "GitLab User : " + RESET + "#{ @config.gitlab_api }\n" + RESET
+        print BOLD + "GitLab Repo : " + RESET + "#{ @config.gitlab_repo }\n\n" + RESET
+      end
+
       # 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
@@ -467,6 +473,11 @@ module Watson
         when "bitbucket"
           debug_print "Bitbucket setup called from CL\n"
           Watson::Remote::Bitbucket.setup(@config)
+
+        when "gitlab"
+          debug_print "GitLab setup called from CL\n"
+          Watson::Remote::GitLab.setup(@config)
+
         end
       elsif args.length > 1
         formatter.print_status "x", RED

data/lib/watson/config.rb

@@ -41,6 +41,9 @@ module Watson
     # Flag for where the temp file for printing is located
     attr_reader   :tmp_file
 
+    # Count of number of issues found
+    attr_accessor :issue_count
+
     # Flag for whether remote access is avaliable
     attr_accessor :remote_valid
 
@@ -66,6 +69,19 @@ module Watson
     attr_accessor :bitbucket_repo
     # Hash to hold list of all Bitbucket issues associated with repo
     attr_accessor :bitbucket_issues
+
+
+    # Flag for whether GitLab access is avaliable
+    attr_accessor :gitlab_valid
+    # GitLab API key generated from Remote::GitHub setup
+    attr_accessor :gitlab_api
+    # GitLab Endpoint (for GitHub Enterprise)
+    attr_accessor :gitlab_endpoint
+    # GitLab repo associated with current directory + watson config
+    attr_accessor :gitlab_repo
+    # Hash to hold list of all GitLab issues associated with repo
+    attr_accessor :gitlab_issues
+
     # Formatter
     attr_accessor :output_format
 
@@ -103,6 +119,7 @@ module Watson
       @dir_list     = Array.new()
       @file_list    = Array.new()
       @tag_list     = Array.new()
+      @issue_count  = 0
 
       # Remote options
       @remote_valid   = false
@@ -111,18 +128,26 @@ module Watson
       @github_api      = ""
       @github_endpoint = ""
       @github_repo     = ""
-      @github_issues   = {:open   => Hash.new(),
-                          :closed => Hash.new()
-                          }
+      @github_issues   = Hash.new()
+
+
 
       # Keep API param (and put username there) for OAuth update later
       @bitbucket_valid  = false
       @bitbucket_api    = ""
       @bitbucket_pw     = ""
       @bitbucket_repo   = ""
-      @bitbucket_issues   = {:open   => Hash.new(),
-                   :closed => Hash.new()
-                  }
+      @bitbucket_issues = Hash.new()
+
+
+      @gitlab_valid    = false
+      @gitlab_api      = ""
+      @gitlab_endpoint = ""
+      @gitlab_repo     = ""
+      @gitlab_issues   = Hash.new()
+
+
+
       @output_format = Watson::Formatters::DefaultFormatter
     end
 
@@ -138,6 +163,8 @@ module Watson
       exit if check_conf == false
       read_conf
 
+
+      # [review] - Theres gotta be a magic ruby way to trim this down
       unless @github_api.empty? && @github_repo.empty?
         Remote::GitHub.get_issues(self)
       end
@@ -145,6 +172,10 @@ module Watson
       unless @bitbucket_api.empty? && @bitbucket_repo.empty?
         Remote::Bitbucket.get_issues(self)
       end
+
+      unless @gitlab_api.empty? && @gitlab_repo.empty?
+        Remote::GitLab.get_issues(self)
+      end
     end
 
 
@@ -239,9 +270,9 @@ module Watson
       # [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
-      @ignore_list.push("..")
-      @ignore_list.push(@rc_file)
-      @ignore_list.push(@tmp_file)
+      @ignore_list.push(Regexp.escape(".."))
+      @ignore_list.push(Regexp.escape(@rc_file))
+      @ignore_list.push(Regexp.escape(@tmp_file))
 
       # Open and read rc
       # [review] - Not sure if explicit file close is required here
@@ -348,11 +379,12 @@ module Watson
             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]
+          # Convert each ignore into a regex
+          # Grab ignore and remove leading ./ and trailing /
+          _mtch = _line.match(/^(\.\/)?(\S+)/)[0].gsub(/\/$/, '')
+
+          # Escape all characters then replace \* with \.+
+          _mtch = Regexp.escape(_mtch).gsub(/\\\*/, ".+")
           if !_mtch.empty?
             @ignore_list.push(_mtch)
             debug_print "#{ _mtch } added to @ignore_list\n"
@@ -384,12 +416,30 @@ module Watson
           @bitbucket_api = _line.chomp!
           debug_print "Bitbucket API: #{ @bitbucket_api }\n"
 
+        when "bitbucket_pw"
+          # Same as GitHub parse above
+          @bitbucket_pw = _line.chomp!
+          debug_print "Bitbucket PW: #{ @bitbucket_pw }\n"
 
         when "bitbucket_repo"
           # Same as GitHub repo parse above
           @bitbucket_repo = _line.chomp!
           debug_print "Bitbucket Repo: #{ @bitbucket_repo }\n"
 
+        when "gitlab_api"
+          # Same as GitHub
+          @gitlab_api = _line.chomp!
+          debug_print "GitLab API: #{ @gitlab_api }\n"
+
+        when "gitlab_endpoint"
+        # Same as GitHub
+          @gitlab_endpoint = _line.chomp!
+          debug_print "GitLab Endpoint #{ @gitlab_endpoint }\n"
+
+        when "gitlab_repo"
+          # Same as GitHub
+          @gitlab_repo = _line.chomp!
+          debug_print "GitLab Repo: #{ @gitlab_repo }\n"
 
         else
           debug_print "Unknown tag found #{_section}\n"