abc_size_visualizer 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f52f861e9648b636dfcc86181cc365b79ba093a4a09c4c45353ccd1e4dacb7f2
+  data.tar.gz: 95876ace082fd00b1b82db979a9472e0561e560dcca9191e76b581bb924da6e0
+SHA512:
+  metadata.gz: 57e4bd8f098bf144f50f8e89f11ca10c95c9362b5bdfa94b0475d993e092bfaba206f06946fccf0f26903761155bb7a261c9f3b59893cf7b6c284f46021224f3
+  data.tar.gz: 4dc54f448f0d9ed9f78ef7453917ed3fcb5e676e5f16a44b9d0a9df7708beed623720447bb1ae4ebf29b5c091c3011e148558bdc3811d01ac0a630daa279e464

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.standard.yml

@@ -0,0 +1,3 @@
+# For available configuration options, see:
+#   https://github.com/testdouble/standard
+ruby_version: 3.1

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in abc_size_visualizer.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "standard", "~> 1.3"
+
+gem "debug", "~> 1.6"

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    abc_size_visualizer (0.1.0)
+      colorize (~> 0.8.0)
+      rouge (~> 4.0.0)
+      rubocop (~> 1.39.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    colorize (0.8.1)
+    debug (1.6.3)
+      irb (>= 1.3.6)
+      reline (>= 0.3.1)
+    diff-lcs (1.5.0)
+    io-console (0.5.11)
+    irb (1.5.0)
+      reline (>= 0.3.0)
+    json (2.6.2)
+    language_server-protocol (3.17.0.1)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.6.1)
+    reline (0.3.1)
+      io-console (~> 0.5)
+    rexml (3.2.5)
+    rouge (4.0.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.0)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
+    standard (1.19.0)
+      language_server-protocol (= 3.17.0.1)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.1)
+    unicode-display_width (2.3.0)
+
+PLATFORMS
+  arm64-darwin-21
+
+DEPENDENCIES
+  abc_size_visualizer!
+  debug (~> 1.6)
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  standard (~> 1.3)
+
+BUNDLED WITH
+   2.3.15

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Yusuke Sangenya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,18 @@
+# AbcSizeVisualizer
+
+```bash
+$ gem install abc_size_visualizer
+$ abc_size_visualizer some_code.rb
+# prints size of 1)assignment 2)branch 3)condition with code.
+# red means assignment, yellow means branch, blue means condition
+```
+
+![screenshot](./docs/screenshot.png)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/genya0407/abc_size_visualizer.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "standard/rake"
+
+task default: %i[spec standard]

data/exe/visualize_abc_size

@@ -0,0 +1,90 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/lib")
+
+require "abc_size_visualizer"
+
+module AbcSizeVisualizer
+  class VisualizeAbcSize
+    COLOR_BY_TYPE = {
+      assignment: :red,
+      branch: :yellow,
+      condition: :blue
+    }
+    MAX_BAR_SIZE = 20
+
+    def initialize(source_file_name:)
+      @abc_size_result = []
+      @source = File.read(source_file_name)
+      buffer = Parser::Source::Buffer.new(source_file_name, source: @source)
+      parser = Parser::CurrentRuby.new(RuboCop::AST::Builder.new)
+      @node = parser.parse(buffer)
+      @highlighted_source_by_line_num = begin
+        formatter = Rouge::Formatters::TerminalTruecolor.new
+        lexer = Rouge::Lexers::Ruby.new
+        formatter.format(lexer.lex(@source)).lines(chomp: true).zip(1..).map do |line, line_num|
+          [line_num, line]
+        end.to_h
+      end
+    end
+
+    def execute
+      calculators = analyze(@node)
+
+      @source.lines(chomp: true).zip(1..).each do |line, line_num|
+        calculator = calculators.find { |calculator| calculator.abc_by_line_num[line_num] }
+        bar = generate_bar(calculator:, line_num:).ljust(MAX_BAR_SIZE + 3)
+        highlighted_line = @highlighted_source_by_line_num[line_num]
+        annotation = generate_annotation(calculator:, line_num:)
+        puts [bar, highlighted_line, annotation].join("")
+      end
+    end
+
+    private
+
+    def analyze(node)
+      case node.type
+      when :def, :defs
+        calculator = ::AbcSizeVisualizer::AbcSizeCalculator.new(node)
+        calculator.calculate
+        [calculator]
+      when :begin, :module, :class
+        node.each_child_node.flat_map do |child_node|
+          analyze(child_node)
+        end
+      else
+        []
+      end
+    end
+
+    def generate_bar(calculator:, line_num:)
+      if calculator
+        abc_size_by_type = calculator.abc_by_line_num[line_num]
+        max_abc = calculator.abc_by_line_num.values.map { |abc| abc.values.sum }.max
+        types = %i[assignment branch condition]
+        sizes = types.map do |type|
+          (MAX_BAR_SIZE * (abc_size_by_type[type].to_f / max_abc)).ceil
+        end
+        bar = sizes.zip(types).map do |size, type|
+          ColorizedString[" " * size].colorize(background: COLOR_BY_TYPE[type])
+        end.join("")
+        ljust_count = [(MAX_BAR_SIZE + 3) - sizes.sum, 0].max
+        bar + (" " * ljust_count)
+      else
+        " " * (MAX_BAR_SIZE + 3)
+      end
+    end
+
+    def generate_annotation(calculator:, line_num:)
+      return "" unless calculator
+
+      abc_size_by_type = calculator.abc_by_line_num[line_num]
+      return "" if abc_size_by_type.values.sum <= 0
+
+      " # <" + abc_size_by_type.values_at(:assignment, :branch, :condition).join(", ") + ">"
+    end
+  end
+end
+
+AbcSizeVisualizer::VisualizeAbcSize.new(source_file_name: ARGV[0]).execute

data/lib/abc_size_visualizer/abc_size_calculator.rb

@@ -0,0 +1,151 @@
+# Based on https://github.com/rubocop/rubocop/blob/master/lib/rubocop/cop/metrics/utils/abc_size_calculator.rb
+
+module AbcSizeVisualizer
+  # > ABC is .. a software size metric .. computed by counting the number
+  # > of assignments, branches and conditions for a section of code.
+  # > http://c2.com/cgi/wiki?AbcMetric
+  #
+  # We separate the *calculator* from the *cop* so that the calculation,
+  # the formula itself, is easier to test.
+  class AbcSizeCalculator
+    include RuboCop::Cop::Metrics::Utils::IteratingBlock
+    include RuboCop::Cop::Metrics::Utils::RepeatedCsendDiscount
+    prepend RuboCop::Cop::Metrics::Utils::RepeatedAttributeDiscount
+
+    # > Branch -- an explicit forward program branch out of scope -- a
+    # > function call, class method call ..
+    # > http://c2.com/cgi/wiki?AbcMetric
+    BRANCH_NODES = %i[send csend yield].freeze
+
+    # > Condition -- a logical/Boolean test, == != <= >= < > else case
+    # > default try catch ? and unary conditionals.
+    # > http://c2.com/cgi/wiki?AbcMetric
+    CONDITION_NODES = RuboCop::Cop::Metrics::CyclomaticComplexity::COUNTED_NODES.freeze
+
+    def self.calculate(node, discount_repeated_attributes: false)
+      new(node, discount_repeated_attributes:).calculate
+    end
+
+    # TODO: move to rubocop-ast
+    ARGUMENT_TYPES = %i[arg optarg restarg kwarg kwoptarg kwrestarg blockarg].freeze
+
+    private_constant :BRANCH_NODES, :CONDITION_NODES, :ARGUMENT_TYPES
+
+    attr_reader :assignment, :branch, :condition
+
+    def initialize(node)
+      @assignment = IntegerOnLocation.new
+      @branch = IntegerOnLocation.new
+      @condition = IntegerOnLocation.new
+      @node = node
+      reset_repeated_csend
+    end
+
+    def abc_by_line_num
+      @abc_by_line_num ||= [@assignment, @branch, @condition].map(&:line_nums).flatten.map do |line_num|
+        [
+          line_num,
+          {assignment: @assignment, branch: @branch, condition: @condition}.transform_values do
+            _1.value_at(line_num:) || 0
+          end
+        ]
+      end.to_h
+    end
+
+    def calculate
+      visit_depth_last(@node) { |child| calculate_node(child) }
+
+      [
+        Math.sqrt((@assignment.to_i**2) + (@branch.to_i**2) + (@condition.to_i**2)).round(2),
+        "<#{@assignment.to_i}, #{@branch.to_i}, #{@condition.to_i}>"
+      ]
+    end
+
+    def evaluate_branch_nodes(node)
+      if node.comparison_method?
+        @condition.add(node, 1)
+      else
+        @branch.add(node, 1)
+        @condition.add(node, 1) if node.csend_type? && !discount_for_repeated_csend?(node)
+      end
+    end
+
+    def evaluate_condition_node(node)
+      @condition.add(node, 1) if else_branch?(node)
+      @condition.add(node, 1)
+    end
+
+    def else_branch?(node)
+      %i[case if].include?(node.type) && node.else? && node.loc.else.is?("else")
+    end
+
+    private
+
+    def visit_depth_last(node, &block)
+      node.each_child_node { |child| visit_depth_last(child, &block) }
+      yield node
+    end
+
+    def calculate_node(node)
+      @assignment.add(node, 1) if assignment?(node)
+
+      if branch?(node)
+        evaluate_branch_nodes(node)
+      elsif condition?(node)
+        evaluate_condition_node(node)
+      end
+    end
+
+    def assignment?(node)
+      return compound_assignment(node) if node.masgn_type? || node.shorthand_asgn?
+
+      node.for_type? ||
+        (node.respond_to?(:setter_method?) && node.setter_method?) ||
+        simple_assignment?(node) ||
+        argument?(node)
+    end
+
+    def compound_assignment(node)
+      # Methods setter cannot be detected for multiple assignments
+      # and shorthand assigns, so we'll count them here instead
+      children = node.masgn_type? ? node.children[0].children : node.children
+
+      will_be_miscounted = children.count do |child|
+        child.respond_to?(:setter_method?) && !child.setter_method?
+      end
+      @assignment.add(node, will_be_miscounted)
+
+      false
+    end
+
+    def simple_assignment?(node)
+      if !node.equals_asgn?
+        false
+      elsif node.lvasgn_type?
+        reset_on_lvasgn(node)
+        capturing_variable?(node.children.first)
+      else
+        true
+      end
+    end
+
+    def capturing_variable?(name)
+      # TODO: Remove `Symbol#to_s` after supporting only Ruby >= 2.7.
+      name && !name.to_s.start_with?("_")
+    end
+
+    def branch?(node)
+      BRANCH_NODES.include?(node.type)
+    end
+
+    def argument?(node)
+      ARGUMENT_TYPES.include?(node.type) && capturing_variable?(node.children.first)
+    end
+
+    def condition?(node)
+      return false if iterating_block?(node) == false
+
+      CONDITION_NODES.include?(node.type)
+    end
+  end
+end

data/lib/abc_size_visualizer/integer_on_location.rb

@@ -0,0 +1,27 @@
+module AbcSizeVisualizer
+  class IntegerOnLocation
+    attr_reader :value_by_line_num
+
+    def initialize
+      @value_by_line_num = {}
+    end
+
+    def add(node, value)
+      line_num = node.loc.expression.line
+      @value_by_line_num[line_num] ||= 0
+      @value_by_line_num[line_num] += value
+    end
+
+    def value_at(line_num:)
+      @value_by_line_num[line_num]
+    end
+
+    def to_i
+      @value_by_line_num.values.sum || 0
+    end
+
+    def line_nums
+      @value_by_line_num.keys
+    end
+  end
+end

data/lib/abc_size_visualizer/version.rb

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

data/lib/abc_size_visualizer.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require "rubocop"
+require "parser/current"
+require "colorized_string"
+require "rouge"
+
+require_relative "abc_size_visualizer/abc_size_calculator"
+require_relative "abc_size_visualizer/integer_on_location"
+require_relative "abc_size_visualizer/version"
+
+module AbcSizeVisualizer
+  class Error < StandardError; end
+  # Your code goes here...
+end

data/sig/abc_size_visualizer.rbs

@@ -0,0 +1,4 @@
+module AbcSizeVisualizer
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: abc_size_visualizer
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yusuke Sangenya
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.8.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.39.0
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 4.0.0
+description: Visualize ABC size
+email:
+- longinus.eva@gmail.com
+executables:
+- visualize_abc_size
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".standard.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/visualize_abc_size
+- lib/abc_size_visualizer.rb
+- lib/abc_size_visualizer/abc_size_calculator.rb
+- lib/abc_size_visualizer/integer_on_location.rb
+- lib/abc_size_visualizer/version.rb
+- sig/abc_size_visualizer.rbs
+homepage: https://github.com/genya0407/abc_size_visualizer
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/genya0407/abc_size_visualizer
+  source_code_uri: https://github.com/genya0407/abc_size_visualizer
+  changelog_uri: https://github.com/genya0407/abc_size_visualizer
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.5
+signing_key:
+specification_version: 4
+summary: Visualize ABC size.
+test_files: []