rubycritic 0.0.5 → 1.4.0

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.4.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-14 00:00:00.000000000 Z
+date: 2015-03-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -24,34 +24,68 @@ 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
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 4.2.0
+        version: 4.2.1
 - !ruby/object:Gem::Dependency
   name: reek
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: 1.6.5
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -108,8 +142,22 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
-description: |2
-      Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+description: RubyCritic is a tool that wraps around various static analysis gems to
+  provide a quality report of your Ruby code.
 email:
 - guilherme.rdems@gmail.com
 executables:
@@ -118,65 +166,120 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
 - CONTRIBUTING.md
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- SPEC.md
 - bin/rubycritic
 - lib/rubycritic.rb
-- lib/rubycritic/analysers/config.reek
-- lib/rubycritic/analysers/flog.rb
-- lib/rubycritic/analysers/reek.rb
+- lib/rubycritic/analysers/attributes.rb
+- lib/rubycritic/analysers/churn.rb
+- lib/rubycritic/analysers/complexity.rb
+- lib/rubycritic/analysers/helpers/ast_node.rb
+- lib/rubycritic/analysers/helpers/config.reek
+- lib/rubycritic/analysers/helpers/flay.rb
+- lib/rubycritic/analysers/helpers/flog.rb
+- lib/rubycritic/analysers/helpers/methods_counter.rb
+- lib/rubycritic/analysers/helpers/modules_locator.rb
+- lib/rubycritic/analysers/helpers/parser.rb
+- lib/rubycritic/analysers/helpers/reek.rb
+- lib/rubycritic/analysers/smells/flay.rb
+- lib/rubycritic/analysers/smells/flog.rb
+- lib/rubycritic/analysers/smells/reek.rb
 - lib/rubycritic/analysers_runner.rb
-- lib/rubycritic/cli.rb
-- lib/rubycritic/location.rb
-- lib/rubycritic/report_generators/assets/javascripts/application.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
-- 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/templates/layouts/application.html.erb
-- lib/rubycritic/report_generators/templates/line.html.erb
-- lib/rubycritic/report_generators/templates/smelly_line.html.erb
-- lib/rubycritic/report_generators/view_helpers.rb
+- lib/rubycritic/cli/application.rb
+- lib/rubycritic/cli/options.rb
+- lib/rubycritic/commands/ci.rb
+- lib/rubycritic/commands/default.rb
+- lib/rubycritic/commands/help.rb
+- lib/rubycritic/commands/version.rb
+- lib/rubycritic/configuration.rb
+- lib/rubycritic/core/analysed_module.rb
+- lib/rubycritic/core/location.rb
+- lib/rubycritic/core/rating.rb
+- lib/rubycritic/core/smell.rb
+- lib/rubycritic/generators/html/assets/javascripts/application.js
+- lib/rubycritic/generators/html/assets/javascripts/highcharts.src-4.0.1.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery-2.1.0.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.floatThead-v1.2.7.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.scrollTo-1.4.11.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.tablesorter.js
+- lib/rubycritic/generators/html/assets/javascripts/jquery.timeago-v1.4.1.js
+- lib/rubycritic/generators/html/assets/javascripts/prettify-4-Mar-2013.js
+- lib/rubycritic/generators/html/assets/stylesheets/application.css
+- lib/rubycritic/generators/html/assets/stylesheets/prettify.custom_theme.css
+- lib/rubycritic/generators/html/base.rb
+- lib/rubycritic/generators/html/code_file.rb
+- lib/rubycritic/generators/html/code_index.rb
+- lib/rubycritic/generators/html/line.rb
+- lib/rubycritic/generators/html/overview.rb
+- lib/rubycritic/generators/html/smells_index.rb
+- lib/rubycritic/generators/html/templates/code_file.html.erb
+- lib/rubycritic/generators/html/templates/code_index.html.erb
+- lib/rubycritic/generators/html/templates/layouts/application.html.erb
+- lib/rubycritic/generators/html/templates/line.html.erb
+- lib/rubycritic/generators/html/templates/overview.html.erb
+- lib/rubycritic/generators/html/templates/smells_index.html.erb
+- lib/rubycritic/generators/html/templates/smelly_line.html.erb
+- lib/rubycritic/generators/html/turbulence.rb
+- lib/rubycritic/generators/html/view_helpers.rb
+- lib/rubycritic/generators/html_report.rb
+- lib/rubycritic/generators/json/simple.rb
+- lib/rubycritic/generators/json_report.rb
+- lib/rubycritic/reporter.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_control_systems/mercurial.rb
 - lib/rubycritic/source_locator.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/analysers_test_helper.rb
+- test/lib/rubycritic/analysers/churn_test.rb
+- test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
+- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
+- test/lib/rubycritic/analysers/smells/flay_test.rb
+- test/lib/rubycritic/analysers/smells/flog_test.rb
+- test/lib/rubycritic/analysers/smells/reek_test.rb
+- test/lib/rubycritic/configuration_test.rb
+- test/lib/rubycritic/core/analysed_module_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/report_generators/turbulence_test.rb
+- test/lib/rubycritic/report_generators/view_helpers_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_control_systems/base_test.rb
+- test/lib/rubycritic/source_control_systems/double_test.rb
+- test/lib/rubycritic/source_control_systems/git_test.rb
+- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
+- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
+- test/lib/rubycritic/source_control_systems/mercurial_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/empty.rb
+- test/samples/flay/smelly.rb
+- test/samples/flay/smelly2.rb
+- test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
+- test/samples/location/file0_symlink.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
+- test/samples/methods_count.rb
+- test/samples/module_names.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
+- test/samples/unparsable.rb
 - test/test_helper.rb
 homepage: https://github.com/whitesmith/rubycritic
 licenses:
@@ -190,7 +293,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,26 +301,48 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.1.11
+rubygems_version: 2.4.1
 signing_key: 
 specification_version: 4
-summary: Ruby code smell detector
+summary: RubyCritic is a Ruby code quality reporter
 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/analysers_test_helper.rb
+- test/lib/rubycritic/analysers/churn_test.rb
+- test/lib/rubycritic/analysers/complexity_test.rb
+- test/lib/rubycritic/analysers/helpers/methods_counter_test.rb
+- test/lib/rubycritic/analysers/helpers/modules_locator_test.rb
+- test/lib/rubycritic/analysers/smells/flay_test.rb
+- test/lib/rubycritic/analysers/smells/flog_test.rb
+- test/lib/rubycritic/analysers/smells/reek_test.rb
+- test/lib/rubycritic/configuration_test.rb
+- test/lib/rubycritic/core/analysed_module_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/report_generators/turbulence_test.rb
+- test/lib/rubycritic/report_generators/view_helpers_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_control_systems/base_test.rb
+- test/lib/rubycritic/source_control_systems/double_test.rb
+- test/lib/rubycritic/source_control_systems/git_test.rb
+- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
+- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
+- test/lib/rubycritic/source_control_systems/mercurial_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/empty.rb
+- test/samples/flay/smelly.rb
+- test/samples/flay/smelly2.rb
+- test/samples/flog/complex.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
+- test/samples/location/file0_symlink.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
+- test/samples/methods_count.rb
+- test/samples/module_names.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
+- test/samples/unparsable.rb
 - test/test_helper.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/analysers/flog.rb

@@ -1,20 +0,0 @@
-require "flog"
-
-module Rubycritic
-  module Analyser
-
-    class Flog < ::Flog
-      DEFAULT_OPTIONS = {
-        :all => true,
-        :continue => true,
-        :methods => true
-      }
-
-      def initialize(paths)
-        super(DEFAULT_OPTIONS)
-        flog(*paths)
-      end
-    end
-
-  end
-end

data/lib/rubycritic/analysers/reek.rb

@@ -1,15 +0,0 @@
-require "reek"
-
-module Rubycritic
-  module Analyser
-
-    class Reek < ::Reek::Examiner
-      DEFAULT_CONFIG_FILES = [File.expand_path("../config.reek", __FILE__)]
-
-      def initialize(paths)
-        super(Array(paths), DEFAULT_CONFIG_FILES)
-      end
-    end
-
-  end
-end

data/lib/rubycritic/cli.rb

@@ -1,25 +0,0 @@
-require "optparse"
-require "rubycritic"
-
-module Rubycritic
-
-  OptionParser.new do |opts|
-    opts.banner = "Usage: rubycritic [options] [paths]"
-
-    opts.on_tail("-v", "--version", "Show this version") do
-      require "rubycritic/version"
-      puts VERSION
-      exit 0
-    end
-
-    opts.on_tail("-h", "--help", "Show this message") do
-      puts opts
-      exit 0
-    end
-  end.parse!
-
-  ARGV << "." if ARGV.empty?
-  puts "New critique at #{Rubycritic.new.critique(ARGV)}"
-  exit 0
-
-end

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

@@ -1,25 +0,0 @@
-prettyPrint();
-
-highlightLineFromFragment();
-
-function highlightLineFromFragment() {
-    highlightLine(window.location.hash)
-}
-
-$(".js-file-code").on("click", ".js-smell-location", highlightSmellyLine);
-
-function highlightSmellyLine() {
-    var lineId = "#" + this.href.split("#")[1];
-    $(".js-file-code li").removeClass("highlight");
-    highlightLine(lineId);
-}
-
-function highlightLine(lineReference) {
-    $(lineReference).addClass("highlight");
-}
-
-$("#js-toggle-smells").on("click", toggleSmells);
-
-function toggleSmells() {
-    $(".js-smells").toggle();
-}

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

@@ -1,26 +0,0 @@
-.smells {
-  margin: 2px 0 22px 0;
-  padding-left: 0;
-  border: 1px solid #000;
-  background-color: #DDD;
-  white-space: normal;
-  list-style-type: disc;
-}
-
-.smell {
-  margin: 5px 5px 5px 30px;
-  font-size: 24px;
-}
-
-.smell.new {
-  color: #F00;
-}
-
-.smell.old {
-  color: #FA0;
-}
-
-.smell .description {
-  color: #000;
-  font-size: initial;
-}

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