rubycritic 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b237439616d353d003180ab2ac29d4e7cf815f8e
-  data.tar.gz: a965e2652ab60bbd525fa7b26e0ade5d48931aa2
+  metadata.gz: 88e1add4a91ef2551d93ccec55b2991033b7c2f0
+  data.tar.gz: 4d2b5928a03eff96fc1e5b97529e73e9538affa7
 SHA512:
-  metadata.gz: ffe787925969ccb524082fffd0efed141dd2187145072f6aa3357f240df771a72d120f068ea32b77a57170195810bd0f532f8cb9fccd7183c81e63603fea0f20
-  data.tar.gz: 1955b7fef42bdc712584fbc823c9d28cfb054cab67e2c2ffed861c120a9f48e18a1f45e4ad36d1f5228e1081f30bc0fd6132e3f73c8cbb606d7b98d0da12b6b5
+  metadata.gz: 5bd3e6a0658fbdc874d740a3efc1b1b2649d69224218017bef6071447653ab18796b0a86ceddf5fb3199b4904f00655bac7ec70ec4ab6c43b52681896a48c072
+  data.tar.gz: 449e90f3900e888dd4995135ca4d96a4da595b0d40a7e860d432d20eb358b1354c2ada9fce1a22a4b0a291247489a07d5eda42c75bf1acab2ea2e2238d434d06

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# 1.3.0 2015-02-16
+
+* [FEATURE] New CLI option `--deduplicate-symlinks` to deduplicate symlinks (by LeeXGreen)
+* [CHANGE] Update to Reek 1.6.5 (from 1.6.3)
+* [CHANGE] Remove ruby2ruby dependency
+
 # 1.2.1 / 2015-01-17
 
 * [FEATURE] Support Ruby 2.2
@@ -8,7 +14,7 @@
 
 * [FEATURE] Add CI mode that only analyses the last commit
 * [FEATURE] Add partial support for Mercurial
-* [FEATURE] Allow using Rubycritic programatically
+* [FEATURE] Allow using RubyCritic programatically
 * [CHANGE] Update to Reek 1.6.0 (from 1.3.8)
 
 # 1.1.1 / 2014-07-29

data/README.md

@@ -3,7 +3,7 @@ RubyCritic
 
 [![Gem Version](https://badge.fury.io/rb/rubycritic.svg)](http://badge.fury.io/rb/rubycritic)
 [![Build Status](https://travis-ci.org/whitesmith/rubycritic.svg?branch=master)](https://travis-ci.org/whitesmith/rubycritic)
-[![Code Climate](http://img.shields.io/codeclimate/github/whitesmith/rubycritic.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
+[![Code Climate](https://codeclimate.com/github/whitesmith/rubycritic/badges/gpa.svg)](https://codeclimate.com/github/whitesmith/rubycritic)
 
 <img src="http://i.imgur.com/66HACCD.png" alt="RubyCritic Icon" align="right" />
 RubyCritic is a gem that wraps around static analysis gems such as [Reek][1], [Flay][2] and [Flog][3] to provide a quality report of your Ruby code.
@@ -91,6 +91,7 @@ $ rubycritic --help
 | `-v/--version`           | Displays the current version and exits                |
 | `-p/--path`              | Sets the output directory (tmp/rubycritic by default) |
 | `-m/--mode-ci`           | Uses CI mode (faster, but only analyses last commit)  |
+| `--deduplicate-symlinks` | De-duplicate symlinks based on their final target     |
 
 Alternative Usage Methods
 -------------------------

data/lib/rubycritic.rb

@@ -10,13 +10,13 @@ module Rubycritic
       Command::Version.new
     when :help
       require "rubycritic/commands/help"
-      Command::Help.new(options)
+      Command::Help.new(options.help_text)
     when :ci
       require "rubycritic/commands/ci"
-      Command::Ci.new(options_hash)
+      Command::Ci.new(options_hash[:paths])
     else
       require "rubycritic/commands/default"
-      Command::Default.new(options_hash)
+      Command::Default.new(options_hash[:paths])
     end
   end
 end

data/lib/rubycritic/cli/options.rb

@@ -8,6 +8,7 @@ module Rubycritic
         @parser = OptionParser.new
       end
 
+      # rubocop:disable Metrics/MethodLength
       def parse
         @parser.new do |opts|
           opts.banner = "Usage: rubycritic [options] [paths]"
@@ -20,6 +21,10 @@ module Rubycritic
             @mode = :ci
           end
 
+          opts.on("--deduplicate-symlinks", "De-duplicate symlinks based on their final target") do
+            @deduplicate_symlinks = true
+          end
+
           opts.on_tail("-v", "--version", "Show gem's version") do
             @mode = :version
           end
@@ -39,6 +44,7 @@ module Rubycritic
         {
           :mode => @mode,
           :root => @root,
+          :deduplicate_symlinks => @deduplicate_symlinks,
           :paths => paths
         }
       end

data/lib/rubycritic/commands/ci.rb

@@ -5,22 +5,21 @@ require "rubycritic/reporters/main"
 module Rubycritic
   module Command
     class Ci
-      def initialize(options)
-        @paths = options[:paths]
+      def initialize(paths)
+        @paths = paths
         Config.source_control_system = SourceControlSystem::Base.create
       end
 
       def execute
-        critique(@paths)
-        report
+        report(critique)
       end
 
-      def critique(paths)
-        @analysed_modules = AnalysersRunner.new(paths).run
+      def critique
+        AnalysersRunner.new(@paths).run
       end
 
-      def report
-        report_location = Reporter::Main.new(@analysed_modules).generate_report
+      def report(analysed_modules)
+        report_location = Reporter::Main.new(analysed_modules).generate_report
         puts "New critique at #{report_location}"
       end
     end

data/lib/rubycritic/commands/default.rb

@@ -6,23 +6,22 @@ require "rubycritic/reporters/main"
 module Rubycritic
   module Command
     class Default
-      def initialize(options)
-        @paths = options[:paths]
+      def initialize(paths)
+        @paths = paths
         Config.source_control_system = SourceControlSystem::Base.create
       end
 
       def execute
-        critique(@paths)
-        report
+        report(critique)
       end
 
-      def critique(paths)
-        @analysed_modules = AnalysersRunner.new(paths).run
-        RevisionComparator.new(paths).set_statuses(@analysed_modules)
+      def critique
+        analysed_modules = AnalysersRunner.new(@paths).run
+        RevisionComparator.new(@paths).set_statuses(analysed_modules)
       end
 
-      def report
-        report_location = Reporter::Main.new(@analysed_modules).generate_report
+      def report(analysed_modules)
+        report_location = Reporter::Main.new(analysed_modules).generate_report
         puts "New critique at #{report_location}"
       end
     end

data/lib/rubycritic/commands/help.rb

@@ -1,12 +1,12 @@
 module Rubycritic
   module Command
     class Help
-      def initialize(options)
-        @options = options
+      def initialize(help_text)
+        @help_text = help_text
       end
 
       def execute
-        puts @options.help_text
+        puts @help_text
       end
     end
   end

data/lib/rubycritic/configuration.rb

@@ -1,11 +1,12 @@
 module Rubycritic
   class Configuration
     attr_reader :root
-    attr_accessor :source_control_system, :mode
+    attr_accessor :source_control_system, :mode, :deduplicate_symlinks
 
     def set(options)
       self.mode = options[:mode] || :default
       self.root = options[:root] || "tmp/rubycritic"
+      self.deduplicate_symlinks = options[:deduplicate_symlinks] || false
     end
 
     def root=(path)

data/lib/rubycritic/source_locator.rb

@@ -20,14 +20,31 @@ module Rubycritic
 
     private
 
+    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" }
+      if defined?(JRUBY_VERSION)
+        require "java"
+        path_list.uniq! do |path|
+          java.io.File.new(path.realpath.to_s).canonical_path
+        end
+      else
+        path_list.uniq!(&:realpath)
+      end
+    end
+
     def expand_paths
-      @initial_paths.flat_map do |path|
+      path_list = @initial_paths.flat_map do |path|
         if File.directory?(path)
           Pathname.glob(File.join(path, RUBY_FILES))
         elsif File.exist?(path) && File.extname(path) == RUBY_EXTENSION
           Pathname.new(path)
         end
-      end.compact.map(&:cleanpath)
+      end.compact
+
+      deduplicate_symlinks(path_list) if Config.deduplicate_symlinks
+
+      path_list.map(&:cleanpath)
     end
   end
 end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "1.2.1"
+  VERSION = "1.3.0"
 end

data/rubycritic.gemspec

@@ -23,9 +23,8 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency "virtus", "~> 1.0"
   spec.add_runtime_dependency "flay", "2.4.0"
   spec.add_runtime_dependency "flog", "4.2.1"
-  spec.add_runtime_dependency "reek", "1.6.3"
+  spec.add_runtime_dependency "reek", "1.6.5"
   spec.add_runtime_dependency "parser", ">= 2.2.0", "< 3.0"
-  spec.add_runtime_dependency "ruby2ruby", ">= 2.1.1", "< 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"

data/test/lib/rubycritic/source_locator_test.rb

@@ -26,10 +26,19 @@ describe Rubycritic::SourceLocator do
 
     it "finds all the files" do
       initial_paths = ["."]
-      final_paths = ["dir1/file1.rb", "file0.rb"]
+      final_paths = ["dir1/file1.rb", "file0.rb", "file0_symlink.rb"]
       Rubycritic::SourceLocator.new(initial_paths).paths.must_match_array final_paths
     end
 
+    context "when configured to deduplicate symlinks" do
+      it "it favors a file over a symlink if they both point to the same target" do
+        Rubycritic::Config.stubs(:deduplicate_symlinks).returns(true)
+        initial_paths = ["file0.rb", "file0_symlink.rb"]
+        final_paths = ["file0.rb"]
+        Rubycritic::SourceLocator.new(initial_paths).paths.must_match_array final_paths
+      end
+    end
+
     it "cleans paths of consecutive slashes and useless dots" do
       initial_paths = [".//file0.rb"]
       final_paths = ["file0.rb"]

data/test/samples/reek/not_smelly.rb

@@ -12,7 +12,7 @@ class Perfume
     end
   end
 
-  def method_with_too_many_statements
+  def allow_many_statements
     do_something
     do_something
     do_something

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-17 00:00:00.000000000 Z
+date: 2015-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.6.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.6.3
+        version: 1.6.5
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
@@ -86,26 +86,6 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '3.0'
-- !ruby/object:Gem::Dependency
-  name: ruby2ruby
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 2.1.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -291,6 +271,7 @@ files:
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
+- test/samples/location/file0_symlink.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
 - test/samples/methods_count.rb
@@ -354,6 +335,7 @@ test_files:
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
+- test/samples/location/file0_symlink.rb
 - test/samples/location/file_with_different_extension.py
 - test/samples/location/file_with_no_extension
 - test/samples/methods_count.rb
@@ -362,4 +344,3 @@ test_files:
 - test/samples/reek/smelly.rb
 - test/samples/unparsable.rb
 - test/test_helper.rb
-has_rdoc: