hotspots 1.1.0 → 1.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7f43a6b0f28f054b6f4b3799ccabb18ebe2327f6709c325c4c7a2c07f16d0c8d
+  data.tar.gz: c165186a7d68e49e3bd6a3507d30f22ade3513d7f1182ba0f7b9eabcdc6739b0
+SHA512:
+  metadata.gz: 589499e787b881d179b267e3d2ff468db0af16b5d7aef558cd4799807288474d8cef5e1c3c4a2998cbd568d27681ace4cb8c409f3ca607d290a80136737b7d6f
+  data.tar.gz: 742faf60cca8d31eeda8e42e66f13d7a6d771bd75fd61cbc8820834a5423f1d12b15367da64ccc00084314d50c6c27a59f4d54a9b1f987fb45bc0c23b911eb68

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+v1.2.0
+-------
+
+* Use ruby's built-in logger instead of a custom one.
+* Introduce the concept of Configuration. Configurations have defaults and are overridden by command-line options.
+* Remove compatibility layers.
+* Always enable colour for verbose output.
+* Minimum supported version of ruby is 3.0.0.
+
 v1.1.0
 ------
 
@@ -23,7 +32,7 @@ v0.2.0
 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
+* 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 that breaks intermittently on 1.8.7. Tests fail intermittently on 1.8.7. So support for ruby 1.9.x only
 * Simplify Rakefile
 * Pull out a minitest_helper
 * Allow gem to be used as a library

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011-2013 Chirantan Mitra
+Copyright (c) 2011-2024 Chirantan Mitra
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

data/README.md

@@ -1,10 +1,10 @@
-[![Build Status](https://secure.travis-ci.org/chiku/hotspots.png?branch=master)](https://travis-ci.org/chiku/hotspots)
-[![Code Climate](https://codeclimate.com/github/chiku/hotspots.png)](https://codeclimate.com/github/chiku/hotspots)
+![Build Status](https://github.com/chiku/r0man/actions/workflows/build.yml/badge.svg)
+[![Gem Version](https://badge.fury.io/rb/hotspots.svg)](http://badge.fury.io/rb/hotspots)
 
 Overview
 --------
 
-This program helps in identifying files with maximum churn in a git repository. The more the number of changes made to a file, the more likelyhood of the file being a source of bug. If the same file is modified many times for bug fixes, it indicates that the file needs some refactoring or redesign love.
+This program helps in identifying files with maximum churn in a git repository. The more the number of changes made to a file, the more likelyhood of the file being a source of bugs. If the same file is modified many times for bug fixes, it indicates that the file needs some refactoring or redesign love.
 
 
 Dependencies
@@ -30,11 +30,12 @@ Specific options:
     -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]  Pipe separated values to filter files names against each commit message.
-                                           All files are allowed when not specified
+                                           All commit messages are allowed when not specified
     -c, --cutoff [CUTOFF]                  The minimum occurrence to consider for a file to appear in the list. Defaults to zero
+        --log [LOG LEVEL]                  Log level (debug, info, warn, error, fatal)
     -v, --verbose                          Show verbose output
-    -C, --colour, --color                  Show verbose output in colours
-        --version                          Show version information
+    -C, --colour, --color                  Show output in colours. The log level should be info or debug for colours
+        --version                          Show version
     -h, --help                             Show this message
 ```
 
@@ -65,15 +66,6 @@ gem install simplecov
 rake
 ```
 
-Contributing
-------------
-
-* Fork the project.
-* Make your feature addition or bug fix.
-* Add tests for it. This is important so I don't break it in a future version unintentionally.
-* Commit, but do not mess with the VERSION. If you want to have your own version, that is fine but bump the version in a commit by itself in another branch so I can ignore it when I pull.
-* Send me a pull request.
-
 License
 -------
 

data/TODO.md

@@ -1,5 +1,3 @@
 * Allow better use as a library - add documentation
-* Use builtin logger instead of a custom one
 * Reduce conditionals
-* Split responsibilities of OptionsParser. It shouldn't be responsible for holding default options. It should just setting overrides.
 * Group files based on their extensions

data/bin/hotspots

@@ -1,7 +1,13 @@
 #!/usr/bin/env ruby
 
-require 'hotspots'
+lib = File.expand_path(File.join("..", "..", "lib"), __FILE__)
+$:.unshift lib unless $:.include?(lib)
 
-options = Hotspots::OptionsParser.new.parse(*ARGV)
+require "logger"
+require "hotspots"
 
-Hotspots.new(options).output
+default_configuration    = Hotspots::Configuration.new
+user_options             = Hotspots::OptionsParser.new(:configuration => default_configuration)
+overridden_configuration = user_options.parse(*ARGV)
+
+Hotspots.new(overridden_configuration).output

data/lib/hotspots/configuration.rb

@@ -0,0 +1,36 @@
+class Hotspots
+  class Configuration #:nodoc: all
+    attr_accessor :repository, :time, :message_filters, :file_filter, :cutoff
+    attr_accessor :logger
+    attr_accessor :exit_strategy
+
+    def initialize(options = {})
+      @repository       = "."
+      @time             = 15
+      @message_filters  = [""]
+      @file_filter      = ""
+      @cutoff           = 0
+      @info_log_level   = options[:info_log_level]  || ::Logger::INFO
+      @error_log_level  = options[:error_log_level] || ::Logger::ERROR
+      @logger           = options[:logger]          || default_logger
+      @exit_strategy    = Exit::Noop.new
+      @logger.level     = @error_log_level
+    end
+
+    def log_level
+      @logger.level
+    end
+
+    def enable_verbosity
+      @logger.level = @info_log_level
+    end
+
+    private
+
+    def default_logger
+      ::Logger.new(STDOUT).tap do |logger|
+        logger.formatter = proc { |severity, datetime, progname, msg| "#{datetime}: #{msg}\n" }
+      end
+    end
+  end
+end

data/lib/hotspots/{option_based_exit.rb → exit.rb}

@@ -1,5 +1,5 @@
 class Hotspots
-  module OptionBasedExit #:nodoc: all
+  module Exit #:nodoc: all
     class Error
       attr_reader :code, :message
 
@@ -9,7 +9,7 @@ class Hotspots
       end
 
       def perform
-        puts @message
+        $stderr.puts @message
         exit @code
       end
     end
@@ -23,7 +23,7 @@ class Hotspots
       end
 
       def perform
-        puts @message
+        $stdout.puts @message
         exit @code
       end
     end
@@ -31,7 +31,7 @@ class Hotspots
     class Noop
       attr_reader :code, :message
 
-      def initialize(options = {})
+      def initialize
         @message = ""
         @code    = nil
       end

data/lib/hotspots/options_parser.rb

@@ -1,37 +1,19 @@
-require 'optparse'
-
-require 'hotspots/version'
-require 'hotspots/option_based_exit'
+require "optparse"
 
 class Hotspots
   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,
-          :colour          => false,
-        }
-      end
-    end
-
-    def initialize
-      @options = self.class.default_options
+    def initialize(opts)
+      @configuration = opts[:configuration].dup
     end
 
     def parse(*args)
       parser = new_option_parser
       begin
-        parser.parse args
+        parser.parse(args)
       rescue ::OptionParser::InvalidOption, ::OptionParser::InvalidArgument => ex
-        @options[:exit_strategy] = OptionBasedExit::Error.new(:code => 1, :message => (ex.to_s << "\nUse -h for help\n"))
+        @configuration.exit_strategy = Exit::Error.new(:code => 1, :message => (ex.to_s + "\nUse -h for help\n"))
       end
-      @options
+      @configuration
     end
 
     private
@@ -47,7 +29,7 @@ class Hotspots
         handle_message_filter_on(opts)
         handle_cutoff_on(opts)
         handle_verbosity_on(opts)
-        handle_colours_on(opts)
+        handle_version_on(opts)
         handle_help_on(opts)
       end
     end
@@ -62,7 +44,7 @@ class Hotspots
       opts.separator "Version #{::Hotspots::VERSION}"
       opts.separator "Copyright (C) 2011-2013 Chirantan Mitra"
       opts.separator ""
-      opts.separator "Usage: ruby hotspots [options]"
+      opts.separator "Usage: hotspots [options]"
       opts.separator ""
       opts.separator "Specific options:"
     end
@@ -70,14 +52,14 @@ class Hotspots
     def handle_time_on(opts)
       opts.on("-t", "--time [TIME]", OptionParser::DecimalInteger,
               "Time in days to scan the repository for. Defaults to fifteen") do |o|
-        @options[:time] = o.to_i
+        @configuration.time = o.to_i
       end
     end
 
     def handle_path_on(opts)
       opts.on("-r", "--repository [PATH]", String,
               "Path to the repository to scan. Defaults to current path") do |o|
-        @options[:repository] = o.to_s
+        @configuration.repository = o.to_s
       end
     end
 
@@ -85,43 +67,43 @@ class Hotspots
       opts.on("-f", "--file-filter [REGEX]", String,
               "Regular expression to filtering file names.",
               "All files are allowed when not specified") do |o|
-        @options[:file_filter] = o.to_s
+        @configuration.file_filter = o.to_s
       end
     end
 
     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.",
-              "All files are allowed when not specified") do |o|
-        @options[:message_filters] = o.to_s.split("|")
+              "All commit messages are allowed when not specified") do |o|
+        @configuration.message_filters = o.to_s.split("|")
       end
     end
 
     def handle_cutoff_on(opts)
       opts.on("-c", "--cutoff [CUTOFF]", OptionParser::DecimalInteger,
-              "The minimum occurance to consider for a file to appear in the list. Defaults to zero") do |o|
-        @options[:cutoff] = o.to_i
+              "The minimum occurrence to consider for a file to appear in the list. Defaults to zero") do |o|
+        @configuration.cutoff = o.to_i
       end
     end
 
     def handle_verbosity_on(opts)
       opts.on("-v", "--verbose",
               "Show verbose output") do
-        @options[:verbose] = true
+        @configuration.enable_verbosity
       end
     end
 
-    def handle_colours_on(opts)
-      opts.on("-C", "--colour", "--color",
-              "Show verbose output in colours") do
-        @options[:colour] = true
+    def handle_version_on(opts)
+      opts.on_tail("--version",
+                   "Show version") do
+        @configuration.exit_strategy = Exit::Safe.new(:message => "hotspots #{::Hotspots::VERSION}\n")
       end
     end
 
     def handle_help_on(opts)
       opts.on_tail("-h", "--help",
                    "Show this message") do
-        @options[:exit_strategy] = OptionBasedExit::Safe.new(:message => opts.to_s)
+        @configuration.exit_strategy = Exit::Safe.new(:message => opts.to_s)
       end
     end
   end

data/lib/hotspots/repository/git.rb

@@ -0,0 +1,17 @@
+class Hotspots
+  module Repository #:nodoc: all
+    module Git
+      class << self
+        def installed?
+          `git --help 2>&1`
+          $? == 0
+        end
+
+        def inside_valid_repository?
+          `git status 2>&1`
+          $? == 0
+        end
+      end
+    end
+  end
+end

data/lib/hotspots/repository/git_command.rb

@@ -0,0 +1,38 @@
+class Hotspots
+  module Repository #:nodoc: all
+    module GitCommand
+      class Log
+        def initialize(options)
+          @since_days     = options[:since_days]
+          @message_filter = options[:message_filter].to_s
+        end
+
+        def to_s
+          "git log --pretty=\"%H\" #{since_clause}#{grep_clause}"
+        end
+
+        private
+
+        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 to_s
+          "git show --oneline --name-only #{commit_hash}"
+        end
+      end
+    end
+  end
+end

data/lib/hotspots/repository/git_driver.rb

@@ -0,0 +1,35 @@
+require "ansi/code"
+require "open3"
+
+class Hotspots
+  module Repository #:nodoc: all
+    class GitDriver
+      def initialize(options)
+        @logger = options[:logger]
+      end
+
+      def pretty_log(options)
+        execute GitCommand::Log.new(:since_days => options[:since_days], :message_filter => options[:message_filter]).to_s
+      end
+
+      def show_one_line_names(options)
+        execute GitCommand::Show.new(:commit_hash => options[:commit_hash]).to_s
+      end
+
+      private
+
+      def execute(command)
+        @logger.info { ::ANSI::Code.blue("[input]\n#{command}") }
+        output = ""
+        Open3.popen3(command) do |stdin, stdout, stderr, wait_thr|
+          error = stderr.gets(nil)
+          output = stdout.gets(nil)
+          @logger.error { ::ANSI::Code.red("[error]\n#{error}") } if error
+          @logger.info { ::ANSI::Code.green("[output]\n#{output}") } if output
+          Exit::Error.new(:message => "Error encountered while running git", :code => 1).perform unless wait_thr.value.success?
+        end
+        output || ""
+      end
+    end
+  end
+end

data/lib/hotspots/repository/git_parser.rb

@@ -0,0 +1,25 @@
+class Hotspots
+  module Repository #:nodoc: all
+    class GitParser
+      attr_reader :driver, :time, :message_filters
+
+      def initialize(driver, options)
+        @driver          = driver
+        @time            = options[:time]
+        @message_filters = options[:message_filters]
+      end
+
+      def files
+        filtered_commit_hashes.reduce([]) do |acc, commit_hash|
+          acc + driver.show_one_line_names({:commit_hash => commit_hash}).lines.map(&:strip)[1..-1]
+        end
+      end
+
+      def filtered_commit_hashes
+        message_filters.reduce([]) do |acc, filter|
+          acc + driver.pretty_log({:since_days => time, :message_filter => filter}).lines.map(&:strip)
+        end.uniq
+      end
+    end
+  end
+end

data/lib/hotspots/repository.rb

@@ -1,3 +1,5 @@
-require 'hotspots/repository/command'
-require 'hotspots/repository/driver'
-require 'hotspots/repository/parser'
+require "hotspots/repository/git"
+require "hotspots/repository/git_command"
+require "hotspots/repository/git_command"
+require "hotspots/repository/git_driver"
+require "hotspots/repository/git_parser"

data/lib/hotspots/store.rb

@@ -7,7 +7,7 @@ class Hotspots
       @filter = options[:file_filter] || ""
 
       @lines.map   { |line| line.strip }.
-             select{ |line| not line.empty? and line =~ Regexp.new(@filter) }.
+             select{ |line| !line.empty? && line =~ Regexp.new(@filter) }.
              each  { |line| @store[line] += 1 }
     end
 
@@ -23,7 +23,7 @@ class Hotspots
     private
 
     def sorted_array
-      @sorted_array ||= @store.sort do |(key1, value1), (key2, value2)|
+      @sorted_array ||= @store.sort do |(_, value1), (_, value2)|
         value2 <=> value1
       end
     end

data/lib/hotspots/version.rb

@@ -1,3 +1,3 @@
 class Hotspots
-  VERSION = "1.1.0"
+  VERSION = "1.2.0"
 end

data/lib/hotspots.rb

@@ -1,82 +1,61 @@
-require 'hotspots/version'
-require 'hotspots/logger'
-require 'hotspots/store'
-require 'hotspots/options_parser'
-require 'hotspots/repository'
-require 'hotspots/compatibility'
+require "hotspots/version"
+require "hotspots/exit"
+require "hotspots/configuration"
+require "hotspots/store"
+require "hotspots/options_parser"
+require "hotspots/repository"
 
 class Hotspots
-  attr_reader :logger, :repository, :verbose, :colour,
-              :exit_strategy, :driver, :parser, :store,
-              :time, :message_filters, :file_filter, :cutoff
+  attr_reader :configuration
 
-  def initialize(opts)
-    options          = Hotspots::OptionsParser.default_options.merge(opts)
-
-    @logger          = Hotspots::Logger.new
-    @repository      = options[:repository]
-    @verbose         = options[:verbose]
-    @colour          = options[:colour]
-    @exit_strategy   = options[:exit_strategy]
-
-    @time            = options[:time]
-    @message_filters = options[:message_filters]
-    @file_filter     = options[:file_filter]
-    @cutoff          = options[:cutoff]
+  def initialize(configuration)
+    @configuration = configuration
   end
 
   def output
     validate
-    set
-    run
+    inside_repository do
+      run
+    end
   end
 
   private
 
-  def validate #:nodoc:
-    exit_if_options_are_for_help
-    exit_if_not_git_repository
+  def validate
+    configuration.exit_strategy.perform
+    ensure_git_installed
+    ensure_git_repository
   end
 
-  def set #:nodoc:
-    configure_logger
-    set_path
-    assign
+  def inside_repository
+    yield Dir.chdir(repository)
   end
 
-  def run #:nodoc:
+  def run
     puts store.to_s
   end
 
-  def exit_if_options_are_for_help
-    exit_strategy.perform
+  def ensure_git_installed
+    Exit::Error.new(:message => "git not installed or not present in PATH!", :code => 10).perform unless Repository::Git.installed?
   end
 
-  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
+  def ensure_git_repository
+    Exit::Error.new(:message => "'#{@repository}' doesn't seem to be a git repository!", :code => 10).perform unless Repository::Git.inside_valid_repository?
   end
 
-  def configure_logger
-    if verbose
-      logger.as_console
-    end
+  def repository
+    configuration.repository
+  end
 
-    if colour
-      logger.colourize
-    end
+  def store
+    Store.new(parser.files, :cutoff => configuration.cutoff, :file_filter => configuration.file_filter)
   end
 
-  def set_path
-    Dir.chdir(repository)
+  def parser
+    Repository::GitParser.new(driver, :time => configuration.time, :message_filters => configuration.message_filters)
   end
 
-  def assign
-    @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
+  def driver
+    Repository::GitDriver.new(:logger => configuration.logger)
   end
 end

data/test/hotspots/configuration_test.rb

@@ -0,0 +1,65 @@
+require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
+
+class Hotspots
+  class StubLogger
+    attr_accessor :level
+    def initialize
+      @level = :uninitialized
+    end
+  end
+
+  describe "Configuration" do
+    describe "#initialize" do
+      let(:stub_logger) { StubLogger.new }
+      let(:configuration) { Configuration.new(:logger => stub_logger, :info_log_level => :info_level, :error_log_level => :error_level) }
+
+      it "defaults repository to the current path" do
+        expect(configuration.repository).must_equal "."
+      end
+
+      it "defaults time to 15" do
+        expect(configuration.time).must_equal 15
+      end
+
+      it "defaults file filter to empty string" do
+        expect(configuration.file_filter).must_equal ""
+      end
+
+      it "defaults message filters to array with an empty string" do
+        expect(configuration.message_filters).must_equal [""]
+      end
+
+      it "defaults cutoff to 0" do
+        expect(configuration.cutoff).must_equal 0
+      end
+
+      it "set a logger" do
+        expect(configuration.logger).wont_be :nil?
+      end
+
+      it "defaults the logger level to error" do
+        expect(configuration.logger.level).must_equal :error_level
+      end
+
+      it "defaults exit code to nil" do
+        expect(configuration.exit_strategy.code).must_be :nil?
+      end
+
+      it "defaults exit message to empty string" do
+        expect(configuration.exit_strategy.message).must_equal ""
+      end
+    end
+
+    describe "#initialize without default logger" do
+      let(:configuration) { Configuration.new }
+
+      it "set a logger" do
+        expect(configuration.logger).wont_be :nil?
+      end
+
+      it "defaults the logger level to error" do
+        expect(configuration.logger.level).must_equal ::Logger::ERROR
+      end
+    end
+  end
+end