rubycritic 0.0.12 → 0.0.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f4ffd32168812c62fcc6df57e4be70945ec2f596
-  data.tar.gz: a6255f8b72f25cf2c73e9f20a9738543c24cf9f4
+  metadata.gz: b4f79955ca6f3dab8dccacc5dca7c2b994db9cc7
+  data.tar.gz: 51bb696eca3c5caa072c1e20a0fb67c1d18c113f
 SHA512:
-  metadata.gz: 3e0a4d3522db7f8a2565a003928b8cf6dd1a50ec0b8ed4f9680b6ff40723e7d80a4d54d339bae4bd938b35373dae375555c7936ff400913302599aec4aadae2c
-  data.tar.gz: 973ed3d59c5f67032df4f5a35379692f1d9b07abf2f8fe84379df9a40f1b1f574d480150f9c0999aaff7a6b3db430ff0df54a6bb3b5b3b367f958675c990c283
+  metadata.gz: 0794412b39af6196e6d9e70ab55c634744778acf6a9102538ea34a2bbf0aa509fb2f4569437203eb53e0dc770dd73db7095ae2238323e9a10fff1520e30dfb50
+  data.tar.gz: f93087c069037601daa5f19c21d5794d8b176dbcc81b291b8a3f46f5d14a091bce4d75c0dd2d0e9b73cc7d0f4c5aa1568ec93ef7f33a91f2d3839010aeee60f6

data/lib/rubycritic.rb

@@ -3,25 +3,6 @@ require "rubycritic/source_locator"
 require "rubycritic/analysers_runner"
 require "rubycritic/source_control_systems/source_control_system"
 require "rubycritic/revision_comparator"
-require "rubycritic/turbulence"
-require "rubycritic/report_generators/reporter"
-
-module Rubycritic
-
-  class Rubycritic
-    def initialize
-      @source_control_system = SourceControlSystem.create
-    end
-
-    def critique(paths)
-      source = SourceLocator.new(paths)
-      smells = AnalysersRunner.new(source.paths).run
-      if @source_control_system.has_revision?
-        smells = RevisionComparator.new(smells, @source_control_system).smells
-        turbulence_data = Turbulence.new(source.paths, @source_control_system).data
-      end
-      Reporter.new(source.pathnames, smells, turbulence_data).generate_report
-    end
-  end
-
-end
+require "rubycritic/analysers/churn"
+require "rubycritic/adapters/complexity/flog"
+require "rubycritic/analysed_files_builder"

data/lib/rubycritic/adapters/complexity/flog.rb

@@ -1,5 +1,5 @@
 module Rubycritic
-  module QualityAdapter
+  module ComplexityAdapter
 
     class Flog
       def initialize(paths)

data/lib/rubycritic/adapters/smell/flay.rb

@@ -1,5 +1,5 @@
 require "rubycritic/analysers/flay"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 module Rubycritic
   module SmellAdapter

data/lib/rubycritic/adapters/smell/flog.rb

@@ -1,5 +1,5 @@
 require "rubycritic/analysers/flog"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 module Rubycritic
   module SmellAdapter

data/lib/rubycritic/adapters/smell/reek.rb

@@ -1,5 +1,5 @@
 require "rubycritic/analysers/reek"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 module Rubycritic
   module SmellAdapter

data/lib/rubycritic/analysed_files_builder.rb

@@ -0,0 +1,36 @@
+require "rubycritic/core/analysed_file"
+
+module Rubycritic
+
+  class AnalysedFilesBuilder
+    def initialize(pathnames, smells, churn, complexity)
+      @pathnames = pathnames
+      @smells = smells
+      @churn = churn
+      @complexity = complexity
+    end
+
+    def analysed_files
+      @pathnames.zip(@churn, @complexity).map do |file_attributes|
+        pathname = file_attributes[0]
+        AnalysedFile.new(
+          :smells => file_smells(pathname),
+          :pathname => pathname,
+          :churn => file_attributes[1],
+          :complexity => file_attributes[2]
+        )
+      end
+    end
+
+    private
+
+    def file_smells(pathname)
+      file_smells = []
+      @smells.each do |smell|
+        file_smells << smell if smell.at_pathname?(pathname)
+      end
+      file_smells
+    end
+  end
+
+end

data/lib/rubycritic/analysers/config.reek

@@ -3,6 +3,10 @@ Attribute:
   enabled: false
 IrresponsibleModule:
   enabled: false
+NestedIterators:
+  max_allowed_nesting: 2
+TooManyStatements:
+  enabled: false
 UncommunicativeMethodName:
   reject:
   - !ruby/regexp /^[a-z]$/
@@ -16,5 +20,5 @@ UncommunicativeVariableName:
   reject:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
-NestedIterators:
-  max_allowed_nesting: 2
+UtilityFunction:
+  enabled: false

data/lib/rubycritic/analysers_runner.rb

@@ -14,7 +14,7 @@ module Rubycritic
       @paths = paths
     end
 
-    def run
+    def smells
       aggregate_smells(smell_adapters)
     end
 
@@ -27,7 +27,7 @@ module Rubycritic
     end
 
     def aggregate_smells(smell_adapters)
-      smell_adapters.map(&:smells).flatten.sort
+      smell_adapters.flat_map(&:smells).sort
     end
   end
 

data/lib/rubycritic/cli.rb

@@ -1,5 +1,6 @@
 require "optparse"
 require "rubycritic"
+require "rubycritic/orchestrators/main"
 
 module Rubycritic
 
@@ -23,7 +24,7 @@ module Rubycritic
   end.parse!
 
   ARGV << "." if ARGV.empty?
-  puts "New critique at #{Rubycritic.new.critique(ARGV)}"
+  puts "New critique at #{Orchestrator::Main.new.critique(ARGV)}"
   exit 0
 
 end

data/lib/rubycritic/core/analysed_file.rb

@@ -0,0 +1,22 @@
+require "virtus"
+
+module Rubycritic
+
+  class AnalysedFile
+    include Virtus.model
+
+    attribute :pathname
+    attribute :smells
+    attribute :churn
+    attribute :complexity
+
+    def name
+      pathname.basename.sub_ext("").to_s
+    end
+
+    def has_smells?
+      !smells.empty?
+    end
+  end
+
+end

data/lib/rubycritic/{smell.rb → core/smell.rb}

@@ -1,5 +1,5 @@
 require "virtus"
-require "rubycritic/location"
+require "rubycritic/core/location"
 
 module Rubycritic
 
@@ -13,11 +13,11 @@ module Rubycritic
     attribute :type
     attribute :status
 
-    def pathnames
-      @pathnames ||= locations.map(&:pathname).uniq
+    def at_pathname?(other_pathname)
+      pathnames.any? { |pathname| pathname == other_pathname }
     end
 
-    def located_in?(other_location)
+    def at_location?(other_location)
       locations.any? { |location| location == other_location }
     end
 
@@ -47,6 +47,12 @@ module Rubycritic
     def state
       [@context, @message, @score, @type]
     end
+
+    private
+
+    def pathnames
+      @pathnames ||= locations.map(&:pathname).uniq
+    end
   end
 
 end

data/lib/rubycritic/orchestrators/base.rb

@@ -0,0 +1,27 @@
+module Rubycritic
+  module Orchestrator
+
+    class Base
+      def initialize
+        @source_control_system = SourceControlSystem.create
+      end
+
+      def critique(paths)
+        source = SourceLocator.new(paths)
+        @smells = AnalysersRunner.new(source.paths).smells
+        if @source_control_system.has_revision?
+          @smells = RevisionComparator.new(@smells, @source_control_system).smells
+          churn = Analyser::Churn.new(source.paths, @source_control_system).churn
+        end
+        complexity = ComplexityAdapter::Flog.new(source.paths).complexity
+        @analysed_files = AnalysedFilesBuilder.new(source.pathnames, @smells, churn, complexity).analysed_files
+        generate_report
+      end
+
+      def generate_report
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+    end
+
+  end
+end

data/lib/rubycritic/orchestrators/main.rb

@@ -0,0 +1,14 @@
+require "rubycritic/orchestrators/base"
+require "rubycritic/reporters/main"
+
+module Rubycritic
+  module Orchestrator
+
+    class Main < Base
+      def generate_report
+        Reporter::Main.new(@analysed_files, @smells).generate_report
+      end
+    end
+
+  end
+end

data/lib/rubycritic/orchestrators/mini.rb

@@ -0,0 +1,14 @@
+require "rubycritic/orchestrators/base"
+require "rubycritic/reporters/mini"
+
+module Rubycritic
+  module Orchestrator
+
+    class Mini < Base
+      def generate_report
+        Reporter::Mini.new(@analysed_files.first).generate_report
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/assets/javascripts/application.js

@@ -86,13 +86,6 @@ $("#js-chart-container").highcharts({
                     }
                 }
             },
-            states: {
-                hover: {
-                    marker: {
-                        enabled: false
-                    }
-                }
-            },
             tooltip: {
                 headerFormat: "<b>{point.key}</b><br>",
                 pointFormat: "Committed {point.x} times, with Flog score of {point.y}"
@@ -100,8 +93,8 @@ $("#js-chart-container").highcharts({
         }
     },
     series: [{
+        showInLegend: false,
         color: "steelblue",
-        data: turbulence_data,
-        showInLegend: false
+        data: turbulence_data
     }]
 });

data/lib/rubycritic/report_generators/base.rb

@@ -0,0 +1,43 @@
+require "erb"
+require "rubycritic/report_generators/view_helpers"
+
+module Rubycritic
+  module Generator
+
+    class Base
+      def self.erb_template(template_path)
+        ERB.new(File.read(File.join(TEMPLATES_DIR, template_path)))
+      end
+
+      TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
+      LAYOUT_TEMPLATE = erb_template(File.join("layouts", "application.html.erb"))
+
+      include ViewHelpers
+
+      def file_href
+        "file://#{file_pathname}"
+      end
+
+      def file_pathname
+        File.join(file_directory, file_name)
+      end
+
+      def file_directory
+        root_directory
+      end
+
+      def file_name
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def render
+        raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      end
+
+      def get_binding
+        binding
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/code_file.rb

@@ -0,0 +1,40 @@
+require "erb"
+require "rubycritic/report_generators/base"
+require "rubycritic/report_generators/line"
+
+module Rubycritic
+  module Generator
+
+    class CodeFile < Base
+      LINE_NUMBER_OFFSET = 1
+      TEMPLATE = erb_template("code_file.html.erb")
+
+      def initialize(analysed_file)
+        @analysed_file = analysed_file
+        @pathname = @analysed_file.pathname
+        @smells = @analysed_file.smells
+      end
+
+      def file_directory
+        File.join(root_directory, @pathname.dirname)
+      end
+
+      def file_name
+        @pathname.basename.sub_ext(".html")
+      end
+
+      def render
+        file_code = ""
+        File.readlines(@pathname).each.with_index(LINE_NUMBER_OFFSET) do |line_text, line_number|
+          location = Location.new(@pathname, line_number)
+          line_smells = @smells.select { |smell| smell.at_location?(location) }
+          file_code << Line.new(line_text, line_smells).render
+        end
+
+        file_body = TEMPLATE.result(get_binding { file_code })
+        LAYOUT_TEMPLATE.result(get_binding { file_body })
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/code_index.rb

@@ -0,0 +1,29 @@
+require "erb"
+require "rubycritic/report_generators/base"
+
+module Rubycritic
+  module Generator
+
+    class CodeIndex < Base
+      TEMPLATE = erb_template("code_index.html.erb")
+
+      def initialize(analysed_files)
+        @analysed_files = analysed_files
+      end
+
+      def file_name
+        "code_index.html"
+      end
+
+      def render
+        index_body = TEMPLATE.result(get_binding)
+        LAYOUT_TEMPLATE.result(get_binding { index_body })
+      end
+
+      def file_path(pathname)
+        File.join(root_directory, pathname.sub_ext(".html"))
+      end
+    end
+
+  end
+end

data/lib/rubycritic/report_generators/line.rb

@@ -0,0 +1,29 @@
+require "erb"
+require "rubycritic/report_generators/base"
+require "cgi"
+
+module Rubycritic
+  module Generator
+
+    class Line < Base
+      NORMAL_TEMPLATE = erb_template("line.html.erb")
+      SMELLY_TEMPLATE = erb_template("smelly_line.html.erb")
+
+      def initialize(text, smells)
+        @text = CGI::escapeHTML(text.chomp)
+        @smells = smells
+        @template =
+          if @smells.empty?
+            NORMAL_TEMPLATE
+          else
+            SMELLY_TEMPLATE
+          end
+      end
+
+      def render
+        @template.result(binding).delete("\n") + "\n"
+      end
+    end
+
+  end
+end