code_keeper 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b4a15da64994715117539279f4e5e5cf188cda6d2b12a1a06bf2c9d952e675a4
-  data.tar.gz: f4aa1e1345c5677ded8d8aaaa124d4680b92f022ed83a93410dbf747c8491216
+  metadata.gz: f1032e75ff8322d23a622e6bac5a04039939999032d5559e9ff54d46f04ccd16
+  data.tar.gz: 51e78032de7754ea37aacd6ea422d46e4c66cc94c5c5d10a2baf963cee475ee1
 SHA512:
-  metadata.gz: '042197cb06c4aed7677d9074f53ee106264164536e3bc8a14a483c2bebf88454fd183724939daad10ea0eb5078b6718df07bfbcf615d792ac9ca4cbd2b51ef6f'
-  data.tar.gz: a3ba59d24ab56465ede942e32262838485ef38795156a48976deb2de00508fee3a9b0249e71495ce99d05f525bd7873abf4fe195b605f9bb080a22d3fc5e1c62
+  metadata.gz: eedf3bcecbd0ad563300548c9b1ac9b7d2ddec52550b459754fa1556e052940ad36ce7c5fd9afdb6df0768ea5ce9dd04680d3cae6a68112d106cb4ddf6611073
+  data.tar.gz: c527a3f3a175535b53512f8291276b34edf6cf8b3afe267a093603a14b59c4bedb867af0383dd137b6b78992d7b9194dfd133535f811f2654a1077d61409c8ee

data/.rubocop.yml

@@ -56,3 +56,6 @@ Metrics/PerceivedComplexity:
   Exclude:
     # It's hard to control.
     - lib/code_keeper/metrics/class_length.rb 
+
+Metrics/MethodLength:
+  Max: 40

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unrelease
 
+## 0.5.1 (2021-09-19)
+### Bug fixes
+- [34](https://github.com/ebihara99999/code_keeper/pull/34): A result of the class_length doesn't show namespaces, and the class_length doesn't count comments of inner classes correctly.
+
 ## 0.5.0 (2021-09-16)
 ### Changes
 - [32](https://github.com/ebihara99999/code_keeper/pull/32): Specify dependency versions and loosen the supported ruby version.
@@ -15,7 +19,6 @@
 ### New features
 - [#26](https://github.com/ebihara99999/code_keeper/pull/26): Support an ABC software metric.
 - [#27](https://github.com/ebihara99999/code_keeper/pull/27): Support a class length metric.
-### Bug fixes
 
 ### Changes
 - [#25](https://github.com/ebihara99999/code_keeper/pull/25): Remove redundant codes.

data/lib/code_keeper/metrics/class_length.rb

@@ -12,14 +12,15 @@ module CodeKeeper
 
       # NOTE: This doesn't exclude foldale sources like Array, Hash and Heredoc.
       def score
-        @body.each_node(:class, :casgn) do |node|
-          if node.class_type?
-            @score_hash.store(node.loc.name.source.to_sym, calculate(node))
+        @body.each_node(:class, :casgn, :module) do |node|
+          if node.class_type? || node.module_type?
+            @score_hash.store(build_namespace(node), calculate(node))
           elsif node.casgn_type?
             parent = node.parent
 
             if parent&.assignment?
               block_node = node.children[2]
+              klass = node.loc.name.source
             elsif parent&.parent&.masgn_type?
               # In the case where `A, B = Struct.new(:a, :b)`,
               # B is always nil.
@@ -27,8 +28,10 @@ module CodeKeeper
               next unless node.loc.name.source == assigned
 
               block_node = parent.parent.children[1]
+              klass = node.loc.name.source
             else
               _scope, klass, block_node = *node
+              klass = klass.to_s
             end
 
             # This is not to raise error on dynamic assignments like `X = Y = Z = Class.new`.
@@ -37,10 +40,13 @@ module CodeKeeper
             # Similarly the block node is `:X` as follows if node is Y.
             next unless block_node.respond_to?(:class_definition?) && block_node.class_definition?
 
-            # if the parent is an assignment_type or the parent of the parent is a masgn_type,
-            klass ||= node.loc.name.source.to_sym
-
-            @score_hash.store(klass, calculate(block_node))
+            # NOTE: klass doesn't have a namespace.
+            # Only supports namepaces in `class A; end` case.
+            if klass
+              @score_hash.store(klass, calculate(block_node)) if klass
+            else
+              @score_hash.store(build_namespace(block_node), calculate(block_node))
+            end
           end
         end
         @score_hash
@@ -50,24 +56,67 @@ module CodeKeeper
 
       def calculate(node)
         # node.body.line_count doesn't include comments after definition of a class.
-        count = node.nonempty_line_count - 2
-        count - line_count_of_inner_nodes(node) - comment_line_count(node)
+        # Don't use nonempty_lines. Empty lines are considered on only the node.
+        count = node.line_count - 2
+
+        count - line_count_of_inner_nodes(node) - comment_line_count(node) - empty_line_count(node)
+      end
+
+      def body_lines(node)
+        (node.first_line..node.last_line).to_a - descendant_class_lines(node)
+      end
+
+      def descendant_class_lines(node)
+        # A class may have multiple inner classes seperately.
+        # So it needs to store all descendant classes line ranges.
+        node.each_descendant(:class, :module).map do |desendant|
+          # To make easier to compare and consider inner nodes, change array of line range into an array of line numbers.
+          (desendant.first_line..desendant.last_line).to_a
+        end.flatten.uniq
+      end
+
+      def empty_line_count(node)
+        empty_lines = @ps.lines.filter_map.with_index { |line, i| i + 1 if line.empty? }
+        (empty_lines & body_lines(node)).size
       end
 
       def line_count_of_inner_nodes(node)
-        count = 0
-        node.each_descendant(:class, :module) do |klass_or_module_node|
-          count += klass_or_module_node.nonempty_line_count
-        end
-        count
+        line_numbers = node.each_descendant(:class, :module).map do |descendant|
+          (descendant.first_line..descendant.last_line).to_a
+        end.flatten.uniq
+
+        line_numbers.size
       end
 
+      # Only counts the comment of the class or module of a node.
+      # Because `#line_count_of_inner_nodes` only considers the first inner node,
+      # the second or later inner nodes' commments are not necesarry to be counted.
       def comment_line_count(node)
-        count = 0
-        @ps.comments.each do |comment|
-          count += 1 if (node.first_line...node.last_line).include? comment.loc.line
+        node_range = node.first_line...node.last_line
+        comment_lines = @ps.comments.map { |comment| comment.loc.line }
+        # The latter condition considers a class ouside or above the node.
+        comment_lines.select { |cl| !descendant_class_lines(node).include?(cl) && node_range.include?(cl) }.count
+      end
+
+      def build_namespace(node)
+        self_name = name_with_ns(node)
+
+        return self_name if node.each_ancestor(:class, :module).to_a.empty?
+
+        full_name = self_name.dup
+        node.each_ancestor(:class, :module) do |ancestor|
+          full_name = "#{name_with_ns(ancestor)}::#{full_name}"
+        end
+        full_name
+      end
+
+      def name_with_ns(node)
+        ns = node.children.first&.namespace&.source
+        if ns.nil?
+          node.children.first&.short_name.to_s
+        else
+          node.children.first.namespace.source + "::#{node.children.first.short_name}"
         end
-        count
       end
     end
   end

data/lib/code_keeper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CodeKeeper
-  VERSION = "0.5.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: code_keeper
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yusuke Ebihara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-15 00:00:00.000000000 Z
+date: 2021-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
@@ -68,7 +68,6 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile

data/Gemfile.lock

@@ -1,57 +0,0 @@
-PATH
-  remote: .
-  specs:
-    code_keeper (0.4.0)
-      parallel (~> 1.20.1)
-      rubocop (~> 1.13.0)
-      rubocop-ast (~> 1.4.1)
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    diff-lcs (1.4.4)
-    parallel (1.20.1)
-    parser (3.0.2.0)
-      ast (~> 2.4.1)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
-    rexml (3.2.5)
-    rspec (3.10.0)
-      rspec-core (~> 3.10.0)
-      rspec-expectations (~> 3.10.0)
-      rspec-mocks (~> 3.10.0)
-    rspec-core (3.10.1)
-      rspec-support (~> 3.10.0)
-    rspec-expectations (3.10.1)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
-      diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
-      parallel (~> 1.10)
-      parser (>= 3.0.0.0)
-      rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
-      ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.2)
-      parser (>= 3.0.1.1)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.1.0)
-
-PLATFORMS
-  x86_64-linux
-
-DEPENDENCIES
-  code_keeper!
-  rake (~> 13.0)
-  rspec (~> 3.0)
-
-BUNDLED WITH
-   2.2.3