geld 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a477e02346ad9f481e7bbf58304e68419aea5641
+  data.tar.gz: 98071b65fc6773fc6f8e29be10bea7619efd96a1
+SHA512:
+  metadata.gz: 1a9febd55f109812b20ba2c2a30f8e892cfb9c1094c3fe1b1bb1112ef166b17105dcc35d2e211e6cf4a7ee670a7e9b33a2502400b6358b96584d061263a9506e
+  data.tar.gz: 3fa8a5bf98ddbae6d522d00d37405bd7092ee608c6db68438388a772dd8c29ee5de0a06b24690abda4c1eb1d4880225ea1d61340e7baa07712ae0130a44cf862

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in geld.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Pedro Benevides
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,67 @@
+# Geld
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'geld'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install geld
+
+## Usage
+
+Configure your convertions
+
+```ruby
+  Geld::Money.convertion_rates("EUR", { "BRL" => 4, "USD" => 1.5 })
+```
+
+Instanciate a new money object
+
+```ruby
+  Geld::Money.new(10, "BRL")
+  => 10.00 BRL
+```
+
+Convert to another currency
+
+```ruby
+  Geld::Money.new(10, "BRL").convert_to("USD")
+  => 3.10 USD
+```
+
+Do operations with another currency
+
+```ruby
+  Geld::Money.new(10, "EUR") + Geld::Money.new(10, "BRL")
+  => 10.25 EUR
+```
+
+Compare with another currency
+
+```ruby
+  Geld::Money.new(1, "EUR") == Geld::Money.new(4, "BRL")
+  => 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.
+
+You can also create new example files in the examples folder `ruby examples/usage.rb`
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/pedroaugusto/geld.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "geld"
+
+# 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/examples/usage.rb

@@ -0,0 +1,25 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require "geld"
+
+rates_eur = { "BRL" => 3.63, "USD" => 1.12 }
+
+puts "EUR => #{rates_eur}"
+
+Geld::Money.convertion_rates("EUR", rates_eur)
+
+m1 = Geld::Money.new(10, "BRL")
+puts "m1 is #{m1.inspect}"
+puts "m1 is #{m1.convert_to("USD").inspect}"
+
+m2 = Geld::Money.new(99.10, "EUR")
+puts "m2 is #{m2.inspect}"
+puts "m2 is #{m2.convert_to("BRL").inspect}"
+
+m3 = Geld::Money.new(14.67, "USD")
+puts "m3 is #{m3.inspect}"
+puts "m3 is #{m3.convert_to("BRL").inspect}"
+
+puts "m1 + m2 is #{(m1 + m2).inspect}"
+puts "m1 - m3 is #{(m1 - m3).inspect}"
+puts "m2 * m3 is #{(m2 * m3).inspect}"
+puts "m3 / m1 is #{(m3 / m1).inspect}"

data/geld.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "geld/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "geld"
+  spec.version       = Geld::VERSION
+  spec.authors       = ["Pedro Benevides"]
+  spec.email         = ["pedro.augusto.sb@gmail.com"]
+
+  spec.summary       = %q{Gem to manage money currency operations.}
+  spec.homepage      = "https://github.com/pedroaugusto/geld"
+  spec.license       = "MIT"
+
+  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_dependency "activesupport", "~> 4.2"
+
+  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 "pry"
+  spec.add_development_dependency "pry-byebug"
+end

data/lib/geld.rb

@@ -0,0 +1,104 @@
+require "active_support/core_ext/module/attribute_accessors"
+require "bigdecimal"
+require "geld/config"
+require "geld/error/currency_error"
+require "geld/error/currency_not_found"
+require "geld/version"
+
+module Geld
+
+  # Singleton Config instance that stores the convertion rates
+  mattr_accessor :config
+
+  # Main class
+  class Money
+
+    attr_accessor :amount, :currency
+
+    # Uses bigdecimal for safer money operations
+    def initialize(amount, currency)
+      @amount = BigDecimal.new(amount.to_s)
+      @currency = currency
+    end
+
+    # Adds a converion rate in the configuration storage
+    def self.convertion_rates(currency, rates)
+      Geld.config ||= Config.new
+      Geld.config.add_currency(currency, rates)
+    end
+
+    # Apply the specific rate or raises error if not found
+    def convert_to(new_currency)
+      return dup if new_currency == self.currency
+
+      new_amount = Geld.config &&
+      Geld.config.get_rate(self.currency, new_currency) &&
+      Geld.config.get_rate(self.currency, new_currency).mult(self.amount, 2)
+
+      if new_amount.nil?
+        raise Error::CurrencyNotFound.new("The desired currency is not set.")
+      else
+       Money.new(new_amount, new_currency)
+      end
+    end
+
+    # Sums two moneys
+    def +(money)
+      operate(money, :add)
+    end
+
+    # Subtracts two moneys
+    def -(money)
+      operate(money, :sub)
+    end
+
+    # Multiplies two moneys
+    def *(money)
+      operate(money, :mult)
+    end
+
+    # Divides two moneys
+    def /(money)
+      operate(money, :div)
+    end
+
+    # Shows money formated
+    def inspect
+      "#{'%.2f' % amount} #{currency}"
+    end
+
+    # Tests equality
+    def ==(money)
+      compare(money, :==)
+    end
+
+    # Tests equality
+    def !=(money)
+      compare(money, :!=)
+    end
+
+    # Tests greater than
+    def >(money)
+      compare(money, :>)
+    end
+
+    # Tests less than
+    def <(money)
+      compare(money, :<)
+    end
+
+    private
+
+    # executes an arithmetic operation after convert to the same currency
+    def operate(money, operation)
+      new_amount = self.amount.send(operation, money.convert_to(self.currency).amount, 2)
+      Money.new(new_amount, self.currency)
+    end
+
+    # executes an comparisson after convert
+    def compare(money, operator)
+      self.amount.send(operator, money.convert_to(self.currency).amount)
+    end
+
+  end
+end

data/lib/geld/config.rb

@@ -0,0 +1,59 @@
+module Geld
+  class Config
+
+    # Set a new currency configuration.
+    # If the rates table is set more than once, the new one overrides the older
+    def add_currency(currency, rates)
+      validate_currency(currency)
+      validate_rates(rates)
+
+      @currencies ||= {}
+
+      # Converts rates to BigDecimal
+      bd_rates = rates.inject({}){|hash, (k,v)| hash[k] = BigDecimal.new(v.to_s); hash }
+      @currencies[currency] = bd_rates
+
+      bd_rates.each do |a_currency, a_rate|
+
+        # reverse operation will be the first element
+        current_rate = BigDecimal.new("1").div(a_rate, 2) # 1/rate 2 digits
+        @currencies[a_currency] = { currency => current_rate }
+
+        # now the others
+        (bd_rates.keys - [a_currency]).each do |other_currency|
+          @currencies[a_currency][other_currency] = @currencies[currency][other_currency].mult(current_rate, 2)
+        end
+
+      end
+      # returns the new calculations
+      @currencies
+    end
+
+    # returns the specific rate
+    def get_rate(from, to)
+      @currencies &&
+      @currencies[from] &&
+      @currencies[from][to]
+    end
+
+    private
+
+    # Validates currency entry
+    def validate_currency(currency)
+      unless currency.is_a?(String) && !currency.empty?
+        raise Error::CurrencyError.new("Invalid currency. Should be a non empty string")
+      end
+    end
+
+    # Validates rates entry
+    def validate_rates(rates)
+      unless rates.is_a?(Hash) &&
+        !rates.empty? &&
+        !rates.keys.any?{|key| !key.is_a?(String) } &&
+        !rates.values.any?{|value| !value.is_a?(Numeric) }
+        raise Error::CurrencyError.new("Invalid rates format. Should be a not empty hash of { String => Numeric }")
+      end
+    end
+
+  end
+end

data/lib/geld/error/currency_error.rb

@@ -0,0 +1,5 @@
+module Geld
+  module Error
+    class CurrencyError < ::RuntimeError; end
+  end
+end

data/lib/geld/error/currency_not_found.rb

@@ -0,0 +1,5 @@
+module Geld
+  module Error
+    class CurrencyNotFound < ::RuntimeError; end
+  end
+end

data/lib/geld/version.rb

@@ -0,0 +1,3 @@
+module Geld
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,144 @@
+--- !ruby/object:Gem::Specification
+name: geld
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Pedro Benevides
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !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: pry
+  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: pry-byebug
+  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'
+description: 
+email:
+- pedro.augusto.sb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- examples/usage.rb
+- geld.gemspec
+- lib/geld.rb
+- lib/geld/config.rb
+- lib/geld/error/currency_error.rb
+- lib/geld/error/currency_not_found.rb
+- lib/geld/version.rb
+homepage: https://github.com/pedroaugusto/geld
+licenses:
+- MIT
+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.11
+signing_key: 
+specification_version: 4
+summary: Gem to manage money currency operations.
+test_files: []