watson-ruby 1.6.2 → 1.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 514fedab81cf81f62c7a4fb415d83750ebf05ad5
-  data.tar.gz: 4b63e079270286b0fd7bea2a3d1a5fc3e17310ff
+  metadata.gz: b8a024874dc8eeea248cbe763168012a330e18c8
+  data.tar.gz: ace9f356ed3afa6ca4e569c02796c0b09a4b485d
 SHA512:
-  metadata.gz: db6f2c055827b284eb40682f5bb137c7ee21cbdb85dde8924f3a2653c9f334922f6493af9c974d603957b0d3901cbd3f80fa31b84ebf8ef0be7a95dcd243dc10
-  data.tar.gz: 14a2b0d85756bb5357c49de86029be86d6a467f955d687af9269326049196809d16d342cc41b49de1dd6ad22ba65ae3924c3923245c60b63eba82aba94a9ff9e
+  metadata.gz: 54fb65d9d2cf0b41109cca529045a41aa0e0db0d8885dd919174df8cb2356b8e87e522db58594c01d416dc51d513f90d8f11ed4196d166e8aec51cec51d27142
+  data.tar.gz: 8e1522e949c5f4f7dc8b13e63ac760eb41121826333803157faf4b3b97735d677184e3e67284dc9273ac67455869299e10253dfed9eeb89b7690cdceefdfd763

data/Gemfile.lock

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

data/README.md

@@ -70,6 +70,7 @@ submit a pull request (comment parsing happens in **lib/watson/paser.rb**)
 - **HTML**
 - **Emacslisp**
 - **LaTex**
+- **Handlebars**
 
 
 ## Command line arguments

data/lib/watson/command.rb

@@ -172,6 +172,8 @@ module Watson
       @config.run
       structure = @parser.run
       @printer.run(structure)
+
+      print RESET;
     end
 
 
@@ -251,6 +253,9 @@ module Watson
         return false
       end
 
+      # Set config flag for CL context_set in config
+      @config.cl_context_set = true
+      debug_print "Updated cl_context_set flag: #{ @config.cl_context_set }\n"
 
       # For context_depth we do NOT append to RC, ALWAYS overwrite
       # For each argument passed, make sure valid, then set @config.parse_depth
@@ -393,6 +398,10 @@ module Watson
         return false
       end
 
+      # Set config flag for CL parse_set  in config
+      @config.cl_parse_set = true
+      debug_print "Updated cl_parse_set flag: #{ @config.cl_parse_set }\n"
+
       # 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 |
@@ -539,6 +548,10 @@ module Watson
         return false
       end
 
+      # Set config flag for CL tag set in config
+      @config.cl_output_set = true
+      debug_print "Updated cl_output_set flag: #{ @config.cl_output_set }\n"
+
       @config.output_format = case args.pop.to_s
         when 'j', 'json'
           Watson::Formatters::JsonFormatter
@@ -546,6 +559,8 @@ module Watson
           Watson::Formatters::UniteFormatter
         when 'silent'
           Watson::Formatters::SilentFormatter
+        when 'nocolor'
+          Watson::Formatters::NoColorFormatter
         else
           Watson::Formatters::DefaultFormatter
       end
@@ -568,6 +583,10 @@ module Watson
         return false
       end
 
+      # Set config flag for CL tag set in config
+      @config.cl_show_set = true
+      debug_print "Updated cl_show_set flag: #{ @config.cl_show_set }\n"
+
       args.each do | _show |
         case _show.downcase
         when 'clean'

data/lib/watson/config.rb

@@ -47,6 +47,14 @@ module Watson
     attr_accessor :cl_ignore_set
     # Flag for command line setting of tag to parse for
     attr_accessor :cl_tag_set
+    # Flag for command line setting of showtype
+    attr_accessor :cl_show_set
+    # Flag for command line setting of output format
+    attr_accessor :cl_output_set
+    # Flag for command line setting of context depth
+    attr_accessor :cl_context_set
+    # Flag for command line setting of parse depth
+    attr_accessor :cl_parse_set
 
     # Entries that watson should show
     attr_accessor :show_type
@@ -130,9 +138,11 @@ module Watson
       @context_depth  = 15
 
       # State flags
-      @cl_entry_set   = false
-      @cl_tag_set   = false
-      @cl_ignore_set  = false
+      @cl_entry_set  = false
+      @cl_tag_set    = false
+      @cl_ignore_set = false
+      @cl_show_set   = false
+      @cl_output_set = false
 
       @show_type = 'all'
 
@@ -183,7 +193,8 @@ module Watson
       @asana_issues    = Hash.new()
 
 
-      @output_format = Watson::Formatters::DefaultFormatter
+      @output_format = STDOUT.tty? ? Watson::Formatters::DefaultFormatter :
+                                     Watson::Formatters::NoColorFormatter
 
 
     end
@@ -362,15 +373,29 @@ module Watson
 
         case _section
         when "context_depth"
+          # If set from command line, ignore config file
+          if @cl_context_set
+            debug_print "Directories or files set from command line ignoring rc [context_depth]\n"
+            next
+          end
+
           # 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!.to_i
+          debug_print "@context_depth --> #{ @context_depth }\n"
 
 
         when "parse_depth"
+          # If set from command line, ignore config file
+          if @cl_parse_set
+            debug_print "Directories or files set from command line ignoring rc [parse_depth]\n"
+            next
+          end
+
           # 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!
+          debug_print "@parse_depth --> #{ @parse_depth }\n"
 
 
         when "dirs"
@@ -393,6 +418,36 @@ module Watson
           debug_print "@dir_list --> #{ @dir_list }\n"
 
 
+        when "output_format"
+          if @cl_output_set
+            debug_print "Output type set from command line, ignoring rc [output_format]\n"
+            next
+          end
+
+          # Set default output format for printing
+          _output = _line.chomp!
+
+          @output_format = case _output.downcase
+            when 'json'
+              debug_print "Output format set to JSON\n"
+              Watson::Formatters::JsonFormatter
+            when 'unite'
+              debug_print "Output format set to Unite\n"
+              Watson::Formatters::UniteFormatter
+            when 'silent'
+              debug_print "Output format set to Silent\n"
+              Watson::Formatters::SilentFormatter
+            when 'nocolor'
+              debug_print "Output format set to NoColor\n"
+              Watson::Formatters::NoColorFormatter
+            else
+             debug_print "Output format set to default (color or nocolor depending on tty)\n"
+             STDOUT.tty? ? Watson::Formatters::DefaultFormatter :
+                           Watson::Formatters::NoColorFormatter
+          end
+
+          debug_print "@output_format --> #{ @output_format }\n"
+
         when "tags"
           # Same as previous for tags
           # [review] - Populate @tag_list, then check size instead
@@ -414,7 +469,7 @@ module Watson
 
         when "tag_format"
           @tag_format = _line.chomp!
-          debug_print @tag_format
+          debug_print "@tag_format --> #{ @tag_format }\n"
 
         when "type"
           # Regex to grab ".type" => ["param1", "param2"]
@@ -425,16 +480,17 @@ module Watson
             @type_list[_ext] = _type
           end
 
+          deug_print "@type_list --> #{ @type_list }\n"
 
-        when "ignore"
-          # Same as previous for ignores
-          # [review] - Populate @tag_list, then check size instead
 
+        when "ignore"
           if @cl_ignore_set
             debug_print "Ignores set from command line, ignoring rc [ignores]\n"
             next
           end
 
+          # Same as previous for ignores
+          # [review] - Populate @tag_list, then check size instead
           # Convert each ignore into a regex
           # Grab ignore and remove leading ./ and trailing /
           _mtch = _line.match(/^(\.\/)?(\S+)/)[0].gsub(/\/$/, '')
@@ -449,8 +505,12 @@ module Watson
 
 
         when "show_type"
-          # No need for parsing, just check case
+          if @cl_show_set
+            debug_print "Show type set from command line, ignoring rc [show_type]\n"
+            next
+          end
 
+          # No need for parsing, just check case
           case _line.chomp.downcase
           when "clean"
             @show_type = "clean"
@@ -463,9 +523,10 @@ module Watson
           else
             @show_type = "all"
             debug_print "@show_type set to \"all\" from config\n"
-
           end
 
+          debug_print "@show_type --> #{ @show_type }\n"
+
 
         # Project directories reference $HOME/.watsonrc for GitHub API token
         # If we don't find a username=token format string, use username

data/lib/watson/formatters.rb

@@ -4,4 +4,5 @@ module Watson::Formatters
   autoload :JsonFormatter, 'watson/formatters/json_formatter'
   autoload :UniteFormatter, 'watson/formatters/unite_formatter'
   autoload :SilentFormatter, 'watson/formatters/silent_formatter'
+  autoload :NoColorFormatter, 'watson/formatters/nocolor_formatter'
 end

data/lib/watson/formatters/nocolor_formatter.rb

@@ -0,0 +1,198 @@
+module Watson::Formatters
+  class NoColorFormatter < BaseFormatter
+    def initialize(config)
+      super
+
+      @output = STDOUT
+    end
+
+    def run(structure)
+      debug_print "#{self} : #{__method__}\n"
+
+      output_result do
+        # Check Config to see if we have access to less for printing
+        # If so, open our temp file as the output to write to
+        # Else, just print out to STDOUT
+        # Print header for output
+        debug_print "Printing Header\n"
+
+        print_header
+
+        # Print out structure that was passed to this Printer
+        debug_print "Starting structure printing\n"
+        print_structure(structure)
+      end
+    end
+
+    ###########################################################
+    # Standard header print for class call (uses member cprint)
+    def print_header
+      # Identify method entry
+      debug_print "#{ self } : #{ __method__ }\n"
+
+      # Header
+      cprint <<-MESSAGE.gsub(/^(\s+)/, '')
+      ------------------------------
+      watson - inline issue manager\n
+
+      Run in: #{Dir.pwd}
+      Run @ #{Time.now.asctime}
+      ------------------------------\n
+      MESSAGE
+    end
+
+    ###########################################################
+    # Status printer for member call (uses member cprint)
+    # Print status block in standard format
+    def print_status(msg)
+      cprint "[ #{msg} ]"
+    end
+
+    private
+
+    def output_result(&block)
+      debug_print "#{self} : #{__method__}\n"
+      @output = if @config.use_less
+        debug_print "Unix less avaliable, setting output to #{@config.tmp_file}\n"
+        File.open(@config.tmp_file, 'w')
+      else
+        debug_print "Unix less is unavaliable, setting output to STDOUT\n"
+        STDOUT
+      end
+
+      yield
+
+      # If we are using less, close the output file, display with less, then delete
+      if @config.use_less
+        @output.close
+        # [review] - Way of calling a native Ruby less?
+        system("less -R #{@config.tmp_file}")
+        debug_print "File displayed with less, now deleting...\n"
+        File.delete(@config.tmp_file)
+      end
+    end
+
+    ###########################################################
+    # Go through all files and directories and call necessary printing methods
+    # Print all individual entries, call print_structure on each subdir
+    def print_structure(structure)
+      # Identify method entry
+      debug_print "#{self} : #{__method__}\n"
+
+      # First go through all the files in the current structure
+      # The current "structure" should reflect a dir/subdir
+      structure[:files].each do |file|
+        debug_print "Printing info for #{file}\n"
+        print_entry(file)
+      end
+
+      # Next go through all the subdirs and pass them to print_structure
+      structure[:subdirs].each do |subdir|
+        debug_print "Entering #{subdir} to print further\n"
+        print_structure(subdir)
+      end
+    end
+
+    ###########################################################
+    # Individual entry printer
+    # Uses issue hash to format printed output
+    def print_entry(entry)
+      # Identify method entry
+      debug_print "#{self} : #{__method__}\n"
+
+      # If no issues for this file, print that and break
+      # The filename print is repetative, but reduces another check later
+      if entry[:has_issues]
+        return true if @config.show_type == 'clean'
+
+        debug_print "Issues found for #{entry}\n"
+        cprint "\n"
+        print_status 'x'
+        cprint " #{entry[:relative_path]}\n"
+      else
+        unless @config.show_type == 'dirty'
+          debug_print "No issues for #{entry}\n"
+          print_status 'o'
+          cprint " #{entry[:relative_path]}\n"
+          return true
+        end
+      end
+
+      # [review] - Should the tag structure be self contained in the hash
+      #      Or is it ok to reference @config to figure out the tags
+      @config.tag_list.each do | tag |
+        debug_print "Checking for #{ tag }\n"
+        print_tag(tag, entry)
+      end
+    end
+
+    def print_tag(tag, entry)
+      # [review] - Better way to ignore tags through structure (hash) data
+      # Maybe have individual has_issues for each one?
+      if entry[tag].size.zero?
+        debug_print "#{ tag } has no issues, skipping\n"
+        return
+      end
+
+      debug_print "#{tag} has issues in it, print!\n"
+      print_status "#{tag}"
+      cprint "\n"
+
+      # Go through each issue in tag
+      entry[tag].each do |issue|
+        cprint "  line #{issue[:line_number]} - #{issue[:title]} "
+
+
+        # If there are any remote issues, print status and issue #
+        if _GH = @config.github_issues[issue[:md5]]
+          debug_print "Found #{ issue[:title]} in remote issues\n"
+
+          cprint <<-MESSAGE.gsub(/^(\s+)/, '').chomp
+          [GH##{_GH[:id]}]
+          MESSAGE
+        end
+
+        if _BB = @config.bitbucket_issues[issue[:md5]]
+          debug_print "Found #{ issue[:title]} in remote issues\n"
+
+          cprint <<-MESSAGE.gsub(/^(\s+)/, '').chomp
+          [BB##{_BB[:id]}]
+            MESSAGE
+        end
+
+
+        if _GL = @config.gitlab_issues[issue[:md5]]
+          debug_print "Found #{ issue[:title]} in remote issues\n"
+
+          cprint <<-MESSAGE.gsub(/^(\s+)/, '').chomp
+          [GL##{_GL[:id]}]
+            MESSAGE
+        end
+
+        if _AS = @config.asana_issues[issue[:md5]]
+          debug_print "Found #{ issue[:title]} in remote issues\n"
+          completed = _AS[:state]
+
+          cprint <<-MESSAGE.gsub(/^(\s+)/, '').chomp
+          [AS##{_AS[:id]}]
+          MESSAGE
+        end
+
+
+        cprint "\n"
+      end
+
+      cprint "\n"
+    end
+
+    ###########################################################
+    # Custom color print for member call
+    # Allows not only for custom color printing but writing to file vs STDOUT
+    def cprint(msg)
+      # Identify method entry
+      debug_print "#{self} : #{__method__}\n"
+
+      @output.write(msg)
+    end
+  end
+end

data/lib/watson/parser.rb

@@ -12,6 +12,56 @@ module Watson
     require 'digest'
     require 'pp'
 
+    COMMENT_DEFINITIONS = {
+        '.cpp'     => ['//', '/*'],        # C++
+        '.cxx'     => ['//', '/*'],
+        '.cc'      => ['//', '/*'],
+        '.hpp'     => ['//', '/*'],
+        '.hxx'     => ['//', '/*'],
+        '.c'       => ['//', '/*'],        # C
+        '.h'       => ['//', '/*'],
+        '.java'    => ['//', '/*', '/**'], # Java
+        '.class'   => ['//', '/*', '/**'],
+        '.cs'      => ['//', '/*'],        # C#
+        '.scss'    => ['//', '/*'],        # SASS SCSS
+        '.sass'    => ['//', '/*'],        # SASS SCSS
+        '.js'      => ['//', '/*'],        # JavaScript
+        '.php'     => ['//', '/*', '#'],   # PHP
+        '.m'       => ['//', '/*'],        # ObjectiveC
+        '.mm'      => ['//', '/*'],
+        '.go'      => ['//', '/*'],        # Go(lang)
+        '.scala'   => ['//', '/*'],        # Scala
+        '.erl'     => ['%%', '%'],         # Erlang
+        '.f'       => ['!'],               # Fortran
+        '.f90'     => ['!'],               # Fortran
+        '.F'       => ['!'],               # Fortran
+        '.F90'     => ['!'],               # Fortran
+        '.hs'      => ['--'],              # Haskell
+        '.sh'      => ['#'],               # Bash
+        '.rb'      => ['#'],               # Ruby
+        '.haml'    => ['-#'],              # Haml
+        '.pl'      => ['#'],               # Perl
+        '.pm'      => ['#'],
+        '.t'       => ['#'],
+        '.py'      => ['#'],               # Python
+        '.coffee'  => ['#'],               # CoffeeScript
+        '.zsh'     => ['#'],               # Zsh
+        '.clj'     => [';;'],              # Clojure
+        '.sql'     => ['---', '//', '#' ], # SQL and PL types
+        '.lua'     => ['--', '--[['],      # Lua
+        '.vim'     => ['"'],               # VimL
+        '.md'      => ['<!--'],            # Markdown
+        '.html'    => ['<!--'],            # HTML
+        '.el'      => [';'],               # Emacslisp
+        '.sqf'     => ['//','/*'],         # SQF
+        '.sqs'     => [';'],               # SQS
+        '.d'       => ['//','/*'],         # D
+        '.tex'     => ['%'],               # LaTex
+        '.hbs'     => ['{{!--'],           # Handlebars
+        '.twig'    => ['{#']               # Twig
+    }.freeze
+
+
     ###########################################################
     # Initialize the parser with the current watson config
     def initialize(config)
@@ -269,9 +319,9 @@ module Watson
         _issue_list[:has_issues] = true
 
         # [review] - This could probably be done better, elsewhere!
-        # If it's a HTML comment, remove trailing -->
-        if _mtch[0].match(/<!--/)
-          _title = _mtch[2].gsub(/-->/, "")
+        # If it's a HTML or Handlebars comment, remove trailing -->, --}}
+        if _mtch[0].match(/[<{]+(!--)?(#)?/)
+          _title = _mtch[2].gsub(/(--)?(#)?[>}]+/, "")
         else
           _title = _mtch[2]
         end
@@ -365,88 +415,16 @@ module Watson
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
 
-      # Grab the file extension (.something)
-      # Check to see whether it is recognized and set comment type
-      # If unrecognized, try to grab the next .something extension
-      # This is to account for file.cpp.1 or file.cpp.bak, ect
-
-      # [review] - Matz style while loop a la http://stackoverflow.com/a/10713963/1604424
-      # Create _mtch var so we can access it outside of the do loop
-
-
-
-      _ext = { '.cpp'     => ['//', '/*'],        # C++
-               '.cxx'     => ['//', '/*'],
-               '.cc'      => ['//', '/*'],
-               '.hpp'     => ['//', '/*'],
-               '.hxx'     => ['//', '/*'],
-               '.c'       => ['//', '/*'],        # C
-               '.h'       => ['//', '/*'],
-               '.java'    => ['//', '/*', '/**'], # Java
-               '.class'   => ['//', '/*', '/**'],
-               '.cs'      => ['//', '/*'],        # C#
-               '.scss'    => ['//', '/*'],        # SASS SCSS
-               '.sass'    => ['//', '/*'],        # SASS SCSS
-               '.js'      => ['//', '/*'],        # JavaScript
-               '.php'     => ['//', '/*', '#'],   # PHP
-               '.m'       => ['//', '/*'],        # ObjectiveC
-               '.mm'      => ['//', '/*'],
-               '.go'      => ['//', '/*'],        # Go(lang)
-               '.scala'   => ['//', '/*'],        # Scala
-               '.erl'     => ['%%', '%'],         # Erlang
-               '.f'       => ['!'],               # Fortran
-               '.f90'     => ['!'],               # Fortran
-               '.F'       => ['!'],               # Fortran
-               '.F90'     => ['!'],               # Fortran
-               '.hs'      => ['--'],              # Haskell
-               '.sh'      => ['#'],               # Bash
-               '.rb'      => ['#'],               # Ruby
-               '.pl'      => ['#'],               # Perl
-               '.pm'      => ['#'],
-               '.t'       => ['#'],
-               '.py'      => ['#'],               # Python
-               '.coffee'  => ['#'],               # CoffeeScript
-               '.zsh'     => ['#'],               # Zsh
-               '.clj'     => [';;'],              # Clojure
-               '.sql'     => ['---', '//', '#' ], # SQL and PL types
-               '.lua'     => ['--', '--[['],      # Lua
-               '.vim'     => ['"'],               # VimL
-               '.md'      => ['<!--'],            # Markdown
-               '.html'    => ['<!--'],            # HTML
-               '.el'      => [';'],               # Emacslisp
-               '.sqf'     => ['//','/*'],         # SQF
-               '.sqs'     => [';'],               # SQS
-               '.d'       => ['//','/*'],         # D
-               '.tex'     => ['%']                # LaTex
-             }
-
       # Merge config file type list with defaults
-      _ext.merge!(@config.type_list)
-      
-
-       loop do
-        _mtch = filename.match(/(\.(\S+))$/)
-        debug_print "Extension: #{ _mtch }\n"
-
-        # Break if we don't find a match
-        break if _mtch.nil?
+      _comments = COMMENT_DEFINITIONS.merge(@config.type_list)
 
-        return _ext[_mtch[0]] if _ext.has_key?(_mtch[0])
+      # Grab all possible extensions, check for comment match in reverse order
+      # Return comment type if found in comment definitions, else false
+      filename.split('.')[1..-1].each { |_ext| return _comments['.' << _ext] if _comments.has_key?('.' << _ext) }
 
-        # Can't recognize extension, keep looping in case of .bk, .#, ect
-        filename = filename.gsub(/(\.(\S+))$/, '')
-        debug_print "Didn't recognize, searching #{ filename }\n"
-
-      end
-
-      # We didn't find any matches from the filename, return error (0)
-      # Deal with what default to use in calling method
-      # [review] - Is Ruby convention to return 1 or 0 (or -1) on failure/error?
       debug_print "Couldn't find any recognized extension type\n"
       false
 
     end
-
-
   end
 end

data/lib/watson/version.rb

@@ -1,3 +1,3 @@
 module Watson
-  VERSION = "1.6.2"
+  VERSION = "1.6.3"
 end

data/spec/parser_spec.rb

@@ -93,6 +93,14 @@ describe Parser do
       it 'return correct extension (;; for clojure)' do
         @parser.get_comment_type('lib/watson.clj').should eql [';;']
       end
+
+      it 'return correct extension handlebars' do
+        @parser.get_comment_type('lib/watson.hbs').should eql ['{{!--']
+      end
+
+      it 'return correct extension jst handlebars' do
+        @parser.get_comment_type('lib/watson.jst.hbs').should eql ['{{!--']
+      end
     end
 
     context 'unknown extension' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watson-ruby
 version: !ruby/object:Gem::Version
-  version: 1.6.2
+  version: 1.6.3
 platform: ruby
 authors:
 - nhmood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-08 00:00:00.000000000 Z
+date: 2014-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -78,6 +78,7 @@ files:
 - lib/watson/formatters/base_formatter.rb
 - lib/watson/formatters/default_formatter.rb
 - lib/watson/formatters/json_formatter.rb
+- lib/watson/formatters/nocolor_formatter.rb
 - lib/watson/formatters/silent_formatter.rb
 - lib/watson/formatters/unite_formatter.rb
 - lib/watson/fs.rb