rubycritic 0.0.8 → 0.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cf087d756a9bf0d14b016b82d75b675870614854
-  data.tar.gz: 5c17c62548734bd39a5ca405f764473b96cdd24e
+  metadata.gz: 1099d50ed1beb525a791af3127cfae40dc525d4e
+  data.tar.gz: 2be5a299cd4a4839ca9c096ffd613a3ae0e38647
 SHA512:
-  metadata.gz: d0cfeef76646512463c61140b93959f5de1bc6654bc505005f74f5d560c1e5518d5cda6af6cfbcc18b81285c594aad88ae15fce0cd9ef1c143d56ee49300dc81
-  data.tar.gz: 957ce873afee75b3c4ae67b43d4fd2402bdc3317f7c78f0f2d36d93a0e252eb3d47101a48b83b398df38e887169f1aeafc151231217d2dd580f14316bc6527f9
+  metadata.gz: 11c74550a23f8fdcf3d7bcb579d72ab8cf584552bf8ee412bc3c41be13f565d21a5ed73159c615dfc177724c9d73a20eaa9efd6f081da363f2ab7b33f3278ec3
+  data.tar.gz: dcfa39fc7b30b9d2ba6a2a3d02d93eacb1f1616cfb3c78dad9f790841172d8b202d93c4c312db95798090f7a733152837d38ce95222df0545cf5fbeadc970657

data/README.md

@@ -1,33 +1,55 @@
-Ruby Critic
+RubyCritic
 ===========
 
-Ruby Critic is a tool that detects and reports smells in Ruby code.
+RubyCritic is a gem that wraps around static analysis gems such as [Reek][1]
+and [Flay][2] to provide a quality report of your Ruby code.
+
+For example, given the following code:
+
+```ruby
+class Dirty
+  def awful(x, y, offset = 0, log = false)
+    puts @screen.title
+    @screen = widgets.map {|w| w.each {|key| key += 3}}
+    puts @screen.contents
+  end
+end
+```
+
+It turns something like this:
+
+![Reek output screenshot](http://i.imgur.com/xLtEDOb.png)
+
+Into this:
+
+![RubyCritic output screenshot](http://i.imgur.com/SpZ2SJN.png)
 
 Installation
 ------------
 
-Add this line to your application's Gemfile:
+RubyCritic can be installed with the following command:
 
-```ruby
-gem "rubycritic"
+```bash
+$ gem install rubycritic
 ```
 
-And then execute:
+If you'd rather install RubyCritic using Bundler, add this line to your
+application's Gemfile:
 
-```bash
-$ bundle
+```ruby
+gem "rubycritic", :require => false
 ```
 
-Or just install it yourself:
+And then execute:
 
 ```bash
-$ gem install rubycritic
+$ bundle
 ```
 
 Usage
 -----
 
-Running `rubycritic` with no arguments will check all Ruby source files in the
+Running `rubycritic` with no arguments will analyse all the Ruby files in the
 current directory:
 
 ```bash
@@ -39,3 +61,12 @@ Alternatively you can pass `rubycritic` a list of files and directories to check
 ```bash
 $ rubycritic app lib/foo.rb
 ```
+
+For a full list of the command-line options run:
+
+```bash
+$ rubycritic --help
+```
+
+[1]: https://github.com/troessner/reek
+[2]: https://github.com/seattlerb/flay

data/lib/rubycritic/analysers_runner.rb

@@ -1,7 +1,9 @@
 require "rubycritic/active_support/methods"
 require "rubycritic/analysers/flay"
-require "rubycritic/smell_adapters/flay"
+require "rubycritic/analysers/flog"
 require "rubycritic/analysers/reek"
+require "rubycritic/smell_adapters/flay"
+require "rubycritic/smell_adapters/flog"
 require "rubycritic/smell_adapters/reek"
 
 module Rubycritic
@@ -9,7 +11,7 @@ module Rubycritic
   class AnalysersRunner
     include ActiveSupport
 
-    ANALYSERS = ["Flay", "Reek"]
+    ANALYSERS = ["Flay", "Flog", "Reek"]
 
     def initialize(paths)
       @paths = paths

data/lib/rubycritic/cli.rb

@@ -6,7 +6,11 @@ module Rubycritic
   OptionParser.new do |opts|
     opts.banner = "Usage: rubycritic [options] [paths]"
 
-    opts.on_tail("-v", "--version", "Show this version") do
+    opts.on("-p", "--path [PATH]", "Set path where report will be saved (tmp/rubycritic by default)") do |path|
+      configuration.root = path
+    end
+
+    opts.on_tail("-v", "--version", "Show gem's version") do
       require "rubycritic/version"
       puts VERSION
       exit 0

data/lib/rubycritic/configuration.rb

@@ -0,0 +1,17 @@
+module Rubycritic
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  class Configuration
+    attr_reader :root
+
+    def initialize
+      self.root = "tmp/rubycritic"
+    end
+
+    def root=(path)
+      @root = File.expand_path(path)
+    end
+  end
+end

data/lib/rubycritic/location.rb

@@ -7,7 +7,7 @@ module Rubycritic
 
     def initialize(path, line)
       @pathname = Pathname.new(path)
-      @line = line
+      @line = line.to_i
     end
 
     def file_name

data/lib/rubycritic/report_generators/base_generator.rb

@@ -4,7 +4,6 @@ require "rubycritic/report_generators/view_helpers"
 module Rubycritic
 
   class BaseGenerator
-    REPORT_DIR = File.expand_path("tmp/rubycritic", Dir.getwd)
     TEMPLATES_DIR = File.expand_path("../templates", __FILE__)
     LAYOUT_TEMPLATE = ERB.new(File.read(File.join(TEMPLATES_DIR, "layouts", "application.html.erb")))
 
@@ -19,7 +18,7 @@ module Rubycritic
     end
 
     def file_directory
-      raise NotImplementedError.new("The #{self.class} class must implement the #{__method__} method.")
+      root_directory
     end
 
     def file_name
@@ -37,7 +36,7 @@ module Rubycritic
     private
 
     def root_directory
-      REPORT_DIR
+      ::Rubycritic.configuration.root
     end
   end
 

data/lib/rubycritic/report_generators/code_index_generator.rb

@@ -10,10 +10,6 @@ module Rubycritic
       @file_generators = file_generators.sort { |a, b| a.analysed_file_name <=> b.analysed_file_name }
     end
 
-    def file_directory
-      REPORT_DIR
-    end
-
     def file_name
       "code_index.html"
     end

data/lib/rubycritic/report_generators/file_generator.rb

@@ -14,7 +14,7 @@ module Rubycritic
     end
 
     def file_directory
-      File.join(REPORT_DIR, @pathname.dirname)
+      File.join(root_directory, @pathname.dirname)
     end
 
     def file_name

data/lib/rubycritic/report_generators/reporter.rb

@@ -22,7 +22,7 @@ module Rubycritic
           file.write(generator.render)
         end
       end
-      FileUtils.cp_r(ASSETS_DIR, BaseGenerator::REPORT_DIR)
+      FileUtils.cp_r(ASSETS_DIR, ::Rubycritic.configuration.root)
       code_index_generator.file_href
     end
 

data/lib/rubycritic/report_generators/smells_index_generator.rb

@@ -10,10 +10,6 @@ module Rubycritic
       @smells = smells.sort { |a, b| a.type <=> b.type }
     end
 
-    def file_directory
-      REPORT_DIR
-    end
-
     def file_name
       "smells_index.html"
     end

data/lib/rubycritic/revision_comparator.rb

@@ -7,7 +7,7 @@ require "rubycritic/smells_status_setter"
 module Rubycritic
 
   class RevisionComparator
-    SNAPSHOTS_DIR = File.expand_path("tmp/rubycritic/snapshots", Dir.getwd)
+    SNAPSHOTS_DIR_NAME = "snapshots"
 
     def initialize(smells, source_control_system)
       @smells_now = smells
@@ -36,7 +36,11 @@ module Rubycritic
     end
 
     def revision_file
-      @revision_file ||= File.join(SNAPSHOTS_DIR, @source_control_system.head_reference)
+      @revision_file ||= File.join(
+        ::Rubycritic.configuration.root,
+        SNAPSHOTS_DIR_NAME,
+        @source_control_system.head_reference
+      )
     end
 
     def paths_of_tracked_files

data/lib/rubycritic/smell_adapters/flog.rb

@@ -4,14 +4,18 @@ module Rubycritic
   module SmellAdapter
 
     class Flog
+      HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
+      VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
+
       def initialize(flog)
         @flog = flog
       end
 
       def smells
         smells = []
-        @flog.each_by_score do |class_method, score|
-          smells << create_smell(class_method, score)
+        @flog.each_by_score do |class_method, original_score|
+          score = original_score.round
+          smells << create_smell(class_method, score) if score >= HIGH_COMPLEXITY_SCORE_THRESHOLD
         end
         smells
       end
@@ -20,14 +24,20 @@ module Rubycritic
 
       def create_smell(context, score)
         location = smell_location(context)
-        message  = "has a complexity of #{score.round}"
+        message  = "has a flog score of #{score}"
+        type     =
+          if score >= VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD
+            "VeryHighComplexity"
+          else
+            "HighComplexity"
+          end
 
         Smell.new(
           :locations => [location],
           :context => context,
           :message => message,
           :score => score,
-          :type => "Complexity"
+          :type => type
         )
       end
 

data/lib/rubycritic/smells_status_setter.rb

@@ -3,7 +3,7 @@ module Rubycritic
   class SmellsStatusSetter
     def initialize(smells_before, smells_now)
       @smells_before = smells_before || []
-      @smells_now = smells_now
+      @smells_now = smells_now || []
     end
 
     def smells

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.8"
+  VERSION = "0.0.9"
 end

data/lib/rubycritic.rb

@@ -1,3 +1,4 @@
+require "rubycritic/configuration"
 require "rubycritic/source_locator"
 require "rubycritic/analysers_runner"
 require "rubycritic/smells_aggregator"

data/test/lib/rubycritic/configuration_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+require "rubycritic/configuration"
+
+describe Rubycritic::Configuration do
+  describe "#root" do
+    it "has a default" do
+      Rubycritic.configuration.root.wont_be_empty
+    end
+
+    it "can be configured" do
+      default = Rubycritic.configuration.root
+      Rubycritic.configuration.root = "foo"
+      Rubycritic.configuration.root.must_equal File.expand_path("foo")
+      Rubycritic.configuration.root = default
+    end
+  end
+end

data/test/lib/rubycritic/location_test.rb

@@ -5,7 +5,7 @@ describe Rubycritic::Location do
   describe "attribute readers" do
     before do
       @path = "./foo.rb"
-      @line = 42
+      @line = "42"
       @location = Rubycritic::Location.new(@path, @line)
     end
 
@@ -14,7 +14,7 @@ describe Rubycritic::Location do
     end
 
     it "has a line number" do
-      @location.line.must_equal @line
+      @location.line.must_equal @line.to_i
     end
 
     it "has a file name" do

data/test/lib/rubycritic/metric_adapters/flog_adapter_test.rb

@@ -15,7 +15,7 @@ describe Rubycritic::SmellAdapter::Flog do
 
   it "has smells with messages" do
     smell = @adapter.smells.first
-    smell.message.must_equal "has a complexity of 8"
+    smell.message.must_be_kind_of String
   end
 
   it "has smells with scores" do

data/test/lib/rubycritic/source_locator_test.rb

@@ -3,7 +3,7 @@ require "rubycritic/source_locator"
 
 describe Rubycritic::SourceLocator do
   before do
-    @original_dir = Dir.pwd
+    @original_dir = Dir.getwd
     Dir.chdir("test/samples/location")
   end
 

data/test/samples/flog/smelly.rb

@@ -1,6 +1,11 @@
 class AllTheMethods
   def method_missing(method, *args, &block)
-    define_method(method) { "I did not exist, but now I do." }
-    send(method)
+    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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.0.9
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-29 00:00:00.000000000 Z
+date: 2014-05-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -147,6 +147,7 @@ files:
 - lib/rubycritic/analysers/reek.rb
 - lib/rubycritic/analysers_runner.rb
 - lib/rubycritic/cli.rb
+- lib/rubycritic/configuration.rb
 - lib/rubycritic/location.rb
 - lib/rubycritic/report_generators/assets/javascripts/application.js
 - lib/rubycritic/report_generators/assets/javascripts/jquery-2.1.0.js
@@ -180,6 +181,7 @@ files:
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
 - test/lib/rubycritic/analysers_runner_test.rb
+- test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/location_test.rb
 - test/lib/rubycritic/metric_adapters/flay_adapter_test.rb
 - test/lib/rubycritic/metric_adapters/flog_adapter_test.rb
@@ -226,6 +228,7 @@ specification_version: 4
 summary: Ruby code smell detector
 test_files:
 - test/lib/rubycritic/analysers_runner_test.rb
+- test/lib/rubycritic/configuration_test.rb
 - test/lib/rubycritic/location_test.rb
 - test/lib/rubycritic/metric_adapters/flay_adapter_test.rb
 - test/lib/rubycritic/metric_adapters/flog_adapter_test.rb