rubycritic 1.1.1 → 1.2.0

data/lib/rubycritic/source_locator.rb

@@ -7,7 +7,7 @@ module Rubycritic
     RUBY_FILES = File.join("**", "*#{RUBY_EXTENSION}")
 
     def initialize(paths)
-      @initial_paths = paths
+      @initial_paths = Array(paths)
     end
 
     def paths
@@ -21,14 +21,13 @@ module Rubycritic
     private
 
     def expand_paths
-      @initial_paths.map do |path|
+      @initial_paths.flat_map do |path|
         if File.directory?(path)
           Pathname.glob(File.join(path, RUBY_FILES))
-        elsif File.exists?(path) && File.extname(path) == RUBY_EXTENSION
+        elsif File.exist?(path) && File.extname(path) == RUBY_EXTENSION
           Pathname.new(path)
         end
-      end.flatten.compact.map(&:cleanpath)
+      end.compact.map(&:cleanpath)
     end
   end
-
 end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/rubycritic.gemspec

@@ -16,19 +16,20 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = ">= 1.9.3"
 
   spec.files         = `git ls-files`.split("\n")
-  spec.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  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 "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.3.8"
-  spec.add_runtime_dependency "parser", "~> 2.1"
+  spec.add_runtime_dependency "reek", "1.6.0"
+  spec.add_runtime_dependency "parser", ">= 2.2.0.pre.5", "< 3.0"
   spec.add_runtime_dependency "ruby2ruby", ">= 2.1.1", "< 3.0"
 
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "minitest", "~> 5.3"
   spec.add_development_dependency "mocha", "~> 1.0"
+  spec.add_development_dependency "rubocop", "0.28.0"
 end

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

@@ -5,18 +5,18 @@ require "rubycritic/source_control_systems/base"
 describe Rubycritic::Analyser::Churn do
   before do
     @analysed_modules = [AnalysedModuleDouble.new(:path => "path_to_some_file.rb")]
-    @source_control_system = SourceControlSystemDouble.new
+    analyser = Rubycritic::Analyser::Churn.new(@analysed_modules)
+    analyser.source_control_system = SourceControlSystemDouble.new
+    analyser.run
   end
 
   it "calculates the churn of each file and adds it to analysed_modules" do
-    Rubycritic::Analyser::Churn.new(@analysed_modules, @source_control_system).run
     @analysed_modules.each do |analysed_module|
       analysed_module.churn.must_equal 1
     end
   end
 
   it "calculates the date of the last commit of each file and adds it to analysed_modules" do
-    Rubycritic::Analyser::Churn.new(@analysed_modules, @source_control_system).run
     @analysed_modules.each do |analysed_module|
       analysed_module.committed_at.must_equal "2013-10-09 12:52:49 +0100"
     end
@@ -24,11 +24,11 @@ describe Rubycritic::Analyser::Churn do
 end
 
 class SourceControlSystemDouble < Rubycritic::SourceControlSystem::Base
-  def revisions_count(path)
+  def revisions_count(_path)
     1 # churn
   end
 
-  def date_of_last_commit(path)
+  def date_of_last_commit(_path)
     "2013-10-09 12:52:49 +0100"
   end
 end

data/test/lib/rubycritic/analysers/smells/flay_test.rb

@@ -6,7 +6,7 @@ require "pathname"
 describe Rubycritic::Analyser::FlaySmells do
   before do
     @analysed_module = Rubycritic::AnalysedModule.new(
-      :pathname => Pathname.new("test/samples/flay/smelly.rb"),
+      :pathname => Pathname.new("test/samples/flay/smelly.rb")
     )
     analysed_modules = [@analysed_module]
     Rubycritic::Analyser::FlaySmells.new(analysed_modules).run

data/test/lib/rubycritic/configuration_test.rb

@@ -4,25 +4,26 @@ require "rubycritic/configuration"
 describe Rubycritic::Configuration do
   describe "#root" do
     before do
-      @default = Rubycritic.configuration.root
+      Rubycritic::Config.set
+      @default = Rubycritic::Config.root
     end
 
     it "has a default" do
-      Rubycritic.configuration.root.wont_be_empty
+      Rubycritic::Config.root.must_be_instance_of String
     end
 
     it "can be set to a relative path" do
-      Rubycritic.configuration.root = "foo"
-      Rubycritic.configuration.root.must_equal File.expand_path("foo")
+      Rubycritic::Config.root = "foo"
+      Rubycritic::Config.root.must_equal File.expand_path("foo")
     end
 
     it "can be set to an absolute path" do
-      Rubycritic.configuration.root = "/foo"
-      Rubycritic.configuration.root.must_equal "/foo"
+      Rubycritic::Config.root = "/foo"
+      Rubycritic::Config.root.must_equal "/foo"
     end
 
     after do
-      Rubycritic.configuration.root = @default
+      Rubycritic::Config.root = @default
     end
   end
 end

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

@@ -68,10 +68,10 @@ describe Rubycritic::AnalysedModule do
     end
   end
 
-  describe "#has_smells?" do
+  describe "#smells?" do
     it "returns true if the analysed_module has at least one smell" do
       analysed_module = Rubycritic::AnalysedModule.new(:smells => [SmellDouble.new])
-      analysed_module.has_smells?.must_equal true
+      analysed_module.smells?.must_equal true
     end
   end
 

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

@@ -47,12 +47,12 @@ describe Rubycritic::Smell do
     end
   end
 
-  describe "#has_multiple_locations?" do
+  describe "#multiple_locations?" do
     it "returns true if the smell has more than one location" do
       location1 = Rubycritic::Location.new("./foo", "42")
       location2 = Rubycritic::Location.new("./foo", "23")
       smell = Rubycritic::Smell.new(:locations => [location1, location2])
-      smell.has_multiple_locations?.must_equal true
+      smell.multiple_locations?.must_equal true
     end
   end
 

data/test/lib/rubycritic/source_control_systems/{source_control_system_test.rb → base_test.rb}

@@ -1,7 +1,7 @@
 require "test_helper"
 require "rubycritic/source_control_systems/base"
 
-describe Rubycritic::SourceControlSystem do
+describe Rubycritic::SourceControlSystem::Base do
   before do
     Rubycritic::SourceControlSystem::Base.systems.each do |system|
       system.stubs(:supported?).returns(false)

data/test/lib/rubycritic/source_control_systems/double_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+require "rubycritic/source_control_systems/base"
+require_relative "interfaces/basic"
+
+class DoubleTest < Minitest::Test
+  include BasicInterface
+
+  def setup
+    @system = Rubycritic::SourceControlSystem::Double.new
+  end
+end

data/test/lib/rubycritic/source_control_systems/git_test.rb

@@ -0,0 +1,13 @@
+require "test_helper"
+require "rubycritic/source_control_systems/base"
+require_relative "interfaces/basic"
+require_relative "interfaces/time_travel"
+
+class GitTest < Minitest::Test
+  include BasicInterface
+  include TimeTravelInterface
+
+  def setup
+    @system = Rubycritic::SourceControlSystem::Git.new
+  end
+end

data/test/lib/rubycritic/source_control_systems/interfaces/basic.rb

@@ -0,0 +1,7 @@
+module BasicInterface
+  def test_implements_basic_interface
+    assert_respond_to @system, :revisions_count
+    assert_respond_to @system, :date_of_last_commit
+    assert_respond_to @system, :revision?
+  end
+end

data/test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb

@@ -0,0 +1,7 @@
+# This interface is only used if `@system.revision?` returns `true`.
+module TimeTravelInterface
+  def test_implements_time_travel_interface
+    assert_respond_to @system, :head_reference
+    assert_respond_to @system, :travel_to_head
+  end
+end

data/test/lib/rubycritic/source_control_systems/mercurial_test.rb

@@ -0,0 +1,11 @@
+require "test_helper"
+require "rubycritic/source_control_systems/base"
+require_relative "interfaces/basic"
+
+class MercurialTest < Minitest::Test
+  include BasicInterface
+
+  def setup
+    @system = Rubycritic::SourceControlSystem::Mercurial.new
+  end
+end

data/test/lib/rubycritic/source_locator_test.rb

@@ -21,13 +21,13 @@ describe Rubycritic::SourceLocator do
 
     it "finds files through multiple paths" do
       paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(paths).paths.sort.must_equal paths
+      Rubycritic::SourceLocator.new(paths).paths.must_match_array paths
     end
 
     it "finds all the files" do
       initial_paths = ["."]
       final_paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(initial_paths).paths.sort.must_equal final_paths
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_match_array final_paths
     end
 
     it "cleans paths of consecutive slashes and useless dots" do
@@ -47,6 +47,12 @@ describe Rubycritic::SourceLocator do
       final_paths = []
       Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
+
+    it "can deal with nil paths" do
+      paths = nil
+      final_paths = []
+      Rubycritic::SourceLocator.new(paths).paths.must_equal final_paths
+    end
   end
 
   describe "#pathnames" do

data/test/test_helper.rb

@@ -15,3 +15,32 @@ ensure
   $stdout = STDOUT
   $stderr = STDERR
 end
+
+module MiniTest
+  module Assertions
+    ##
+    # Fails unless <tt>exp</tt> and <tt>act</tt> are both arrays and
+    # contain the same elements.
+    #
+    #     assert_matched_arrays [3,2,1], [1,2,3]
+
+    def assert_matched_arrays(exp, act)
+      exp_ary = exp.to_ary
+      assert_kind_of Array, exp_ary
+      act_ary = act.to_ary
+      assert_kind_of Array, act_ary
+      assert_equal exp_ary.sort, act_ary.sort
+    end
+  end
+
+  module Expectations
+    ##
+    # See MiniTest::Assertions#assert_matched_arrays
+    #
+    #     [1,2,3].must_match_array [3,2,1]
+    #
+    # :method: must_match_array
+
+    infect_an_assertion :assert_matched_arrays, :must_match_array
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-29 00:00:00.000000000 Z
+date: 2014-12-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -58,28 +58,34 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 1.6.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 1.3.8
+        version: 1.6.0
 - !ruby/object:Gem::Dependency
   name: parser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0.pre.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.0.pre.5
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: ruby2ruby
   requirement: !ruby/object:Gem::Requirement
@@ -156,6 +162,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.28.0
 description: RubyCritic is a tool that wraps around various static analysis gems to
   provide a quality report of your Ruby code.
 email:
@@ -166,6 +186,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - CONTRIBUTING.md
@@ -184,19 +205,23 @@ files:
 - lib/rubycritic/analysers/helpers/flog.rb
 - lib/rubycritic/analysers/helpers/methods_counter.rb
 - lib/rubycritic/analysers/helpers/modules_locator.rb
+- lib/rubycritic/analysers/helpers/parser.rb
 - lib/rubycritic/analysers/helpers/reek.rb
 - lib/rubycritic/analysers/smells/flay.rb
 - lib/rubycritic/analysers/smells/flog.rb
 - lib/rubycritic/analysers/smells/reek.rb
 - lib/rubycritic/analysers_runner.rb
-- lib/rubycritic/cli.rb
+- lib/rubycritic/cli/application.rb
+- lib/rubycritic/cli/options.rb
+- lib/rubycritic/commands/ci.rb
+- lib/rubycritic/commands/default.rb
+- lib/rubycritic/commands/help.rb
+- lib/rubycritic/commands/version.rb
 - lib/rubycritic/configuration.rb
 - lib/rubycritic/core/analysed_module.rb
 - lib/rubycritic/core/location.rb
 - lib/rubycritic/core/rating.rb
 - lib/rubycritic/core/smell.rb
-- lib/rubycritic/modules_initializer.rb
-- lib/rubycritic/orchestrator.rb
 - lib/rubycritic/report_generators/assets/javascripts/application.js
 - lib/rubycritic/report_generators/assets/javascripts/highcharts.src-4.0.1.js
 - lib/rubycritic/report_generators/assets/javascripts/jquery-2.1.0.js
@@ -232,6 +257,7 @@ files:
 - lib/rubycritic/source_control_systems/base.rb
 - lib/rubycritic/source_control_systems/double.rb
 - lib/rubycritic/source_control_systems/git.rb
+- lib/rubycritic/source_control_systems/mercurial.rb
 - lib/rubycritic/source_locator.rb
 - lib/rubycritic/version.rb
 - rubycritic.gemspec
@@ -251,7 +277,12 @@ files:
 - test/lib/rubycritic/report_generators/turbulence_test.rb
 - test/lib/rubycritic/report_generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
-- test/lib/rubycritic/source_control_systems/source_control_system_test.rb
+- test/lib/rubycritic/source_control_systems/base_test.rb
+- test/lib/rubycritic/source_control_systems/double_test.rb
+- test/lib/rubycritic/source_control_systems/git_test.rb
+- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
+- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
+- test/lib/rubycritic/source_control_systems/mercurial_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
 - test/samples/empty.rb
@@ -309,7 +340,12 @@ test_files:
 - test/lib/rubycritic/report_generators/turbulence_test.rb
 - test/lib/rubycritic/report_generators/view_helpers_test.rb
 - test/lib/rubycritic/smells_status_setter_test.rb
-- test/lib/rubycritic/source_control_systems/source_control_system_test.rb
+- test/lib/rubycritic/source_control_systems/base_test.rb
+- test/lib/rubycritic/source_control_systems/double_test.rb
+- test/lib/rubycritic/source_control_systems/git_test.rb
+- test/lib/rubycritic/source_control_systems/interfaces/basic.rb
+- test/lib/rubycritic/source_control_systems/interfaces/time_travel.rb
+- test/lib/rubycritic/source_control_systems/mercurial_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
 - test/samples/empty.rb

data/lib/rubycritic/cli.rb

@@ -1,46 +0,0 @@
-require "optparse"
-require "rubycritic"
-require "rubycritic/reporters/main"
-
-module Rubycritic
-
-  class Cli
-    STATUS_SUCCESS = 0
-
-    def initialize(argv)
-      @argv = argv
-      @argv << "." if @argv.empty?
-      @main_command = true
-    end
-
-    def execute
-      OptionParser.new do |opts|
-        opts.banner = "Usage: rubycritic [options] [paths]"
-
-        opts.on("-p", "--path [PATH]", "Set path where report will be saved (tmp/rubycritic by default)") do |path|
-          ::Rubycritic.configuration.root = path
-        end
-
-        opts.on_tail("-v", "--version", "Show gem's version") do
-          require "rubycritic/version"
-          puts "RubyCritic #{VERSION}"
-          @main_command = false
-        end
-
-        opts.on_tail("-h", "--help", "Show this message") do
-          puts opts
-          @main_command = false
-        end
-      end.parse!(@argv)
-
-      if @main_command
-        analysed_modules = Orchestrator.new.critique(@argv)
-        report_location = Reporter::Main.new(analysed_modules).generate_report
-        puts "New critique at #{report_location}"
-      end
-
-      STATUS_SUCCESS
-    end
-  end
-
-end