shopify-money 0.10.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e9f1cbeeb932d4f9f9d1abb4ef49ae366e9f5467
+  data.tar.gz: a257d7dd55acb578b89690f153a8a613bc334089
+SHA512:
+  metadata.gz: ed81f64a2a63282fa961088381634c8d2d414ea30120f2e39049afb6cb6e5f85a36069d550f6ba956636481b9ccbde8eae8428347e5b105ecfd16b22146b2b5e
+  data.tar.gz: 7edd2b3d5dd0ec6d0f695a0959fd55f25e4c1bfefdd7c96171825b77085a353892d954d6edb00a49a7a224b57e019982f981554b3c8896b1ab02c443e4682115

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/.gitignore

@@ -0,0 +1,51 @@
+# rcov generated
+coverage
+
+# rdoc generated
+rdoc
+
+# yard generated
+doc
+.yardoc
+
+# bundler
+.bundle
+
+# jeweler generated
+pkg
+
+# Have editor/IDE/OS specific files you need to ignore? Consider using a global gitignore: 
+#
+# * Create a file at ~/.gitignore
+# * Include files you want ignored
+# * Run: git config --global core.excludesfile ~/.gitignore
+#
+# After doing this, these files will be ignored in all your git projects,
+# saving you from having to 'pollute' every project you touch with them
+#
+# Not sure what to needs to be ignored for particular editors/OSes? Here's some ideas to get you started. (Remember, remove the leading # of the line)
+#
+# For MacOS:
+#
+#.DS_Store
+
+# For TextMate
+#*.tmproj
+#tmtags
+
+# For emacs:
+#*~
+#\#*
+#.\#*
+
+# For vim:
+#*.swp
+
+# For redcar:
+#.redcar
+
+# For rubinius:
+#*.rbc
+Gemfile.lock
+
+.rspec_status

data/.rspec

@@ -0,0 +1 @@
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+gem "pry-byebug", require: false
+gem 'codecov', require: false
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Shopify
+
+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,156 @@
+# money
+
+[![Build Status](https://circleci.com/gh/Shopify/money.png?circle-token=88060f61185838446bb65723d96658bdd74ebb3c)](https://circleci.com/gh/Shopify/money) [![codecov](https://codecov.io/gh/Shopify/money/branch/master/graph/badge.svg)](https://codecov.io/gh/Shopify/money)
+
+
+money_column expects a decimal 8,3 database field.
+
+### Features
+
+- Keeps value in decimal
+- Provides a `Money` class which encapsulates all information about an certain
+  amount of money, such as its value and its currency.
+- Provides a `Money::Currency` class which encapsulates all information about
+  a monetary unit.
+- Does NOT provides APIs for exchanging money from one currency to another.
+- wont lose pennies during division!
+- Money::NullCurrency for no currency support
+
+## Installation
+
+    gem 'shopify-money', require: 'money'
+
+## Usage
+
+``` ruby
+require 'money'
+
+# 10.00 USD
+money = Money.new(10.00, "USD")
+money.subunits     #=> 1000
+money.currency  #=> Currency.new("USD")
+
+# Comparisons
+Money.new(1000, "USD") == Money.new(1000, "USD")   #=> true
+Money.new(1000, "USD") == Money.new(100, "USD")    #=> false
+Money.new(1000, "USD") == Money.new(1000, "EUR")   #=> false
+Money.new(1000, "USD") != Money.new(1000, "EUR")   #=> true
+
+# Arithmetic
+Money.new(1000, "USD") + Money.new(500, "USD") == Money.new(1500, "USD")
+Money.new(1000, "USD") - Money.new(200, "USD") == Money.new(800, "USD")
+Money.new(1000, "USD") / 5                     == Money.new(200, "USD")
+Money.new(1000, "USD") * 5                     == Money.new(5000, "USD")
+
+# Unit to subunit conversions
+Money.from_subunits(500, "USD") == Money.new(5, "USD")  # 5 USD
+Money.from_subunits(5, "JPY") == Money.new(5, "JPY")    # 5 JPY
+Money.from_subunits(5000, "TND") == Money.new(5, "TND") # 5 TND
+```
+
+## Currency
+
+Currencies are consistently represented as instances of `Money::Currency`.
+The most part of `Money` APIs allows you to supply either a `String` or a
+`Money::Currency`.
+
+``` ruby
+Money.new(1000, "USD") == Money.new(1000, Money::Currency.new("USD"))
+Money.new(1000, "EUR").currency == Money::Currency.new("EUR")
+```
+
+A `Money::Currency` instance holds all the information about the currency,
+including the currency symbol, name and much more.
+
+``` ruby
+currency = Money.new(1000, "USD").currency
+currency.iso_code #=> "USD"
+currency.name     #=> "United States Dollar"
+currency.to_s     #=> 'USD'
+currency.symbol   #=> '$'
+currency.disambiguate_symbol #=> 'US$'
+```
+
+### Default Currency
+
+By default `Money` defaults to Money::NullCurrency as its currency. This is a
+global variable that can be changed using:
+
+``` ruby
+Money.default_currency = Money::Currency.new("USD")
+```
+
+In web apps you might want to set the default currency on a per request basis.
+In Rails you can do this with an around action, for example:
+
+```ruby
+class ApplicationController < ActionController::Base
+  around_action :set_currency
+
+  private
+
+  def set_currency
+    Money.with_currency(current_shop.currency) { yield }
+  end
+end
+```
+
+### Currency Minor Units
+
+The exponent of a money value is the number of digits after the decimal
+separator (which separates the major unit from the minor unit).
+
+``` ruby
+Money::Currency.new("USD").minor_units  # => 2
+Money::Currency.new("JPY").minor_units  # => 0
+Money::Currency.new("MGA").minor_units  # => 1
+```
+
+## Money column
+
+Since money internally uses BigDecimal it's logical to use a `decimal` column
+(or `money` for PostgreSQL) for your database. The `money_column` method can
+generate methods for use with ActiveRecord:
+
+```ruby
+create_table :orders do |t|
+  t.decimal :sub_total, precision: 20, scale: 3
+  t.decimal :tax, precision: 20, scale: 3
+  t.string :currency, limit: 3
+end
+
+class Order < ApplicationRecord
+  money_column :sub_total, :tax
+end
+```
+
+### Options
+
+| option | type |  description |
+| --- | --- |  --- |
+| currency_column | method | column from which to read/write the currency  |
+| currency | string | hardcoded currency value  |
+| currency_read_only | boolean |  when true, `currency_column` won't write the currency back into the db. Must be set to true if `currency_column` is an attr_reader or delegate. Default: false |
+| coerce_null | boolean | when true, a nil value will be returned as Money.zero. Default: false |
+
+You can use multiple `money_column` calls to achieve the desired effects with
+currency on the model or attribute level.
+
+There are no validations generated. You can add these for the specified money
+and currency attributes as you normally would for any other.
+
+## Contributing to money
+
+- Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+- Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+- Fork the project
+- Start a feature/bugfix branch
+- Commit and push until you are happy with your contribution
+- Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+- Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Copyright
+
+Copyright (c) 2011 Shopify. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+begin
+  require 'bundler/gem_tasks'
+rescue LoadError
+  nil
+end
+
+require 'rubygems'
+require 'bundler'
+require 'rdoc/task'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rcov = true
+end
+
+task :default => :spec
+
+require 'rake/task'
+RDoc::Task.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "money #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/bin/console

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

@@ -0,0 +1,13 @@
+machine:
+  ruby:
+    version: 2.3.3
+
+database:
+  override:
+    - echo "Skipping database setup"
+
+test:
+  override:
+    - bundle exec rake
+  post:
+    - bash <(curl -s https://codecov.io/bash)

data/config/currency_historic.json

@@ -0,0 +1,157 @@
+{
+  "cyp": {
+    "priority": 100,
+    "iso_code": "CYP",
+    "name": "Cypriot pound",
+    "symbol": "£",
+    "alternate_symbols": [],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "£",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "196",
+    "smallest_denomination": 1
+  },
+  "eek": {
+    "priority": 100,
+    "iso_code": "EEK",
+    "name": "Estonian Kroon",
+    "symbol": "KR",
+    "alternate_symbols": [],
+    "subunit": "Sent",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "233",
+    "smallest_denomination": 5
+  },
+  "ghc": {
+    "priority": 100,
+    "iso_code": "GHS",
+    "name": "Ghanaian Cedi",
+    "symbol": "₵",
+    "disambiguate_symbol": "GH₵",
+    "alternate_symbols": ["GH₵"],
+    "subunit": "Pesewa",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "₵",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "288",
+    "smallest_denomination": 1
+  },
+  "mtl": {
+    "priority": 100,
+    "iso_code": "MTL",
+    "name": "Maltese Lira",
+    "symbol": "₤",
+    "alternate_symbols": ["Lm"],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "£",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "470",
+    "smallest_denomination": 1
+  },
+  "tmm": {
+    "priority": 100,
+    "iso_code": "TMM",
+    "name": "Turkmenistani Manat",
+    "symbol": "m",
+    "alternate_symbols": [],
+    "subunit": "Tennesi",
+    "subunit_to_unit": 100,
+    "symbol_first": false,
+    "html_entity": "",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "795",
+    "smallest_denomination": 1
+  },
+  "VEB": {
+    "priority": 100,
+    "iso_code": "VEB",
+    "name": "Venezuelan Bolívar",
+    "symbol": "Bs.",
+    "alternate_symbols": [],
+    "subunit": "Céntimo",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "",
+    "decimal_mark": ",",
+    "thousands_separator": ".",
+    "iso_numeric": "862",
+    "smallest_denomination": 1
+  },
+  "zwd": {
+    "priority": 100,
+    "iso_code": "ZWD",
+    "name": "Zimbabwean Dollar",
+    "symbol": "$",
+    "disambiguate_symbol": "ZWD",
+    "alternate_symbols": ["Z$"],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "$",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "716",
+    "smallest_denomination": 100
+  },
+  "zwl": {
+    "priority": 100,
+    "iso_code": "ZWL",
+    "name": "Zimbabwean Dollar",
+    "symbol": "$",
+    "disambiguate_symbol": "ZWL",
+    "alternate_symbols": ["Z$"],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "$",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "932",
+    "smallest_denomination": 100
+  },
+  "zwn": {
+    "priority": 100,
+    "iso_code": "ZWN",
+    "name": "Zimbabwean Dollar",
+    "symbol": "$",
+    "disambiguate_symbol": "ZWN",
+    "alternate_symbols": ["Z$"],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "$",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "942",
+    "smallest_denomination": 100
+  },
+  "zwr": {
+    "priority": 100,
+    "iso_code": "ZWR",
+    "name": "Zimbabwean Dollar",
+    "symbol": "$",
+    "disambiguate_symbol": "ZWR",
+    "alternate_symbols": ["Z$"],
+    "subunit": "Cent",
+    "subunit_to_unit": 100,
+    "symbol_first": true,
+    "html_entity": "$",
+    "decimal_mark": ".",
+    "thousands_separator": ",",
+    "iso_numeric": "935",
+    "smallest_denomination": 100
+  }
+}