hotspots 0.1.1 → 0.2.0

data/CHANGELOG.md

@@ -1,5 +1,11 @@
+v0.2.0
+------
+
+* Use default options when invoked as a library
+* Restructure interfaces for Logger, ExitStrategy & Hotspots. The older classes, modules and methods are still available
+
 v0.1.1
--------
+------
 
 * Sort for an array of array via spaceship operator returns different result on each run on ruby 1.8.7. Store has a string representation breaks intermittently on 1.8.7. Tests fail intermittently on 1.8.7. So support for ruby 1.9.x only
 * Simplify Rakefile

data/README.md

@@ -28,7 +28,7 @@ Specific options:
     -t, --time [TIME]                      Time in days to scan the repository for. Defaults to fifteen
     -r, --repository [PATH]                Path to the repository to scan. Defaults to current path
     -f, --file-filter [REGEX]              Regular expression to filtering file names. All files are allowed when not specified
-    -m, --message-filter [PIPE SEPARATED]  Values to filter files names against each commit message separated by pipe.
+    -m, --message-filter [PIPE SEPARATED]  Pipe separated values to filter files names against each commit message.
                                            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

data/TODO.md

@@ -1,4 +1,4 @@
 * Allow better use as a library - add documentation
-* Don't barf if not inside root directory of git
-* Hotspots#initialize validates presence of mandatory arguments - useful when used as library
+* Reduce conditionals
 * Optional support for colors
+* Remove compatibility layers in a major release

data/bin/hotspots

@@ -2,4 +2,4 @@
 
 require 'hotspots'
 
-Hotspots::Main.new.execute!
+Hotspots::Main.new.output

data/lib/hotspots.rb

@@ -6,54 +6,73 @@ require 'hotspots/repository'
 
 module Hotspots
   class Main
-    attr_reader :logger, :options, :repository, :verbose,
-                :exit_strategy, :driver, :parser, :store
+    attr_reader :logger, :repository, :verbose,
+                :exit_strategy, :driver, :parser, :store,
+                :time, :message_filters, :file_filter, :cutoff
 
+    # TODO : change this signature - this method should get resolved options as parameters
+    # initialize is not responsible for invoking option parsing
     def initialize(opts = nil)
-      @options       = opts || Hotspots::OptionsParser.new.parse(*ARGV)
-      @repository    = options[:repository]
-      @verbose       = options[:verbose]
-      @exit_strategy = options[:exit_strategy]
-      @logger        = Hotspots::Logger.new
+      options          = opts.nil? ? Hotspots::OptionsParser.new.parse(*ARGV) : Hotspots::OptionsParser.default_options.merge(opts)
+
+      @logger          = Hotspots::Logger.new
+      @repository      = options[:repository]
+      @verbose         = options[:verbose]
+      @exit_strategy   = options[:exit_strategy]
+
+      @time            = options[:time]
+      @message_filters = options[:message_filters]
+      @file_filter     = options[:file_filter]
+      @cutoff          = options[:cutoff]
     end
 
-    def execute!
-      validate!
+    def output
+      validate
       set
       run
     end
 
-    def validate!
-      validate_early_exit!
-      validate_git_repository!
+    # TODO : this method should be private
+    def validate #:nodoc:
+      exit_if_options_are_for_help
+      exit_if_not_git_repository
     end
 
-    def set
-      set_logger
+    # TODO : this method should be private
+    def set #:nodoc:
+      set_logger_if_verbose
       set_path
       assign
     end
 
-    def run
+    # TODO : this method should be private
+    def run #:nodoc:
       puts store.to_s
     end
 
+    # TODO : these methods should be private
+    # compatibility begin
+    alias_method :execute!, :output
+    alias_method :validate!, :validate
+    # compatibility end
+
     private
 
-    def validate_early_exit!
+    def exit_if_options_are_for_help
       exit_strategy.perform
     end
 
-    def validate_git_repository!
-      if not File.directory?(repository) or not File.directory?(File.join(repository, '.git'))
+    def exit_if_not_git_repository
+      output = `git status 2>&1`
+      unless $? == 0
         puts "'#{repository}' doesn't seem to be a git repository!"
         exit 10
       end
     end
 
-    def set_logger
+    def set_logger_if_verbose
       if verbose
-        logger.set_console
+        logger.as_console
       end
     end
 
@@ -62,9 +81,9 @@ module Hotspots
     end
 
     def assign
-      @driver = Hotspots::Repository::Driver::Git.new logger
-      @parser = Hotspots::Repository::Parser::Git.new driver, options.clone
-      @store  = Hotspots::Store.new parser.files, options.clone
+      @driver  = Hotspots::Repository::Driver::Git.new logger
+      @parser  = Hotspots::Repository::Parser::Git.new driver, :time => time, :message_filters => message_filters
+      @store   = Hotspots::Store.new parser.files, :cutoff => cutoff, :file_filter => file_filter
     end
   end
 end

data/lib/hotspots/exit_strategy.rb

@@ -1,41 +1,13 @@
+# compatibility begin
 module Hotspots
-  class ExitStrategy
-    attr_reader :code, :message
-
-    def initialize(options)
-      @message = options[:message]
-      @code    = options[:code]
-    end
-
-    def perform
-      puts @message
-      exit @code
-    end
-
-    class Safe
-      attr_reader :code, :message
-
-      def initialize(options)
-        @message = options[:message]
-        @code    = 0
-      end
-
-      def perform
-        puts @message
-        exit @code
-      end
-    end
-
-    class Null
-      attr_reader :code, :message
-
-      def initialize(options = {})
-        @message = ""
-        @code    = nil
-      end
-
-      def perform
-      end
-    end
+  module OptionBasedExit #:nodoc: all
+    class Error; end
+    class Safe; end
+    class Noop; end
+
+    ExitStrategy = Error
+    ExitStrategy::Safe = Safe
+    ExitStrategy::Null = Noop
   end
 end
+# compatibility end

data/lib/hotspots/logger.rb

@@ -1,5 +1,5 @@
 module Hotspots
-  class Logger
+  class Logger #:nodoc: all
     class Console
       def self.<<(message)
         $stdout << message
@@ -16,10 +16,14 @@ module Hotspots
       @sink = Null
     end
 
-    def set_console
+    def as_console
       @sink = Console
     end
 
+    # compatibility begin
+    alias_method :set_console, :as_console
+    # compatibility end
+
     def log(message)
       @sink << format(message)
     end

data/lib/hotspots/option_based_exit.rb

@@ -0,0 +1,47 @@
+module Hotspots
+  module OptionBasedExit #:nodoc: all
+    class Error
+      attr_reader :code, :message
+
+      def initialize(options)
+        @message = options[:message]
+        @code    = options[:code]
+      end
+
+      def perform
+        puts @message
+        exit @code
+      end
+    end
+
+    class Safe
+      attr_reader :code, :message
+
+      def initialize(options)
+        @message = options[:message]
+        @code    = 0
+      end
+
+      def perform
+        puts @message
+        exit @code
+      end
+    end
+
+    class Noop
+      attr_reader :code, :message
+
+      def initialize(options = {})
+        @message = ""
+        @code    = nil
+      end
+
+      def perform
+      end
+    end
+  end
+end
+
+# compatibility begin
+require 'hotspots/exit_strategy'
+# compatibility end

data/lib/hotspots/options_parser.rb

@@ -1,20 +1,26 @@
 require 'optparse'
 
 require 'hotspots/version'
-require 'hotspots/exit_strategy'
+require 'hotspots/option_based_exit'
 
 module Hotspots
-  class OptionsParser
+  class OptionsParser #:nodoc: all
+    class << self
+      def default_options
+        {
+          :time            => 15,
+          :repository      => ".",
+          :file_filter     => "",
+          :message_filters => [""],
+          :cutoff          => 0,
+          :verbose         => false,
+          :exit_strategy   => OptionBasedExit::Noop.new
+        }
+      end
+    end
+
     def initialize
-      @options = {
-        :time            => 15,
-        :repository      => ".",
-        :file_filter     => "",
-        :message_filters => [""],
-        :cutoff          => 0,
-        :verbose         => false,
-        :exit_strategy   => ExitStrategy::Null.new
-      }
+      @options = self.class.default_options
     end
 
     def parse(*args)
@@ -22,7 +28,7 @@ module Hotspots
       begin
         parser.parse args
       rescue ::OptionParser::InvalidOption, ::OptionParser::InvalidArgument => ex
-        @options[:exit_strategy] = ExitStrategy.new(:code => 1, :message => (ex.to_s << "\nUse -h for help\n"))
+        @options[:exit_strategy] = OptionBasedExit::Error.new(:code => 1, :message => (ex.to_s << "\nUse -h for help\n"))
       end
       @options
     end
@@ -83,7 +89,7 @@ module Hotspots
 
     def handle_message_filter_on(opts)
       opts.on("-m", "--message-filter [PIPE SEPARATED]", String,
-              "Pipe separated values to filter files names against each commit message separated by pipe.",
+              "Pipe separated values to filter files names against each commit message.",
               "All files are allowed when not specified") do |o|
         @options[:message_filters] = o.to_s.split("|")
       end
@@ -106,7 +112,7 @@ module Hotspots
     def handle_help_on(opts)
       opts.on_tail("-h", "--help",
                    "Show this message") do
-        @options[:exit_strategy] = ExitStrategy::Safe.new(:message => opts.to_s)
+        @options[:exit_strategy] = OptionBasedExit::Safe.new(:message => opts.to_s)
       end
     end
   end

data/lib/hotspots/repository.rb

@@ -1,2 +1,3 @@
+require 'hotspots/repository/command'
 require 'hotspots/repository/driver'
 require 'hotspots/repository/parser'

data/lib/hotspots/repository/command.rb

@@ -0,0 +1 @@
+require 'hotspots/repository/command/git'

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

@@ -0,0 +1,40 @@
+module Hotspots
+  module Repository #:nodoc: all
+    module Command
+      module Git
+        class Log
+          attr_reader :since_days, :message_filter
+
+          def initialize(options)
+            @since_days     = options[:since_days]
+            @message_filter = options[:message_filter].to_s
+          end
+
+          def build
+            "git log --pretty=\"%H\" #{since_clause}#{grep_clause}"
+          end
+
+          def since_clause
+            "--since=\"#{since_days} days ago\""
+          end
+
+          def grep_clause
+            message_filter.empty? ? "" : " --grep \"#{message_filter}\""
+          end
+        end
+
+        class Show
+          attr_reader :commit_hash
+
+          def initialize(options)
+            @commit_hash = options[:commit_hash]
+          end
+
+          def build
+            "git show --oneline --name-only #{commit_hash}"
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,5 @@
 module Hotspots
-  module Repository
+  module Repository #:nodoc: all
     module Driver
       class Git
         attr_reader :logger
@@ -8,19 +8,20 @@ module Hotspots
           @logger = logger
         end
 
+        # Input and output should be optionally coloured
         def pretty_log(options)
-          grep_clause = options[:message_filter].empty? ? "" : " --grep \"#{options[:message_filter]}\""
-          command = %Q(git log --pretty="%H" --since="#{options[:since_days]} days ago" #{grep_clause}).
-            tap {|raw| logger.log "<Input>\n#{raw}\n</Input>"}
-          %x(#{command}).
-            tap {|raw| logger.log "<Output>\n#{raw}\n</Output>"}
+          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}) }
         end
 
+        # Input and output should be optionally coloured
         def show_one_line_names(options)
-          command = %Q(git show --oneline --name-only #{options[:commit_hash]}).
-            tap {|raw| logger.log "<Input>\n#{raw}\n</Input>"}
-          %x(#{command}).
-            tap {|raw| logger.log "<Output>\n#{raw}\n</Output>"}
+          command = log_with_tag("Input") { Command::Git::Show.new(:commit_hash => options[:commit_hash]).build }
+          log_with_tag("Output") { %x(#{command}) }
+        end
+
+        def log_with_tag(tag, &block)
+          yield.tap { |raw| logger.log "<#{tag}>\n#{raw}<#{tag}/>" }
         end
       end
     end

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

@@ -1,25 +1,29 @@
 module Hotspots
-  module Repository
+  module Repository #:nodoc: all
     module Parser
       class Git
+        attr_reader :driver, :time, :message_filters
+
         def initialize(driver, options)
           @driver          = driver
           @time            = options[:time]
           @message_filters = options[:message_filters]
         end
 
+        # TODO : replace with each_line
         def files
           filtered_commit_hashes.map do |commit_hash|
-            @driver.show_one_line_names(:commit_hash => commit_hash).
+            driver.show_one_line_names(:commit_hash => commit_hash).
               gsub("\r\n", "\n").
               gsub("\r", "\n").
               split("\n")[1..-1]
           end.flatten
         end
 
+        # TODO : replace with each_line
         def filtered_commit_hashes
-          @message_filters.map do |filter|
-            @driver.pretty_log(:since_days => @time, :message_filter => filter).
+          message_filters.map do |filter|
+            driver.pretty_log(:since_days => time, :message_filter => filter).
               gsub("\r\n", "\n").
               gsub("\r", "\n").
               split("\n")

data/lib/hotspots/store.rb

@@ -1,5 +1,5 @@
 module Hotspots
-  class Store
+  class Store #:nodoc: all
     def initialize(lines, options = {})
       @lines  = lines
       @store  = Hash.new(0)

data/lib/hotspots/version.rb

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

data/test/hotspots/options_parser_test.rb

@@ -1,6 +1,3 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib', 'hotspots', 'exit_strategy')
-require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib', 'hotspots', 'options_parser')
-
 require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
 
 module Hotspots
@@ -123,7 +120,7 @@ module Hotspots
       end
     end
 
-    describe "on a invalid option" do
+    describe "on an invalid option" do
       before do
         @options = @parser.parse("--invalid-option")
       end
@@ -137,7 +134,7 @@ module Hotspots
       end
     end
 
-    describe "on a invalid argument" do
+    describe "on an invalid argument" do
       before do
         @options = @parser.parse("--repo", "")
       end

data/test/hotspots/repository/command/git_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', 'minitest_helper')
+
+module Hotspots::Repository
+  describe "Command::Git" do
+    describe "Log" do
+      describe "#build" do
+        describe "when message filter exists" do
+          it "includes a grep clause" do
+            log_command = Command::Git::Log.new :since_days => 20, :message_filter => "Foo|Bar"
+            log_command.build.must_equal 'git log --pretty="%H" --since="20 days ago" --grep "Foo|Bar"'
+          end
+        end
+
+        describe "when message filter doesn't exist" do
+          it "doesn't have a grep clause" do
+            log_command = Command::Git::Log.new :since_days => 20
+            log_command.build.must_equal 'git log --pretty="%H" --since="20 days ago"'
+          end
+        end
+
+        describe "when message filter is set to an empty string" do
+          it "grep clause is ignored" do
+            log_command = Command::Git::Log.new :since_days => 20, :message_filter => ""
+            log_command.build.must_equal 'git log --pretty="%H" --since="20 days ago"'
+          end
+        end
+      end
+    end
+
+    describe "Show" do
+      describe "#build" do
+        it "constructs a git show with one-line format" do
+          show_command = Command::Git::Show.new :commit_hash => "abc123"
+          show_command.build.must_equal 'git show --oneline --name-only abc123'
+        end
+      end
+    end
+  end
+end

data/test/hotspots/repository/parser/git_test.rb

@@ -1,5 +1,3 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', '..', 'lib', 'hotspots', 'repository', 'parser', 'git')
-
 require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', '..', 'minitest_helper')
 
 module Hotspots::Repository

data/test/hotspots/store_test.rb

@@ -1,5 +1,3 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), '..', '..', 'lib', 'hotspots', 'store')
-
 require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
 
 module Hotspots

data/test/minitest_helper.rb

@@ -1,10 +1,15 @@
-begin
-  require 'simplecov'
-  SimpleCov.start do
-    add_filter "/test/"
+lib = File.expand_path('../../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+if ENV["coverage"] == "true"
+  begin
+    require 'simplecov'
+    SimpleCov.start do
+      add_filter "/test/"
+    end
+  rescue LoadError
+    puts "\nPlease install simplecov to generate coverage report!\n\n"
   end
-rescue LoadError
-  puts "\nPlease install simplecov to generate coverage report!\n\n"
 end
 
 # eager load all files
@@ -12,6 +17,7 @@ Dir["lib/**/*.rb"].each do |file|
   require File.expand_path(file)
 end
 
+require_relative "../lib/hotspots"
 
 require 'minitest/autorun'
 require 'minitest/spec'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotspots
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-22 00:00:00.000000000 Z
+date: 2012-12-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -77,7 +77,10 @@ extra_rdoc_files: []
 files:
 - lib/hotspots/exit_strategy.rb
 - lib/hotspots/logger.rb
+- lib/hotspots/option_based_exit.rb
 - lib/hotspots/options_parser.rb
+- lib/hotspots/repository/command/git.rb
+- lib/hotspots/repository/command.rb
 - lib/hotspots/repository/driver/git.rb
 - lib/hotspots/repository/driver.rb
 - lib/hotspots/repository/parser/git.rb
@@ -88,6 +91,7 @@ files:
 - lib/hotspots.rb
 - bin/hotspots
 - test/hotspots/options_parser_test.rb
+- test/hotspots/repository/command/git_test.rb
 - test/hotspots/repository/parser/git_test.rb
 - test/hotspots/store_test.rb
 - test/minitest_helper.rb
@@ -107,12 +111,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1394833690291643919
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 1394833690291643919
 requirements: []
 rubyforge_project: hotspots
 rubygems_version: 1.8.24
@@ -121,6 +131,7 @@ specification_version: 3
 summary: Find all files that changed over the past in a git repository based on conditions
 test_files:
 - test/hotspots/options_parser_test.rb
+- test/hotspots/repository/command/git_test.rb
 - test/hotspots/repository/parser/git_test.rb
 - test/hotspots/store_test.rb
 - test/minitest_helper.rb