hotspots 1.0.0 → 1.1.0

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+v1.1.0
+------
+
+* Cleanup some of the internals. All compatibility layers exist in a separate file. Remove dependency on deprecated class.
+* Defer to ruby for interpreting line endings
+
 v1.0.0
 ------
 

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) <2011> <Chirantan Mitra>
+Copyright (c) 2011-2013 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,4 +1,5 @@
 [![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)
 
 Overview
 --------

data/TODO.md

@@ -1,2 +1,5 @@
 * 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

@@ -4,4 +4,4 @@ require 'hotspots'
 
 options = Hotspots::OptionsParser.new.parse(*ARGV)
 
-Hotspots::Main.new(options).output
+Hotspots.new(options).output

data/lib/hotspots.rb

@@ -3,81 +3,80 @@ require 'hotspots/logger'
 require 'hotspots/store'
 require 'hotspots/options_parser'
 require 'hotspots/repository'
+require 'hotspots/compatibility'
 
-module Hotspots
-  class Main
-    attr_reader :logger, :repository, :verbose, :colour,
-                :exit_strategy, :driver, :parser, :store,
-                :time, :message_filters, :file_filter, :cutoff
+class Hotspots
+  attr_reader :logger, :repository, :verbose, :colour,
+              :exit_strategy, :driver, :parser, :store,
+              :time, :message_filters, :file_filter, :cutoff
 
-    def initialize(opts)
-      options          = Hotspots::OptionsParser.default_options.merge(opts)
+  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]
+    @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]
-    end
+    @time            = options[:time]
+    @message_filters = options[:message_filters]
+    @file_filter     = options[:file_filter]
+    @cutoff          = options[:cutoff]
+  end
 
-    def output
-      validate
-      set
-      run
-    end
+  def output
+    validate
+    set
+    run
+  end
 
-    private
+  private
 
-    def validate #:nodoc:
-      exit_if_options_are_for_help
-      exit_if_not_git_repository
-    end
+  def validate #:nodoc:
+    exit_if_options_are_for_help
+    exit_if_not_git_repository
+  end
 
-    def set #:nodoc:
-      configure_logger
-      set_path
-      assign
-    end
+  def set #:nodoc:
+    configure_logger
+    set_path
+    assign
+  end
 
-    def run #:nodoc:
-      puts store.to_s
-    end
+  def run #:nodoc:
+    puts store.to_s
+  end
 
-    def exit_if_options_are_for_help
-      exit_strategy.perform
-    end
+  def exit_if_options_are_for_help
+    exit_strategy.perform
+  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 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 configure_logger
-      if verbose
-        logger.as_console
-      end
-
-      if colour
-        logger.colourize
-      end
+  def configure_logger
+    if verbose
+      logger.as_console
     end
 
-    def set_path
-      Dir.chdir(repository)
+    if colour
+      logger.colourize
     end
+  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
-    end
+  def set_path
+    Dir.chdir(repository)
+  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
   end
 end

data/lib/hotspots/compatibility.rb

@@ -0,0 +1,4 @@
+# Provides compatibility with older API
+# These compatibility layers will be removed in the next major release (v2.0)
+
+Hotspots::Main = Hotspots

data/lib/hotspots/logger.rb

@@ -1,5 +1,5 @@
-module Hotspots
-  # Should understand log levels
+class Hotspots
+  # TODO : Should understand log levels
   class Logger #:nodoc: all
     module Sink
       class Console

data/lib/hotspots/option_based_exit.rb

@@ -1,4 +1,4 @@
-module Hotspots
+class Hotspots
   module OptionBasedExit #:nodoc: all
     class Error
       attr_reader :code, :message

data/lib/hotspots/options_parser.rb

@@ -3,7 +3,7 @@ require 'optparse'
 require 'hotspots/version'
 require 'hotspots/option_based_exit'
 
-module Hotspots
+class Hotspots
   class OptionsParser #:nodoc: all
     class << self
       def default_options
@@ -60,7 +60,7 @@ module Hotspots
       opts.banner = "Tool to find most modified files over the past few days in a git repository."
 
       opts.separator "Version #{::Hotspots::VERSION}"
-      opts.separator "Copyright (C) 2011-2012 Chirantan Mitra"
+      opts.separator "Copyright (C) 2011-2013 Chirantan Mitra"
       opts.separator ""
       opts.separator "Usage: ruby hotspots [options]"
       opts.separator ""

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

@@ -1,4 +1,4 @@
-module Hotspots
+class Hotspots
   module Repository #:nodoc: all
     module Command
       module Git

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

@@ -1,4 +1,4 @@
-module Hotspots
+class Hotspots
   module Repository #:nodoc: all
     module Driver
       class Git

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

@@ -1,4 +1,4 @@
-module Hotspots
+class Hotspots
   module Repository #:nodoc: all
     module Parser
       class Git
@@ -10,24 +10,16 @@ module Hotspots
           @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).
-              gsub("\r\n", "\n").
-              gsub("\r", "\n").
-              split("\n")[1..-1]
-          end.flatten
+          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
 
-        # TODO : replace with each_line
         def filtered_commit_hashes
-          message_filters.map do |filter|
-            driver.pretty_log(:since_days => time, :message_filter => filter).
-              gsub("\r\n", "\n").
-              gsub("\r", "\n").
-              split("\n")
-          end.flatten.uniq
+          message_filters.reduce([]) do |acc, filter|
+            acc + driver.pretty_log(:since_days => time, :message_filter => filter).lines.map(&:strip)
+          end.uniq
         end
       end
     end

data/lib/hotspots/store.rb

@@ -1,4 +1,4 @@
-module Hotspots
+class Hotspots
   class Store #:nodoc: all
     def initialize(lines, options = {})
       @lines  = lines

data/lib/hotspots/version.rb

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

data/test/hotspots/options_parser_test.rb

@@ -1,6 +1,6 @@
 require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
 
-module Hotspots
+class Hotspots
   describe "OptionsParser" do
     before do
       @parser = OptionsParser.new

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

@@ -41,20 +41,11 @@ module Hotspots::Repository
       git_parser.files.must_equal(["file1", "file2", "file2", "file3", "file5", "file4"])
     end
 
-    describe "handles line ending" do
-      it "of type \r\n" do
-        options    = {:time => 10, :message_filters => ["Foo", "Bar"]}
-        git_parser = Parser::Git.new StubGitDriver.new(:line_ending => "\r\n"), options
-
-        git_parser.files.must_equal(["file1", "file2", "file2", "file3", "file5", "file4"])
-      end
-
-      it "of type \r" do
-        options    = {:time => 10, :message_filters => ["Foo", "Bar"]}
-        git_parser = Parser::Git.new StubGitDriver.new(:line_ending => "\r"), options
+    it "handles line ending" do
+      options    = {:time => 10, :message_filters => ["Foo", "Bar"]}
+      git_parser = Parser::Git.new StubGitDriver.new, options
 
-        git_parser.files.must_equal(["file1", "file2", "file2", "file3", "file5", "file4"])
-      end
+      git_parser.files.must_equal(["file1", "file2", "file2", "file3", "file5", "file4"])
     end
   end
 
@@ -68,14 +59,12 @@ module Hotspots::Repository
     it "has a sane show one line names" do
       StubGitDriver.new.show_one_line_names(:commit_hash => "SHA2").
           must_equal "SHA1 commit message\nfile2\nfile3\nfile5"
-      StubGitDriver.new(:line_ending => "\r\n").show_one_line_names(:commit_hash => "SHA2").
-          must_equal "SHA1 commit message\r\nfile2\r\nfile3\r\nfile5"
     end
   end
 
   class StubGitDriver
-    def initialize(options = {})
-      line_ending = options[:line_ending] || "\n"
+    def initialize
+      line_ending = "\n"
       @pretty_log_enum = ["SHA1#{line_ending}SHA2", "SHA2#{line_ending}SHA3"].cycle
       @commits = {
         "SHA1" => "SHA1 commit message#{line_ending}file1#{line_ending}file2",

data/test/hotspots/store_test.rb

@@ -1,6 +1,6 @@
 require File.join(File.expand_path(File.dirname(__FILE__)), '..', 'minitest_helper')
 
-module Hotspots
+class Hotspots
   describe "Store" do
     it "counts occurances of a line present once" do
       lines = [

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hotspots
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-28 00:00:00.000000000 Z
+date: 2013-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ansi
@@ -91,25 +91,26 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/hotspots/logger.rb
-- lib/hotspots/option_based_exit.rb
 - lib/hotspots/options_parser.rb
+- lib/hotspots/version.rb
+- lib/hotspots/option_based_exit.rb
+- lib/hotspots/logger.rb
+- lib/hotspots/repository.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
+- lib/hotspots/repository/command.rb
 - lib/hotspots/repository/parser.rb
-- lib/hotspots/repository.rb
+- lib/hotspots/repository/parser/git.rb
 - lib/hotspots/store.rb
-- lib/hotspots/version.rb
+- lib/hotspots/compatibility.rb
 - lib/hotspots.rb
 - bin/hotspots
-- test/hotspots/options_parser_test.rb
+- test/minitest_helper.rb
 - test/hotspots/repository/command/git_test.rb
 - test/hotspots/repository/parser/git_test.rb
 - test/hotspots/store_test.rb
-- test/minitest_helper.rb
+- test/hotspots/options_parser_test.rb
 - LICENSE
 - README.md
 - CHANGELOG.md
@@ -126,27 +127,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 684827185202909371
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: 684827185202909371
 requirements: []
 rubyforge_project: hotspots
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 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/minitest_helper.rb
 - test/hotspots/repository/command/git_test.rb
 - test/hotspots/repository/parser/git_test.rb
 - test/hotspots/store_test.rb
-- test/minitest_helper.rb
+- test/hotspots/options_parser_test.rb