code_keeper 0.1.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: da70c28c42b1b848e40adb6145d25686ed8e8bea4dbf25adeb49bebbb82555a8
-  data.tar.gz: dcf7b9aebd57660ded6869224c87769d836c8518a19b46c74a8d1c86edd1e9b4
+  metadata.gz: f1032e75ff8322d23a622e6bac5a04039939999032d5559e9ff54d46f04ccd16
+  data.tar.gz: 51e78032de7754ea37aacd6ea422d46e4c66cc94c5c5d10a2baf963cee475ee1
 SHA512:
-  metadata.gz: e6dcab3c8280feb01e837e87025d5d71f6913f74b64c5afa22c36e126e8d69f8321c4445653088fc8fa82a4ee5c4bf2dffef825f92e6c5e5fbf4177a9ce725fd
-  data.tar.gz: 6d40b0fe93e685cbe3d982dd467dc843138686bdf08a95964b90da4187587fb9e4a3ffcab454dbc1b90ad086e9df6bf56d96cb2152dabf72450bc203790bde42
+  metadata.gz: eedf3bcecbd0ad563300548c9b1ac9b7d2ddec52550b459754fa1556e052940ad36ce7c5fd9afdb6df0768ea5ce9dd04680d3cae6a68112d106cb4ddf6611073
+  data.tar.gz: c527a3f3a175535b53512f8291276b34edf6cf8b3afe267a093603a14b59c4bedb867af0383dd137b6b78992d7b9194dfd133535f811f2654a1077d61409c8ee

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]
+    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
 
@@ -44,3 +43,19 @@ Style/Documentation:
 
 Metrics/AbcSize:
   Max: 25
+  Exclude:
+    # It's hard to control.
+    - lib/code_keeper/metrics/class_length.rb
+
+Metrics/CyclomaticComplexity:
+  Exclude:
+    # It's hard to control.
+    - lib/code_keeper/metrics/class_length.rb 
+
+Metrics/PerceivedComplexity:
+  Exclude:
+    # It's hard to control.
+    - lib/code_keeper/metrics/class_length.rb 
+
+Metrics/MethodLength:
+  Max: 40

data/CHANGELOG.md

@@ -0,0 +1,24 @@
+# Change log
+
+## 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.
+
+## 0.4.0 (2021-09-15)
+### New features
+- [#30](https://github.com/ebihara99999/code_keeper/pull/30): Support CSV and JSON format.
+
+## 0.3.0 (2021-09-15)
+
+### 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.
+
+### Changes
+- [#25](https://github.com/ebihara99999/code_keeper/pull/25): Remove redundant codes.

data/README.md

@@ -3,7 +3,7 @@ The CodeKeeper measures metrics especially about complexity and size of Ruby fil
 
 Mesuring metrics leads to keep codebase simple and clean, and I name the gem CodeKeeper.
 
-Now CodeKeeper supports the cyclomatic complexity. The scores are output to stdout.
+Now CodeKeeper supports the cyclomatic complexity of a file, the ABC software metric of a file, and class length. The scores are output to stdout of a json or csv format.
 
 ## Installation
 
@@ -25,18 +25,11 @@ Or install it yourself as:
 Run CodeKeeper and you get scores of metrics from stdout like 
 
 ```rb
-$ bundle exec code_keeper ./app/models
-Scores:
-
-Metric: cyclomatic_complexity
-Filename: app/models/admin.rb
-Score: 1
----
-Metric: cyclomatic_complexity
-Filename: app/models/user.rb
-Score: 23
----
+$ bundle exec code_keeper app/models/user.rb app/models/admin.rb > metrics.json
+$ cat metrics.json
+{"cyclomatic_complexity":{"app/models/admin.rb":9,"app/models/user.rb":23},"class_length":{"Admin":86,"User":1475},"abc_metric":{"app/models/admin.rb":76.909,"app/models/user.rb":1546.4155}}
 ```
+If you need a csv format, change the configuration as explained later.
 
 ### Run CodeKeeper
 To measure metrics of all the ruby files recursively in the current directory, run
@@ -55,9 +48,11 @@ CodeKeeper makes you configure the following way:
 ```rb
 CodeKeeper.configure do |config|
   # If you choose metrics, specify as follows:
-  config.metrics = [:cyclomatic_complexity]
+  config.metrics = %i(cyclomatic_complexity abc_metric class_length)
   # The number of threads. The default is 2. Executed sequentially if you set 1.
   config.number_of_threads = 4
+  # The default is json
+  config.format = :json
 end
 ```
 

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

@@ -3,11 +3,12 @@
 module CodeKeeper
   # Provide configuration
   class Config
-    attr_accessor :metrics, :number_of_threads
+    attr_accessor :metrics, :number_of_threads, :format
 
     def initialize
-      @metrics = [:cyclomatic_complexity]
+      @metrics = %i[cyclomatic_complexity class_length abc_metric]
       @number_of_threads = 2
+      @format = :json # json and csv are supported.
     end
   end
 end

data/lib/code_keeper/finder.rb

@@ -16,13 +16,7 @@ module CodeKeeper
     private
 
     def search_recursively(file_or_dir_paths)
-      checked = {}
-
       file_or_dir_paths.each do |edge|
-        next if checked[:"#{edge}"]
-
-        checked[:"#{edge}"] = true
-
         if FileTest.file?(edge)
           file_or_dir_paths << edge unless file_or_dir_paths.include?(edge)
         else

data/lib/code_keeper/formatter.rb

@@ -1,26 +1,25 @@
 # frozen_string_literal: true
 
+require 'csv'
+
 module CodeKeeper
   # Format a result and make it human-readable.
   class Formatter
     class << self
       def format(result)
-        title = "Scores:\n\n"
-        formatted_result = +title
+        return result.scores.to_json if CodeKeeper.config.format == :json
 
+        # csv is supported besides json
+        csv_array = []
         result.scores.each_key do |metric|
-          result.scores[metric].each do |k, v|
-            formatted_result.concat(
-              <<~EOS
-                Metric: #{metric}
-                Filename: #{k}
-                Score: #{v}
-                ---
-              EOS
-            )
-          end
+          result.scores[metric].each { |k, v| csv_array << [metric, k, v] }
+        end
+
+        headers = %w[metric file score]
+        CSV.generate(headers: true) do |csv|
+          csv << headers
+          csv_array.each { |array| csv << array }
         end
-        formatted_result
       end
     end
   end

data/lib/code_keeper/metrics/abc_metric.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module CodeKeeper
+  module Metrics
+    # Caluculate cyclomatic complexity
+    class AbcMetric
+      include ::RuboCop::Cop::Metrics::Utils::IteratingBlock
+      include ::RuboCop::Cop::Metrics::Utils::RepeatedCsendDiscount
+
+      def initialize(file_path)
+        ps = Parser.parse(file_path)
+        @path = file_path
+        @body = ps.ast
+        @assignments = 0
+        @branches = 0
+        @conditionals = 0
+      end
+
+      def score
+        caluculator = ::RuboCop::Cop::Metrics::Utils::AbcSizeCalculator.new(@body)
+        caluculator.calculate
+        @assignments = caluculator.instance_variable_get('@assignment')
+        @conditionals = caluculator.instance_variable_get('@condition')
+        @branches = caluculator.instance_variable_get('@branch')
+
+        value = Math.sqrt(@assignments**2 + @branches**2 + @conditionals**2).round(4)
+        { "#{@path}": value }
+      end
+    end
+  end
+end

data/lib/code_keeper/metrics/class_length.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module CodeKeeper
+  module Metrics
+    # Caluculate Class Length.
+    class ClassLength
+      def initialize(file_path)
+        @ps = Parser.parse(file_path)
+        @body = @ps.ast
+        @score_hash = {}
+      end
+
+      # NOTE: This doesn't exclude foldale sources like Array, Hash and Heredoc.
+      def score
+        @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.
+              assigned = parent.loc.expression.source.split(',').first
+              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`.
+            # the block node is as follows if node is X:
+            # `s(:casgn, nil, :Y, s(:casgn, nil, :Z, s(:block, ...`
+            # Similarly the block node is `:X` as follows if node is Y.
+            next unless block_node.respond_to?(:class_definition?) && block_node.class_definition?
+
+            # 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
+      end
+
+      private
+
+      def calculate(node)
+        # node.body.line_count doesn't include comments after definition of a class.
+        # 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)
+        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)
+        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
+      end
+    end
+  end
+end

data/lib/code_keeper/metrics/cyclomatic_complexity.rb

@@ -10,18 +10,20 @@ module CodeKeeper
       CONSIDERED_NODES = %i[if while until for csend block block_pass rescue when and or or_asgnand_asgn].freeze
 
       def initialize(file_path)
-        ps = Parser.parse(file_path)
+        @path = file_path
+        ps = Parser.parse(@path)
         @body = ps.ast
       end
 
       # returns score of cyclomatic complexity
       def score
-        @body.each_node(:lvasgn, *CONSIDERED_NODES).reduce(1) do |score, node|
+        final_score = @body.each_node(:lvasgn, *CONSIDERED_NODES).reduce(1) do |score, node|
           next score if !iterating_block?(node) || node.lvasgn_type?
           next score if node.csend_type? && discount_for_repeated_csend?(node)
 
           next 1 + score
         end
+        { "#{@path}": final_score }
       end
     end
   end

data/lib/code_keeper/metrics.rb

@@ -1,10 +1,16 @@
 # frozen_string_literal: true
 
+require 'code_keeper/metrics/abc_metric'
 require 'code_keeper/metrics/cyclomatic_complexity'
+require 'code_keeper/metrics/class_length'
 
 module CodeKeeper
   # Manage config values of metrics and the correspond classes
   module Metrics
-    MAPPINGS = { cyclomatic_complexity: CodeKeeper::Metrics::CyclomaticComplexity }.freeze
+    MAPPINGS = {
+      abc_metric: CodeKeeper::Metrics::AbcMetric,
+      cyclomatic_complexity: CodeKeeper::Metrics::CyclomaticComplexity,
+      class_length: CodeKeeper::Metrics::ClassLength
+    }.freeze
   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/result.rb

@@ -9,8 +9,8 @@ module CodeKeeper
       @scores = CodeKeeper.config.metrics.map { |key| [key, {}] }.to_h
     end
 
-    def add(metric, path, score)
-      scores[:"#{metric}"].store(path, score)
+    def add(metric, klass_or_path, score)
+      scores[:"#{metric}"].store(klass_or_path, score)
     end
   end
 end

data/lib/code_keeper/scorer.rb

@@ -14,20 +14,27 @@ module CodeKeeper
         # `in_threads: 1` makes 2 threads, a sleep_forever thread and the main thread.
         if num_threads == 1
           ruby_file_paths.each do |path|
-            metrics.each do |metric|
-              result.add(:cyclomatic_complexity, path, ::CodeKeeper::Metrics::MAPPINGS[metric].new(path).score)
-            end
+            metrics.each { |metric| calculate_score(metric, path, result) }
           end
         else
           Parallel.map(ruby_file_paths, in_threads: num_threads) do |path|
-            metrics.each do |metric|
-              result.add(:cyclomatic_complexity, path, ::CodeKeeper::Metrics::MAPPINGS[metric].new(path).score)
-            end
+            metrics.each { |metric| calculate_score(metric, path, result) }
           end
         end
 
         result
       end
+
+      private
+
+      def calculate_score(metric, path, result)
+        score = ::CodeKeeper::Metrics::MAPPINGS[metric].new(path).score
+
+        # The class length metric's score has multiple classes.
+        score.each do |k, v|
+          result.add(metric, k.to_s, v)
+        end
+      end
     end
   end
 end

data/lib/code_keeper/version.rb

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

data/lib/code_keeper.rb

@@ -10,7 +10,9 @@ require 'code_keeper/config'
 require 'code_keeper/scorer'
 require 'code_keeper/result'
 require 'code_keeper/metrics'
+require 'code_keeper/metrics/abc_metric'
 require 'code_keeper/metrics/cyclomatic_complexity'
+require 'code_keeper/metrics/class_length'
 
 module CodeKeeper
   class << self

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: code_keeper
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Yusuke Ebihara
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-08-18 00:00:00.000000000 Z
+date: 2021-09-19 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:
@@ -65,9 +65,9 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
-- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -81,6 +81,8 @@ files:
 - lib/code_keeper/finder.rb
 - lib/code_keeper/formatter.rb
 - lib/code_keeper/metrics.rb
+- lib/code_keeper/metrics/abc_metric.rb
+- lib/code_keeper/metrics/class_length.rb
 - lib/code_keeper/metrics/cyclomatic_complexity.rb
 - lib/code_keeper/parser.rb
 - lib/code_keeper/result.rb
@@ -101,7 +103,7 @@ 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:
   - - ">="

data/Gemfile.lock

@@ -1,69 +0,0 @@
-PATH
-  remote: .
-  specs:
-    code_keeper (0.1.0)
-      parallel
-      rubocop
-      rubocop-ast
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    ast (2.4.2)
-    coderay (1.1.3)
-    diff-lcs (1.4.4)
-    method_source (0.9.2)
-    parallel (1.20.1)
-    parser (3.0.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)
-    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.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.11.0)
-    unicode-display_width (2.0.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