latinum 0.7.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d6dd56393739d90d4d893817b978c8a14c3dc9c4
-  data.tar.gz: be685ba7796486a231c2483b417ed878c6100251
+  metadata.gz: 16215481d04c41e76fa7bda13e0977acbf0a3862
+  data.tar.gz: a192fa7dd018680858f4770e44c318cbf6b9be1c
 SHA512:
-  metadata.gz: d5e2b2826c9726d94e73f6d2f97773a19493281725d175c45c8415d827d7a776bf8fac76c60e5926aa818c1f2c3ceb03c6c8064eb5aaaa79580850da98bdf1c5
-  data.tar.gz: 0e093fc3b2a171f38b91781450b4eb9cc70c991ec34d4a09308cc5c4d70b9deecac11e2874be6ab6bcad8b6ee7e3dd2f07d21a75a499e04b9e4f85895ae89aa1
+  metadata.gz: b8d753a9318134a4347ab131f549b1bad9aa5970c805b0458b6357f56002b47241679c9d8194f3a41223a2e0be41112742f293162c970ae40cf76b4249ab1e10
+  data.tar.gz: 6c1f2c3137edbb552730b052077aa462a39e8749ef50c6d7f033c7acc536d1f20132b4d09511993f2aac035cf50ea2911a154f4e6e66220c6fbcefbcfe5ff3b6

data/.rspec

@@ -0,0 +1,4 @@
+--color
+--format documentation
+--backtrace
+--warnings

data/.simplecov

@@ -0,0 +1,9 @@
+
+SimpleCov.start do
+	add_filter "/spec/"
+end
+
+if ENV['TRAVIS']
+	require 'coveralls'
+	Coveralls.wear!
+end

data/.travis.yml

@@ -1,5 +1,12 @@
 language: ruby
+sudo: false
 rvm:
-  - "1.9"
-  - "2.0"
-  - "2.1"
+  - 2.1.8
+  - 2.2.4
+  - 2.3.0
+  - ruby-head
+  - rbx-2
+env: COVERAGE=true
+matrix:
+  allow_failures:
+    - rvm: "rbx-2"

data/Gemfile

@@ -1,4 +1,7 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in build.gemspec
 gemspec
+
+group :test do
+	gem 'coveralls', platforms: [:mri]
+end

data/README.md

@@ -3,7 +3,20 @@
 Latinum is a library for resource and currency calculations. It provides immutable `Resource` objects for dealing with quantities of named resources with an arbitrary number of decimal places, and `Bank` objects for converting resources and formatting them for output. Latinum doesn't include any global state by default and thus is ideal for integration with other frameworks/libraries.
 
 [![Build Status](https://travis-ci.org/ioquatix/latinum.svg?branch=master)](https://travis-ci.org/ioquatix/latinum)
-[![Code Climate](https://codeclimate.com/github/ioquatix/latinum.png)](https://codeclimate.com/github/ioquatix/latinum)
+[![Code Climate](https://codeclimate.com/github/ioquatix/latinum.svg)](https://codeclimate.com/github/ioquatix/latinum)
+[![Coverage Status](https://coveralls.io/repos/ioquatix/latinum/badge.svg)](https://coveralls.io/r/ioquatix/latinum)
+
+## Motivation
+
+I was originally planning on using the [Money gem](https://github.com/RubyMoney/money), but it's [dependency on global state](https://github.com/RubyMoney/money/blob/39b617cca8f02c885cc8246e0aab3e9dc5f90e15/lib/money/currency.rb#L19-L21) makes it hard to use if you want to deal with money as an immutable value type.
+
+Additionally, I wanted to support BitCoin, Japanese Yen, etc. The money gem was heavily biased towards decimal currency. It had (~2012) [fields like `dollars` and `cents`](https://github.com/RubyMoney/money/issues/197) which don't really make sense and don't really align with the real world. These days they have fixed parts of the API, but it's a bit of a mess now, supporting both decimal and non-decimal values.
+
+Another problem I had at the time was the [concept of zero](https://github.com/RubyMoney/money/issues/195). It should be possible to have an additive (e.g. 0) and multiplicative identity (e.g. 1) do the right thing. In fact, in Latinum, you can multiply `Latinum::Resource` instances by a scalar and get a useful result (e.g. for computing discounts).
+
+Finally, because of the above problem, it was not obvious at the time how to sum up a collection of money instances correctly. In fact, this is still a problem and a separate gem, based on the `Latinum::Collection` concept, [was made](https://github.com/lulalala/money-collection). However, this all fits together in a rather haphazard way.
+
+Latinum addresses all these issues. It has an immutable value type `Latinum::Resource` which has a robust definition: A value (e.g. 5.0025) and a resource name (USD). The semantics of resources are well defined without the need for "Currency" state like the symbol, how many decimal places, etc. So, it suits well for serialization into a database, and for formatting to the user, there is `Latinum::Bank` which gives you the choice of how you decide to format things or exchange them, whether you want to round something off, etc.
 
 ## Installation
 

data/Rakefile

@@ -1,9 +1,14 @@
 require "bundler/gem_tasks"
-require "rake/testtask"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-	t.libs << 'test'
+RSpec::Core::RakeTask.new(:spec) do |task|
+	if ENV['COVERAGE']
+		begin
+			require('simplecov/version')
+			task.rspec_opts = %w{--require simplecov}
+		rescue LoadError
+		end
+	end
 end
 
-desc "Run tests"
-task :default => :test
+task :default => :spec

data/latinum.gemspec

@@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
 	spec.authors       = ["Samuel Williams"]
 	spec.email         = ["samuel.williams@oriontransfer.co.nz"]
 	spec.summary       = %q{Latinum is a simple gem for managing resource computations, including money and minerals.}
-	spec.homepage      = ""
+	spec.homepage      = "https://github.com/ioquatix/latinum"
 	spec.license       = "MIT"
 
 	spec.files         = `git ls-files`.split($/)
@@ -18,6 +18,6 @@ Gem::Specification.new do |spec|
 	spec.require_paths = ["lib"]
 
 	spec.add_development_dependency "bundler", "~> 1.3"
-	spec.add_development_dependency "rspec", "~> 3.1.0"
+	spec.add_development_dependency "rspec", "~> 3.4.0"
 	spec.add_development_dependency "rake"
 end

data/lib/latinum/formatters.rb

@@ -25,8 +25,8 @@ module Latinum
 		}
 		
 		class PlainFormatter
-			def initialize(options = {})
-				@name = options[:name]
+			def initialize(name:)
+				@name = name
 			end
 			
 			def format(amount)

data/lib/latinum/version.rb

@@ -19,5 +19,5 @@
 # THE SOFTWARE.
 
 module Latinum
-	VERSION = "0.7.1"
+	VERSION = "1.0.0"
 end

data/spec/latinum/bank_spec.rb

@@ -1,5 +1,3 @@
-# encoding: UTF-8
-#
 # Copyright, 2015, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
@@ -26,8 +24,7 @@ require 'latinum/currencies/global'
 module Latinum::BankSpec
 	describe Latinum::Bank do
 		before(:all) do
-			@bank = Latinum::Bank.new
-			@bank.import(Latinum::Currencies::Global)
+			@bank = Latinum::Bank.new(Latinum::Currencies::Global)
 			
 			@bank << Latinum::ExchangeRate.new("NZD", "AUD", "0.5")
 		end
@@ -80,5 +77,9 @@ module Latinum::BankSpec
 			
 			expect(@bank.parse("5 NZD")).to be == Latinum::Resource.new("5", "NZD")
 		end
+		
+		it "should fail to parse unknown resource" do
+			expect{@bank.parse("B5")}.to raise_error(ArgumentError)
+		end
 	end
 end

data/spec/latinum/collection_spec.rb

@@ -24,23 +24,21 @@ require 'latinum/currencies/global'
 require 'set'
 
 module Latinum::CollectionSpec
-	describe Latinum::Bank do
-		before(:all) do
-			@bank = Latinum::Bank.new
-			@bank.import(Latinum::Currencies::Global)
+	describe Latinum::Collection do
+		it "can set an initial value" do
+			subject["NZD"] = BigDecimal.new("20")
+			
+			expect(subject["NZD"]).to be == Latinum::Resource.load("20 NZD")
 		end
 		
 		it "should sum up currencies correctly" do
 			resource = Latinum::Resource.new("10", "NZD")
 			
-			currencies = Set.new
-			collection = Latinum::Collection.new(currencies)
-			
-			collection << resource
-			expect(collection["NZD"]).to be == resource
+			subject << resource
+			expect(subject["NZD"]).to be == resource
 			
-			collection << resource
-			expect(collection["NZD"]).to be == (resource * 2)
+			subject << resource
+			expect(subject["NZD"]).to be == (resource * 2)
 		end
 		
 		it "should sum up multiple currencies correctly" do
@@ -50,14 +48,38 @@ module Latinum::CollectionSpec
 				Latinum::Resource.new("10", "USD"),
 				Latinum::Resource.new("10", "NZD"),
 				Latinum::Resource.new("10", "AUD"),
-				Latinum::Resource.new("10", "USD")
+				Latinum::Resource.new("10", "USD"),
+			]
+			
+			subject = Latinum::Collection.new
+			subject << resources
+			
+			expect(subject["NZD"]).to be == (resources[0] * 2)
+			expect(subject.names).to be == Set.new(["NZD", "AUD", "USD"])
+		end
+		
+		it "can add two collections together" do
+			other_resources = [
+				Latinum::Resource.new("10", "NZD"),
+				Latinum::Resource.new("10", "AUD"),
+				Latinum::Resource.new("10", "USD"),
+			]
+			
+			other_collection = Latinum::Collection.new
+			other_collection << other_resources
+			
+			resources = [
+				Latinum::Resource.new("10", "NZD"),
+				Latinum::Resource.new("10", "AUD"),
+				Latinum::Resource.new("10", "USD"),
 			]
 			
-			collection = Latinum::Collection.new
-			collection << resources
+			subject << resources
+			subject << other_collection
 			
-			expect(collection["NZD"]).to be == (resources[0] * 2)
-			expect(collection.names).to be == Set.new(["NZD", "AUD", "USD"])
+			expect(subject["NZD"]).to be == Latinum::Resource.load("20 NZD")
+			expect(subject["AUD"]).to be == Latinum::Resource.load("20 AUD")
+			expect(subject["USD"]).to be == Latinum::Resource.load("20 USD")
 		end
 	end
 end

data/spec/latinum/formatters_spec.rb

@@ -23,6 +23,22 @@ require 'latinum/currencies/global'
 require 'latinum/formatters'
 
 module Latinum::FormattersSpec
+	describe Latinum::Formatters::PlainFormatter.new(name: "NZD") do
+		let(:amount) {BigDecimal.new(10)}
+		
+		it "can convert to integral" do
+			expect(subject.to_integral(amount)).to be == 10
+		end
+		
+		it "can convert from integral" do
+			expect(subject.from_integral(10)).to be == amount
+		end
+		
+		it "can do basic formatting" do
+			expect(subject.format(amount)).to be == "10.0 NZD"
+		end
+	end
+	
 	describe Latinum::Formatters::DecimalCurrencyFormatter do
 		before(:all) do
 			@bank = Latinum::Bank.new
@@ -55,4 +71,17 @@ module Latinum::FormattersSpec
 			expect(@bank.format(resource, symbol: "!!")).to be == "!!10.00 NZD"
 		end
 	end
+	
+	describe Latinum::Formatters::DecimalCurrencyFormatter do
+		before(:all) do
+			@bank = Latinum::Bank.new
+			@bank.import(Latinum::Currencies::Global)
+		end
+		
+		let(:resource) {Latinum::Resource.load("10 JPY")}
+		
+		it "should format without separator or fractional part" do
+			expect(@bank.format(resource)).to be == "¥10 JPY"
+		end
+	end
 end

data/spec/latinum/resource_spec.rb

@@ -76,9 +76,57 @@ module Latinum::ResourceSpec
 		it "should compute quotient" do
 			original_price = Latinum::Resource.load("10 NZD")
 			
-			quotient = original_price / 2.0
-			
 			expect(original_price / 2.0).to be == Latinum::Resource.load("5 NZD")
 		end
+		
+		it "should add two resources of the same symbol" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("5 NZD")
+			c = Latinum::Resource.load("15 NZD")
+			
+			expect(a+b).to be == c
+		end
+		
+		it "should fail two resources of different symbol" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("5 USD")
+			
+			expect{a+b}.to raise_error(Latinum::DifferentResourceNameError)
+		end
+		
+		it "should be able to negate a value" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("-10 NZD")
+			
+			expect(-a).to be == b
+		end
+		
+		it "can be used as a hash key" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("0 NZD")
+			
+			hash = {a => true}
+			
+			expect(hash).to be_include a
+			expect(hash).to_not be_include b
+		end
+		
+		it "can be zero" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("0 NZD")
+			
+			expect(a).to_not be_zero
+			expect(b).to be_zero
+		end
+		
+		it "can be eql?" do
+			a = Latinum::Resource.load("10 NZD")
+			b = Latinum::Resource.load("0 NZD")
+			c = Latinum::Resource.load("0 NZD")
+			
+			expect(a).to be_eql a
+			expect(a).to_not be_eql b
+			expect(b).to be_eql c
+		end
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: latinum
 version: !ruby/object:Gem::Version
-  version: 0.7.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-13 00:00:00.000000000 Z
+date: 2016-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,14 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.1.0
+        version: 3.4.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -59,6 +59,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rspec"
+- ".simplecov"
 - ".travis.yml"
 - Gemfile
 - README.md
@@ -77,7 +79,7 @@ files:
 - spec/latinum/formatters_spec.rb
 - spec/latinum/integrals_spec.rb
 - spec/latinum/resource_spec.rb
-homepage: ''
+homepage: https://github.com/ioquatix/latinum
 licenses:
 - MIT
 metadata: {}
@@ -97,7 +99,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: Latinum is a simple gem for managing resource computations, including money