monetary_value 1.0.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/README.rdoc

@@ -0,0 +1,6 @@
+= Monetary Value -- Library for dealing with monetary values
+
+This library provides the classes MonetaryValue and Currency.
+
+
+Copyright (c) 2009 OpenCuro, Inc., all rights reserved

data/Rakefile

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

data/lib/currency.rb

@@ -0,0 +1,82 @@
+require 'active_support/core_ext/enumerable' # Provides Enumerable#index_by
+
+class Currency
+	attr_reader :id, :name, :code, :minor_divisor
+	
+	def initialize(id, name, code, minor_divisor)
+		@id = id
+		@name = name
+		@code = code
+		@minor_divisor = minor_divisor
+	end
+	
+  unless const_defined?(:CURRENCIES)
+		CURRENCIES = [
+			new(840, "United States Dollar", "USD", 100),
+		]
+		CURRENCIES_BY_ID = CURRENCIES.index_by(&:id)
+		CURRENCIES_BY_NAME = CURRENCIES.index_by(&:name)
+		CURRENCIES_BY_CODE = CURRENCIES.index_by(&:code)
+		
+		CURRENCIES.freeze
+		CURRENCIES_BY_ID.freeze
+		CURRENCIES_BY_NAME.freeze
+		CURRENCIES_BY_CODE.freeze
+	end
+	
+	def convert_to_minor_denomination(major_denomination)
+		return nil if major_denomination.nil?
+		(major_denomination.to_f * self.minor_divisor.to_f).round
+	end
+	
+	def convert_to_major_denomination(minor_denomination)
+		return nil if minor_denomination.nil?
+		minor_denomination.to_f / self.minor_divisor.to_f
+	end
+	
+	class << self
+		def all
+			CURRENCIES
+		end
+		
+		def new(id = 840)
+			self[id]
+		end
+		
+		def [](arg)
+			case arg
+			when Integer
+				CURRENCIES_BY_ID[arg]
+			else
+				raise ArgumentError, "invalid argument to Currency[]: #{arg.inspect}"
+			end
+		end
+		
+		def typecast(object)
+			return nil if object.nil?
+			return object if object.is_a? self
+			
+			case object
+			when Integer
+				currency = CURRENCIES_BY_ID[object]
+				currency.nil? ? Currency.new : currency
+			when String
+				currency = CURRENCIES_BY_CODE[object]
+				currency.nil? ? Currency.new : currency
+			else
+				raise UntypecastableArgumentError, "#{object.inspect}:#{object.class} cannot be cast as #{self}"
+			end
+		end
+		
+	end
+	
+	def new_record?
+		false
+	end
+	
+	def destroyed?
+		false
+	end
+	
+end
+

data/lib/monetary_value.rb

@@ -0,0 +1,200 @@
+require 'monetary_value/version'
+
+require 'currency'
+
+class MonetaryValue
+	attr_reader :currency, :denomination
+	
+	def initialize(denomination = 0, currency = Currency.new)
+		@denomination = denomination
+		@currency = currency
+	end
+	
+	# Backwards compatibility
+	# TODO: Remove minor_denomination from MonetaryValue
+	def minor_denomination
+		denomination
+	end
+	
+	def major_denomination
+		"%01.2f" % (currency.convert_to_major_denomination(denomination))
+	end
+	
+	# Display
+	def to_s(format = :default)
+		case format
+		when :default, :short
+			"$#{major_denomination}"
+		when :long
+			"#{major_denomination} #{currency.code}"
+		else
+			"$#{major_denomination}"
+		end
+	end
+	
+	def inspect
+		to_s(:long)
+	end
+	
+	def self.parse(string)
+		currency = Currency.new
+		string.strip!
+		denomination = nil
+		nonnegative_string_formats = [
+			/^(\d+)$/, # "123"
+			/^\$(\d+)$/, # "$123"
+			/^(\d*)\.(\d{1,2})$/, # "123.4", ".4", "123.45", ".45"
+			/^\$(\d*)\.(\d{1,2})$/, # "$123.4", "$.4", "$123.45", "$.45"
+		]
+		
+		nonnegative_string_formats.each do |format|
+			result = string.scan(format)
+			if result.size == 1
+				denominations = result.first
+				major_denomination = denominations[0].to_i
+				minor_denomination = denominations[1].nil? ? 0 : denominations[1].ljust(2, "0").to_i
+				denomination = major_denomination * 100 + minor_denomination
+				return MonetaryValue.new(denomination, currency)
+			end
+		end
+		
+		negative_string_formats = [
+			/^-(\d+)$/, # "-123"
+			/^-\$(\d+)$/, # "-$123"
+			/^\$-(\d+)$/, # "$-123"
+			/^-(\d*)\.(\d{1,2})$/, # "-123.4", "-.4", "-123.45", "-.45"
+			/^-\$(\d*)\.(\d{1,2})$/, # "-$123.4", "-$.4", "-$123.45", "-$.45"
+			/^\$-(\d*)\.(\d{1,2})$/, # "$-123.4", "$-.4", "$-123.45", "$-.45"
+		]
+		
+		negative_string_formats.each do |format|
+			result = string.scan(format)
+			if result.size == 1
+				denominations = result.first
+				major_denomination = denominations[0].to_i
+				minor_denomination = denominations[1].nil? ? 0 : denominations[1].ljust(2, "0").to_i
+				denomination = major_denomination * 100 + minor_denomination
+				return MonetaryValue.new(-denomination, currency)
+			end
+		end
+		
+		raise ArgumentError, "invalid money_value"
+	end
+	
+	class << self
+		def typecast(object)
+			return nil if object.nil?
+			return object if object.is_a? self
+			
+			case object
+			when String
+				begin
+					parse(object)
+				rescue ArgumentError => e
+					raise UntypecastableArgumentError, "#{object.inspect}:#{object.class} cannot be cast as #{self}"
+				end
+			else
+				raise UntypecastableArgumentError, "#{object.inspect}:#{object.class} cannot be cast as #{self}"
+			end
+		end
+		
+	end
+	
+	##############
+	# Arithmetic #
+	##############
+	
+	# Comparisons
+	include Comparable
+	def <=>(other)
+		raise ArgumentError, "can't compare values in difference currencies" unless self =~ other
+		denomination <=> other.denomination
+	end
+	
+	# Addition
+	def +(other)
+		raise ArgumentError, "can't add values in difference currencies" unless self =~ other
+		MonetaryValue.new(denomination + other.denomination, currency)
+	end
+	
+	# Subtraction
+	def -(other)
+		raise ArgumentError, "can't subtract values in difference currencies" unless self =~ other
+		MonetaryValue.new(denomination - other.denomination, currency)
+	end
+	
+	# Multiplication
+	def *(num)
+		MonetaryValue.new(denomination * num, currency)
+	end
+	
+	# Division
+	def /(num)
+		MonetaryValue.new(denomination / num, currency)
+	end
+	
+	# Absolute value
+	def abs
+		MonetaryValue.new(denomination.abs, currency)
+	end
+	
+	# Unary plus
+	def +@
+		MonetaryValue.new(denomination, currency)
+	end
+	
+	# Unary minus
+	def -@
+		MonetaryValue.new(-denomination, currency)
+	end
+	
+	# Currency matching
+	def =~(other)
+		currency == other.currency
+	end
+	
+	# Next
+	def next
+		MonetaryValue.new(denomination.next, currency)
+	end
+	alias :succ :next
+	
+	##############
+	# Sign tests #
+	##############
+	
+	def zero?
+		denomination.zero?
+	end
+	
+	def sign
+		denomination.sign
+	end
+	
+	def positive?
+		denomination.positive?
+	end
+	
+	def negative?
+		denomination.negative?
+	end
+	
+	#################
+	# Serialization #
+	#################
+	
+	def self.xml_root
+		"money"
+	end
+	
+	def to_xml(options = {})
+		options[:root] ||= self.class.xml_root
+		{ :currency_id => currency.id, :denomination => denomination }.to_xml(options)
+	end
+	
+	def self.from_xml(xml)
+		attributes = Hash.from_xml(xml)[xml_root].symbolize_keys
+		new( attributes[:denomination] || attributes[:minor_value], Currency.new(attributes[:currency_id]) )
+	end
+	
+end

data/lib/monetary_value/version.rb

@@ -0,0 +1,3 @@
+class MonetaryValue
+  VERSION = "1.0.0"
+end

data/monetary_value.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "monetary_value/version"
+
+Gem::Specification.new do |s|
+  s.name        = "monetary_value"
+  s.version     = MonetaryValue::VERSION
+  s.authors     = ["Ian James"]
+  s.email       = ["ian@opencuro.com"]
+  s.homepage    = "https://opencuro.com"
+  s.summary     = %q{Library for working with monetary values}
+  s.description = %q{Provides the MonetaryValue and Currency classes.}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+  s.add_dependency "activesupport"
+end

data/test/currency_test.rb

@@ -0,0 +1,9 @@
+require 'test_helper'
+require 'currency'
+
+class CurrencyTest < ActiveSupport::TestCase
+  # Replace this with your real tests.
+  test "the truth" do
+    assert true
+  end
+end

data/test/monetary_value_test.rb

@@ -0,0 +1,149 @@
+require 'test_helper'
+require 'monetary_value'
+
+class MonetaryValueTest < ActiveSupport::TestCase
+	def test_parse
+		valid_strings = {
+			"0"           => MonetaryValue.new(0),
+			"00"          => MonetaryValue.new(0),
+			"1"           => MonetaryValue.new(100),
+			"123"         => MonetaryValue.new(12300),
+			
+			"$0"          => MonetaryValue.new(0),
+			"$00"         => MonetaryValue.new(0),
+			"$1"          => MonetaryValue.new(100),
+			"$123"        => MonetaryValue.new(12300),
+			
+			"0.00"        => MonetaryValue.new(0),
+			"0.0"         => MonetaryValue.new(0),
+			".00"         => MonetaryValue.new(0),
+			".0"          => MonetaryValue.new(0),
+			"0.12"        => MonetaryValue.new(12),
+			"0.10"        => MonetaryValue.new(10),
+			"0.1"         => MonetaryValue.new(10),
+			".12"         => MonetaryValue.new(12),
+			".10"         => MonetaryValue.new(10),
+			".1"          => MonetaryValue.new(10),
+			"1.23"        => MonetaryValue.new(123),
+			"1.20"        => MonetaryValue.new(120),
+			"1.2"         => MonetaryValue.new(120),
+			
+			"$0.00"       => MonetaryValue.new(0),
+			"$0.0"        => MonetaryValue.new(0),
+			"$.00"        => MonetaryValue.new(0),
+			"$.0"         => MonetaryValue.new(0),
+			"$0.12"       => MonetaryValue.new(12),
+			"$0.10"       => MonetaryValue.new(10),
+			"$0.1"        => MonetaryValue.new(10),
+			"$.12"        => MonetaryValue.new(12),
+			"$.10"        => MonetaryValue.new(10),
+			"$.1"         => MonetaryValue.new(10),
+			"$1.23"       => MonetaryValue.new(123),
+			"$1.20"       => MonetaryValue.new(120),
+			"$1.2"        => MonetaryValue.new(120),
+			
+			"-0"          => MonetaryValue.new(0),
+			"-00"         => MonetaryValue.new(0),
+			"-1"          => MonetaryValue.new(-100),
+			"-123"        => MonetaryValue.new(-12300),
+			
+			"-$0"         => MonetaryValue.new(0),
+			"-$00"        => MonetaryValue.new(0),
+			"-$1"         => MonetaryValue.new(-100),
+			"-$123"       => MonetaryValue.new(-12300),
+			
+			"$-0"         => MonetaryValue.new(0),
+			"$-00"        => MonetaryValue.new(0),
+			"$-1"         => MonetaryValue.new(-100),
+			"$-123"       => MonetaryValue.new(-12300),
+			
+			"-0.00"       => MonetaryValue.new(0),
+			"-0.0"        => MonetaryValue.new(0),
+			"-.00"        => MonetaryValue.new(0),
+			"-.0"         => MonetaryValue.new(0),
+			"-0.12"       => MonetaryValue.new(-12),
+			"-0.10"       => MonetaryValue.new(-10),
+			"-0.1"        => MonetaryValue.new(-10),
+			"-.12"        => MonetaryValue.new(-12),
+			"-.10"        => MonetaryValue.new(-10),
+			"-.1"         => MonetaryValue.new(-10),
+			"-1.23"       => MonetaryValue.new(-123),
+			"-1.20"       => MonetaryValue.new(-120),
+			"-1.2"        => MonetaryValue.new(-120),
+			
+			"-$0.00"      => MonetaryValue.new(0),
+			"-$0.0"       => MonetaryValue.new(0),
+			"-$.00"       => MonetaryValue.new(0),
+			"-$.0"        => MonetaryValue.new(0),
+			"-$0.12"      => MonetaryValue.new(-12),
+			"-$0.10"      => MonetaryValue.new(-10),
+			"-$0.1"       => MonetaryValue.new(-10),
+			"-$.12"       => MonetaryValue.new(-12),
+			"-$.10"       => MonetaryValue.new(-10),
+			"-$.1"        => MonetaryValue.new(-10),
+			"-$1.23"      => MonetaryValue.new(-123),
+			"-$1.20"      => MonetaryValue.new(-120),
+			"-$1.2"       => MonetaryValue.new(-120),
+			
+			"$-0.00"      => MonetaryValue.new(0),
+			"$-0.0"       => MonetaryValue.new(0),
+			"$-.00"       => MonetaryValue.new(0),
+			"$-.0"        => MonetaryValue.new(0),
+			"$-0.12"      => MonetaryValue.new(-12),
+			"$-0.10"      => MonetaryValue.new(-10),
+			"$-0.1"       => MonetaryValue.new(-10),
+			"$-.12"       => MonetaryValue.new(-12),
+			"$-.10"       => MonetaryValue.new(-10),
+			"$-.1"        => MonetaryValue.new(-10),
+			"$-1.23"      => MonetaryValue.new(-123),
+			"$-1.20"      => MonetaryValue.new(-120),
+			"$-1.2"       => MonetaryValue.new(-120),
+			
+		}
+		
+		valid_strings.each do |valid_string, result|
+			begin
+				assert_equal result, MonetaryValue.parse(valid_string), valid_string
+			rescue ArgumentError
+				flunk "#{valid_string} should be able to be parsed"
+			end
+		end
+		
+		invalid_strings = [
+			"",
+			"$",
+			".",
+			"$.",
+			
+			"-",
+			"-$",
+			"$-",
+			"-.",
+			"-$.",
+			"$-.",
+			
+			"$1.234",
+			"a1.23",
+			"1a.23",
+			"1. 23",
+			"1 .23",
+			"1,23",
+			"1.023",
+			"0x1",
+			
+			"0.",
+			"1.",
+			"$0.",
+			"$-1.",
+			"-$1.",
+		]
+		
+		invalid_strings.each do |invalid_string|
+			assert_raise ArgumentError do
+				MonetaryValue.parse(invalid_string)
+			end
+		end
+		
+	end
+	
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support'

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: monetary_value
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: 
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Ian James
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-06-06 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: Provides the MonetaryValue and Currency classes.
+email: 
+- ian@opencuro.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/currency.rb
+- lib/monetary_value.rb
+- lib/monetary_value/version.rb
+- monetary_value.gemspec
+- test/currency_test.rb
+- test/monetary_value_test.rb
+- test/test_helper.rb
+homepage: https://opencuro.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Library for working with monetary values
+test_files: []
+