hotspots 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+v0.3.0
+------
+
+* Optional colours for input and output from git. Use 'ansi' gem for colours
+
 v0.2.0
 ------
 

data/README.md

@@ -32,6 +32,7 @@ Specific options:
                                            All files are allowed when not specified
     -c, --cutoff [CUTOFF]                  The minimum occurrence to consider for a file to appear in the list. Defaults to zero
     -v, --verbose                          Show verbose output
+    -C, --colour, --color                  Show verbose output in colours
         --version                          Show version information
     -h, --help                             Show this message
 ```

data/TODO.md

@@ -1,4 +1,3 @@
 * Allow better use as a library - add documentation
 * Reduce conditionals
-* Optional support for colors
 * Remove compatibility layers in a major release

data/lib/hotspots.rb

@@ -6,7 +6,7 @@ require 'hotspots/repository'
 
 module Hotspots
   class Main
-    attr_reader :logger, :repository, :verbose,
+    attr_reader :logger, :repository, :verbose, :colour,
                 :exit_strategy, :driver, :parser, :store,
                 :time, :message_filters, :file_filter, :cutoff
 
@@ -18,6 +18,7 @@ module Hotspots
       @logger          = Hotspots::Logger.new
       @repository      = options[:repository]
       @verbose         = options[:verbose]
+      @colour          = options[:colour]
       @exit_strategy   = options[:exit_strategy]
 
       @time            = options[:time]
@@ -40,7 +41,7 @@ module Hotspots
 
     # TODO : this method should be private
     def set #:nodoc:
-      set_logger_if_verbose
+      configure_logger
       set_path
       assign
     end
@@ -70,10 +71,14 @@ module Hotspots
       end
     end
 
-    def set_logger_if_verbose
+    def configure_logger
       if verbose
         logger.as_console
       end
+
+      if colour
+        logger.colourize
+      end
     end
 
     def set_path

data/lib/hotspots/logger.rb

@@ -1,35 +1,63 @@
 module Hotspots
+  # Should understand log levels
   class Logger #:nodoc: all
-    class Console
-      def self.<<(message)
-        $stdout << message
+    module Sink
+      class Console
+        def self.<<(message)
+          $stdout << message
+        end
+      end
+
+      class Null
+        def self.<<(message)
+        end
       end
     end
 
-    class Null
-      def self.<<(message)
+    module Colour
+      class ANSI
+        def self.as(colour, message)
+          ::ANSI::Code.send(colour, message)
+        end
+      end
+
+      class Null
+        def self.as(colour, message)
+          message
+        end
       end
     end
 
-    attr_reader :sink
+    attr_reader :sink, :colour
+
     def initialize
-      @sink = Null
+      @sink = Sink::Null
+      @colour = Colour::Null
     end
 
     def as_console
-      @sink = Console
+      @sink = Sink::Console
     end
 
-    # compatibility begin
-    alias_method :set_console, :as_console
-    # compatibility end
+    def colourize
+      require 'ansi/code'
+      @colour = Colour::ANSI
+    end
 
-    def log(message)
-      @sink << format(message)
+    def log(message, options = {})
+      sink << format(message, options)
     end
 
-    def format(message)
-      "[#{Time.now}] #{message}\n"
+    # Make this method private
+    # Time stampimg should be part of log level
+    def format(message, options = {})
+      colour.as(options[:as] || "black", "[#{Time.now}] #{message}\n")
     end
+
+    # compatibility begin
+    alias_method :set_console, :as_console
+    Console = Sink::Console
+    Null = Sink::Null
+    # compatibility end
   end
 end

data/lib/hotspots/options_parser.rb

@@ -14,7 +14,8 @@ module Hotspots
           :message_filters => [""],
           :cutoff          => 0,
           :verbose         => false,
-          :exit_strategy   => OptionBasedExit::Noop.new
+          :exit_strategy   => OptionBasedExit::Noop.new,
+          :colour          => false,
         }
       end
     end
@@ -46,6 +47,7 @@ module Hotspots
         handle_message_filter_on(opts)
         handle_cutoff_on(opts)
         handle_verbosity_on(opts)
+        handle_colours_on(opts)
         handle_help_on(opts)
       end
     end
@@ -109,6 +111,13 @@ module Hotspots
       end
     end
 
+    def handle_colours_on(opts)
+      opts.on("-C", "--colour", "--color",
+              "Show verbose output in colours") do
+        @options[:colour] = true
+      end
+    end
+
     def handle_help_on(opts)
       opts.on_tail("-h", "--help",
                    "Show this message") do

data/lib/hotspots/repository/driver/git.rb

@@ -10,18 +10,18 @@ module Hotspots
 
         # Input and output should be optionally coloured
         def pretty_log(options)
-          command = log_with_tag("Input") { Command::Git::Log.new(:since_days => options[:since_days], :message_filter => options[:message_filter]).build }
-          log_with_tag("Output") { %x(#{command}) }
+          command = log_with_tag("Input", :as => :green) { Command::Git::Log.new(:since_days => options[:since_days], :message_filter => options[:message_filter]).build }
+          log_with_tag("Output", :as => :red) { %x(#{command}) }
         end
 
         # Input and output should be optionally coloured
         def show_one_line_names(options)
-          command = log_with_tag("Input") { Command::Git::Show.new(:commit_hash => options[:commit_hash]).build }
-          log_with_tag("Output") { %x(#{command}) }
+          command = log_with_tag("Input", :as => :green) { Command::Git::Show.new(:commit_hash => options[:commit_hash]).build }
+          log_with_tag("Output", :as => :red) { %x(#{command}) }
         end
 
-        def log_with_tag(tag, &block)
-          yield.tap { |raw| logger.log "<#{tag}>\n#{raw}<#{tag}/>" }
+        def log_with_tag(tag, options, &block)
+          yield.tap { |raw| logger.log("<#{tag}>\n#{raw}<#{tag}/>", :as => options[:as]) }
         end
       end
     end

data/lib/hotspots/version.rb

@@ -1,3 +1,3 @@
 module Hotspots
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/test/hotspots/options_parser_test.rb

@@ -6,38 +6,42 @@ module Hotspots
       @parser = OptionsParser.new
     end
 
-    describe "defaults" do
-      it "repository to current path" do
+    describe "#initialize" do
+      it "defaults repository to current path" do
         @parser.parse[:repository].must_equal "."
       end
 
-      it "time to 15" do
+      it "defaults time to 15" do
         @parser.parse[:time].must_equal 15
       end
 
-      it "file filter to empty string" do
+      it "defaults file filter to empty string" do
         @parser.parse[:file_filter].must_equal ""
       end
 
-      it "message filters to array with an empty string" do
+      it "defaults message filters to array with an empty string" do
         @parser.parse[:message_filters].must_equal [""]
       end
 
-      it "cutoff to 0" do
+      it "defaults cutoff to 0" do
         @parser.parse[:cutoff].must_equal 0
       end
 
-      it "verbose to nil" do
+      it "defaults verbose to nil" do
         @parser.parse[:verbose].must_equal false
       end
 
-      it "exit code to nil" do
+      it "defaults exit code to nil" do
         @parser.parse[:exit_strategy].code.must_equal nil
       end
 
-      it "exit message to empty string" do
+      it "defaults exit message to empty string" do
         @parser.parse[:exit_strategy].message.must_equal ""
       end
+
+      it "defaults colour to false" do
+        @parser.parse[:colour].must_equal false
+      end
     end
 
     ["--repository", "--repo", "-r"].each do |option|
@@ -108,6 +112,14 @@ module Hotspots
       end
     end
 
+    ["--color", "--colour", "-C"].each do |option|
+      describe option do
+        it "sets colours" do
+          @parser.parse(option)[:colour].must_equal true
+        end
+      end
+    end
+
     ["--help", "-h"].each do |option|
       describe option do
         it "sets exit code to zero" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotspots
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,8 +9,24 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-26 00:00:00.000000000 Z
+date: 2012-12-28 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: ansi
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -113,7 +129,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1394833690291643919
+      hash: -2901882375356969213
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -122,7 +138,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 1394833690291643919
+      hash: -2901882375356969213
 requirements: []
 rubyforge_project: hotspots
 rubygems_version: 1.8.24