rubycritic 0.0.5 → 1.4.0

data/lib/rubycritic/source_control_systems/git.rb

@@ -1,53 +1,57 @@
 module Rubycritic
+  module SourceControlSystem
 
-  class Git < SourceControlSystem
-    register_system
+    class Git < Base
+      register_system
 
-    def self.supported?
-      `git branch 2>&1` && $?.success?
-    end
+      def self.supported?
+        `git branch 2>&1` && $?.success?
+      end
 
-    def self.to_s
-      "Git"
-    end
+      def self.to_s
+        "Git"
+      end
 
-    def has_revision?
-      head_reference && $?.success?
-    end
+      def revisions_count(path)
+        `git log --follow --format=%h #{path.shellescape}`.count("\n")
+      end
 
-    def head_reference
-      `git rev-parse --verify HEAD`.chomp
-    end
+      def date_of_last_commit(path)
+        `git log -1 --date=iso --format=%ad #{path.shellescape}`.chomp!
+      end
 
-    def travel_to_head
-      stash_successful = stash_changes
-      yield
-    ensure
-      travel_to_original_state if stash_successful
-    end
+      def revision?
+        head_reference && $?.success?
+      end
 
-    private
+      def head_reference
+        `git rev-parse --verify HEAD`.chomp!
+      end
 
-    def stash_changes
-      return false if everything_commmited?
+      def travel_to_head
+        stash_successful = stash_changes
+        yield
+      ensure
+        travel_to_original_state if stash_successful
+      end
 
-      stashes_count_before = stashes_count
-      `git stash`
-      stashes_count_after = stashes_count
-      stashes_count_after > stashes_count_before
-    end
+      private
 
-    def everything_commmited?
-      `git status --porcelain`.empty?
-    end
+      def stash_changes
+        stashes_count_before = stashes_count
+        `git stash`
+        stashes_count_after = stashes_count
+        stashes_count_after > stashes_count_before
+      end
 
-    def stashes_count
-      `git stash list`.split("\n").length
-    end
+      def stashes_count
+        `git stash list --format=%h`.count("\n")
+      end
 
-    def travel_to_original_state
-      `git stash pop`
+      def travel_to_original_state
+        `git stash pop`
+      end
     end
-  end
 
+  end
 end

data/lib/rubycritic/source_control_systems/mercurial.rb

@@ -0,0 +1,29 @@
+module Rubycritic
+  module SourceControlSystem
+
+    class Mercurial < Base
+      register_system
+
+      def self.supported?
+        `hg verify 2>&1` && $?.success?
+      end
+
+      def self.to_s
+        "Mercurial"
+      end
+
+      def revisions_count(path)
+        `hg log #{path.shellescape} --template '1'`.size
+      end
+
+      def date_of_last_commit(path)
+        `hg log #{path.shellescape} --template '{date|isodate}' --limit 1`.chomp
+      end
+
+      def revision?
+        false
+      end
+    end
+
+  end
+end

data/lib/rubycritic/source_locator.rb

@@ -7,32 +7,44 @@ module Rubycritic
     RUBY_FILES = File.join("**", "*#{RUBY_EXTENSION}")
 
     def initialize(paths)
-      @user_paths = paths
-    end
-
-    def pathnames
-      @pathnames ||= expand_paths
+      @initial_paths = Array(paths)
     end
 
     def paths
       @paths ||= pathnames.map(&:to_s)
     end
 
+    def pathnames
+      @pathnames ||= expand_paths
+    end
+
     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
-      @user_paths.map do |path|
+      path_list = @initial_paths.flat_map do |path|
         if File.directory?(path)
-          Pathname.glob(files_contained_in(path))
-        elsif File.exists?(path) && File.extname(path) == RUBY_EXTENSION
+          Pathname.glob(File.join(path, RUBY_FILES))
+        elsif File.exist?(path) && File.extname(path) == RUBY_EXTENSION
           Pathname.new(path)
         end
-      end.flatten.compact.sort
-    end
+      end.compact
+
+      deduplicate_symlinks(path_list) if Config.deduplicate_symlinks
 
-    def files_contained_in(path)
-      (path == ".") ? RUBY_FILES : File.join(path, RUBY_FILES)
+      path_list.map(&:cleanpath)
     end
   end
-
 end

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.5"
+  VERSION = "1.4.0"
 end

data/lib/rubycritic.rb

@@ -1,27 +1,22 @@
-require "rubycritic/source_locator"
-require "rubycritic/analysers_runner"
-require "rubycritic/smells_aggregator"
-require "rubycritic/source_control_systems/source_control_system"
-require "rubycritic/revision_comparator"
-require "rubycritic/report_generators/reporter"
+require "rubycritic/configuration"
 
 module Rubycritic
-
-  class Rubycritic
-    def initialize
-      @source_control_system = SourceControlSystem.create
-    end
-
-    def critique(paths)
-      source = SourceLocator.new(paths)
-      if @source_control_system.has_revision?
-        smelly_pathnames = RevisionComparator.new(source.paths, @source_control_system).compare
-      else
-        smell_adapters = AnalysersRunner.new(source.paths).run
-        smelly_pathnames = SmellsAggregator.new(smell_adapters).smelly_pathnames
-      end
-      Reporter.new(source.pathnames, smelly_pathnames).generate_report
+  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/rubycritic.gemspec

@@ -8,24 +8,27 @@ Gem::Specification.new do |spec|
   spec.version       = Rubycritic::VERSION
   spec.authors       = ["Guilherme Simoes"]
   spec.email         = ["guilherme.rdems@gmail.com"]
-  spec.description   = <<-EOF
-    Ruby Critic is a tool that detects and reports smells in Ruby classes, modules and methods.
-  EOF
-  spec.summary       = "Ruby code smell detector"
+  spec.description   = "RubyCritic is a tool that wraps around various static analysis gems "\
+    "to provide a quality report of your Ruby code."
+  spec.summary       = "RubyCritic is a Ruby code quality reporter"
   spec.homepage      = "https://github.com/whitesmith/rubycritic"
   spec.license       = "MIT"
+  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 "flog", "4.2.0"
-  spec.add_runtime_dependency "reek", "1.3.6"
+  spec.add_runtime_dependency "flay", "2.4.0"
+  spec.add_runtime_dependency "flog", "4.2.1"
+  spec.add_runtime_dependency "reek", "1.6.5"
+  spec.add_runtime_dependency "parser", ">= 2.2.0", "< 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/analysers_test_helper.rb

@@ -0,0 +1,3 @@
+require "test_helper"
+
+class AnalysedModuleDouble < OpenStruct; end

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

@@ -0,0 +1,33 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/churn"
+require "rubycritic/source_control_systems/base"
+
+describe Rubycritic::Analyser::Churn do
+  context "when analysing a file" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "path_to_some_file.rb")
+      analysed_modules = [@analysed_module]
+      analyser = Rubycritic::Analyser::Churn.new(analysed_modules)
+      analyser.source_control_system = SourceControlSystemDouble.new
+      analyser.run
+    end
+
+    it "calculates its churn" do
+      @analysed_module.churn.must_equal 1
+    end
+
+    it "determines the date of its last commit" do
+      @analysed_module.committed_at.must_equal "2013-10-09 12:52:49 +0100"
+    end
+  end
+end
+
+class SourceControlSystemDouble < Rubycritic::SourceControlSystem::Base
+  def revisions_count(_path)
+    1 # churn
+  end
+
+  def date_of_last_commit(_path)
+    "2013-10-09 12:52:49 +0100"
+  end
+end

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

@@ -0,0 +1,16 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/complexity"
+
+describe Rubycritic::Analyser::Complexity do
+  context "when analysing a file" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/complex.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::Complexity.new(analysed_modules).run
+    end
+
+    it "calculates its complexity" do
+      @analysed_module.complexity.must_be :>, 0
+    end
+  end
+end

data/test/lib/rubycritic/analysers/helpers/methods_counter_test.rb

@@ -0,0 +1,29 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/helpers/methods_counter"
+
+describe Rubycritic::MethodsCounter do
+  describe "#count" do
+    context "when a file contains Ruby code" do
+      it "calculates the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/methods_count.rb")
+        Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 2
+      end
+    end
+
+    context "when a file is empty" do
+      it "returns 0 as the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/empty.rb")
+        Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
+      end
+    end
+
+    context "when a file is unparsable" do
+      it "does not blow up and returns 0 as the number of methods" do
+        analysed_module = AnalysedModuleDouble.new(:path => "test/samples/unparsable.rb")
+        capture_output_streams do
+          Rubycritic::MethodsCounter.new(analysed_module).count.must_equal 0
+        end
+      end
+    end
+  end
+end

data/test/lib/rubycritic/analysers/helpers/modules_locator_test.rb

@@ -0,0 +1,53 @@
+require "test_helper"
+require "rubycritic/analysers/helpers/modules_locator"
+require "rubycritic/core/analysed_module"
+require "pathname"
+
+describe Rubycritic::ModulesLocator do
+  describe "#names" do
+    context "when a file contains Ruby code" do
+      it "returns the names of all the classes and modules inside the file" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/module_names.rb"),
+          :methods_count => 1
+        )
+        Rubycritic::ModulesLocator.new(analysed_module).names
+          .must_equal ["Foo", "Foo::Bar", "Foo::Baz", "Foo::Qux", "Foo::Quux::Corge"]
+      end
+    end
+
+    context "when a file is empty" do
+      it "returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/empty.rb"),
+          :methods_count => 1
+        )
+        Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Empty"]
+      end
+    end
+
+    context "when a file is unparsable" do
+      it "does not blow up and returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/unparsable.rb"),
+          :methods_count => 1
+        )
+        capture_output_streams do
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["Unparsable"]
+        end
+      end
+    end
+
+    context "when a file has no methods" do
+      it "returns the name of the file titleized" do
+        analysed_module = Rubycritic::AnalysedModule.new(
+          :pathname => Pathname.new("test/samples/no_methods.rb"),
+          :methods_count => 0
+        )
+        capture_output_streams do
+          Rubycritic::ModulesLocator.new(analysed_module).names.must_equal ["NoMethods"]
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+require "test_helper"
+require "rubycritic/analysers/smells/flay"
+require "rubycritic/core/analysed_module"
+require "pathname"
+
+describe Rubycritic::Analyser::FlaySmells do
+  context "when analysing a bunch of files with duplicate code" do
+    before do
+      @analysed_modules = [
+        Rubycritic::AnalysedModule.new(:pathname => Pathname.new("test/samples/flay/smelly.rb")),
+        Rubycritic::AnalysedModule.new(:pathname => Pathname.new("test/samples/flay/smelly2.rb"))
+      ]
+      Rubycritic::Analyser::FlaySmells.new(@analysed_modules).run
+    end
+
+    it "detects its smells" do
+      @analysed_modules.first.smells?.must_equal true
+    end
+
+    it "creates smells with messages" do
+      smell = @analysed_modules.first.smells.first
+      smell.message.must_be_instance_of String
+    end
+
+    it "creates smells with scores" do
+      smell = @analysed_modules.first.smells.first
+      smell.score.must_be_kind_of Numeric
+    end
+
+    it "creates smells with more than one location" do
+      smell = @analysed_modules.first.smells.first
+      smell.multiple_locations?.must_equal true
+    end
+
+    it "calculates the mass of duplicate code" do
+      @analysed_modules.first.duplication.must_be(:>, 0)
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/smells/flog"
+
+describe Rubycritic::Analyser::FlogSmells do
+  context "when analysing a complex file" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/flog/smelly.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::FlogSmells.new(analysed_modules).run
+    end
+
+    it "detects its smells" do
+      @analysed_module.smells.length.must_equal 1
+    end
+
+    it "creates smells with messages" do
+      smell = @analysed_module.smells.first
+      smell.message.must_be_instance_of String
+    end
+
+    it "creates smells with scores" do
+      smell = @analysed_module.smells.first
+      smell.score.must_be :>, 0
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+require "analysers_test_helper"
+require "rubycritic/analysers/smells/reek"
+
+describe Rubycritic::Analyser::ReekSmells do
+  context "when analysing a smelly file" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/reek/smelly.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
+    end
+
+    it "detects its smells" do
+      @analysed_module.smells.length.must_equal 1
+    end
+
+    it "creates smells with messages" do
+      smell = @analysed_module.smells.first
+      smell.message.must_equal "has boolean parameter 'reek'"
+    end
+  end
+
+  context "when analysing a file with smells ignored in config.reek" do
+    before do
+      @analysed_module = AnalysedModuleDouble.new(:path => "test/samples/reek/not_smelly.rb", :smells => [])
+      analysed_modules = [@analysed_module]
+      Rubycritic::Analyser::ReekSmells.new(analysed_modules).run
+    end
+
+    it "does not detect those smells" do
+      @analysed_module.smells.must_be_empty
+    end
+  end
+end

data/test/lib/rubycritic/configuration_test.rb

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

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

@@ -0,0 +1,88 @@
+require "test_helper"
+require "rubycritic/core/analysed_module"
+require "rubycritic/core/smell"
+
+describe Rubycritic::AnalysedModule do
+  describe "attribute readers" do
+    before do
+      @name = "Foo"
+      @pathname = Pathname.new("foo.rb")
+      @smells = []
+      @churn = 1
+      @complexity = 2
+      @analysed_module = Rubycritic::AnalysedModule.new(
+        :name       => @name,
+        :pathname   => @pathname,
+        :smells     => @smells,
+        :churn      => @churn,
+        :complexity => @complexity
+      )
+    end
+
+    it "has a name reader" do
+      @analysed_module.name.must_equal @name
+    end
+
+    it "has a pathname reader" do
+      @analysed_module.pathname.must_equal @pathname
+    end
+
+    it "has a path reader" do
+      @analysed_module.path.must_equal @pathname.to_s
+    end
+
+    it "has a smells reader" do
+      @analysed_module.smells.must_equal @smells
+    end
+
+    it "has a churn reader" do
+      @analysed_module.churn.must_equal @churn
+    end
+
+    it "has a complexity reader" do
+      @analysed_module.complexity.must_equal @complexity
+    end
+  end
+
+  describe "#cost" do
+    it "returns the remediation cost of fixing the analysed_module" do
+      smells = [SmellDouble.new(:cost => 1), SmellDouble.new(:cost => 2)]
+      analysed_module = Rubycritic::AnalysedModule.new(:smells => smells, :complexity => 0)
+      analysed_module.cost.must_equal 3
+    end
+  end
+
+  describe "#complexity_per_method" do
+    context "when the file has no methods" do
+      it "returns a placeholder" do
+        analysed_module = Rubycritic::AnalysedModule.new(:complexity => 0, :methods_count => 0)
+        analysed_module.complexity_per_method.must_equal "N/A"
+      end
+    end
+
+    context "when the file has at least one method" do
+      it "returns the average complexity per method" do
+        analysed_module = Rubycritic::AnalysedModule.new(:complexity => 10, :methods_count => 2)
+        analysed_module.complexity_per_method.must_equal 5
+      end
+    end
+  end
+
+  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.smells?.must_equal true
+    end
+  end
+
+  describe "#smells_at_location" do
+    it "returns the smells of an analysed_module at a certain location" do
+      location = Rubycritic::Location.new("./foo", "42")
+      smells = [Rubycritic::Smell.new(:locations => [location])]
+      analysed_module = Rubycritic::AnalysedModule.new(:smells => smells)
+      analysed_module.smells_at_location(location).must_equal smells
+    end
+  end
+end
+
+class SmellDouble < OpenStruct; end

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

@@ -1,11 +1,11 @@
 require "test_helper"
-require "rubycritic/location"
+require "rubycritic/core/location"
 
 describe Rubycritic::Location do
   describe "attribute readers" do
     before do
-      @path = "./foo"
-      @line = 42
+      @path = "./foo.rb"
+      @line = "42"
       @location = Rubycritic::Location.new(@path, @line)
     end
 
@@ -14,7 +14,11 @@ 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
+      @location.file_name.must_equal "foo"
     end
   end