mgd_money 0.0.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4c10d10675064445a34fb24ab6efeb6e30146b9
-  data.tar.gz: aa2d1e3d3cd53bd2c690b06656e2c8cb44c837fe
+  metadata.gz: 51b83b7f9ae3a67c02a8c54bb3ff6f30293311e6
+  data.tar.gz: f15781d2be55afaecd1470ad2d5d17f7e450b341
 SHA512:
-  metadata.gz: 18b054083240cbf6538d0d52f4ddf4ad6192646807ef6b15fbccd55334c5cace2bd64df1c2d0678c070e04722a444f6a1b5bf13e743d7ce64916f234363cd1a6
-  data.tar.gz: d961cc6071bf268f2ba391b28d6d9169fc440ea898e4004ad5059fac6f08e413524fc4a4e5a7f2b3e9d1fd6d59d9fabbf13963ea39dc32b3a52ba05369c97fb6
+  metadata.gz: f524c79a917aaaab75f88b16d34391d8927370919e793e912bb184b71484785e96d9208fa527ea716bac86d13dfaedfdc6dfd2d50f6ae48fcd87755a3f224016
+  data.tar.gz: f2d99a38c6af886d2fb8907f1313aa5c9d48e987678e945cee464d41cd6f79183dddc2980f47463818bcf1e242d4298fdf05cdc79a6c5d2883d6a3c980bd8eb4

data/.gitignore

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

data/.travis.yml

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

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in mgd_money.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Matt Davis
+
+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,59 @@
+# MgdMoney
+The MGDMoney gem provides a simple interface for converting between currencies 
+and performing operations in different currencies.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mgd_money'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mgd_money
+
+## Usage
+
+Define the conversion rates between currencies:
+
+    MGDMoney.conversion_rates("USD", { "EUR" => 0.75, "BTC" => 0.0001 })
+    
+You must specify at least one conversion rate or the gem will not know how to perform
+any operations. The gem only supports conversion operations on those specified currencies.
+
+After setting the rates, you can define new MGDMoney objects, which consist of an 
+`amount` and a `currency`:
+
+    twenty_dollars = MGDMoney.new(20, "USD")
+    ten_eur = MGDMoney.new(10, "EUR")
+    
+Convert between currencies:
+
+    twenty_dollars.convert_to("EUR")
+    => 15.00 EUR
+    
+
+Perform arithmetic operations (+, -, *, /) on different currencies
+
+    twenty_dollars + ten_eur
+    => 27.50 USD
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/davismattg/mgd_money.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

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

@@ -1,3 +1,5 @@
+require "mgd_money/version"
+
 class MGDMoney
   include Comparable                                                                                # for implementing custom comparing methods for MGDMoney objects
 
@@ -11,13 +13,17 @@ class MGDMoney
   attr_reader :amount, :currency                                                                    # each MGDMoney object will have these attributes
 
   # instantiate new MGDMoney objects.
-  # @param [Numeric] amount, the amount of the given currency
-  # @param [String] currency, the user-defined currency string
+  # @param [Numeric] amount the amount of the given currency
+  # @param [String] currency the user-defined currency string
   # @return [MGDMoney] the resulting MGDMoney object
-  # @example fifty_eur = MGDMoney.new(50, 'EUR') #=> 50 EUR
+  # @example fifty_eur = MGDMoney.new(50, 'EUR') => 50.00 EUR
   def initialize(amount, currency)
     unless amount.is_a?(Numeric)                                                                    # the amount entered wasn't empty, but we still have to make sure it's a number
-      raise UnknownObjectError, 'Amount must be a number'
+      raise InvalidDeclarationError, 'Amount must be a number'
+    end
+    
+    unless currency.is_a?(String)                                                                   # the currency entered wasn't a string
+      raise InvalidDeclarationError, 'Currency must be a string'
     end
 
     if currency.empty?
@@ -29,15 +35,33 @@ class MGDMoney
   end
 
   # configure the currency rates on the singleton class with respect to a base currency
-  # @param [String] base_currency, the currency used to determine conversion rates
-  # @param [Hash] conversion_factors, the conversion rates for supported currencies
+  # @param [String] base_currency the currency used to determine conversion rates
+  # @param [Hash] conversion_factors the conversion rates for supported currencies
   # @return [nil]
-  # @example
-  # MGDMoney.conversion_rates("EUR", {
-  #    "USD" => 1.11,
-  #    "Bitcoin" => 0.0047
-  # })
+  # @example MGDMoney.conversion_rates("EUR", {
+  #                 "USD" => 1.11,
+  #                 "Bitcoin" => 0.0047
+  #             })
   def self.conversion_rates(base_currency, conversion_factors)
+    unless base_currency.is_a?(String)                                                              # check the base currency is a string
+        raise InvalidConversionDeclarationError, 'Currency must be a string'
+    end
+    
+    unless conversion_factors.is_a?(Hash)                                                           # check the rates were specified as a hash
+        raise InvalidConversionDeclarationError, 'Conversion rates not specified'
+    end
+    
+    # check that the users supplied the currency as a string, and the conversion rate as a number
+    conversion_factors.each do |key, value|
+        unless key.is_a?(String) 
+            raise InvalidConversionDeclarationError, 'Currency must be a string'
+        end
+        
+        unless value.is_a?(Numeric)
+            raise InvalidConversionDeclarationError, 'Conversion factor must be a number'
+        end
+    end
+    
     self.base_currency = base_currency
     self.conversion_factors = conversion_factors
   end
@@ -45,7 +69,7 @@ class MGDMoney
   # convert to a different currency, returning a new MGDMoney object.
   # requires both source and destination currency to be defined by
   # MGDMoney.conversion_rates (otherwise rate not known)
-  # @param [String] currency, the desired currency after conversion
+  # @param [String] currency the desired currency after conversion
   # @return [MGDMoney] the new MGDMoney object representing the converted currency
   # @example fifty_eur.convert_to('USD') # => 55.50 USD
   def convert_to(currency)
@@ -99,7 +123,7 @@ class MGDMoney
 
   # convert the given number to its float representation.
   # this makes all the arithmetic possible
-  # @param [Numeric] amount, the amount to convert
+  # @param [Numeric] amount the amount to convert
   # @return [BigDecimal]
   # @example convert_to_float(twenty_dollars.amount)
   def convert_to_float(amount)
@@ -111,7 +135,7 @@ class MGDMoney
   end
 
   # perform arithmetic operations in two different currencies
-  # @param [MGDMoney] other_object, the MGDMoney object we're doing the operation with
+  # @param [MGDMoney] other_object the MGDMoney object we're doing the operation with
   # @return [MGDMoney]
   # @example fifty_eur + twenty_dollars = 68.02 EUR
   # @example fifty_eur / 2 = 25 EUR
@@ -151,7 +175,7 @@ class MGDMoney
 
   # compare different currencies (using Comparable)
   # in this case, we only care about comparing the amounts of each MGDMoney object
-  # @param [MGDMoney] other_object, the object to compare to
+  # @param [MGDMoney] other_object the object to compare to
   # @return [FixNum]
   # @example twenty_dollars == MGDMoney.new(20, 'USD') # => true
   # @example twenty_dollars == MGDMoney.new(30, 'USD') # => false
@@ -160,7 +184,7 @@ class MGDMoney
   def <=>(other_object)
     if other_object.is_a?(MGDMoney)
       other_object = other_object.convert_to(currency)
-      amount <=> other_object.amount
+      convert_to_float(amount) <=> convert_to_float(other_object.amount)                            # convert to float so we're only comparing up to 2 decimal places
     else
       raise UnknownObjectError, 'Unknown destination object type (must be type MGDMoney)'
     end
@@ -175,4 +199,10 @@ class MGDMoney
 
   class UnsupportedOperationError < StandardError
   end
-end
+  
+  class InvalidDeclarationError < StandardError
+  end
+  
+  class InvalidConversionDeclarationError < StandardError
+  end
+end

data/lib/mgd_money/version.rb

@@ -0,0 +1,3 @@
+module MgdMoney
+  VERSION = "1.0.0"
+end

data/mgd_money.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "mgd_money/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "mgd_money"
+  spec.version       = MgdMoney::VERSION
+  spec.authors       = ["Matt Davis"]
+  spec.email         = ["davismattg@gmail.com"]
+
+  spec.summary       = "MGDMoney"
+  spec.description   = "A simple gem to enable conversion between different currencies"
+  spec.homepage      = "http://www.mattgdavis.com"
+  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_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -1,23 +1,75 @@
 --- !ruby/object:Gem::Specification
 name: mgd_money
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Matt Davis
 autorequire: 
-bindir: bin
+bindir: exe
 cert_chain: []
-date: 2018-04-06 00:00:00.000000000 Z
-dependencies: []
-description: A simple gem to enable conversion and arithmetic operations between different
-  currencies
-email: davismattg@gmail.com
+date: 2018-04-18 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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: A simple gem to enable conversion between different currencies
+email:
+- davismattg@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
 - lib/mgd_money.rb
+- lib/mgd_money/version.rb
+- mgd_money.gemspec
 homepage: http://www.mattgdavis.com
 licenses:
 - MIT
@@ -28,17 +80,17 @@ 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.0.14.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: MGDMoney