rubycritic 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0accaa8040e2dc7aee137d0f73cce04c35e59f4
-  data.tar.gz: 589f325af9afba9ce66dedccd501b6f32451490c
+  metadata.gz: e19fa08f433cdb1ef0d4f49096ffa2de1e8a7132
+  data.tar.gz: 0eb7f2ce702010efc38a3d14d5044ba9dcccfe70
 SHA512:
-  metadata.gz: 1e94e46ee87cea62b1248c1eaa6735aa6b0c6437bfba024ce1a2bdbd53c32983a292eeaed11df5747ec920d5c3fdbff25718e3359bcc4453a0a0d192e85ae77a
-  data.tar.gz: bfcba2f0bed83fad8bacb44775c7fd10684efbfd981a05ff589f3317c7d7c1440cce82278657ecfcdc06e20cb706a8c160738b40708f0bc52c4fc07aa05b74d8
+  metadata.gz: ae8600a942a9c784bb4c7c4c3caba9d649430c9f346ce5e8576c92fef8e5a0e933ee3200b96f44deee10f9bef3b9cca99094949ea7c5f36a21baba36d839c0c3
+  data.tar.gz: 285e582072b09076129b9519349aa4e2d941cee174c31688b730674ac689f030d5f2df5ee232185b3f9456b96aee2a481f25676d4ced89c669f5f0e4b651f17c

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+# 1.1.0 / 2014-07-27
+
+* [FEATURE] Display name of the first module found in a file instead of the file's name
+
+# 1.0.2 / 2014-07-23
+
+* [BUGFIX] Fix issue #8 - Solve a dependency error by requiring at least ruby2ruby 2.1.1
+
+# 1.0.1 / 2014-07-22
+
+* [BUGFIX] Fix issue #6 - Rescue `Parser::SyntaxError` when a file is unparsable
+
+# 1.0.0 / 2014-07-13
+
+* Official Release

data/lib/rubycritic/analysers/attributes.rb

@@ -0,0 +1,21 @@
+require "rubycritic/analysers/helpers/methods_counter"
+require "rubycritic/analysers/helpers/modules_locator"
+
+module Rubycritic
+  module Analyser
+
+    class Attributes
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
+      end
+
+      def run
+        @analysed_modules.each do |analysed_module|
+          analysed_module.methods_count = MethodsCounter.new(analysed_module).count
+          analysed_module.name = ModulesLocator.new(analysed_module).first_name
+        end
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/churn.rb

@@ -2,15 +2,15 @@ module Rubycritic
   module Analyser
 
     class Churn
-      def initialize(analysed_files, source_control_system)
-        @analysed_files = analysed_files
+      def initialize(analysed_modules, source_control_system)
+        @analysed_modules = analysed_modules
         @source_control_system = source_control_system
       end
 
       def run
-        @analysed_files.each do |analysed_file|
-          analysed_file.churn = @source_control_system.revisions_count(analysed_file.path)
-          analysed_file.committed_at = @source_control_system.date_of_last_commit(analysed_file.path)
+        @analysed_modules.each do |analysed_module|
+          analysed_module.churn = @source_control_system.revisions_count(analysed_module.path)
+          analysed_module.committed_at = @source_control_system.date_of_last_commit(analysed_module.path)
         end
       end
     end

data/lib/rubycritic/analysers/complexity.rb

@@ -1,19 +1,19 @@
-require "rubycritic/analysers/adapters/flog"
+require "rubycritic/analysers/helpers/flog"
 
 module Rubycritic
   module Analyser
 
     class Complexity
-      def initialize(analysed_files)
+      def initialize(analysed_modules)
         @flog = Flog.new
-        @analysed_files = analysed_files
+        @analysed_modules = analysed_modules
       end
 
       def run
-        @analysed_files.each do |analysed_file|
+        @analysed_modules.each do |analysed_module|
           @flog.reset
-          @flog.flog(analysed_file.path)
-          analysed_file.complexity = @flog.total_score.round
+          @flog.flog(analysed_module.path)
+          analysed_module.complexity = @flog.total_score.round
         end
       end
     end

data/lib/rubycritic/analysers/helpers/ast_node.rb

@@ -0,0 +1,73 @@
+module Parser
+  module AST
+
+    class Node
+      MODULE_TYPES = [:module, :class]
+
+      def count_nodes_of_type(*types)
+        count = 0
+        recursive_children do |child|
+          count += 1 if types.include?(child.type)
+        end
+        count
+      end
+
+      def recursive_children
+        children.each do |child|
+          next unless child.is_a?(Parser::AST::Node)
+          yield child
+          child.recursive_children { |grand_child| yield grand_child }
+        end
+      end
+
+      def get_module_names
+        children_modules = children
+          .select { |child| child.is_a?(Parser::AST::Node) }
+          .flat_map { |child| child.get_module_names }
+
+        if MODULE_TYPES.include?(self.type)
+          if children_modules.empty?
+            [module_name]
+          else
+            children_modules.map do |children_module|
+              "#{module_name}::#{children_module}"
+            end
+          end
+        elsif children_modules.empty?
+          []
+        else
+          children_modules
+        end
+      end
+
+      private
+
+      def module_name
+        name_segments = []
+        current_node = children[0]
+        while(current_node) do
+          name_segments.unshift(current_node.children[1])
+          current_node = current_node.children[0]
+        end
+        name_segments.join("::")
+      end
+    end
+
+  end
+end
+
+module Rubycritic
+  module AST
+
+    class EmptyNode
+      def count_nodes_of_type(*types)
+        0
+      end
+
+      def get_module_names
+        []
+      end
+    end
+
+  end
+end

data/lib/rubycritic/analysers/helpers/methods_counter.rb

@@ -0,0 +1,28 @@
+require "parser/current"
+require "rubycritic/analysers/helpers/ast_node"
+
+module Rubycritic
+
+  class MethodsCounter
+    def initialize(analysed_module)
+      @analysed_module = analysed_module
+    end
+
+    def count
+      node.count_nodes_of_type(:def, :defs)
+    end
+
+    private
+
+    def node
+      Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
+    rescue Parser::SyntaxError => error
+      AST::EmptyNode.new
+    end
+
+    def content
+      File.read(@analysed_module.path)
+    end
+  end
+
+end

data/lib/rubycritic/analysers/helpers/modules_locator.rb

@@ -0,0 +1,46 @@
+require "parser/current"
+require "rubycritic/analysers/helpers/ast_node"
+
+module Rubycritic
+
+  class ModulesLocator
+    def initialize(analysed_module)
+      @analysed_module = analysed_module
+    end
+
+    def first_name
+      names.first
+    end
+
+    def names
+      return name_from_path if @analysed_module.methods_count == 0
+      names = node.get_module_names
+      if names.empty?
+        name_from_path
+      else
+        names
+      end
+    end
+
+    private
+
+    def node
+      Parser::CurrentRuby.parse(content) || AST::EmptyNode.new
+    rescue Parser::SyntaxError => error
+      AST::EmptyNode.new
+    end
+
+    def content
+      File.read(@analysed_module.path)
+    end
+
+    def name_from_path
+      [file_name.split("_").map(&:capitalize).join]
+    end
+
+    def file_name
+      @analysed_module.pathname.basename.sub_ext("").to_s
+    end
+  end
+
+end

data/lib/rubycritic/analysers/smells/flay.rb

@@ -1,34 +1,34 @@
-require "rubycritic/analysers/adapters/flay"
+require "rubycritic/analysers/helpers/flay"
 require "rubycritic/core/smell"
 
 module Rubycritic
   module Analyser
 
     class FlaySmells
-      def initialize(analysed_files)
-        @analysed_files = paths_to_analysed_files(analysed_files)
-        @flay = Flay.new(@analysed_files.keys)
+      def initialize(analysed_modules)
+        @analysed_modules = paths_to_analysed_modules(analysed_modules)
+        @flay = Flay.new(@analysed_modules.keys)
       end
 
       def run
         @flay.hashes.each do |structural_hash, nodes|
           smell = create_smell(structural_hash, nodes)
           nodes.map(&:file).uniq.each do |file|
-            @analysed_files[file].smells << smell
+            @analysed_modules[file].smells << smell
           end
 
           nodes.each do |node|
-            @analysed_files[node.file].duplication += node.mass
+            @analysed_modules[node.file].duplication += node.mass
           end
         end
       end
 
       private
 
-      def paths_to_analysed_files(analysed_files)
+      def paths_to_analysed_modules(analysed_modules)
         paths = {}
-        analysed_files.each do |analysed_file|
-          paths[analysed_file.path] = analysed_file
+        analysed_modules.each do |analysed_module|
+          paths[analysed_module.path] = analysed_module
         end
         paths
       end

data/lib/rubycritic/analysers/smells/flog.rb

@@ -1,4 +1,4 @@
-require "rubycritic/analysers/adapters/flog"
+require "rubycritic/analysers/helpers/flog"
 require "rubycritic/core/smell"
 
 module Rubycritic
@@ -8,26 +8,26 @@ module Rubycritic
       HIGH_COMPLEXITY_SCORE_THRESHOLD = 25
       VERY_HIGH_COMPLEXITY_SCORE_THRESHOLD = 60
 
-      def initialize(analysed_files)
+      def initialize(analysed_modules)
         @flog = Flog.new
-        @analysed_files = analysed_files
+        @analysed_modules = analysed_modules
       end
 
       def run
-        @analysed_files.each do |analysed_file|
-          add_smells_to(analysed_file)
+        @analysed_modules.each do |analysed_module|
+          add_smells_to(analysed_module)
         end
       end
 
       private
 
-      def add_smells_to(analysed_file)
+      def add_smells_to(analysed_module)
         @flog.reset
-        @flog.flog(analysed_file.path)
+        @flog.flog(analysed_module.path)
         @flog.each_by_score do |class_method, original_score|
           score = original_score.round
           if score >= HIGH_COMPLEXITY_SCORE_THRESHOLD
-            analysed_file.smells << create_smell(class_method, score)
+            analysed_module.smells << create_smell(class_method, score)
           end
         end
       end

data/lib/rubycritic/analysers/smells/reek.rb

@@ -1,25 +1,25 @@
-require "rubycritic/analysers/adapters/reek"
+require "rubycritic/analysers/helpers/reek"
 require "rubycritic/core/smell"
 
 module Rubycritic
   module Analyser
 
     class ReekSmells
-      def initialize(analysed_files)
-        @analysed_files = analysed_files
+      def initialize(analysed_modules)
+        @analysed_modules = analysed_modules
       end
 
       def run
-        @analysed_files.each do |analysed_file|
-          add_smells_to(analysed_file)
+        @analysed_modules.each do |analysed_module|
+          add_smells_to(analysed_module)
         end
       end
 
       private
 
-      def add_smells_to(analysed_file)
-        Reek.new(analysed_file.path).smells.each do |smell|
-          analysed_file.smells << create_smell(smell)
+      def add_smells_to(analysed_module)
+        Reek.new(analysed_module.path).smells.each do |smell|
+          analysed_module.smells << create_smell(smell)
         end
       end
 

data/lib/rubycritic/analysers_runner.rb

@@ -3,7 +3,7 @@ require "rubycritic/analysers/smells/flog"
 require "rubycritic/analysers/smells/reek"
 require "rubycritic/analysers/complexity"
 require "rubycritic/analysers/churn"
-require "rubycritic/analysers/stats"
+require "rubycritic/analysers/attributes"
 
 module Rubycritic
 
@@ -13,19 +13,19 @@ module Rubycritic
       Analyser::FlogSmells,
       Analyser::ReekSmells,
       Analyser::Complexity,
-      Analyser::Stats
+      Analyser::Attributes
     ]
 
-    def initialize(analysed_files, source_control_system)
-      @analysed_files = analysed_files
+    def initialize(analysed_modules, source_control_system)
+      @analysed_modules = analysed_modules
       @source_control_system = source_control_system
     end
 
     def run
       ANALYSERS.each do |analyser|
-        analyser.new(@analysed_files).run
+        analyser.new(@analysed_modules).run
       end
-      Analyser::Churn.new(@analysed_files, @source_control_system).run
+      Analyser::Churn.new(@analysed_modules, @source_control_system).run
     end
   end
 

data/lib/rubycritic/cli.rb

@@ -34,8 +34,8 @@ module Rubycritic
       end.parse!(@argv)
 
       if @main_command
-        analysed_files = Orchestrator.new.critique(@argv)
-        report_location = Reporter::Main.new(analysed_files).generate_report
+        analysed_modules = Orchestrator.new.critique(@argv)
+        report_location = Reporter::Main.new(analysed_modules).generate_report
         puts "New critique at #{report_location}"
       end
 

data/lib/rubycritic/core/{analysed_file.rb → analysed_module.rb}

@@ -3,21 +3,18 @@ require "rubycritic/core/rating"
 
 module Rubycritic
 
-  class AnalysedFile
+  class AnalysedModule
     include Virtus.model
 
+    attribute :name
     attribute :pathname
-    attribute :smells
+    attribute :smells,        Array,   :default => []
     attribute :churn
     attribute :committed_at
     attribute :complexity
-    attribute :duplication
+    attribute :duplication,   Integer, :default => 0
     attribute :methods_count
 
-    def name
-      @name ||= pathname.basename.sub_ext("").to_s
-    end
-
     def path
       @path ||= pathname.to_s
     end