RubyGems - rubycritic - Versions diffs - 0.0.10 → 0.0.11 - Mend

rubycritic 0.0.10 → 0.0.11

Files changed (33) hide show

data/lib/rubycritic/report_generators/assets/stylesheets/application.css CHANGED Viewed

@@ -34,6 +34,11 @@ html {
   text-decoration: none;
 }
+.chart-container {
+  max-width: 1000px;
+  margin: 0 auto;
+}
 .code-table,
 .smells-table {
   width: 100%;

data/lib/rubycritic/report_generators/overview_generator.rb ADDED Viewed

@@ -0,0 +1,24 @@
+require "erb"
+require "rubycritic/report_generators/base_generator"
+require "json"
+module Rubycritic
+  class OverviewGenerator < BaseGenerator
+    TEMPLATE = erb_template("overview.html.erb")
+    def initialize(turbulence_data)
+      @turbulence_data = turbulence_data.to_json
+    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

data/lib/rubycritic/report_generators/reporter.rb CHANGED Viewed

@@ -1,5 +1,6 @@
 require "rubycritic/report_generators/base_generator"
 require "rubycritic/report_generators/file_generator"
+require "rubycritic/report_generators/overview_generator"
 require "rubycritic/report_generators/code_index_generator"
 require "rubycritic/report_generators/smells_index_generator"
 require "fileutils"
@@ -9,9 +10,10 @@ module Rubycritic
   class Reporter
     ASSETS_DIR = File.expand_path("../assets", __FILE__)
-    def initialize(source_pathnames, smells)
+    def initialize(source_pathnames, smells, turbulence_data)
       @source_pathnames = source_pathnames
       @smells = smells
+      @turbulence_data = turbulence_data
       @smelly_pathnames = pathnames_to_files_with_smells
     end
@@ -23,13 +25,17 @@ module Rubycritic
         end
       end
       FileUtils.cp_r(ASSETS_DIR, ::Rubycritic.configuration.root)
-      code_index_generator.file_href
+      overview_generator.file_href
     end
     private
     def generators
-      [code_index_generator, smells_index_generator] + file_generators
+      [overview_generator, code_index_generator, smells_index_generator] + file_generators
+    end
+    def overview_generator
+      @overview_generator ||= OverviewGenerator.new(@turbulence_data)
     end
     def code_index_generator
@@ -50,8 +56,8 @@ module Rubycritic
     def pathnames_to_files_with_smells
       pathnames = Hash.new { |hash, key| hash[key] = [] }
       @smells.each do |smell|
-        smell.pathnames.each do |path|
-          pathnames[path] << smell
+        smell.pathnames.each do |pathname|
+          pathnames[pathname] << smell
         end
       end
       pathnames

data/lib/rubycritic/report_generators/templates/layouts/application.html.erb CHANGED Viewed

@@ -3,21 +3,23 @@
   <head>
     <meta charset="utf-8">
     <meta http-equiv="X-UA-Compatible" content="IE=edge">
-    <title>Ruby Critic</title>
+    <title>RubyCritic</title>
     <link href="<%= stylesheet_path(:application) %>" media="screen, projection, print" rel="stylesheet" type="text/css">
     <link href="<%= stylesheet_path(:'prettify.custom_theme') %>" media="screen, projection, print" rel="stylesheet" type="text/css">
     <meta name="viewport" content="width=device-width, initial-scale=1">
   </head>
   <body>
     <header class="project-header group">
-      <h1 class="logo"><a href="<%= code_index_path %>" class="logo-link">Ruby Critic</a></h1>
+      <h1 class="logo"><a href="<%= overview_path %>" class="logo-link">RubyCritic</a></h1>
       <nav class="project-nav">
+        <a href="<%= overview_path %>" class="project-nav-item">Overview</a>
         <a href="<%= code_index_path %>" class="project-nav-item">Code</a>
         <a href="<%= smells_index_path %>" class="project-nav-item">Smells</a>
       </nav>
     </header>
     <%= yield %>
     <script src="<%= javascript_path(:'jquery-2.1.0') %>"></script>
+    <script src="<%= javascript_path(:'highcharts.src') %>"></script>
     <script src="<%= javascript_path(:prettify) %>"></script>
     <script src="<%= javascript_path(:application) %>"></script>
   </body>

data/lib/rubycritic/report_generators/templates/overview.html.erb ADDED Viewed

@@ -0,0 +1,5 @@
+<div id="js-chart-container" class="chart-container"></div>
+<script type="text/javascript">
+  var turbulence_data = <%= @turbulence_data %>;
+</script>

data/lib/rubycritic/report_generators/view_helpers.rb CHANGED Viewed

@@ -18,6 +18,10 @@ module Rubycritic
       File.join(root_directory, "#{pathname.sub_ext('.html')}#L#{location.line}")
     end
+    def overview_path
+      File.join(root_directory, "overview.html")
+    end
     def code_index_path
       File.join(root_directory, "code_index.html")
     end

data/lib/rubycritic/revision_comparator.rb CHANGED Viewed

@@ -1,7 +1,6 @@
 require "rubycritic/smells_serializer"
 require "rubycritic/source_locator"
 require "rubycritic/analysers_runner"
-require "rubycritic/smells_aggregator"
 require "rubycritic/smells_status_setter"
 module Rubycritic
@@ -27,8 +26,7 @@ module Rubycritic
       else
         smells = nil
         @source_control_system.travel_to_head do
-          smell_adapters = AnalysersRunner.new(paths_of_tracked_files).run
-          smells = SmellsAggregator.new(smell_adapters).smells
+          smells = AnalysersRunner.new(paths_of_tracked_files).run
         end
         serializer.dump(smells)
         smells

data/lib/rubycritic/smell_adapters/flay.rb CHANGED Viewed

@@ -1,11 +1,12 @@
+require "rubycritic/analysers/flay"
 require "rubycritic/smell"
 module Rubycritic
   module SmellAdapter
     class Flay
-      def initialize(flay)
-        @flay = flay
+      def initialize(paths)
+        @flay = ::Rubycritic::Analyser::Flay.new(paths)
       end
       def smells

data/lib/rubycritic/smell_adapters/flog.rb CHANGED Viewed

@@ -1,3 +1,4 @@
+require "rubycritic/analysers/flog"
 require "rubycritic/smell"
 module Rubycritic
@@ -7,8 +8,9 @@ module Rubycritic
       HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
       VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
-      def initialize(flog)
-        @flog = flog
+      def initialize(paths)
+        @flog = ::Rubycritic::Analyser::Flog.new
+        @flog.flog(*paths)
       end
       def smells

data/lib/rubycritic/smell_adapters/reek.rb CHANGED Viewed

@@ -1,11 +1,12 @@
+require "rubycritic/analysers/reek"
 require "rubycritic/smell"
 module Rubycritic
   module SmellAdapter
     class Reek
-      def initialize(reek)
-        @reek = reek
+      def initialize(paths)
+        @reek = ::Rubycritic::Analyser::Reek.new(paths)
       end
       def smells

data/lib/rubycritic/source_control_systems/git.rb CHANGED Viewed

@@ -26,6 +26,10 @@ module Rubycritic
       travel_to_original_state if stash_successful
     end
+    def revisions_count(file)
+      `git log --follow --format=oneline #{file}`.count("\n")
+    end
     private
     def stash_changes

data/lib/rubycritic/source_control_systems/source_control_system.rb CHANGED Viewed

@@ -39,6 +39,10 @@ module Rubycritic
     def travel_to_head
       raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
     end
+    def revisions_count(file)
+      raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+    end
   end
 end

data/lib/rubycritic/turbulence.rb ADDED Viewed

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

data/lib/rubycritic/version.rb CHANGED Viewed

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.10"
+  VERSION = "0.0.11"
 end

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

@@ -0,0 +1,23 @@
+require "test_helper"
+require "rubycritic/analysers/churn"
+require "rubycritic/source_control_systems/source_control_system"
+describe Rubycritic::Analyser::Churn do
+  before do
+    sample_paths = ["path_to_some_file.rb"]
+    source_control_system = SourceControlSystemDouble.new
+    @churn = Rubycritic::Analyser::Churn.new(sample_paths, source_control_system)
+  end
+  describe "#churn" do
+    it "returns an array containing the number of times each file has changed" do
+      @churn.churn.must_equal [1]
+    end
+  end
+end
+class SourceControlSystemDouble < Rubycritic::SourceControlSystem
+  def revisions_count(file)
+    1 # churn
+  end
+end

data/test/lib/rubycritic/analysers_runner_test.rb CHANGED Viewed

@@ -3,9 +3,9 @@ require "rubycritic/analysers_runner"
 describe Rubycritic::AnalysersRunner do
   describe "#run" do
-    it "returns an array containing smell adapters" do
-      smell_adapters = Rubycritic::AnalysersRunner.new("test/samples/analysers_runner/empty.rb").run
-      smell_adapters.each { |adapter| adapter.must_respond_to(:smells) }
+    it "returns the smells found by various analysers" do
+      smells = Rubycritic::AnalysersRunner.new("test/samples/analysers_runner/empty.rb").run
+      smells.must_be_instance_of Array
     end
   end
 end

data/test/lib/rubycritic/quality_adapters/flog_test.rb ADDED Viewed

@@ -0,0 +1,18 @@
+require "test_helper"
+require "rubycritic/analysers/flog"
+require "rubycritic/quality_adapters/flog"
+describe Rubycritic::QualityAdapter::Flog do
+  before do
+    sample_paths = ["test/samples/flog/smelly.rb", "test/samples/flog/smelly2.rb"]
+    @adapter = Rubycritic::QualityAdapter::Flog.new(sample_paths)
+  end
+  describe "#complexity" do
+    it "return an array containing the complexity of each file" do
+      @adapter.complexity.each do |file_complexity|
+        file_complexity.must_be_kind_of Numeric
+      end
+    end
+  end
+end

data/test/lib/rubycritic/{metric_adapters/flay_adapter_test.rb → smell_adapters/flay_test.rb} RENAMED Viewed

@@ -1,12 +1,10 @@
 require "test_helper"
-require "rubycritic/analysers/flay"
 require "rubycritic/smell_adapters/flay"
 describe Rubycritic::SmellAdapter::Flay do
   before do
-    sample_path = "test/samples/flay/smelly.rb"
-    flay = Rubycritic::Analyser::Flay.new([sample_path])
-    @adapter = Rubycritic::SmellAdapter::Flay.new(flay)
+    sample_paths = ["test/samples/flay/smelly.rb"]
+    @adapter = Rubycritic::SmellAdapter::Flay.new(sample_paths)
   end
   it "detects smells" do

data/test/lib/rubycritic/{metric_adapters/flog_adapter_test.rb → smell_adapters/flog_test.rb} RENAMED Viewed

@@ -1,12 +1,10 @@
 require "test_helper"
-require "rubycritic/analysers/flog"
 require "rubycritic/smell_adapters/flog"
 describe Rubycritic::SmellAdapter::Flog do
   before do
-    sample_path = "test/samples/flog/smelly.rb"
-    flog = Rubycritic::Analyser::Flog.new([sample_path])
-    @adapter = Rubycritic::SmellAdapter::Flog.new(flog)
+    sample_paths = ["test/samples/flog/smelly.rb"]
+    @adapter = Rubycritic::SmellAdapter::Flog.new(sample_paths)
   end
   it "detects smells" do
@@ -15,7 +13,7 @@ describe Rubycritic::SmellAdapter::Flog do
   it "has smells with messages" do
     smell = @adapter.smells.first
-    smell.message.must_be_kind_of String
+    smell.message.must_be_instance_of String
   end
   it "has smells with scores" do

data/test/lib/rubycritic/{metric_adapters/reek_adapter_test.rb → smell_adapters/reek_test.rb} RENAMED Viewed

@@ -1,13 +1,11 @@
 require "test_helper"
-require "rubycritic/analysers/reek"
 require "rubycritic/smell_adapters/reek"
 describe Rubycritic::SmellAdapter::Reek do
   context "when analysing a smelly file" do
     before do
-      sample_path = "test/samples/reek/smelly.rb"
-      reek = Rubycritic::Analyser::Reek.new([sample_path])
-      @adapter = Rubycritic::SmellAdapter::Reek.new(reek)
+      sample_paths = ["test/samples/reek/smelly.rb"]
+      @adapter = Rubycritic::SmellAdapter::Reek.new(sample_paths)
     end
     it "detects smells" do
@@ -22,9 +20,8 @@ describe Rubycritic::SmellAdapter::Reek do
   context "when analysing a file with smells ignored in config.reek" do
     before do
-      sample_path = "test/samples/reek/not_smelly.rb"
-      reek = Rubycritic::Analyser::Reek.new([sample_path])
-      @adapter = Rubycritic::SmellAdapter::Reek.new(reek)
+      sample_paths = ["test/samples/reek/not_smelly.rb"]
+      @adapter = Rubycritic::SmellAdapter::Reek.new(sample_paths)
     end
     it "does not detect smells" do

data/test/lib/rubycritic/turbulence_test.rb ADDED Viewed

@@ -0,0 +1,27 @@
+require "test_helper"
+require "rubycritic/turbulence"
+require "rubycritic/source_control_systems/source_control_system"
+describe Rubycritic::Turbulence do
+  before do
+    @sample_path = "test/samples/flog/smelly.rb"
+    @sample_paths = [@sample_path]
+    @source_control_system = SourceControlSystemDouble.new
+  end
+  describe "#data" do
+    it "returns an array of hashes containing the path, churn and complexity of each file" do
+      data = Rubycritic::Turbulence.new(@sample_paths, @source_control_system).data
+      data_instance = data.first
+      data_instance[:name].must_equal @sample_path
+      data_instance[:x].must_equal 1 # churn
+      data_instance[:y].must_be_kind_of Numeric # complexity
+    end
+  end
+end
+class SourceControlSystemDouble < Rubycritic::SourceControlSystem
+  def revisions_count(file)
+    1 # churn
+  end
+end

data/test/samples/flog/smelly2.rb ADDED Viewed

@@ -0,0 +1,11 @@
+class AllTheMethods
+  def method_missing(method, *args, &block)
+    message = "I"
+    eval "message = ' did not'"
+    eval "message << ' exist,'"
+    eval "message << ' but now'"
+    eval "message << ' I do.'"
+    self.class.send(:define_method, method) { "I did not exist, but now I do." }
+    self.send(method)
+  end
+end

metadata CHANGED Viewed

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2014-05-07 00:00:00.000000000 Z
+date: 2014-05-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -141,6 +141,7 @@ files:
 - bin/rubycritic
 - lib/rubycritic.rb
 - lib/rubycritic/active_support/methods.rb
+- lib/rubycritic/analysers/churn.rb
 - lib/rubycritic/analysers/config.reek
 - lib/rubycritic/analysers/flay.rb
 - lib/rubycritic/analysers/flog.rb
@@ -149,7 +150,9 @@ files:
 - lib/rubycritic/cli.rb
 - lib/rubycritic/configuration.rb
 - lib/rubycritic/location.rb
+- lib/rubycritic/quality_adapters/flog.rb
 - lib/rubycritic/report_generators/assets/javascripts/application.js
+- lib/rubycritic/report_generators/assets/javascripts/highcharts.src.js
 - lib/rubycritic/report_generators/assets/javascripts/jquery-2.1.0.js
 - lib/rubycritic/report_generators/assets/javascripts/prettify.js
 - lib/rubycritic/report_generators/assets/stylesheets/application.css
@@ -158,12 +161,14 @@ files:
 - lib/rubycritic/report_generators/code_index_generator.rb
 - lib/rubycritic/report_generators/file_generator.rb
 - lib/rubycritic/report_generators/line_generator.rb
+- lib/rubycritic/report_generators/overview_generator.rb
 - lib/rubycritic/report_generators/reporter.rb
 - lib/rubycritic/report_generators/smells_index_generator.rb
 - lib/rubycritic/report_generators/templates/code_index.html.erb
 - lib/rubycritic/report_generators/templates/file.html.erb
 - lib/rubycritic/report_generators/templates/layouts/application.html.erb
 - lib/rubycritic/report_generators/templates/line.html.erb
+- lib/rubycritic/report_generators/templates/overview.html.erb
 - lib/rubycritic/report_generators/templates/smells_index.html.erb
 - lib/rubycritic/report_generators/templates/smelly_line.html.erb
 - lib/rubycritic/report_generators/view_helpers.rb
@@ -172,30 +177,33 @@ files:
 - lib/rubycritic/smell_adapters/flay.rb
 - lib/rubycritic/smell_adapters/flog.rb
 - lib/rubycritic/smell_adapters/reek.rb
-- lib/rubycritic/smells_aggregator.rb
 - lib/rubycritic/smells_serializer.rb
 - lib/rubycritic/smells_status_setter.rb
 - lib/rubycritic/source_control_systems/git.rb
 - lib/rubycritic/source_control_systems/source_control_system.rb
 - lib/rubycritic/source_locator.rb
+- lib/rubycritic/turbulence.rb
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
+- test/lib/rubycritic/analysers/churn_test.rb
 - test/lib/rubycritic/analysers_runner_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/location_test.rb
-- test/lib/rubycritic/metric_adapters/flay_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
+- test/lib/rubycritic/quality_adapters/flog_test.rb
+- test/lib/rubycritic/smell_adapters/flay_test.rb
+- test/lib/rubycritic/smell_adapters/flog_test.rb
+- test/lib/rubycritic/smell_adapters/reek_test.rb
 - test/lib/rubycritic/smell_test.rb
-- test/lib/rubycritic/smells_aggregator_test.rb
 - test/lib/rubycritic/smells_array_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
+- test/lib/rubycritic/turbulence_test.rb
 - test/lib/rubycritic/version_test.rb
 - test/samples/analysers_runner/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
+- test/samples/flog/smelly2.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
 - test/samples/location/file_with_different_extension.py
@@ -228,22 +236,25 @@ signing_key:
 specification_version: 4
 summary: Ruby code smell detector
 test_files:
+- test/lib/rubycritic/analysers/churn_test.rb
 - test/lib/rubycritic/analysers_runner_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/location_test.rb
-- test/lib/rubycritic/metric_adapters/flay_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
+- test/lib/rubycritic/quality_adapters/flog_test.rb
+- test/lib/rubycritic/smell_adapters/flay_test.rb
+- test/lib/rubycritic/smell_adapters/flog_test.rb
+- test/lib/rubycritic/smell_adapters/reek_test.rb
 - test/lib/rubycritic/smell_test.rb
-- test/lib/rubycritic/smells_aggregator_test.rb
 - test/lib/rubycritic/smells_array_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
+- test/lib/rubycritic/turbulence_test.rb
 - test/lib/rubycritic/version_test.rb
 - test/samples/analysers_runner/empty.rb
 - test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
+- test/samples/flog/smelly2.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
 - test/samples/location/file_with_different_extension.py