rubycritic 1.0.2 → 1.1.0

data/test/lib/rubycritic/analysers/helpers/modules_locator_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+require "rubycritic/analysers/helpers/modules_locator"
+require "rubycritic/core/analysed_module"
+require "pathname"
+
+describe Rubycritic::ModulesLocator do
+  describe "#names" do
+    context "when a file contains Ruby code" do
+      it "returns the names of all the classes and modules inside the file" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/module_names.rb"),
+          :methods_count => 1
+        )
+        Rubycritic::ModulesLocator.new(analysed_module).names
+          .must_equal ["Foo", "Foo::Bar", "Foo::Baz", "Foo::Qux", "Foo::Quux::Corge"]
+      end
+    end
+
+    context "when a file is empty" do
+      it "returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/empty.rb"),
+          :methods_count => 1
+        )
+        Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Empty"]
+      end
+    end
+
+    context "when a file is unparsable" do
+      it "does not blow up and returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/unparsable.rb"),
+          :methods_count => 1
+        )
+        capture_output_streams do
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Unparsable"]
+        end
+      end
+    end
+
+    context "when a file has no methods" do
+      it "returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/no_methods.rb"),
+          :methods_count => 0
+        )
+        capture_output_streams do
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["NoMethods"]
+        end
+      end
+    end
+  end
+end

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

@@ -1,34 +1,32 @@
 require "test_helper"
 require "rubycritic/analysers/smells/flay"
-require "rubycritic/core/analysed_file"
+require "rubycritic/core/analysed_module"
 require "pathname"
 
 describe Rubycritic::Analyser::FlaySmells do
   before do
-    @analysed_file = Rubycritic::AnalysedFile.new(
+    @analysed_module = Rubycritic::AnalysedModule.new(
       :pathname => Pathname.new("test/samples/flay/smelly.rb"),
-      :smells => [],
-      :duplication => 0
     )
-    analysed_files = [@analysed_file]
-    Rubycritic::Analyser::FlaySmells.new(analysed_files).run
+    analysed_modules = [@analysed_module]
+    Rubycritic::Analyser::FlaySmells.new(analysed_modules).run
   end
 
-  it "detects smells and adds them to analysed_files" do
-    @analysed_file.smells.length.must_equal 1
+  it "detects smells and adds them to analysed_modules" do
+    @analysed_module.smells.length.must_equal 1
   end
 
   it "creates smells with messages" do
-    smell = @analysed_file.smells.first
+    smell = @analysed_module.smells.first
     smell.message.must_be_instance_of String
   end
 
   it "creates smells with scores" do
-    smell = @analysed_file.smells.first
+    smell = @analysed_module.smells.first
     smell.score.must_be_kind_of Numeric
   end
 
-  it "calculates the mass of duplicate code and adds it to analysed_files" do
-    @analysed_file.duplication.must_be(:>, 0)
+  it "calculates the mass of duplicate code and adds it to analysed_modules" do
+    @analysed_module.duplication.must_be(:>, 0)
   end
 end

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

@@ -3,22 +3,22 @@ require "rubycritic/analysers/smells/flog"
 
 describe Rubycritic::Analyser::FlogSmells do
   before do
-    @analysed_file = AnalysedFileDouble.new(:path => "test/samples/flog/smelly.rb", :smells => [])
-    analysed_files = [@analysed_file]
-    Rubycritic::Analyser::FlogSmells.new(analysed_files).run
+    @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/smelly.rb", :smells => [])
+    analysed_modules = [@analysed_module]
+    Rubycritic::Analyser::FlogSmells.new(analysed_modules).run
   end
 
-  it "detects smells and adds them to analysed_files" do
-    @analysed_file.smells.length.must_equal 1
+  it "detects smells and adds them to analysed_modules" do
+    @analysed_module.smells.length.must_equal 1
   end
 
   it "creates smells with messages" do
-    smell = @analysed_file.smells.first
+    smell = @analysed_module.smells.first
     smell.message.must_be_instance_of String
   end
 
   it "creates smells with scores" do
-    smell = @analysed_file.smells.first
+    smell = @analysed_module.smells.first
     smell.score.must_be_kind_of Numeric
   end
 end

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

@@ -4,30 +4,30 @@ require "rubycritic/analysers/smells/reek"
 describe Rubycritic::Analyser::ReekSmells do
   context "when analysing a smelly file" do
     before do
-      @analysed_file = AnalysedFileDouble.new(:path => "test/samples/reek/smelly.rb", :smells => [])
-      analysed_files = [@analysed_file]
-      Rubycritic::Analyser::ReekSmells.new(analysed_files).run
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/reek/smelly.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
     end
 
-    it "detects smells and adds them to analysed_files" do
-      @analysed_file.smells.length.must_equal 1
+    it "detects smells and adds them to analysed_modules" do
+      @analysed_module.smells.length.must_equal 1
     end
 
     it "creates smells with messages" do
-      smell = @analysed_file.smells.first
+      smell = @analysed_module.smells.first
       smell.message.must_equal "has boolean parameter 'reek'"
     end
   end
 
   context "when analysing a file with smells ignored in config.reek" do
     before do
-      @analysed_file = AnalysedFileDouble.new(:path => "test/samples/reek/not_smelly.rb", :smells => [])
-      analysed_files = [@analysed_file]
-      Rubycritic::Analyser::ReekSmells.new(analysed_files).run
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/reek/not_smelly.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
     end
 
     it "does not detect smells and does not add them to analysed files" do
-      @analysed_file.smells.must_be_empty
+      @analysed_module.smells.must_be_empty
     end
   end
 end

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

@@ -0,0 +1,88 @@
+require "test_helper"
+require "rubycritic/core/analysed_module"
+require "rubycritic/core/smell"
+
+describe Rubycritic::AnalysedModule do
+  describe "attribute readers" do
+    before do
+      @name = "Foo"
+      @pathname = Pathname.new("foo.rb")
+      @smells = []
+      @churn = 1
+      @complexity = 2
+      @analysed_module = Rubycritic::AnalysedModule.new(
+        :name       => @name,
+        :pathname   => @pathname,
+        :smells     => @smells,
+        :churn      => @churn,
+        :complexity => @complexity
+      )
+    end
+
+    it "has a name reader" do
+      @analysed_module.name.must_equal @name
+    end
+
+    it "has a pathname reader" do
+      @analysed_module.pathname.must_equal @pathname
+    end
+
+    it "has a path reader" do
+      @analysed_module.path.must_equal @pathname.to_s
+    end
+
+    it "has a smells reader" do
+      @analysed_module.smells.must_equal @smells
+    end
+
+    it "has a churn reader" do
+      @analysed_module.churn.must_equal @churn
+    end
+
+    it "has a complexity reader" do
+      @analysed_module.complexity.must_equal @complexity
+    end
+  end
+
+  describe "#cost" do
+    it "returns the remediation cost of fixing the analysed_module" do
+      smells = [SmellDouble.new(:cost => 1), SmellDouble.new(:cost => 2)]
+      analysed_module = Rubycritic::AnalysedModule.new(:smells => smells, :complexity => 0)
+      analysed_module.cost.must_equal 3
+    end
+  end
+
+  describe "#complexity_per_method" do
+    context "when the file has no methods" do
+      it "returns a placeholder" do
+        analysed_module = Rubycritic::AnalysedModule.new(:complexity => 0, :methods_count => 0)
+        analysed_module.complexity_per_method.must_equal "N/A"
+      end
+    end
+
+    context "when the file has at least one method" do
+      it "returns the average complexity per method" do
+        analysed_module = Rubycritic::AnalysedModule.new(:complexity => 10, :methods_count => 2)
+        analysed_module.complexity_per_method.must_equal 5
+      end
+    end
+  end
+
+  describe "#has_smells?" do
+    it "returns true if the analysed_module has at least one smell" do
+      analysed_module = Rubycritic::AnalysedModule.new(:smells => [SmellDouble.new])
+      analysed_module.has_smells?.must_equal true
+    end
+  end
+
+  describe "#smells_at_location" do
+    it "returns the smells of an analysed_module at a certain location" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smells = [Rubycritic::Smell.new(:locations => [location])]
+      analysed_module = Rubycritic::AnalysedModule.new(:smells => smells)
+      analysed_module.smells_at_location(location).must_equal smells
+    end
+  end
+end
+
+class SmellDouble < OpenStruct; end

data/test/lib/rubycritic/report_generators/turbulence_test.rb

@@ -2,16 +2,16 @@ require "test_helper"
 require "rubycritic/report_generators/turbulence"
 
 describe Rubycritic::Turbulence do
-  describe "#data" do
+  describe "::data" do
     it "returns json data that maps pathname, churn and complexity to name, x and y" do
-      files = [AnalysedFileDouble.new(:pathname => "./foo.rb", :churn => 1, :complexity => 2)]
+      files = [AnalysedModuleDouble.new(:name => "Foo", :churn => 1, :complexity => 2)]
       turbulence_data = Rubycritic::Turbulence.data(files)
       instance_parsed_json = JSON.parse(turbulence_data).first
-      instance_parsed_json["name"].must_equal "./foo.rb"
+      instance_parsed_json["name"].must_equal "Foo"
       instance_parsed_json["x"].must_equal 1
       instance_parsed_json["y"].must_equal 2
     end
   end
 end
 
-class AnalysedFileDouble < OpenStruct; end
+class AnalysedModuleDouble < OpenStruct; end

data/test/lib/rubycritic/report_generators/view_helpers_test.rb

@@ -22,57 +22,44 @@ describe Rubycritic::ViewHelpers do
 
     describe "#asset_path" do
       it "creates a relative path to an asset" do
-        generator.asset_path("stylesheets", "application.css").to_s
+        generator.asset_path("stylesheets/application.css").to_s
           .must_equal "assets/stylesheets/application.css"
       end
     end
   end
 
-  context "when the file is in a subdirectory" do
-    let(:generator) { GeneratorDouble.new("subdirectory/foo.html") }
+  context "when the file is n directories deep" do
+    let(:generator) { GeneratorDouble.new("lets/go/crazy/foo.html") }
 
     describe "#file_path" do
       context "when the other file is in the same directory" do
         it "creates a relative path to a file" do
-          generator.file_path("subdirectory/bar.html").to_s.must_equal "bar.html"
+          generator.file_path("lets/go/crazy/bar.html").to_s.must_equal "bar.html"
         end
       end
 
       context "when the other file is in the root directory" do
         it "creates a relative path to a file" do
-          generator.file_path("bar.html").to_s.must_equal "../bar.html"
+          generator.file_path("bar.html").to_s.must_equal "../../../bar.html"
         end
       end
-    end
 
-    describe "#asset_path" do
-      it "creates a relative path to an asset" do
-        generator.asset_path("stylesheets", "application.css").to_s
-          .must_equal "../assets/stylesheets/application.css"
-      end
-    end
-  end
-
-  context "when the file is n directories deep" do
-    let(:generator) { GeneratorDouble.new("lets/go/crazy/foo.html") }
-
-    describe "#file_path" do
-      context "when the other file is in the same directory" do
+      context "when the other file has n-1 directories in common" do
         it "creates a relative path to a file" do
-          generator.file_path("lets/go/crazy/bar.html").to_s.must_equal "bar.html"
+          generator.file_path("lets/go/home/bar.html").to_s.must_equal "../home/bar.html"
         end
       end
 
-      context "when the other file is in the root directory" do
+      context "when the other file is one directory deeper" do
         it "creates a relative path to a file" do
-          generator.file_path("bar.html").to_s.must_equal "../../../bar.html"
+          generator.file_path("lets/go/crazy/everybody/bar.html").to_s.must_equal "everybody/bar.html"
         end
       end
     end
 
     describe "#asset_path" do
       it "creates a relative path to an asset" do
-        generator.asset_path("stylesheets", "application.css").to_s
+        generator.asset_path("stylesheets/application.css").to_s
           .must_equal "../../../assets/stylesheets/application.css"
       end
     end

data/test/lib/rubycritic/smells_status_setter_test.rb

@@ -3,7 +3,7 @@ require "rubycritic/core/smell"
 require "rubycritic/smells_status_setter"
 
 describe Rubycritic::SmellsStatusSetter do
-  describe "#smells" do
+  describe "::smells" do
     before do
       @smell = Rubycritic::Smell.new(:context => "#bar")
       @smells = [@smell]

data/test/lib/rubycritic/source_locator_test.rb

@@ -13,21 +13,21 @@ describe Rubycritic::SourceLocator do
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
 
-    it "finds files through multiple paths" do
-      paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal paths
-    end
-
     it "finds all the files inside a given directory" do
       initial_paths = ["dir1"]
       final_paths = ["dir1/file1.rb"]
       Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
+    it "finds files through multiple paths" do
+      paths = ["dir1/file1.rb", "file0.rb"]
+      Rubycritic::SourceLocator.new(paths).paths.sort.must_equal paths
+    end
+
     it "finds all the files" do
       initial_paths = ["."]
       final_paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
+      Rubycritic::SourceLocator.new(initial_paths).paths.sort.must_equal final_paths
     end
 
     it "cleans paths of consecutive slashes and useless dots" do

data/test/samples/module_names.rb

@@ -0,0 +1,18 @@
+module Foo
+end
+
+module Foo
+  class Bar
+  end
+
+  class Baz
+  end
+end
+
+class Foo::Qux
+end
+
+module Foo::Quux
+  class Corge
+  end
+end

data/test/samples/unparsable.rb

@@ -0,0 +1 @@
+unparsable :<%=

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-23 00:00:00.000000000 Z
+date: 2014-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -156,8 +156,8 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: |2
-      Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
+description: RubyCritic is a tool that wraps around various static analysis gems to
+  provide a quality report of your Ruby code.
 email:
 - guilherme.rdems@gmail.com
 executables:
@@ -167,6 +167,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
@@ -174,25 +175,27 @@ files:
 - Rakefile
 - bin/rubycritic
 - lib/rubycritic.rb
-- lib/rubycritic/analysers/adapters/ast_node.rb
-- lib/rubycritic/analysers/adapters/config.reek
-- lib/rubycritic/analysers/adapters/flay.rb
-- lib/rubycritic/analysers/adapters/flog.rb
-- lib/rubycritic/analysers/adapters/reek.rb
+- lib/rubycritic/analysers/attributes.rb
 - lib/rubycritic/analysers/churn.rb
 - lib/rubycritic/analysers/complexity.rb
+- lib/rubycritic/analysers/helpers/ast_node.rb
+- lib/rubycritic/analysers/helpers/config.reek
+- lib/rubycritic/analysers/helpers/flay.rb
+- lib/rubycritic/analysers/helpers/flog.rb
+- lib/rubycritic/analysers/helpers/methods_counter.rb
+- lib/rubycritic/analysers/helpers/modules_locator.rb
+- lib/rubycritic/analysers/helpers/reek.rb
 - lib/rubycritic/analysers/smells/flay.rb
 - lib/rubycritic/analysers/smells/flog.rb
 - lib/rubycritic/analysers/smells/reek.rb
-- lib/rubycritic/analysers/stats.rb
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
 - lib/rubycritic/configuration.rb
-- lib/rubycritic/core/analysed_file.rb
+- lib/rubycritic/core/analysed_module.rb
 - lib/rubycritic/core/location.rb
 - lib/rubycritic/core/rating.rb
 - lib/rubycritic/core/smell.rb
-- lib/rubycritic/files_initializer.rb
+- lib/rubycritic/modules_initializer.rb
 - lib/rubycritic/orchestrator.rb
 - lib/rubycritic/report_generators/assets/javascripts/application.js
 - lib/rubycritic/report_generators/assets/javascripts/highcharts.src-4.0.1.js
@@ -235,12 +238,13 @@ files:
 - test/analysers_test_helper.rb
 - test/lib/rubycritic/analysers/churn_test.rb
 - test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
+- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
 - test/lib/rubycritic/analysers/smells/flay_test.rb
 - test/lib/rubycritic/analysers/smells/flog_test.rb
 - test/lib/rubycritic/analysers/smells/reek_test.rb
-- test/lib/rubycritic/analysers/stats_test.rb
 - test/lib/rubycritic/configuration_test.rb
-- test/lib/rubycritic/core/analysed_file_test.rb
+- test/lib/rubycritic/core/analysed_module_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb
@@ -250,6 +254,7 @@ files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
@@ -257,11 +262,11 @@ files:
 - test/samples/location/file0.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
+- test/samples/methods_count.rb
+- test/samples/module_names.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
-- test/samples/stats/empty_example.rb
-- test/samples/stats/example.rb
-- test/samples/stats/unparsable_example.rb
+- test/samples/unparsable.rb
 - test/test_helper.rb
 homepage: https://github.com/whitesmith/rubycritic
 licenses:
@@ -286,17 +291,18 @@ rubyforge_project:
 rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Ruby code smell detector
+summary: RubyCritic is a Ruby code quality reporter
 test_files:
 - test/analysers_test_helper.rb
 - test/lib/rubycritic/analysers/churn_test.rb
 - test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
+- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
 - test/lib/rubycritic/analysers/smells/flay_test.rb
 - test/lib/rubycritic/analysers/smells/flog_test.rb
 - test/lib/rubycritic/analysers/smells/reek_test.rb
-- test/lib/rubycritic/analysers/stats_test.rb
 - test/lib/rubycritic/configuration_test.rb
-- test/lib/rubycritic/core/analysed_file_test.rb
+- test/lib/rubycritic/core/analysed_module_test.rb
 - test/lib/rubycritic/core/location_test.rb
 - test/lib/rubycritic/core/smell_test.rb
 - test/lib/rubycritic/core/smells_array_test.rb
@@ -306,6 +312,7 @@ test_files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
@@ -313,9 +320,9 @@ test_files:
 - test/samples/location/file0.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
+- test/samples/methods_count.rb
+- test/samples/module_names.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
-- test/samples/stats/empty_example.rb
-- test/samples/stats/example.rb
-- test/samples/stats/unparsable_example.rb
+- test/samples/unparsable.rb
 - test/test_helper.rb