rubycritic 0.0.12 → 0.0.13

data/lib/rubycritic/report_generators/overview.rb

@@ -0,0 +1,26 @@
+require "erb"
+require "rubycritic/report_generators/base"
+require "rubycritic/turbulence"
+
+module Rubycritic
+  module Generator
+
+    class Overview < Base
+      TEMPLATE = erb_template("overview.html.erb")
+
+      def initialize(analysed_files)
+        @turbulence_data = Turbulence.new(analysed_files).data
+      end
+
+      def file_name
+        "overview.html"
+      end
+
+      def render
+        index_body = TEMPLATE.result(get_binding)
+        LAYOUT_TEMPLATE.result(get_binding { index_body })
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/smells_index.rb

@@ -0,0 +1,25 @@
+require "erb"
+require "rubycritic/report_generators/base"
+
+module Rubycritic
+  module Generator
+
+    class SmellsIndex < Base
+      TEMPLATE = erb_template("smells_index.html.erb")
+
+      def initialize(smells)
+        @smells = smells
+      end
+
+      def file_name
+        "smells_index.html"
+      end
+
+      def render
+        index_body = TEMPLATE.result(get_binding)
+        LAYOUT_TEMPLATE.result(get_binding { index_body })
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/templates/{file.html.erb → code_file.html.erb}

@@ -1,7 +1,7 @@
 <div class="file-header">
-  <h2 class="file-name"><%= analysed_file_name(@pathname) %></h2>
+  <h2 class="file-name"><%= @analysed_file.name %></h2>
 
-  <% if file_has_smells? %>
+  <% if @analysed_file.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

@@ -6,12 +6,12 @@
   </tr>
 </thead>
 <tbody>
-  <% @source_pathnames.each do |pathname| %>
+  <% @analysed_files.each do |analysed_file| %>
     <tr>
       <td class="first-cell">
-        <a href="<%= file_path(pathname) %>"><%= analysed_file_name(pathname) %></a>
+        <a href="<%= file_path(analysed_file.pathname) %>"><%= analysed_file.name %></a>
       </td>
-      <td><%= smells_count(pathname) %></td>
+      <td><%= analysed_file.smells.length %></td>
     </tr>
   <% end %>
 </tbody>

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

@@ -1,4 +1,4 @@
-<table class="analysis-index-table">
+<table id="js-code-table" class="analysis-index-table sortable-table">
 <thead>
   <tr>
     <th class="first-cell">Smell</th>

data/lib/rubycritic/report_generators/view_helpers.rb

@@ -33,10 +33,6 @@ module Rubycritic
     def root_directory
       ::Rubycritic.configuration.root
     end
-
-    def analysed_file_name(pathname)
-      pathname.basename.sub_ext("")
-    end
   end
 
 end

data/lib/rubycritic/reporters/main.rb

@@ -0,0 +1,55 @@
+require "rubycritic/report_generators/overview"
+require "rubycritic/report_generators/smells_index"
+require "rubycritic/report_generators/code_index"
+require "rubycritic/report_generators/code_file"
+require "fileutils"
+
+module Rubycritic
+  module Reporter
+
+    class Main
+      ASSETS_DIR = File.expand_path("../../report_generators/assets", __FILE__)
+
+      def initialize(analysed_files, smells)
+        @analysed_files = analysed_files
+        @smells = smells
+      end
+
+      def generate_report
+        generators.each do |generator|
+          FileUtils.mkdir_p(generator.file_directory)
+          File.open(generator.file_pathname, "w+") do |file|
+            file.write(generator.render)
+          end
+        end
+        FileUtils.cp_r(ASSETS_DIR, ::Rubycritic.configuration.root)
+        overview_generator.file_href
+      end
+
+      private
+
+      def generators
+        [overview_generator, code_index_generator, smells_index_generator] + file_generators
+      end
+
+      def overview_generator
+        @overview_generator ||= Generator::Overview.new(@analysed_files)
+      end
+
+      def code_index_generator
+        Generator::CodeIndex.new(@analysed_files)
+      end
+
+      def smells_index_generator
+        Generator::SmellsIndex.new(@smells)
+      end
+
+      def file_generators
+        @analysed_files.map do |analysed_file|
+          Generator::CodeFile.new(analysed_file)
+        end
+      end
+    end
+
+  end
+end

data/lib/rubycritic/reporters/mini.rb

@@ -0,0 +1,26 @@
+require "rubycritic/report_generators/code_file"
+require "fileutils"
+
+module Rubycritic
+  module Reporter
+
+    class Mini
+      ASSETS_DIR = File.expand_path("../../report_generators/assets", __FILE__)
+
+      def initialize(analysed_file)
+        @analysed_file = analysed_file
+      end
+
+      def generate_report
+        file_generator = Generator::CodeFile.new(@analysed_file)
+        FileUtils.mkdir_p(file_generator.file_directory)
+        File.open(file_generator.file_pathname, "w+") do |file|
+          file.write(file_generator.render)
+        end
+        FileUtils.cp_r(ASSETS_DIR, ::Rubycritic.configuration.root)
+        file_generator.file_href
+      end
+    end
+
+  end
+end

data/lib/rubycritic/revision_comparator.rb

@@ -26,7 +26,7 @@ module Rubycritic
       else
         smells = nil
         @source_control_system.travel_to_head do
-          smells = AnalysersRunner.new(paths_of_tracked_files).run
+          smells = AnalysersRunner.new(paths_of_tracked_files).smells
         end
         serializer.dump(smells)
         smells

data/lib/rubycritic/source_locator.rb

@@ -10,14 +10,14 @@ module Rubycritic
       @initial_paths = paths
     end
 
-    def pathnames
-      @pathnames ||= expand_paths
-    end
-
     def paths
       @paths ||= pathnames.map(&:to_s)
     end
 
+    def pathnames
+      @pathnames ||= expand_paths
+    end
+
     private
 
     def expand_paths

data/lib/rubycritic/turbulence.rb

@@ -1,30 +1,20 @@
-require "rubycritic/analysers/churn"
-require "rubycritic/adapters/complexity/flog"
+require "json"
 
 module Rubycritic
 
   class Turbulence
-    def initialize(paths, source_control_system)
-      @paths = paths
-      @source_control_system = source_control_system
+    def initialize(analysed_files)
+      @analysed_files = analysed_files
     end
 
     def data
-      @paths.zip(churn, complexity).map do |path_info|
+      @analysed_files.map do |analysed_file|
         {
-          :name => path_info[0],
-          :x => path_info[1],
-          :y => path_info[2]
+          :name => analysed_file.pathname,
+          :x => analysed_file.churn,
+          :y => analysed_file.complexity
         }
-      end
-    end
-
-    def churn
-      @churn ||= Analyser::Churn.new(@paths, @source_control_system).churn
-    end
-
-    def complexity
-      @complexity ||= QualityAdapter::Flog.new(@paths).complexity
+      end.to_json
     end
   end
 

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.12"
+  VERSION = "0.0.13"
 end

data/test/lib/rubycritic/{quality_adapters → adapters/complexity}/flog_test.rb

@@ -2,10 +2,10 @@ require "test_helper"
 require "rubycritic/analysers/flog"
 require "rubycritic/adapters/complexity/flog"
 
-describe Rubycritic::QualityAdapter::Flog do
+describe Rubycritic::ComplexityAdapter::Flog do
   before do
     sample_paths = ["test/samples/flog/smelly.rb", "test/samples/flog/smelly2.rb"]
-    @adapter = Rubycritic::QualityAdapter::Flog.new(sample_paths)
+    @adapter = Rubycritic::ComplexityAdapter::Flog.new(sample_paths)
   end
 
   describe "#complexity" do

data/test/lib/rubycritic/{smell_adapters → adapters/smell}/flay_test.rb

@@ -13,10 +13,10 @@ describe Rubycritic::SmellAdapter::Flay do
 
   it "has smells with messages" do
     smell = @adapter.smells.first
-    smell.message.must_equal "found in 2 nodes"
+    smell.message.must_be_instance_of String
   end
 
-  it "has smells with messages" do
+  it "has smells with scores" do
     smell = @adapter.smells.first
     smell.score.must_be_kind_of Numeric
   end

data/test/lib/rubycritic/analysed_files_builder_test.rb

@@ -0,0 +1,36 @@
+require "test_helper"
+require "rubycritic/analysed_files_builder"
+
+describe Rubycritic::AnalysedFilesBuilder do
+  describe "analysed_files" do
+    before do
+      @pathnames = [Pathname.new("./foo"), Pathname.new("./bar")]
+      @smells = [SmellDouble.new]
+      @churn = [1, 2]
+      @complexity = [3, 4]
+      @builder = Rubycritic::AnalysedFilesBuilder.new(@pathnames, @smells, @churn, @complexity)
+    end
+
+    it "returns an array of AnalysedFiles" do
+      analysed_files = @builder.analysed_files
+      first = analysed_files.first
+      last = analysed_files.last
+
+      first.pathname.must_equal Pathname.new("./foo")
+      first.smells.must_equal @smells
+      first.churn.must_equal @churn.first
+      first.complexity.must_equal @complexity.first
+
+      last.pathname.must_equal Pathname.new("./bar")
+      last.smells.must_equal @smells
+      last.churn.must_equal @churn.last
+      last.complexity.must_equal @complexity.last
+    end
+  end
+end
+
+class SmellDouble
+  def at_pathname?(other_pathname)
+    true
+  end
+end

data/test/lib/rubycritic/analysers_runner_test.rb

@@ -2,9 +2,9 @@ require "test_helper"
 require "rubycritic/analysers_runner"
 
 describe Rubycritic::AnalysersRunner do
-  describe "#run" do
+  describe "#smells" do
     it "returns the smells found by various analysers" do
-      smells = Rubycritic::AnalysersRunner.new("test/samples/analysers_runner/empty.rb").run
+      smells = Rubycritic::AnalysersRunner.new("test/samples/analysers_runner/empty.rb").smells
       smells.must_be_instance_of Array
     end
   end

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

@@ -0,0 +1,51 @@
+require "test_helper"
+require "rubycritic/core/analysed_file"
+
+describe Rubycritic::AnalysedFile do
+  describe "attribute readers" do
+    before do
+      @pathname = Pathname.new("./foo")
+      @smells = []
+      @churn = 1
+      @complexity = 2
+      @smell = Rubycritic::AnalysedFile.new(
+        :pathname   => @pathname,
+        :smells     => @smells,
+        :churn      => @churn,
+        :complexity => @complexity
+      )
+    end
+
+    it "has a pathname reader" do
+      @smell.pathname.must_equal @pathname
+    end
+
+    it "has a smells reader" do
+      @smell.smells.must_equal @smells
+    end
+
+    it "has a churn reader" do
+      @smell.churn.must_equal @churn
+    end
+
+    it "has a complexity reader" do
+      @smell.complexity.must_equal @complexity
+    end
+  end
+
+  describe "#name" do
+    it "returns the name of the file" do
+      analysed_file = Rubycritic::AnalysedFile.new(:pathname => Pathname.new("foo/bar.rb"))
+      analysed_file.name.must_equal "bar"
+    end
+  end
+
+  describe "#has_smells?" do
+    it "returns true if the analysed_file has at least one smell" do
+      analysed_file = Rubycritic::AnalysedFile.new(:smells => [SmellDouble.new])
+      analysed_file.has_smells?.must_equal true
+    end
+  end
+end
+
+class SmellDouble; end

data/test/lib/rubycritic/{location_test.rb → core/location_test.rb}

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/location"
+require "rubycritic/core/location"
 
 describe Rubycritic::Location do
   describe "attribute readers" do

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

@@ -0,0 +1,80 @@
+require "test_helper"
+require "rubycritic/core/smell"
+
+describe Rubycritic::Smell do
+  describe "attribute readers" do
+    before do
+      @locations = [Rubycritic::Location.new("./foo", "42")]
+      @context = "#bar"
+      @message = "This smells"
+      @score = 0
+      @type = :complexity
+      @smell = Rubycritic::Smell.new(
+        :locations => @locations,
+        :context   => @context,
+        :message   => @message,
+        :score     => @score,
+        :type      => @type
+      )
+    end
+
+    it "has a context reader" do
+      @smell.context.must_equal @context
+    end
+
+    it "has a locations reader" do
+      @smell.locations.must_equal @locations
+    end
+
+    it "has a message reader" do
+      @smell.message.must_equal @message
+    end
+
+    it "has a score reader" do
+      @smell.score.must_equal @score
+    end
+
+    it "has a type reader" do
+      @smell.type.must_equal @type
+    end
+  end
+
+  describe "#at_location?" do
+    it "returns true if the smell has a location that matches the location passed as argument" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smell = Rubycritic::Smell.new(:locations => [location])
+      smell.at_location?(location).must_equal true
+    end
+  end
+
+  describe "#at_pathname?" do
+    it "returns true if the smell has a pathname that matches the pathname passed as argument" do
+      path = "./foo"
+      pathname = Pathname.new(path)
+      location = Rubycritic::Location.new(path, "42")
+      smell = Rubycritic::Smell.new(:locations => [location])
+      smell.at_pathname?(pathname).must_equal true
+    end
+  end
+
+  describe "#has_multiple_locations?" do
+    it "returns true if the smell has more than one location" do
+      location1 = Rubycritic::Location.new("./foo", "42")
+      location2 = Rubycritic::Location.new("./foo", "23")
+      smell = Rubycritic::Smell.new(:locations => [location1, location2])
+      smell.has_multiple_locations?.must_equal true
+    end
+  end
+
+  it "is comparable" do
+    attributes = {
+      :context => "#bar",
+      :message => "This smells",
+      :score => 0,
+      :type => :complexity
+    }
+    smell1 = Rubycritic::Smell.new(attributes)
+    smell2 = Rubycritic::Smell.new(attributes)
+    smell1.must_equal smell2
+  end
+end