elegant_money 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2bb9d1bca3a2ac64c4e6031d1eb1776d97e42585
+  data.tar.gz: 87f9dd0bc6bc19be0b21d6edda872aba0fea1935
+SHA512:
+  metadata.gz: 9f5272cc301d57d39c367539ad03a45738a7aa52fc435c69ae97751e02cf045664ea916cd27deed6d6fb4ce7d2406c6ecae6f33adb5d1e3928402c7a4f3a7877
+  data.tar.gz: 13282a7fbbca037f37e409de1017303cfcbdaa6e65edefac5446f4672daad9a51073e07aacaa5167b27946c87ccfef7d97f66eddab2624ad60fc58ad22e50b60

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at ncls.ayala@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Nico Ayala (nicoayala)
+
+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,58 @@
+# ElegantMoney
+
+Elegant and simple implementation to handle money in different currencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'elegant_money'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install elegant_money
+
+## Usage
+
+```ruby
+# Configure:
+ElegantMoney.configure do |config|
+  config.default_currency = "EUR"
+  config.conversions = {
+    "USD" => 1.22,
+    # ...
+  }
+end
+
+# Instantiate and manipulate:
+twenty_eur = ElegantMoney.new(20, "EUR")
+twenty_eur * 2  # => 40.00 EUR
+twenty_eur / 2  # => 10.00 EUR
+twenty_eur + 10 # => 30.00 EUR
+twenty_eur + ElegantMoney.new(30, "EUR") # => 50.00 EUR
+
+# Convert:
+twenty_eur.convert_to("USD") # => 22.20 USD
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nicoayala/elegant_money. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the ElegantMoney project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nicoayala/elegant_money/blob/master/CODE_OF_CONDUCT.md).

data/elegant_money.gemspec

@@ -0,0 +1,22 @@
+Gem::Specification.new do |spec|
+  spec.name          = "elegant_money"
+  spec.version       = "0.1.0"
+  spec.authors       = ["Nico"]
+  spec.email         = ["ncls.ayala@gmail.com"]
+
+  spec.summary       = %q{Elegant and simple implementation to handle money in different currencies}
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/nicoayala/elegant_money"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files lib spec *.md`.split("\n")
+  spec.files        += %w[LICENSE.txt elegant_money.gemspec]
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.1.2"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "pry", "~> 0.11"
+end

data/lib/elegant_money.rb

@@ -0,0 +1,99 @@
+class ElegantMoney
+  include Comparable
+
+  attr_reader :amount, :currency
+
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  def initialize(amount, currency = 'EUR')
+    @amount = BigDecimal.new(amount.to_s)
+    @currency = currency
+  end
+
+  def inspect
+    "%.2f %s" % [amount, currency]
+  end
+  alias :to_s :inspect
+
+  def <=>(other)
+    other_amount = amount_with_normalized_currency(other)
+    amount.round(2) <=> other_amount.round(2)
+  end
+
+  def +(other)
+    operate_with_normalized_currency(other) do |other_amount|
+      amount + other_amount
+    end
+  end
+
+  def -(other)
+    operate_with_normalized_currency(other) do |other_amount|
+      amount - other_amount
+    end
+  end
+
+  def *(other)
+    operate_with_normalized_currency(other) do |other_amount|
+      amount * other_amount
+    end
+  end
+
+  def /(other)
+    operate_with_normalized_currency(other) do |other_amount|
+      amount / other_amount
+    end
+  end
+
+  def convert_to(new_currency)
+    return build(amount, currency) if currency == new_currency
+
+    conversion = conversion_for(new_currency)
+    new_amount = if currency == default_currency
+      amount * conversion
+    else
+      default_amount = amount / conversion_for(currency)
+      default_amount * conversion
+    end
+
+    build(new_amount, new_currency)
+  end
+
+  def infinite?
+    amount.infinite?
+  end
+
+  private
+
+  def operate_with_normalized_currency(other)
+    result = yield amount_with_normalized_currency(other)
+    build(result, currency)
+  end
+
+  def amount_with_normalized_currency(other)
+    return other.convert_to(currency).amount if other.is_a?(ElegantMoney)
+    return BigDecimal.new(other.to_s) if other.is_a?(Float)
+    other
+  end
+
+  def build(amount, currency)
+    ElegantMoney.new(amount, currency)
+  end
+
+  def conversion_for(key)
+    return 1 if key == default_currency
+    ElegantMoney.configuration.conversions.fetch(key)
+  end
+
+  def default_currency
+    ElegantMoney.configuration.default_currency
+  end
+end
+
+require "bigdecimal"
+require "elegant_money/configuration"

data/lib/elegant_money/configuration.rb

@@ -0,0 +1,4 @@
+# TODO: Should be immutable
+class ElegantMoney::Configuration
+  attr_accessor :default_currency, :conversions
+end

data/spec/elegant_money_spec.rb

@@ -0,0 +1,112 @@
+ElegantMoney.configure do |config|
+  config.default_currency = "EUR"
+  config.conversions = {
+    "USD" => 1.11,
+    "BTC" => 0.0047
+  }
+end
+
+RSpec.describe ElegantMoney do
+  describe "#inspect" do
+    it "returns a string representation" do
+      expect(eur(9.98).inspect).to eql("9.98 EUR")
+    end
+
+    it "returns a string representation when amount is not a number" do
+      expect(eur("asd").inspect).to eql("0.00 EUR")
+    end
+  end
+
+  describe "#+" do
+    it "returns the sum of two amounts" do
+      ten = eur(10)
+      expect(ten + ten).to eq eur(20)
+    end
+
+    it "returns the sum of two amounts when they have different currencies" do
+      expect(eur(50) + usd(20)).to eq eur(68.02)
+    end
+  end
+
+  describe "#-" do
+    it "returns the difference between two amounts" do
+      ten = eur(10)
+      expect(ten - ten).to eq eur(0)
+    end
+
+    it "returns the sum of two amounts when they have different currencies" do
+      expect(eur(50) - usd(20)).to eq eur(31.98)
+    end
+  end
+
+  describe "#*" do
+    it "returns the result of multiplying of two amounts" do
+      ten = eur(10)
+      expect(ten * ten).to eq eur(100)
+    end
+
+    it "returns the result of multiplying an amount and a primitive value" do
+      expect(eur(10) * 2).to eq eur(20)
+      expect(eur(10) * 2.0).to eq eur(20)
+    end
+  end
+
+  describe "#/" do
+    it "returns the result of the division of two amounts" do
+      expect(eur(10) / eur(2)).to eq eur(5)
+    end
+
+    it "returns infinity when the divider is zero" do
+      expect(eur(10) / eur(0)).to be_infinite
+      expect(eur(10) / 0).to be_infinite
+    end
+
+    it "returns the result of the division between an amount and a primitive value" do
+      expect(eur(10) / 2).to eq eur(5)
+      expect(eur(10) / 2.0).to eq eur(5)
+    end
+  end
+
+  describe "#convert_to" do
+    it "returns the amount in the new currency" do
+      expect(eur(10).convert_to("USD")).to eq usd(11.10)
+    end
+
+    it "returns the amount of the new currency when it is different than the default one" do
+      money = usd(10).convert_to("BTC")
+      expect(money).to eq btc(0.04)
+      expect(money.convert_to("USD")).to eq usd(10)
+    end
+
+    it "returns the same amount when converting to the same currency" do
+      expect(eur(10).convert_to("EUR")).to eq eur(10)
+    end
+  end
+
+  describe "comparision" do
+    it "returns true when amounts are equal" do
+      expect(eur(10) == eur(10)).to eq true
+    end
+
+    it "returns true when amounts are equal and currencies are different" do
+      expect(eur(10) == usd(11.10)).to eq true
+    end
+
+    it "returns true when amount is greater than the second one" do
+      expect(eur(10) > usd(10)).to eq true
+      expect(usd(10) < eur(10)).to eq true
+    end
+  end
+
+  def eur(amount)
+    described_class.new(amount, "EUR")
+  end
+
+  def usd(amount)
+    described_class.new(amount, "USD")
+  end
+
+  def btc(amount)
+    described_class.new(amount, "BTC")
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,18 @@
+require "bundler/setup"
+require "elegant_money"
+require "pry"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status"
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.order = :random
+  Kernel.srand config.seed
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: elegant_money
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nico
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-01-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.11'
+description: Elegant and simple implementation to handle money in different currencies
+email:
+- ncls.ayala@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- elegant_money.gemspec
+- lib/elegant_money.rb
+- lib/elegant_money/configuration.rb
+- spec/elegant_money_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/nicoayala/elegant_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: 2.1.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Elegant and simple implementation to handle money in different currencies
+test_files: []