rubycritic 0.0.12 → 0.0.13

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

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 describe "Array of Smells" do
   it "is sortable" do

data/test/lib/rubycritic/smells_status_setter_test.rb

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 require "rubycritic/smells_status_setter"
 
 describe Rubycritic::SmellsStatusSetter do

data/test/lib/rubycritic/turbulence_test.rb

@@ -1,27 +1,18 @@
 require "test_helper"
 require "rubycritic/turbulence"
-require "rubycritic/source_control_systems/source_control_system"
+require "ostruct"
 
 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
+    it "returns json data that maps pathname, churn and complexity to name, x and y" do
+      files = [AnalysedFileDouble.new(:pathname => "./foo.rb", :churn => 1, :complexity => 2)]
+      turbulence_data = Rubycritic::Turbulence.new(files).data
+      instance_parsed_json = JSON.parse(turbulence_data).first
+      instance_parsed_json["name"].must_equal "./foo.rb"
+      instance_parsed_json["x"].must_equal 1
+      instance_parsed_json["y"].must_equal 2
     end
   end
 end
 
-class SourceControlSystemDouble < Rubycritic::SourceControlSystem
-  def revisions_count(file)
-    1 # churn
-  end
-end
+class AnalysedFileDouble < OpenStruct; end

data/test/samples/reek/not_smelly.rb

@@ -5,10 +5,19 @@ class Perfume
     oneVariable = oneParameter
   end
 
-  def allowNestingIteratorsTwoLevelsDeep
+  def allow_nesting_iterators_two_levels_deep
     loop do
       loop do
       end
     end
   end
+
+  def method_with_too_many_statements
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.12
+  version: 0.0.13
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -145,6 +145,7 @@ files:
 - lib/rubycritic/adapters/smell/flay.rb
 - lib/rubycritic/adapters/smell/flog.rb
 - lib/rubycritic/adapters/smell/reek.rb
+- lib/rubycritic/analysed_files_builder.rb
 - lib/rubycritic/analysers/churn.rb
 - lib/rubycritic/analysers/config.reek
 - lib/rubycritic/analysers/flay.rb
@@ -153,7 +154,12 @@ files:
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
 - lib/rubycritic/configuration.rb
-- lib/rubycritic/location.rb
+- lib/rubycritic/core/analysed_file.rb
+- lib/rubycritic/core/location.rb
+- lib/rubycritic/core/smell.rb
+- lib/rubycritic/orchestrators/base.rb
+- lib/rubycritic/orchestrators/main.rb
+- lib/rubycritic/orchestrators/mini.rb
 - lib/rubycritic/report_generators/assets/javascripts/application.js
 - lib/rubycritic/report_generators/assets/javascripts/highcharts.src-4.0.1.js
 - lib/rubycritic/report_generators/assets/javascripts/jquery-2.1.0.js
@@ -162,23 +168,23 @@ files:
 - lib/rubycritic/report_generators/assets/javascripts/prettify-4-Mar-2013.js
 - lib/rubycritic/report_generators/assets/stylesheets/application.css
 - lib/rubycritic/report_generators/assets/stylesheets/prettify.custom_theme.css
-- lib/rubycritic/report_generators/base_generator.rb
-- 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/base.rb
+- lib/rubycritic/report_generators/code_file.rb
+- lib/rubycritic/report_generators/code_index.rb
+- lib/rubycritic/report_generators/line.rb
+- lib/rubycritic/report_generators/overview.rb
+- lib/rubycritic/report_generators/smells_index.rb
+- lib/rubycritic/report_generators/templates/code_file.html.erb
 - 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
+- lib/rubycritic/reporters/main.rb
+- lib/rubycritic/reporters/mini.rb
 - lib/rubycritic/revision_comparator.rb
-- lib/rubycritic/smell.rb
 - lib/rubycritic/smells_serializer.rb
 - lib/rubycritic/smells_status_setter.rb
 - lib/rubycritic/source_control_systems/git.rb
@@ -187,16 +193,18 @@ files:
 - lib/rubycritic/turbulence.rb
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
+- test/lib/rubycritic/adapters/complexity/flog_test.rb
+- test/lib/rubycritic/adapters/smell/flay_test.rb
+- test/lib/rubycritic/adapters/smell/flog_test.rb
+- test/lib/rubycritic/adapters/smell/reek_test.rb
+- test/lib/rubycritic/analysed_files_builder_test.rb
 - 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/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_array_test.rb
+- test/lib/rubycritic/core/analysed_file_test.rb
+- test/lib/rubycritic/core/location_test.rb
+- test/lib/rubycritic/core/smell_test.rb
+- test/lib/rubycritic/core/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
@@ -238,16 +246,18 @@ signing_key:
 specification_version: 4
 summary: Ruby code smell detector
 test_files:
+- test/lib/rubycritic/adapters/complexity/flog_test.rb
+- test/lib/rubycritic/adapters/smell/flay_test.rb
+- test/lib/rubycritic/adapters/smell/flog_test.rb
+- test/lib/rubycritic/adapters/smell/reek_test.rb
+- test/lib/rubycritic/analysed_files_builder_test.rb
 - 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/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_array_test.rb
+- test/lib/rubycritic/core/analysed_file_test.rb
+- test/lib/rubycritic/core/location_test.rb
+- test/lib/rubycritic/core/smell_test.rb
+- test/lib/rubycritic/core/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

data/lib/rubycritic/report_generators/base_generator.rb

@@ -1,41 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/view_helpers"
-
-module Rubycritic
-
-  class BaseGenerator
-    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

data/lib/rubycritic/report_generators/code_index_generator.rb

@@ -1,32 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/base_generator"
-
-module Rubycritic
-
-  class CodeIndexGenerator < BaseGenerator
-    TEMPLATE = erb_template("code_index.html.erb")
-
-    def initialize(source_pathnames, smelly_pathnames)
-      @source_pathnames = source_pathnames
-      @smelly_pathnames = smelly_pathnames
-    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(path)
-      File.join(root_directory, path.sub_ext(".html"))
-    end
-
-    def smells_count(pathname)
-      (@smelly_pathnames[pathname] || []).length
-    end
-  end
-
-end

data/lib/rubycritic/report_generators/file_generator.rb

@@ -1,41 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/base_generator"
-require "rubycritic/report_generators/line_generator"
-
-module Rubycritic
-
-  class FileGenerator < BaseGenerator
-    LINE_NUMBER_OFFSET = 1
-    TEMPLATE = erb_template("file.html.erb")
-
-    def initialize(pathname, smells)
-      @pathname = pathname
-      @smells = 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.located_in?(location) }
-        file_code << LineGenerator.new(line_text, line_smells).render
-      end
-
-      file_body = TEMPLATE.result(get_binding { file_code })
-      LAYOUT_TEMPLATE.result(get_binding { file_body })
-    end
-
-    def file_has_smells?
-      !@smells.empty?
-    end
-  end
-
-end

data/lib/rubycritic/report_generators/line_generator.rb

@@ -1,27 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/base_generator"
-require "cgi"
-
-module Rubycritic
-
-  class LineGenerator < BaseGenerator
-    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

data/lib/rubycritic/report_generators/overview_generator.rb

@@ -1,24 +0,0 @@
-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

@@ -1,67 +0,0 @@
-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"
-
-module Rubycritic
-
-  class Reporter
-    ASSETS_DIR = File.expand_path("../assets", __FILE__)
-
-    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
-
-    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 ||= OverviewGenerator.new(@turbulence_data)
-    end
-
-    def code_index_generator
-      @code_index_generator ||= CodeIndexGenerator.new(@source_pathnames, @smelly_pathnames)
-    end
-
-    def smells_index_generator
-      @smells_index_generator ||= SmellsIndexGenerator.new(@smells)
-    end
-
-    def file_generators
-      @file_generators ||= @source_pathnames.map do |file_pathname|
-        file_smells = @smelly_pathnames[file_pathname]
-        FileGenerator.new(file_pathname, file_smells)
-      end
-    end
-
-    def pathnames_to_files_with_smells
-      pathnames = Hash.new { |hash, key| hash[key] = [] }
-      @smells.each do |smell|
-        smell.pathnames.each do |pathname|
-          pathnames[pathname] << smell
-        end
-      end
-      pathnames
-    end
-  end
-
-end

data/lib/rubycritic/report_generators/smells_index_generator.rb

@@ -1,23 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/base_generator"
-
-module Rubycritic
-
-  class SmellsIndexGenerator < BaseGenerator
-    TEMPLATE = erb_template("smells_index.html.erb")
-
-    def initialize(smells)
-      @smells = smells.sort { |a, b| a.type <=> b.type }
-    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