churn 1.0.2 → 1.0.4

data/lib/churn/history.rb

@@ -14,7 +14,7 @@ module Churn
     def self.load_revision_data(revision, data_directory)
       #load revision data from scratch folder if it exists
       filename = "#{data_directory}/#{revision}.json"
-      if File.exists?(filename)
+      if File.exist?(filename)
         begin
           json_data = File.read(filename)
           data      = JSON.parse(json_data)

data/lib/churn/location_mapping.rb

@@ -2,7 +2,7 @@ module Churn
 
   # Given a ruby file, map the klass and methods to a range of line numbers
   # The klass and method to line numbers mappings, are stored in
-  # @klasses_collection and @methods_collection
+  # klasses_collection and methods_collection
   # this is based off https://github.com/seattlerb/ruby_parser which seems to have some known line number bugs
   # perhaps look at and move more to the style of line numbers from metric_fu
   # https://github.com/metricfu/metric_fu/blob/master/lib/data_structures/line_numbers.rb

data/lib/churn/options.rb

@@ -9,8 +9,8 @@ module Churn
     DEFAULT_START_TIME = '3 months ago'
     DEFAULT_REPORT_HOST = 'http://churn.picoappz.com'
 
-    attr_accessor :data_directory, :minimum_churn_count, :ignores, :start_date, :history, :report_host, :name
-    
+    attr_accessor :data_directory, :minimum_churn_count, :ignores, :start_date, :history, :report_host, :name, :file_extension, :file_prefix
+
     def initialize()
       @data_directory      = DEFAULT_CHURN_DIRECTORY
       @minimum_churn_count = DEFAULT_MINIMUM_CHURN_COUNT
@@ -19,12 +19,16 @@ module Churn
       @history             = nil
       @report_host         = nil
       @name                = nil
+      @file_extension      = nil
+      @file_prefix         = nil
     end
 
     def set_options(options = {})
       @data_directory      = options.fetch(:data_directory){ @data_directory } unless options[:data_directory]==''
+      @file_extension      = options.fetch(:file_extension){ @file_extension } unless options[:file_extension]==''
+      @file_prefix      = options.fetch(:file_prefix){ @file_prefix } unless options[:file_prefix]==''
       @minimum_churn_count = options.fetch(:minimum_churn_count){ @minimum_churn_count }.to_i
-      @ignores             = (options.fetch(:ignores){ @ignores }).to_s.split(',').map(&:strip)
+      @ignores             = (options.fetch(:ignore_files){ options[:ignores] || @ignores }).to_s.split(',').map(&:strip)
       @ignores << '/dev/null' unless @ignores.include?('/dev/null')
       @start_date          = options[:start_date] if !options[:start_date].nil? && options[:start_date]!=''
       @history             = options[:history] if !options[:history].nil? && options[:history]!=''

data/lib/churn/scm/bzr_analyzer.rb

@@ -1,26 +1,34 @@
 module Churn
 
-  #analizes Bzr / Bazaar SCM to find recently changed files, and what lines have been altered
+  # Analyzes Bzr / Bazaar SCM, to find recently changed files, and what lines have been altered
   class BzrAnalyzer < SourceControl
 
+    # @return [Boolean]
     def self.supported?
-      !!(`bzr nick 2>&1` && $?.success?)
+      !!(`bzr nick 2>&1` && cmd_success?)
     end
 
+    # @return [Array]
     def get_logs
       `bzr log -v --short #{date_range}`.split("\n").reject{|line| line !~ /^[ ]*(M|A)  /}.map{|line| line.strip.split(" ")[1..-1]}.flatten
     end
 
+    # @return [Array]
     def get_revisions
       `bzr log --line #{date_range}`.split("\n").map{|line| line[/^(\S+):/, 1] }
     end
 
+    # @raise RunTimeError Currently, the generate history option does not support Bazaar
     def generate_history(starting_point)
-      raise "currently the generate history option does not support bazaar"
+      raise NotImplementedError, "currently the generate history option does not support bazaar"
     end
 
     private
 
+    def self.cmd_success?
+      $?.success?
+    end
+
     def get_diff(revision, previous_revision)
       `bzr diff -r #{previous_revision}..#{revision}`.split(/\n/).select{|line| /^@@|^---|^\+\+\+/ =~ line }
     end
@@ -35,6 +43,5 @@ module Churn
     def get_recent_file(line)
       super(line).split("\t")[0]
     end
-
   end
 end

data/lib/churn/scm/git_analyzer.rb

@@ -1,16 +1,19 @@
 module Churn
 
-  #analizes git SCM to find recently changed files, and what lines have been altered
+  # Analyzes git SCM to find recently changed files, and what lines have been altered
   class GitAnalyzer < SourceControl
 
+    # @return [Boolean]
     def self.supported?
       !!(`git branch 2>&1` && $?.success?)
     end
 
+    # @return [Array]
     def get_logs
       `git log #{date_range} --name-only --pretty=format:`.split(/\n/).reject{|line| line == ""}
     end
 
+    # @return [Array]
     def get_revisions
       `git log #{date_range} --pretty=format:"%H"`.split(/\n/).reject{|line| line == ""}
     end
@@ -36,7 +39,7 @@ module Churn
     end
 
     def get_diff(revision, previous_revision)
-      `git diff #{revision} #{previous_revision} --unified=0`.split(/\n/).select{|line| /^@@|^---|^\+\+\+/ =~ line }
+      `git diff #{revision} #{previous_revision} --no-ext-diff --unified=0`.split(/\n/).select{|line| /^@@|^---|^\+\+\+/ =~ line }
     end
 
     def date_range
@@ -45,6 +48,5 @@ module Churn
         "--after=#{date.strftime('%Y-%m-%d')}"
       end
     end
-
   end
 end

data/lib/churn/scm/hg_analyzer.rb

@@ -1,26 +1,34 @@
 module Churn
 
-  #analizes Hg / Mercurial SCM to find recently changed files, and what lines have been altered
+  # Analyzes Hg / Mercurial SCM to find recently changed files, and what lines have been altered
   class HgAnalyzer < SourceControl
 
+    # @return [Array]
     def self.supported?
-      !!(`hg branch 2>&1` && $?.success?)
+      !!(`hg branch 2>&1` && cmd_success?)
     end
 
+    # @return [Array]
     def get_logs
       `hg log -v#{date_range}`.split("\n").reject{|line| line !~ /^files:/}.map{|line| line.split(" ")[1..-1]}.flatten
     end
 
+    # @return [Array]
     def get_revisions
       `hg log#{date_range}`.split("\n").reject{|line| line !~ /^changeset:/}.map{|line| line[/:(\S+)$/, 1] }
     end
 
+    # @raise RunTimeError Currently, the generate history option does not support Mercurial
     def generate_history(starting_point)
-      raise "currently the generate history option does not support mercurial"
+      raise NotImplementedError, "currently the generate history option does not support mercurial"
     end
 
     private
 
+    def self.cmd_success?
+      $?.success?
+    end
+    
     def get_diff(revision, previous_revision)
       `hg diff -r #{revision}:#{previous_revision} -U 0`.split(/\n/).select{|line| /^@@|^---|^\+\+\+/ =~ line }
     end
@@ -35,6 +43,5 @@ module Churn
     def get_recent_file(line)
       super(line).split("\t")[0]
     end
-
   end
 end

data/lib/churn/scm/source_control.rb

@@ -1,6 +1,6 @@
 module Churn
 
-  # Base clase for analyzing various SCM systems like git, HG, and SVN
+  # Base class for analyzing various SCM systems like git, HG, and SVN
   class SourceControl
 
     def self.set_source_control(start_date)
@@ -13,8 +13,9 @@ module Churn
       end
     end
 
+    # @api public
     def self.supported?
-      raise "child class must implement"
+      raise NotImplementedError, "child class must implement"
     end
 
     def initialize(start_date=nil)
@@ -22,15 +23,15 @@ module Churn
     end
 
     def get_logs
-      raise "child class must implement"
+      raise NotImplementedError, "child class must implement"
     end
 
     def get_revisions
-      raise "child class must implement"
+      raise NotImplementedError, "child class must implement"
     end
 
     def generate_history(starting_point)
-      raise "child class must implement"
+      raise NotImplementedError, "child class must implement"
     end
 
     def get_updated_files_change_info(revision, revisions)
@@ -49,7 +50,6 @@ module Churn
           updated[recent_file] << removed_range
           updated[recent_file] << added_range
         else
-          puts /^---/ =~ line
           raise "diff lines that don't match the two patterns aren't expected: '#{line}'"
         end
       end
@@ -87,7 +87,5 @@ module Churn
     def get_recent_file(line)
       line.gsub(/^--- /,'').gsub(/^\+\+\+ /,'').gsub(/^a\//,'').gsub(/^b\//,'')
     end
-
   end
-
 end

data/lib/churn/scm/svn_analyzer.rb

@@ -1,25 +1,31 @@
 module Churn
 
-  #analizes SVN SCM to find recently changed files, and what lines have been altered
+  # Analyzes SVN SCM to find recently changed files, and what lines have been altered
   class SvnAnalyzer < SourceControl
 
+    # @return [Boolean]
     def self.supported?
       File.exist?(".svn")
     end
 
+    # @return [Array]
     def get_logs
       `svn log --verbose#{date_range}#{svn_credentials}`.split(/\n/).map { |line| clean_up_svn_line(line) }.compact
     end
 
+    # @raise RunTimeError Currently, the generate history option does not support Subversion
     def generate_history(starting_point)
-      raise "currently the generate history option does not support subversion"
+      raise NotImplementedError, "currently the generate history option does not support subversion"
     end
 
-    #below 2 methods aren't supported by SVN so they become noops
+    # This method is not supported by SVN
+    # @return [Array]
     def get_revisions
       []
     end
 
+    # This method is not supported by SVN
+    # @return [Hash]
     def get_updated_files_change_info(revision, revisions)
       {}
     end

data/lib/churn/version.rb

@@ -1,3 +1,3 @@
 module Churn
-  VERSION = "1.0.2"
+  VERSION = "1.0.4"
 end

metadata

@@ -1,209 +1,111 @@
 --- !ruby/object:Gem::Specification
 name: churn
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.0.4
 platform: ruby
 authors:
 - Dan Mayer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-17 00:00:00.000000000 Z
+date: 2019-09-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '5.3'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '5.3'
-- !ruby/object:Gem::Dependency
-  name: shoulda
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: test_construct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: mocha
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rdoc
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: main
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: json_pure
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: chronic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.3
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.2.3
 - !ruby/object:Gem::Dependency
   name: sexp_processor
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.1'
 - !ruby/object:Gem::Dependency
   name: ruby_parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: hirb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.6.0
 description: 'High method and class churn has been shown to have increased bug and
@@ -213,68 +115,12 @@ email: dan@mayerdan.com
 executables:
 - churn
 extensions: []
-extra_rdoc_files:
-- LICENSE
-- README.md
+extra_rdoc_files: []
 files:
-- .deferred_server
-- .document
-- .gitignore
-- .travis.yml
-- Gemfile
-- Gemfile.lock
-- LICENSE
+- LICENSE.txt
 - README.md
-- Rakefile
 - bin/churn
 - churn.gemspec
-- doc/Churn.html
-- doc/Churn/BzrAnalyzer.html
-- doc/Churn/ChurnCalculator.html
-- doc/Churn/ChurnHistory.html
-- doc/Churn/ChurnOptions.html
-- doc/Churn/GitAnalyzer.html
-- doc/Churn/HgAnalyzer.html
-- doc/Churn/LocationMapping.html
-- doc/Churn/SourceControl.html
-- doc/Churn/SvnAnalyzer.html
-- doc/LICENSE.html
-- doc/Object.html
-- doc/created.rid
-- doc/images/add.png
-- doc/images/arrow_up.png
-- doc/images/brick.png
-- doc/images/brick_link.png
-- doc/images/bug.png
-- doc/images/bullet_black.png
-- doc/images/bullet_toggle_minus.png
-- doc/images/bullet_toggle_plus.png
-- doc/images/date.png
-- doc/images/delete.png
-- doc/images/find.png
-- doc/images/loadingAnimation.gif
-- doc/images/macFFBgHack.png
-- doc/images/package.png
-- doc/images/page_green.png
-- doc/images/page_white_text.png
-- doc/images/page_white_width.png
-- doc/images/plugin.png
-- doc/images/ruby.png
-- doc/images/tag_blue.png
-- doc/images/tag_green.png
-- doc/images/transparent.png
-- doc/images/wrench.png
-- doc/images/wrench_orange.png
-- doc/images/zoom.png
-- doc/index.html
-- doc/js/darkfish.js
-- doc/js/jquery.js
-- doc/js/navigation.js
-- doc/js/search.js
-- doc/js/search_index.js
-- doc/js/searcher.js
-- doc/rdoc.css
-- doc/table_of_contents.html
 - lib/churn.rb
 - lib/churn/calculator.rb
 - lib/churn/history.rb
@@ -289,18 +135,6 @@ files:
 - lib/tasks/churn_tasks.rb
 - man/churn.1
 - man/churn.html
-- test/data/churn_calculator.rb
-- test/data/test_helper.rb
-- test/test_helper.rb
-- test/unit/bzr_analyzer_test.rb
-- test/unit/churn_calculator_test.rb
-- test/unit/churn_history_test.rb
-- test/unit/churn_options_test.rb
-- test/unit/git_analyzer_test.rb
-- test/unit/hg_analyzer_test.rb
-- test/unit/location_mapping_test.rb
-- test/unit/source_control_test.rb
-- test/unit/svn_analyzer_test.rb
 homepage: http://github.com/danmayer/churn
 licenses:
 - MIT
@@ -311,17 +145,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
-requirements: []
-rubyforge_project: churn
-rubygems_version: 2.0.3
+requirements:
+- bzr, git, hg or svn
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Providing additional churn metrics over the original metric_fu churn