latinum 0.2.5 → 0.3.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2541b0bcc344983c49e0a03ea5538b30134a6e66
+  data.tar.gz: 6e6ea43f0549ea6866fbb4fbdc8d9b79e7c1499e
+SHA512:
+  metadata.gz: 55f37f35c7eb1dc772ee10649ff1d6281016ba58d0ffaff8e1cb4c8107273d67b7194503cdbd0bca2ed3a68e302dc356a37cf0c45e3604db5b2f228bdc3a92a2
+  data.tar.gz: 194e82ccb7da1a0a063809f1ab5393185419cad05d86148c408658d553f47bd622b2de9a0480de2b9503282f55d841b51805cb82feff771ff1eee442b7465467

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - "1.9"
+  - "2.0"
+  - "2.1"

data/Gemfile

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

data/README.md

@@ -1,14 +1,24 @@
-Latinum
-=======
+# Latinum
 
-* Author: Samuel G. D. Williams (<http://www.oriontransfer.co.nz>)
-* Copyright (C) 2012 Samuel G. D. Williams.
-* Released under the MIT license.
+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.
 
-Latinum is a framework for resource and currency calculations.
+[![Build Status](https://travis-ci.org/ioquatix/latinum.svg?branch=master)](https://travis-ci.org/ioquatix/latinum)
 
-Basic Usage
------------
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'latinum'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install latinum
+
+## Usage
 
 Latinum has several core concepts:
 
@@ -18,7 +28,7 @@ Latinum has several core concepts:
 - A `Bank` can exchange currencies explicitly with a given set of exchange rates.
 - A `Collection` is responsible for adding currencies together and is completely deterministic.
 
-### Resources and Collections ###
+### Resources and Collections
 
 To create a new resource, use a string for accuracy:
 
@@ -47,7 +57,7 @@ To add multiple currencies together, use a collection:
 	> currencies.collect {|currency| collection[currency]}
 	=> [10.0 NZD, 20.0 AUD]
 
-### Banks and Exchange Rates ###
+### Banks and Exchange Rates
 
 The bank is responsible for formatting and exchange rates:
 
@@ -83,10 +93,31 @@ Currency codes take priority over symbols if specified:
 	> bank.parse("€5 NZD")
 	=> 5.0 NZD
 
-License
--------
+### Conversion To and From Integers
+
+For storage in traditional databases, you may prefer to use integers. Based on the precision of the currency, you can store integer representations:
+
+	> resource = Latinum::Resource.new("1.12345678", "BTC")
+	
+	> 112345678 == bank.to_integral(resource)
+	true
+	
+	> resource == bank.from_integral(112345678, "BTC")
+	true
+
+As BitCoin has 8 decimal places, it requires an integer representation with at least 10^8.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+## License
 
-Copyright (c) 2010, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+Copyright, 2011, 2012, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
 
 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/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/latinum.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'latinum/version'
+
+Gem::Specification.new do |spec|
+	spec.name          = "latinum"
+	spec.version       = Latinum::VERSION
+	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.license       = "MIT"
+
+	spec.files         = `git ls-files`.split($/)
+	spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+	spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+	spec.require_paths = ["lib"]
+
+	spec.add_development_dependency "bundler", "~> 1.3"
+	spec.add_development_dependency "rake"
+end

data/lib/latinum.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -25,6 +25,6 @@ require 'latinum/collection'
 require 'bigdecimal'
 require 'bigdecimal/util'
 
-if RUBY_VERSION < "1.9"
+if RUBY_VERSION < "1.9.3"
 	require 'latinum/extensions/bigdecimal-1.8'
 end

data/lib/latinum/bank.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -83,8 +83,8 @@ module Latinum
 		end
 		
 		def exchange(resource, for_name)
-			rate = @exchange[resource.name][for_name]
-			raise ArgumentError.new("Invalid rate specified #{rate}") if rate == nil
+			rate = @exchange[resource.name][for_name] rescue nil
+			raise ArgumentError.new("Rate #{rate} unavailable") if rate == nil
 			
 			config = self[for_name]
 			
@@ -103,7 +103,7 @@ module Latinum
 				if symbol
 					Resource.new(string.gsub(/[^\.0-9]/, ''), symbol.last.to_s)
 				else
-					raise ArgumentError.new("Could not parse #{string}")
+					raise ArgumentError.new("Could not parse #{string}, could not determine currency!")
 				end
 			end
 		end
@@ -114,5 +114,18 @@ module Latinum
 			
 			formatter.format(resource.amount, *args)
 		end
+		
+		# Convert the resource to an integral representation based on the currency's precision
+		def to_integral(resource)
+			formatter = @formatters[resource.name]
+			
+			formatter.to_integral(resource.amount)
+		end
+		
+		def from_integral(amount, resource_name)
+			formatter = @formatters[resource_name]
+			
+			Resource.new(formatter.from_integral(amount), resource_name)
+		end
 	end
 end

data/lib/latinum/collection.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # 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/lib/latinum/currencies/global.rb

@@ -1,6 +1,6 @@
-# encoding: utf-8
+# encoding: UTF-8
 #
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # 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/lib/latinum/formatters.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -32,6 +32,14 @@ module Latinum
 			def format(amount)
 				"#{amount.to_s('F')} #{@name}"
 			end
+			
+			def to_integral(amount)
+				amount.to_i
+			end
+			
+			def from_integral(amount)
+				amount.to_d
+			end
 		end
 
 		class DecimalCurrencyFormatter
@@ -52,7 +60,7 @@ module Latinum
 				sign = amount.sign < 0 ? '-' : ''
 
 				# Decimal places, e.g. the '.00' in '$10.00'
-				frac = frac[0...2].ljust(@places, @zero)
+				frac = frac[0...@places].ljust(@places, @zero)
 
 				# Grouping, e.g. the ',' in '$10,000.00'
 				remainder = fix.size % 3
@@ -68,7 +76,14 @@ module Latinum
 					"#{whole}#{name}"
 				end
 			end
+			
+			def to_integral(amount)
+				(amount * 10**@places).to_i
+			end
+			
+			def from_integral(amount)
+				(amount.to_d / 10**@places)
+			end
 		end
-		
 	end
 end

data/lib/latinum/resource.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -62,7 +62,7 @@ module Latinum
 			self.class.new(exchanged_amount, name)
 		end
 		
-		def to_s(options = {})
+		def to_s
 			@amount.to_s('F') + ' ' + @name.to_s
 		end
 		

data/lib/latinum/version.rb

@@ -1,4 +1,4 @@
-# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
 # 
 # Permission is hereby granted, free of charge, to any person obtaining a copy
 # of this software and associated documentation files (the "Software"), to deal
@@ -19,11 +19,5 @@
 # THE SOFTWARE.
 
 module Latinum
-	module VERSION
-		MAJOR = 0
-		MINOR = 2
-		TINY  = 5
-
-		STRING = [MAJOR, MINOR, TINY].join('.')
-	end
+	VERSION = "0.3.0"
 end

data/test/test_bank.rb

@@ -1,5 +1,26 @@
+# encoding: UTF-8
+#
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
 
-require 'helper'
+require 'test/unit'
 
 require 'latinum'
 require 'latinum/currencies/global'
@@ -24,7 +45,7 @@ class BankTest < Test::Unit::TestCase
 		assert_equal "-$100.00 NZD", @bank.format(resource)
 		
 		resource = Latinum::Resource.new("1.12345678", "BTC")
-		assert_equal "B⃦1.12000000 BTC", @bank.format(resource)
+		assert_equal "B⃦1.12345678 BTC", @bank.format(resource)
 	end
 	
 	def test_exchange

data/test/test_collection.rb

@@ -1,5 +1,24 @@
+# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
 
-require 'helper'
+require 'test/unit'
 
 require 'latinum'
 require 'latinum/currencies/global'

data/test/test_integrals.rb

@@ -0,0 +1,46 @@
+# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# 
+# 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.
+
+require 'test/unit'
+
+require 'latinum'
+require 'latinum/currencies/global'
+
+class IntegralTest < Test::Unit::TestCase
+	def setup
+		@bank = Latinum::Bank.new(Latinum::Currencies::Global)
+	end
+	
+	def test_nzd_integral
+		resource = Latinum::Resource.new("10", "NZD")
+		
+		assert_equal 1000, @bank.to_integral(resource)
+		
+		assert_equal resource, @bank.from_integral(1000, "NZD")
+	end
+	
+	def test_btc_integral
+		resource = Latinum::Resource.new("1.12345678", "BTC")
+		
+		assert_equal 112345678, @bank.to_integral(resource)
+		
+		assert_equal resource, @bank.from_integral(112345678, "BTC")
+	end
+end

metadata

@@ -1,22 +1,56 @@
 --- !ruby/object:Gem::Specification
 name: latinum
 version: !ruby/object:Gem::Version
-  version: 0.2.5
-  prerelease: 
+  version: 0.3.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-20 00:00:00.000000000 Z
-dependencies: []
+date: 2014-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
-email: samuel.williams@oriontransfer.co.nz
+email:
+- samuel.williams@oriontransfer.co.nz
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- latinum.gemspec
+- lib/latinum.rb
 - lib/latinum/bank.rb
 - lib/latinum/collection.rb
 - lib/latinum/currencies/global.rb
@@ -24,35 +58,36 @@ files:
 - lib/latinum/formatters.rb
 - lib/latinum/resource.rb
 - lib/latinum/version.rb
-- lib/latinum.rb
-- test/helper.rb
 - test/test_bank.rb
 - test/test_collection.rb
-- README.md
-homepage: http://www.oriontransfer.co.nz/gems/latinum
-licenses: []
+- test/test_integrals.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Latinum is a simple gem for managing resource computations, including money
   and minerals.
-test_files: []
+test_files:
+- test/test_bank.rb
+- test/test_collection.rb
+- test/test_integrals.rb
 has_rdoc: 

data/test/helper.rb

@@ -1,4 +0,0 @@
-
-$LOAD_PATH.unshift File.expand_path("../../lib/", __FILE__)
-
-require 'test/unit'