rubycritic 2.4.1 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 94afa6a36845ed427f723017ab3ae8c1dbb1bf45
-  data.tar.gz: 76b2b5a795e9c0f4a64c612211f0dda8c23058b5
+  metadata.gz: 5adb91703b4aa88b8328579edf0f7c085641db2d
+  data.tar.gz: 64b6f7e6ea46022ab9a585cc77badb21d1a350d2
 SHA512:
-  metadata.gz: 83dc3bddc791df06b118ebce1a51a7aec17f4f524736dd80c8ee2f37bcd29df7b44221ea3f32a1a00efb605ab9e3e3984143c84be117d7102b7a88e9a4c2213d
-  data.tar.gz: 13f1c532c8c0586d4791ffdae390666388a88889bbb436c8d86a16964932baf66fd39e338adcb2bf0a3b9b85990f0891a26c795a8aa1ce7732418430a37393d1
+  metadata.gz: 60f3072ea06df5f44c7e609c6e130e65034d07e88a3a03b0aaa50f7542887a0054781aa9c0652945c16420ba3786cd3e3b830164e1cf654e72efdc8c6feaf750
+  data.tar.gz: beaecb13950c18aa46dd3482ac62da1136caaad868bc451bfc28a46a5c9d8f9329e03f43ad81b2de5a77b0bf722bb5d5bf8deca97040a52def39d855c333d9a2

data/.travis.yml

@@ -13,4 +13,5 @@ matrix:
     - rvm: jruby
   fast_finish: true
 
+before_install: "gem update bundler"
 script: "bundle exec rake"

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 2.5.0 / 2015-01-16
+
+* [FEATURE] Add a ConsoleReport format (by Josh Bodah)
+
 # 2.4.1 / 2015-12-27
 
 * [CHANGE] Bump Reek to 3.8.1

data/lib/rubycritic.rb

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

data/lib/rubycritic/cli/application.rb

@@ -1,5 +1,6 @@
 require "rubycritic"
 require "rubycritic/cli/options"
+require "rubycritic/command_factory"
 
 module Rubycritic
   module Cli
@@ -13,7 +14,7 @@ module Rubycritic
 
       def execute
         parsed_options = @options.parse
-        ::Rubycritic.create(parsed_options).execute
+        ::Rubycritic::CommandFactory.create(parsed_options).execute
         STATUS_SUCCESS
       rescue OptionParser::InvalidOption => error
         $stderr.puts "Error: #{error}"

data/lib/rubycritic/cli/options.rb

@@ -19,10 +19,11 @@ module Rubycritic
 
           opts.on(
             "-f", "--format [FORMAT]",
-            [:html, :json],
+            [:html, :json, :console],
             "Report smells in the given format:",
             "  html (default)",
-            "  json"
+            "  json",
+            "  console"
           ) do |format|
             @format = format
           end

data/lib/rubycritic/command_factory.rb

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

data/lib/rubycritic/core/analysed_module.rb

@@ -43,6 +43,10 @@ module Rubycritic
       smells.select { |smell| smell.at_location?(location) }
     end
 
+    def <=>(other)
+      [rating.to_s, name] <=> [other.rating.to_s, other.name]
+    end
+
     def to_h
       {
         :name => name,

data/lib/rubycritic/core/smell.rb

@@ -8,7 +8,7 @@ module Rubycritic
 
     attribute :context
     attribute :cost
-    attribute :locations
+    attribute :locations, Array, :default => []
     attribute :message
     attribute :score
     attribute :status

data/lib/rubycritic/generators/console_report.rb

@@ -0,0 +1,18 @@
+require "rubycritic/generators/text/list"
+
+module Rubycritic
+  module Generator
+    class ConsoleReport
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def generate_report
+        reports = @analysed_modules.sort.map do |mod|
+          Text::List.new(mod).render
+        end
+        puts reports.join("\n")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+require "colorize"
+
+module Rubycritic
+  module Generator
+    module Text
+      class List
+        class << self
+          TEMPLATE_PATH = File.expand_path("../templates/list.erb", __FILE__)
+
+          def erb_template
+            @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
+        }
+
+        def initialize(analysed_module)
+          @analysed_module = analysed_module
+        end
+
+        def render
+          erb_template.result(binding)
+        end
+
+        private
+
+        def erb_template
+          self.class.erb_template
+        end
+
+        def color
+          @color ||= RATING_TO_COLOR[@analysed_module.rating.to_s]
+        end
+      end
+    end
+  end
+end

data/lib/rubycritic/generators/text/templates/list.erb

@@ -0,0 +1,12 @@
+<%= @analysed_module.name.colorize(color) %>:
+  Rating:       <%= @analysed_module.rating.to_s.colorize(color) %>
+  Churn:        <%= @analysed_module.churn %>
+  Complexity:   <%= @analysed_module.complexity %>
+  Duplication:  <%= @analysed_module.duplication %>
+  Smells:       <%= @analysed_module.smells.count %>
+<%- @analysed_module.smells.each do |smell| -%>
+    * <%= smell %>
+  <%- smell.locations.each do |location| -%>
+      - <%= location %>
+  <%- end -%>
+<%- end -%>

data/lib/rubycritic/reporter.rb

@@ -10,6 +10,9 @@ module Rubycritic
       when :json
         require "rubycritic/generators/json_report"
         Generator::JsonReport
+      when :console
+        require "rubycritic/generators/console_report"
+        Generator::ConsoleReport
       else
         require "rubycritic/generators/html_report"
         Generator::HtmlReport

data/lib/rubycritic/version.rb

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

data/rubycritic.gemspec

@@ -25,6 +25,7 @@ Gem::Specification.new do |spec|
   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_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/lib/rubycritic/generators/console_report_test.rb

@@ -0,0 +1,81 @@
+require "test_helper"
+require "rubycritic/generators/console_report"
+require "rubycritic/core/rating"
+require "rubycritic/core/smell"
+
+describe Rubycritic::Generator::ConsoleReport do
+  describe "#generate_report" do
+    before do
+      @mock_analysed_module = mock_analysed_module
+      capture_output_streams do
+        report = Rubycritic::Generator::ConsoleReport.new([@mock_analysed_module])
+        report.generate_report
+        @output = $stdout.tap(&:rewind).read
+      end
+    end
+
+    it "outputs the report to the stdout" do
+      assert @output.size > 0, "expected report to be output to stdout"
+    end
+
+    it "starts the report with the module's name" do
+      lines = @output.split("\n")
+      assert lines[0][/#{mock_analysed_module.name}/]
+    end
+
+    it "includes the module's rating in the report" do
+      assert output_contains?("Rating", @mock_analysed_module.rating)
+    end
+
+    it "includes the module's rating in the report" do
+      assert output_contains?("Churn", @mock_analysed_module.churn)
+    end
+
+    it "includes the module's rating in the report" do
+      assert output_contains?("Complexity", @mock_analysed_module.complexity)
+    end
+
+    it "includes the module's rating in the report" do
+      assert output_contains?("Duplication", @mock_analysed_module.duplication)
+    end
+
+    it "includes the number of smells in the report" do
+      assert output_contains?("Smells", @mock_analysed_module.smells.count)
+    end
+
+    it "includes the smell and its attributes in the report" do
+      @mock_analysed_module.smells.each do |smell|
+        assert output_contains?(smell), "expected smell type and context to be reported"
+        smell.locations.each do |location|
+          assert output_contains?(location), "expected all smell locations to be reported"
+        end
+      end
+    end
+
+    def output_contains?(*strs)
+      @lines ||= @output.split("\n")
+      expr = strs.map(&:to_s).map! { |s| Regexp.escape(s) }.join(".*")
+      @lines.any? { |l| l[/#{expr}/] }
+    end
+
+    def mock_analysed_module
+      OpenStruct.new(
+        :name         => "TestModule",
+        :rating       => Rubycritic::Rating.from_cost(3),
+        :churn        => 10,
+        :complexity   => 0,
+        :duplication  => 20,
+        :smells       => [mock_smell]
+      )
+    end
+
+    def mock_smell
+      smell = Rubycritic::Smell.new
+      smell.locations << Rubycritic::Location.new(__FILE__, 3)
+      smell.type = "SmellySmell"
+      smell.context = "You"
+      smell.message = "Seriously, take a shower or something"
+      smell
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 2.4.1
+  version: 2.5.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -86,6 +86,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  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
@@ -193,6 +207,7 @@ files:
 - lib/rubycritic/cli/application.rb
 - lib/rubycritic/cli/options.rb
 - lib/rubycritic/colorize.rb
+- lib/rubycritic/command_factory.rb
 - lib/rubycritic/commands/ci.rb
 - lib/rubycritic/commands/default.rb
 - lib/rubycritic/commands/help.rb
@@ -203,6 +218,7 @@ files:
 - lib/rubycritic/core/location.rb
 - lib/rubycritic/core/rating.rb
 - lib/rubycritic/core/smell.rb
+- lib/rubycritic/generators/console_report.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
@@ -231,6 +247,8 @@ files:
 - lib/rubycritic/generators/html_report.rb
 - lib/rubycritic/generators/json/simple.rb
 - lib/rubycritic/generators/json_report.rb
+- lib/rubycritic/generators/text/list.rb
+- lib/rubycritic/generators/text/templates/list.erb
 - lib/rubycritic/reporter.rb
 - lib/rubycritic/revision_comparator.rb
 - lib/rubycritic/serializer.rb
@@ -256,8 +274,9 @@ files:
 - 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/generators/console_report_test.rb
+- test/lib/rubycritic/generators/turbulence_test.rb
+- test/lib/rubycritic/generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/base_test.rb
 - test/lib/rubycritic/source_control_systems/double_test.rb
@@ -322,8 +341,9 @@ test_files:
 - 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/generators/console_report_test.rb
+- test/lib/rubycritic/generators/turbulence_test.rb
+- test/lib/rubycritic/generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
 - test/lib/rubycritic/source_control_systems/base_test.rb
 - test/lib/rubycritic/source_control_systems/double_test.rb