watson-ruby 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6526764e5a9d056f1e208763be9871e9097c7848
-  data.tar.gz: 13b5605c8e07c6e05ce2b035180c5327a115cbb6
+  metadata.gz: ca27dbddaa8f1c118cb988a0798bcac865a47c38
+  data.tar.gz: 1c474e7962dff2e93839f30bc3513cd27dd63153
 SHA512:
-  metadata.gz: 385b0d1fc3a4398fa63671ef1e96ac497c2e81924e2d6b8877b1df36bbea08b6e8bfca3edd2c3860a894d970deddd9cf18d51bfa2faf3b237ff569e192c2e70b
-  data.tar.gz: ba4a0830d8b1600da0b0506da9cedef1effb4c0cde820cc67d9b3e2261dc42a30c557201aed2a6b0df1e934c321c727da7d23f4c8d86de49661eee40f4870ddf
+  metadata.gz: 28d381b26c4216d36e987f5dd619ea78b0acd998e24b86df36376f68ab5283a3f53acac6141a2f913812064a1e5eb9721c618cc73673f70809f2f39f2d943efa
+  data.tar.gz: 60bb4d26b816e0f2276624984d01e60cd139a36feb94c8800e89948e4a2d7dab019a61a797cb22524c3591d569c5440853b1781b630ea6e7a0dfa46bd4a7259f

data/Gemfile.lock

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

data/lib/watson.rb

@@ -3,6 +3,7 @@ require_relative 'watson/config'
 require_relative 'watson/fs'
 require_relative 'watson/parser'
 require_relative 'watson/printer'
+require_relative 'watson/formatters'
 require_relative 'watson/remote'
 require_relative 'watson/github'
 require_relative 'watson/bitbucket'

data/lib/watson/bitbucket.rb

@@ -24,12 +24,13 @@ module Watson
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
-      Printer.print_status "+", GREEN
+      formatter = Printer.new(config).build_formatter
+      formatter.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
+        formatter.print_status "!", RED
         print BOLD + "Previous Bitbucket API + Repo is in RC, are you sure you want to overwrite?\n" + RESET
         print "      (Y)es/(N)o: "
 
@@ -37,14 +38,14 @@ module Watson
         _overwrite = $stdin.gets.chomp
         if ["no", "n"].include?(_overwrite.downcase)
           print "\n"
-          Printer.print_status "x", RED
+          formatter.print_status "x", RED
           print BOLD + "Not overwriting current Bitbucket API + repo info\n" + RESET
           return false
         end
       end
 
 
-      Printer.print_status "!", YELLOW
+      formatter.print_status "!", YELLOW
       print BOLD + "Access to your Bitbucket account required to make/update issues\n" + RESET
       print "      See help or README for more details on GitHub/Bitbucket access\n\n"
 
@@ -52,7 +53,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
+      formatter.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"
 
@@ -62,7 +63,7 @@ module Watson
       print BOLD + "Username: " + RESET
       _username = $stdin.gets.chomp
       if _username.empty?
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter your username!\n\n" + RESET
         return false
       end
@@ -70,7 +71,7 @@ module Watson
       print "\n"
 
       # Get repo information, if blank give error
-      Printer.print_status "!", YELLOW
+      formatter.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"
@@ -80,7 +81,7 @@ module Watson
       _owner = $stdin.gets.chomp
       if _owner.empty?
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter the owner the repo is under!\n\n" + RESET
         return false
       end
@@ -89,7 +90,7 @@ module Watson
       _repo = $stdin.gets.chomp
       if _repo.empty?
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter the repo name!\n\n" + RESET
         return false
       end
@@ -104,7 +105,7 @@ module Watson
       system "stty echo"
       print "\n"
       if _password.empty?
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input is blank. Please enter your password!\n\n" + RESET
         return false
       end
@@ -127,11 +128,11 @@ module Watson
       # Check response to validate authorization
       if _resp.code == "200"
         print "\n"
-        Printer.print_status "o", GREEN
+        formatter.print_status "o", GREEN
         print BOLD + "Successfully accessed remote repo with given credentials\n" + RESET
       else
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to access /#{ _owner }/#{ _repo } with given credentials\n" + RESET
         print "      Check that credentials are correct and repository exists under user\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n\n"
@@ -152,10 +153,10 @@ module Watson
       config.update_conf("bitbucket_api", "bitbucket_repo")
 
       print "\n"
-      Printer.print_status "o", GREEN
+      formatter.print_status "o", GREEN
       print BOLD + "Bitbucket successfully setup\n" + RESET
       print "      Issues will now automatically be retrieved from Bitbucket by default\n"
-      print "      Use -p, --push to post issues to GitHub\n"
+      print "      Use -u, --update to post issues to GitHub\n"
       print "      See help or README for more details on GitHub/Bitbucket access\n\n"
 
       return true
@@ -170,6 +171,12 @@ module Watson
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
+
+      # Set up formatter for printing errors
+      # config.output_format should be set based on less status by now
+      formatter = Printer.new(config).build_formatter
+
+
       # 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"
@@ -179,7 +186,7 @@ module Watson
       # If we haven't obtained the pw from user yet, do it
       if config.bitbucket_pw.empty?
         # No OAuth for Bitbucket yet, gotta get user password in order to make calls :(
-        Printer.print_status "!", YELLOW
+        formatter.print_status "!", YELLOW
         print BOLD + "Bitbucket password required for remote checking/posting.\n" + RESET
         print "      Password: "
 
@@ -213,7 +220,7 @@ module Watson
 
       # Check response to validate repo access
       if _resp.code != "200"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to access remote #{ config.bitbucket_repo }, Bitbucket API may be invalid\n" + RESET
         print "      Make sure you have created an issue tracker for your repository on the Bitbucket website\n"
         print "      Consider running --remote (-r) option to regenerate/validate settings\n"
@@ -244,7 +251,7 @@ module Watson
       # 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
+        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"
@@ -270,6 +277,11 @@ module Watson
       debug_print "#{self.class} : #{__method__}\n"
 
 
+      # Set up formatter for printing errors
+      # config.output_format should be set based on less status by now
+      formatter = Printer.new(config).build_formatter
+
+
       # 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"
@@ -304,7 +316,7 @@ module Watson
       # If we haven't obtained the pw from user yet, do it
       if config.bitbucket_pw.empty?
         # No OAuth for Bitbucket yet, gotta get user password in order to make calls :(
-        Printer.print_status "!", YELLOW
+        formatter.print_status "!", YELLOW
         print BOLD + "Bitbucket password required for remote checking/posting.\n" + RESET
         print "      Password: "
 
@@ -354,7 +366,7 @@ module Watson
       # 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
+        formatter.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 "      Status: #{ _resp.code } - #{ _resp.message }\n"

data/lib/watson/command.rb

@@ -23,18 +23,20 @@ module Watson
       debug_print "#{ self } : #{ __method__ }\n"
 
       # List of possible flags, used later in parsing and for user reference
-      _flag_list = ["-c", "--context-depth",
-                    "-d", "--dirs",
-                    "-f", "--files",
-                    "-h", "--help",
-                    "-i", "--ignore",
-                    "-p", "--parse-depth",
-                    "-r", "--remote",
-                    "-s", "--show",
-                    "-t", "--tags",
-                    "-u", "--update",
-                    "-v", "--version"
-                   ]
+      _flag_list = %w[
+        -c --context-depth
+        -d --dirs
+        -f --files
+        -h --help
+        -i --ignore
+        -p --parse-depth
+        -r --remote
+        -s --show
+        -t --tags
+        --format
+        -u --update
+        -v --version
+      ]
 
 
       # If we get the version or help flag, ignore all other flags
@@ -118,6 +120,10 @@ module Watson
           debug_print "Found -i/--ignore argument\n"
           set_ignores(_flag_args)
 
+        when '--format'
+          debug_print "Found --format argument\n"
+          set_output_format(_flag_args)
+
         when "-p", "--parse-depth"
           debug_print "Found -r/--parse-depth argument\n"
           set_parse_depth(_flag_args)
@@ -423,14 +429,15 @@ module Watson
       # Identify method entry
       debug_print "#{ self } : #{ __method__ }\n"
 
-      Printer.print_header
+      formatter = Printer.new(@config).build_formatter
+      formatter.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?
-        Printer.print_status "!", YELLOW
+        formatter.print_status "!", YELLOW
         print BOLD + "No remotes currently exist\n\n" + RESET
       end
 
@@ -458,7 +465,7 @@ module Watson
           Watson::Remote::Bitbucket.setup(@config)
         end
       elsif args.length > 1
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         puts <<-SUMMERY.gsub(/^ {,8}/, '')
         #{BOLD}Incorrect arguments passed#{RESET}
         Please specify either Github or Bitbucket to setup remote
@@ -470,6 +477,30 @@ module Watson
       end
     end
 
+    ###########################################################
+    # set_output_format
+    # Set format watson should output in
+    def set_output_format(args)
+      # Identify method entry
+      debug_print "#{ self } : #{ __method__ }\n"
+
+      # Need at least one file in args
+      unless args.length == 1
+        debug_print "Invalid argument passed\n"
+        return false
+      end
+
+      @config.output_format = case args.pop.to_s
+        when 'j', 'json'
+          Watson::Formatters::JsonFormatter
+        when 'unite'
+          Watson::Formatters::UniteFormatter
+        else
+          Watson::Formatters::DefaultFormatter
+      end
+
+      debug_print "Updated output_format to: #{@config.output_format}\n"
+    end
 
     ###########################################################
     # set_show

data/lib/watson/config.rb

@@ -35,7 +35,7 @@ module Watson
 
     # Entries that watson should show
     attr_accessor :show_type
-    
+
     # Flag for whether less is avaliable to print results
     attr_reader   :use_less
     # Flag for where the temp file for printing is located
@@ -66,7 +66,8 @@ module Watson
     attr_accessor :bitbucket_repo
     # Hash to hold list of all Bitbucket issues associated with repo
     attr_accessor :bitbucket_issues
-
+    # Formatter
+    attr_accessor :output_format
 
     ###########################################################
     # Config initialization method to setup necessary parameters, states, and vars
@@ -119,9 +120,10 @@ module Watson
       @bitbucket_api    = ""
       @bitbucket_pw     = ""
       @bitbucket_repo   = ""
-      @bitbucket_issues = {:open   => Hash.new(),
-                           :closed => Hash.new()
-                          }
+      @bitbucket_issues   = {:open   => Hash.new(),
+                   :closed => Hash.new()
+                  }
+      @output_format = Watson::Formatters::DefaultFormatter
     end
 
 

data/lib/watson/formatters.rb

@@ -0,0 +1,6 @@
+module Watson::Formatters
+  autoload :BaseFormatter, 'watson/formatters/base_formatter'
+  autoload :DefaultFormatter, 'watson/formatters/default_formatter'
+  autoload :JsonFormatter, 'watson/formatters/json_formatter'
+  autoload :UniteFormatter, 'watson/formatters/unite_formatter'
+end

data/lib/watson/formatters/base_formatter.rb

@@ -0,0 +1,10 @@
+module Watson::Formatters
+  class BaseFormatter
+    include Watson
+    DEBUG = false
+
+    def initialize(config)
+      @config = config
+    end
+  end
+end

data/lib/watson/formatters/default_formatter.rb

@@ -0,0 +1,196 @@
+module Watson::Formatters
+  class DefaultFormatter < 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(/^ {6}/, '')
+      #{BOLD}------------------------------#{RESET}
+      #{BOLD}watson#{RESET} - #{RESET}#{BOLD}#{YELLOW}inline issue manager#{RESET}
+
+      Run in: #{Dir.pwd}
+      Run @ #{Time.now.asctime}
+      #{BOLD}------------------------------\n#{RESET}
+      MESSAGE
+    end
+
+    ###########################################################
+    # Status printer for member call (uses member cprint)
+    # Print status block in standard format
+    def print_status(msg, color)
+      cprint "#{RESET}#{BOLD}#{WHITE}[ "
+      cprint "#{msg} ", color
+      cprint "#{WHITE}] #{RESET}"
+    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', RED
+        cprint " #{BOLD}#{UNDERLINE}#{RED}#{entry[:relative_path]}#{RESET}\n"
+      else
+        unless @config.show_type == 'dirty'
+          debug_print "No issues for #{entry}\n"
+          print_status 'o', GREEN
+          cprint " #{BOLD}#{UNDERLINE}#{GREEN}#{entry[:relative_path]}#{RESET}\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}", BLUE
+      cprint "\n"
+
+      # Go through each issue in tag
+      entry[tag].each do |issue|
+        cprint "#{WHITE}  line #{issue[:line_number]} - #{RESET}#{BOLD}#{issue[:title]}#{RESET}"
+
+        # Check to see if it has been resolved on GitHub/Bitbucket
+        debug_print "Checking if issue has been resolved\n"
+        @config.github_issues[:closed].each do | _closed |
+          if _closed["body"].include?(issue[:md5])
+            debug_print "Found in #{ _closed[:comment] }, not posting\n"
+            cprint <<-MESSAGE.gsub(/^(\s+)/, '')
+            #{BOLD} [#{RESET}#{GREEN}#{BOLD}Resolved on GitHub#{RESET}#{BOLD}]#{RESET}
+            MESSAGE
+          end
+          debug_print "Did not find in #{ _closed[:comment] }\n"
+        end
+
+        debug_print "Checking if issue has been resolved\n"
+        @config.bitbucket_issues[:closed].each do  |closed|
+          if closed['content'].include?(issue[:md5])
+            debug_print "Found in #{ closed["content"] }, not posting\n"
+            cprint <<-MESSAGE.gsub(/^(\s+)/, '')
+            #{BOLD} [#{RESET}#{GREEN}#{BOLD}Resolved on Bitbucket#{RESET}#{BOLD}]#{RESET}
+            MESSAGE
+          end
+          debug_print "Did not find in #{ closed["title"] }\n"
+        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 = '', color = '')
+      # Identify method entry
+      debug_print "#{self} : #{__method__}\n"
+
+      # This little check will allow us to take a Constant defined color
+      # As well as a [0-256] value if specified
+      if color.is_a?(String)
+        debug_print "Custom color specified for cprint\n"
+        @output.write(color)
+      elsif color.between?(0, 256)
+        debug_print "No or Default color specified for cprint\n"
+        @output.write("\e[38;5;#{color}m")
+      end
+
+      @output.write(msg)
+    end
+  end
+end

data/lib/watson/formatters/json_formatter.rb

@@ -0,0 +1,13 @@
+require 'json'
+
+module Watson::Formatters
+  class JsonFormatter < BaseFormatter
+    def run(structure)
+      debug_print "#{self} : #{__method__}\n"
+
+      File.open(@config.tmp_file, 'w') do |f|
+        f.write(structure.to_json)
+      end
+    end
+  end
+end

data/lib/watson/formatters/unite_formatter.rb

@@ -0,0 +1,60 @@
+require 'json'
+
+module Watson::Formatters
+  class UniteFormatter < BaseFormatter
+    def run(structure)
+      debug_print "#{self} : #{__method__}\n"
+
+      candidates = generate_candidates(structure)
+
+      File.open(@config.tmp_file, 'w') do |f|
+        f.write(candidates.to_json)
+      end
+    end
+
+    private
+
+    def generate_candidates(structure)
+      candidates = []
+
+      structure[:files].each do |file|
+        original_candidate = {
+          action__path: file[:absolute_path],
+          action__absolute_path: file[:absolute_path],
+          action__relative_path: file[:relative_path],
+          is_multiline: 1,
+          action__has_issue: file[:has_issues] ? 1 : 0,
+          action__tags: @config.tag_list,
+        }
+
+        if file[:has_issues]
+          @config.tag_list.each do |tag|
+            file[tag].each do |info|
+              candidates << original_candidate.dup.merge(create_candidate(file, info))
+            end
+          end
+        else
+          original_candidate[:word] = "[o] #{file[:relative_path]}"
+          candidates << original_candidate
+        end
+      end
+
+      structure[:subdirs].each do |dir|
+        candidates += generate_candidates(dir)
+      end
+
+      candidates
+    end
+
+    def create_candidate(file, info)
+      {
+        word: "[x] #{file[:relative_path]}:#{info[:line_number]}\n    #{info[:tag]} - #{info[:title]}",
+        action__line: info[:line_number],
+        action__tag: info[:tag],
+        action__md5: info[:md5],
+        action__title: info[:title],
+        action__context: info[:context],
+      }
+    end
+  end
+end

data/lib/watson/github.rb

@@ -11,7 +11,7 @@ module Watson
     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 formatter class so we dont need the formatter. for
     #      method calls?
     # [todo] - Keep asking for user data until valid instead of leaving app
 
@@ -27,12 +27,13 @@ module Watson
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
-      Printer.print_status "+", GREEN
+      formatter = Printer.new(config).build_formatter
+      formatter.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? && config.github_endpoint.empty?
-        Printer.print_status "!", RED
+        formatter.print_status "!", RED
         print BOLD + "Previous GitHub API + Repo is in RC, are you sure you want to overwrite?\n" + RESET
         print "      (Y)es/(N)o: "
 
@@ -40,19 +41,18 @@ module Watson
         _overwrite = $stdin.gets.chomp
         if ["no", "n"].include?(_overwrite.downcase)
           print "\n\n"
-          Printer.print_status "x", RED
+          formatter.print_status "x", RED
           print BOLD + "Not overwriting current GitHub API + repo info\n" + RESET
           return false
         end
       end
 
-      print "\n\n"
 
-      Printer.print_status "!", YELLOW
+      formatter.print_status "!", YELLOW
       print BOLD + "Access to your GitHub account required to make/update issues\n" + RESET
       print "      See help or README for more details on GitHub/Bitbucket access\n\n"
 
-      Printer.print_status "!", GREEN
+      formatter.print_status "!", GREEN
       print BOLD + "Is this a GitHub Enterprise account?\n" + RESET
       print "      (Y)es/(N)o: "
 
@@ -63,7 +63,7 @@ module Watson
         print BOLD + "GitHub API Endpoint: " + RESET
         _endpoint = $stdin.gets.chomp.chomp('/')
         if _endpoint.empty?
-          Printer.print_status "x", RED
+          formatter.print_status "x", RED
           print BOLD + "Input blank. Please enter your API endpoint!\n\n" + RESET
           return false
         end
@@ -78,7 +78,7 @@ module Watson
       print BOLD + "Username: " + RESET
       _username = $stdin.gets.chomp
       if _username.empty?
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter your username!\n\n" + RESET
         return false
       end
@@ -91,7 +91,7 @@ module Watson
       system "stty echo"
       print "\n\n"
       if _password.empty?
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input is blank. Please enter your password!\n\n" + RESET
         return false
       end
@@ -119,10 +119,10 @@ module Watson
 
       # Check response to validate authorization
       if _resp.code == "201"
-        Printer.print_status "o", GREEN
+        formatter.print_status "o", GREEN
         print BOLD + "Obtained OAuth Token\n\n" + RESET
       else
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to obtain OAuth Token\n" + RESET
         print "      Status: #{ _resp.code } - #{ _resp.message }\n\n"
         return false
@@ -136,7 +136,7 @@ module Watson
 
 
       # Get repo information, if blank give error
-      Printer.print_status "!", YELLOW
+      formatter.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"
@@ -146,7 +146,7 @@ module Watson
       _owner = $stdin.gets.chomp
       if _owner.empty?
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter the owner the repo is under!\n\n" + RESET
         return false
       end
@@ -155,7 +155,7 @@ module Watson
       _repo = $stdin.gets.chomp
       if _repo.empty?
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Input blank. Please enter the repo name!\n\n" + RESET
         return false
       end
@@ -184,7 +184,7 @@ module Watson
       # Check response to validate repo access
       if _resp.code == "404"
         print "\n"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to access /#{ _owner }/#{ _repo } with given credentials\n" + RESET
         print "      Check that credentials are correct and repository exists under user\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n\n"
@@ -194,7 +194,7 @@ module Watson
         # If it is anything but a 404, I THINK it means we have access...
         # Will assume that until proven otherwise
         print "\n"
-        Printer.print_status "o", GREEN
+        formatter.print_status "o", GREEN
         print BOLD + "Repo successfully accessed\n\n" + RESET
       end
 
@@ -203,16 +203,16 @@ module Watson
       debug_print "Config GitHub API Key updated to: #{ config.github_repo }\n"
 
       # Inform user of label creation status (created above)
-      Printer.print_status "+", GREEN
+      formatter.print_status "+", GREEN
       print BOLD + "Creating label for watson on GitHub...\n" + RESET
       if _resp.code == "201"
-        Printer.print_status "+", GREEN
+        formatter.print_status "+", GREEN
         print BOLD + "Label successfully created\n" + RESET
       elsif _resp.code == "422" && _json["code"] == "already_exists"
-        Printer.print_status "!", YELLOW
+        formatter.print_status "!", YELLOW
         print BOLD + "Label already exists\n" + RESET
       else
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to create label for /#{ _owner }/#{ _repo }\n" + RESET
         print "      Status: #{ _resp.code } - #{ _resp.message }\n"
       end
@@ -224,7 +224,7 @@ module Watson
 
       # Give user some info
       print "\n"
-      Printer.print_status "o", GREEN
+      formatter.print_status "o", GREEN
       print BOLD + "GitHub successfully setup\n" + RESET
       print "      Issues will now automatically be retrieved from GitHub by default\n"
       print "      Use -u, --update to post issues to GitHub\n"
@@ -243,6 +243,10 @@ module Watson
       # Identify method entry
       debug_print "#{ self.class } : #{ __method__ }\n"
 
+      # Set up formatter for printing errors
+      # config.output_format should be set based on less status by now
+      formatter = Printer.new(config).build_formatter
+
       # 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"
@@ -265,7 +269,7 @@ module Watson
 
       # Check response to validate repo access
       if _resp.code != "200"
-        Printer.print_status "x", RED
+        formatter.print_status "x", RED
         print BOLD + "Unable to access remote #{ config.github_repo }, GitHub API may be invalid\n" + RESET
         print "      Consider running --remote (-r) option to regenerate key\n\n"
         print "      Status: #{ _resp.code } - #{ _resp.message }\n"
@@ -293,7 +297,7 @@ module Watson
       # 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
+        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"
@@ -319,6 +323,11 @@ module Watson
       debug_print "#{ self.class } : #{ __method__ }\n"
 
 
+      # Set up formatter for printing errors
+      # config.output_format should be set based on less status by now
+      formatter = Printer.new(config).build_formatter
+
+
       # 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"
@@ -378,7 +387,7 @@ module Watson
       # 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
+        formatter.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 "      Status: #{ _resp.code } - #{ _resp.message }\n"

data/lib/watson/parser.rb

@@ -397,6 +397,10 @@ module Watson
                '.go'      => ['//', '/*'],        # Go(lang)
                '.scala'   => ['//', '/*'],        # Scala
                '.erl'     => ['%%', '%'],         # Erlang
+               '.f'       => ['!'],               # Fortran
+               '.f90'     => ['!'],               # Fortran
+               '.F'       => ['!'],               # Fortran
+               '.F90'     => ['!'],               # Fortran
                '.hs'      => ['--'],              # Haskell
                '.sh'      => ['#'],               # Bash
                '.rb'      => ['#'],               # Ruby
@@ -406,7 +410,8 @@ module Watson
                '.py'      => ['#'],               # Python
                '.coffee'  => ['#'],               # CoffeeScript
                '.zsh'     => ['#'],               # Zsh
-               '.clj'     => [';;']               # Clojure
+               '.clj'     => [';;'],              # Clojure
+               '.sql'     => ['---', '//', '#' ]  # SQL and PL types
              }
 
       loop do

data/lib/watson/printer.rb

@@ -1,22 +1,19 @@
 module Watson
-
-    # Color definitions for pretty printing
-    # Defined here because we need Global scope but makes sense to have them
-    # in the printer.rb file at least
-
-    BOLD      = "\e[01m"
-    UNDERLINE = "\e[4m"
-    RESET     = "\e[00m"
-
-    GRAY      = "\e[38;5;0m"
-    RED       = "\e[38;5;1m"
-    GREEN     = "\e[38;5;2m"
-    YELLOW    = "\e[38;5;3m"
-    BLUE      = "\e[38;5;4m"
-    MAGENTA   = "\e[38;5;5m"
-    CYAN      = "\e[38;5;6m"
-    WHITE     = "\e[38;5;7m"
-
+  # Color definitions for pretty printing
+  # Defined here because we need Global scope but makes sense to have them
+  # in the printer.rb file at least
+  BOLD      = "\e[01m"
+  UNDERLINE = "\e[4m"
+  RESET     = "\e[00m"
+
+  GRAY      = "\e[38;5;0m"
+  RED       = "\e[38;5;1m"
+  GREEN     = "\e[38;5;2m"
+  YELLOW    = "\e[38;5;3m"
+  BLUE      = "\e[38;5;4m"
+  MAGENTA   = "\e[38;5;5m"
+  CYAN      = "\e[38;5;6m"
+  WHITE     = "\e[38;5;7m"
 
   # Printer class that handles all formatting and printing of parsed dir/file structure
   class Printer
@@ -31,268 +28,25 @@ module Watson
     # Debug printing for this class
     DEBUG = false
 
-    class << self
-
-    # Include for debug_print (for static methods)
-    include Watson
-
-    ###########################################################
-    # Custom color print for static call (only writes to STDOUT)
-    def cprint (msg = "", color = "")
-
-      # Identify method entry
-      debug_print "#{ self } : #{ __method__ }\n"
-
-      # This little check will allow us to take a Constant defined color
-      # As well as a [0-256] value if specified
-      if (color.is_a?(String))
-        debug_print "Custom color specified for cprint\n"
-        STDOUT.write(color)
-      elsif (color.between?(0, 256))
-        debug_print "No or Default color specified for cprint\n"
-        STDOUT.write("\e[38;5;#{ color }m")
-      end
-
-      STDOUT.write(msg)
-    end
-
-
-    ###########################################################
-    # Standard header print for static call (uses static cprint)
-    def print_header
-
-      # Identify method entry
-      debug_print "#{ self } : #{ __method__ }\n"
-
-      # Header
-      cprint BOLD + "------------------------------\n" + RESET
-      cprint BOLD + "watson" + RESET
-      cprint " - " + RESET
-      cprint BOLD + YELLOW + "inline issue manager\n" + RESET
-      cprint BOLD + "------------------------------\n\n" + RESET
-
-      return true
-    end
-
-
-    ###########################################################
-    # Status printer for static call (uses static cprint)
-    # Print status block in standard format
-    def print_status(msg, color)
-      cprint RESET + BOLD
-      cprint WHITE + "[ "
-      cprint "#{ msg } ", color
-      cprint WHITE + "] " + RESET
-    end
-
-    end
-
     ###########################################################
     # Printer initialization method to setup necessary parameters, states, and vars
     def initialize(config)
-
       # Identify method entry
-      debug_print "#{ self } : #{ __method__ }\n"
-
+      debug_print "#{self} : #{__method__}\n"
       @config = config
-      return true
     end
 
-
     ###########################################################
     # Take parsed structure and print out in specified formatting
     def run(structure)
-
       # Identify method entry
-      debug_print "#{ self } : #{ __method__ }\n"
-
-      # 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
-      if @config.use_less
-        debug_print "Unix less avaliable, setting output to #{ @config.tmp_file }\n"
-        @output = File.open(@config.tmp_file, 'w')
-      else
-        debug_print "Unix less is unavaliable, setting output to STDOUT\n"
-        @output = STDOUT
-      end
-
-      # 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)
+      debug_print "#{self} : #{__method__}\n"
 
-      # 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
-
-      return true
+      build_formatter.run(structure)
     end
 
-
-    ###########################################################
-    # Custom color print for member call
-    # Allows not only for custom color printing but writing to file vs STDOUT
-    def cprint (msg = "", color = "")
-
-      # Identify method entry
-      debug_print "#{ self } : #{ __method__ }\n"
-
-      # This little check will allow us to take a Constant defined color
-      # As well as a [0-256] value if specified
-      if (color.is_a?(String))
-        debug_print "Custom color specified for cprint\n"
-        @output.write(color)
-      elsif (color.between?(0, 256))
-        debug_print "No or Default color specified for cprint\n"
-        @output.write("\e[38;5;#{ color }m")
-      end
-
-      @output.write(msg)
-    end
-
-
-    ###########################################################
-    # Standard header print for class call (uses member cprint)
-    def print_header
-      # Identify method entry
-
-      debug_print "#{ self } : #{ __method__ }\n"
-
-      # Header
-      cprint BOLD + "------------------------------\n" + RESET
-      cprint BOLD + "watson" + RESET
-      cprint " - " + RESET
-      cprint BOLD + YELLOW + "inline issue manager\n\n" + RESET
-      cprint "Run in: #{ Dir.pwd }\n"
-      cprint "Run @ #{ Time.now.asctime }\n"
-      cprint BOLD + "------------------------------\n\n" + RESET
-
-      return true
+    def build_formatter
+      @formatter ||= @config.output_format.new(@config)
     end
-
-
-    ###########################################################
-    # Status printer for member call (uses member cprint)
-    # Print status block in standard format
-    def print_status(msg, color)
-      cprint RESET + BOLD
-      cprint WHITE + "[ "
-      cprint "#{ msg } ", color
-      cprint WHITE + "] " + RESET
-    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]
-        if @config.show_type != 'dirty'
-          debug_print "No issues for #{ entry }\n"
-          print_status "o", GREEN
-          cprint BOLD + UNDERLINE + GREEN + "#{ entry[:relative_path] }" + RESET + "\n"
-          return true
-        end
-      else
-        if @config.show_type != 'clean'
-          debug_print "Issues found for #{ entry }\n"
-          cprint "\n"
-          print_status "x", RED
-          cprint BOLD + UNDERLINE + RED + "#{entry[:relative_path]}" + RESET + "\n"
-        else
-          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"
-
-        # [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"
-          next
-        end
-
-        debug_print "#{ _tag } has issues in it, print!\n"
-        print_status "#{ _tag }", BLUE
-        cprint "\n"
-
-        # Go through each issue in tag
-        entry[_tag].each do | _issue |
-          cprint WHITE + "  line #{ _issue[:line_number] } - " + RESET
-          cprint BOLD + "#{ _issue[:title] }" + RESET
-
-
-          # Check to see if it has been resolved on GitHub/Bitbucket
-          debug_print "Checking if issue has been resolved\n"
-          @config.github_issues[:closed].each do | _closed |
-            if _closed["body"].include?(_issue[:md5])
-              debug_print "Found in #{ _closed[:comment] }, not posting\n"
-              cprint BOLD + " [" + RESET
-              cprint GREEN + BOLD + "Resolved on GitHub" + RESET
-              cprint BOLD + "]" + RESET
-            end
-            debug_print "Did not find in #{ _closed[:comment] }\n"
-          end
-
-          debug_print "Checking if issue has been resolved\n"
-          @config.bitbucket_issues[:closed].each do  | _closed |
-            if _closed["content"].include?(_issue[:md5])
-              debug_print "Found in #{ _closed["content"] }, not posting\n"
-              cprint BOLD + " [" + RESET
-              cprint GREEN + BOLD + "Resolved on Bitbucket" + RESET
-              cprint BOLD + "]\n" + RESET
-            end
-            debug_print "Did not find in #{ _closed["title"] }\n"
-          end
-          cprint "\n"
-
-        end
-        cprint "\n"
-      end
-    end
-
   end
 end

data/lib/watson/version.rb

@@ -1,3 +1,3 @@
 module Watson
-  VERSION = "1.2.0"
+  VERSION = "1.3.0"
 end

data/watson.gemspec

@@ -26,7 +26,7 @@ Gem::Specification.new do |s|
   s.required_ruby_version = '>= 2.0.0'
 
   # Runtime Dependencies
-  s.add_runtime_dependency 'json'
+  s.add_runtime_dependency (RUBY_PLATFORM == 'java' ? 'json_pure' : 'json')
 
   # Development Dependencies
   s.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: watson-ruby
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - nhmood
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-28 00:00:00.000000000 Z
+date: 2013-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -73,6 +73,11 @@ files:
 - lib/watson/bitbucket.rb
 - lib/watson/command.rb
 - lib/watson/config.rb
+- lib/watson/formatters.rb
+- lib/watson/formatters/base_formatter.rb
+- lib/watson/formatters/default_formatter.rb
+- lib/watson/formatters/json_formatter.rb
+- lib/watson/formatters/unite_formatter.rb
 - lib/watson/fs.rb
 - lib/watson/github.rb
 - lib/watson/parser.rb