rubycritic 2.2.0 → 2.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1bbd53ca30b1e2cae94b44246ca2df4f1ef200bb
-  data.tar.gz: 584e3a45c1c3ae04c261366b706699c5087effea
+  metadata.gz: 08d300df3ff05cf7919348a8302d52623343c9b7
+  data.tar.gz: 75d743139e01f2310eec35c8300b25d0550f689a
 SHA512:
-  metadata.gz: 9a452882ed7dc3cb9bd8ab6817650a4f475ea06cc465ff7c9d9290495578be1ad76c04eb31cd66155813a88d14ad28c44c43280f2bcef7d0a5a521d8e8abd97c
-  data.tar.gz: 2b2f54e2f3f40363bdd9f628e0f0fa0ff742dde3ad217aa69f0d25e2bb0424bc3a8119a37937e42c49fbf197604c5e4ae54e1c8d0fb3459f90662461165f9609
+  metadata.gz: c3453709805cd4268e8093baf584b3db879c400bca3240e22c919dd1a3a6deea19d683750aaf48a9dca1e27c8c07374be50d7daccb009ede7fdcda14e22f6867
+  data.tar.gz: 2c746421764e0bef87f7798c09c7fbb4234758c73c9a408f776f7f4494231ba814b10e7750e678e9057817200a3ba1a3a96ae907752876be1075f47d33a18efe

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.3.0 / 2015-11-30
+
+* [FEATURE] Added global score calculation
+* [CHANGE] Bump Reek dependency to 3.7.1.
+
 # 2.2.0 / 2015-11-20
 
 * [CHANGE] Use `Reeks` default configuration loading.

data/lib/rubycritic/analysers_runner.rb

@@ -1,5 +1,4 @@
-require "rubycritic/source_locator"
-require "rubycritic/core/analysed_module"
+require "rubycritic/core/analysed_modules_collection"
 require "rubycritic/analysers/smells/flay"
 require "rubycritic/analysers/smells/flog"
 require "rubycritic/analysers/smells/reek"
@@ -29,9 +28,7 @@ module Rubycritic
     end
 
     def analysed_modules
-      @analysed_modules ||= SourceLocator.new(@paths).pathnames.map do |pathname|
-        AnalysedModule.new(:pathname => pathname)
-      end
+      @analysed_modules ||= AnalysedModulesCollection.new(@paths)
     end
   end
 

data/lib/rubycritic/core/analysed_modules_collection.rb

@@ -0,0 +1,49 @@
+require "rubycritic/source_locator"
+require "rubycritic/core/analysed_module"
+
+module Rubycritic
+  class AnalysedModulesCollection
+    include Enumerable
+
+    # Limit used to prevent very bad modules to have excessive impact in the
+    # overall result. See #limited_cost_for
+    COST_LIMIT = 32
+    # Score goes from 0 (worst) to 100 (perfect)
+    MAX_SCORE = 100
+    # Projects with an average cost of 16 (or above) will score 0, since 16
+    # is where the worst possible rating (F) starts
+    ZERO_SCORE_COST = 16
+    COST_MULTIPLIER = MAX_SCORE.to_f / ZERO_SCORE_COST
+
+    def initialize(paths)
+      @modules = SourceLocator.new(paths).pathnames.map do |pathname|
+        AnalysedModule.new(:pathname => pathname)
+      end
+    end
+
+    def each(&block)
+      @modules.each(&block)
+    end
+
+    def to_json(*options)
+      @modules.to_json(*options)
+    end
+
+    def score
+      MAX_SCORE - average_limited_cost * COST_MULTIPLIER
+    rescue
+      0.0
+    end
+
+    private
+
+    def average_limited_cost
+      avg = map { |mod| limited_cost_for(mod) }.reduce(:+) / @modules.size.to_f
+      [avg, ZERO_SCORE_COST].min
+    end
+
+    def limited_cost_for(mod)
+      [mod.cost, COST_LIMIT].min
+    end
+  end
+end

data/lib/rubycritic/generators/html/overview.rb

@@ -10,6 +10,8 @@ module Rubycritic
 
         def initialize(analysed_modules)
           @turbulence_data = Turbulence.data(analysed_modules)
+          @score = analysed_modules.score
+          @max_score = AnalysedModulesCollection::MAX_SCORE
         end
 
         def file_name

data/lib/rubycritic/generators/html/templates/overview.html.erb

@@ -1,3 +1,7 @@
+<div class="chart-container">
+  <h2>Score: <%= @score.round(2) %> / <%= @max_score %></h2>
+</div>
+
 <div id="js-chart-container" class="chart-container"></div>
 
 <script type="text/javascript">

data/lib/rubycritic/generators/json/simple.rb

@@ -21,7 +21,8 @@ module Rubycritic
                 :version => Rubycritic::VERSION
               }
             },
-            :analysed_modules => @analysed_modules
+            :analysed_modules => @analysed_modules,
+            :score => @analysed_modules.score
           }
         end
       end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "2.2.0"
+  VERSION = "2.3.0"
 end

data/rubycritic.gemspec

@@ -23,7 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "virtus", "~> 1.0"
   spec.add_runtime_dependency "flay", "2.6.1"
   spec.add_runtime_dependency "flog", "4.3.2"
-  spec.add_runtime_dependency "reek", "3.6.0"
+  spec.add_runtime_dependency "reek", "3.7.1"
   spec.add_runtime_dependency "parser", ">= 2.2.0", "< 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"

data/test/lib/rubycritic/analysers/smells/reek_test.rb

@@ -16,10 +16,10 @@ describe Rubycritic::Analyser::ReekSmells do
 
     it "creates smells with messages" do
       first_smell = @analysed_module.smells.first
-      first_smell.message.must_equal "has no descriptive comment"
+      first_smell.message.must_equal "has boolean parameter 'reek'"
 
       last_smell = @analysed_module.smells.last
-      last_smell.message.must_equal "has boolean parameter 'reek'"
+      last_smell.message.must_equal "has no descriptive comment"
     end
   end
 end

data/test/lib/rubycritic/core/analysed_modules_collection_test.rb

@@ -0,0 +1,109 @@
+require "test_helper"
+require "rubycritic/core/analysed_modules_collection"
+
+describe Rubycritic::AnalysedModulesCollection do
+  subject { Rubycritic::AnalysedModulesCollection.new(paths) }
+
+  describe ".new" do
+    context "with an empty path" do
+      let(:paths) { "" }
+
+      it "returns an empty collection" do
+        subject.count.must_equal 0
+      end
+    end
+
+    context "with a list of files" do
+      let(:paths) { %w(test/samples/doesnt_exist.rb test/samples/unparsable.rb test/samples/empty.rb) }
+
+      it "registers one AnalysedModule element per existent file" do
+        subject.count.must_equal 2
+        subject.all? { |a| a.is_a?(Rubycritic::AnalysedModule) }.must_equal true
+      end
+    end
+
+    context "with a directory" do
+      let(:paths) { "test/samples/" }
+
+      it "recursively registers all files" do
+        subject.count.must_equal 13
+      end
+    end
+
+    context "with redundant paths" do
+      let(:paths) { %w(test/samples/flog test/samples/flog/complex.rb) }
+
+      it "returns a redundant collection" do
+        subject.count.must_equal 3
+      end
+    end
+  end
+
+  describe "#score" do
+    context "with no modules" do
+      let(:paths) { "" }
+
+      it "returns zero" do
+        subject.score.must_equal 0.0
+      end
+    end
+
+    context "with not analysed modules" do
+      let(:paths) { "test/samples/flog" }
+
+      it "returns zero" do
+        subject.score.must_equal 0.0
+      end
+    end
+
+    context "with analysed modules" do
+      before do
+        subject.each_with_index do |mod, i|
+          mod.expects(:cost).returns costs[i]
+        end
+      end
+
+      let(:paths) { %w(test/samples/flog test/samples/flay) }
+
+      context "with perfect modules" do
+        let(:costs) { [0.0, 0.0, 0.0, 0.0] }
+
+        it "returns the maximum score" do
+          subject.score.must_equal 100.0
+        end
+      end
+
+      context "with very bad modules" do
+        let(:costs) { [16.0, 16.0, 16.0, 16.0] }
+
+        it "returns zero" do
+          subject.score.must_equal 0.0
+        end
+      end
+
+      context "with horrible modules" do
+        let(:costs) { [32.0, 32.0, 32.0, 32.0] }
+
+        it "returns zero" do
+          subject.score.must_equal 0.0
+        end
+      end
+
+      context "with mixed modules" do
+        let(:costs) { [32.0, 2.0, 0.0, 2.0] }
+
+        it "properly calculates the score" do
+          subject.score.must_equal 43.75
+        end
+      end
+
+      context "with a module above the cost limit" do
+        let(:costs) { [220.0, 2.0, 0.0, 2.0] }
+
+        it "reduces the impact in the result" do
+          subject.score.must_equal 43.75
+        end
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.3.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-24 00:00:00.000000000 Z
+date: 2015-11-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 3.6.0
+        version: 3.7.1
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -198,6 +198,7 @@ files:
 - lib/rubycritic/commands/version.rb
 - lib/rubycritic/configuration.rb
 - lib/rubycritic/core/analysed_module.rb
+- lib/rubycritic/core/analysed_modules_collection.rb
 - lib/rubycritic/core/location.rb
 - lib/rubycritic/core/rating.rb
 - lib/rubycritic/core/smell.rb
@@ -250,6 +251,7 @@ files:
 - test/lib/rubycritic/analysers/smells/reek_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_module_test.rb
+- test/lib/rubycritic/core/analysed_modules_collection_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb
@@ -300,7 +302,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: RubyCritic is a Ruby code quality reporter
@@ -315,6 +317,7 @@ test_files:
 - test/lib/rubycritic/analysers/smells/reek_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_module_test.rb
+- test/lib/rubycritic/core/analysed_modules_collection_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb