rubycritic 3.4.0 → 3.5.0

data/features/command_line_interface/minimum_score.feature

@@ -1,39 +0,0 @@
-Feature: Break if overall score is below minimum
-  In order to break the Continuous Integration builds based on a score threshold
-  RubyCritic returns the exit status according with the score
-
-  Scenario: Status indicates a success when not using --minimum-score
-    Given the smelly file 'smelly.rb' with a score of 93.19
-    When I run rubycritic smelly.rb
-    Then the exit status indicates a success
-
-  Scenario: Status indicates an error when score below the minimum
-    Given the smelly file 'smelly.rb' with a score of 93.19
-    When I run rubycritic --minimum-score 100 smelly.rb
-    Then the exit status indicates an error
-
-  Scenario: Status indicates a success when score is above the minimum
-    Given the smelly file 'smelly.rb' with a score of 93.19
-    When I run rubycritic --minimum-score 93 smelly.rb
-    Then the exit status indicates a success
-
-  Scenario: Status indicates a success when score is equal the minimum
-    Given the clean file 'clean.rb' with a score of 100
-    When I run rubycritic --minimum-score 100 clean.rb
-    Then the exit status indicates a success
-
-  Scenario: Prints the score on output
-    Given the smelly file 'smelly.rb' with a score of 93.19
-    When I run rubycritic smelly.rb
-    Then the output should contain:
-    """
-    Score: 93.19
-    """
-
-  Scenario: Prints a message informing the score is below the minimum
-    Given the empty file 'empty.rb' with a score of 0
-    When I run rubycritic --minimum-score 100 empty.rb
-    Then the output should contain:
-    """
-    Score (0.0) is below the minimum 100
-    """

data/features/command_line_interface/options.feature

@@ -1,37 +0,0 @@
-Feature: RubyCritic can be controlled using command-line options
-  In order to change RubyCritic's default behaviour
-  As a developer
-  I want to supply options on the command line
-
-  Scenario: return non-zero status on bad option
-    When I run rubycritic --no-such-option
-    Then the exit status indicates an error
-    And it reports the error "Error: invalid option: --no-such-option"
-    And there is no output on stdout
-
-  Scenario: display the current version number
-    When I run rubycritic --version
-    Then it succeeds
-    And it reports the current version
-
-  Scenario: display the help information
-    When I run rubycritic --help
-    Then it succeeds
-    And it reports:
-      """
-      Usage: rubycritic [options] [paths]
-          -p, --path [PATH]                Set path where report will be saved (tmp/rubycritic by default)
-          -f, --format [FORMAT]            Report smells in the given format:
-                                             html (default; will open in a browser)
-                                             json
-                                             console
-                                             lint
-          -s, --minimum-score [MIN_SCORE]  Set a minimum score
-          -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/rake_task.feature

@@ -1,65 +0,0 @@
-Feature: RubyCritic can be run via Rake task
-  In order to allow for a better CI usage
-  As a developer
-  I want to use RubyCritic as a Rake task
-
-  Scenario: ‘paths' attribute is respected
-    Given the smelly file 'smelly.rb'
-    When I run rake rubycritic with:
-      """
-      RubyCritic::RakeTask.new do |t|
-        t.paths = FileList['smelly.*']
-        t.options = '--no-browser -f console'
-      end
-      """
-    Then the output should contain:
-      """
-      (HighComplexity) AllTheMethods#method_missing has a flog score of 27
-      """
-    And the exit status indicates a success
-
-  Scenario: 'name' option changes the task name
-    Given the smelly file 'smelly.rb'
-    When I run rake silky with:
-      """
-      RubyCritic::RakeTask.new('silky') do |t|
-        t.paths = FileList['smelly.*']
-        t.verbose = true
-        t.options = '--no-browser'
-      end
-      """
-    Then the output should contain:
-      """
-      Running `silky` rake command
-      """
-
-  Scenario: 'verbose' prints details about the execution
-    Given the smelly file 'smelly.rb'
-    When I run rake rubycritic with:
-      """
-      RubyCritic::RakeTask.new do |t|
-        t.paths = FileList['smelly.*']
-        t.verbose = true
-        t.options = '--no-browser'
-      end
-      """
-    Then the output should contain:
-      """
-      !!! Running `rubycritic` rake command
-      !!! Inspecting smelly.rb with options --no-browser
-      """
-
-  Scenario: respect --minimum-score
-    Given the smelly file 'smelly.rb'
-    When I run rake rubycritic with:
-      """
-      RubyCritic::RakeTask.new do |t|
-        t.paths = FileList['smelly.*']
-        t.verbose = true
-        t.options = '--no-browser -f console --minimum-score 95'
-      end
-      """
-    Then the output should contain:
-      """
-      Score (93.19) is below the minimum 95
-      """

data/features/step_definitions/rake_task_steps.rb

@@ -1,5 +0,0 @@
-# frozen_string_literal: true
-
-When(/^I run rake (\w*) with:$/) do |name, task_def|
-  rake(name, task_def)
-end

data/features/step_definitions/rubycritic_steps.rb

@@ -1,33 +0,0 @@
-# frozen_string_literal: true
-
-When(/^I run rubycritic (.*)$/) do |args|
-  rubycritic(args)
-end
-
-Then(/^the exit status indicates an error$/) do
-  expect(last_command_started).to have_exit_status(RubyCritic::Command::StatusReporter::SCORE_BELOW_MINIMUM)
-end
-
-Then(/^the exit status indicates a success$/) do
-  expect(last_command_started).to have_exit_status(RubyCritic::Command::StatusReporter::SUCCESS)
-end
-
-Then(/^it reports:$/) do |report|
-  expect(last_command_started).to have_output_on_stdout(report.gsub('\n', "\n"))
-end
-
-Then(/^there is no output on stdout$/) do
-  expect(last_command_started).to have_output_on_stdout('')
-end
-
-Then(/^it reports the current version$/) do
-  expect(last_command_started).to have_output("RubyCritic #{RubyCritic::VERSION}\n")
-end
-
-Then(/^it reports the error ['"](.*)['"]$/) do |string|
-  expect(last_command_started).to have_output_on_stderr(/#{Regexp.escape(string)}/)
-end
-
-Then(/^it succeeds$/) do
-  expect(last_command_started).to have_exit_status(RubyCritic::Command::StatusReporter::SUCCESS)
-end

data/features/step_definitions/sample_file_steps.rb

@@ -1,32 +0,0 @@
-# frozen_string_literal: true
-
-Given(/^the smelly file 'smelly.rb'/) do
-  contents = <<-RUBY.strip_heredoc
-    class AllTheMethods
-      def method_missing(method, *args, &block)
-        message = "I"
-        eval "message = ' did not'"
-        eval "message << ' exist,'"
-        eval "message << ' but now'"
-        eval "message << ' I do.'"
-        self.class.send(:define_method, method) { "I did not exist, but now I do." }
-        self.send(method)
-      end
-    end
-  RUBY
-  write_file('smelly.rb', contents)
-end
-
-Given(/^the clean file 'clean.rb'/) do
-  contents = <<-RUBY.strip_heredoc
-    # Explanatory comment
-    class Clean
-      def foo; end
-    end
-  RUBY
-  write_file('clean.rb', contents)
-end
-
-Given(/^the empty file 'empty.rb'/) do
-  write_file('clean.rb', '')
-end

data/features/support/env.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-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.
-#
-class RubyCriticWorld
-  extend MiniTest::Assertions
-  attr_accessor :assertions
-
-  def initialize
-    self.assertions = 0
-  end
-
-  def rubycritic(args)
-    run_simple("rubycritic #{args}  --no-browser", false)
-  end
-
-  def rake(name, task_def)
-    header = <<-RUBY.strip_heredoc
-      require 'rubycritic'
-      require 'rubycritic/rake_task'
-
-    RUBY
-    write_file 'Rakefile', header + task_def
-    run_simple("rake #{name}", false)
-  end
-end
-
-World do
-  RubyCriticWorld.new
-end
-
-Before do
-  Aruba.configure do |config|
-    config.exit_timeout = 30
-  end
-end

data/rubycritic.gemspec

@@ -1,45 +0,0 @@
-# frozen_string_literal: true
-
-lib = File.expand_path('lib', __dir__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'rubycritic/version'
-
-Gem::Specification.new do |spec|
-  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.1.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.add_runtime_dependency 'flay', '~> 2.8'
-  spec.add_runtime_dependency 'flog', '~> 4.4'
-  spec.add_runtime_dependency 'launchy', '2.4.3'
-  spec.add_runtime_dependency 'parser', '~> 2.5.0'
-  spec.add_runtime_dependency 'rainbow', '~> 3.0'
-  spec.add_runtime_dependency 'reek', '~> 4.4'
-  spec.add_runtime_dependency 'ruby_parser', '~> 3.8'
-  spec.add_runtime_dependency 'tty-which', '~> 0.3.0'
-  spec.add_runtime_dependency 'virtus', '~> 1.0'
-
-  spec.add_development_dependency 'aruba', '~> 0.12', '>= 0.12.0'
-  spec.add_development_dependency 'bundler', '~> 1.3', '>= 1.3.0'
-  spec.add_development_dependency 'byebug', '~> 9.0', '>= 8.0'
-  spec.add_development_dependency 'cucumber', '~> 3.0', '>= 2.2.0'
-  spec.add_development_dependency 'diff-lcs', '~> 1.3'
-  spec.add_development_dependency 'fakefs', '~> 0.10', '>= 0.10.0'
-  spec.add_development_dependency 'minitest', '~> 5.3', '>= 5.3.0'
-  spec.add_development_dependency 'minitest-around', '~> 0.4.0'
-  spec.add_development_dependency 'mocha', '~> 1.1', '>= 1.1.0'
-  spec.add_development_dependency 'rake', '~> 12.0', '>= 11.0.0'
-  spec.add_development_dependency 'rubocop', '~> 0.53'
-end

data/test/analysers_test_helper.rb

@@ -1,12 +0,0 @@
-# frozen_string_literal: true
-
-require 'test_helper'
-
-class AnalysedModuleDouble < OpenStruct; end
-
-require_relative '../lib/rubycritic/core/analysed_modules_collection'
-class AnalysedModulesCollectionDouble < RubyCritic::AnalysedModulesCollection
-  def initialize(module_doubles)
-    @modules = module_doubles
-  end
-end

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

@@ -1,35 +0,0 @@
-# frozen_string_literal: true
-
-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
-    before do
-      @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
-      @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'
-    end
-  end
-end
-
-class SourceControlSystemDouble < RubyCritic::SourceControlSystem::Base
-  def revisions_count(_path)
-    1 # churn
-  end
-
-  def date_of_last_commit(_path)
-    '2013-10-09 12:52:49 +0100'
-  end
-end

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

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-require 'analysers_test_helper'
-require 'rubycritic/analysers/complexity'
-
-describe RubyCritic::Analyser::Complexity do
-  context 'when analysing a file' do
-    before do
-      @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
-      @analysed_module.complexity.must_be :>, 0
-    end
-  end
-end

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-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')
-        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')
-        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')
-        capture_output_streams do
-          RubyCritic::MethodsCounter.new(analysed_module).count.must_equal 0
-        end
-      end
-    end
-  end
-end

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

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-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
-        analysed_module = RubyCritic::AnalysedModule.new(
-          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']
-      end
-    end
-
-    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
-        )
-        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
-        analysed_module = RubyCritic::AnalysedModule.new(
-          pathname: Pathname.new('test/samples/unparsable.rb'),
-          methods_count: 1
-        )
-        capture_output_streams do
-          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
-        analysed_module = RubyCritic::AnalysedModule.new(
-          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']
-        end
-      end
-    end
-  end
-end