latinum 0.2.0

data/README.md

@@ -0,0 +1,31 @@
+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 framework for resource and currency calculations. *It is currently a work in progress and not designed to be taken seriously at this time*.
+
+License
+-------
+
+Copyright (c) 2010, 2011 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+
+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/lib/latinum.rb

@@ -0,0 +1,22 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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'
+require 'latinum/collection'

data/lib/latinum/bank.rb

@@ -0,0 +1,112 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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
+	class ExchangeRate
+		def initialize(input, output, factor)
+			@input = input
+			@output = output
+			@factor = BigDecimal(factor)
+		end
+		
+		attr :input
+		attr :output
+		attr :factor
+	end
+	
+	class Bank
+		def initialize(*imports)
+			@rates = []
+			@exchange = {}
+			
+			@formatters = {}
+			
+			# Symbols and their associated priorities
+			@symbols = {}
+			
+			imports.each do |resources|
+				import(resources)
+			end
+		end
+		
+		def import(resources)
+			resources.each do |name, config|
+				name = (config[:name] || name).to_s
+				
+				# Create a formatter:
+				self[name] = config[:formatter].new(config)
+				
+				if config[:symbol]
+					symbols = (@symbols[config[:symbol]] ||= [])
+					symbols << [config.fetch(:priority, -1), name.to_s]
+					symbols.sort!.uniq!
+				end
+			end
+		end
+		
+		attr :rates
+		attr :symbols
+		attr :formatters
+		
+		def << object
+			@rates << rate
+			
+			@exchange[rate.input] ||= {}
+			@exchange[rate.input][rate.output] = rate
+		end
+		
+		def []= name, formatter
+			@formatters[name] = formatter
+		end
+		
+		def exchange(resource, for_name)
+			rate = @exchange[resource.name][for_name]
+			raise ArgumentError.new("Invalid rate specified #{rate}") if rate == nil
+			
+			Resource.new(resource.amount * rate.factor, for_name)
+		end
+		
+		def parse(string)
+			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
+				
+				if symbol
+					Resource.new(string.gsub(/[^\.0-9]/, ''), symbol.last.to_s)
+				else
+					raise ArgumentError.new("Could not parse #{string}")
+				end
+			end
+		end
+		
+		def format(resource, *args)
+			formatter = @formatters[resource.name]
+			raise ArgumentError.new("No formatter found for #{resource.name}") unless formatter
+			
+			formatter.format(resource.amount, *args)
+		end
+	end
+end

data/lib/latinum/collection.rb

@@ -0,0 +1,46 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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 'bigdecimal'
+require 'set'
+
+module Latinum
+	class Collection
+		def initialize(names = Set.new)
+			@names = names
+			@resources = Hash.new {|hash, key| @names << key; BigDecimal.new(0)}
+		end
+		
+		attr :names
+		attr :resources
+		
+		def << resource
+			@resources[resource.name] += resource.amount
+		end
+		
+		def [] key
+			Resource.new(@resources[key], key)
+		end
+		
+		def []= key, amount
+			@resources[key] = amount
+		end
+	end
+end

data/lib/latinum/currencies/global.rb

@@ -0,0 +1,66 @@
+# encoding: utf-8
+#
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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/formatters'
+
+module Latinum
+	module Currencies
+		Global = {}
+		
+		Global[:NZD] = {
+			:symbol => '$',
+			:name => 'NZD',
+			:description => 'New Zealand Dollar',
+			:formatter => Formatters::DecimalCurrencyFormatter,
+		}
+		
+		Global[:GBP] = {
+			:symbol => '£',
+			:name => 'GBP',
+			:description => 'Pound Sterling',
+			:formatter => Formatters::DecimalCurrencyFormatter,
+		}
+		
+		Global[:AUD] = {
+			:symbol => '$',
+			:name => 'AUD',
+			:description => 'Australian Dollar',
+			:formatter => Formatters::DecimalCurrencyFormatter,
+		}
+		
+		Global[:USD] = {
+			:symbol => '$',
+			:name => 'USD',
+			:description => 'United States Dollar',
+			:formatter => Formatters::DecimalCurrencyFormatter,
+		}
+		
+		Global[:EUR] = {
+			:symbol => '€',
+			:name => 'EUR',
+			:description => 'Euro',
+			:formatter => Formatters::DecimalCurrencyFormatter,
+			#:delimeter => '.',
+			#:separator => ','
+		}
+	end
+end

data/lib/latinum/formatters.rb

@@ -0,0 +1,74 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+module Latinum
+	module Formatters
+		DEFAULT_OPTIONS = {
+			:format => :full
+		}
+		
+		class PlainFormatter
+			def initialize(options = {})
+				@name = options[:name]
+			end
+			
+			def format(amount)
+				"#{amount.to_s('F')} #{@name}"
+			end
+		end
+
+		class DecimalCurrencyFormatter
+			def initialize(options = {})
+				@symbol = options[:symbol] || '$'
+				@separator = options[:separator] || '.'
+				@delimeter = options[:delimter] || ','
+				@places = options[:places] || 2
+				@zero = options[:zero] || '0'
+
+				@name = options[:name]
+			end
+
+			def format(amount, options = DEFAULT_OPTIONS)
+				fix, frac = amount.to_s('F').split(/\./, 2)
+
+				# The sign of the number
+				sign = amount.sign < 0 ? '-' : ''
+
+				# Decimal places, e.g. the '.00' in '$10.00'
+				frac = frac[0...2].ljust(@places, @zero)
+
+				# Grouping, e.g. the ',' in '$10,000.00'
+				remainder = fix.size % 3
+				groups = fix[remainder..-1].scan(/.{3}/).to_a
+				groups.unshift(fix[0...remainder]) if remainder > 0
+
+				whole = "#{sign}#{@symbol}#{groups.join(@delimeter)}"
+				name = (@name && options[:format] == :full) ? " #{@name}" : ''
+
+				if @places > 0
+					"#{whole}#{@separator}#{frac}#{name}"
+				else
+					"#{whole}#{name}"
+				end
+			end
+		end
+		
+	end
+end

data/lib/latinum/resource.rb

@@ -0,0 +1,77 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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 'bigdecimal'
+
+module Latinum
+	# A fixed unit in a given named resource
+	class Resource
+		include Comparable
+		
+		attr :amount
+		attr :name
+		
+		def initialize(amount, name)
+			@amount = BigDecimal(amount)
+			@name = name
+		end
+		
+		# By default, we can only add and subtract if the name is the same
+		def + other
+			throw ArgumentError.new("Cannot operate on different currencies!") if @name != other.name
+			
+			self.class.new(@amount + other.amount, @name)
+		end
+		
+		def - other
+			throw ArgumentError.new("Cannot operate on different currencies!") if @name != other.name
+			
+			self.class.new(@amount - other.amount, @name)
+		end
+		
+		def -@
+			self.class.new(-@amount, @name)
+		end
+		
+		def * factor
+			self.class.new(@amount * factor, @name)
+		end
+		
+		def to_s(options = {})
+			@amount.to_s('F') + ' ' + @name.to_s
+		end
+		
+		def <=> other
+			if @name == other.name
+				@amount <=> other.amount
+			else
+				@name <=> other.name
+			end
+		end
+		
+		def self.parse(string)
+			self.new *string.split(/\s+/, 2)
+		end
+		
+		def zero?
+			@amount.zero?
+		end
+	end
+end

data/lib/latinum/version.rb

@@ -0,0 +1,29 @@
+# Copyright (c) 2012 Samuel G. D. Williams. <http://www.oriontransfer.co.nz>
+# 
+# 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.
+
+module Latinum
+	module VERSION
+		MAJOR = 0
+		MINOR = 2
+		TINY  = 0
+
+		STRING = [MAJOR, MINOR, TINY].join('.')
+	end
+end

data/test/helper.rb

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

data/test/test_bank.rb

@@ -0,0 +1,21 @@
+
+require 'helper'
+
+require 'latinum/bank'
+require 'latinum/currencies/global'
+
+class BankTest < Test::Unit::TestCase
+	def setup
+		@bank = Latinum::Bank.new
+		@bank.import(Latinum::Currencies::Global)
+	end
+	
+	def test_formatting
+		resource = Latinum::Resource.new("10", "NZD")
+		assert_equal "$10.00 NZD", @bank.format(resource, :format => :full)
+		assert_equal "$10.00", @bank.format(resource, :format => :compact)
+		
+		resource = Latinum::Resource.new("391", "AUD")
+		assert_equal "$391.00 AUD", @bank.format(resource)
+	end
+end

metadata

@@ -0,0 +1,56 @@
+--- !ruby/object:Gem::Specification
+name: latinum
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+  prerelease: 
+platform: ruby
+authors:
+- Samuel Williams
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-23 00:00:00.000000000 Z
+dependencies: []
+description: 
+email: samuel.williams@oriontransfer.co.nz
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/latinum/bank.rb
+- lib/latinum/collection.rb
+- lib/latinum/currencies/global.rb
+- lib/latinum/formatters.rb
+- lib/latinum/resource.rb
+- lib/latinum/version.rb
+- lib/latinum.rb
+- test/helper.rb
+- test/test_bank.rb
+- README.md
+homepage: http://www.oriontransfer.co.nz/gems/latinum
+licenses: []
+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
+signing_key: 
+specification_version: 3
+summary: Latinum is a simple gem for managing resource computations, including money
+  and minerals.
+test_files: []
+has_rdoc: