metric_fu 4.1.3 → 4.2.0

data/HISTORY.md

@@ -1,5 +1,14 @@
 ### Master
 
+### MetricFu 4.2.0 / 2013-05-20
+
+* Features
+  * Allow setting of the --continue flag with flog (Eric Wollesen)
+*Fixes
+  * Allow the 2.0.x point releases (Benjamin Fleischer #75)
+* Misc
+  * Make Location and AnalyzedProblems code more confident (Avdi Grimm)
+
 ### MetricFu 4.1.3 / 2013-05-13
 
 * Features

data/Rakefile

@@ -1,6 +1,11 @@
 #!/usr/bin/env rake
 require 'bundler/setup'
-require 'bundler/gem_tasks'
+
+
+Dir['./gem_tasks/*.rake'].each do |task|
+  import(task)
+end
+
 # $LOAD_PATH << '.'
 begin
   require 'spec/rake/spectask'

data/TODO.md

@@ -35,6 +35,10 @@ Also see [CONTRIBUTING](./CONTRIBUTING.md)
 
 ## Misc
 
+### Work on dependent libraries
+
+* Look into getting rails_best_practices, cane, and flog to use a non-MRI-specific parser, such as [parser](https://github.com/whitequark/parser/), aka not Ripper
+
 ### Improvements
 
 * See TODO items in the code

data/checksum/metric_fu-4.2.0.gem.sha512

@@ -0,0 +1 @@
+9dab16044285faa2d79afc40e701fb35d7e41d658d147bb161f616676f3258e069c1e250c1d854460e67ca1674ae286265f43dcd50255416c0e6d8e9e919b516

data/gem_tasks/build.rake

@@ -0,0 +1,46 @@
+# see http://blog.jayfields.com/2008/02/rake-task-overwriting.html
+desc 'override bundler release task'
+task :release => ['build'] do
+  STDOUT.puts "Running Bundler Release Task Override"
+end
+require 'bundler/gem_tasks'
+
+GEMSPEC = Bundler::GemHelper.gemspec
+
+# bundler-free alternative
+# packaging
+# https://github.com/YorickPeterse/ruby-lint/blob/master/Rakefile
+# require 'rubygems/package_task'
+# GEMSPEC = Gem::Specification.load('metric_fu.gemspec')
+#
+# Gem::PackageTask.new(GEMSPEC) do |pkg|
+#   pkg.need_tar = false
+#   pkg.need_zip = false
+# end
+
+# gem signing
+# desc 'Builds and signs a new Gem'
+# task :build => [:gem] do
+#   name = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+#   path = File.join(File.expand_path('../../pkg', __FILE__), name)
+#
+#   sh("gem sign #{path}")
+#
+#   Rake::Task['checksum'].invoke
+# end
+
+require 'digest/sha2'
+
+desc 'Creates a SHA512 checksum of the current version'
+task :checksum => ['build']  do
+  checksums = File.expand_path('../../checksum', __FILE__)
+  name      = "#{GEMSPEC.name}-#{GEMSPEC.version}.gem"
+  path      = File.join(File.expand_path('../../pkg', __FILE__), name)
+
+  checksum_name = File.basename(path) + '.sha512'
+  checksum      = Digest::SHA512.new.hexdigest(File.read(path))
+
+  File.open(File.join(checksums, checksum_name), 'w') do |handle|
+    handle.write(checksum)
+  end
+end

data/lib/metric_fu/data_structures/location.rb

@@ -5,28 +5,21 @@ module MetricFu
     attr_accessor :class_name, :method_name, :file_path, :simple_method_name, :hash
 
     def self.get(file_path, class_name, method_name)
-      # This could be more 'confident' using Maybe, but we want it to be as fast as possible
-      file_path_copy = file_path == nil ? nil : file_path.clone
-      class_name_copy = class_name == nil ? nil : class_name.clone
-      method_name_copy = method_name == nil ? nil : method_name.clone
-      key = [file_path_copy, class_name_copy, method_name_copy]
+      location = new(file_path, class_name, method_name)
       @@locations ||= {}
-      if @@locations.has_key?(key)
-        @@locations[key]
-      else
-        location = self.new(file_path_copy, class_name_copy, method_name_copy)
-        @@locations[key] = location
-        location.freeze  # we cache a lot of method call results, so we want location to be immutable
+      @@locations.fetch(location.to_key) do
+        @@locations[location.to_key] = location
+        location.finalize
         location
       end
     end
 
     def initialize(file_path, class_name, method_name)
-      @file_path = file_path
-      @class_name = class_name
-      @method_name = method_name
-      @simple_method_name = @method_name.sub(@class_name,'') unless @method_name == nil
-      @hash = [@file_path, @class_name, @method_name].hash
+      @file_path          = file_path
+      @class_name         = class_name
+      @method_name        = method_name
+      @simple_method_name = @method_name.to_s.sub(@class_name.to_s,'')
+      @hash               = to_key.hash
     end
 
     # TODO - we need this method (and hash accessor above) as a temporary hack where we're using Location as a hash key
@@ -69,6 +62,17 @@ module MetricFu
       [self.file_path.to_s, self.class_name.to_s, self.method_name.to_s] <=> [other.file_path.to_s, other.class_name.to_s, other.method_name.to_s]
     end
 
+    def to_key
+      [@file_path, @class_name, @method_name]
+    end
+
+    def finalize
+      @file_path   &&= @file_path.clone
+      @class_name  &&= @class_name.clone
+      @method_name &&= @method_name.clone
+      freeze  # we cache a lot of method call results, so we want location to be immutable
+    end
+
     private
 
     def self.strip_modules(class_or_method_name)

data/lib/metric_fu/metrics/flog/flog.rb

@@ -25,9 +25,11 @@ module MetricFu
         dir_files = remove_excluded_files(dir_files)
         files += dir_files
       end
-      options = ::Flog.parse_options ["--all", "--details"]
-      # TODO determine if flogging should continue despite errors
-      # options = ::Flog.parse_options ["--all", "--details", "--continue"]
+      options = ::Flog.parse_options [
+        "--all",
+        "--details",
+        MetricFu.flog[:continue] ? "--continue" : nil,
+      ].compact
 
       @flogger = ::Flog.new options
       @flogger.flog files

data/lib/metric_fu/metrics/hotspots/analysis/analyzed_problems.rb

@@ -44,22 +44,26 @@ module MetricFu
     end
     def location(item, value)
       sub_table = get_sub_table(item, value)
-      if(sub_table.length==0)
-        raise MetricFu::AnalysisError, "The #{item.to_s} '#{value.to_s}' does not have any rows in the analysis table"
+      assert_sub_table_has_data(item, sub_table, value)
+      first_row = sub_table[0]
+      case item
+      when :class
+        MetricFu::Location.get(first_row.file_path, first_row.class_name, nil)
+      when :method
+        MetricFu::Location.get(first_row.file_path, first_row.class_name, first_row.method_name)
+      when :file
+        MetricFu::Location.get(first_row.file_path, nil, nil)
       else
-        first_row = sub_table[0]
-        case item
-        when :class
-          MetricFu::Location.get(first_row.file_path, first_row.class_name, nil)
-        when :method
-          MetricFu::Location.get(first_row.file_path, first_row.class_name, first_row.method_name)
-        when :file
-          MetricFu::Location.get(first_row.file_path, nil, nil)
-        else
-          raise ArgumentError, "Item must be :class, :method, or :file"
-        end
+        raise ArgumentError, "Item must be :class, :method, or :file"
+      end
+    end
+
+    def assert_sub_table_has_data(item, sub_table, value)
+      if (sub_table.length==0)
+        raise MetricFu::AnalysisError, "The #{item.to_s} '#{value.to_s}' does not have any rows in the analysis table"
       end
     end
+
     # just for testing
     public :location, :problems_with
     def get_sub_table(item, value)

data/lib/metric_fu/version.rb

@@ -1,3 +1,3 @@
 module MetricFu
-  VERSION = "4.1.3"
+  VERSION = "4.2.0"
 end

data/lib/metric_fu_requires.rb

@@ -21,7 +21,7 @@ module MetricFu
     end
 
     def ruby2ruby
-      ['= 2.0.2']
+      ['~> 2.0', '>= 2.0.2']
     end
     def ruby_parser
       ['~> 3.0', '>= 3.1.1']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metric_fu
 version: !ruby/object:Gem::Version
-  version: 4.1.3
+  version: 4.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -19,7 +19,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-13 00:00:00.000000000 Z
+date: 2013-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: flay
@@ -144,7 +144,10 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.2
   type: :runtime
@@ -152,7 +155,10 @@ dependencies:
   version_requirements: !ruby/object:Gem::Requirement
     none: false
     requirements:
-    - - '='
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.0'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.2
 - !ruby/object:Gem::Dependency
@@ -343,7 +349,6 @@ files:
 - Gemfile
 - HISTORY.md
 - MIT-LICENSE
-- Manifest.txt
 - README.md
 - Rakefile
 - TODO.md
@@ -355,7 +360,10 @@ files:
 - bin/mf-reek
 - bin/mf-roodi
 - bin/mf-stats
+- checksum/.gitkeep
+- checksum/metric_fu-4.2.0.gem.sha512
 - config/roodi_config.yml
+- gem_tasks/build.rake
 - lib/metric_fu.rb
 - lib/metric_fu/cli/client.rb
 - lib/metric_fu/cli/helper.rb
@@ -549,7 +557,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.6
 requirements: []
 rubyforge_project: metric_fu
-rubygems_version: 1.8.24
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: A fistful of code metrics, with awesome templates and graphs

data/Manifest.txt

@@ -1,25 +0,0 @@
-History.txt
-Manifest.txt
-metric_fu-0.7.gem
-metric_fu.gemspec
-MIT-LICENSE
-Rakefile
-README
-TODO.txt
-lib/metric_fu.rb
-lib/metric_fu/base.rb
-lib/metric_fu/churn.rb
-lib/metric_fu/flay_reporter.rb
-lib/metric_fu/flog_reporter.rb
-lib/metric_fu/md5_tracker.rb
-lib/metric_fu/saikuro/saikuro.rb
-lib/metric_fu/saikuro/SAIKURO_README
-lib/tasks/churn.rake
-lib/tasks/coverage.rake
-lib/tasks/flog.rake
-lib/tasks/metric_fu.rake
-lib/tasks/metric_fu.rb
-lib/tasks/saikuro.rake
-lib/tasks/stats.rake
-test/test_helper.rb
-test/test_md5_tracker.rb