RubyGems - rubycritic - Versions diffs - 1.3.0 → 1.4.0 - Mend

rubycritic 1.3.0 → 1.4.0

Files changed (65) hide show

data/lib/rubycritic/{report_generators → generators/html}/templates/code_index.html.erb RENAMED Viewed

@@ -1,25 +1,29 @@
 <table id="js-index-table" class="index-table sortable-table">
 <thead>
   <tr>
-    <th class="first-cell">Name</th>
+    <th>Name</th>
     <th class="numeric-cell" title="Number of times a file has changed">Churn</th>
     <th class="numeric-cell" title="Overall amount of code in a file">Complexity</th>
     <th class="numeric-cell" title="Amount of code that is similar to other code">Duplication</th>
     <th class="numeric-cell">Smells</th>
-    <th class="centered-cell last-cell">Rating</th>
+    <% unless Config.suppress_ratings %>
+      <th class="centered-cell">Rating</th>
+    <% end %>
   </tr>
 </thead>
 <tbody>
   <% @analysed_modules.each do |analysed_module| %>
     <tr>
-      <td class="first-cell">
+      <td>
         <a href="<%= file_path(analysed_module.pathname.sub_ext('.html')) %>"><%= analysed_module.name %></a>
       </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>
+      <% unless Config.suppress_ratings %>
+        <td class="centered-cell"><span class="rating-<%= analysed_module.rating.to_s.downcase %> circled-text circle"><%= analysed_module.rating %></span></td>
+      <% end %>
     </tr>
   <% end %>
 </tbody>

data/lib/rubycritic/{report_generators → generators/html}/templates/layouts/application.html.erb RENAMED Viewed

@@ -10,16 +10,20 @@
   </head>
   <body>
     <header class="project-header group">
-      <h1 class="logo"><a href="<%= file_path('overview.html') %>" class="logo-link">RubyCritic</a></h1>
-      <nav class="project-nav">
-        <a href="<%= file_path('overview.html') %>" class="project-nav-item">Overview</a>
-        <a href="<%= file_path('code_index.html') %>" class="project-nav-item">Code</a>
-        <a href="<%= file_path('smells_index.html') %>" class="project-nav-item">Smells</a>
-      </nav>
+      <div class="container">
+        <h1 class="logo"><a href="<%= file_path('overview.html') %>" class="logo-link">RubyCritic</a></h1>
+        <nav class="project-nav">
+          <a href="<%= file_path('overview.html') %>" class="project-nav-item">Overview</a>
+          <a href="<%= file_path('code_index.html') %>" class="project-nav-item">Code</a>
+          <a href="<%= file_path('smells_index.html') %>" class="project-nav-item">Smells</a>
+        </nav>
+      </div>
     </header>
-    <%= yield %>
+    <div class="container">
+      <%= yield %>
+    </div>
     <%= javascript_tag(:'jquery-2.1.0') %>
-    <%= javascript_tag(:'jquery.tablesorter-2.0') %>
+    <%= javascript_tag(:'jquery.tablesorter') %>
     <%= javascript_tag(:'jquery.floatThead-v1.2.7') %>
     <%= javascript_tag(:'jquery.timeago-v1.4.1') %>
     <%= javascript_tag(:'highcharts.src-4.0.1') %>

data/lib/rubycritic/{report_generators → generators/html}/templates/line.html.erb RENAMED Viewed

File without changes

data/lib/rubycritic/{report_generators → generators/html}/templates/overview.html.erb RENAMED Viewed

File without changes

data/lib/rubycritic/{report_generators → generators/html}/templates/smells_index.html.erb RENAMED Viewed

@@ -1,24 +1,24 @@
 <table id="js-index-table" class="smells-index-table index-table sortable-table">
 <thead>
   <tr>
-    <th class="first-cell">Smell</th>
+    <th>Smell</th>
     <th>Locations</th>
     <% if @show_status %>
-      <th class="centered-cell last-cell" title="Code smells introduced recently are marked as new. There's still time before they are committed!">Status</th>
+      <th class="centered-cell" title="Code smells introduced recently are marked as new. There's still time before they are committed!">Status</th>
     <% end %>
   </tr>
 </thead>
 <tbody>
   <% @smells.each do |smell| %>
     <tr>
-      <td class="first-cell"><%= smell.type %></td>
+      <td><%= smell.type %></td>
       <td>
         <% smell.locations.each do |location| %>
           <a href="<%= smell_location_path(location) %>"><%= @analysed_module_names[location.pathname] %></a>
         <% end %>
       </td>
       <% if @show_status %>
-        <td class="centered-cell last-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
+        <td class="centered-cell"><span class="status-<%= smell.status %> circled-text circle"><%= smell.status %></span></td>
       <% end %>
     </tr>
   <% end %>

data/lib/rubycritic/{report_generators → generators/html}/templates/smelly_line.html.erb RENAMED Viewed

File without changes

data/lib/rubycritic/{report_generators → generators/html}/turbulence.rb RENAMED Viewed

File without changes

data/lib/rubycritic/{report_generators → generators/html}/view_helpers.rb RENAMED Viewed

File without changes

data/lib/rubycritic/generators/html_report.rb ADDED Viewed

@@ -0,0 +1,66 @@
+require "fileutils"
+require "rubycritic/generators/html/overview"
+require "rubycritic/generators/html/smells_index"
+require "rubycritic/generators/html/code_index"
+require "rubycritic/generators/html/code_file"
+module Rubycritic
+  module Generator
+    class HtmlReport
+      ASSETS_DIR = File.expand_path("../html/assets", __FILE__)
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+      def generate_report
+        create_directories_and_files
+        copy_assets_to_report_directory
+        puts "New critique at #{report_location}"
+      end
+      private
+      def create_directories_and_files
+        Array(generators).each do |generator|
+          FileUtils.mkdir_p(generator.file_directory)
+          File.open(generator.file_pathname, "w+") do |file|
+            file.write(generator.render)
+          end
+        end
+      end
+      def generators
+        [overview_generator, code_index_generator, smells_index_generator] + file_generators
+      end
+      def overview_generator
+        @overview_generator ||= Html::Overview.new(@analysed_modules)
+      end
+      def code_index_generator
+        Html::CodeIndex.new(@analysed_modules)
+      end
+      def smells_index_generator
+        Html::SmellsIndex.new(@analysed_modules)
+      end
+      def file_generators
+        @analysed_modules.map do |analysed_module|
+          Html::CodeFile.new(analysed_module)
+        end
+      end
+      def copy_assets_to_report_directory
+        FileUtils.cp_r(ASSETS_DIR, Config.root)
+      end
+      def report_location
+        overview_generator.file_href
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require "json"
+module Rubycritic
+  module Generator
+    module Json
+      class Simple
+        def initialize(analysed_modules)
+          @analysed_modules = analysed_modules
+        end
+        def render
+          JSON.dump(data)
+        end
+        def data
+          {
+            :metadata => {
+              :rubycritic => {
+                :version => Rubycritic::VERSION
+              }
+            },
+            :analysed_modules => @analysed_modules
+          }
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/json_report.rb ADDED Viewed

@@ -0,0 +1,23 @@
+require "rubycritic/generators/json/simple"
+module Rubycritic
+  module Generator
+    class JsonReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+      def generate_report
+        print generator.render
+      end
+      private
+      def generator
+        Json::Simple.new(@analysed_modules)
+      end
+    end
+  end
+end

data/lib/rubycritic/reporter.rb ADDED Viewed

@@ -0,0 +1,20 @@
+module Rubycritic
+  module Reporter
+    def self.generate_report(analysed_modules)
+      report_generator_class.new(analysed_modules).generate_report
+    end
+    def self.report_generator_class
+      case Config.format
+      when :json
+        require "rubycritic/generators/json_report"
+        Generator::JsonReport
+      else
+        require "rubycritic/generators/html_report"
+        Generator::HtmlReport
+      end
+    end
+  end
+end

data/lib/rubycritic/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

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

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

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

@@ -2,11 +2,15 @@ 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_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
+  context "when analysing a file" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/complex.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::Complexity.new(analysed_modules).run
+    end
+    it "calculates its complexity" do
+      @analysed_module.complexity.must_be :>, 0
     end
   end
 end

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

@@ -4,29 +4,36 @@ require "rubycritic/core/analysed_module"
 require "pathname"
 describe Rubycritic::Analyser::FlaySmells do
-  before do
-    @analysed_module = Rubycritic::AnalysedModule.new(
-      :pathname => Pathname.new("test/samples/flay/smelly.rb")
-    )
-    analysed_modules = [@analysed_module]
-    Rubycritic::Analyser::FlaySmells.new(analysed_modules).run
-  end
+  context "when analysing a bunch of files with duplicate code" do
+    before do
+      @analysed_modules = [
+        Rubycritic::AnalysedModule.new(:pathname => Pathname.new("test/samples/flay/smelly.rb")),
+        Rubycritic::AnalysedModule.new(:pathname => Pathname.new("test/samples/flay/smelly2.rb"))
+      ]
+      Rubycritic::Analyser::FlaySmells.new(@analysed_modules).run
+    end
-  it "detects smells and adds them to analysed_modules" do
-    @analysed_module.smells.length.must_equal 1
-  end
+    it "detects its smells" do
+      @analysed_modules.first.smells?.must_equal true
+    end
-  it "creates smells with messages" do
-    smell = @analysed_module.smells.first
-    smell.message.must_be_instance_of String
-  end
+    it "creates smells with messages" do
+      smell = @analysed_modules.first.smells.first
+      smell.message.must_be_instance_of String
+    end
-  it "creates smells with scores" do
-    smell = @analysed_module.smells.first
-    smell.score.must_be_kind_of Numeric
-  end
+    it "creates smells with scores" do
+      smell = @analysed_modules.first.smells.first
+      smell.score.must_be_kind_of Numeric
+    end
+    it "creates smells with more than one location" do
+      smell = @analysed_modules.first.smells.first
+      smell.multiple_locations?.must_equal true
+    end
-  it "calculates the mass of duplicate code and adds it to analysed_modules" do
-    @analysed_module.duplication.must_be(:>, 0)
+    it "calculates the mass of duplicate code" do
+      @analysed_modules.first.duplication.must_be(:>, 0)
+    end
   end
 end

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

@@ -2,23 +2,25 @@ require "analysers_test_helper"
 require "rubycritic/analysers/smells/flog"
 describe Rubycritic::Analyser::FlogSmells do
-  before do
-    @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/smelly.rb", :smells => [])
-    analysed_modules = [@analysed_module]
-    Rubycritic::Analyser::FlogSmells.new(analysed_modules).run
-  end
+  context "when analysing a complex file" do
+    before do
+      @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_modules" do
-    @analysed_module.smells.length.must_equal 1
-  end
+    it "detects its smells" do
+      @analysed_module.smells.length.must_equal 1
+    end
-  it "creates smells with messages" do
-    smell = @analysed_module.smells.first
-    smell.message.must_be_instance_of String
-  end
+    it "creates smells with messages" do
+      smell = @analysed_module.smells.first
+      smell.message.must_be_instance_of String
+    end
-  it "creates smells with scores" do
-    smell = @analysed_module.smells.first
-    smell.score.must_be_kind_of Numeric
+    it "creates smells with scores" do
+      smell = @analysed_module.smells.first
+      smell.score.must_be :>, 0
+    end
   end
 end

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

@@ -9,7 +9,7 @@ describe Rubycritic::Analyser::ReekSmells do
       Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
     end
-    it "detects smells and adds them to analysed_modules" do
+    it "detects its smells" do
       @analysed_module.smells.length.must_equal 1
     end
@@ -26,7 +26,7 @@ describe Rubycritic::Analyser::ReekSmells do
       Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
     end
-    it "does not detect smells and does not add them to analysed files" do
+    it "does not detect those smells" do
       @analysed_module.smells.must_be_empty
     end
   end

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

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/report_generators/turbulence"
+require "rubycritic/generators/html/turbulence"
 describe Rubycritic::Turbulence do
   describe "::data" do

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

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/report_generators/view_helpers"
+require "rubycritic/generators/html/view_helpers"
 require "pathname"
 describe Rubycritic::ViewHelpers do