abc_size 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 293927810a67c15335a07661d8cb27585ee9856b0e95aeb9721e5e38e40c2d2c
-  data.tar.gz: 9a213a32372bf35afdf159222f192bd03fe46d79c5a8fc9480e1c0d31cd099ad
+  metadata.gz: 51190a5338c4af0c9142e1c7a34b038b36f27886423622e2f5ffba95abaa0115
+  data.tar.gz: 78085c24057b5c3c768afccbde767d3bfbb9cb00dfbece94317786980664198f
 SHA512:
-  metadata.gz: 1cc720a41c800a7a6e7b7f2fbccef9e1b90e325fec341c65084b3eb313e709bfd09914bc99dd66dcd481d7cdd0e29129033ccf2bed0f9104f0ba0a55e070e41f
-  data.tar.gz: 50d451798ee2b1f86acb242fb99cf347b3aaec1f75578e9603bd9b8ac6532406cad67534496bf669e25c5dbb1b2bec81bfe77833aa01606ca9fbea219401d144
+  metadata.gz: 6df3da3944879c32af3dc4a1880306529c3a966792c7ad308ae6c7c0e25598cbcbf0240363bbb3be839651dd7a867ed9e819dd5b4525feeb42bebdcd3d29aa11
+  data.tar.gz: 75beb2c8d15c2a700fdf7aabb6acad134e0ba70040cb775227ed32db850b19ba07e44f5d504bc10d0a16e8980170c05d4a54f08b4bbc93c40c42ac29e8fd5870

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## [0.1.3] - 2021-12-24
+
+- Processing Ruby code for specified Ruby version.
+- Ruby version detection from `.ruby-version` file at working directory.
+- Ruby version picking with `-r` or `--ruby` option.
+
 ## [0.1.2] - 2021-12-04
 
 - Updates README.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    abc_size (0.1.0)
+    abc_size (0.1.3)
       rainbow (>= 3.0.0)
       rubocop (>= 1.23.0)
       rubocop-ast (>= 1.14.0)

data/README.md

@@ -37,8 +37,14 @@ abc [file] [options]
 ```
 Options:
     -d, --discount    Discount repeated attributes
+    -r, --ruby        Ruby version
 ```
 
+Ruby code can be processed for specified Ruby version.
+
+Default behavior is to detect it from `.ruby-version` file at working directory.
+Alternatively it can be picked with `-r` or `--ruby` option.
+
 ## Contributing
 
 Bug reports are welcome on GitHub at https://github.com/efurtak/abc_size.

data/exe/abc

@@ -1,18 +1,19 @@
 #!/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])
+path, *parameters = ARGV
 
 if path
-  AbcSize::Calculator.new.call(path: path, discount: discount)
+  AbcSize::Calculator.new(path: path, parameters: parameters).call
 else
   puts "Usage: abc [file] [options]\n"\
        "\n"\
        "Options:\n"\
-       '    -d, --discount    Discount repeated attributes'
+       "    -d, --discount    Discount repeated attributes\n"\
+       '    -r, --ruby        Ruby version'
 end

data/lib/abc_size/calculator.rb

@@ -0,0 +1,97 @@
+# frozen_string_literal: true
+
+require 'rainbow'
+require 'rubocop'
+require 'rubocop-ast'
+
+module AbcSize
+  # main class
+  class Calculator
+    SATISFACTORY_ABC_SIZE = 17
+
+    attr_reader :source_code, :path, :parameters, :discount, :results, :ruby_version
+
+    def initialize(source_code: nil, path: nil, parameters: nil)
+      @source_code = source_code
+      @path = path
+      @parameters = parameters
+
+      @discount = @parameters.map { |parameter| ['-d', '--discount'].include?(parameter) }.any?(true)
+
+      @results = []
+    end
+
+    def call
+      source = source_code || read_source_code_from_file
+      @ruby_version = return_ruby_version
+
+      nodes = RuboCop::AST::ProcessedSource.new(source, ruby_version).ast
+      nodes.each_node { |node| results << calculate_result(node) if node.is_a?(RuboCop::AST::DefNode) }
+
+      print_all_messages
+
+      # return results for testing purposes
+      results
+    end
+
+    private
+
+    def read_source_code_from_file
+      data = File.read(path)
+      raise EmptyFileError, 'File is empty!' if data.empty?
+
+      data
+    rescue TypeError, Errno::ENOENT, Errno::EISDIR, EmptyFileError => e
+      puts "#{e.message}\n"\
+           'Please provide valid path to valid file.'
+      exit
+    end
+
+    def return_ruby_version
+      RubyVersion::Picker.new(parameters).call || RubyVersion::Detector.new.call
+    end
+
+    def calculate_result(node)
+      abc_size, abc = RuboCop::Cop::Metrics::Utils::AbcSizeCalculator.calculate(
+        node,
+        discount_repeated_attributes: discount
+      )
+
+      [abc_size, abc, node.method_name]
+    end
+
+    def color(input, satisfactory)
+      color = satisfactory ? :yellow : :red
+      Rainbow(input).color(color)
+    end
+
+    def print_all_messages
+      print_version
+      print_results
+      print_interpretation
+    end
+
+    def print_version
+      puts "Processed for Ruby version: #{color(ruby_version, true)}\n"\
+           "\n"
+    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 print_interpretation
+      puts "\n"\
+           "ABC size: <= 17 satisfactory, 18..30 unsatisfactory, > 30 dangerous\n"\
+           'ABC: <assignments, branches (method calls), conditions>'
+    end
+  end
+end

data/lib/abc_size/errors.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module AbcSize
+  class Error < StandardError; end
+
+  class EmptyFileError < Error; end
+
+  class UnknownFormatError < Error; end
+
+  class UnsupportedVersionError < Error; end
+end

data/lib/abc_size/ruby_version/detector.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module AbcSize
+  module RubyVersion
+    # Ruby version detector
+    class Detector
+      include Common
+
+      RUBY_VERSION_FILENAME = '.ruby-version'
+
+      def call
+        file_version = return_file_version
+
+        return_supported_version_if_version_supported(file_version)
+      rescue Errno::ENOENT, EmptyFileError, UnknownFormatError => e
+        rescue_detection_error(e)
+      end
+
+      private
+
+      def return_file_version
+        data = return_data
+
+        match_data = return_match_data(data)
+
+        match_data[0].to_f
+      end
+
+      def return_data
+        path = "#{Dir.pwd}/#{RUBY_VERSION_FILENAME}"
+
+        data = File.read(path)
+        raise EmptyFileError if data.empty?
+
+        data
+      end
+
+      def return_match_data(data)
+        match_data = data.match(/\A\d+\.\d+/)
+        raise UnknownFormatError if match_data.nil?
+
+        match_data
+      end
+
+      def rescue_detection_error(error)
+        case error
+        when Errno::ENOENT
+          puts 'Not detected `.ruby-version` file!'
+        when EmptyFileError
+          puts 'Detected `.ruby-version` file, but file is empty!'
+        when UnknownFormatError
+          puts 'Detected `.ruby-version` file, but file contain unknown format!'
+        end
+        exit
+      end
+    end
+  end
+end

data/lib/abc_size/ruby_version/picker.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module AbcSize
+  module RubyVersion
+    # Ruby version picker
+    class Picker
+      include Common
+
+      attr_reader :parameters, :parameter_index
+
+      def initialize(parameters)
+        @parameters = parameters
+        @parameter_index = @parameters.index('-r') || @parameters.index('--ruby')
+      end
+
+      def call
+        return if parameter_index.nil?
+
+        value_index = parameter_index + 1
+
+        parameters_version = parameters[value_index].to_f
+
+        return_supported_version_if_version_supported(parameters_version)
+      end
+    end
+  end
+end

data/lib/abc_size/ruby_version.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module AbcSize
+  module RubyVersion
+    SUPPORTED_VERSIONS = RuboCop::TargetRuby.supported_versions.freeze
+
+    # common methods
+    module Common
+      def return_supported_version_if_version_supported(version)
+        supported_version = RubyVersion::SUPPORTED_VERSIONS.include?(version) ? version : nil
+        raise UnsupportedVersionError, 'Unsupported Ruby version given.' if supported_version.nil?
+
+        supported_version
+      rescue UnsupportedVersionError => e
+        puts "#{e.message}\n"\
+             "Supported versions: #{RubyVersion::SUPPORTED_VERSIONS}"
+        exit
+      end
+    end
+  end
+end

data/lib/abc_size/version.rb

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

data/lib/abc_size.rb

@@ -1,83 +1,8 @@
 # frozen_string_literal: true
 
+require_relative 'abc_size/calculator'
+require_relative 'abc_size/errors'
+require_relative 'abc_size/ruby_version'
+require_relative 'abc_size/ruby_version/detector'
+require_relative 'abc_size/ruby_version/picker'
 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

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: abc_size
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - Emil Furtak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-12-04 00:00:00.000000000 Z
+date: 2021-12-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rainbow
@@ -72,6 +72,11 @@ files:
 - bin/setup
 - exe/abc
 - lib/abc_size.rb
+- lib/abc_size/calculator.rb
+- lib/abc_size/errors.rb
+- lib/abc_size/ruby_version.rb
+- lib/abc_size/ruby_version/detector.rb
+- lib/abc_size/ruby_version/picker.rb
 - lib/abc_size/version.rb
 homepage: https://github.com/efurtak/abc_size
 licenses: