rubycritic 1.0.2 → 1.1.0

data/lib/rubycritic/modules_initializer.rb

@@ -0,0 +1,14 @@
+require "rubycritic/source_locator"
+require "rubycritic/core/analysed_module"
+
+module Rubycritic
+
+  module ModulesInitializer
+    def self.init(paths)
+      SourceLocator.new(paths).pathnames.map do |pathname|
+        AnalysedModule.new(:pathname => pathname)
+      end
+    end
+  end
+
+end

data/lib/rubycritic/orchestrator.rb

@@ -1,5 +1,5 @@
 require "rubycritic/source_control_systems/base"
-require "rubycritic/files_initializer"
+require "rubycritic/modules_initializer"
 require "rubycritic/analysers_runner"
 require "rubycritic/revision_comparator"
 
@@ -11,12 +11,12 @@ module Rubycritic
     end
 
     def critique(paths)
-      analysed_files = FilesInitializer.init(paths)
-      AnalysersRunner.new(analysed_files, @source_control_system).run
+      analysed_modules = ModulesInitializer.init(paths)
+      AnalysersRunner.new(analysed_modules, @source_control_system).run
       if @source_control_system.has_revision?
-        RevisionComparator.new(analysed_files, @source_control_system).set_statuses
+        RevisionComparator.new(analysed_modules, @source_control_system).set_statuses
       end
-      analysed_files
+      analysed_modules
     end
   end
 

data/lib/rubycritic/report_generators/code_file.rb

@@ -8,9 +8,9 @@ module Rubycritic
       LINE_NUMBER_OFFSET = 1
       TEMPLATE = erb_template("code_file.html.erb")
 
-      def initialize(analysed_file)
-        @analysed_file = analysed_file
-        @pathname = @analysed_file.pathname
+      def initialize(analysed_module)
+        @analysed_module = analysed_module
+        @pathname = @analysed_module.pathname
       end
 
       def file_directory
@@ -25,7 +25,7 @@ module Rubycritic
         file_code = ""
         File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
           location = Location.new(@pathname, line_number)
-          line_smells = @analysed_file.smells_at_location(location)
+          line_smells = @analysed_module.smells_at_location(location)
           file_code << Line.new(file_directory, line_text, line_smells).render
         end
 

data/lib/rubycritic/report_generators/code_index.rb

@@ -6,8 +6,8 @@ module Rubycritic
     class CodeIndex < Base
       TEMPLATE = erb_template("code_index.html.erb")
 
-      def initialize(analysed_files)
-        @analysed_files = analysed_files
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
       end
 
       def file_name

data/lib/rubycritic/report_generators/overview.rb

@@ -7,8 +7,8 @@ module Rubycritic
     class Overview < Base
       TEMPLATE = erb_template("overview.html.erb")
 
-      def initialize(analysed_files)
-        @turbulence_data = Turbulence.data(analysed_files)
+      def initialize(analysed_modules)
+        @turbulence_data = Turbulence.data(analysed_modules)
       end
 
       def file_name

data/lib/rubycritic/report_generators/smells_index.rb

@@ -6,8 +6,9 @@ module Rubycritic
     class SmellsIndex < Base
       TEMPLATE = erb_template("smells_index.html.erb")
 
-      def initialize(smells)
-        @smells = smells
+      def initialize(analysed_modules)
+        @smells = analysed_modules.flat_map(&:smells).uniq
+        @analysed_module_names = analysed_module_names(analysed_modules)
       end
 
       def file_name
@@ -18,6 +19,16 @@ module Rubycritic
         index_body = TEMPLATE.result(get_binding)
         LAYOUT_TEMPLATE.result(get_binding { index_body })
       end
+
+      private
+
+      def analysed_module_names(analysed_modules)
+        names = {}
+        analysed_modules.each do |analysed_module|
+          names[analysed_module.pathname] = analysed_module.name
+        end
+        names
+      end
     end
 
   end

data/lib/rubycritic/report_generators/templates/code_file.html.erb

@@ -1,10 +1,10 @@
 <div class="file-header group">
-  <span class="rating-<%= @analysed_file.rating.to_s.downcase %> circled-text circle "><%= @analysed_file.rating %></span>
-  <h2 class="file-name"><%= @analysed_file.name %></h2>
+  <span class="rating-<%= @analysed_module.rating.to_s.downcase %> circled-text circle "><%= @analysed_module.rating %></span>
+  <h2 class="file-name"><%= @analysed_module.name %></h2>
 
   <span class="file-committed-at">
-    <% if @analysed_file.committed_at %>
-      Updated <%= timeago_tag(@analysed_file.committed_at) %>
+    <% if @analysed_module.committed_at %>
+      Updated <%= timeago_tag(@analysed_module.committed_at) %>
     <% else %>
       Never committed
     <% end %>
@@ -12,23 +12,23 @@
 
   <div class="file-stats group">
     <div class="file-stat">
-      <%= @analysed_file.complexity %> complexity
+      <%= @analysed_module.complexity %> complexity
     </div>
     <div class="file-stat">
-      <%= @analysed_file.complexity_per_method %> complexity per method
+      <%= @analysed_module.complexity_per_method %> complexity per method
     </div>
     <div class="file-stat">
-      <%= @analysed_file.churn %> churn
+      <%= @analysed_module.churn %> churn
     </div>
     <div class="file-stat">
-      <%= @analysed_file.methods_count %> methods
+      <%= @analysed_module.methods_count %> methods
     </div>
     <div class="file-stat">
-      <%= @analysed_file.duplication %> duplication
+      <%= @analysed_module.duplication %> duplication
     </div>
   </div>
 
-  <% if @analysed_file.has_smells? %>
+  <% if @analysed_module.has_smells? %>
     <button id="js-toggle-smells" class="smells-toggle-button button">Toggle Smells</button>
   <% end %>
 </div>

data/lib/rubycritic/report_generators/templates/code_index.html.erb

@@ -10,16 +10,16 @@
   </tr>
 </thead>
 <tbody>
-  <% @analysed_files.each do |analysed_file| %>
+  <% @analysed_modules.each do |analysed_module| %>
     <tr>
       <td class="first-cell">
-        <a href="<%= file_path(analysed_file.pathname.sub_ext('.html')) %>"><%= analysed_file.name %></a>
+        <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>"><%= analysed_module.name %></a>
       </td>
-      <td class="numeric-cell"><%= analysed_file.churn %></td>
-      <td class="numeric-cell"><%= analysed_file.complexity %></td>
-      <td class="numeric-cell"><%= analysed_file.duplication %></td>
-      <td class="numeric-cell"><%= analysed_file.smells.length %></td>
-      <td class="centered-cell last-cell"><span class="rating-<%= analysed_file.rating.to_s.downcase %> circled-text circle"><%= analysed_file.rating %></span></td>
+      <td class="numeric-cell"><%= analysed_module.churn %></td>
+      <td class="numeric-cell"><%= analysed_module.complexity %></td>
+      <td class="numeric-cell"><%= analysed_module.duplication %></td>
+      <td class="numeric-cell"><%= analysed_module.smells.length %></td>
+      <td class="centered-cell last-cell"><span class="rating-<%= analysed_module.rating.to_s.downcase %> circled-text circle"><%= analysed_module.rating %></span></td>
     </tr>
   <% end %>
 </tbody>

data/lib/rubycritic/report_generators/templates/smells_index.html.erb

@@ -12,7 +12,7 @@
       <td class="first-cell"><%= smell.type %></td>
       <td>
         <% smell.locations.each do |location| %>
-          <a href="<%= smell_location_path(location) %>"><%= location.file_name %></a>
+          <a href="<%= smell_location_path(location) %>"><%= @analysed_module_names[location.pathname] %></a>
         <% end %>
       </td>
       <td class="centered-cell last-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>

data/lib/rubycritic/report_generators/turbulence.rb

@@ -3,12 +3,12 @@ require "json"
 module Rubycritic
 
   module Turbulence
-    def self.data(analysed_files)
-      analysed_files.map do |analysed_file|
+    def self.data(analysed_modules)
+      analysed_modules.map do |analysed_module|
         {
-          :name => analysed_file.pathname,
-          :x => analysed_file.churn,
-          :y => analysed_file.complexity
+          :name => analysed_module.name,
+          :x => analysed_module.churn,
+          :y => analysed_module.complexity
         }
       end.to_json
     end

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -6,15 +6,15 @@ module Rubycritic
     end
 
     def javascript_tag(file)
-      "<script src='" + asset_path("javascripts", "#{file}.js").to_s + "'></script>"
+      "<script src='" + asset_path("javascripts/#{file}.js").to_s + "'></script>"
     end
 
     def stylesheet_path(file)
-      asset_path("stylesheets", "#{file}.css")
+      asset_path("stylesheets/#{file}.css")
     end
 
-    def asset_path(*fragments)
-      relative_path(([root_directory, "assets"] + fragments).reduce(:+))
+    def asset_path(file)
+      relative_path(root_directory + "assets" + file)
     end
 
     def file_path(file)

data/lib/rubycritic/reporters/main.rb

@@ -8,9 +8,8 @@ module Rubycritic
   module Reporter
 
     class Main < Base
-      def initialize(analysed_files)
-        @analysed_files = analysed_files
-        @smells = analysed_files.flat_map(&:smells).uniq
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
       end
 
       def generate_report
@@ -26,20 +25,20 @@ module Rubycritic
       end
 
       def overview_generator
-        @overview_generator ||= Generator::Overview.new(@analysed_files)
+        @overview_generator ||= Generator::Overview.new(@analysed_modules)
       end
 
       def code_index_generator
-        Generator::CodeIndex.new(@analysed_files)
+        Generator::CodeIndex.new(@analysed_modules)
       end
 
       def smells_index_generator
-        Generator::SmellsIndex.new(@smells)
+        Generator::SmellsIndex.new(@analysed_modules)
       end
 
       def file_generators
-        @analysed_files.map do |analysed_file|
-          Generator::CodeFile.new(analysed_file)
+        @analysed_modules.map do |analysed_module|
+          Generator::CodeFile.new(analysed_module)
         end
       end
 

data/lib/rubycritic/reporters/mini.rb

@@ -5,8 +5,8 @@ module Rubycritic
   module Reporter
 
     class Mini < Base
-      def initialize(analysed_files)
-        @analysed_file = analysed_files.first
+      def initialize(analysed_modules)
+        @analysed_module = analysed_modules.first
       end
 
       def generate_report
@@ -18,7 +18,7 @@ module Rubycritic
       private
 
       def file_generator
-        @file_generator ||= Generator::CurrentCodeFile.new(@analysed_file)
+        @file_generator ||= Generator::CurrentCodeFile.new(@analysed_module)
       end
 
       def report_location

data/lib/rubycritic/revision_comparator.rb

@@ -1,38 +1,39 @@
 require "rubycritic/serializer"
-require "rubycritic/files_initializer"
+require "rubycritic/modules_initializer"
 require "rubycritic/analysers_runner"
 require "rubycritic/smells_status_setter"
+require "rubycritic/version"
 
 module Rubycritic
 
   class RevisionComparator
     SNAPSHOTS_DIR_NAME = "snapshots"
 
-    def initialize(analysed_files, source_control_system)
-      @analysed_files_now = analysed_files
+    def initialize(analysed_modules, source_control_system)
+      @analysed_modules_now = analysed_modules
       @source_control_system = source_control_system
     end
 
     def set_statuses
       SmellsStatusSetter.set(
-        analysed_files_before.flat_map(&:smells),
-        @analysed_files_now.flat_map(&:smells)
+        analysed_modules_before.flat_map(&:smells),
+        @analysed_modules_now.flat_map(&:smells)
       )
     end
 
     private
 
-    def analysed_files_before
+    def analysed_modules_before
       serializer = Serializer.new(revision_file)
       if File.file?(revision_file)
         serializer.load
       else
-        analysed_files = FilesInitializer.init(["."])
+        analysed_modules = ModulesInitializer.init(["."])
         @source_control_system.travel_to_head do
-          AnalysersRunner.new(analysed_files, @source_control_system).run
+          AnalysersRunner.new(analysed_modules, @source_control_system).run
         end
-        serializer.dump(analysed_files)
-        analysed_files
+        serializer.dump(analysed_modules)
+        analysed_modules
       end
     end
 
@@ -40,6 +41,7 @@ module Rubycritic
       @revision_file ||= File.join(
         ::Rubycritic.configuration.root,
         SNAPSHOTS_DIR_NAME,
+        VERSION,
         @source_control_system.head_reference
       )
     end

data/lib/rubycritic/source_locator.rb

@@ -27,7 +27,7 @@ module Rubycritic
         elsif File.exists?(path) && File.extname(path) == RUBY_EXTENSION
           Pathname.new(path)
         end
-      end.flatten.compact.map(&:cleanpath).sort
+      end.flatten.compact.map(&:cleanpath)
     end
   end
 

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "1.0.2"
+  VERSION = "1.1.0"
 end

data/rubycritic.gemspec

@@ -8,10 +8,9 @@ Gem::Specification.new do |spec|
   spec.version       = Rubycritic::VERSION
   spec.authors       = ["Guilherme Simoes"]
   spec.email         = ["guilherme.rdems@gmail.com"]
-  spec.description   = <<-EOF
-    Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
-  EOF
-  spec.summary       = "Ruby code smell detector"
+  spec.description   = "RubyCritic is a tool that wraps around various static analysis gems "\
+    "to provide a quality report of your Ruby code."
+  spec.summary       = "RubyCritic is a Ruby code quality reporter"
   spec.homepage      = "https://github.com/whitesmith/rubycritic"
   spec.license       = "MIT"
   spec.required_ruby_version = ">= 1.9.3"

data/test/analysers_test_helper.rb

@@ -1,3 +1,3 @@
 require "test_helper"
 
-class AnalysedFileDouble < OpenStruct; end
+class AnalysedModuleDouble < OpenStruct; end

data/test/lib/rubycritic/analysers/churn_test.rb

@@ -4,21 +4,21 @@ require "rubycritic/source_control_systems/base"
 
 describe Rubycritic::Analyser::Churn do
   before do
-    @analysed_files = [AnalysedFileDouble.new(:path => "path_to_some_file.rb")]
+    @analysed_modules = [AnalysedModuleDouble.new(:path => "path_to_some_file.rb")]
     @source_control_system = SourceControlSystemDouble.new
   end
 
-  it "calculates the churn of each file and adds it to analysed_files" do
-    Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).run
-    @analysed_files.each do |analysed_file|
-      analysed_file.churn.must_equal 1
+  it "calculates the churn of each file and adds it to analysed_modules" do
+    Rubycritic::Analyser::Churn.new(@analysed_modules, @source_control_system).run
+    @analysed_modules.each do |analysed_module|
+      analysed_module.churn.must_equal 1
     end
   end
 
-  it "calculates the date of the last commit of each file and adds it to analysed_files" do
-    Rubycritic::Analyser::Churn.new(@analysed_files, @source_control_system).run
-    @analysed_files.each do |analysed_file|
-      analysed_file.committed_at.must_equal "2013-10-09 12:52:49 +0100"
+  it "calculates the date of the last commit of each file and adds it to analysed_modules" do
+    Rubycritic::Analyser::Churn.new(@analysed_modules, @source_control_system).run
+    @analysed_modules.each do |analysed_module|
+      analysed_module.committed_at.must_equal "2013-10-09 12:52:49 +0100"
     end
   end
 end

data/test/lib/rubycritic/analysers/complexity_test.rb

@@ -2,11 +2,11 @@ require "analysers_test_helper"
 require "rubycritic/analysers/complexity"
 
 describe Rubycritic::Analyser::Complexity do
-  it "calculates the complexity of each file and adds it to analysed_files" do
-    analysed_files = [AnalysedFileDouble.new(:path => "test/samples/flog/complex.rb")]
-    Rubycritic::Analyser::Complexity.new(analysed_files).run
-    analysed_files.each do |analysed_file|
-      analysed_file.complexity.must_be_kind_of Numeric
+  it "calculates the complexity of each file and adds it to analysed_modules" do
+    analysed_modules = [AnalysedModuleDouble.new(:path => "test/samples/flog/complex.rb")]
+    Rubycritic::Analyser::Complexity.new(analysed_modules).run
+    analysed_modules.each do |analysed_module|
+      analysed_module.complexity.must_be_kind_of Numeric
     end
   end
 end

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

@@ -0,0 +1,29 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/helpers/methods_counter"
+
+describe Rubycritic::MethodsCounter do
+  describe "#count" do
+    context "when a file contains Ruby code" do
+      it "calculates the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/methods_count.rb")
+        Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 2
+      end
+    end
+
+    context "when a file is empty" do
+      it "returns 0 as the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/empty.rb")
+        Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
+      end
+    end
+
+    context "when a file is unparsable" do
+      it "does not blow up and returns 0 as the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/unparsable.rb")
+        capture_output_streams do
+          Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
+        end
+      end
+    end
+  end
+end