code_keeper 0.4.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 36a68ad1540e4e6adb062bc85c1ab015c280bfe604ac5644cdfc21dd1df58c9d
-  data.tar.gz: 6850f00648efb8910be1eaf0125a3aa39a799a888a31e2c971946cab337dbdbb
+  metadata.gz: 66e68d33e3f03cbbe30bb5b77fcf0470667fc1ba9da620e3053f38707fd3b17b
+  data.tar.gz: 510711a6a8419fb0fcf803d532d332f7a353d9d84eda34a71cc52a56da6b265f
 SHA512:
-  metadata.gz: 87718f55c24471bee5b26d21d108445103111b135e117872d8c0e709b20a21cdbd6b865d06db277e29722eb607ba3bb687f8eef6c509e68a47c1563052d7b2e3
-  data.tar.gz: 63938e0590f3c9faa32ef9f71d7a1b45cc3685d0a46d2a53aaa6d8c222eefaf3119cb2bb5aac2eeb618a0bf092999c4283f3b98fc36554218624c4a9027b9054
+  metadata.gz: 36b18bf9a92fa12834dc74aa9e5985b2ad57c0e315a4b78ffc95deab045a14a08b884a83ef4592cf52cc3c4231695a0d8ed50334672e78e23d7fc4e6bb5ead33
+  data.tar.gz: cefd0d3ea837b5210b4bdb2ea63722fafb751f7c1b7d13f2a536a31b686993c97e2df832fac169239076d77497063a14cc92683d77334778c57e6fe91faa87b7

data/.github/workflows/main.yml

@@ -5,12 +5,16 @@ on: [push,pull_request]
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [2.7, 3.0, 3.1]
+    name: Ruby ${{ matrix.ruby }}
     steps:
     - uses: actions/checkout@v2
     - name: Set up Ruby
       uses: ruby/setup-ruby@v1
       with:
-        ruby-version: 3.0.0
+        ruby-version: ${{ matrix.ruby }}
     - name: Run the default task
       run: |
         gem install bundler -v 2.2.3

data/.rubocop.yml

@@ -1,5 +1,4 @@
 AllCops:
-  TargetRubyVersion: 3.0
   Exclude:
     - spec/fixtures/**/*.rb
 
@@ -57,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,18 @@
 
 ## Unrelease
 
+## 0.6.0 (2022-03-27)
+### New features
+- [35](https://github.com/ebihara99999/code_keeper/pull/35): Support Ruby 3.1.
+
+## 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.
+
 ## 0.4.0 (2021-09-15)
 ### New features
 - [#30](https://github.com/ebihara99999/code_keeper/pull/30): Support CSV and JSON format.
@@ -11,7 +23,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/Gemfile.lock

@@ -1,69 +1,57 @@
 PATH
   remote: .
   specs:
-    code_keeper (0.1.0)
-      parallel
-      rubocop
-      rubocop-ast
+    code_keeper (0.5.1)
+      parallel (~> 1.20.1)
+      rubocop (>= 1.13.0)
+      rubocop-ast (>= 1.4.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    method_source (0.9.2)
+    diff-lcs (1.5.0)
     parallel (1.20.1)
-    parser (3.0.1.0)
+    parser (3.1.1.0)
       ast (~> 2.4.1)
-    pry (0.12.2)
-      coderay (~> 1.1.0)
-      method_source (~> 0.9.0)
-    pry-nav (0.3.0)
-      pry (>= 0.9.10, < 0.13.0)
-    rainbow (3.0.0)
-    rake (13.0.3)
-    regexp_parser (2.1.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.2.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)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.2)
+      rspec-support (~> 3.11.0)
+    rspec-mocks (3.11.0)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
-    rubocop (1.13.0)
+      rspec-support (~> 3.11.0)
+    rspec-support (3.11.0)
+    rubocop (1.26.0)
       parallel (~> 1.10)
-      parser (>= 3.0.0.0)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.2.0, < 2.0)
+      rubocop-ast (>= 1.16.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.1)
-      parser (>= 2.7.1.5)
+    rubocop-ast (1.16.0)
+      parser (>= 3.1.1.0)
     ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   x86_64-linux
 
 DEPENDENCIES
   code_keeper!
-  parallel
-  pry
-  pry-nav
   rake (~> 13.0)
   rspec (~> 3.0)
-  rubocop
-  rubocop-ast
 
 BUNDLED WITH
-   2.2.3
+   2.3.3

data/code_keeper.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description   = "The CodeKeeper measures metrics especially about complexity and size of Ruby files, aiming to be a Ruby version of gmetrics."
   spec.homepage      = "https://github.com/ebihara99999/code_keeper"
   spec.license       = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = "https://github.com/ebihara99999/code_keeper/"
@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "parallel"
-  spec.add_dependency "rubocop"
-  spec.add_dependency "rubocop-ast"
+  spec.add_dependency "parallel", '~> 1.20.1'
+  spec.add_dependency "rubocop", '>= 1.13.0'
+  spec.add_dependency "rubocop-ast", '>= 1.4.1'
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

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/parser.rb

@@ -7,7 +7,7 @@ module CodeKeeper
 
     def initialize(file_path)
       source = File.read(File.expand_path(file_path))
-      @processed_source = ::RuboCop::AST::ProcessedSource.new(source, 3.0)
+      @processed_source = ::RuboCop::AST::ProcessedSource.new(source, RUBY_VERSION.to_f)
     rescue Errno::ENOENT
       raise TargetFileNotFoundError, "The target file does not exist. Check the file path: #{file_path}."
     end

data/lib/code_keeper/version.rb

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

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: code_keeper
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Yusuke Ebihara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-14 00:00:00.000000000 Z
+date: 2022-03-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parallel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.20.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.20.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: rubocop-ast
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.4.1
 description: The CodeKeeper measures metrics especially about complexity and size
   of Ruby files, aiming to be a Ruby version of gmetrics.
 email:
@@ -104,14 +104,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.3
 signing_key: 
 specification_version: 4
 summary: Measures metrics about complexity and size.