cashish 0.1.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010-2011 [Matthew Rudy Jacobs and Thought Sauce]
+
+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/README

@@ -0,0 +1,22 @@
+Cashish
+=======
+
+Storing Currency as Integers
+Cashish (will) make it easy to display this with the right number of decimal places.
+As well as creating a simple "Amount" object you can perform arithmetic on.
+
+Example
+=======
+
+    gbp = Cashish::Amount.new(1_000_000_00, "GBP")
+    
+    gbp.to_s
+    => "1,000,000.00 GBP"
+    
+    gbp.to_f
+    => 1_000_000.00
+    
+    gbp.to_s(:simple)
+    => "1000000.00"
+    
+    

data/lib/cashish.rb

@@ -0,0 +1,8 @@
+require 'cashish/amount'
+require 'cashish/currency'
+
+module Cashish
+  
+  class MissingCurrencyException < ArgumentError ; end
+
+end

data/lib/cashish/amount.rb

@@ -0,0 +1,139 @@
+require 'active_support/core_ext/array/extract_options'
+
+require 'action_view/helpers/number_helper'
+
+# these are all for the number helper
+# today, write this myself and remove these dependencies
+require 'active_support/core_ext/hash/indifferent_access'
+require 'active_support/core_ext/hash/reverse_merge'
+require 'active_support/core_ext/string/output_safety'
+require 'i18n'
+
+module Cashish
+  class Amount
+    include Comparable
+    include ActionView::Helpers::NumberHelper
+
+    def initialize(integer_value, currency_code)
+      @integer_value = integer_value
+      @currency_code = currency_code
+      @currency_data = Currency[currency_code]
+    end
+    attr_reader :integer_value, :currency_code, :currency_data
+    
+    def inspect
+      "#<Cashish::Amount #{self.to_s}>"
+    end
+    
+    def <=>(other)
+      if self.currency_code == other.currency_code
+        self.integer_value <=> other.integer_value
+      end
+    end
+    
+    def +(other)
+      if @currency_code == other.currency_code
+        Cashish::Amount.new(@integer_value.to_f + other.integer_value.to_f, @currency_code)
+      else
+        raise "you can't add different currencies"
+      end
+    end
+    
+    def -(other)
+      if @currency_code == other.currency_code
+        Cashish::Amount.new(@integer_value.to_f - other.integer_value.to_f, @currency_code)
+      else
+        raise "you can't subtract different currencies"
+      end
+    end
+    
+    def *(value)
+      if value.is_a?(Numeric)
+        if @integer_value
+          Cashish::Amount.new(@integer_value*value, @currency_code)
+        else
+          self
+        end
+      else
+        raise "you can only multiply a currency by a numeric"
+      end
+    end
+    
+    def /(value)
+      if value.is_a?(Numeric)
+        if @integer_value
+          Cashish::Amount.new(@integer_value/value, @currency_code)
+        else
+          self
+        end
+      elsif value.is_a?(Cashish::Amount)
+        ratio(value)
+      else
+        raise "you can only divide a currency by a numeric or another currency"
+      end
+    end
+    
+    def decimal_places
+      currency_data[:e]
+    end
+
+    def decimal_value
+      if integer_value
+        @decimal_value ||= integer_value * BigDecimal.new("1E-#{decimal_places}")
+      end
+    end
+
+    # use XE.com's format
+    # eg. 14,399.43 USD
+    def to_s(*args)
+      opts = args.extract_options!
+      format = args.first || :full
+      
+      case format
+        when :full   # USD 14,399.43
+          "#{formatted_value(opts) || "-"} #{currency_code}"
+        when :hide_currency   # 14,399.43
+          "#{formatted_value(opts) || "-"}"
+        when :simple # 14399.43
+          formatted_value(opts.merge(:delimiter => "", :default_to_zero => true))
+        else
+          raise "bad format"
+      end
+    end
+    
+    # the underlying value explicitly as an integer
+    def to_i
+      self.integer_value.to_i
+    end
+    
+    # the underlying value explicitly as a float
+    def to_f
+      self.integer_value.to_f
+    end
+
+    def formatted_value(opts={})
+      this_value = decimal_value
+      if opts.delete(:default_to_zero)
+        this_value ||= 0
+      end
+
+      if this_value
+        precision = opts[:precision] || self.decimal_places
+        with_precision = "%01.#{precision}f" % this_value
+        number_with_delimiter(with_precision, {:separator => '.', :delimiter => ','}.merge(opts))
+      end
+    end
+    
+    protected
+    
+    # the ratio of two currencies
+    def ratio(other)
+      if @currency_code == other.currency_code
+        @integer_value.to_f / other.integer_value.to_f
+      else
+        raise "you can't find the ratio of two different currencies"
+      end
+    end
+
+  end
+end

data/lib/cashish/currency.rb

@@ -0,0 +1,33 @@
+require 'active_support/memoizable'
+
+module Cashish
+  
+  module Currency
+    
+    # http://en.wikipedia.org/wiki/ISO_4217
+    #   Code | Num | E | Currency         | Locations using this currency  
+    #   HKD  | 344 | 2 | Hong Kong dollar	| Hong Kong Special Administrative Region
+    CURRENCIES = [
+      {:code => "HKD", :num => 344, :e => 2, :currency => "Hong Kong dollar", :locations => "Hong Kong Special Administrative Region"},
+      {:code => "SGD", :num => 702, :e => 2, :currency => "Singapore dollar", :locations => "Singapore"}
+    ]
+    
+    class << self
+      
+      extend ActiveSupport::Memoizable
+      
+      def find_by_code(code)
+        CURRENCIES.detect{|currency| currency[:code] == code} || raise(MissingCurrencyException, "no currency #{code}")
+      end
+      memoize :find_by_code
+      
+      alias :[] :find_by_code
+      
+      def codes
+        CURRENCIES.map{|currency| currency[:code]}
+      end
+    end
+    
+  end
+
+end

data/test/arithmetic_test.rb

@@ -0,0 +1,70 @@
+require 'test_helper'
+
+class ArithmeticTest < Test::Unit::TestCase
+  
+  test "addition" do
+    sum = Cashish::Amount.new(12_34, "HKD") + Cashish::Amount.new(500_00, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "512.34 HKD", sum.to_s
+  end
+
+  test "addition to nil" do
+    sum = Cashish::Amount.new(nil, "HKD") + Cashish::Amount.new(500_00, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "500.00 HKD", sum.to_s
+  end
+
+  test "addition of nil" do
+    sum = Cashish::Amount.new(12_34, "HKD") + Cashish::Amount.new(nil, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "12.34 HKD", sum.to_s
+  end
+
+  test "subtraction" do
+    sum = Cashish::Amount.new(123_45, "HKD") - Cashish::Amount.new(21_00, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "102.45 HKD", sum.to_s
+  end
+
+  test "subtraction from nil" do
+    sum = Cashish::Amount.new(nil, "HKD") - Cashish::Amount.new(21_00, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "-21.00 HKD", sum.to_s
+  end
+
+  test "subtraction of nil" do
+    sum = Cashish::Amount.new(123_45, "HKD") - Cashish::Amount.new(nil, "HKD")
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "123.45 HKD", sum.to_s
+  end
+
+  test "multiplication" do
+    sum = Cashish::Amount.new(12_34, "HKD") *4
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "49.36 HKD", sum.to_s
+  end
+
+  test "multiplication of nil" do
+    it = Cashish::Amount.new(nil, "HKD")
+    sum = it * 4
+    assert_equal "- HKD", sum.to_s
+  end
+
+  test "division" do
+    sum = Cashish::Amount.new(12_34, "HKD") / 2
+    assert_instance_of Cashish::Amount, sum
+    assert_equal "6.17 HKD", sum.to_s
+  end
+
+  test "division of nil" do
+    it = Cashish::Amount.new(nil, "HKD")
+    sum = it / 4
+    assert_equal "- HKD", sum.to_s
+  end
+
+  test "division of two currencies" do
+    sum = Cashish::Amount.new(123_45, "HKD") / Cashish::Amount.new(21_00, "HKD")
+    assert_instance_of Float, sum
+    assert_equal_float 123_45.0 / 21_00.0, sum
+  end
+end

data/test/currency_test.rb

@@ -0,0 +1,17 @@
+require 'test_helper'
+
+class CurrencyTest < Test::Unit::TestCase
+  
+  test "Currency['HKD'] grabs all the data for HKDs" do
+    assert_equal(
+    {:code => "HKD", :num => 344, :e => 2, :currency => "Hong Kong dollar", :locations => "Hong Kong Special Administrative Region"},
+    Cashish::Currency["HKD"])
+  end
+
+  test "Currency[] raises an exception for an imaginary currency" do
+    assert_raise(Cashish::MissingCurrencyException) do
+      Cashish::Currency["notreal"]
+    end
+  end
+  
+end

data/test/display_test.rb

@@ -0,0 +1,118 @@
+require 'test_helper'
+
+class DisplayTest < Test::Unit::TestCase
+
+  test "Cashish::Amount" do
+    amount = Cashish::Amount.new(12_345_67, "HKD")
+    assert_equal "HKD", amount.currency_code
+    assert_equal 2, amount.decimal_places
+    assert_equal "12,345.67", amount.formatted_value
+    assert_equal "12,345.67 HKD", amount.to_s
+    assert_equal "12,345.67 HKD", amount.to_s(:full)
+    assert_equal "12345.67", amount.to_s(:simple)
+    
+    assert_equal 12_345_67,   amount.integer_value
+    assert_equal 12_345.67,   amount.decimal_value
+    assert_equal 12_345_67.0, amount.to_f
+    assert_equal 12_345_67,   amount.to_i
+  end
+
+  test "Cashish::Amount - negative" do
+    amount = Cashish::Amount.new(-12_345_67, "HKD")
+    assert_equal "HKD",            amount.currency_code
+    assert_equal 2,                amount.decimal_places
+    assert_equal "-12,345.67",     amount.formatted_value
+    assert_equal "-12,345.67 HKD", amount.to_s
+    assert_equal "-12,345.67 HKD", amount.to_s(:full)
+    assert_equal "-12345.67",      amount.to_s(:simple)
+    
+    assert_equal -12_345_67,       amount.integer_value
+    assert_equal -12_345.67,       amount.decimal_value
+    assert_equal -12_345_67.0,     amount.to_f
+    assert_equal -12_345_67,       amount.to_i
+  end
+
+  test "Cashish::Amount - nil" do
+    amount = Cashish::Amount.new(nil, "HKD")
+    assert_equal "HKD",   amount.currency_code
+    assert_equal 2,       amount.decimal_places
+    assert_equal nil,     amount.formatted_value
+    assert_equal "0.00",  amount.formatted_value(:default_to_zero => true)
+    assert_equal "- HKD", amount.to_s
+    assert_equal "- HKD", amount.to_s(:full)
+    assert_equal "0.00",  amount.to_s(:simple)
+
+    assert_equal       nil, amount.integer_value
+    assert_equal       nil, amount.decimal_value
+    assert_equal_float 0.0, amount.to_f
+    assert_equal         0, amount.to_i
+  end
+
+  test "Cashish::Amount - float" do
+    amount = Cashish::Amount.new(123_456_78.9012, "HKD")
+    assert_equal "HKD",            amount.currency_code
+    assert_equal 2,                amount.decimal_places
+    assert_equal "123,456.79",     amount.formatted_value
+    assert_equal "123,456.79 HKD", amount.to_s
+    assert_equal "123,456.79 HKD", amount.to_s(:full)
+    assert_equal "123456.79",      amount.to_s(:simple)
+
+    assert_equal       123_456_78.9012, amount.integer_value
+    assert_equal_float 123_456.789012,  amount.decimal_value
+    
+    assert_equal_float amount.integer_value,  amount.to_f
+    assert_equal       amount.integer_value.to_i, amount.to_i
+  end
+
+  test "Cashish::Amount#to_s should accept a precision" do
+    amount = Cashish::Amount.new(123_45.678901234, "HKD")
+    assert_equal "123.46 HKD",   amount.to_s
+    assert_equal "123.4568 HKD", amount.to_s(:precision => 4)
+  end
+
+  test "Cashish::Amount#to_s should accept delimiter and separator" do
+    amount = Cashish::Amount.new(123_456_789_012_34, "HKD")
+    assert_equal "123,456,789,012.34 HKD", amount.to_s
+    assert_equal "123o456o789o012-34 HKD", amount.to_s(:delimiter => "o", :separator => "-")
+  end
+
+  test "Cashish::Amount#to_s should round to the nearest if given a float" do
+    assert_equal "0.02 HKD", Cashish::Amount.new(5/3.0, "HKD").to_s # 0.016666
+    assert_equal "0.02 HKD", Cashish::Amount.new(7/3.0, "HKD").to_s # 0.023333
+  end
+
+  test "Cashish::Amount#to_s should handle massive numbers" do
+    assert_to_s(
+    100_000_000_000_000_000_000_00,
+    "100,000,000,000,000,000,000.00 HKD")
+  end
+
+  test "Cashish::Amount#to_s should keep all significant figures" do
+    assert_to_s(123_456_789_012_345_67, "123,456,789,012,345.67 HKD")
+  end
+
+  test "ruby patchlevel 173 bug" do
+    assert_to_s(100_000_01, "100,000.01 HKD")
+  end
+
+  test "simple edge cases" do
+    assert_to_s(1_00, "1.00 HKD")
+    assert_to_s(   1, "0.01 HKD")
+    assert_to_s(  10, "0.10 HKD")
+  end
+
+  test "negative numbers" do
+    assert_to_s(     -1, "-0.01 HKD")
+    assert_to_s(    -12, "-0.12 HKD")
+    assert_to_s(   -123, "-1.23 HKD")
+
+    assert_to_s(-123456, "-1,234.56 HKD")
+  end
+  
+  protected
+
+  def assert_to_s(value, expected_to_s)
+    assert_equal expected_to_s, Cashish::Amount.new(value,"HKD").to_s, "value of #{value.inspect} came out wrong"
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'test/unit'
+require 'active_support/testing/declarative'
+
+$: << File.expand_path(File.dirname(__FILE__)+"/../lib")
+require 'cashish'
+
+class Test::Unit::TestCase
+  extend ActiveSupport::Testing::Declarative
+  
+  def assert_equal_float(expected, actual, message=nil)
+    assert_in_delta expected, actual, 1E-4, message
+  end
+  
+end

metadata

@@ -0,0 +1,101 @@
+--- !ruby/object:Gem::Specification 
+name: cashish
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Matthew Rudy Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-22 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
+- !ruby/object:Gem::Dependency 
+  name: actionpack
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: MatthewRudyJacobs@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- MIT-LICENSE
+- test/arithmetic_test.rb
+- test/currency_test.rb
+- test/display_test.rb
+- test/test_helper.rb
+- lib/cashish/amount.rb
+- lib/cashish/currency.rb
+- lib/cashish.rb
+- README
+homepage: https://github.com/matthewrudy/cashish
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README
+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.7.2
+signing_key: 
+specification_version: 3
+summary: Currency Handling done simple
+test_files: []
+