rubycritic 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ff62ecc1acf094e82a10bf40ef08f3e99f503994
-  data.tar.gz: b72615619b79aeff062110b689f0795768a81ab4
+  metadata.gz: a776a51f8d90b8d2b65bb2e81f6b4dea87cd63a4
+  data.tar.gz: 4f35ecbef41031dd622513ef120ca1fab15e1e10
 SHA512:
-  metadata.gz: 678cf22b3f926a270505432a1c7c473d782b05e93b647c3cb0754c25d606d35a76ff7af26d44182bfaeeddbc5845e07a8a6c219228b880f562940e5f8b1ec814
-  data.tar.gz: 46abcfc03b41e1824bc7acdd017955a2850095faf8ed3996cb698615e74f34d01ef108727dee9df7095d754bbf23c55ca4bdba6fa890106f33fd9893d1d570fb
+  metadata.gz: 078000998ba31e7c53c637dfda9184e8dfcdc90e28750afd88a4c35949f86feb38b785be71a2038d7704d2acd12d9182b905f19cafa00329ae20f99db51f1592
+  data.tar.gz: fff0b984ed7ebe0e120ceb0ed13947eacea027162312e80e84d7dbe9e96b1f998ecd8be4cd9dfd8e3fc659a50a252261a8ec63ba6310b323b42eda3885327d17

data/lib/rubycritic/analysers/config.reek

@@ -16,3 +16,5 @@ UncommunicativeVariableName:
   reject:
   - !ruby/regexp /^.$/
   - !ruby/regexp /[0-9]$/
+NestedIterators:
+  max_allowed_nesting: 2

data/lib/rubycritic/analysers/flay.rb

@@ -0,0 +1,15 @@
+require "flay"
+
+module Rubycritic
+  module Analyser
+
+    class Flay < ::Flay
+      def initialize(paths)
+        super()
+        process(*paths)
+        analyze
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers_runner.rb

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

data/lib/rubycritic/report_generators/reporter.rb

@@ -35,9 +35,9 @@ module Rubycritic
     end
 
     def file_generators
-      @file_generators ||= @source_pathnames.map do |pathname|
-        file_smells = @smelly_pathnames[pathname]
-        FileGenerator.new(pathname, file_smells)
+      @file_generators ||= @source_pathnames.map do |file_pathname|
+        file_smells = @smelly_pathnames[file_pathname]
+        FileGenerator.new(file_pathname, file_smells)
       end
     end
   end

data/lib/rubycritic/smell_adapters/flay.rb

@@ -0,0 +1,45 @@
+require "rubycritic/smell"
+
+module Rubycritic
+  module SmellAdapter
+
+    class Flay
+      def initialize(flay)
+        @flay = flay
+      end
+
+      def smells
+        @flay.hashes.map do |structural_hash, nodes|
+          create_smell(structural_hash, nodes)
+        end
+      end
+
+      private
+
+      def create_smell(structural_hash, nodes)
+        is_identical = @flay.identical[structural_hash]
+        similarity   = is_identical ? "Identical" : "Similar"
+
+        locations = smell_locations(nodes)
+        context   = "#{similarity} code"
+        message   = "found in #{nodes.size} nodes"
+        score     = @flay.masses[structural_hash]
+
+        Smell.new(
+          :locations => locations,
+          :context => context,
+          :message => message,
+          :score => score,
+          :type => "DuplicateCode"
+        )
+      end
+
+      def smell_locations(nodes)
+        nodes.map do |node|
+          Location.new(node.file, node.line)
+        end.sort
+      end
+    end
+
+  end
+end

data/lib/rubycritic/smell_adapters/flog.rb

@@ -19,8 +19,9 @@ module Rubycritic
       private
 
       def create_smell(context, score)
-        location = method_location(context)
+        location = smell_location(context)
         message  = "has a complexity of #{score.round}"
+
         Smell.new(
           :locations => [location],
           :context => context,
@@ -30,7 +31,7 @@ module Rubycritic
         )
       end
 
-      def method_location(context)
+      def smell_location(context)
         line = @flog.method_locations[context]
         file_path, file_line = line.split(":")
         Location.new(file_path, file_line)

data/lib/rubycritic/smell_adapters/reek.rb

@@ -18,16 +18,17 @@ module Rubycritic
 
       def create_smell(smell)
         locations = smell_locations(smell.source, smell.lines)
-        message   = smell.message
         context   = smell.context
+        message   = smell.message
         type      = smell.subclass
+
         Smell.new(:locations => locations, :context => context, :message => message, :type => type)
       end
 
       def smell_locations(file_path, file_lines)
-        file_lines.uniq.sort.map do |file_line|
+        file_lines.uniq.map do |file_line|
           Location.new(file_path, file_line)
-        end
+        end.sort
       end
     end
 

data/lib/rubycritic/smelly_pathnames_serializer.rb

@@ -8,7 +8,7 @@ module Rubycritic
     end
 
     def load
-      Marshal.load(File.read(@file_name))
+      Marshal.load(File.binread(@file_name))
     end
 
     def dump(smelly_pathnames)

data/lib/rubycritic/source_locator.rb

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

data/lib/rubycritic/version.rb

@@ -1,3 +1,3 @@
 module Rubycritic
-  VERSION = "0.0.6"
+  VERSION = "0.0.7"
 end

data/rubycritic.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |spec|
   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.0"
   spec.add_runtime_dependency "reek", "1.3.6"
 

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

@@ -0,0 +1,25 @@
+require "test_helper"
+require "rubycritic/analysers/flay"
+require "rubycritic/smell_adapters/flay"
+
+describe Rubycritic::SmellAdapter::Flay do
+  before do
+    sample_path = "test/samples/flay/smelly.rb"
+    flay = Rubycritic::Analyser::Flay.new([sample_path])
+    @adapter = Rubycritic::SmellAdapter::Flay.new(flay)
+  end
+
+  it "detects smells" do
+    @adapter.smells.wont_be_empty
+  end
+
+  it "has smells with messages" do
+    smell = @adapter.smells.first
+    smell.message.must_equal "found in 2 nodes"
+  end
+
+  it "has smells with messages" do
+    smell = @adapter.smells.first
+    smell.score.must_be_kind_of Numeric
+  end
+end

data/test/lib/rubycritic/source_locator_test.rb

@@ -18,24 +18,34 @@ describe Rubycritic::SourceLocator do
       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 all the files" do
-      paths = ["dir1/file1.rb", "file0.rb"]
-      Rubycritic::SourceLocator.new(["."]).paths.must_equal paths
+      initial_paths = ["."]
+      final_paths = ["dir1/file1.rb", "file0.rb"]
+      Rubycritic::SourceLocator.new(initial_paths).paths.must_equal 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
+    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
   end
 

data/test/samples/flay/smelly.rb

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

data/test/samples/reek/not_smelly.rb

@@ -1,7 +1,14 @@
-class Perfumed
-  attr_reader :perfume
+class Perfume
+  attr_reader :perfumed
 
-  def ignoresRubyStyle(oneParameter)
+  def ignoreRubyStyle(oneParameter)
     oneVariable = oneParameter
   end
+
+  def allowNestingIteratorsTwoLevelsDeep
+    loop do
+      loop do
+      end
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubycritic
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Guilherme Simoes
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-22 00:00:00.000000000 Z
+date: 2014-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: virtus
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: flay
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 2.4.0
 - !ruby/object:Gem::Dependency
   name: flog
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +142,7 @@ files:
 - lib/rubycritic.rb
 - lib/rubycritic/active_support/methods.rb
 - lib/rubycritic/analysers/config.reek
+- lib/rubycritic/analysers/flay.rb
 - lib/rubycritic/analysers/flog.rb
 - lib/rubycritic/analysers/reek.rb
 - lib/rubycritic/analysers_runner.rb
@@ -151,6 +166,7 @@ files:
 - lib/rubycritic/report_generators/view_helpers.rb
 - lib/rubycritic/revision_comparator.rb
 - lib/rubycritic/smell.rb
+- lib/rubycritic/smell_adapters/flay.rb
 - lib/rubycritic/smell_adapters/flog.rb
 - lib/rubycritic/smell_adapters/reek.rb
 - lib/rubycritic/smells_aggregator.rb
@@ -163,6 +179,7 @@ files:
 - rubycritic.gemspec
 - test/lib/rubycritic/analysers_runner_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
 - test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
 - test/lib/rubycritic/smell_test.rb
@@ -172,6 +189,7 @@ files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb
@@ -207,6 +225,7 @@ summary: Ruby code smell detector
 test_files:
 - test/lib/rubycritic/analysers_runner_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
 - test/lib/rubycritic/metric_adapters/reek_adapter_test.rb
 - test/lib/rubycritic/smell_test.rb
@@ -216,6 +235,7 @@ test_files:
 - test/lib/rubycritic/source_control_systems/source_control_system_test.rb
 - test/lib/rubycritic/source_locator_test.rb
 - test/lib/rubycritic/version_test.rb
+- test/samples/flay/smelly.rb
 - test/samples/flog/smelly.rb
 - test/samples/location/dir1/file1.rb
 - test/samples/location/file0.rb