latinum 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 597ddf3035b21a9c9ca7cc3ab036331db974903c
-  data.tar.gz: 2171d764b3c41e0ca975854397d8644a10d5e6d6
+  metadata.gz: c6565ff801afd8f7700bd6723059fae97fec8718
+  data.tar.gz: 3c2d9ca868c490c9ab0e35bc520ca4a6c434b620
 SHA512:
-  metadata.gz: bd414c78914a6cd7144e4e30e90657e6cb1523662c0c9ec510e363127a47b2e18ced5c29190685260b07f0db7b69b2183caecdf41729e43cfbfb430bb02aed1f
-  data.tar.gz: ba272f4680a3c8420649f364901887d47380776b864416bfdb92d3caeb86a01f502653e408ce693cd788fe6fa70a0c8c68fe418ef49c924f39f9a805d58b1353
+  metadata.gz: 0c6a80ff70d4a87dfe53404389fe86159aeb0209a5f370d26c5f201fabe114805b09cbe33fc1646426361695106c24a3a5c5f5328fa304e86ea50e8b396a3540
+  data.tar.gz: 4c2aed581bc0637765e498d4207aa879e833905c67cedfbd1d1c6748f14f39a8aad1a89ab7fd2306ea158882766c4c0fbfed5ca451305841e1e787a14121dd85

data/README.md

@@ -118,7 +118,7 @@ As BitCoin has 8 decimal places, it requires an integer representation with at l
 
 ## License
 
-Copyright, 2011, 2012, 2014, by [Samuel G. D. Williams](http://www.codeotaku.com/samuel-williams).
+Copyright, 2015, 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/lib/latinum.rb

@@ -1,4 +1,4 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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/bank.rb

@@ -1,4 +1,4 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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
@@ -33,7 +33,9 @@ module Latinum
 		attr :factor
 	end
 	
+	# A bank defines exchange rates and formatting rules for resources. It is a centralised location for resource related state.
 	class Bank
+		# Imports all given currencies.
 		def initialize(*imports)
 			@rates = []
 			@exchange = {}
@@ -50,6 +52,7 @@ module Latinum
 			end
 		end
 		
+		# Import a list of resource templates, e.g. currencies.
 		def import(resources)
 			resources.each do |name, config|
 				name = (config[:name] || name).to_s
@@ -67,6 +70,7 @@ module Latinum
 			end
 		end
 		
+		# Look up a currency by name.
 		def [] name
 			@currencies[name]
 		end
@@ -75,6 +79,7 @@ module Latinum
 		attr :symbols
 		attr :currencies
 		
+		# Add an exchange rate to the bank.
 		def << rate
 			@rates << rate
 			
@@ -82,6 +87,7 @@ module Latinum
 			@exchange[rate.input][rate.output] = rate
 		end
 		
+		# Exchange one resource for another using internally specified rates.
 		def exchange(resource, for_name)
 			rate = @exchange[resource.name][for_name] rescue nil
 			raise ArgumentError.new("Rate #{rate} unavailable") if rate == nil
@@ -91,14 +97,15 @@ module Latinum
 			resource.exchange(rate.factor, for_name, config[:precision])
 		end
 		
-		def parse(string)
+		# Parse a string according to the loaded currencies.
+		def parse(string, default_name: nil)
 			parts = string.strip.split(/\s+/, 2)
 			
 			if parts.size == 2
 				Resource.new(parts[0].gsub(/[^\.0-9]/, ''), parts[1])
 			else
 				# Lookup the named symbol, e.g. '$', and get the highest priority name:
-				symbol = @symbols.fetch(string.gsub(/[\-\.,0-9]/, ''), []).last
+				symbol = @symbols.fetch(string.gsub(/[\-\.,0-9]/, ''), []).last || default_name
 				
 				if symbol
 					Resource.new(string.gsub(/[^\.0-9]/, ''), symbol.last.to_s)
@@ -108,6 +115,7 @@ module Latinum
 			end
 		end
 		
+		# Format a resource as a string according to the loaded currencies.
 		def format(resource, *args)
 			formatter = @formatters[resource.name]
 			raise ArgumentError.new("No formatter found for #{resource.name}") unless formatter
@@ -115,13 +123,14 @@ module Latinum
 			formatter.format(resource.amount, *args)
 		end
 		
-		# Convert the resource to an integral representation based on the currency's precision
+		# 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
 		
+		# Convert the resource from an integral representation based on the currency's precision.
 		def from_integral(amount, resource_name)
 			formatter = @formatters[resource_name]
 			

data/lib/latinum/collection.rb

@@ -1,4 +1,4 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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
@@ -22,19 +22,26 @@ require 'bigdecimal'
 require 'set'
 
 module Latinum
+	# Aggregates a set of resources, typically used for summing values.
 	class Collection
+		# Initialize the collection with a given set of resource names.
 		def initialize(names = Set.new)
 			@names = names
 			@resources = Hash.new {|hash, key| @names << key; BigDecimal.new("0")}
 		end
 		
+		# All resource names which have been added to the collection, e.g. `['NZD', 'USD']`.
 		attr :names
+		
+		# A map of `name` => `total` for all added resources. Totals are stored as BigDecimal instances.
 		attr :resources
 		
+		# Add a resource into the totals.
 		def add resource
 			@resources[resource.name] += resource.amount
 		end
 		
+		# Add a resource, an array of resources, or another collection into this one.
 		def << object
 			case object
 			when Resource
@@ -48,21 +55,12 @@ module Latinum
 			return self
 		end
 		
-		def others
-			self.dup
-			
-			case others
-			when Array
-				others.each { |resource| self << resource }
-			when Collection
-				
-			end
-		end
-		
+		# Get a `Resource` for the given name:
 		def [] key
 			Resource.new(@resources[key], key)
 		end
 		
+		# Set a `BigDecimal` value for the given name:
 		def []= key, amount
 			@resources[key] = amount
 		end

data/lib/latinum/currencies/global.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 #
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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/resource.rb

@@ -1,4 +1,4 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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
@@ -74,8 +74,18 @@ module Latinum
 			end
 		end
 		
-		def self.parse(string)
-			self.new *string.split(/\s+/, 2)
+		class << self
+			def parse(string, default_name: nil)
+				amount, name = string.split(/\s+/, 2)
+				
+				self.new(amount, name || default_name)
+			end
+			
+			alias load parse
+			
+			def dump(resource)
+				resource.to_s
+			end
 		end
 		
 		def zero?

data/lib/latinum/version.rb

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

data/spec/latinum/bank_spec.rb

@@ -1,6 +1,6 @@
 # encoding: UTF-8
 #
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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/spec/latinum/collection_spec.rb

@@ -1,4 +1,4 @@
-# Copyright, 2012, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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/spec/latinum/integrals_spec.rb

@@ -1,4 +1,4 @@
-# Copyright, 2014, by Samuel G. D. Williams. <http://www.codeotaku.com>
+# Copyright, 2015, 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/spec/latinum/resource_spec.rb

@@ -0,0 +1,39 @@
+# Copyright, 2015, 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 'latinum/resource'
+
+module Latinum::ResourceSpec
+	describe Latinum::Resource do
+		before(:all) do
+			@bank = Latinum::Bank.new
+			@bank.import(Latinum::Currencies::Global)
+		end
+		
+		it "should load and dump resources" do
+			resource = Latinum::Resource.load("10 NZD")
+			string_representation = Latinum::Resource.dump(resource)
+			
+			loaded_resource = Latinum::Resource.load(string_representation)
+			
+			expect(loaded_resource).to be == loaded_resource
+		end
+	end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: latinum
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Samuel Williams
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-12 00:00:00.000000000 Z
+date: 2015-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -74,6 +74,7 @@ files:
 - spec/latinum/bank_spec.rb
 - spec/latinum/collection_spec.rb
 - spec/latinum/integrals_spec.rb
+- spec/latinum/resource_spec.rb
 homepage: ''
 licenses:
 - MIT
@@ -103,3 +104,4 @@ test_files:
 - spec/latinum/bank_spec.rb
 - spec/latinum/collection_spec.rb
 - spec/latinum/integrals_spec.rb
+- spec/latinum/resource_spec.rb