hotspots 1.1.0 → 1.2.0

data/test/hotspots/options_parser_test.rb

@@ -1,163 +1,135 @@
-require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
+require "logger"
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "minitest_helper")
 
 class Hotspots
   describe "OptionsParser" do
-    before do
-      @parser = OptionsParser.new
-    end
-
-    describe "#initialize" do
-      it "defaults repository to current path" do
-        @parser.parse[:repository].must_equal "."
-      end
-
-      it "defaults time to 15" do
-        @parser.parse[:time].must_equal 15
-      end
-
-      it "defaults file filter to empty string" do
-        @parser.parse[:file_filter].must_equal ""
-      end
-
-      it "defaults message filters to array with an empty string" do
-        @parser.parse[:message_filters].must_equal [""]
-      end
-
-      it "defaults cutoff to 0" do
-        @parser.parse[:cutoff].must_equal 0
+    let(:info_log_level) { ::Logger::INFO }
+    let(:error_log_level) { ::Logger::ERROR }
+    let(:logger) { ::Logger.new(STDOUT) }
+    let(:configuration) { Configuration.new(:logger => logger, :info_log_level => info_log_level, :error_log_level => error_log_level) }
+    let(:parser) { OptionsParser.new(:configuration => configuration) }
+
+    describe "#parse" do
+      ["--repository", "-r"].each do |option|
+        describe option do
+          it "sets the specified value repository" do
+            expect(parser.parse(option, "rails").repository).must_equal "rails"
+          end
+
+          it "sets empty repository when missing" do
+            expect(parser.parse(option).repository).must_equal ""
+          end
+        end
       end
 
-      it "defaults verbose to nil" do
-        @parser.parse[:verbose].must_equal false
-      end
+      ["--time", "-t"].each do |option|
+        describe option do
+          it "sets the specified time to consider" do
+            expect(parser.parse(option, "8").time).must_equal 8
+          end
 
-      it "defaults exit code to nil" do
-        @parser.parse[:exit_strategy].code.must_equal nil
+          it "sets zero time when missing" do
+            expect(parser.parse(option).time).must_equal 0
+          end
+        end
       end
 
-      it "defaults exit message to empty string" do
-        @parser.parse[:exit_strategy].message.must_equal ""
-      end
+      ["--cutoff", "-c"].each do |option|
+        describe option do
+          it "sets the specified cutoff" do
+            expect(parser.parse(option, "5").cutoff).must_equal 5
+          end
 
-      it "defaults colour to false" do
-        @parser.parse[:colour].must_equal false
+          it "sets zero cutoff when missing" do
+            expect(parser.parse(option).cutoff).must_equal 0
+          end
+        end
       end
-    end
 
-    ["--repository", "--repo", "-r"].each do |option|
-      describe option do
-        it "sets the specified value repository" do
-          @parser.parse(option, "rails")[:repository].must_equal "rails"
-        end
+      ["--file-filter", "-f"].each do |option|
+        describe option do
+          it "sets the specified file-filter" do
+            expect(parser.parse(option, "rb").file_filter).must_equal "rb"
+          end
 
-        it "sets empty repository when missing" do
-          @parser.parse(option)[:repository].must_equal ""
+          it "sets empty file-filter when missing" do
+            expect(parser.parse(option).file_filter).must_equal ""
+          end
         end
       end
-    end
 
-    ["--time", "--ti", "-t"].each do |option|
-      describe option do
-        it "sets the specified time to consider" do
-          @parser.parse(option, "8")[:time].must_equal 8
-        end
+      ["--message-filter", "-m"].each do |option|
+        describe option do
+          it "sets the specified message filters" do
+            expect(parser.parse(option, "cleanup|defect").message_filters).must_equal ["cleanup", "defect"]
+          end
 
-        it "sets zero time when missing" do
-          @parser.parse(option)[:time].must_equal 0
+          it "sets empty message-filter when missing" do
+            expect(parser.parse(option).message_filters).must_equal []
+          end
         end
       end
-    end
 
-    ["--cutoff", "--cut", "-c"].each do |option|
-      describe option do
-        it "sets the specified cutoff" do
-          @parser.parse(option, "5")[:cutoff].must_equal 5
-        end
-
-        it "sets zero cutoff when missing" do
-          @parser.parse(option)[:cutoff].must_equal 0
+      ["--verbose", "-v"].each do |option|
+        describe option do
+          it "sets the log level to info" do
+            expect(parser.parse(option).log_level).must_equal info_log_level
+          end
         end
       end
-    end
 
-    ["--file-filter", "--file", "-f"].each do |option|
-      describe option do
-        it "sets the specified file-filter" do
-          @parser.parse(option, "rb")[:file_filter].must_equal "rb"
-        end
+      ["--version"].each do |option|
+        describe option do
+          it "sets exit code to zero" do
+            expect(parser.parse(option).exit_strategy.code).must_equal 0
+          end
 
-        it "sets empty file-filter when missing" do
-          @parser.parse(option)[:file_filter].must_equal ""
+          it "sets a version message" do
+            expect(parser.parse(option).exit_strategy.message).must_be :include?, ::Hotspots::VERSION
+          end
         end
       end
-    end
 
-    ["--message-filter", "--message", "-m"].each do |option|
-      describe option do
-        it "sets the specified message filters" do
-          @parser.parse(option, "cleanup|defect")[:message_filters].must_equal ["cleanup", "defect"]
-        end
+      ["--help", "-h"].each do |option|
+        describe option do
+          it "sets exit code to zero" do
+            expect(parser.parse(option).exit_strategy.code).must_equal 0
+          end
 
-        it "sets empty message-filter when missing" do
-          @parser.parse(option)[:message_filters].must_equal []
+          it "sets an exit message" do
+            expect(parser.parse(option).exit_strategy.message).wont_be_empty
+          end
         end
       end
-    end
 
-    ["--verbose", "-v"].each do |option|
-      describe option do
-        it "sets the console logger" do
-          @parser.parse(option)[:verbose].must_equal true
-        end
+      it "doesn't mutate options" do
+        parser.parse("--help")
+        expect(configuration.exit_strategy.code).must_be :nil?
       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
+      describe "when parsing an invalid option" do
+        let(:options) { parser.parse("--invalid-option") }
 
-    ["--help", "-h"].each do |option|
-      describe option do
-        it "sets exit code to zero" do
-          @parser.parse(option)[:exit_strategy].code.must_equal 0
+        it "sets an exit code" do
+          expect(options.exit_strategy.code).must_equal 1
         end
 
         it "sets an exit message" do
-          @parser.parse(option)[:exit_strategy].message.wont_be_empty
+          expect(options.exit_strategy.message).wont_be_empty
         end
       end
-    end
-
-    describe "on an invalid option" do
-      before do
-        @options = @parser.parse("--invalid-option")
-      end
-
-      it "sets an exit code" do
-        @options[:exit_strategy].code.must_equal 1
-      end
 
-      it "sets an exit message" do
-        @options[:exit_strategy].message.wont_be_empty
-      end
-    end
+      describe "when parsing an invalid argument" do
+        let(:options) { parser.parse("--repository", "") }
 
-    describe "on an invalid argument" do
-      before do
-        @options = @parser.parse("--repo", "")
-      end
-
-      it "sets an exit code" do
-        @options[:exit_strategy].code.must_equal 1
-      end
+        it "sets an exit code" do
+          expect(options.exit_strategy.code).must_equal 1
+        end
 
-      it "sets an exit message" do
-        @options[:exit_strategy].message.wont_be_empty
+        it "sets an exit message" do
+          expect(options.exit_strategy.message).wont_be_empty
+        end
       end
     end
   end
-end
+end

data/test/hotspots/repository/git_command_test.rb

@@ -0,0 +1,39 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "minitest_helper")
+
+module Hotspots::Repository
+  describe "GitCommand" do
+    describe "Log" do
+      describe "#to_s" do
+        describe "when message filter exists" do
+          it "includes a grep clause" do
+            log_command = GitCommand::Log.new :since_days => 20, :message_filter => "Foo|Bar"
+            expect(log_command.to_s).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 = GitCommand::Log.new :since_days => 20
+            expect(log_command.to_s).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 = GitCommand::Log.new :since_days => 20, :message_filter => ""
+            expect(log_command.to_s).must_equal 'git log --pretty="%H" --since="20 days ago"'
+          end
+        end
+      end
+    end
+
+    describe "Show" do
+      describe "#to_s" do
+        it "constructs a git show with one-line format" do
+          show_command = GitCommand::Show.new :commit_hash => "abc123"
+          expect(show_command.to_s).must_equal 'git show --oneline --name-only abc123'
+        end
+      end
+    end
+  end
+end

data/test/hotspots/repository/git_parser_test.rb

@@ -0,0 +1,88 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "minitest_helper")
+
+module Hotspots::Repository
+  class GitDriverStub
+    def initialize
+      @pretty_log = ["SHA1\nSHA2", "SHA2\nSHA3"]
+      @commits = {
+        "SHA1" => "SHA1 commit message\nfile1\nfile2",
+        "SHA2" => "SHA1 commit message\nfile2\nfile3\nfile5",
+        "SHA3" => "SHA1 commit message\nfile4",
+      }
+      @pretty_log_cycle = 0
+    end
+
+    def pretty_log(options)
+      @pretty_log[@pretty_log_cycle].tap do
+        @pretty_log_cycle = (@pretty_log_cycle + 1) % 2
+      end
+    end
+
+    def show_one_line_names(options)
+      @commits[options[:commit_hash]]
+    end
+  end
+
+  describe GitDriverStub do
+    subject { GitDriverStub.new }
+
+    describe "#pretty_log" do
+      it "is sane" do
+        expect(subject.pretty_log(:time => 10, :message_filter => "Foo")).must_equal "SHA1\nSHA2"
+        expect(subject.pretty_log(:time => 10, :message_filter => "Bar")).must_equal "SHA2\nSHA3"
+      end
+    end
+
+    describe "#show_one_line_names" do
+      it "is sane" do
+        expect(subject.show_one_line_names(:commit_hash => "SHA2")).
+            must_equal "SHA1 commit message\nfile2\nfile3\nfile5"
+      end
+    end
+  end
+
+  describe "GitParser" do
+    describe "#filtered_commit_hashes" do
+      it "fetches a commit hash based on filter and time" do
+        mock_git_driver = Minitest::Mock.new
+        options         = {:time => 10, :message_filters => ["Foo"]}
+        git_parser      = GitParser.new mock_git_driver, options
+
+        mock_git_driver.expect(:pretty_log, "SHA1\nSHA2", [{:since_days => options[:time], :message_filter => "Foo"}])
+
+        expect(git_parser.filtered_commit_hashes).must_equal(["SHA1", "SHA2"])
+
+        expect(mock_git_driver.verify).must_equal true
+      end
+
+      it "fetches multiple commit hashes" do
+        options    = {:time => 10, :message_filters => ["Foo", "Bar"]}
+        git_parser = GitParser.new GitDriverStub.new, options
+
+        expect(git_parser.filtered_commit_hashes).must_equal(["SHA1", "SHA2", "SHA3"])
+      end
+    end
+
+    describe "#files" do
+      it "finds all affected files for a commit message" do
+        mock_git_driver = Minitest::Mock.new
+        options         = {:time => 10, :message_filters => ["Foo"]}
+        git_parser      = GitParser.new mock_git_driver, options
+
+        mock_git_driver.expect(:pretty_log, "SHA1", [{:since_days => options[:time], :message_filter => "Foo"}])
+        mock_git_driver.expect(:show_one_line_names, "SHA1 CommitMessage\nfile1\nfile2", [{:commit_hash => "SHA1"}])
+
+        expect(git_parser.files).must_equal(["file1", "file2"])
+
+        expect(mock_git_driver.verify).must_equal true
+      end
+
+      it "finds all affected files for multiple commit messages" do
+        options    = {:time => 10, :message_filters => ["Foo", "Bar"]}
+        git_parser = GitParser.new GitDriverStub.new, options
+
+        expect(git_parser.files).must_equal(["file1", "file2", "file2", "file3", "file5", "file4"])
+      end
+    end
+  end
+end

data/test/hotspots/store_test.rb

@@ -8,8 +8,8 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines)
-      store.on("abc.txt").must_equal 1
-      store.on("efg.txt").must_equal 1
+      expect(store.on("abc.txt")).must_equal 1
+      expect(store.on("efg.txt")).must_equal 1
     end
 
     it "counts occurances of a line present multiple times" do
@@ -19,7 +19,7 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines)
-      store.on("abc.txt").must_equal 2
+      expect(store.on("abc.txt")).must_equal 2
     end
 
     it "identifies zero occurances" do
@@ -28,7 +28,7 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines)
-      store.on("absent.txt").must_equal 0
+      expect(store.on("absent.txt")).must_equal 0
     end
 
     it "neglects empty lines" do
@@ -36,7 +36,7 @@ class Hotspots
         " "
       ]
       store = Store.new(lines)
-      store.on(" ").must_equal 0
+      expect(store.on(" ")).must_equal 0
     end
 
     it "neglects spaces at the extremes of the line" do
@@ -44,7 +44,7 @@ class Hotspots
         "  abc.txt  "
       ]
       store = Store.new(lines)
-      store.on("abc.txt").must_equal 1
+      expect(store.on("abc.txt")).must_equal 1
     end
 
     it "neglects linefeeds at the extremes of the line" do
@@ -53,7 +53,7 @@ class Hotspots
         "\n\n  abc.txt  \r\n"
       ]
       store = Store.new(lines)
-      store.on("abc.txt").must_equal 2
+      expect(store.on("abc.txt")).must_equal 2
     end
 
     it "has a string representation" do
@@ -62,7 +62,7 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines)
-      store.to_s.must_equal "abc.txt,1\nefg.txt,1\n"
+      expect(store.to_s).must_equal "abc.txt,1\nefg.txt,1\n"
     end
 
     it "has a case-sensitive string representation" do
@@ -70,7 +70,7 @@ class Hotspots
         "aBc.tXt"
       ]
       store = Store.new(lines)
-      store.to_s.must_equal "aBc.tXt,1\n"
+      expect(store.to_s).must_equal "aBc.tXt,1\n"
     end
 
     it "string representation has maximum occuring string at the top" do
@@ -82,7 +82,7 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines)
-      store.to_s.must_equal "efg.txt,3\nabc.txt,2\n"
+      expect(store.to_s).must_equal "efg.txt,3\nabc.txt,2\n"
     end
 
     it "doesn't display setting below cut-off" do
@@ -94,7 +94,7 @@ class Hotspots
         "efg.txt"
       ]
       store = Store.new(lines, :cutoff => 3)
-      store.to_s.must_equal "efg.txt,3\n"
+      expect(store.to_s).must_equal "efg.txt,3\n"
     end
 
     it "doesn't display lines that don't match criteria" do
@@ -109,7 +109,7 @@ class Hotspots
         "missing.txt"
       ]
       store = Store.new(lines, :file_filter => "abc|efg")
-      store.to_s.must_equal "abc.txt,3\nefg.txt,2\nabc.log,1\n"
+      expect(store.to_s).must_equal "abc.txt,3\nefg.txt,2\nabc.log,1\n"
     end
   end
-end
+end

data/test/minitest_helper.rb

@@ -1,14 +1,17 @@
-lib = File.expand_path('../../lib/', __FILE__)
+lib = File.expand_path("../../lib/", __FILE__)
 $:.unshift lib unless $:.include?(lib)
 
+require "ansi/code"
+
 if ENV["coverage"] == "true"
   begin
-    require 'simplecov'
+    require "simplecov"
     SimpleCov.start do
       add_filter "/test/"
     end
   rescue LoadError
-    puts "\nPlease install simplecov to generate coverage report!\n\n"
+    $stderr.puts ::ANSI::Code.red("Please install simplecov to generate a coverage report!")
+    exit 1
   end
 end
 
@@ -19,5 +22,5 @@ end
 
 require_relative "../lib/hotspots"
 
-require 'minitest/autorun'
-require 'minitest/spec'
+gem "minitest"
+require "minitest/autorun"