splittable 0.0.1 → 0.0.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba1d6d16997bdc50cceb7bfb3fbd4d8725171c8c5e945673042216245d614089
-  data.tar.gz: 290622d97e60bf50749db770057fbe14d9bfdd7fe5c6ecc952d11a5baf9c3f59
+  metadata.gz: cb837f528d6f26ba39664a98ccc95671c5a30d0148f0f8d17ee840154c49cebb
+  data.tar.gz: cf4595a1d4c52fb03ad82c6d7dd12e34df852120901235ed7fad28141f7ddebf
 SHA512:
-  metadata.gz: 10a4210eb291b4cadd03c041700df948dab6dcf1bdb92e51db862d01440ed98536eb89b41847c9c8933bbe9900ef52c2943e41e729574aa00b4777f03e1115cf
-  data.tar.gz: 48cd265bee2d9263c2ceacf618903cc8a557151baf5129496f28939234c75fc73c6e7fa790d6b50be511d0fa2723e4490e83ac03a714634333d67d83e9fd007d
+  metadata.gz: 94ed8b8ca4ec6216a37a369e5d4efdb9e183b10cf6e6ed1d8a72f9482319ed28330550a7200e55948451e527f6674112188a530bcc718981546ec5ae34bb4036
+  data.tar.gz: 889f51d82f678fa595d201b18c5eefcc01af4422c4802499d1ff6ce7f1dfa5c5ca0c5069ae82a5ec27ad79b7996c4428f813c86b790df3b36224057956a7e906

data/.github/workflows/publish_release.yml

@@ -0,0 +1,25 @@
+name: Publish Gem
+
+on:
+  push:
+    branches:
+      - master
+    tags:
+      - v*
+
+jobs:
+  publish:
+    if: github.event_name == 'push' && github.ref == 'refs/heads/master'
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Release Gem
+        uses: marcelotoledo5000/publish-rubygems-action@master
+        env:
+          GITHUB_TOKEN: ${{secrets.BUNDLE_GITHUB__COM}}
+          RUBYGEMS_API_KEY: ${{secrets.RUBYGEMS_RELEASE}}
+          GIT_EMAIL: automated_release@useblu.com.br
+          GIT_NAME: 'Automated Release'
+          RELEASE_COMMAND: bundle exec rake release

data/.github/workflows/ruby.yml

@@ -10,24 +10,27 @@ on:
 jobs:
   build:
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: [ '2.5', '2.6', '2.7', '3.0' ]
 
     steps:
     - uses: actions/checkout@v2
 
     - name: Set up Ruby version specified in `.ruby-version`
       with:
-          ruby-version: 2.6.6
+        ruby-version: ${{ matrix.ruby }}
       uses: eregon/use-ruby-action@master
 
     - name: Install dependencies
       run:  bundle install --jobs 4 --retry 3
 
-    - name: Run Rubocop
+    - name: Run tests with RSpec
       env:
         RAILS_ENV: test
-      run: bundle exec rubocop --config .rubocop.yml
+      run: bundle exec rspec
 
-    - name: Run tests with RSpec
+    - name: Run Rubocop
       env:
         RAILS_ENV: test
-      run: bundle exec rspec
+      run: bundle exec rubocop --config .rubocop.yml

data/.gitignore

@@ -10,10 +10,11 @@
 /spec/reports/
 /tmp/
 
-# rspec failure tracking
-.rspec_status
+# local gem
+splittable*.gem
 
 # rspec
+.rspec_status
 /spec/examples.txt
 
 .tool-versions

data/.ruby-version

@@ -1 +1 @@
-2.6.6
+3.0.0

data/CHANGELOG.md

@@ -1,3 +1,31 @@
+## splittable 0.0.5 (Feb 02, 2021)
+
+* Add precision parameter to division and normilize methods
+
+  *Ítalo Matos*
+
+## splittable 0.0.4 (Jan 29, 2021)
+
+* Fix publish_release job
+
+  *Marcelo Toledo*
+
+## splittable 0.0.3 (Jan 29, 2021)
+
+* Separate Division code
+* Separate Normalize code
+* Update actions to use ruby versions 2.5, 2.6 and 3.0
+* Add a badge to README.md
+* Updated some gems versions
+
+  *Eduardo Fiorezi, Marcelo Toledo*
+
+## splittable 0.0.2 (Jan 25, 2021)
+
+* Update description for rubygems.org
+* Add rubgems badge to README.md
+
+  *Marcelo Toledo*
 
 ## splittable 0.0.1 (Jan 14, 2021)
 

data/Gemfile

@@ -2,10 +2,9 @@
 
 source 'https://rubygems.org'
 
-ruby '2.6.6'
-
 gemspec
 
+gem 'bigdecimal', '~> 3.0'
 gem 'pry-byebug', '~> 3.9'
 gem 'rake', '~> 13.0.3'
 gem 'rspec', '~> 3.10'

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    splittable (0.0.1)
+    splittable (0.0.6)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
+    ast (2.4.2)
+    bigdecimal (3.0.0)
     byebug (11.1.3)
     coderay (1.1.3)
     diff-lcs (1.4.4)
@@ -23,7 +24,7 @@ GEM
       pry (~> 0.13.0)
     rainbow (3.0.0)
     rake (13.0.3)
-    regexp_parser (2.0.3)
+    regexp_parser (2.1.1)
     rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
@@ -34,11 +35,11 @@ GEM
     rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-mocks (3.10.1)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.1)
-    rubocop (1.8.1)
+    rspec-support (3.10.2)
+    rubocop (1.11.0)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
       rainbow (>= 2.2.2, < 4.0)
@@ -47,14 +48,14 @@ GEM
       rubocop-ast (>= 1.2.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.4.0)
+    rubocop-ast (1.4.1)
       parser (>= 2.7.1.5)
-    rubocop-performance (1.9.2)
+    rubocop-performance (1.10.0)
       rubocop (>= 0.90.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     rubocop-rake (0.5.1)
       rubocop
-    rubocop-rspec (2.1.0)
+    rubocop-rspec (2.2.0)
       rubocop (~> 1.0)
       rubocop-ast (>= 1.1.0)
     ruby-progressbar (1.11.0)
@@ -70,6 +71,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  bigdecimal (~> 3.0)
   pry-byebug (~> 3.9)
   rake (~> 13.0.3)
   rspec (~> 3.10)
@@ -80,8 +82,5 @@ DEPENDENCIES
   simplecov
   splittable!
 
-RUBY VERSION
-   ruby 2.6.6p146
-
 BUNDLED WITH
-   2.2.5
+   2.2.7

data/README.md

@@ -1,5 +1,8 @@
 # Splittable
 
+[![Gem Version](https://badge.fury.io/rb/splittable.svg)](https://badge.fury.io/rb/splittable)
+[![Ruby](https://github.com/Pagnet/splittable/workflows/Ruby/badge.svg?branch=master)](https://github.com/Pagnet/splittable/actions?query=workflow%3ARuby)
+
 ## Goal
 
 This gem solves the problem of several decimal places in divisions where the result must be presented in cents, that is converting the division result to only two decimal places and the difference is attributed to the first plot.
@@ -33,6 +36,17 @@ Result: the total truncated value was divided by the number of plots informed an
 ```ruby
 => [0.5e-1, 0.3e-1, 0.3e-1] # => [0.05, 0.03, 0.03]
 ```
+Default precision is 2 decimal places, but, you can customize this with precision parameter: 
+
+``` ruby
+Splittable.division(value: 10, quantity: 3, precision: 3)
+```
+
+Result: 
+```ruby
+=> [0.3334e1, 0.3333e1, 0.3333e1] # => [0.334, 0.333, 0.333]
+```
+
 
 Using `normalize` method:
 
@@ -46,6 +60,16 @@ Result: all values are truncated and them the difference is attributed in the fi
 => [0.3524e2, 0.2143e2, 0.4333e2] # => [35.24, 21.43, 43.33]
 ```
 
+In this method, you have the same optional precision parameter: 
+```ruby
+Splittable.normalize(value: 100, installments: [33.33333333, 33.33333333, 33.33333333], precision: 3)
+```
+
+Result: 
+```ruby
+=> [0.33334e2, 0.33333e2, 0.33333e2] # => [33.334, 33.333, 33.333]
+```
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/splittable.rb

@@ -1,47 +1,22 @@
 # frozen_string_literal: true
 
 require 'splittable/version'
+require 'splittable/division'
+require 'splittable/normalize'
 require 'bigdecimal/util'
 
 module Splittable
   class << self
     # receive total value and to quantity installments are required to equal division
     # just the first installment will receive the difference cents
-    def division(value:, quantity:)
-      convert_params!(value: value, quantity: quantity)
-      params_validation!(@quantity)
-      partial_value = (@value / @quantity).truncate(2)
-      decimal_difference = @value - (@quantity * partial_value)
-      installments = [partial_value] * @quantity
-      installments[0] += decimal_difference
-
-      installments
+    def division(value:, quantity:, precision: 2)
+      Splittable::Division.new(value: value, quantity: quantity, precision: precision).call
     end
 
     # receive total value and specific value of installments are required to specific division
     # just the first installment will receive the difference cents
-    def normalize(value:, installments:)
-      convert_params!(value: value, installments: installments)
-      decimal_difference = @value - @installments.sum
-      @installments[0] += decimal_difference
-
-      @installments
-    end
-
-    private
-
-    attr_accessor :value, :quantity, :installments
-
-    def params_validation!(quantity)
-      return if quantity.positive?
-
-      raise ArgumentError, 'quantity should be positive'
-    end
-
-    def convert_params!(value: nil, quantity: nil, installments: nil)
-      @value = BigDecimal(value.truncate(2), 15) unless value.nil?
-      @quantity = BigDecimal(quantity.to_i, 15) unless quantity.nil?
-      @installments = installments.map { |installment| BigDecimal(installment.round(2), 15) } unless installments.nil?
+    def normalize(value:, installments:, precision: 2)
+      Splittable::Normalize.new(value: value, installments: installments, precision: precision).call
     end
   end
 end

data/lib/splittable/division.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+class Splittable::Division
+  def initialize(value:, quantity:, precision: 2)
+    @precision = precision
+    @value = BigDecimal(value, 15).truncate(precision)
+    @quantity = BigDecimal(quantity.to_i, 15)
+
+    check_quantity_as_positive_value!
+  end
+
+  def call
+    partial_value = (value / quantity).truncate(precision)
+    installments = [partial_value] * quantity
+    installments[0] += value - installments.sum.to_d
+
+    installments
+  end
+
+  private
+
+  attr_reader :value, :quantity, :precision
+
+  def check_quantity_as_positive_value!
+    return if quantity.positive?
+
+    raise ArgumentError, 'quantity should be positive'
+  end
+end

data/lib/splittable/normalize.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+class Splittable::Normalize
+  def initialize(value:, installments:, precision: 2)
+    @value = BigDecimal(value, 15).truncate(precision)
+    @installments = installments.map { |installment| BigDecimal(installment.round(precision), 15) }
+  end
+
+  def call
+    decimal_difference = value - installments.sum
+    installments[0] += decimal_difference
+
+    installments
+  end
+
+  private
+
+  attr_reader :value
+  attr_accessor :installments
+end

data/lib/splittable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Splittable
-  VERSION = '0.0.1'
+  VERSION = '0.0.6'
 end

data/splittable.gemspec

@@ -10,8 +10,11 @@ Gem::Specification.new do |spec|
 
   spec.license       = 'MIT'
 
-  spec.summary       = 'Calculate division and normalize parcels.'
-  spec.description   = 'Calculate division and normalize parcels to use just cents.'
+  spec.summary       = 'Calculate division and normalize parcels to use just cents.'
+  spec.description   = 'This gem solves the problem of several decimal places in divisions
+                        where the result must be presented in cents, that is converting the
+                        division result to only two decimal places and the difference is
+                        attributed to the first plot.'
   spec.homepage      = 'https://github.com/Pagnet/splittable'
   spec.required_ruby_version = Gem::Requirement.new('>= 2.5.3')
 

metadata

@@ -1,17 +1,21 @@
 --- !ruby/object:Gem::Specification
 name: splittable
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.6
 platform: ruby
 authors:
 - Arthur Brandão
 - Marcelo Toledo
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-01-22 00:00:00.000000000 Z
+date: 2021-03-01 00:00:00.000000000 Z
 dependencies: []
-description: Calculate division and normalize parcels to use just cents.
+description: |-
+  This gem solves the problem of several decimal places in divisions
+                          where the result must be presented in cents, that is converting the
+                          division result to only two decimal places and the difference is
+                          attributed to the first plot.
 email:
 - arthur_aebc@hotmail.com
 - marcelotoledo5000@gmail.com
@@ -23,6 +27,7 @@ files:
 - ".github/ISSUE_TEMPLATE/feature_request.md"
 - ".github/ISSUE_TEMPLATE/security_vulnerability.md"
 - ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/workflows/publish_release.yml"
 - ".github/workflows/ruby.yml"
 - ".gitignore"
 - ".rspec"
@@ -39,6 +44,8 @@ files:
 - bin/console
 - bin/setup
 - lib/splittable.rb
+- lib/splittable/division.rb
+- lib/splittable/normalize.rb
 - lib/splittable/version.rb
 - sonar-project.properties
 - splittable.gemspec
@@ -49,7 +56,7 @@ metadata:
   homepage_uri: https://github.com/Pagnet/splittable
   source_code_uri: https://github.com/Pagnet/splittable
   changelog_uri: https://github.com/Pagnet/splittable/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -64,8 +71,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
-summary: Calculate division and normalize parcels.
+summary: Calculate division and normalize parcels to use just cents.
 test_files: []