commissioner-guy 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe7e70de62af11761a16e9f9a1375aa837abc96e7a9c6d5ae7054a502036c69f
-  data.tar.gz: 7f75bd17875adc6aefa876d59e99d12c84ced25f775fade72873b128b3a954ae
+  metadata.gz: '09145e647b6a57e336c094804b5cae11c6aa1346a3bacda852f6119a0e79a322'
+  data.tar.gz: 20a9ced63f0ecab83195834d36b710a9bf1a0e9d6cf3aea557347cd976c98f22
 SHA512:
-  metadata.gz: d7a2d80c717ac710a51863745b69cb54d6c0c077a7c4d7c68167b4d42988ef530482396b38abf659a1375690694d42674dbadfc7b9a312f04d031b1c7cd1a9cb
-  data.tar.gz: a6286246d68e4a1860c808d5e8566ede9490a63ac5333b18ca1b5d4cbdea772c7fa189b124f8c5341207512aaac11bd559ccc5b44034d9e5036298a2137a46c2
+  metadata.gz: '006658ff7ea4801acf352c15c8fb192970fbecab106e548596b69910332612bd62a78daf935db3583c03efbb699ef6f04eb7de3412512e7f6a387d6b04d1499d'
+  data.tar.gz: 749dfe3e31731ddde638be7d7e84bf2a1e9d28d77352183ad97c4a10dcb84bbdfcf75e5cff8035aca3f298c387b639f13891c2be21d4edd4c1631041e01263bc

data/.rubocop.yml

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

data/.rubocop_todo.yml

@@ -0,0 +1,61 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2020-12-12 19:03:34 UTC using RuboCop version 1.6.1.
+# 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: 1
+# Configuration parameters: Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'commissioner.gemspec'
+
+# Offense count: 2
+# Configuration parameters: AllowedMethods.
+# AllowedMethods: enums
+Lint/ConstantDefinitionInBlock:
+  Exclude:
+    - 'spec/commissioner/mixin_spec.rb'
+
+# Offense count: 2
+# Configuration parameters: IgnoredMethods, CountRepeatedAttributes.
+Metrics/AbcSize:
+  Max: 19
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+# IgnoredMethods: refine
+Metrics/BlockLength:
+  Max: 98
+
+# Offense count: 1
+# Configuration parameters: CountComments, CountAsOne.
+Metrics/ClassLength:
+  Max: 101
+
+# Offense count: 1
+# Configuration parameters: IgnoredMethods.
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, ExcludedMethods, IgnoredMethods.
+Metrics/MethodLength:
+  Max: 20
+
+# Offense count: 2
+Style/ClassVars:
+  Exclude:
+    - 'lib/commissioner/mixin.rb'
+
+# Offense count: 4
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/commissioner.rb'
+    - 'lib/commissioner/calculator.rb'
+    - 'lib/commissioner/mixin.rb'

data/.travis.yml

@@ -7,4 +7,5 @@ rvm:
 before_install: gem install bundler -v 1.17.3
 
 script:
+  - bundle exec rubocop
   - bundle exec rspec

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in exchanger.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    commissioner-guy (0.1.1)
+    commissioner-guy (0.2.0)
       dry-auto_inject (~> 0.6)
       dry-configurable (~> 0.11)
       money (~> 6.13.8)
@@ -9,6 +9,9 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.1)
+    byebug (11.1.3)
+    coderay (1.1.3)
     concurrent-ruby (1.1.7)
     diff-lcs (1.4.4)
     dry-auto_inject (0.7.0)
@@ -20,14 +23,27 @@ GEM
     dry-container (0.7.2)
       concurrent-ruby (~> 1.0)
       dry-configurable (~> 0.1, >= 0.1.3)
-    dry-core (0.4.10)
+    dry-core (0.5.0)
       concurrent-ruby (~> 1.0)
     dry-equalizer (0.3.0)
     i18n (1.8.5)
       concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
     money (6.13.8)
       i18n (>= 0.6.4, <= 2)
+    parallel (1.20.1)
+    parser (2.7.2.0)
+      ast (~> 2.4.1)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
+    rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (2.0.0)
+    rexml (3.2.4)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -41,6 +57,19 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    rubocop (1.6.1)
+      parallel (~> 1.10)
+      parser (>= 2.7.1.5)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.2.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (1.3.0)
+      parser (>= 2.7.1.5)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.7.0)
 
 PLATFORMS
   ruby
@@ -48,8 +77,10 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.17)
   commissioner-guy!
+  pry-byebug (~> 3.9.0)
   rake (~> 10.0)
   rspec (~> 3.0)
+  rubocop (~> 1.6.1)
 
 BUNDLED WITH
    1.17.3

data/README.md

@@ -77,6 +77,76 @@ class MyCalculator
 end
 ```
 
+#### Specify order
+
+You can specify in which order calculation will be applied. The steps are:
+
+- exchange
+- commission
+- exchange_commission
+
+`exchange` - calls exchanger if currencies of received and charged amounts differ
+`commission` - applies typical commission operation
+`exchange_commission` - applies commission for exchange (in charged currency if ordered before `exchange` or in received currency if ordered after `exchange`)
+
+```ruby
+class MyCalculator
+  include Commissioner::Mixin
+
+  # Default order is:
+  # - :commission
+  # - :exchange
+  # - :exchange_commission
+
+  Order[
+    :commission,
+    :exchange_commission,
+    :exchange
+  ]
+end
+
+MyCalculator.new.calculate(
+  received_amount: 100,
+  received_currency: 'EUR',
+  charged_currency: 'USD',
+  commission: 10,
+  exchange_commission: 15
+).to_h
+# =>
+#   {
+#     :received_amount => #<Money fractional:10000 currency:EUR>,
+#     :charged_amount => #<Money fractional:13072 currency:USD>,
+#     :fee => #<Money fractional:1307 currency:USD>,
+#     :exchange_fee => #<Money fractional:1765 currency:USD>,
+#     :exchange_rate => 1
+#    }
+
+# Changing the order
+class MyCalculator
+  Order[
+    :exchange_commission,
+    :exchange,
+    :commission
+  ]
+end
+
+MyCalculator.new.calculate(
+  received_amount: 100,
+  received_currency: 'EUR',
+  charged_currency: 'USD',
+  commission: 10,
+  exchange_commission: 15
+).to_h
+# =>
+#   {
+#     :received_amount => #<Money fractional:10000 currency:EUR>,
+#     :charged_amount => #<Money fractional:13072 currency:USD>,
+#     :fee => #<Money fractional:1111 currency:EUR>,
+#     :exchange_fee => #<Money fractional:1961 currency:USD>,
+#     :exchange_rate => 1
+#    }
+```
+
 ## Development
 
 - [x] Custom exchanger
@@ -84,7 +154,8 @@ end
 - [x] Commission for operation
 - [x] Commission for exchange
 - [x] No matter whether received or charged amount is provided, the calculation result is the same
-- [ ] User-defined order of commissions aplying
+- [x] User-defined order of commissions aplying and exchanging
+- [ ] Custom commissions and exchanges in order
 
 ## Contributing
 

data/Rakefile

@@ -1,9 +1,11 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 task :build do
   sh 'gem build commissioner.gemspec'

data/bin/console

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "exchanger"
+require 'bundler/setup'
+require 'exchanger'
 
 # 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.
@@ -10,5 +11,5 @@ require "exchanger"
 # require "pry"
 # Pry.start
 
-require "irb"
+require 'irb'
 IRB.start(__FILE__)

data/commissioner.gemspec

@@ -1,4 +1,6 @@
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'commissioner/version'
 
@@ -8,8 +10,8 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Valentine Kiselev']
   spec.email         = ['mrexox@outlook.com']
 
-  spec.summary       = %q{A simple gem to calculate money based on provided amounts.}
-  spec.description   = %q{A simple gem to calculate money based on provided amounts.}
+  spec.summary       = 'A simple gem to calculate money based on provided amounts.'
+  spec.description   = 'A simple gem to calculate money based on provided amounts.'
   spec.homepage      = 'https://github.com/mrexox/commissioner'
   spec.license       = 'MIT'
 
@@ -25,17 +27,19 @@ Gem::Specification.new do |spec|
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
 
   spec.require_paths = ['lib']
 
-  spec.add_runtime_dependency 'dry-configurable', '~> 0.11'
   spec.add_runtime_dependency 'dry-auto_inject', '~> 0.6'
+  spec.add_runtime_dependency 'dry-configurable', '~> 0.11'
   spec.add_runtime_dependency 'money', '~> 6.13.8'
 
   spec.add_development_dependency 'bundler', '~> 1.17'
+  spec.add_development_dependency 'pry-byebug', '~> 3.9.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 1.6.1'
 end

data/lib/commissioner.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'commissioner/version'
 require 'commissioner/calculator'
 require 'commissioner/mixin'
@@ -11,6 +13,6 @@ module Commissioner
   setting :rounding_mode, :half_up # possible values: :up, :down, :half_up, :half_even
 
   def self.calculate(params)
-    Calculator.new(params, config: self.config).calculate
+    Calculator.new(params, config: config).calculate
   end
 end

data/lib/commissioner/calculator.rb

@@ -1,3 +1,6 @@
+# frozen_string_literal: true
+
+require 'ostruct'
 require 'money'
 
 module Commissioner
@@ -5,10 +8,77 @@ module Commissioner
     AmountUnknown = Class.new(StandardError)
     CommissionerArityInvalid = Class.new(StandardError)
 
-    HELP_MESSAGE = 'You must provider either charged_amount (with charged_currency) or received_amount (with received_currency). If none or both are non-zero, the service cannot know how to handle this.'.freeze
+    class Operator
+      OPERATIONS = {
+        exchange: ->(op) { op.exchange },
+        commission: ->(op) { op.apply_commission(op.commission, :operation) },
+        exchange_commission: ->(op) { op.apply_commission(op.exchange_commission, :exchange) if op.to != op.from }
+      }.freeze
+
+      attr_reader :commission, :exchange_commission, :exchanger, :to, :from, :exchange_fee, :fee, :exchange_rate,
+                  :amount
+
+      def initialize(params)
+        @amount = params[:amount]
+        @commission = params[:commission]
+        @exchange_commission = params[:exchange_commission]
+        @exchanger = params[:exchanger]
+        @rounding_mode = params[:rounding_mode]
+        @commission_action = params[:commission_action]
+        @from = params[:from_currency]
+        @to = params[:to_currency]
+      end
+
+      def apply_order(order)
+        order.each do |operation|
+          OPERATIONS[operation]&.call(self)
+        end
+      end
+
+      def apply_commission(commission, type)
+        return 0 unless commission
+
+        if @commission_action == :reduce
+          fee = round(@amount.to_f * commission / 100, @amount.currency.to_s)
+          @amount -= fee
+        else
+          fee = round(@amount.to_f * commission / (100 - commission), @amount.currency.to_s)
+          @amount += fee
+        end
+
+        case type
+        when :exchange
+          @exchange_fee = fee
+        else
+          @fee = fee
+        end
+      end
+
+      def round(decimal, currency)
+        Money.with_rounding_mode(@rounding_mode) do
+          Money.from_amount(decimal, currency)
+        end
+      end
+
+      def exchange
+        @amount, @exchange_rate = exchanger.call(from, to, @amount)
+      end
+    end
+
+    HELP_MESSAGE = 'You must provider either charged_amount (with charged_currency) '\
+                   'or received_amount (with received_currency). If none or both are '\
+                   'non-zero, the service cannot know how to handle this.'
+    DEFAULT_ORDER = %i[
+      commission
+      exchange
+      exchange_commission
+    ].freeze
+
     private_constant :HELP_MESSAGE
+    private_constant :DEFAULT_ORDER
+    private_constant :Operator
 
-    def initialize(params, config:)
+    def initialize(params, config:, order: DEFAULT_ORDER)
       @charged_amount = guess_amount(params[:charged_amount], params[:charged_currency])
       @received_amount = guess_amount(params[:received_amount], params[:received_currency])
 
@@ -16,10 +86,11 @@ module Commissioner
       @commission = params[:commission] || 0
 
       unless config.exchanger.is_a?(Proc) && config.exchanger.arity == 3
-        raise CommissionerArityInvalid.new("'exchanger' setting must be a lambda with arity of 3")
+        raise CommissionerArityInvalid, "'exchanger' setting must be a lambda with arity of 3"
       end
 
       @exchanger = config.exchanger
+      @order = order
       @rounding_mode =
         case config.rounding_mode
         when :up
@@ -34,53 +105,69 @@ module Commissioner
     end
 
     def calculate
-      if !empty?(@received_amount) && empty?(@charged_amount)
-        @charged_amount = calculate_for_received
-      elsif !empty?(@charged_amount) && empty?(@received_amount)
-        @received_amount = calculate_for_charged
-      else
-        raise AmountUnknown.new(HELP_MESSAGE)
-      end
-
-      OpenStruct.new(
+      @result = OpenStruct.new(
         received_amount: @received_amount,
         charged_amount: @charged_amount,
-        fee: @fee,
-        exchange_fee: @exchange_fee,
-        exchange_rate: @exchange_rate
+        fee: 0,
+        exchange_fee: 0,
+        exchange_rate: 0
       )
+
+      if !empty?(@charged_amount) && @received_amount.zero?
+        calculate_for_charged
+      elsif !empty?(@received_amount) && @charged_amount.zero?
+        calculate_for_received
+      else
+        raise AmountUnknown, HELP_MESSAGE
+      end
+
+      @result
     end
 
     private
 
-    attr_reader :exchange_commission, :commission, :exchanger
-
     def empty?(amount)
       amount.nil? || amount.zero?
     end
 
-    def calculate_for_received
-      amount = @received_amount
-
-      amount, @exchange_fee = add_commission(amount, exchange_commission)
-
-      amount, @exchange_rate = exchange(amount) if @charged_amount.currency != @received_amount.currency
+    def calculate_for_charged
+      operator = Operator.new(
+        from_currency: @charged_amount.currency.to_s,
+        to_currency: @received_amount.currency.to_s,
+        amount: @charged_amount,
+        commission: @commission,
+        exchange_commission: @exchange_commission,
+        exchanger: @exchanger,
+        rounding_mode: @rounding_mode,
+        commission_action: :reduce
+      )
 
-      amount, @fee = add_commission(amount, commission)
+      operator.apply_order(@order)
 
-      amount
+      @result.received_amount = operator.amount
+      @result.fee = operator.fee if operator.fee
+      @result.exchange_fee = operator.exchange_fee if operator.exchange_fee
+      @result.exchange_rate = operator.exchange_rate
     end
 
-    def calculate_for_charged
-      amount = @charged_amount
-
-      amount, @fee = reduce_commission(amount, commission)
-
-      amount, @exchange_rate = exchange(amount) if @charged_amount.currency != @received_amount.currency
+    def calculate_for_received
+      operator = Operator.new(
+        from_currency: @charged_amount.currency.to_s,
+        to_currency: @received_amount.currency.to_s,
+        amount: @received_amount,
+        commission: @commission,
+        exchange_commission: @exchange_commission,
+        exchanger: @exchanger,
+        rounding_mode: @rounding_mode,
+        commission_action: :add
+      )
 
-      amount, @exchange_fee = reduce_commission(amount, exchange_commission)
+      operator.apply_order(@order.reverse)
 
-      amount
+      @result.charged_amount = operator.amount
+      @result.fee = operator.fee if operator.fee
+      @result.exchange_fee = operator.exchange_fee if operator.exchange_fee
+      @result.exchange_rate = operator.exchange_rate
     end
 
     def guess_amount(amount, currency)
@@ -93,31 +180,5 @@ module Commissioner
         Money.new(0, currency) if currency.is_a?(String)
       end
     end
-
-    def reduce_commission(amount, commission)
-      return 0 unless commission
-      fee = round(amount.to_f * commission / 100, amount.currency.to_s)
-      amount -= fee
-
-      [amount, fee]
-    end
-
-    def add_commission(amount, commission)
-      return 0 unless commission
-      fee = round(amount.to_f * commission / (100 - commission), amount.currency.to_s)
-      amount += fee
-
-      [amount, fee]
-    end
-
-    def round(decimal, currency)
-      Money.with_rounding_mode(@rounding_mode) do
-        Money.from_amount(decimal, currency)
-      end
-    end
-
-    def exchange(amount)
-      exchanger.call(@charged_amount.currency.to_s, @received_amount.currency.to_s, amount)
-    end
   end
 end

data/lib/commissioner/mixin.rb

@@ -1,16 +1,17 @@
+# frozen_string_literal: true
+
 module Commissioner
   module Mixin
-    # TODO: Allow configuring order of operations
-    # Order = ->(*order) { @@order = order }
+    Order = ->(*order) { @@order = order }
 
-    # @@order = [
-    #   :commission,
-    #   :exchange,
-    #   :exchange_commission
-    # ]
+    @@order = %i[
+      commission
+      exchange
+      exchange_commission
+    ]
 
     def calculate(params)
-      Calculator.new(params, config: Commissioner.config).calculate
+      Calculator.new(params, config: Commissioner.config, order: @@order).calculate
     end
   end
 end

data/lib/commissioner/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Commissioner
-  VERSION = "0.1.2"
+  VERSION = '0.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: commissioner-guy
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Valentine Kiselev
@@ -11,33 +11,33 @@ cert_chain: []
 date: 2020-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: dry-configurable
+  name: dry-auto_inject
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.11'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
-  name: dry-auto_inject
+  name: dry-configurable
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.11'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.11'
 - !ruby/object:Gem::Dependency
   name: money
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.9.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.6.1
 description: A simple gem to calculate money based on provided amounts.
 email:
 - mrexox@outlook.com
@@ -103,6 +131,8 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
 - ".ruby-version"
 - ".travis.yml"
 - Gemfile