rubycritic 2.6.0 → 2.7.0

data/lib/rubycritic/generators/json_report.rb

@@ -1,8 +1,7 @@
-require "rubycritic/generators/json/simple"
+require 'rubycritic/generators/json/simple'
 
 module Rubycritic
   module Generator
-
     class JsonReport
       def initialize(analysed_modules)
         @analysed_modules = analysed_modules
@@ -18,6 +17,5 @@ module Rubycritic
         Json::Simple.new(@analysed_modules)
       end
     end
-
   end
 end

data/lib/rubycritic/generators/text/list.rb

@@ -1,24 +1,24 @@
-require "colorize"
+require 'colorize'
 
 module Rubycritic
   module Generator
     module Text
       class List
         class << self
-          TEMPLATE_PATH = File.expand_path("../templates/list.erb", __FILE__)
+          TEMPLATE_PATH = File.expand_path('../templates/list.erb', __FILE__)
 
           def erb_template
-            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, "-")
+            @erb_template ||= ERB.new(File.read(TEMPLATE_PATH), nil, '-')
           end
         end
 
         RATING_TO_COLOR = {
-          "A" => :green,
-          "B" => :green,
-          "C" => :yellow,
-          "D" => :light_red,
-          "F" => :red
-        }
+          'A' => :green,
+          'B' => :green,
+          'C' => :yellow,
+          'D' => :light_red,
+          'F' => :red
+        }.freeze
 
         def initialize(analysed_module)
           @analysed_module = analysed_module

data/lib/rubycritic/reporter.rb

@@ -1,5 +1,4 @@
 module Rubycritic
-
   module Reporter
     def self.generate_report(analysed_modules)
       report_generator_class.new(analysed_modules).generate_report
@@ -8,16 +7,15 @@ module Rubycritic
     def self.report_generator_class
       case Config.format
       when :json
-        require "rubycritic/generators/json_report"
+        require 'rubycritic/generators/json_report'
         Generator::JsonReport
       when :console
-        require "rubycritic/generators/console_report"
+        require 'rubycritic/generators/console_report'
         Generator::ConsoleReport
       else
-        require "rubycritic/generators/html_report"
+        require 'rubycritic/generators/html_report'
         Generator::HtmlReport
       end
     end
   end
-
 end

data/lib/rubycritic/revision_comparator.rb

@@ -1,13 +1,12 @@
-require "rubycritic/serializer"
-require "rubycritic/analysers_runner"
-require "rubycritic/smells_status_setter"
-require "rubycritic/version"
-require "digest/md5"
+require 'rubycritic/serializer'
+require 'rubycritic/analysers_runner'
+require 'rubycritic/smells_status_setter'
+require 'rubycritic/version'
+require 'digest/md5'
 
 module Rubycritic
-
   class RevisionComparator
-    SNAPSHOTS_DIR_NAME = "snapshots"
+    SNAPSHOTS_DIR_NAME = 'snapshots'.freeze
 
     def initialize(paths)
       @paths = paths
@@ -49,5 +48,4 @@ module Rubycritic
       )
     end
   end
-
 end

data/lib/rubycritic/serializer.rb

@@ -1,7 +1,6 @@
-require "fileutils"
+require 'fileutils'
 
 module Rubycritic
-
   class Serializer
     def initialize(file)
       @file = file
@@ -13,7 +12,7 @@ module Rubycritic
 
     def dump(content)
       create_file_directory
-      File.open(@file, "w+") do |file|
+      File.open(@file, 'w+') do |file|
         Marshal.dump(content, file)
       end
     end
@@ -28,5 +27,4 @@ module Rubycritic
       File.dirname(@file)
     end
   end
-
 end

data/lib/rubycritic/smells_status_setter.rb

@@ -1,5 +1,4 @@
 module Rubycritic
-
   module SmellsStatusSetter
     def self.set(smells_before, smells_now)
       old_smells = smells_now & smells_before
@@ -8,11 +7,10 @@ module Rubycritic
       set_status(new_smells, :new)
     end
 
-    private
-
     def self.set_status(smells, status)
       smells.each { |smell| smell.status = status }
     end
-  end
 
+    private_class_method :set_status
+  end
 end

data/lib/rubycritic/source_control_systems/base.rb

@@ -1,8 +1,7 @@
-require "shellwords"
+require 'shellwords'
 
 module Rubycritic
   module SourceControlSystem
-
     class Base
       @@systems = []
 
@@ -28,10 +27,9 @@ module Rubycritic
         "#{systems[0...-1].join(', ')} or #{systems[-1]}"
       end
     end
-
   end
 end
 
-require "rubycritic/source_control_systems/double"
-require "rubycritic/source_control_systems/git"
-require "rubycritic/source_control_systems/mercurial"
+require 'rubycritic/source_control_systems/double'
+require 'rubycritic/source_control_systems/git'
+require 'rubycritic/source_control_systems/mercurial'

data/lib/rubycritic/source_control_systems/double.rb

@@ -2,7 +2,7 @@ module Rubycritic
   module SourceControlSystem
     class Double < Base
       def revisions_count(_)
-        "N/A"
+        'N/A'
       end
 
       def date_of_last_commit(_)
@@ -13,6 +13,5 @@ module Rubycritic
         false
       end
     end
-
   end
 end

data/lib/rubycritic/source_control_systems/git.rb

@@ -1,6 +1,5 @@
 module Rubycritic
   module SourceControlSystem
-
     class Git < Base
       register_system
 
@@ -9,7 +8,7 @@ module Rubycritic
       end
 
       def self.to_s
-        "Git"
+        'Git'
       end
 
       def revisions_count(path)
@@ -52,6 +51,5 @@ module Rubycritic
         `git stash pop`
       end
     end
-
   end
 end

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -1,6 +1,5 @@
 module Rubycritic
   module SourceControlSystem
-
     class Mercurial < Base
       register_system
 
@@ -9,7 +8,7 @@ module Rubycritic
       end
 
       def self.to_s
-        "Mercurial"
+        'Mercurial'
       end
 
       def revisions_count(path)
@@ -24,6 +23,5 @@ module Rubycritic
         false
       end
     end
-
   end
 end

data/lib/rubycritic/source_locator.rb

@@ -1,10 +1,9 @@
-require "pathname"
+require 'pathname'
 
 module Rubycritic
-
   class SourceLocator
-    RUBY_EXTENSION = ".rb"
-    RUBY_FILES = File.join("**", "*#{RUBY_EXTENSION}")
+    RUBY_EXTENSION = '.rb'.freeze
+    RUBY_FILES = File.join('**', "*#{RUBY_EXTENSION}")
 
     def initialize(paths)
       @initial_paths = Array(paths)
@@ -22,9 +21,9 @@ module Rubycritic
 
     def deduplicate_symlinks(path_list)
       # sort the symlinks to the end so files are preferred
-      path_list.sort_by! { |path| File.symlink?(path.cleanpath) ? "z" : "a" }
+      path_list.sort_by! { |path| File.symlink?(path.cleanpath) ? 'z' : 'a' }
       if defined?(JRUBY_VERSION)
-        require "java"
+        require 'java'
         path_list.uniq! do |path|
           java.io.File.new(path.realpath.to_s).canonical_path
         end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "2.6.0"
+  VERSION = '2.7.0'.freeze
 end

data/rubycritic.gemspec

@@ -1,37 +1,38 @@
 # coding: utf-8
-lib = File.expand_path("../lib", __FILE__)
+lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rubycritic/version"
+require 'rubycritic/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rubycritic"
+  spec.name          = 'rubycritic'
   spec.version       = Rubycritic::VERSION
-  spec.authors       = ["Guilherme Simoes"]
-  spec.email         = ["guilherme.rdems@gmail.com"]
-  spec.description   = "RubyCritic is a tool that wraps around various static analysis gems "\
-    "to provide a quality report of your Ruby code."
-  spec.summary       = "RubyCritic is a Ruby code quality reporter"
-  spec.homepage      = "https://github.com/whitesmith/rubycritic"
-  spec.license       = "MIT"
-  spec.required_ruby_version = ">= 2.0.0"
+  spec.authors       = ['Guilherme Simoes']
+  spec.email         = ['guilherme.rdems@gmail.com']
+  spec.description   = 'RubyCritic is a tool that wraps around various static analysis gems '\
+    'to provide a quality report of your Ruby code.'
+  spec.summary       = 'RubyCritic is a Ruby code quality reporter'
+  spec.homepage      = 'https://github.com/whitesmith/rubycritic'
+  spec.license       = 'MIT'
+  spec.required_ruby_version = '>= 2.0.0'
 
   spec.files         = `git ls-files`.split("\n")
   spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.test_files    = `git ls-files -- test/*`.split("\n")
-  spec.require_path  = "lib"
+  spec.require_path  = 'lib'
 
-  spec.add_runtime_dependency "virtus", "~> 1.0"
-  spec.add_runtime_dependency "flay", "2.6.1"
-  spec.add_runtime_dependency "flog", "4.3.2"
-  spec.add_runtime_dependency "reek", "3.8.1"
-  spec.add_runtime_dependency "parser", ">= 2.2.0", "< 3.0"
-  spec.add_runtime_dependency "colorize"
+  spec.add_runtime_dependency 'virtus', '~> 1.0'
+  spec.add_runtime_dependency 'flay', '2.6.1'
+  spec.add_runtime_dependency 'flog', '4.3.2'
+  spec.add_runtime_dependency 'reek', '3.9.1'
+  spec.add_runtime_dependency 'parser', '~> 2.3'
+  spec.add_runtime_dependency 'colorize'
+  spec.add_runtime_dependency 'launchy', '2.4.3'
 
-  spec.add_development_dependency "aruba"
-  spec.add_development_dependency "bundler", "~> 1.3"
-  spec.add_development_dependency "cucumber"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "minitest", "~> 5.3"
-  spec.add_development_dependency "mocha", "~> 1.0"
-  spec.add_development_dependency "rubocop", "0.29.0"
+  spec.add_development_dependency 'aruba'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'cucumber'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'minitest', '~> 5.3'
+  spec.add_development_dependency 'mocha', '~> 1.0'
+  spec.add_development_dependency 'rubocop', '0.36.0'
 end

data/test/analysers_test_helper.rb

@@ -1,3 +1,3 @@
-require "test_helper"
+require 'test_helper'
 
 class AnalysedModuleDouble < OpenStruct; end

data/test/lib/rubycritic/analysers/churn_test.rb

@@ -1,23 +1,23 @@
-require "analysers_test_helper"
-require "rubycritic/analysers/churn"
-require "rubycritic/source_control_systems/base"
+require 'analysers_test_helper'
+require 'rubycritic/analysers/churn'
+require 'rubycritic/source_control_systems/base'
 
 describe Rubycritic::Analyser::Churn do
-  context "when analysing a file" do
+  context 'when analysing a file' do
     before do
-      @analysed_module = AnalysedModuleDouble.new(:path => "path_to_some_file.rb")
+      @analysed_module = AnalysedModuleDouble.new(path: 'path_to_some_file.rb')
       analysed_modules = [@analysed_module]
       analyser = Rubycritic::Analyser::Churn.new(analysed_modules)
       analyser.source_control_system = SourceControlSystemDouble.new
       analyser.run
     end
 
-    it "calculates its churn" do
+    it 'calculates its churn' do
       @analysed_module.churn.must_equal 1
     end
 
-    it "determines the date of its last commit" do
-      @analysed_module.committed_at.must_equal "2013-10-09 12:52:49 +0100"
+    it 'determines the date of its last commit' do
+      @analysed_module.committed_at.must_equal '2013-10-09 12:52:49 +0100'
     end
   end
 end
@@ -28,6 +28,6 @@ class SourceControlSystemDouble < Rubycritic::SourceControlSystem::Base
   end
 
   def date_of_last_commit(_path)
-    "2013-10-09 12:52:49 +0100"
+    '2013-10-09 12:52:49 +0100'
   end
 end

data/test/lib/rubycritic/analysers/complexity_test.rb

@@ -1,15 +1,15 @@
-require "analysers_test_helper"
-require "rubycritic/analysers/complexity"
+require 'analysers_test_helper'
+require 'rubycritic/analysers/complexity'
 
 describe Rubycritic::Analyser::Complexity do
-  context "when analysing a file" do
+  context 'when analysing a file' do
     before do
-      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/complex.rb", :smells => [])
+      @analysed_module = AnalysedModuleDouble.new(path: 'test/samples/flog/complex.rb', smells: [])
       analysed_modules = [@analysed_module]
       Rubycritic::Analyser::Complexity.new(analysed_modules).run
     end
 
-    it "calculates its complexity" do
+    it 'calculates its complexity' do
       @analysed_module.complexity.must_be :>, 0
     end
   end

data/test/lib/rubycritic/analysers/helpers/methods_counter_test.rb

@@ -1,25 +1,25 @@
-require "analysers_test_helper"
-require "rubycritic/analysers/helpers/methods_counter"
+require 'analysers_test_helper'
+require 'rubycritic/analysers/helpers/methods_counter'
 
 describe Rubycritic::MethodsCounter do
-  describe "#count" do
-    context "when a file contains Ruby code" do
-      it "calculates the number of methods" do
-        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/methods_count.rb")
+  describe '#count' do
+    context 'when a file contains Ruby code' do
+      it 'calculates the number of methods' do
+        analysed_module = AnalysedModuleDouble.new(path: 'test/samples/methods_count.rb')
         Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 2
       end
     end
 
-    context "when a file is empty" do
-      it "returns 0 as the number of methods" do
-        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/empty.rb")
+    context 'when a file is empty' do
+      it 'returns 0 as the number of methods' do
+        analysed_module = AnalysedModuleDouble.new(path: 'test/samples/empty.rb')
         Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
       end
     end
 
-    context "when a file is unparsable" do
-      it "does not blow up and returns 0 as the number of methods" do
-        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/unparsable.rb")
+    context 'when a file is unparsable' do
+      it 'does not blow up and returns 0 as the number of methods' do
+        analysed_module = AnalysedModuleDouble.new(path: 'test/samples/unparsable.rb')
         capture_output_streams do
           Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
         end

data/test/lib/rubycritic/analysers/helpers/modules_locator_test.rb

@@ -1,51 +1,51 @@
-require "test_helper"
-require "rubycritic/analysers/helpers/modules_locator"
-require "rubycritic/core/analysed_module"
-require "pathname"
+require 'test_helper'
+require 'rubycritic/analysers/helpers/modules_locator'
+require 'rubycritic/core/analysed_module'
+require 'pathname'
 
 describe Rubycritic::ModulesLocator do
-  describe "#names" do
-    context "when a file contains Ruby code" do
-      it "returns the names of all the classes and modules inside the file" do
+  describe '#names' do
+    context 'when a file contains Ruby code' do
+      it 'returns the names of all the classes and modules inside the file' do
         analysed_module = Rubycritic::AnalysedModule.new(
-          :pathname => Pathname.new("test/samples/module_names.rb"),
-          :methods_count => 1
+          pathname: Pathname.new('test/samples/module_names.rb'),
+          methods_count: 1
         )
         Rubycritic::ModulesLocator.new(analysed_module).names
-          .must_equal ["Foo", "Foo::Bar", "Foo::Baz", "Foo::Qux", "Foo::Quux::Corge"]
+                                  .must_equal ['Foo', 'Foo::Bar', 'Foo::Baz', 'Foo::Qux', 'Foo::Quux::Corge']
       end
     end
 
-    context "when a file is empty" do
-      it "returns the name of the file titleized" do
+    context 'when a file is empty' do
+      it 'returns the name of the file titleized' do
         analysed_module = Rubycritic::AnalysedModule.new(
-          :pathname => Pathname.new("test/samples/empty.rb"),
-          :methods_count => 1
+          pathname: Pathname.new('test/samples/empty.rb'),
+          methods_count: 1
         )
-        Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Empty"]
+        Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ['Empty']
       end
     end
 
-    context "when a file is unparsable" do
-      it "does not blow up and returns the name of the file titleized" do
+    context 'when a file is unparsable' do
+      it 'does not blow up and returns the name of the file titleized' do
         analysed_module = Rubycritic::AnalysedModule.new(
-          :pathname => Pathname.new("test/samples/unparsable.rb"),
-          :methods_count => 1
+          pathname: Pathname.new('test/samples/unparsable.rb'),
+          methods_count: 1
         )
         capture_output_streams do
-          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Unparsable"]
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ['Unparsable']
         end
       end
     end
 
-    context "when a file has no methods" do
-      it "returns the names of all the classes and modules inside the file" do
+    context 'when a file has no methods' do
+      it 'returns the names of all the classes and modules inside the file' do
         analysed_module = Rubycritic::AnalysedModule.new(
-          :pathname => Pathname.new("test/samples/no_methods.rb"),
-          :methods_count => 0
+          pathname: Pathname.new('test/samples/no_methods.rb'),
+          methods_count: 0
         )
         capture_output_streams do
-          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Foo::NoMethods"]
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ['Foo::NoMethods']
         end
       end
     end