currency_shushugah 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 025a361a07ad5469e9f3b19f285c1882d4d2b510
-  data.tar.gz: b0a579adf6581e8926192437148bf965d0e400a3
+  metadata.gz: 66ba837fb8fa313e4803fd7250c7e86e9355800d
+  data.tar.gz: 75382370b6dd872c6dfe041010ab8af15336370c
 SHA512:
-  metadata.gz: c3c2f0ecb2deb87d8a6abc4910b6d20bb04c38a45a0d0cd6e9d1b19db6ee22b527b8f01b34574460f4dc7c4d6008cb2c7230e30a13c850338e867b3a00b64be2
-  data.tar.gz: 76e6665f5ee08b7f089aae84707d4f5079fa7cb73ecd2595d435386df310d500457f4ec31c0b77bd68c751b3d682622a50438b96f16564653b622e59d0948a10
+  metadata.gz: d617e7586263f2b16989368140477e460b3780feae896b3a81f9afe642792275bad57937e7b5bb036cc7c92b1d2c400c48bf09e3ad9a978893e78618e62d9973
+  data.tar.gz: c93217f6ab36348e1c7aba00c9fdd4ff075da140e672ea49381db77906d16e37fa4fbf737e0d879d97df81082cde2deb87365484248501f3b735e718c9f06fc7

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 yonatan miller
+Copyright (c) 2017 Yonatan Miller
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,3 @@
-# CurrencyShushugah
-
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/currency_shushugah`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
-
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -16,7 +10,7 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it yourself via:
 
     $ gem install currency_shushugah
 
@@ -24,63 +18,62 @@ Or install it yourself as:
 
 ```
 # Configure the currency rates with respect to a base currency (here EUR):
- 
+
 Money.conversion_rates('EUR', {
   'USD'     => 1.11,
   'Bitcoin' => 0.0047,
   'CAD' => 1.39
 })
- 
-# Instantiate money objects:
- 
+
+# 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.currency # => 'EUR'
+fifty_eur.inspect  # => '50.00 EUR'
+
+# Convert to a different currency (returns new Money instance)
+
 fifty_eur.convert_to('USD') # => 55.50 USD
- 
+fifty_eur.convert_to('USD').currency # => '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):
- 
+3 * twenty_dollars         # => 60 USD
+
+# Comparisons:
+
 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.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake` 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/[USERNAME]/currency_shushugah. 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.
-
+Bug reports, feedback and pull requests are welcome on GitHub at https://github.com/shushugah/currency_shushugah. 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](http://opensource.org/licenses/MIT).
-

data/bin/console

@@ -1,14 +1,6 @@
 #!/usr/bin/env ruby
 
-require "bundler/setup"
-require "currency_shushugah"
-
-# 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"
+require 'bundler/setup'
+require 'currency_shushugah'
+require 'irb'
 IRB.start

data/bin/setup

@@ -4,5 +4,3 @@ IFS=$'\n\t'
 set -vx
 
 bundle install
-
-# Do any other automated setup that you need to do here

data/lib/currency_shushugah/errors.rb

@@ -0,0 +1,4 @@
+module CurrencyShushugah
+  class UnsupportedCurrency < StandardError; end
+  class DivisionByZero < StandardError; end
+end

data/lib/currency_shushugah/version.rb

@@ -1,3 +1,3 @@
-class CurrencyShushugah
-  VERSION = '2.0.0'.freeze
+module CurrencyShushugah
+  VERSION = '2.0.1'.freeze
 end

data/lib/currency_shushugah.rb

@@ -1,74 +1,77 @@
 require 'currency_shushugah/version'
-
-# Understands currency and quantity
-class Money
-  include Comparable
-
-  attr_reader :quantity, :currency
-  protected :currency, :quantity
-
-  def self.conversion_rates(base_currency, hash_rates)
-    @rates = hash_rates.merge(base_currency => 1)
-  end
-
-  def initialize(quantity, currency)
-    raise StandardError.new('Not supported currency') unless rates[currency]
-    @quantity = quantity
-    @currency = currency
-  end
-
-  def <=>(other)
-    return unless other.class == self.class
-    quantity <=> other.convert_to(currency).quantity
-  end
-
-  def inspect
-    "#{'%0.2f' % quantity} #{currency}"
-  end
-
-  def convert_to(other_currency)
-    raise StandardError.new('InvalidCurrency') unless rates[other_currency]
-    return self if currency == other_currency
-    new_quantity = @quantity * rates[other_currency] / rates[currency]
-    new_money(new_quantity, other_currency)
-  end
-
-  def +(other)
-    new_money(quantity + other.convert_to(currency).quantity)
-  end
-
-  def -(other)
-    self + -other
-  end
-
-  def -@
-    new_money(-quantity)
-  end
-
-  def coerce(other)
-    return self, other
-  end
-
-  def *(scalar)
-    new_money(quantity * scalar)
-  end
-
-  def /(scalar)
-    raise StandardError.new 'InvalidDivision' if scalar.zero?
-    self * (1.0 / scalar)
-  end
-
-  def new_money(quantity, currency = @currency)
-    Money.send :new, quantity.round(2), currency
-  end
-
-  def self.rates
-    Money.instance_variable_get(:@rates)
-  end
-
-  private
-
-  def rates
-    self.class.rates
+require 'currency_shushugah/errors'
+
+module CurrencyShushugah
+  # Understands currency and quantity
+  class Money
+    include Comparable
+
+    attr_reader :quantity, :currency
+    protected :currency, :quantity
+
+    def self.conversion_rates(base_currency, hash_rates)
+      @rates = hash_rates.merge(base_currency => 1)
+    end
+
+    def initialize(quantity, currency)
+      raise UnsupportedCurrency unless rates[currency]
+      @quantity = quantity
+      @currency = currency
+    end
+
+    def <=>(other)
+      return unless other.class == self.class
+      quantity <=> other.convert_to(currency).quantity
+    end
+
+    def inspect
+      "#{'%0.2f' % quantity} #{currency}"
+    end
+
+    def convert_to(other_currency)
+      raise UnsupportedCurrency unless rates[other_currency]
+      return self if currency == other_currency
+      new_quantity = @quantity * rates[other_currency] / rates[currency]
+      new_money(new_quantity, other_currency)
+    end
+
+    def +(other)
+      new_money(quantity + other.convert_to(currency).quantity)
+    end
+
+    def -(other)
+      self + -other
+    end
+
+    def -@
+      new_money(-quantity)
+    end
+
+    def coerce(other)
+      [self, other]
+    end
+
+    def *(other)
+      new_money(quantity * other)
+    end
+
+    def /(other)
+      raise DivisionByZero if other.zero?
+      self * (1.0 / other)
+    end
+
+    def new_money(quantity, currency = @currency)
+      Money.send :new, quantity.round(2), currency
+    end
+
+    def self.rates
+      Money.instance_variable_get(:@rates)
+    end
+
+    private
+
+    def rates
+      self.class.rates
+    end
   end
 end

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification
 name: currency_shushugah
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Yonatan Miller
 autorequire: 
-bindir: exe
+bindir: bin
 cert_chain: []
 date: 2017-07-29 00:00:00.000000000 Z
 dependencies:
@@ -59,22 +59,13 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
-- ".rspec"
-- ".travis.yml"
-- CODE_OF_CONDUCT.md
-- Gemfile
 - LICENSE.txt
 - README.md
-- Rakefile
 - bin/console
 - bin/setup
-- currency_shushugah.gemspec
 - lib/currency_shushugah.rb
+- lib/currency_shushugah/errors.rb
 - lib/currency_shushugah/version.rb
-- tasks/Rakefile
-- tasks/debug.rake
-- tasks/rspec.rake
 homepage: https://github.com/shushugah/currency_shushugah
 licenses:
 - MIT

data/.gitignore

@@ -1,9 +0,0 @@
-/.bundle/
-/.yardoc
-/Gemfile.lock
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/

data/.rspec

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

data/.travis.yml

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

data/CODE_OF_CONDUCT.md

@@ -1,49 +0,0 @@
-# Contributor Code of Conduct
-
-As contributors and maintainers of this project, and in the interest of
-fostering an open and welcoming community, we pledge to respect all people who
-contribute through reporting issues, posting feature requests, updating
-documentation, submitting pull requests or patches, and other activities.
-
-We are committed to making participation in this project a harassment-free
-experience for everyone, regardless of level of experience, gender, gender
-identity and expression, sexual orientation, disability, personal appearance,
-body size, race, ethnicity, age, religion, or nationality.
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery
-* Personal attacks
-* Trolling or insulting/derogatory comments
-* Public or private harassment
-* Publishing other's private information, such as physical or electronic
-  addresses, without explicit permission
-* Other unethical or unprofessional conduct
-
-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.
-
-By adopting this Code of Conduct, project maintainers commit themselves to
-fairly and consistently applying these principles to every aspect of managing
-this project. Project maintainers who do not follow or enforce the Code of
-Conduct may be permanently removed from the project team.
-
-This code of conduct applies both within project spaces and in public spaces
-when an individual is representing the project or its community.
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting a project maintainer at brombacher1@gmail.com. All
-complaints will be reviewed and investigated and will result in a response that
-is deemed necessary and appropriate to the circumstances. Maintainers are
-obligated to maintain confidentiality with regard to the reporter of an
-incident.
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage],
-version 1.3.0, available at
-[http://contributor-covenant.org/version/1/3/0/][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

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

data/Rakefile

@@ -1,5 +0,0 @@
-require 'bundler/gem_tasks'
-
-Dir.glob('tasks/**/*.rake').each(&method(:import))
-
-task default: :spec

data/currency_shushugah.gemspec

@@ -1,23 +0,0 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'currency_shushugah/version'
-
-Gem::Specification.new do |spec|
-  spec.name          = "currency_shushugah"
-  spec.version       = CurrencyShushugah::VERSION
-  spec.authors       = ["Yonatan Miller"]
-  spec.email         = ["brombacher1@gmail.com"]
-
-  spec.summary       = "Converts currencies and accepts conversion rates"
-  spec.homepage      = "https://github.com/shushugah/currency_shushugah"
-  spec.license       = "MIT"
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  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"
-end

data/tasks/Rakefile

@@ -1,3 +0,0 @@
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)

data/tasks/debug.rake

@@ -1,4 +0,0 @@
-desc 'Open an irb session preloaded with this library'
-task :console do
-  sh 'irb -rubygems -I lib -r currency_shushugah.rb'
-end

data/tasks/rspec.rake

@@ -1,3 +0,0 @@
-require 'rspec/core/rake_task'
-
-RSpec::Core::RakeTask.new(:spec)