lare_round 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 22cc87361ca388e9fea449cc3fc775bba6c4869a
-  data.tar.gz: 5b837592bedcd9da1f528fdabf5a328896422860
+SHA256:
+  metadata.gz: d208fe3a2e4acdfa0c624b7dba9e36935fc0e23abaea5c64283272b6219b6192
+  data.tar.gz: 4b73f0f1d035445cc2a5b4de6f52436d2d0ea00a57d5d415a3582372a7306a5e
 SHA512:
-  metadata.gz: 92fc9fcefcdb98717afbd19cc8b2c2423f23dd53e2e195af746fe50183422c6518abe76a31260a1d1ef0d77fde661f27cd4d251841e3c6222e6e8da841a6ff15
-  data.tar.gz: cbd9d9df3a74c4f7a7a66d49f60923468e47066ffd615f421e055b732798c80b627c32f7ff12b03df05210cf5f04b9da51e41d32263f2d9c3d1daa1e9f6eae01
+  metadata.gz: b058ab1e006b7a3fc31ab71abe67f2be4c3471468f53b5f1b013f26a2a102a6c8afc99cf3767a810e95017f588813f3787fa59dba93eed013aaf9d723265afe3
+  data.tar.gz: d0b548004322dbecd8d72d7f2bfa168edab906f3646242b6f4874c17c61e72e0c3620d5393c26e8906c2b12b7a6ae0ca9efcae6251abf41bc1be23da2bef0312

data/.rubocop.yml

@@ -0,0 +1 @@
+inherit_from: .rubocop_todo.yml

data/.rubocop_todo.yml

@@ -0,0 +1,69 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-06-07 14:11:23 +0200 using RuboCop version 0.71.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 3
+Metrics/AbcSize:
+  Max: 23
+
+# Offense count: 3
+# Configuration parameters: CountComments, ExcludedMethods.
+# ExcludedMethods: refine
+Metrics/BlockLength:
+  Max: 79
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 130
+
+# Offense count: 2
+# Configuration parameters: CountComments, ExcludedMethods.
+Metrics/MethodLength:
+  Max: 18
+
+# Offense count: 1
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/lare_round.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+Style/ExpandPathArguments:
+  Exclude:
+    - 'lare_round.gemspec'
+
+# Offense count: 2
+# Configuration parameters: MinBodyLength.
+Style/GuardClause:
+  Exclude:
+    - 'lib/lare_round.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: use_perl_names, use_english_names
+Style/SpecialGlobalVars:
+  Exclude:
+    - 'lare_round.gemspec'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
+# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
+Style/TernaryParentheses:
+  Exclude:
+    - 'lib/lare_round.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
+# URISchemes: http, https
+Metrics/LineLength:
+  Max: 82

data/.travis.yml

@@ -1,8 +1,12 @@
 language: ruby
 
 rvm:
-  - 1.9.3
-  - 2.0.0
-  - 2.1.1
-  - 2.1.2
-  - jruby-19mode
+  - 2.4.5
+  - 2.5.3
+  - 2.6.0
+  - jruby-9.1
+  - jruby-9.2
+
+script:
+  - bundle exec rubocop
+  - bundle exec rake test

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lare_round.gemspec

data/README.md

@@ -4,25 +4,25 @@ A collection of BigDecimal items e.g. invoice items can be rounded for displayin
 
 ## Build status
 [![Build Status](https://secure.travis-ci.org/jethroo/lare_round.png)](http://travis-ci.org/jethroo/lare_round)
-
+[![Gem Version](https://badge.fury.io/rb/lare_round.svg)](http://badge.fury.io/rb/lare_round)
 
 ## Used in production
 
-since 4th of september 2013 (still needs to be released as gem)
+since 4th of September 2013
 
 ## Example
 
 say we have an array of 3 invoice items which are stored in the database and your invoice calculations are precise to the 4th position after the decimal point:
 
 ```ruby
-Array.new(3){BigDecimal.new('0.3334')}
+Array.new(3){ BigDecimal('0.3334') }
 #  => [#<BigDecimal:c75a38,'0.3334E0',9(18)>, #<BigDecimal:c759c0,'0.3334E0',9(18)>, #<BigDecimal:c75920,'0.3334E0',9(18)>]
 ```
 say you have an invoice which is rendered as pdf which only needs to display the total you are fine, because you only
 have to round once for displaying a customer friendly price:
 
 ```ruby
-Array.new(3){BigDecimal.new('0.3334')}.reduce(:+).round(2).to_f
+Array.new(3){ BigDecimal('0.3334') }.reduce(:+).round(2).to_f
 # => 1.0
 ```
 
@@ -39,7 +39,7 @@ Item | Price
 So the most likely aproach is to simply round each item by itself, so the customer isn't bothered with 34/10000 €-Cents. Simple at it is its not quite what you want:
 
 ```ruby
-Array.new(3){BigDecimal.new('0.3334')}.map{|i| i.round(2)}.reduce(:+).to_f
+Array.new(3){ BigDecimal('0.3334') }.map{|i| i.round(2)}.reduce(:+).to_f
 # => 0.99
 ```
 
@@ -54,7 +54,7 @@ Now you have the customer bothering about why there is a difference between the
 
 This gem helps to distribute the rounding error amongst the items to preserve the total:
 ```ruby
-a =  Array.new(3){BigDecimal.new('0.3334')}
+a =  Array.new(3){ BigDecimal('0.3334') }
 # => [#<BigDecimal:887b6c8,'0.3334E0',9(18)>, #<BigDecimal:887b600,'0.3334E0',9(18)>, #<BigDecimal:887b4c0,'0.3334E0',9(18)>]
 a = LareRound.round(a,2)
 # => [#<BigDecimal:8867330,'0.34E0',9(36)>, #<BigDecimal:8867290,'0.33E0',9(36)>, #<BigDecimal:88671f0,'0.33E0',9(36)>]
@@ -75,7 +75,7 @@ Item | Price
 LareRound supports *Array* and *Hash* as collection types. As usage of array was shown above here comes the hash example:
 
 ```ruby
-hash = Hash[(1..3).map.with_index{|x,i|[x,BigDecimal.new('0.3334')]}]
+hash = Hash[(1..3).map.with_index{ |x,i| [x,BigDecimal('0.3334')] }]
 # => {1=>#<BigDecimal:26ac7d0,'0.3334E0',9(18)>, 2=>#<BigDecimal:26ac730,'0.3334E0',9(18)>, 3=>#<BigDecimal:26ac690,'0.3334E0',9(18)>}
 LareRound.round(hash,2)
 # => {1=>#<BigDecimal:26b9318,'0.34E0',9(36)>, 2=>#<BigDecimal:26b9250,'0.33E0',9(36)>, 3=>#<BigDecimal:26b91b0,'0.33E0',9(36)>}
@@ -93,8 +93,6 @@ Item (unrounded)| Price (unrounded) | LareRound | Financial
  tax ( 8.23%) | 0.823 | 0.82 | 0.83
  **Total** | **10.823** | **10.82** | **10.83**
 
-  * refactoring ^^
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -114,6 +112,7 @@ And then execute:
 5. Create new Pull Request
 
 ## License
+
 Hereby released under MIT license.
 
 ## Authors/Contributors

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 
 require 'rake/testtask'

data/lare_round.gemspec

@@ -1,4 +1,5 @@
-# coding: utf-8
+# frozen_string_literal: true
+
 lib = File.expand_path('../lib', __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lare_round/version'
@@ -7,7 +8,7 @@ Gem::Specification.new do |spec|
   spec.name          = 'lare_round'
   spec.version       = LareRound::VERSION
   spec.authors       = ['Carsten Wirth']
-  spec.email         = ['carsten.wirth@blacklane.com']
+  spec.email         = ['cwirth79@web.de']
 
   spec.description   = <<-DESCRIPTION
     A collection of BigDecimal items e.g. invoice items can be rounded for
@@ -25,13 +26,13 @@ Gem::Specification.new do |spec|
   spec.license       = 'MIT'
 
   spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(/^bin\//) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(/^(test|spec|features)\//)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'rake'
   spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'minitest'
   spec.add_development_dependency 'simplecov'
 end

data/lib/lare_round.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'bigdecimal'
 
 module LareRound
@@ -15,111 +17,113 @@ module LareRound
   # StandardError for dealing with application level errors
   class LareRoundError < StandardError; end
 
-  private
+  class << self
+    private
 
-  def self.process(values, precision)
-    if values.is_a? Hash
-      process_hash(values, precision)
-    else
-      round_array_of_values(values, precision)
+    def process(values, precision)
+      if values.is_a? Hash
+        process_hash(values, precision)
+      else
+        round_array_of_values(values, precision)
+      end
     end
-  end
 
-  def self.process_hash(values, precision)
-    rounded_values = round_array_of_values(values.values, precision)
-    values.tap do |hash|
-      hash.keys.each_with_index do |key, index|
-        hash[key] = rounded_values[index]
+    def process_hash(values, precision)
+      rounded_values = round_array_of_values(values.values, precision)
+      values.tap do |hash|
+        hash.keys.each_with_index do |key, index|
+          hash[key] = rounded_values[index]
+        end
       end
     end
-  end
 
-  def self.handle_value_errors(values)
-    fail LareRoundError, 'values must not be nil' if values.nil?
-    fail LareRoundError, 'values must not be empty' if values.empty?
-    fail LareRoundError, 'values must be an array' unless values.is_a? Array
-
-    numbers_invalid = values.map { |i| i.is_a? Numeric }
-      .reject { |i| i == true }.size
-    if numbers_invalid > 0
-      error = <<-ERROR.strip.gsub(/\s+/, ' ')
-        values contains not numeric values (#{numbers_invalid})
-      ERROR
-      fail LareRoundError, error
-    end
+    def handle_value_errors(values)
+      raise LareRoundError, 'values must not be nil' if values.nil?
+      raise LareRoundError, 'values must not be empty' if values.empty?
+      raise LareRoundError, 'values must be an array' unless values.is_a? Array
+
+      numbers_invalid = values.map { |i| i.is_a? Numeric }
+                              .reject { |i| i == true }.size
+      if numbers_invalid.positive?
+        error = <<-ERROR.strip.gsub(/\s+/, ' ')
+          values contains not numeric values (#{numbers_invalid})
+        ERROR
+        raise LareRoundError, error
+      end
 
-    if values.map { |i| i.is_a? BigDecimal }.reject { |i| i == true }.size > 0
-      warning = <<-WARNING.strip.gsub(/\s+/, ' ')
-        values contains non decimal values,
-        you might loose precision or even get wrong rounding results
-      WARNING
-      warn warning
+      unless values.map { |i| i.is_a? BigDecimal }.reject { |i| i == true }.empty?
+        warning = <<-WARNING.strip.gsub(/\s+/, ' ')
+          values contains non decimal values,
+          you might loose precision or even get wrong rounding results
+        WARNING
+        warn warning
+      end
     end
-  end
-
-  def self.handle_precision_errors(precision)
-    fail LareRoundError, 'precision must not be nil' if precision.nil?
 
-    unless precision.is_a? Numeric
-      fail LareRoundError, 'precision must be a number'
-    end
+    def handle_precision_errors(precision)
+      raise LareRoundError, 'precision must not be nil' if precision.nil?
 
-    if precision < 0
-      fail LareRoundError, 'precision must be greater or equal to 0'
-    end
-  end
+      unless precision.is_a? Numeric
+        raise LareRoundError, 'precision must be a number'
+      end
 
-  Struct.new(
-    'IntermediaryResults',
-    :decimal_shift,
-    :rounded_total,
-    :array_of_values,
-    :unrounded_values,
-    :precision,
-    :rounded_values
-  )
-
-  def self.round_array_of_values(array_of_values, precision)
-    mrc = Struct::IntermediaryResults.new
-    mrc.precision = precision
-    mrc.decimal_shift = BigDecimal.new(10**precision.to_i)
-    mrc.rounded_total = array_of_values.reduce(:+)
-      .round(precision) * mrc.decimal_shift
-    mrc.array_of_values = array_of_values.map do |v|
-      ((v.is_a? BigDecimal) ? v : BigDecimal.new(v.to_s))
+      if precision.negative?
+        raise LareRoundError, 'precision must be greater or equal to 0'
+      end
     end
-    mrc.unrounded_values = array_of_values.map { |v| v * mrc.decimal_shift }
 
-    largest_remainder_method(mrc)
+    Struct.new(
+      'IntermediaryResults',
+      :decimal_shift,
+      :rounded_total,
+      :array_of_values,
+      :unrounded_values,
+      :precision,
+      :rounded_values
+    )
+
+    def round_array_of_values(array_of_values, precision)
+      mrc = Struct::IntermediaryResults.new
+      mrc.precision = precision
+      mrc.decimal_shift = BigDecimal(10**precision.to_i)
+      mrc.rounded_total = array_of_values.reduce(:+)
+                                         .round(precision) * mrc.decimal_shift
+      mrc.array_of_values = array_of_values.map do |v|
+        ((v.is_a? BigDecimal) ? v : BigDecimal(v.to_s))
+      end
+      mrc.unrounded_values = array_of_values.map { |v| v * mrc.decimal_shift }
 
-    mrc.rounded_values
-  end
+      largest_remainder_method(mrc)
 
-  def self.largest_remainder_method(mrc)
-    mrc.rounded_values = mrc.array_of_values.map do |v|
-      largest_remainder_round(v, mrc)
+      mrc.rounded_values
     end
 
-    until mrc.rounded_values.reduce(:+) >= mrc.rounded_total
-      fractions = mrc.unrounded_values.zip(mrc.rounded_values).map do |x, y|
-        x - y
+    def largest_remainder_method(mrc)
+      mrc.rounded_values = mrc.array_of_values.map do |v|
+        largest_remainder_round(v, mrc)
       end
-      mrc.rounded_values[fractions.index(fractions.max)] += 1
-    end
-
-    mrc.rounded_values.map! { |v| v / mrc.decimal_shift }
-  end
 
-  def self.largest_remainder_round(v, mrc)
-    # items needed to be rounded down if positiv:
-    # 0.7 + 0.7 + 0.7 = ( 2.1 ).round(0) = 2
-    # (0.7).round(0) + (0.7).round(0) + (0.7).round(0) = 1 + 1 + 1 = 3
-    # elsewise if negative
-    rounding_strategy = if v < 0
-        BigDecimal::ROUND_UP
-      else
-        BigDecimal::ROUND_DOWN
+      until mrc.rounded_values.reduce(:+) >= mrc.rounded_total
+        fractions = mrc.unrounded_values.zip(mrc.rounded_values).map do |x, y|
+          x - y
+        end
+        mrc.rounded_values[fractions.index(fractions.max)] += 1
       end
-    v.round(mrc.precision, rounding_strategy) * mrc.decimal_shift
+
+      mrc.rounded_values.map! { |v| v / mrc.decimal_shift }
+    end
+
+    def largest_remainder_round(value, mrc)
+      # items needed to be rounded down if positiv:
+      # 0.7 + 0.7 + 0.7 = ( 2.1 ).round(0) = 2
+      # (0.7).round(0) + (0.7).round(0) + (0.7).round(0) = 1 + 1 + 1 = 3
+      # elsewise if negative
+      rounding_strategy = if value.negative?
+                            BigDecimal::ROUND_UP
+                          else
+                            BigDecimal::ROUND_DOWN
+                          end
+      value.round(mrc.precision, rounding_strategy) * mrc.decimal_shift
+    end
   end
 end

data/lib/lare_round/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module LareRound
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/test/lare_round_test.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require_relative 'test_helper'
 require 'bigdecimal'
 require 'securerandom'
@@ -8,20 +10,19 @@ class LareRoundTest < MiniTest::Spec
   end
 
   def create_big_decimal(precision, digit)
-    BigDecimal.new('0.' + '3' * precision + "#{digit}")
+    BigDecimal('0.' + '3' * precision + digit.to_s)
   end
 
   (1..9).each do |digit|
     (1..23).each do |items|
       (0..10).each do |precision|
-
         method_name = <<-TESTMETHOD.strip.gsub(/\s+/, '_')
           test #{items} items with last digit of #{digit}
           should sum up to rounded total of BigDecimal items
           with precision of #{precision} if passed as array
         TESTMETHOD
         define_method method_name do
-          arr =  Array.new(items) { create_big_decimal(precision, digit) }
+          arr = Array.new(items) { create_big_decimal(precision, digit) }
           rounded_total = arr.reduce(:+).round(precision)
           assert_equal(
             rounded_total,
@@ -36,8 +37,8 @@ class LareRoundTest < MiniTest::Spec
         TESTMETHOD
         define_method method_name do
           hash = Hash[
-            (1..items).map do
-              |x| [x, create_big_decimal(precision, digit)]
+            (1..items).map do |x|
+              [x, create_big_decimal(precision, digit)]
             end
           ]
           rounded_total = hash.values.reduce(:+).round(precision)
@@ -55,7 +56,7 @@ class LareRoundTest < MiniTest::Spec
         define_method method_name do
           hash = Hash[
             (1..items).map.with_index do |x, i|
-              [x, create_big_decimal(precision, digit) + BigDecimal.new(i)]
+              [x, create_big_decimal(precision, digit) + BigDecimal(i)]
             end
           ]
           rounded_hash = LareRound.round(hash.clone, precision)
@@ -71,7 +72,7 @@ class LareRoundTest < MiniTest::Spec
         TESTMETHOD
         define_method method_name do
           arr = Array.new(items) do
-            BigDecimal.new(-1 * create_big_decimal(precision, digit))
+            BigDecimal(-1 * create_big_decimal(precision, digit))
           end
           rounded_total = arr.reduce(:+).round(precision)
           assert_equal(
@@ -98,7 +99,7 @@ class LareRoundTest < MiniTest::Spec
     end
   end
 
-  let(:default_array) { Array.new(3) { BigDecimal.new('0.1234') } }
+  let(:default_array) { Array.new(3) { BigDecimal('0.1234') } }
 
   def test_should_raise_if_precision_is_nil
     exception = assert_raises(LareRound::LareRoundError) do

data/test/test_helper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'simplecov'
 SimpleCov.start
 

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: lare_round
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Carsten Wirth
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-22 00:00:00.000000000 Z
+date: 2019-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -39,7 +39,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rubocop
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -90,12 +90,14 @@ description: |2
       Application of the largest remainder method can help to preserve the
       total sum for fractionated parts thus eliminating this confusion.
 email:
-- carsten.wirth@blacklane.com
+- cwirth79@web.de
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".travis.yml"
 - Gemfile
 - LICENSE.txt
@@ -126,7 +128,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.7.8
 signing_key: 
 specification_version: 4
 summary: gem for rounding BigDecimal items by preserving its sum