rubycritic 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5adb91703b4aa88b8328579edf0f7c085641db2d
-  data.tar.gz: 64b6f7e6ea46022ab9a585cc77badb21d1a350d2
+  metadata.gz: 63f7b195fa4fd7ee15061bdfc41a49f7031e1c6a
+  data.tar.gz: bc1b0a3185d7387223aea5467eb62ab1ba93ce9d
 SHA512:
-  metadata.gz: 60f3072ea06df5f44c7e609c6e130e65034d07e88a3a03b0aaa50f7542887a0054781aa9c0652945c16420ba3786cd3e3b830164e1cf654e72efdc8c6feaf750
-  data.tar.gz: beaecb13950c18aa46dd3482ac62da1136caaad868bc451bfc28a46a5c9d8f9329e03f43ad81b2de5a77b0bf722bb5d5bf8deca97040a52def39d855c333d9a2
+  metadata.gz: a5d3d4dc64f42b8b28650dd3c182633aa7e9e3f153a48f2315ead8969c79d1c99775975d23ca9236ba1a423f4db0073af35b0e96413abf780e7e4c07c9f57b7c
+  data.tar.gz: 27e3289f5e5629763e8bcbd505738f3c8cf5d6a9ffae6f8cff1e6cec2a92837170805f5eeee85abd3a491a16458ff0cab0e090cfe0d9d20ff81020d8648738fc

data/.rubocop.yml

@@ -6,6 +6,7 @@ AllCops:
     - '**/Rakefile'
   Exclude:
     - 'test/samples/**/*'
+    - 'tmp/**/*'
   # By default, the rails cops are not run. Override in project or home
   # directory .rubocop.yml files, or by giving the -R/--rails option.
   RunRailsCops: false

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 2.6.0 / 2015-01-21
+
+* [FEATURE] Add a minimum score option to the command line interface (by Roberto Schneider)
+* [CHANGE] Display the class and module names when the file has no methods
+
 # 2.5.0 / 2015-01-16
 
 * [FEATURE] Add a ConsoleReport format (by Josh Bodah)

data/README.md

@@ -96,6 +96,7 @@ $ rubycritic --help
 |--------------------------|-------------------------------------------------------|
 | `-v/--version`           | Displays the current version and exits                |
 | `-p/--path`              | Sets the output directory (tmp/rubycritic by default) |
+| `-s/--minimum-score`     | Set a minimum score                                   |
 | `--mode-ci`              | Uses CI mode (faster, but only analyses last commit)  |
 | `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
 | `--suppress-ratings`     | Suppress letter ratings                               |

data/Rakefile

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

data/features/command_line_interface/minimum_score.feature

@@ -0,0 +1,39 @@
+Feature: Break if overall score is bellow 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.75
+    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.75
+    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.75
+    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.75
+    When I run rubycritic smelly.rb
+    Then the output should contain:
+    """
+    Score: 93.75
+    """
+
+  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

@@ -0,0 +1,35 @@
+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)
+                                             json
+                                             console
+          -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
+          -v, --version                    Show gem's version
+          -h, --help                       Show this message
+
+      """

data/features/step_definitions/rubycritic_steps.rb

@@ -0,0 +1,31 @@
+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

@@ -0,0 +1,30 @@
+Given(/^the smelly file 'smelly.rb'/) do
+  contents = <<-EOS.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
+  EOS
+  write_file("smelly.rb", contents)
+end
+
+Given(/^the clean file 'clean.rb'/) do
+  contents = <<-EOS.strip_heredoc
+    # Explanatory comment
+    class Clean
+      def foo; end
+    end
+  EOS
+  write_file("clean.rb", contents)
+end
+
+Given(/^the empty file 'empty.rb'/) do
+  write_file("clean.rb", "")
+end

data/features/support/env.rb

@@ -0,0 +1,31 @@
+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}", false)
+  end
+end
+
+World do
+  RubycriticWorld.new
+end
+
+Before do
+  Aruba.configure do |config|
+    config.exit_timeout = 30
+  end
+end

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

@@ -12,7 +12,6 @@ module Rubycritic
     end
 
     def names
-      return name_from_path if @analysed_module.methods_count == 0
       names = node.get_module_names
       if names.empty?
         name_from_path

data/lib/rubycritic/cli/application.rb

@@ -14,12 +14,18 @@ module Rubycritic
 
       def execute
         parsed_options = @options.parse
-        ::Rubycritic::CommandFactory.create(parsed_options).execute
-        STATUS_SUCCESS
+
+        reporter = Rubycritic::CommandFactory.create(parsed_options.to_h).execute
+        print(reporter.status_message)
+        reporter.status
       rescue OptionParser::InvalidOption => error
         $stderr.puts "Error: #{error}"
         STATUS_ERROR
       end
+
+      def print(message)
+        $stdout.puts message
+      end
     end
   end
 end

data/lib/rubycritic/cli/options.rb

@@ -28,6 +28,10 @@ module Rubycritic
             @format = format
           end
 
+          opts.on("-s", "--minimum-score [MIN_SCORE]", "Set a minimum score") do |min_score|
+            @minimum_score = Integer(min_score)
+          end
+
           opts.on("-m", "--mode-ci", "Use CI mode (faster, but only analyses last commit)") do
             @mode = :ci
           end
@@ -51,10 +55,6 @@ module Rubycritic
         self
       end
 
-      def help_text
-        @parser.help
-      end
-
       def to_h
         {
           :mode => @mode,
@@ -62,7 +62,9 @@ module Rubycritic
           :format => @format,
           :deduplicate_symlinks => @deduplicate_symlinks,
           :paths => paths,
-          :suppress_ratings => @suppress_ratings
+          :suppress_ratings => @suppress_ratings,
+          :help_text => @parser.help,
+          :minimum_score => @minimum_score || 0
         }
       end
 

data/lib/rubycritic/command_factory.rb

@@ -3,21 +3,24 @@ require "rubycritic/configuration"
 module Rubycritic
   class CommandFactory
     def self.create(options = {})
-      options_hash = options.to_h
-      Config.set(options_hash)
-      case Config.mode
+      Config.set(options)
+      command_class(Config.mode).new(options)
+    end
+
+    def self.command_class(mode)
+      case mode
       when :version
         require "rubycritic/commands/version"
-        Command::Version.new
+        Command::Version
       when :help
         require "rubycritic/commands/help"
-        Command::Help.new(options.help_text)
+        Command::Help
       when :ci
         require "rubycritic/commands/ci"
-        Command::Ci.new(options_hash[:paths])
+        Command::Ci
       else
         require "rubycritic/commands/default"
-        Command::Default.new(options_hash[:paths])
+        Command::Default
       end
     end
   end

data/lib/rubycritic/commands/base.rb

@@ -0,0 +1,16 @@
+require "rubycritic/commands/status_reporter"
+
+module Rubycritic
+  module Command
+    class Base
+      def initialize(options)
+        @options = options
+        @status_reporter = Rubycritic::Command::StatusReporter.new(@options)
+      end
+
+      def execute
+        raise NotImplementedError
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/ci.rb

@@ -1,26 +1,14 @@
 require "rubycritic/source_control_systems/base"
 require "rubycritic/analysers_runner"
 require "rubycritic/reporter"
+require "rubycritic/commands/default"
 
 module Rubycritic
   module Command
-    class Ci
-      def initialize(paths)
-        @paths = paths
-        Config.source_control_system = SourceControlSystem::Base.create
-      end
-
-      def execute
-        report(critique)
-      end
-
+    class Ci < Default
       def critique
         AnalysersRunner.new(@paths).run
       end
-
-      def report(analysed_modules)
-        Reporter.generate_report(analysed_modules)
-      end
     end
   end
 end

data/lib/rubycritic/commands/default.rb

@@ -2,17 +2,20 @@ require "rubycritic/source_control_systems/base"
 require "rubycritic/analysers_runner"
 require "rubycritic/revision_comparator"
 require "rubycritic/reporter"
+require "rubycritic/commands/base"
 
 module Rubycritic
   module Command
-    class Default
-      def initialize(paths)
-        @paths = paths
+    class Default < Base
+      def initialize(options)
+        super
+        @paths = options[:paths]
         Config.source_control_system = SourceControlSystem::Base.create
       end
 
       def execute
         report(critique)
+        @status_reporter
       end
 
       def critique
@@ -22,6 +25,7 @@ module Rubycritic
 
       def report(analysed_modules)
         Reporter.generate_report(analysed_modules)
+        @status_reporter.score = analysed_modules.score
       end
     end
   end

data/lib/rubycritic/commands/help.rb

@@ -1,12 +1,11 @@
+require "rubycritic/commands/base"
+
 module Rubycritic
   module Command
-    class Help
-      def initialize(help_text)
-        @help_text = help_text
-      end
-
+    class Help < Base
       def execute
-        puts @help_text
+        puts @options[:help_text]
+        @status_reporter
       end
     end
   end

data/lib/rubycritic/commands/status_reporter.rb

@@ -0,0 +1,43 @@
+module Rubycritic
+  module Command
+    class StatusReporter
+      attr_reader :status, :status_message
+      SUCCESS = 0
+      SCORE_BELOW_MINIMUM = 1
+
+      def initialize(options)
+        @options = options
+        @status = SUCCESS
+      end
+
+      def score=(score)
+        @score = score
+        update_status
+      end
+
+      private
+
+      def update_status
+        @status = current_status
+        update_status_message
+      end
+
+      def current_status
+        satisfy_minimum_score_rule ? SUCCESS : SCORE_BELOW_MINIMUM
+      end
+
+      def satisfy_minimum_score_rule
+        @score >= @options[:minimum_score]
+      end
+
+      def update_status_message
+        case @status
+        when SUCCESS
+          @status_message = "Score: #{@score}"
+        when SCORE_BELOW_MINIMUM
+          @status_message = "Score (#{@score}) is below the minimum #{@options[:minimum_score]}"
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/commands/version.rb

@@ -1,10 +1,12 @@
 require "rubycritic/version"
+require "rubycritic/commands/base"
 
 module Rubycritic
   module Command
-    class Version
+    class Version < Base
       def execute
         puts "RubyCritic #{VERSION}"
+        @status_reporter
       end
     end
   end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "2.5.0"
+  VERSION = "2.6.0"
 end

data/rubycritic.gemspec

@@ -27,7 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "parser", ">= 2.2.0", "< 3.0"
   spec.add_runtime_dependency "colorize"
 
+  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"

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

@@ -39,13 +39,13 @@ describe Rubycritic::ModulesLocator do
     end
 
     context "when a file has no methods" do
-      it "returns the name of the file titleized" 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 ["NoMethods"]
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Foo::NoMethods"]
         end
       end
     end

data/test/lib/rubycritic/commands/status_reporter_test.rb

@@ -0,0 +1,67 @@
+require "test_helper"
+require "rubycritic/commands/status_reporter"
+require "rubycritic/cli/options"
+
+describe Rubycritic::Command::StatusReporter do
+  let(:success_status) { Rubycritic::Command::StatusReporter::SUCCESS }
+  let(:score_below_minimum) { Rubycritic::Command::StatusReporter::SCORE_BELOW_MINIMUM }
+
+  describe "with default options" do
+    before do
+      @options = Rubycritic::Cli::Options.new([])
+      @options.parse
+      @reporter = Rubycritic::Command::StatusReporter.new(@options.to_h)
+    end
+
+    it "has a default" do
+      @reporter.status.must_equal success_status
+      @reporter.status_message.must_be_nil
+    end
+
+    it "accept a score" do
+      @reporter.score = 50
+      @reporter.status.must_equal success_status
+      @reporter.status_message.must_equal "Score: 50"
+    end
+  end
+
+  describe "with minimum-score option" do
+    before do
+      @options = Rubycritic::Cli::Options.new(["-s", "99"])
+      @options.parse
+      @reporter = Rubycritic::Command::StatusReporter.new(@options.to_h)
+    end
+
+    it "has a default" do
+      @reporter.status.must_equal success_status
+      @reporter.status_message.must_be_nil
+    end
+
+    describe "when score is below minimum" do
+      let(:score) { 98 }
+      it "should return the correct status" do
+        @reporter.score = score
+        @reporter.status.must_equal score_below_minimum
+        @reporter.status_message.must_equal "Score (98) is below the minimum 99"
+      end
+    end
+
+    describe "when score is equal the minimum" do
+      let(:score) { 99 }
+      it "should return the correct status" do
+        @reporter.score = score
+        @reporter.status.must_equal success_status
+        @reporter.status_message.must_equal "Score: 99"
+      end
+    end
+
+    describe "when score is above the minimum" do
+      let(:score) { 100 }
+      it "should return the correct status" do
+        @reporter.score = score
+        @reporter.status.must_equal success_status
+        @reporter.status_message.must_equal "Score: 100"
+      end
+    end
+  end
+end

data/test/lib/rubycritic/core/analysed_modules_collection_test.rb

@@ -26,7 +26,7 @@ describe Rubycritic::AnalysedModulesCollection do
       let(:paths) { "test/samples/" }
 
       it "recursively registers all files" do
-        subject.count.must_equal 13
+        subject.count.must_equal Dir["test/samples/**/*.rb"].count
       end
     end
 

data/test/samples/no_methods.rb

@@ -0,0 +1,4 @@
+module Foo
+  class NoMethods
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-18 00:00:00.000000000 Z
+date: 2016-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -100,6 +100,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -114,6 +128,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -189,6 +217,11 @@ files:
 - README.md
 - Rakefile
 - bin/rubycritic
+- features/command_line_interface/minimum_score.feature
+- features/command_line_interface/options.feature
+- features/step_definitions/rubycritic_steps.rb
+- features/step_definitions/sample_file_steps.rb
+- features/support/env.rb
 - lib/rubycritic.rb
 - lib/rubycritic/analysers/attributes.rb
 - lib/rubycritic/analysers/churn.rb
@@ -208,9 +241,11 @@ files:
 - lib/rubycritic/cli/options.rb
 - lib/rubycritic/colorize.rb
 - lib/rubycritic/command_factory.rb
+- lib/rubycritic/commands/base.rb
 - lib/rubycritic/commands/ci.rb
 - lib/rubycritic/commands/default.rb
 - lib/rubycritic/commands/help.rb
+- lib/rubycritic/commands/status_reporter.rb
 - lib/rubycritic/commands/version.rb
 - lib/rubycritic/configuration.rb
 - lib/rubycritic/core/analysed_module.rb
@@ -268,6 +303,7 @@ files:
 - 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/commands/status_reporter_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_module_test.rb
 - test/lib/rubycritic/core/analysed_modules_collection_test.rb
@@ -298,6 +334,7 @@ files:
 - test/samples/location/file_with_no_extension
 - test/samples/methods_count.rb
 - test/samples/module_names.rb
+- test/samples/no_methods.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
 - test/samples/unparsable.rb
@@ -335,6 +372,7 @@ test_files:
 - 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/commands/status_reporter_test.rb
 - test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/core/analysed_module_test.rb
 - test/lib/rubycritic/core/analysed_modules_collection_test.rb
@@ -365,6 +403,7 @@ test_files:
 - test/samples/location/file_with_no_extension
 - test/samples/methods_count.rb
 - test/samples/module_names.rb
+- test/samples/no_methods.rb
 - test/samples/reek/not_smelly.rb
 - test/samples/reek/smelly.rb
 - test/samples/unparsable.rb