lare_round 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d208fe3a2e4acdfa0c624b7dba9e36935fc0e23abaea5c64283272b6219b6192
-  data.tar.gz: 4b73f0f1d035445cc2a5b4de6f52436d2d0ea00a57d5d415a3582372a7306a5e
+  metadata.gz: 75cbed7590d38dbbddd0ddb51341cc2fd9b3b55c614ebc347cad64ac8b675d6c
+  data.tar.gz: 99c9fa456289a7c6e384b90922b770532ce937874a226dedbae6a1e83cc32b49
 SHA512:
-  metadata.gz: b058ab1e006b7a3fc31ab71abe67f2be4c3471468f53b5f1b013f26a2a102a6c8afc99cf3767a810e95017f588813f3787fa59dba93eed013aaf9d723265afe3
-  data.tar.gz: d0b548004322dbecd8d72d7f2bfa168edab906f3646242b6f4874c17c61e72e0c3620d5393c26e8906c2b12b7a6ae0ca9efcae6251abf41bc1be23da2bef0312
+  metadata.gz: d5d356f37278ac48cad5f49cba5a88587cc35c57e68a650126c9d066f86d101442cd97c17522c0fd2f0db88d9127cfe6dcb2aa755403883fe4006e1c9c98dba4
+  data.tar.gz: f1f3193af4b5acd7a09a43b9e3c5aee28ceb460730e0ab19a4d6d45d2d20cc0649a6616e6dd77ceee117b1a4e4903c60db909f74e4087fca0372003d1b46368b

data/.github/workflows/ci.yml

@@ -0,0 +1,37 @@
+name: Continuous Integration
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+    name: Rspec and Rubocop
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        ruby-version: ['3.0.4', '3.1.2','3.2.0']
+
+    steps:
+      - name: Check out code
+        uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1.215.0
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+      - name: Rubocop
+        env:
+          RAILS_ENV: test
+        run: |
+          bundle exec rubocop
+
+      - name: Minitest
+        env:
+          RAILS_ENV: test
+        run: |
+          bundle exec rake test

data/.rubocop.yml

@@ -1 +1,5 @@
 inherit_from: .rubocop_todo.yml
+
+AllCops:
+  SuggestExtensions: false
+  NewCops: enable

data/.rubocop_todo.yml

@@ -1,69 +1,38 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2019-06-07 14:11:23 +0200 using RuboCop version 0.71.0.
+# on 2023-09-11 13:29:52 UTC using RuboCop version 1.56.3.
 # 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
+# Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 23
+  Max: 25
 
 # Offense count: 3
-# Configuration parameters: CountComments, ExcludedMethods.
-# ExcludedMethods: refine
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
 Metrics/BlockLength:
-  Max: 79
+  Max: 78
 
 # Offense count: 1
-# Configuration parameters: CountComments.
+# Configuration parameters: CountComments, CountAsOne.
 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'
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/CyclomaticComplexity:
+  Max: 10
 
 # 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'
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+Metrics/MethodLength:
+  Max: 18
 
 # Offense count: 1
-# Cop supports --auto-correct.
-# Configuration parameters: AutoCorrect, AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, IgnoredPatterns.
-# URISchemes: http, https
-Metrics/LineLength:
-  Max: 82
+# Configuration parameters: AllowedMethods, AllowedPatterns.
+Metrics/PerceivedComplexity:
+  Max: 10

data/.ruby-version

@@ -0,0 +1 @@
+3.2.0

data/Gemfile

@@ -4,3 +4,9 @@ source 'https://rubygems.org'
 
 # Specify your gem's dependencies in lare_round.gemspec
 gemspec
+
+gem 'bundler'
+gem 'minitest'
+gem 'rake'
+gem 'rubocop'
+gem 'simplecov'

data/README.md

@@ -3,8 +3,9 @@
 A collection of BigDecimal items e.g. invoice items can be rounded for displaying them in views. Rounding may apply a rounding error to the items such as the summed up rounded items will show deviation towards an invoice total with summed unrounded items. Which might cause confusion for customers and finance departments alike. Application of the largest remainder method can help to preserve the total sum for rounded parts thus eliminating this confusion.
 
 ## Build status
-[![Build Status](https://secure.travis-ci.org/jethroo/lare_round.png)](http://travis-ci.org/jethroo/lare_round)
+[![Continuous Integration](https://github.com/jethroo/lare_round/actions/workflows/ci.yml/badge.svg?branch=master)](https://github.com/jethroo/lare_round/actions/workflows/ci.yml)
 [![Gem Version](https://badge.fury.io/rb/lare_round.svg)](http://badge.fury.io/rb/lare_round)
+<a href="https://codeclimate.com/github/jethroo/lare_round/maintainability"><img src="https://api.codeclimate.com/v1/badges/9d97f5a7c54707277efc/maintainability" /></a>
 
 ## Used in production
 
@@ -97,11 +98,30 @@ Item (unrounded)| Price (unrounded) | LareRound | Financial
 
 Add this line to your application's Gemfile:
 
-    gem 'lare_round', '~> 0.0.1'
-
+```bash
+    gem 'lare_round', '~> 1.0.0'
+```
 And then execute:
 
-    $ bundle
+```bash
+bundle install
+```
+
+## Test
+
+The tests can be run after bundling with:
+
+```bash
+rake test
+```
+
+## Console
+
+To start the interactive ruby shell (irb) you can run:
+
+```bash
+bin/console
+```
 
 ## Contributing
 

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'lare_round'
+
+# 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/lare_round.gemspec

@@ -1,10 +1,13 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('../lib', __FILE__)
+require 'English'
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'lare_round/version'
 
 Gem::Specification.new do |spec|
+  spec.required_ruby_version = '>= 3.0.4'
+
   spec.name          = 'lare_round'
   spec.version       = LareRound::VERSION
   spec.authors       = ['Carsten Wirth']
@@ -25,14 +28,9 @@ Gem::Specification.new do |spec|
   spec.homepage      = ''
   spec.license       = 'MIT'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.metadata      = { 'rubygems_mfa_required' => 'true' }
+
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   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'
-  spec.add_development_dependency 'minitest'
-  spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'rubocop'
-  spec.add_development_dependency 'simplecov'
 end

data/lib/lare_round/version.rb

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

data/lib/lare_round.rb

@@ -2,6 +2,7 @@
 
 require 'bigdecimal'
 
+# module providing the entry point to the rounding logic
 module LareRound
   def self.round(values, precision)
     # although it is the senders responsibility to ensure that correct messages
@@ -51,25 +52,18 @@ module LareRound
         raise LareRoundError, error
       end
 
-      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
+      return if values.map { |i| i.is_a? BigDecimal }.reject { |i| i == true }.empty?
+
+      warn <<-WARNING.strip.gsub(/\s+/, ' ')
+        values contains non decimal values,
+        you might loose precision or even get wrong rounding results
+      WARNING
     end
 
     def handle_precision_errors(precision)
       raise LareRoundError, 'precision must not be nil' if precision.nil?
-
-      unless precision.is_a? Numeric
-        raise LareRoundError, 'precision must be a number'
-      end
-
-      if precision.negative?
-        raise LareRoundError, 'precision must be greater or equal to 0'
-      end
+      raise LareRoundError, 'precision must be a number' unless precision.is_a?(Numeric)
+      raise LareRoundError, 'precision must be greater or equal to 0' if precision.negative?
     end
 
     Struct.new(
@@ -89,7 +83,7 @@ module LareRound
       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))
+        v.is_a?(BigDecimal) ? v : BigDecimal(v.to_s)
       end
       mrc.unrounded_values = array_of_values.map { |v| v * mrc.decimal_shift }
 

data/test/lare_round_test.rb

@@ -4,13 +4,13 @@ require_relative 'test_helper'
 require 'bigdecimal'
 require 'securerandom'
 
-class LareRoundTest < MiniTest::Spec
+class LareRoundTest < Minitest::Spec
   def test_has_static_method_round
     assert_equal(true, LareRound.respond_to?(:round))
   end
 
   def create_big_decimal(precision, digit)
-    BigDecimal('0.' + '3' * precision + digit.to_s)
+    BigDecimal("0.#{'3' * precision}#{digit}")
   end
 
   (1..9).each do |digit|
@@ -36,11 +36,9 @@ class LareRoundTest < MiniTest::Spec
           with precision of #{precision} if passed as hash
         TESTMETHOD
         define_method method_name do
-          hash = Hash[
-            (1..items).map do |x|
-              [x, create_big_decimal(precision, digit)]
-            end
-          ]
+          hash = (1..items).to_h do |x|
+            [x, create_big_decimal(precision, digit)]
+          end
           rounded_total = hash.values.reduce(:+).round(precision)
           assert_equal(
             rounded_total,
@@ -54,14 +52,12 @@ class LareRoundTest < MiniTest::Spec
           if passed as hash should not change order
         TESTMETHOD
         define_method method_name do
-          hash = Hash[
-            (1..items).map.with_index do |x, i|
-              [x, create_big_decimal(precision, digit) + BigDecimal(i)]
-            end
-          ]
+          hash = (1..items).map.with_index do |x, i|
+            [x, create_big_decimal(precision, digit) + BigDecimal(i)]
+          end.to_h
           rounded_hash = LareRound.round(hash.clone, precision)
-          hash.keys.each do |key|
-            assert((((hash[key] - rounded_hash[key]) * 10**precision).abs < 1))
+          hash.each_key do |key|
+            assert((((hash[key] - rounded_hash[key]) * (10**precision)).abs < 1))
           end
         end
 

data/test/test_helper.rb

@@ -8,7 +8,6 @@ lib_dir  = File.join(base_dir, 'lib')
 
 $LOAD_PATH.unshift(lib_dir)
 
-require 'minitest/spec'
 require 'minitest/autorun'
 
 require 'lare_round'

metadata

@@ -1,85 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lare_round
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - Carsten Wirth
-autorequire: 
 bindir: bin
 cert_chain: []
-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: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rubocop
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: simplecov
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
+date: 2025-01-31 00:00:00.000000000 Z
+dependencies: []
 description: |2
       A collection of BigDecimal items e.g. invoice items can be rounded for
       displaying them in views. Rounding may apply a rounding error to the
@@ -91,18 +20,21 @@ description: |2
       total sum for fractionated parts thus eliminating this confusion.
 email:
 - cwirth79@web.de
-executables: []
+executables:
+- console
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
-- ".travis.yml"
+- ".ruby-version"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
 - lare_round.gemspec
 - lib/lare_round.rb
 - lib/lare_round/version.rb
@@ -111,8 +43,8 @@ files:
 homepage: ''
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -120,18 +52,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.4
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.8
-signing_key: 
+rubygems_version: 3.6.3
 specification_version: 4
 summary: gem for rounding BigDecimal items by preserving its sum
-test_files:
-- test/lare_round_test.rb
-- test/test_helper.rb
+test_files: []

data/.travis.yml

@@ -1,12 +0,0 @@
-language: ruby
-
-rvm:
-  - 2.4.5
-  - 2.5.3
-  - 2.6.0
-  - jruby-9.1
-  - jruby-9.2
-
-script:
-  - bundle exec rubocop
-  - bundle exec rake test