rubycritic 2.6.0 → 2.7.0

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# Offense count: 1
+Metrics/AbcSize:
+  Exclude:
+    - 'lib/rubycritic/analysers/smells/flay.rb'
+    - 'lib/rubycritic/cli/options.rb'
+
+# Offense count: 6
+# Configuration parameters: CountComments.
+Metrics/MethodLength:
+  Exclude:
+    - 'lib/rubycritic/analysers/helpers/ast_node.rb'
+    - 'lib/rubycritic/analysers/smells/flay.rb'
+    - 'lib/rubycritic/command_factory.rb'
+    - 'lib/rubycritic/core/analysed_module.rb'
+    - 'lib/rubycritic/reporter.rb'
+    - 'lib/rubycritic/revision_comparator.rb'
+    - 'lib/rubycritic/platforms/base.rb'
+
+# Offense count: 4
+Style/AccessorMethodName:
+  Exclude:
+    - 'lib/rubycritic/analysers/helpers/ast_node.rb'
+    - 'lib/rubycritic/generators/html/base.rb'
+    - 'lib/rubycritic/revision_comparator.rb'
+
+# Offense count: 1
+Style/ClassVars:
+  Exclude:
+    - 'lib/rubycritic/source_control_systems/base.rb'
+
+# Offense count: 3
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, SupportedStyles.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 2.7.0 / 2015-01-23
+
+* [FEATURE] Open html report with browser (by YingRui Lu)
+* [CHANGE] Bump Reek to 3.9.1
+* [CHANGE] Bump Rubocop to 0.36 and internal cleanup (preparing for Ruby 2.3)
+
 # 2.6.0 / 2015-01-21
 
 * [FEATURE] Add a minimum score option to the command line interface (by Roberto Schneider)

data/Gemfile

@@ -1,4 +1,4 @@
-source "https://rubygems.org"
+source 'https://rubygems.org'
 
 # Specify your gem's dependencies in rubycritic.gemspec
 gemspec

data/Rakefile

@@ -1,18 +1,18 @@
-require "bundler/gem_tasks"
-require "rake/testtask"
-require "rubocop/rake_task"
-require "cucumber/rake/task"
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+require 'rubocop/rake_task'
+require 'cucumber/rake/task'
 
 Rake::TestTask.new do |task|
-  task.libs.push "lib"
-  task.libs.push "test"
-  task.pattern = "test/**/*_test.rb"
+  task.libs.push 'lib'
+  task.libs.push 'test'
+  task.pattern = 'test/**/*_test.rb'
 end
 
 Cucumber::Rake::Task.new(:features) do |t|
-  t.cucumber_opts = "features --format progress --color"
+  t.cucumber_opts = 'features --format progress --color'
 end
 
 RuboCop::RakeTask.new
 
-task :default => [:test, :features, :rubocop]
+task default: [:test, :features, :rubocop]

data/bin/rubycritic

@@ -2,8 +2,8 @@
 
 # Always look in the lib directory of this gem
 # first when searching the load path
-$LOAD_PATH.unshift File.expand_path("../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 
-require "rubycritic/cli/application"
+require 'rubycritic/cli/application'
 
 exit Rubycritic::Cli::Application.new(ARGV).execute

data/features/command_line_interface/options.feature

@@ -29,6 +29,7 @@ Feature: Rubycritic can be controlled using command-line options
           -m, --mode-ci                    Use CI mode (faster, but only analyses last commit)
               --deduplicate-symlinks       De-duplicate symlinks based on their final target
               --suppress-ratings           Suppress letter ratings
+              --no-browser                 Do not open html report with browser
           -v, --version                    Show gem's version
           -h, --help                       Show this message
 

data/features/step_definitions/rubycritic_steps.rb

@@ -15,7 +15,7 @@ Then(/^it reports:$/) do |report|
 end
 
 Then(/^there is no output on stdout$/) do
-  expect(last_command_started).to have_output_on_stdout("")
+  expect(last_command_started).to have_output_on_stdout('')
 end
 
 Then(/^it reports the current version$/) do

data/features/step_definitions/sample_file_steps.rb

@@ -12,7 +12,7 @@ Given(/^the smelly file 'smelly.rb'/) do
       end
     end
   EOS
-  write_file("smelly.rb", contents)
+  write_file('smelly.rb', contents)
 end
 
 Given(/^the clean file 'clean.rb'/) do
@@ -22,9 +22,9 @@ Given(/^the clean file 'clean.rb'/) do
       def foo; end
     end
   EOS
-  write_file("clean.rb", contents)
+  write_file('clean.rb', contents)
 end
 
 Given(/^the empty file 'empty.rb'/) do
-  write_file("clean.rb", "")
+  write_file('clean.rb', '')
 end

data/features/support/env.rb

@@ -1,8 +1,8 @@
-require_relative "../../lib/rubycritic"
-require_relative "../../lib/rubycritic/cli/application"
-require_relative "../../lib/rubycritic/commands/status_reporter"
-require "aruba/cucumber"
-require "minitest/spec"
+require_relative '../../lib/rubycritic'
+require_relative '../../lib/rubycritic/cli/application'
+require_relative '../../lib/rubycritic/commands/status_reporter'
+require 'aruba/cucumber'
+require 'minitest/spec'
 
 #
 # Provides runner methods used in the cucumber steps.
@@ -16,7 +16,7 @@ class RubycriticWorld
   end
 
   def rubycritic(args)
-    run_simple("rubycritic #{args}", false)
+    run_simple("rubycritic #{args}  --no-browser", false)
   end
 end
 

data/lib/rubycritic.rb

@@ -1,4 +1,4 @@
-require "rubycritic/command_factory"
+require 'rubycritic/command_factory'
 
 module Rubycritic
 end

data/lib/rubycritic/analysers/attributes.rb

@@ -1,10 +1,9 @@
-require "rubycritic/analysers/helpers/methods_counter"
-require "rubycritic/analysers/helpers/modules_locator"
-require "rubycritic/colorize"
+require 'rubycritic/analysers/helpers/methods_counter'
+require 'rubycritic/analysers/helpers/modules_locator'
+require 'rubycritic/colorize'
 
 module Rubycritic
   module Analyser
-
     class Attributes
       include Colorize
       def initialize(analysed_modules)
@@ -15,13 +14,13 @@ module Rubycritic
         @analysed_modules.each do |analysed_module|
           analysed_module.methods_count = MethodsCounter.new(analysed_module).count
           analysed_module.name = ModulesLocator.new(analysed_module).first_name
-          print green "."
+          print green '.'
         end
-        puts ""
+        puts ''
       end
 
       def to_s
-        "attributes"
+        'attributes'
       end
     end
   end

data/lib/rubycritic/analysers/churn.rb

@@ -1,8 +1,7 @@
-require "rubycritic/colorize"
+require 'rubycritic/colorize'
 
 module Rubycritic
   module Analyser
-
     class Churn
       include Colorize
       attr_writer :source_control_system
@@ -16,15 +15,14 @@ module Rubycritic
         @analysed_modules.each do |analysed_module|
           analysed_module.churn = @source_control_system.revisions_count(analysed_module.path)
           analysed_module.committed_at = @source_control_system.date_of_last_commit(analysed_module.path)
-          print green "."
+          print green '.'
         end
-        puts ""
+        puts ''
       end
 
       def to_s
-        "churn"
+        'churn'
       end
     end
-
   end
 end

data/lib/rubycritic/analysers/complexity.rb

@@ -1,9 +1,8 @@
-require "rubycritic/analysers/helpers/flog"
-require "rubycritic/colorize"
+require 'rubycritic/analysers/helpers/flog'
+require 'rubycritic/colorize'
 
 module Rubycritic
   module Analyser
-
     class Complexity
       include Colorize
       def initialize(analysed_modules)
@@ -16,15 +15,14 @@ module Rubycritic
           @flog.reset
           @flog.flog(analysed_module.path)
           analysed_module.complexity = @flog.total_score.round
-          print green "."
+          print green '.'
         end
-        puts ""
+        puts ''
       end
 
       def to_s
-        "complexity"
+        'complexity'
       end
     end
-
   end
 end

data/lib/rubycritic/analysers/helpers/ast_node.rb

@@ -1,8 +1,7 @@
 module Parser
   module AST
-
     class Node
-      MODULE_TYPES = [:module, :class]
+      MODULE_TYPES = [:module, :class].freeze
 
       def count_nodes_of_type(*types)
         count = 0
@@ -22,8 +21,8 @@ module Parser
 
       def get_module_names
         children_modules = children
-          .select { |child| child.is_a?(Parser::AST::Node) }
-          .flat_map(&:get_module_names)
+                           .select { |child| child.is_a?(Parser::AST::Node) }
+                           .flat_map(&:get_module_names)
 
         if MODULE_TYPES.include?(type)
           if children_modules.empty?
@@ -47,7 +46,7 @@ module Parser
           name_segments.unshift(current_node.children[1])
           current_node = current_node.children[0]
         end
-        name_segments.join("::")
+        name_segments.join('::')
       end
     end
   end
@@ -64,6 +63,5 @@ module Rubycritic
         []
       end
     end
-
   end
 end

data/lib/rubycritic/analysers/helpers/flay.rb

@@ -1,7 +1,6 @@
-require "flay"
+require 'flay'
 
 module Rubycritic
-
   class Flay < ::Flay
     def initialize(paths)
       super()
@@ -9,5 +8,4 @@ module Rubycritic
       analyze
     end
   end
-
 end

data/lib/rubycritic/analysers/helpers/flog.rb

@@ -1,17 +1,15 @@
-require "flog"
+require 'flog'
 
 module Rubycritic
-
   class Flog < ::Flog
     DEFAULT_OPTIONS = {
-      :all => true,
-      :continue => true,
-      :methods => true
-    }
+      all: true,
+      continue: true,
+      methods: true
+    }.freeze
 
     def initialize
       super(DEFAULT_OPTIONS)
     end
   end
-
 end

data/lib/rubycritic/analysers/helpers/methods_counter.rb

@@ -1,7 +1,6 @@
-require "rubycritic/analysers/helpers/parser"
+require 'rubycritic/analysers/helpers/parser'
 
 module Rubycritic
-
   class MethodsCounter
     def initialize(analysed_module)
       @analysed_module = analysed_module
@@ -21,5 +20,4 @@ module Rubycritic
       File.read(@analysed_module.path)
     end
   end
-
 end

data/lib/rubycritic/analysers/helpers/modules_locator.rb

@@ -1,7 +1,6 @@
-require "rubycritic/analysers/helpers/parser"
+require 'rubycritic/analysers/helpers/parser'
 
 module Rubycritic
-
   class ModulesLocator
     def initialize(analysed_module)
       @analysed_module = analysed_module
@@ -31,12 +30,11 @@ module Rubycritic
     end
 
     def name_from_path
-      [file_name.split("_").map(&:capitalize).join]
+      [file_name.split('_').map(&:capitalize).join]
     end
 
     def file_name
-      @analysed_module.pathname.basename.sub_ext("").to_s
+      @analysed_module.pathname.basename.sub_ext('').to_s
     end
   end
-
 end

data/lib/rubycritic/analysers/helpers/parser.rb

@@ -1,5 +1,5 @@
-require "parser/current"
-require "rubycritic/analysers/helpers/ast_node"
+require 'parser/current'
+require 'rubycritic/analysers/helpers/ast_node'
 
 module Rubycritic
   module Parser

data/lib/rubycritic/analysers/helpers/reek.rb

@@ -1,4 +1,4 @@
-require "reek"
+require 'reek'
 
 module Rubycritic
   class Reek < ::Reek::Examiner

data/lib/rubycritic/analysers/smells/flay.rb

@@ -1,10 +1,9 @@
-require "rubycritic/analysers/helpers/flay"
-require "rubycritic/core/smell"
-require "rubycritic/colorize"
+require 'rubycritic/analysers/helpers/flay'
+require 'rubycritic/core/smell'
+require 'rubycritic/colorize'
 
 module Rubycritic
   module Analyser
-
     class FlaySmells
       include Colorize
       def initialize(analysed_modules)
@@ -22,13 +21,13 @@ module Rubycritic
           nodes.each do |node|
             @analysed_modules[node.file].duplication += node.mass
           end
-          print green "."
+          print green '.'
         end
-        puts ""
+        puts ''
       end
 
       def to_s
-        "flay smells"
+        'flay smells'
       end
 
       private
@@ -44,12 +43,12 @@ module Rubycritic
       def create_smell(structural_hash, nodes)
         mass = @flay.masses[structural_hash]
         Smell.new(
-          :locations => smell_locations(nodes),
-          :context   => similarity(structural_hash),
-          :message   => "found in #{nodes.size} nodes",
-          :score     => mass,
-          :type      => "DuplicateCode",
-          :cost      => cost(mass)
+          locations: smell_locations(nodes),
+          context: similarity(structural_hash),
+          message: "found in #{nodes.size} nodes",
+          score: mass,
+          type: 'DuplicateCode',
+          cost: cost(mass)
         )
       end
 
@@ -61,9 +60,9 @@ module Rubycritic
 
       def similarity(structural_hash)
         if @flay.identical[structural_hash]
-          "Identical code"
+          'Identical code'
         else
-          "Similar code"
+          'Similar code'
         end
       end
 
@@ -71,6 +70,5 @@ module Rubycritic
         mass / 25
       end
     end
-
   end
 end