rubycritic 0.0.5 → 1.4.0

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

@@ -0,0 +1,72 @@
+require "test_helper"
+require "rubycritic/core/smell"
+
+describe Rubycritic::Smell do
+  describe "attribute readers" do
+    before do
+      @locations = [Rubycritic::Location.new("./foo", "42")]
+      @context = "#bar"
+      @message = "This smells"
+      @score = 0
+      @type = :complexity
+      @smell = Rubycritic::Smell.new(
+        :locations => @locations,
+        :context   => @context,
+        :message   => @message,
+        :score     => @score,
+        :type      => @type
+      )
+    end
+
+    it "has a context reader" do
+      @smell.context.must_equal @context
+    end
+
+    it "has a locations reader" do
+      @smell.locations.must_equal @locations
+    end
+
+    it "has a message reader" do
+      @smell.message.must_equal @message
+    end
+
+    it "has a score reader" do
+      @smell.score.must_equal @score
+    end
+
+    it "has a type reader" do
+      @smell.type.must_equal @type
+    end
+  end
+
+  describe "#at_location?" do
+    it "returns true if the smell has a location that matches the location passed as argument" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smell = Rubycritic::Smell.new(:locations => [location])
+      smell.at_location?(location).must_equal true
+    end
+  end
+
+  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.multiple_locations?.must_equal true
+    end
+  end
+
+  describe "#==" do
+    it "returns true if two smells have the same base attributes" do
+      attributes = {
+        :context => "#bar",
+        :message => "This smells",
+        :score => 0,
+        :type => :complexity
+      }
+      smell1 = Rubycritic::Smell.new(attributes)
+      smell2 = Rubycritic::Smell.new(attributes)
+      smell1.must_equal smell2
+    end
+  end
+end

data/test/lib/rubycritic/{smells_array_test.rb → core/smells_array_test.rb}

@@ -1,5 +1,5 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 
 describe "Array of Smells" do
   it "is sortable" do

data/test/lib/rubycritic/report_generators/turbulence_test.rb

@@ -0,0 +1,17 @@
+require "test_helper"
+require "rubycritic/generators/html/turbulence"
+
+describe Rubycritic::Turbulence do
+  describe "::data" do
+    it "returns json data that maps pathname, churn and complexity to name, x and y" do
+      files = [AnalysedModuleDouble.new(:name => "Foo", :churn => 1, :complexity => 2)]
+      turbulence_data = Rubycritic::Turbulence.data(files)
+      instance_parsed_json = JSON.parse(turbulence_data).first
+      instance_parsed_json["name"].must_equal "Foo"
+      instance_parsed_json["x"].must_equal 1
+      instance_parsed_json["y"].must_equal 2
+    end
+  end
+end
+
+class AnalysedModuleDouble < OpenStruct; end

data/test/lib/rubycritic/report_generators/view_helpers_test.rb

@@ -0,0 +1,83 @@
+require "test_helper"
+require "rubycritic/generators/html/view_helpers"
+require "pathname"
+
+describe Rubycritic::ViewHelpers do
+  context "when the file is in the root directory" do
+    let(:generator) { GeneratorDouble.new("foo.html") }
+
+    describe "#file_path" do
+      context "when the other file is in the same directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("bar.html").to_s.must_equal "bar.html"
+        end
+      end
+
+      context "when the other file is in a subdirectory" do
+        it "creates a relative path to a file" do
+          generator.file_path("subdirectory/bar.html").to_s.must_equal "subdirectory/bar.html"
+        end
+      end
+    end
+
+    describe "#asset_path" do
+      it "creates a relative path to an asset" do
+        generator.asset_path("stylesheets/application.css").to_s
+          .must_equal "assets/stylesheets/application.css"
+      end
+    end
+  end
+
+  context "when the file is n directories deep" do
+    let(:generator) { GeneratorDouble.new("lets/go/crazy/foo.html") }
+
+    describe "#file_path" do
+      context "when the other file is in the same directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("lets/go/crazy/bar.html").to_s.must_equal "bar.html"
+        end
+      end
+
+      context "when the other file is in the root directory" do
+        it "creates a relative path to a file" do
+          generator.file_path("bar.html").to_s.must_equal "../../../bar.html"
+        end
+      end
+
+      context "when the other file has n-1 directories in common" do
+        it "creates a relative path to a file" do
+          generator.file_path("lets/go/home/bar.html").to_s.must_equal "../home/bar.html"
+        end
+      end
+
+      context "when the other file is one directory deeper" do
+        it "creates a relative path to a file" do
+          generator.file_path("lets/go/crazy/everybody/bar.html").to_s.must_equal "everybody/bar.html"
+        end
+      end
+    end
+
+    describe "#asset_path" do
+      it "creates a relative path to an asset" do
+        generator.asset_path("stylesheets/application.css").to_s
+          .must_equal "../../../assets/stylesheets/application.css"
+      end
+    end
+  end
+end
+
+class GeneratorDouble
+  include Rubycritic::ViewHelpers
+
+  def initialize(file)
+    @file = Pathname.new(file)
+  end
+
+  def file_directory
+    root_directory + @file.dirname
+  end
+
+  def root_directory
+    Pathname.new("root_directory")
+  end
+end

data/test/lib/rubycritic/smells_status_setter_test.rb

@@ -1,21 +1,21 @@
 require "test_helper"
-require "rubycritic/smell"
+require "rubycritic/core/smell"
 require "rubycritic/smells_status_setter"
 
 describe Rubycritic::SmellsStatusSetter do
-  describe "#smelly_pathnames" do
+  describe "::smells" do
     before do
       @smell = Rubycritic::Smell.new(:context => "#bar")
-      @smelly_pathnames = { "file0.rb" => [@smell] }
+      @smells = [@smell]
     end
 
     it "marks old smells" do
-      Rubycritic::SmellsStatusSetter.new(@smelly_pathnames, @smelly_pathnames).smelly_pathnames
+      Rubycritic::SmellsStatusSetter.set(@smells, @smells)
       @smell.status.must_equal :old
     end
 
     it "marks new smells" do
-      Rubycritic::SmellsStatusSetter.new({}, @smelly_pathnames).smelly_pathnames
+      Rubycritic::SmellsStatusSetter.set([], @smells)
       @smell.status.must_equal :new
     end
   end

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

@@ -0,0 +1,29 @@
+require "test_helper"
+require "rubycritic/source_control_systems/base"
+
+describe Rubycritic::SourceControlSystem::Base do
+  before do
+    Rubycritic::SourceControlSystem::Base.systems.each do |system|
+      system.stubs(:supported?).returns(false)
+    end
+  end
+
+  describe "::create" do
+    context "when a source control system is found" do
+      it "creates an instance of that source control system" do
+        Rubycritic::SourceControlSystem::Git.stubs(:supported?).returns(true)
+        system = Rubycritic::SourceControlSystem::Base.create
+        system.must_be_instance_of Rubycritic::SourceControlSystem::Git
+      end
+    end
+
+    context "when no source control system is found" do
+      it "creates a source control system double" do
+        capture_output_streams do
+          system = Rubycritic::SourceControlSystem::Base.create
+          system.must_be_instance_of Rubycritic::SourceControlSystem::Double
+        end
+      end
+    end
+  end
+end

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

@@ -3,48 +3,72 @@ require "rubycritic/source_locator"
 
 describe Rubycritic::SourceLocator do
   before do
-    @original_dir = Dir.pwd
+    @original_dir = Dir.getwd
     Dir.chdir("test/samples/location")
   end
 
   describe "#paths" do
-    it "finds a single path" do
+    it "finds a single file" do
       paths = ["file0.rb"]
       Rubycritic::SourceLocator.new(paths).paths.must_equal paths
     end
 
+    it "finds all the files inside a given directory" do
+      initial_paths = ["dir1"]
+      final_paths = ["dir1/file1.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
+    end
+
     it "finds files through multiple paths" do
       paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal paths
+      Rubycritic::SourceLocator.new(paths).paths.must_match_array paths
     end
 
-    it "finds all the paths" do
-      paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(["."]).paths.must_equal paths
+    it "finds all the files" do
+      initial_paths = ["."]
+      final_paths = ["dir1/file1.rb", "file0.rb", "file0_symlink.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_match_array final_paths
     end
 
-    it "finds all the files inside a given directory" do
-      paths = ["dir1/file1.rb"]
-      Rubycritic::SourceLocator.new(["dir1"]).paths.must_equal paths
+    context "when configured to deduplicate symlinks" do
+      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"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
     it "ignores paths to non-existent files" do
-      paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal []
+      initial_paths = ["non_existent_dir1/non_existent_file1.rb", "non_existent_file0.rb"]
+      final_paths = []
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal final_paths
     end
 
     it "ignores paths to files that do not match the Ruby extension" do
-      paths = ["file_with_no_extension", "file_with_different_extension.py"]
-      Rubycritic::SourceLocator.new(paths).paths.must_equal []
+      initial_paths = ["file_with_no_extension", "file_with_different_extension.py"]
+      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
-    it "finds a single path" do
-      path = "file0.rb"
-      paths = [path]
-      result = [Pathname.new(path)]
-      Rubycritic::SourceLocator.new(paths).pathnames.must_equal result
+    it "finds a single file" do
+      initial_paths = ["file0.rb"]
+      final_pathnames = [Pathname.new("file0.rb")]
+      Rubycritic::SourceLocator.new(initial_paths).pathnames.must_equal final_pathnames
     end
   end
 

data/test/lib/rubycritic/version_test.rb

@@ -1,4 +1,5 @@
 require "test_helper"
+require "rubycritic/version"
 
 describe "Rubycritic version" do
   it "is defined" do

data/test/samples/flay/smelly.rb

@@ -0,0 +1,8 @@
+class Ramsay
+  def flay(parts)
+    parts -= 1
+    parts -= 2
+    parts -= 3
+    parts -= 4
+  end
+end

data/test/samples/flay/smelly2.rb

@@ -0,0 +1,8 @@
+class Roose
+  def flay(parts)
+    parts -= 1
+    parts -= 2
+    parts -= 3
+    parts -= 4
+  end
+end

data/test/samples/flog/complex.rb

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

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

data/test/samples/methods_count.rb

@@ -0,0 +1,7 @@
+class Example
+  def self.one_class_method
+  end
+
+  def one_instance_method
+  end
+end

data/test/samples/module_names.rb

@@ -0,0 +1,18 @@
+module Foo
+end
+
+module Foo
+  class Bar
+  end
+
+  class Baz
+  end
+end
+
+class Foo::Qux
+end
+
+module Foo::Quux
+  class Corge
+  end
+end

data/test/samples/reek/not_smelly.rb

@@ -1,7 +1,35 @@
-class Perfumed
-  attr_reader :perfume
+class Perfume
+  attr_reader :perfumed
 
-  def ignoresRubyStyle(oneParameter)
+  def ignoreRubyStyle(oneParameter)
     oneVariable = oneParameter
   end
+
+  def allow_nesting_iterators_two_levels_deep
+    loop do
+      loop do
+      end
+    end
+  end
+
+  def allow_many_statements
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+    do_something
+  end
+
+  def allow_up_to_two_duplicate_method_calls
+    respond_to do |format|
+      if success
+        format.html { redirect_to some_path }
+        format.js { head :ok }
+      else
+        format.html { redirect_to :back, status: :bad_request }
+        format.js { render status: :bad_request }
+      end
+    end
+  end
 end

data/test/samples/unparsable.rb

@@ -0,0 +1 @@
+unparsable :<%=

data/test/test_helper.rb

@@ -1,7 +1,46 @@
 require "minitest/autorun"
 require "minitest/pride"
 require "mocha/setup"
+require "ostruct"
 
 def context(*args, &block)
   describe(*args, &block)
 end
+
+def capture_output_streams
+  $stdout = StringIO.new
+  $stderr = StringIO.new
+  yield
+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