rubycritic 0.0.5 → 0.0.16

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.16
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2014-07-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -52,6 +66,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.3.6
+- !ruby/object:Gem::Dependency
+  name: code_analyzer
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -118,58 +146,88 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- SPEC.md
 - bin/rubycritic
 - lib/rubycritic.rb
+- lib/rubycritic/adapters/complexity/flog.rb
+- lib/rubycritic/adapters/smell/flay.rb
+- lib/rubycritic/adapters/smell/flog.rb
+- lib/rubycritic/adapters/smell/reek.rb
+- lib/rubycritic/analysers/churn.rb
 - lib/rubycritic/analysers/config.reek
+- lib/rubycritic/analysers/flay.rb
 - lib/rubycritic/analysers/flog.rb
 - lib/rubycritic/analysers/reek.rb
+- lib/rubycritic/analysers/stats.rb
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
-- lib/rubycritic/location.rb
+- lib/rubycritic/configuration.rb
+- lib/rubycritic/core/analysed_file.rb
+- lib/rubycritic/core/location.rb
+- lib/rubycritic/core/rating.rb
+- lib/rubycritic/core/smell.rb
+- lib/rubycritic/files_initializer.rb
+- lib/rubycritic/orchestrator.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
-- lib/rubycritic/report_generators/assets/javascripts/prettify.js
+- lib/rubycritic/report_generators/assets/javascripts/jquery.floatThead-v1.2.7.js
+- lib/rubycritic/report_generators/assets/javascripts/jquery.scrollTo-1.4.11.js
+- lib/rubycritic/report_generators/assets/javascripts/jquery.tablesorter-2.0.js
+- lib/rubycritic/report_generators/assets/javascripts/jquery.timeago-v1.4.1.js
+- 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/file_generator.rb
-- lib/rubycritic/report_generators/index_generator.rb
-- lib/rubycritic/report_generators/line_generator.rb
-- lib/rubycritic/report_generators/reporter.rb
-- lib/rubycritic/report_generators/templates/file.html.erb
-- lib/rubycritic/report_generators/templates/index.html.erb
+- lib/rubycritic/report_generators/base.rb
+- lib/rubycritic/report_generators/code_file.rb
+- lib/rubycritic/report_generators/code_index.rb
+- lib/rubycritic/report_generators/current_code_file.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/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/base.rb
+- lib/rubycritic/reporters/main.rb
+- lib/rubycritic/reporters/mini.rb
 - lib/rubycritic/revision_comparator.rb
-- lib/rubycritic/smell.rb
-- lib/rubycritic/smell_adapters/flog.rb
-- lib/rubycritic/smell_adapters/reek.rb
-- lib/rubycritic/smells_aggregator.rb
+- lib/rubycritic/serializer.rb
 - lib/rubycritic/smells_status_setter.rb
-- lib/rubycritic/smelly_pathnames_serializer.rb
+- lib/rubycritic/source_control_systems/base.rb
+- lib/rubycritic/source_control_systems/double.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/location_test.rb
-- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/reek_adapter_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/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/analysers/churn_test.rb
+- test/lib/rubycritic/configuration_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
+- test/lib/rubycritic/turbulence_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/flay/smelly.rb
+- test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
@@ -190,7 +248,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -198,21 +256,28 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby code smell detector
 test_files:
-- test/lib/rubycritic/location_test.rb
-- test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
-- test/lib/rubycritic/metric_adapters/reek_adapter_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/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/analysers/churn_test.rb
+- test/lib/rubycritic/configuration_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
+- test/lib/rubycritic/turbulence_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/flay/smelly.rb
+- test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb

data/SPEC.md

@@ -1,58 +0,0 @@
-Ruby Critic
-===========
-
-Ruby Critic is a tool that detects and reports smells in Ruby code.
-
-Inspired by [RuboCop][1], [Rails Best Practices][2] and [Code Climate][3], Ruby Critic aims to better help you refactor your code. By making use of Ruby's rich ecosystem of code metrics tools, Ruby Critic generates high-quality visualizations and insightful code quality reports.
-
-[1]: https://github.com/bbatsov/rubocop/
-[2]: https://github.com/railsbp/rails_best_practices
-[3]: https://codeclimate.com/
-
-Installation
-------------
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem "rubycritic"
-```
-
-And then execute:
-
-```bash
-$ bundle
-```
-
-Or just install it yourself:
-
-```bash
-$ gem install rubycritic
-```
-
-Usage
------
-
-Running `rubycritic` with no arguments will check all Ruby source files in the
-current directory:
-
-```bash
-$ rubycritic
-```
-
-Alternatively you can pass `rubycritic` a list of files and directories to check:
-
-```bash
-$ rubycritic app lib/foo.rb
-```
-
-Options
--------
-
-To specify an output file for the results:
-
-```bash
-$ rubycritic -o output_file
-```
-
-The output format is determined by the file extension or by using the `-f` option. Current options are: `text`, `html`, `yaml` and `json`.

data/lib/rubycritic/report_generators/base_generator.rb

@@ -1,42 +0,0 @@
-require "rubycritic/report_generators/view_helpers"
-
-module Rubycritic
-
-  class BaseGenerator
-    REPORT_DIR = File.expand_path("tmp/rubycritic", Dir.getwd)
-    TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
-
-    include ViewHelpers
-
-    def file_href
-      "file://#{file_pathname}"
-    end
-
-    def file_pathname
-      File.join(file_directory, file_name)
-    end
-
-    def file_directory
-      raise NotImplementedError.new("You must implement the file_directory method.")
-    end
-
-    def file_name
-      raise NotImplementedError.new("You must implement the file_name method.")
-    end
-
-    def render
-      raise NotImplementedError.new("You must implement the render method.")
-    end
-
-    def get_binding
-      binding
-    end
-
-    private
-
-    def root_directory
-      REPORT_DIR
-    end
-  end
-
-end

data/lib/rubycritic/report_generators/file_generator.rb

@@ -1,42 +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
-    FILE_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "file.html.erb")))
-    LAYOUT_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "layouts", "application.html.erb")))
-
-    def initialize(pathname, smells)
-      @pathname = pathname
-      @smells = smells
-    end
-
-    def file_directory
-      File.join(REPORT_DIR, File.dirname(@pathname))
-    end
-
-    def file_name
-      "#{analysed_file_name}.html"
-    end
-
-    def analysed_file_name
-      @pathname.basename.sub_ext("")
-    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 = FILE_TEMPLATE.result(get_binding { file_code })
-      LAYOUT_TEMPLATE.result(get_binding { file_body })
-    end
-  end
-
-end

data/lib/rubycritic/report_generators/index_generator.rb

@@ -1,28 +0,0 @@
-require "erb"
-require "rubycritic/report_generators/base_generator"
-
-module Rubycritic
-
-  class IndexGenerator < BaseGenerator
-    INDEX_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "index.html.erb")))
-    LAYOUT_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "layouts", "application.html.erb")))
-
-    def initialize(file_generators)
-      @file_generators = file_generators.sort { |a, b| a.analysed_file_name <=> b.analysed_file_name }
-    end
-
-    def file_directory
-      REPORT_DIR
-    end
-
-    def file_name
-      "index.html"
-    end
-
-    def render
-      index_body = INDEX_TEMPLATE.result(get_binding)
-      LAYOUT_TEMPLATE.result(get_binding { index_body })
-    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.new(File.read(File.join(TEMPLATES_DIR, "line.html.erb")))
-    SMELLY_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "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/reporter.rb

@@ -1,45 +0,0 @@
-require "rubycritic/report_generators/base_generator"
-require "rubycritic/report_generators/file_generator"
-require "rubycritic/report_generators/index_generator"
-require "fileutils"
-
-module Rubycritic
-
-  class Reporter
-    ASSETS_DIR = File.expand_path("../assets", __FILE__)
-
-    def initialize(source_pathnames, smelly_pathnames)
-      @source_pathnames = source_pathnames
-      @smelly_pathnames = smelly_pathnames
-    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, BaseGenerator::REPORT_DIR)
-      index_generator.file_href
-    end
-
-    private
-
-    def generators
-      file_generators + [index_generator]
-    end
-
-    def index_generator
-      @index_generator ||= IndexGenerator.new(file_generators)
-    end
-
-    def file_generators
-      @file_generators ||= @source_pathnames.map do |pathname|
-        file_smells = @smelly_pathnames[pathname]
-        FileGenerator.new(pathname, file_smells)
-      end
-    end
-  end
-
-end

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

@@ -1,3 +0,0 @@
-<button id="js-toggle-smells">Toggle Smells</button>
-
-<code class="prettyprint linenums lang-ruby file-code js-file-code"><%= yield %></code>

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

@@ -1,14 +0,0 @@
-<table>
-<thead>
-  <tr>
-    <th>Name</th>
-  </tr>
-</thead>
-<tbody>
-  <% @file_generators.each do |file_generator| %>
-  <tr>
-    <td><a href="<%= file_generator.file_pathname %>"><%= file_generator.analysed_file_name %></a></td>
-  </tr>
-  <% end %>
-</tbody>
-</table>

data/lib/rubycritic/smell_adapters/flog.rb

@@ -1,41 +0,0 @@
-require "rubycritic/smell"
-
-module Rubycritic
-  module SmellAdapter
-
-    class Flog
-      def initialize(flog)
-        @flog = flog
-      end
-
-      def smells
-        smells = []
-        @flog.each_by_score do |class_method, score|
-          smells << create_smell(class_method, score)
-        end
-        smells
-      end
-
-      private
-
-      def create_smell(context, score)
-        location = method_location(context)
-        message  = "has a complexity of #{score.round}"
-        Smell.new(
-          :locations => [location],
-          :context => context,
-          :message => message,
-          :score => score,
-          :type => "Complexity"
-        )
-      end
-
-      def method_location(context)
-        line = @flog.method_locations[context]
-        file_path, file_line = line.split(":")
-        Location.new(file_path, file_line)
-      end
-    end
-
-  end
-end

data/lib/rubycritic/smell_adapters/reek.rb

@@ -1,35 +0,0 @@
-require "rubycritic/smell"
-
-module Rubycritic
-  module SmellAdapter
-
-    class Reek
-      def initialize(reek)
-        @reek = reek
-      end
-
-      def smells
-        @reek.smells.map do |smell|
-          create_smell(smell)
-        end
-      end
-
-      private
-
-      def create_smell(smell)
-        locations = smell_locations(smell.source, smell.lines)
-        message   = smell.message
-        context   = smell.context
-        type      = smell.subclass
-        Smell.new(:locations => locations, :context => context, :message => message, :type => type)
-      end
-
-      def smell_locations(file_path, file_lines)
-        file_lines.uniq.sort.map do |file_line|
-          Location.new(file_path, file_line)
-        end
-      end
-    end
-
-  end
-end

data/lib/rubycritic/smells_aggregator.rb

@@ -1,29 +0,0 @@
-module Rubycritic
-
-  class SmellsAggregator
-    def initialize(smell_adapters)
-      @smell_adapters = smell_adapters
-    end
-
-    def smells
-      @smells ||= @smell_adapters.map(&:smells).flatten.sort
-    end
-
-    def smelly_pathnames
-      @smelly_pathnames ||= pathnames_to_files_with_smells
-    end
-
-    private
-
-    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
-        end
-      end
-      pathnames
-    end
-  end
-
-end

data/lib/rubycritic/smelly_pathnames_serializer.rb

@@ -1,34 +0,0 @@
-require "fileutils"
-
-module Rubycritic
-
-  class SmellyPathnamesSerializer
-    def initialize(file_name)
-      @file_name = file_name
-    end
-
-    def load
-      Marshal.load(File.read(@file_name))
-    end
-
-    def dump(smelly_pathnames)
-      create_file_directory
-      # HACK It's not possible to Marshal procs or lambdas.
-      smelly_pathnames.default = []
-      File.open(@file_name, "w+") do |file|
-        Marshal.dump(smelly_pathnames, file)
-      end
-    end
-
-    private
-
-    def create_file_directory
-      FileUtils.mkdir_p(file_directory)
-    end
-
-    def file_directory
-      File.dirname(@file_name)
-    end
-  end
-
-end

data/lib/rubycritic/source_control_systems/source_control_system.rb

@@ -1,42 +0,0 @@
-module Rubycritic
-
-  class SourceControlSystem
-    @@systems = []
-
-    def self.register_system
-      @@systems << self
-    end
-
-    def self.create
-      supported_system = systems.detect(&:supported?)
-      if supported_system
-        supported_system.new
-      else
-        raise "Rubycritic requires a #{system_names} repository."
-      end
-    end
-
-    def self.systems
-      @@systems
-    end
-
-    def self.system_names
-      systems.join(", ")
-    end
-
-    def has_revision?
-      raise NotImplementedError.new("You must implement the has_revision? method.")
-    end
-
-    def head_reference
-      raise NotImplementedError.new("You must implement the head_reference method.")
-    end
-
-    def travel_to_head
-      raise NotImplementedError.new("You must implement the travel_to_head method.")
-    end
-  end
-
-end
-
-require "rubycritic/source_control_systems/git"