mint-money 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 546ffe1b3832a048fcfc298bbc6c0ced7b78675b
+  data.tar.gz: c4c8af84ee084d3706aebb8bc0e8a1582109e44d
+SHA512:
+  metadata.gz: 240fe427f6e3ab74a4940733bbd49690e3bb1dc71e02fcd1e16b1dfb2e79d5568533d35a8ade563464ff0d8fea6279660929982af20642f5c3b248cfe80a42b2
+  data.tar.gz: ad8d81cea51deb5750030a4dca9189cd6a3bea5204e6dd7fd939111f77b9446a7c4ec115f3660f4286badebbf5937cd3c556ab0f27b15a487b5602351a0f948b

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+/.idea

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--require spec_helper
+--format documentation

data/.rubocop.yml

@@ -0,0 +1,4 @@
+Metrics/LineLength:
+  Max: 120
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.3
+before_install: gem install bundler -v 1.15.1

data/Gemfile

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

data/README.md

@@ -0,0 +1,88 @@
+# Mint::Money
+
+Mint::Money perform currency conversion and arithmetics with different currencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mint-money'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mint-money
+
+## Usage
+
+```
+# Configure the currency rates with respect to a base currency (here EUR):
+ 
+Money.conversion_rates('EUR', {
+  'USD'     => 1.11,
+  'Bitcoin' => 0.0047
+})
+```
+ 
+```
+# Instantiate money objects:
+ 
+fifty_eur = Money.new(50, 'EUR')
+ 
+# Get amount and currency:
+ 
+fifty_eur.amount   # => 50
+fifty_eur.currency # => "EUR"
+fifty_eur.inspect  # => "50.00 EUR"
+```
+ 
+```
+# Convert to a different currency (should return a Money
+# instance, not a String):
+ 
+fifty_eur.convert_to('USD') # => 55.50 USD
+```
+ 
+```
+# Perform operations in different currencies:
+ 
+twenty_dollars = Money.new(20, 'USD')
+ 
+# Arithmetics:
+ 
+fifty_eur + twenty_dollars # => 68.02 EUR
+fifty_eur - twenty_dollars # => 31.98 EUR
+fifty_eur / 2              # => 25 EUR
+twenty_dollars * 3         # => 60 USD
+```
+ 
+```
+# Comparisons (also in different currencies):
+ 
+twenty_dollars == Money.new(20, 'USD') # => true
+twenty_dollars == Money.new(30, 'USD') # => false
+ 
+fifty_eur_in_usd = fifty_eur.convert_to('USD')
+fifty_eur_in_usd == fifty_eur          # => true
+ 
+twenty_dollars > Money.new(5, 'USD')   # => true
+twenty_dollars < fifty_eur             # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/mpakus/mint-money.
+
+[![CircleCI](https://circleci.com/gh/mpakus/mint-money.svg?style=svg)](https://circleci.com/gh/mpakus/mint-money)
+

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

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

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/circle.yml

@@ -0,0 +1,3 @@
+dependencies:
+  pre:
+    - gem install bundler --pre

data/lib/mint/money.rb

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+require File.dirname(__FILE__) + '/money/version'
+require File.dirname(__FILE__) + '/money/money'

data/lib/mint/money/currency.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require_relative './utils'
+require_relative './exceptions'
+
+module Mint
+  # Global Currencies state
+  class Currency
+    class << self
+      attr_accessor :base, :rates, :precisions
+
+      # Setup currency base and conversion rates
+      def conversion_rates(base, rates)
+        @base = Mint::Utils.to_key(base)
+        @rates = Hash[rates.map { |k, v| [Mint::Utils.to_key(k), Mint::Utils.to_amount(v, Mint::Utils.to_key(k))] }]
+        @rates[@base] = Mint::Utils.to_amount(1.0, @base)
+      end
+
+      # Set round precisions for exceptional currencies like BTC
+      # @params precisions [Hash] of currency exception and number of precision e.g. {BTC: 8}
+      def round_precisions(precisions)
+        @precisions = Hash[precisions.map { |k, v| [Mint::Utils.to_key(k), v.to_i] }]
+      end
+
+      # @return [String]
+      def base
+        @base.to_s
+      end
+
+      # Checks if currency exists in our conversion rates hash
+      # @return [Boolean]
+      def valid?(currency)
+        @rates.key?(currency)
+      end
+
+      # Convert Mint::Money object's amount to another currency
+      # @TODO: use `use_base` flag try to deep conversion through the currency base
+      # @params money [Mint::Money]
+      # @params currency [String, Symbol]
+      # @params _use_base [Boolean]
+      # @return [Mint::Money]
+      def convert_to(money, currency, _use_base = false)
+        currency_need = Mint::Utils.to_key(currency)
+        raise WrongCurrencyError, currency unless Mint::Currency.valid?(currency_need)
+        return money if money.currency_sym == currency_need
+
+        rate = calculate_rate(money, currency_need)
+        Mint::Money.new(money.amount * rate, currency_need)
+      end
+
+      private
+
+      # Find exchange rate
+      # @param money [Mint::Money]
+      # @param currency_needed [Symbol]
+      # @return [BigDecimal]
+      def calculate_rate(money, currency_need)
+        # when they are not the same currency
+        if @base != money.currency_sym
+          # but base currency equal to what we need take reverse currency e.g. 1/currency
+          return 1 / @rates[money.currency_sym] if @base == currency_need
+          raise(WrongConversionError, "#{money.inspect} from #{money.currency_sym} to #{currency_need}")
+        end
+        @rates[currency_need]
+      end
+    end
+  end
+end

data/lib/mint/money/exceptions.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Mint
+  # When currency type is unrecognized
+  class WrongCurrencyError < ArgumentError
+    def initialize(value)
+      super "Can't find #{value} currency, please setup it with Mint::Money.conversion.rates"
+    end
+  end
+
+  # When money type is unrecognized
+  class WrongMoneyError < TypeError
+    def initialize(value)
+      super "Wrong amount's type #{value.inspect}, should be Float, BigDecimal or Mint::Money"
+    end
+  end
+
+  # When a conversion need to setup currency rate
+  class WrongConversionError < ArgumentError
+    def initialize(msg)
+      super "Can't convert #{msg} without conversion rates"
+    end
+  end
+end

data/lib/mint/money/money.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'bigdecimal/util'
+require 'forwardable'
+require_relative './currency'
+require_relative './exceptions'
+require_relative './utils'
+
+module Mint
+  # Minty Money Management
+  #
+  # @author Renat Ibragimov <renat@aomega.co>
+  #
+  # @see https://github.com/mpakus/mint-money
+  class Money
+    include Comparable
+
+    attr_reader :value, :currency, :currency_sym
+    alias amount value
+
+    # @param value [Integer]
+    # @param currency [String,Symbol]
+    # @return [Mint::Money]
+    def initialize(value = 0.00, currency = nil)
+      @currency_sym = normalize_currency(currency)
+      @currency = currency.to_s.upcase
+      @value = Mint::Utils.to_amount(value, @currency_sym)
+    end
+
+    class << self
+      extend Forwardable
+      # Delegate .conversion_rates class method to Mint::Currency class
+      def_delegator :'Mint::Currency', :conversion_rates
+      def_delegator :'Mint::Currency', :round_precisions
+    end
+
+    # Returns formatted value and currency name
+    # @return [String]
+    def inspect
+      "#{self} #{currency}"
+    end
+
+    # Auto/Stringify instance
+    # @return [String]
+    def to_s
+      Mint::Utils.to_format(value, currency_sym)
+    end
+
+    # Create new Mint::Money with amount converted to another currency
+    # @param currency [Symbol]
+    # @param use_base [Boolean]
+    # @return [Mint::Money]
+    def convert_to(currency, use_base = false)
+      Mint::Currency.convert_to(self, currency, use_base)
+    end
+
+    # Plus operation
+    # @return [Mint::Money]
+    def +(other)
+      other = self.class.new(other, @currency_sym) unless other.is_a? self.class
+      self.class.new(amount + cast_type(other).amount, @currency_sym)
+    end
+
+    # Minus operation
+    # @return [Mint::Money]
+    def -(other)
+      other = self.class.new(other, @currency_sym) unless other.is_a? self.class
+      self.class.new(amount - cast_type(other).amount, @currency_sym)
+    end
+
+    # Equal operation
+    # Two Mint::Money objects are equal or one of them is a String and looks like .inspect results
+    # @return [Boolean]
+    def ==(other)
+      eql?(other)
+    end
+
+    # rubocop:disable all
+    # @return [Boolean]
+    def eql?(other)
+      return inspect == other if other.class == String
+      # what if they are same class just different currencies
+      other = cast_type(other) if other.is_a?(self.class) && currency_sym != other.currency_sym
+      self.class == other.class && amount == other.amount && currency_sym == other.currency_sym
+    end
+    # rubocop:enable all
+
+    # Divide operation
+    # @return [Mint::Money]
+    def /(other)
+      other = self.class.new(other, @currency_sym) unless other.is_a? self.class
+      self.class.new(amount / other.amount, @currency_sym)
+    end
+
+    # Multiplication operation
+    # @return [Mint::Money]
+    def *(other)
+      other = self.class.new(other, @currency_sym) unless other.is_a? self.class
+      self.class.new(amount * other.amount, @currency_sym)
+    end
+
+    # Lower and bigger (sort, spaceship) operation
+    # @return [boolean]
+    def <=>(other)
+      other = self.class.new(other, @currency_sym) unless other.is_a? self.class
+      amount <=> other.amount
+    end
+
+    private
+
+    # Convert other Money to the same currency
+    # @return [Mint::Money]
+    def cast_type(other)
+      return Mint::Currency.convert_to(other, @currency_sym) if @currency_sym != other.currency_sym
+      other
+    end
+
+    # @return [Symbol]
+    def normalize_currency(currency = nil)
+      currency_sym = Mint::Utils.to_key(currency)
+      raise WrongCurrencyError, currency unless Mint::Currency.valid?(currency_sym)
+      currency_sym
+    end
+  end
+end

data/lib/mint/money/utils.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'bigdecimal'
+require 'bigdecimal/util'
+require_relative './exceptions'
+
+module Mint
+  # Special utilities
+  class Utils
+    class << self
+      # Normalize string to our keys format
+      # @example
+      #   'usd' -> :USD
+      # @param [String,Symbol]
+      # @return [Symbol]
+      def to_key(key)
+        key.to_s.upcase.to_sym
+      end
+
+      # Normalize and guess amount's type
+      # @example
+      #   '1.178' -> <BigDecimal: 1.18>
+      # @param value [BigDecimal]
+      # @param currency [Symbol]
+      # @return [BigDecimal]
+      def to_amount(value, currency)
+        to_bigdecimal(value).round(precision(currency))
+      end
+
+      # Format number as string with correct precision
+      # @param value [BigDecimal]
+      # @param currency [Symbol]
+      # @return [String]
+      def to_format(value, currency)
+        format("%.#{precision(currency)}f", value.to_f)
+      end
+
+      private
+
+      # Return precision for round or default is 2
+      # @param currency [String,Symbol]
+      # @return [Integer]
+      def precision(currency)
+        (Mint::Currency.precisions || {}).fetch(to_key(currency), 2)
+      end
+
+      # Trying to guess type
+      # @param value [Mixed]
+      # @return [BigDecimal]
+      def to_bigdecimal(value)
+        case value
+        when Mint::Money
+          value.value
+        when Rational
+          value.to_d(16)
+        else
+          value.respond_to?(:to_d) ? value.to_d : raise(WrongMoneyError, value)
+        end
+      end
+    end
+  end
+end

data/lib/mint/money/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Mint
+  class Money
+    VERSION = '0.1.1'.freeze
+  end
+end

data/mint-money.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+# frozen_string_literal: true
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mint/money/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mint-money'
+  spec.version       = Mint::Money::VERSION
+  spec.authors       = ['Renat Ibragimov']
+  spec.email         = ['mrak69@gmail.com']
+
+  spec.summary       = 'Manage money with Mint::Money'
+  spec.description   = File.read(File.expand_path('../README.md', __FILE__))
+  spec.homepage      = 'https://github.com/mpakus/mint-money'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.49'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,218 @@
+--- !ruby/object:Gem::Specification
+name: mint-money
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Renat Ibragimov
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.49'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: |+
+  # Mint::Money
+
+  Mint::Money perform currency conversion and arithmetics with different currencies.
+
+  ## Installation
+
+  Add this line to your application's Gemfile:
+
+  ```ruby
+  gem 'mint-money'
+  ```
+
+  And then execute:
+
+      $ bundle
+
+  Or install it yourself as:
+
+      $ gem install mint-money
+
+  ## Usage
+
+  ```
+  # Configure the currency rates with respect to a base currency (here EUR):
+   
+  Money.conversion_rates('EUR', {
+    'USD'     => 1.11,
+    'Bitcoin' => 0.0047
+  })
+  ```
+   
+  ```
+  # Instantiate money objects:
+   
+  fifty_eur = Money.new(50, 'EUR')
+   
+  # Get amount and currency:
+   
+  fifty_eur.amount   # => 50
+  fifty_eur.currency # => "EUR"
+  fifty_eur.inspect  # => "50.00 EUR"
+  ```
+   
+  ```
+  # Convert to a different currency (should return a Money
+  # instance, not a String):
+   
+  fifty_eur.convert_to('USD') # => 55.50 USD
+  ```
+   
+  ```
+  # Perform operations in different currencies:
+   
+  twenty_dollars = Money.new(20, 'USD')
+   
+  # Arithmetics:
+   
+  fifty_eur + twenty_dollars # => 68.02 EUR
+  fifty_eur - twenty_dollars # => 31.98 EUR
+  fifty_eur / 2              # => 25 EUR
+  twenty_dollars * 3         # => 60 USD
+  ```
+   
+  ```
+  # Comparisons (also in different currencies):
+   
+  twenty_dollars == Money.new(20, 'USD') # => true
+  twenty_dollars == Money.new(30, 'USD') # => false
+   
+  fifty_eur_in_usd = fifty_eur.convert_to('USD')
+  fifty_eur_in_usd == fifty_eur          # => true
+   
+  twenty_dollars > Money.new(5, 'USD')   # => true
+  twenty_dollars < fifty_eur             # => true
+  ```
+
+  ## Development
+
+  After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+  To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+  ## Contributing
+
+  Bug reports and pull requests are welcome on GitHub at https://github.com/mpakus/mint-money.
+
+  [![CircleCI](https://circleci.com/gh/mpakus/mint-money.svg?style=svg)](https://circleci.com/gh/mpakus/mint-money)
+
+email:
+- mrak69@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- circle.yml
+- lib/mint/money.rb
+- lib/mint/money/currency.rb
+- lib/mint/money/exceptions.rb
+- lib/mint/money/money.rb
+- lib/mint/money/utils.rb
+- lib/mint/money/version.rb
+- mint-money.gemspec
+homepage: https://github.com/mpakus/mint-money
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.10
+signing_key: 
+specification_version: 4
+summary: Manage money with Mint::Money
+test_files: []