abc_size 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 293927810a67c15335a07661d8cb27585ee9856b0e95aeb9721e5e38e40c2d2c
+  data.tar.gz: 9a213a32372bf35afdf159222f192bd03fe46d79c5a8fc9480e1c0d31cd099ad
+SHA512:
+  metadata.gz: 1cc720a41c800a7a6e7b7f2fbccef9e1b90e325fec341c65084b3eb313e709bfd09914bc99dd66dcd481d7cdd0e29129033ccf2bed0f9104f0ba0a55e070e41f
+  data.tar.gz: 50d451798ee2b1f86acb242fb99cf347b3aaec1f75578e9603bd9b8ac6532406cad67534496bf669e25c5dbb1b2bec81bfe77833aa01606ca9fbea219401d144

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,18 @@
+require:
+  - rubocop-rake
+  - rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.6
+  NewCops: enable
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [0.1.2] - 2021-12-04
+
+- Updates README.md
+
+## [0.1.1] - 2021-12-04
+
+- Updates gems and gemspec
+
+## [0.1.0] - 2021-11-27
+
+- Initial release

data/Gemfile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in abc_size.gemspec
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+gem 'rubocop-rake', require: false
+gem 'rubocop-rspec', require: false

data/Gemfile.lock

@@ -0,0 +1,64 @@
+PATH
+  remote: .
+  specs:
+    abc_size (0.1.0)
+      rainbow (>= 3.0.0)
+      rubocop (>= 1.23.0)
+      rubocop-ast (>= 1.14.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.4.4)
+    parallel (1.21.0)
+    parser (3.0.3.1)
+      ast (~> 2.4.1)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    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.3)
+    rubocop (1.23.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.12.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.14.0)
+      parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.6.0)
+      rubocop (~> 1.19)
+    ruby-progressbar (1.11.0)
+    unicode-display_width (2.1.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  abc_size!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+  rubocop-rake
+  rubocop-rspec
+
+BUNDLED WITH
+   2.2.32

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Emil Furtak
+
+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,48 @@
+# abc_size
+
+Calculate ABC size, divided into methods defined in a single file.
+
+## Installation
+
+From RubyGems
+
+```sh
+gem install abc_size
+```
+
+From GitHub
+
+```sh
+git clone https://github.com/efurtak/abc_size
+```
+
+```sh
+cd abc_size
+```
+
+```sh
+gem build abc_size.gemspec
+```
+
+```sh
+gem install abc_size-*.gem
+```
+
+## Usage
+
+```sh
+abc [file] [options]
+```
+
+```
+Options:
+    -d, --discount    Discount repeated attributes
+```
+
+## Contributing
+
+Bug reports are welcome on GitHub at https://github.com/efurtak/abc_size.
+
+## 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,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'abc_size'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/abc

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require 'abc_size'
+
+path = ARGV[0]
+discount = ['-d', '--discount'].include?(ARGV[1])
+
+if path
+  AbcSize::Calculator.new.call(path: path, discount: discount)
+else
+  puts "Usage: abc [file] [options]\n"\
+       "\n"\
+       "Options:\n"\
+       '    -d, --discount    Discount repeated attributes'
+end

data/lib/abc_size/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AbcSize
+  VERSION = '0.1.2'
+end

data/lib/abc_size.rb

@@ -0,0 +1,83 @@
+# frozen_string_literal: true
+
+require_relative 'abc_size/version'
+
+require 'rainbow'
+require 'rubocop'
+require 'rubocop-ast'
+
+module AbcSize
+  class Error < StandardError; end
+
+  # class responsible for returning ABC size from ABC size calculator
+  class Calculator
+    SATISFACTORY_ABC_SIZE = 17
+
+    attr_reader :results
+
+    def initialize
+      @results = []
+    end
+
+    def call(source_code: nil, path: nil, discount: false)
+      source = source_code || source_code_from_file(path)
+      ruby_version = RuboCop::TargetRuby.supported_versions.last
+
+      nodes = RuboCop::AST::ProcessedSource.new(source, ruby_version).ast
+
+      nodes.each_node { |node| results << calculate_result(node, discount) if node.is_a?(RuboCop::AST::DefNode) }
+
+      print_results
+
+      print_interpretation
+
+      # return results for testing purposes
+      results
+    end
+
+    private
+
+    def source_code_from_file(path)
+      data = File.open(path, 'r').read
+      raise Error, 'File is empty!' if data.empty?
+
+      data
+    rescue TypeError, Errno::ENOENT, Errno::EISDIR, Error => e
+      puts "#{e.message}\n"\
+           'Please provide valid path to valid file.'
+      exit
+    end
+
+    def calculate_result(node, discount)
+      abc_size, abc = RuboCop::Cop::Metrics::Utils::AbcSizeCalculator.calculate(
+        node,
+        discount_repeated_attributes: discount
+      )
+
+      [abc_size, abc, node.method_name]
+    end
+
+    def print_results
+      results.each do |result|
+        abc_size, abc, method_name = result
+
+        satisfactory = abc_size <= SATISFACTORY_ABC_SIZE
+
+        puts "ABC size: #{color(format('%.2f', abc_size), satisfactory)}, "\
+             "ABC: #{color(abc, satisfactory)} "\
+             "for method: #{color(method_name, satisfactory)}"
+      end
+    end
+
+    def color(input, satisfactory)
+      color = satisfactory ? :yellow : :red
+      Rainbow(input).color(color)
+    end
+
+    def print_interpretation
+      puts "\n"\
+           "ABC size: <= 17 satisfactory, 18..30 unsatisfactory, > 30 dangerous\n"\
+           'ABC: <assignments, branches (method calls), conditions>'
+    end
+  end
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: abc_size
+version: !ruby/object:Gem::Version
+  version: 0.1.2
+platform: ruby
+authors:
+- Emil Furtak
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rainbow
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.23.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-ast
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.14.0
+description: Calculate ABC size, divided into methods defined in a single file.
+email:
+- emil.furtak@gmail.com
+executables:
+- abc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/abc
+- lib/abc_size.rb
+- lib/abc_size/version.rb
+homepage: https://github.com/efurtak/abc_size
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/efurtak/abc_size
+  source_code_uri: https://github.com/efurtak/abc_size
+  changelog_uri: https://github.com/efurtak/abc_size/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.6.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.32
+signing_key: 
+specification_version: 4
+summary: Calculate ABC size.
+test_files: []