experimental-money 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 635267ff25b3ccfccd66e5f8394f63d398b9fe5d
+  data.tar.gz: 433e055f791c12cf60eb71d9be04cf51d75ced6c
+SHA512:
+  metadata.gz: 4ea02386d29e47978d7ccda94291dd5ba71a11916bf8ab161ef99bfbe212e950bce85dea295a3e53ef59341ff6d9c11a11f94a590c15c6d8e877d40072ca33cd
+  data.tar.gz: 326812d7421639b0eeb7f1f3e753fa73f99a2cd9f6679de31761366fb0387176b625812e8529ac8e6796d4e9efc191bf540a1af4dc54d822abb26ef91bbef0ff

data/.gems

@@ -0,0 +1 @@
+cutest -v 1.2.3

data/Challenge.md

@@ -0,0 +1,71 @@
+# Money test
+
+Crear una gema que pueda manejar las diferentes conversiones de monedas, hacer operaciones aritméticas y demas.
+Las caractersticas y el uso serán descritos a continuacion
+ 
+Configurar la moneda default y sus respectivas conversiones (here, EUR)
+```
+Money.configure do |config|
+  config.default_currency = "EUR"
+  config.conversions = {
+    'USD' => 1.11,
+    'Bitcoin' => 0.0047
+  }
+end
+```
+
+#### Instanciar objeto
+```
+fifty_eur = Money.new(50, 'EUR')
+```
+
+#### Get monto y moneda
+```
+fifty_eur.amount   # => 50
+fifty_eur.currency # => "EUR"
+fifty_eur.inspect  # => "50.00 EUR"
+```
+
+#### Convertir a otra moneda (Debe devolver una instancia, no un string)
+```
+fifty_eur.convert_to('USD') # => 55.50 USD
+```
+
+#### Realizar operaciones aritmeticas
+```
+twenty_dollars = Money.new(20, 'USD')
+```
+
+### Aritmeticas:
+```
+fifty_eur + twenty_dollars # => 68.02 EUR
+fifty_eur - twenty_dollars # => 31.98 EUR
+fifty_eur / 2              # => 25 EUR
+twenty_dollars * 3         # => 60 USD
+```
+
+#### Comparaciones (también en diferentes monedas):
+```
+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
+```
+
+La idea del test es que cuente con sus respectivos tests. Además se analizará calidad del codigo. 
+Objeto Money no debe conetener más caracteristicas que las mencionadas, please keep it simple.
+Tambien la gema debe estar subida a RubyGems y debe ser instalable desde
+```
+gem install your_gem
+```
+
+y debe ser capaz de ser cargada desde irb
+```
+irb
+require 'your_gem'
+Money.new
+```

data/README.md

@@ -0,0 +1,100 @@
+Experimental Money
+====
+
+
+Installation
+------------
+
+``` console
+$ gem install experimental-money
+```
+
+Usage
+-----
+
+Here's a simple example:
+
+``` ruby
+Money.configure do |config|
+  config.default_currency = "EUR"
+  config.conversions = {
+    'USD' => 1.11,
+    'Bitcoin' => 0.0047
+  }
+end
+
+fifty_eur = Money.new(50, 'EUR')
+fifty_eur.amount   # => 50
+fifty_eur.currency # => "EUR"
+fifty_eur.inspect  # => "50.00 EUR"
+
+# Currency exchange
+fifty_eur.convert_to('USD') # => 55.50 USD
+
+# Arithmetic
+
+twenty_dollars = Money.new(20, 'USD')
+fifty_eur + twenty_dollars # => 68.02 EUR
+fifty_eur - twenty_dollars # => 31.98 EUR
+fifty_eur / 2              # => 25 EUR
+twenty_dollars * 3         # => 60 USD
+
+# Comparations
+
+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
+
+```
+
+Caveats
+------------
+
+  - We are using BigDecimals. Another option could be using Integers
+    instead. As our desired API expects to initialize Money as `Money.new(float_amount, currency)` we already needed to convert the amount to BigDecimal in order to avoid `Float` precision errors. Integers should work way faster, though.
+  - Precision and rounding: When talking about money we need to know its
+    currency precision. The normal case is having two decimal positions
+    in order to represent `cents`. Other currencies use up to 8 decimal
+    places (to represent `Satoshis`).
+  
+    I arbitrarily set up Bitcoin precision (8) and set a default of (2)
+    for the remaining currencies. A pull request would be needed to add
+    weird currencies with different precision.
+  
+    Rounding:
+    When dividing money (or converting it to another currency -which
+    involves a division) we end up often with a number that has to be
+    rounded. There are many ways to round 0.006 to a two decimal places
+    number representing USD. I hardcoded the Bankers' rounding way, but
+    for some problems it may be suitable another method.
+  
+  - Last caveat: Arithmetic doesn't always represent Money operations as
+    we expect. If we need to divide 100USD among three people and we try
+    to do `Money.new(100, "USD")/3` to know how much each of them is
+    receiving we'll find a surprising result: It's not possible to
+    equally divide 100USD. With the current implementation this operation
+    would return `Money.new(33.33, "USD")`
+
+
+Contributing
+------------
+
+If you want to test this gem, you may want to use a gemset to isolate
+the requirements. We recommend the use of tools like [dep][dep] and
+[gs][gs], but you can use similar tools like [gst][gst] or [bs][bs].
+
+The required gems for testing and development are listed in the
+`.gems` file. If you are using [dep][dep], you can create a gemset
+and run `dep install`.
+
+After `cutest` is installed you can run the tests by doing `make`
+
+[dep]: http://cyx.github.io/dep/
+[gs]: http://soveran.github.io/gs/
+[gst]: https://github.com/tonchis/gst
+[bs]: https://github.com/educabilia/bs

data/experimental-money.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+  s.name              = "experimental-money"
+  s.version           = "0.0.1"
+  s.summary           = "Money arithmetic with BigDecimal"
+  s.description       = "Money arithmetic with BigDecimal"
+  s.authors           = ["CarlosIPe"]
+  s.email             = ["carlos2@compendium.com.ar"]
+  s.homepage          = "https://github.com/carlosipe/experimental-money"
+  s.license           = "MIT"
+
+  s.files = `git ls-files`.split("\n")
+
+  s.add_development_dependency "cutest", '~> 1'
+end

data/lib/experimental-money.rb

@@ -0,0 +1,88 @@
+require 'bigdecimal'
+
+class Money
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+
+  class Configuration
+    attr_writer :default_currency
+    def conversions=(hash)
+      @conversions = hash.map { |k, v| [k, BigDecimal(v.to_s)] }.to_h
+    end
+
+    def conversions
+      raise('No conversions configured') unless @conversions
+      @conversions.merge(default_currency => 1)
+    end
+
+    def default_currency
+      raise('Default currency is not configured') unless @default_currency
+      @default_currency 
+    end
+  end
+
+  include Comparable
+
+  attr_reader :currency, :amount
+  def initialize(amount, currency)
+    raise 'Invalid currency' unless conversions.member?(currency)
+    @currency = currency
+    @amount = BigDecimal(amount.to_s).round(currency_precision)
+  end
+
+  def currency_precision
+    {
+      'Bitcoin' => 8,
+    }.fetch(currency, 2)
+  end
+
+  def convert_to(new_currency)
+    new_amount = amount * conversions.fetch(new_currency) / conversions.fetch(currency)
+    self.class.new(new_amount, new_currency)
+  end
+
+  def <=>(other)
+    amount <=> other.convert_to(currency).amount
+  end
+
+  def inspect
+    "#{format('%.2f', amount)} #{currency}"
+  end
+
+  def conversions
+    self.class.configuration.conversions
+  end
+
+  def +(other)
+    return Money.new(amount + other.amount, currency) if currency == other.currency
+    total = convert_to(default_currency).amount + other.convert_to(default_currency).amount
+    self.class.new(total, default_currency)
+  end
+
+  def -(other)
+    return Money.new(amount - other.amount, currency) if currency == other.currency
+    total = convert_to(default_currency).amount - other.convert_to(default_currency).amount
+    self.class.new(total, default_currency)
+  end
+
+  def /(num)
+    Money.new(amount / num, currency)
+  end
+
+  def *(num)
+    Money.new(amount * num, currency)
+  end
+
+  def default_currency
+    self.class.configuration.default_currency
+  end
+end

data/makefile

@@ -0,0 +1,4 @@
+.PHONY: test
+
+test:
+	cutest ./test/*.rb

data/test/money.rb

@@ -0,0 +1,67 @@
+$LOAD_PATH.unshift(File.expand_path('../lib', File.dirname(__FILE__)))
+require 'money'
+
+Money.configure do |config|
+  config.default_currency = 'EUR'
+  config.conversions = {
+    'USD' => 1.11,
+    'Bitcoin' => 0.0047
+  }
+end
+
+def fifty_eur
+  Money.new(50, 'EUR')
+end
+
+test '.amount' do
+  assert_equal(fifty_eur.amount, 50)
+end
+
+test '.currency' do
+  assert_equal(fifty_eur.currency, 'EUR')
+end
+
+test '.inspect' do
+  assert_equal(fifty_eur.inspect, '50.00 EUR')
+end
+
+test '.convert_to' do
+  assert_equal(fifty_eur.convert_to('USD'), Money.new(55.50, 'USD'))
+end
+
+test 'sum different currencies' do
+  assert_equal(Money.new(50, 'EUR') + Money.new(20, 'USD'), Money.new(68.02, 'EUR'))
+end
+
+test 'subtract different currencies' do
+  assert_equal(Money.new(50, 'EUR') - Money.new(20, 'USD'), Money.new(31.98, 'EUR'))
+end
+
+test 'dividing money by scalar' do
+  assert_equal(Money.new(50, 'EUR') / 2, Money.new(25, 'EUR'))
+end
+
+test 'multiplying money by scalar' do
+  assert_equal(Money.new(20, 'USD') * 3, Money.new(60, 'USD'))
+end
+
+test 'Equal compare on same amount and currency' do
+  assert_equal(Money.new(20, 'USD'), Money.new(20, 'USD'))
+end
+
+test 'not equal on same currency and different amount' do
+  assert Money.new(20, 'USD') != Money.new(30, 'USD')
+end
+
+test 'equal on different currencies but equivalent amount' do
+  fifty_eur_in_usd = fifty_eur.convert_to('USD')
+  assert_equal(fifty_eur, fifty_eur_in_usd)
+end
+
+test 'greater than' do
+  assert Money.new(20, 'USD') > Money.new(5, 'USD')
+end
+
+test 'less than' do
+  assert Money.new(20, 'USD') < Money.new(50, 'EUR')
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: experimental-money
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- CarlosIPe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: cutest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+description: Money arithmetic with BigDecimal
+email:
+- carlos2@compendium.com.ar
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gems"
+- Challenge.md
+- README.md
+- experimental-money.gemspec
+- lib/experimental-money.rb
+- makefile
+- test/money.rb
+homepage: https://github.com/carlosipe/experimental-money
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Money arithmetic with BigDecimal
+test_files: []