auom 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 0052fcab4f594eaadb81ddb9c50b5383a1f6ccbe
-  data.tar.gz: 7dee775c276bad51bfa0b8a926b022278f2c008b
+SHA256:
+  metadata.gz: 9a7dad47d0763bd36fc51452be282e6770defd02dd2456d25283f96306183569
+  data.tar.gz: 9cfdfe4738323f4e8ad3213fcd07e808cfa9afb9a0b09932ac6fc855a36e10f5
 SHA512:
-  metadata.gz: 010b60063558dc2268e38fd1af143492334a37f45a5613e52bfb052a2bee8337305ff1df52ebf5ec8d35aca7db1d92185ca6b7fa9f10aba0aef1d12a75f037c8
-  data.tar.gz: 4db585b70f9db889c5ff9e39a1afb4793bec6d3d62e2dd710661d29711af67c3b3cbb0874a98057b3ad3675755bc1cbed0969d3cae570050a29c6f0ab06b5067
+  metadata.gz: b93ce51d8b7f5f90ca353f001dbd87ec4cefdbc12c008c2a3cb658527ef9199e35ba5dcf6561795251ff1c5c86ba4631c2b6aca781c8ce1dd11a394143ac4cdf
+  data.tar.gz: 5c52401f2362f4d16f038634627fc6be09973392e9e33e18cb4415da5a088be04088a603e95d1b618016546e9a6f92a057779ba7cd09dbd7a6f0df7f02027d87

data/.circleci/config.yml

@@ -0,0 +1,18 @@
+---
+defaults: &defaults
+  working_directory: ~/mutant
+  steps:
+    - checkout
+    - run: bundle install
+    - run: bundle exec rake ci
+version: 2
+jobs:
+  ruby_2_5:
+    <<: *defaults
+    docker:
+      - image: circleci/ruby:2.5.3
+workflows:
+  version: 2
+  test:
+    jobs:
+      - ruby_2_5

data/.rubocop.yml

@@ -1,3 +1,3 @@
 AllCops:
   DisplayCopNames: true
-  TargetRubyVersion: 2.2
+  TargetRubyVersion: 2.5

data/Changelog.md

@@ -1,3 +1,8 @@
+# v0.3.0 2018-11-10
+
+* [breaking-change] Change to provide all relational operators, remove named ones
+* [breaking-change] Drop support for ruby < 2.5
+
 # v0.2.0 2017-09-29
 
 * [breaking-change] Drop support for < 2.4

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 gemspec

data/Rakefile

@@ -1,2 +1,4 @@
+# frozen_string_literal: true
+
 require 'devtools'
 Devtools.init_rake_tasks

data/auom.gemspec

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 Gem::Specification.new do |gem|
   gem.name = 'auom'
-  gem.version = '0.2.0'
+  gem.version = '0.3.0'
 
   gem.authors  = ['Markus Schirp']
   gem.email    = 'mbj@schirp-dso.com'
@@ -10,11 +12,11 @@ Gem::Specification.new do |gem|
   gem.files            = `git ls-files`.split("\n")
   gem.test_files       = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.require_paths    = %w[lib]
-  gem.extra_rdoc_files = %w[TODO LICENSE]
+  gem.extra_rdoc_files = %w[LICENSE]
 
-  gem.required_ruby_version = '>= 2.4'
+  gem.required_ruby_version = '>= 2.5'
 
   gem.add_dependency('equalizer', '~> 0.0.9')
 
-  gem.add_development_dependency('devtools', '~> 0.1.12')
+  gem.add_development_dependency('devtools', '~> 0.1.21')
 end

data/config/devtools.yml

@@ -0,0 +1,2 @@
+---
+unit_test_timeout: 2.0

data/config/flay.yml

@@ -1,3 +1,3 @@
 ---
 threshold: 12
-total_score: 88
+total_score: 87

data/config/reek.yml

@@ -1,97 +1,96 @@
-UncommunicativeParameterName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-TooManyMethods:
-  max_methods: 14
-  enabled: true
-  exclude: []
-  max_instance_variables: 4
-UncommunicativeMethodName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^[a-z]$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-LongParameterList:
-  max_params: 2
-  exclude:
-    - "AUOM::Unit#initialize"   # 3 params
-    - "AUOM::Unit#self.new"     # 3 params
-    - "AUOM::Unit#self.resolve" # 3 params
-  enabled: true
-  overrides: {}
-FeatureEnvy:
-  exclude: []
-  enabled: true
-ClassVariable:
-  exclude: []
-  enabled: true
-BooleanParameter:
-  exclude: []
-  enabled: true
-IrresponsibleModule:
-  exclude: []
-  enabled: true
-UncommunicativeModuleName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-NestedIterators:
-  ignore_iterators: []
-  exclude:
-   - AUOM::Unit#initialize # 2 levels
-  enabled: true
-  max_allowed_nesting: 1
-TooManyStatements:
-  max_statements: 6
-  exclude:
-    - AUOM::Inspection#pretty_unit # 7 statements
-    - AUOM::Unit#initialize # 8 statements
-  enabled: true
-DuplicateMethodCall:
-  allow_calls: []
-  exclude:
-    - "AUOM::ClassMethods#new"     # invalid detection
-  enabled: true
-  max_calls: 1
-UtilityFunction:
-  max_helper_calls: 0
-  exclude: []
-  enabled: true
-Attribute:
-  exclude: []
-  enabled: false
-UncommunicativeVariableName:
-  accept: []
-  exclude: []
-  enabled: true
-  reject:
-  - !ruby/regexp /^.$/
-  - !ruby/regexp /[0-9]$/
-  - !ruby/regexp /[A-Z]/
-RepeatedConditional:
-  enabled: true
-  max_ifs: 1
-DataClump:
-  exclude: []
-  enabled: true
-  max_copies: 1
-  min_clump_size: 2
-ControlParameter:
-  exclude:
-    - AUOM::Unit#assert_same_unit
-  enabled: true
-LongYieldList:
-  max_params: 0
-  exclude: []
-  enabled: true
+detectors:
+  UncommunicativeParameterName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - /^.$/
+    - /[0-9]$/
+    - /[A-Z]/
+  TooManyMethods:
+    max_methods: 14
+    enabled: true
+    exclude: []
+  UncommunicativeMethodName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - /^[a-z]$/
+    - /[0-9]$/
+    - /[A-Z]/
+  LongParameterList:
+    max_params: 2
+    exclude:
+      - "AUOM::Unit#initialize"   # 3 params
+      - "AUOM::Unit#self.new"     # 3 params
+      - "AUOM::Unit#self.resolve" # 3 params
+    enabled: true
+    overrides: {}
+  FeatureEnvy:
+    exclude: []
+    enabled: true
+  ClassVariable:
+    exclude: []
+    enabled: true
+  BooleanParameter:
+    exclude: []
+    enabled: true
+  IrresponsibleModule:
+    exclude: []
+    enabled: true
+  UncommunicativeModuleName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - /^.$/
+    - /[0-9]$/
+  NestedIterators:
+    ignore_iterators: []
+    exclude:
+    - AUOM::Unit#initialize # 2 levels
+    enabled: true
+    max_allowed_nesting: 1
+  TooManyStatements:
+    max_statements: 6
+    exclude:
+      - AUOM::Inspection#pretty_unit # 7 statements
+      - AUOM::Unit#initialize # 8 statements
+    enabled: true
+  DuplicateMethodCall:
+    allow_calls: []
+    exclude:
+      - "AUOM::ClassMethods#new"     # invalid detection
+    enabled: true
+    max_calls: 1
+  UtilityFunction:
+    exclude: []
+    enabled: true
+  Attribute:
+    exclude: []
+    enabled: false
+  UncommunicativeVariableName:
+    accept: []
+    exclude: []
+    enabled: true
+    reject:
+    - /^.$/
+    - /[0-9]$/
+    - /[A-Z]/
+  RepeatedConditional:
+    enabled: true
+    max_ifs: 1
+  DataClump:
+    exclude: []
+    enabled: true
+    max_copies: 1
+    min_clump_size: 2
+  ControlParameter:
+    exclude:
+      - AUOM::Unit#assert_same_unit
+    enabled: true
+  LongYieldList:
+    max_params: 0
+    exclude: []
+    enabled: true

data/config/rubocop.yml

@@ -183,3 +183,6 @@ Send:
 
 Lint/UnifiedInteger:
   Enabled: false
+
+Style/CommentedKeyword:
+  Enabled: false

data/lib/auom.rb

@@ -1,4 +1,5 @@
-require 'rational'
+# frozen_string_literal: true
+
 require 'equalizer'
 
 # Library namespace

data/lib/auom/algebra.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module AUOM
   # The AUOM algebra
   module Algebra

data/lib/auom/equalization.rb

@@ -1,7 +1,8 @@
+# frozen_string_literal: true
+
 module AUOM
   # Equalization for auom units
   module Equalization
-
     # Check for equivalent value and try to convert
     #
     # @param [Object] other
@@ -29,6 +30,5 @@ module AUOM
     def ==(other)
       eql?(self.class.try_convert(other))
     end
-
   end # Equalization
 end # AUOM

data/lib/auom/inspection.rb

@@ -1,10 +1,11 @@
+# frozen_string_literal: true
+
 module AUOM
   # Inspection module for auom units
   module Inspection
-
-    INSPECT_FORMAT = '<%s @scalar=%s%s>'.freeze
-    SCALAR_FORMAT  = '~%0.4f'.freeze
-    UNIT_FORMAT    = ' %s/%s'.freeze
+    INSPECT_FORMAT = '<%s @scalar=%s%s>'
+    SCALAR_FORMAT  = '~%0.4f'
+    UNIT_FORMAT    = ' %s/%s'
 
     # Return inspectable representation
     #
@@ -25,7 +26,9 @@ module AUOM
     # @api private
     #
     def self.prettify_unit_part(base)
-      counts(base).map { |unit, length| length > 1 ? "#{unit}^#{length}" : unit }.join('*')
+      counts(base).map do |unit, length|
+        length > 1 ? "#{unit}^#{length}" : unit
+      end.join('*')
     end
 
   private
@@ -61,9 +64,7 @@ module AUOM
       denominator = Inspection.prettify_unit_part(denominators)
 
       numerator   = '1' if numerator.empty?
-      if denominator.empty?
-        return " #{numerator}"
-      end
+      return " #{numerator}" if denominator.empty?
 
       format(UNIT_FORMAT, numerator, denominator)
     end
@@ -90,8 +91,12 @@ module AUOM
     #
     # @api private
     #
+    # rubocop:disable Metrics/MethodLength
     def self.counts(base)
-      counts = base.each_with_object(Hash.new(0)) { |unit, hash| hash[unit] += 1 }
+      counts = base.each_with_object(Hash.new(0)) do |unit, hash|
+        hash[unit] += 1
+      end
+
       counts.sort do |left, right|
         result = right.last <=> left.last
         if result.equal?(0)
@@ -101,8 +106,8 @@ module AUOM
         end
       end
     end
-
     private_class_method :counts
+    # rubocop:enable Metrics/MethodLength
 
   end # Inspection
 end # AUOM

data/lib/auom/relational.rb

@@ -1,90 +1,20 @@
+# frozen_string_literal: true
+
 module AUOM
   # Mixin to add relational operators
   module Relational
-
-    # Test if unit is less than or equal to other
-    #
-    # @param [Unit] other
-    #
-    # @return [true]
-    #   if unit is less than other
-    #
-    # @return [false]
-    #   otherwise
-    #
-    # @api private
-    #
-    def less_than_or_equal_to?(other)
-      relational_operation(other, :<=)
-    end
-    alias_method :<=, :less_than_or_equal_to?
-
-    # Test if unit is greater than or equal to other
+    # Perform comparison operation
     #
     # @param [Unit] other
     #
-    # @return [true]
-    #   if unit is greater than other
-    #
-    # @return [false]
-    #   otherwise
-    #
-    # @api private
-    #
-    def greater_than_or_equal_to?(other)
-      relational_operation(other, :>=)
-    end
-    alias_method :>=, :greater_than_or_equal_to?
-
-    # Test if unit is less than other
-    #
-    # @param [Unit] other
-    #
-    # @return [true]
-    #   if unit is less than other
-    #
-    # @return [false]
-    #   otherwise
-    #
-    # @api private
-    #
-    def less_than?(other)
-      relational_operation(other, :<)
-    end
-    alias_method :<, :less_than?
-
-    # Test if unit is greater than other
-    #
-    # @param [Unit] other
-    #
-    # @return [true]
-    #   if unit is greater than other
-    #
-    # @return [false]
-    #   otherwise
-    #
-    # @api private
-    #
-    def greater_than?(other)
-      relational_operation(other, :>)
-    end
-    alias_method :<, :less_than?
-
-  private
-
-    # Perform relational operation
-    #
-    # @param [Unit] other
-    # @param [Symbol] operation
-    #
     # @return [Object]
     #
     # @api private
     #
-    def relational_operation(other, operation)
+    def <=>(other)
       assert_same_unit(other)
-      scalar.public_send(operation, other.scalar)
-    end
 
+      scalar <=> other.scalar
+    end
   end # Relational
 end # AUOM