mongoid_money 0.1.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Jeff Bozek
+
+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.rdoc

@@ -0,0 +1,19 @@
+= mongoid_money
+
+Description goes here.
+
+== Contributing to mongoid_money
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Jeff Bozek. See LICENSE.txt for
+further details.
+

data/lib/mongoid_money/conversions.rb

@@ -0,0 +1,24 @@
+module Mongoid
+  module Extensions
+    module Money
+      module Conversions
+        def set(value)
+          return nil if value.blank?
+          begin
+            value.cents
+          rescue
+            value
+          end
+        end
+        def get(value)
+          return nil if value.blank?
+          begin
+            self.new_from_cents value
+          rescue
+            nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/mongoid_money/money.rb

@@ -0,0 +1,180 @@
+class Money < Numeric
+  extend Mongoid::Extensions::Money::Conversions
+  include Comparable
+
+  attr_reader :cents
+
+  def self.new_from_dollars(value)
+    case value
+      when Fixnum
+        Money.new(value * 100)
+      when BigDecimal
+        Money.new((value * 100).fix)
+      when Float
+        Money.new((BigDecimal.new(value.to_s) * 100).fix)
+      when Numeric
+        Money.new((BigDecimal.new(value.to_s) * 100).fix)
+      when String
+        Money.new((BigDecimal.new(value.to_s) * 100).fix)
+      else
+        raise ArgumentError, "#{value} must be a numeric object or a string representation of a number."
+    end
+  end
+
+  def self.new_from_cents(cents)
+    Money.new cents.round.to_i
+  end
+
+  def initialize(cents)
+    @cents = cents.round.to_i
+  end
+
+  def dollars
+    (BigDecimal.new(cents.to_s) / 100 ).to_f
+  end
+
+  def ==(other_money)
+    if other_money.respond_to?(:to_money)
+      other_money = other_money.to_money
+      cents == other_money.cents
+    else
+      false
+    end
+  end
+
+  def eql?(other_money)
+    self == other_money
+  end
+
+  def hash
+    cents.hash
+  end
+
+  def <=>(other_money)
+    if other_money.respond_to?(:to_money)
+      other_money = other_money.to_money
+      cents <=> other_money.cents
+    else
+      raise ArgumentError, "Comparison of #{self.class} with #{other_money.inspect} failed"
+    end
+  end
+
+  def +(other_money)
+    Money.new(cents + other_money.cents)
+  end
+
+  def -(other_money)
+    Money.new(cents - other_money.cents)
+  end
+
+  def *(value)
+    if value.is_a?(Money)
+      raise ArgumentError, "Can't multiply a Money by a Money"
+    else
+      Money.new(cents * value)
+    end
+  end
+
+  def /(value)
+    if value.is_a?(Money)
+      (cents / BigDecimal.new(value.cents.to_s)).to_f
+    else
+      Money.new(cents / value)
+    end
+  end
+
+  def div(value)
+    self / value
+  end
+
+  def divmod(val)
+    if val.is_a?(Money)
+      a = self.cents
+      b = val.cents
+      q, m = a.divmod(b)
+      return [q, Money.new(m)]
+    else
+      return [self.div(val), Money.new(self.cents.modulo(val))]
+    end
+  end
+
+  def modulo(val)
+    self.divmod(val)[1]
+  end
+
+  def %(val)
+    self.modulo(val)
+  end
+
+  def remainder(val)
+    a, b = self, val
+
+    a_sign, b_sign = :pos, :pos
+    a_sign = :neg if a.cents < 0
+    b_sign = :neg if (b.is_a?(Money) and b.cents < 0) or (b < 0)
+
+    return a.modulo(b) if a_sign == b_sign
+    a.modulo(b) - (b.is_a?(Money) ? b : Money.new(b))
+  end
+
+  def abs
+    Money.new(self.cents.abs)
+  end
+
+  def zero?
+    cents == 0
+  end
+
+  def nonzero?
+    cents != 0 ? self : nil
+  end
+
+  def to_money
+    self
+  end
+
+  def inspect
+    to_s
+  end
+
+  def odd?
+    @cents%2 > 0
+  end
+
+  def even?
+    @cents%2 == 0
+  end
+
+  def to_s
+    dollars.to_s
+  end
+
+  def to_f
+    dollars
+  end
+
+  def coerce(other)
+    return other, to_f
+  end
+
+end
+
+class Numeric
+
+  def dollar
+    dollars
+  end
+
+  def dollars
+    Money.new_from_dollars self
+  end
+
+  def cent
+    cents
+  end
+
+  def cents
+    Money.new_from_cents self
+  end
+
+end

data/lib/mongoid_money.rb

@@ -0,0 +1,2 @@
+require 'mongoid_money/conversions'
+require 'mongoid_money/money'

data/spec/conversion_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Mongoid::Extensions::Money::Conversions do
+  
+  describe 'when persisting a document with a Money datatype' do
+  
+    it 'should be persisted normally when set as dollars' do
+      dummy = DummyMoney.new
+      dummy.price = 10.dollars
+      dummy.save.should eq true
+    end
+    
+    it 'should be persisted normally when set as cents' do
+      dummy = DummyMoney.new
+      dummy.price = 99.cents
+      dummy.save.should eq true
+    end
+    
+  end
+  
+  describe 'when accessing a document from the datastore with a Money datatype' do
+    
+    before(:each) do
+      DummyMoney.create(:description => "Test", :price => 9.dollars)
+    end
+    
+    it 'should have a Money value that matches the money value that was initially persisted' do
+      dummy = DummyMoney.first
+      dummy.price.should eq 9.dollars
+    end
+    
+  end
+
+end

data/spec/money_spec.rb

@@ -0,0 +1,111 @@
+require 'spec_helper'
+
+describe Money do
+  
+  describe "#==" do
+    it 'should identify equal dollar values correctly' do
+      (10.dollars == Money.new_from_dollars(10)).should eq true
+      (10.dollars == 10.dollars).should eq true
+    end
+    
+    it 'should identify equal monetary values correctly' do
+      (10.dollars == Money.new_from_cents(10 * 100)).should eq true
+      (10.dollars == 1000.cents).should eq true
+    end
+  end
+  
+  describe "#eql?" do
+    it 'should identify equal dollar values correctly' do
+      (10.dollars.eql?(Money.new_from_dollars(10))).should eq true
+      (10.dollars.eql?(10.dollars)).should eq true
+    end
+    
+    it 'should identify equal monetary values correctly' do
+      (10.dollars.eql?(Money.new_from_cents(10 * 100))).should eq true
+      (10.dollars.eql?(1000.cents)).should eq true
+    end
+  end
+  
+  describe "#<=>" do
+    it 'should find that 10 dollars is greater than 5 dollars' do
+      (10.dollars <=> 5.dollars).should eq 1
+    end
+    
+    it 'should find that 5 dollars is less than 10 dollars' do
+      (5.dollars <=> 10.dollars).should eq -1
+    end
+    
+    it 'should raise an error when Money is compared to non-money' do
+      expect{ 5.dollars <=> 500}.to raise_error(ArgumentError, "Comparison of Money with 500 failed")
+    end
+  end
+  
+  describe "#+" do
+    it 'should add 10 dollars and 5 dollars and get 15 dollars' do
+      (10.dollars + 5.dollars).should eq 15.dollars
+    end
+    
+    it 'should add 10 dollars and 200 cents and get 12 dollars' do
+      (10.dollars + 200.cents).should eq 12.dollars
+    end
+    
+    it 'should add 50 cents and 200 cents and get 250 cents' do
+      (50.cents + 200.cents).should eq 250.cents
+    end
+  end
+  
+  describe "#-" do
+    it 'should subtract 5 dollars from 15 dollars and get 10 dollars' do
+      (15.dollars - 5.dollars).should eq 10.dollars
+    end
+    
+    it 'should subtract 200 cents from 12 dollars and get 10 dollars' do
+      (12.dollars - 200.cents).should eq 10.dollars
+    end
+    
+    it 'should subtract 50 cents from 200 cents and get 150 cents' do
+      (200.cents - 50.cents).should eq 150.cents
+    end
+  end
+  
+  describe "#*" do
+    it 'should multiply 10 dollars by 3 and get 30 dollars' do
+      (10.dollars * 3).should eq 30.dollars
+    end
+    
+    it 'should raise an error when Money is multiplied by money' do
+      expect{ 5.dollars * 5.dollars}.to raise_error(ArgumentError, "Can't multiply a Money by a Money")
+    end
+  end
+  
+  describe "#/" do
+    it 'should divide 10 dollars by 2 and get 5 dollars' do
+      (10.dollars / 2).should eq 5.dollars
+    end
+    
+    it 'should divide 10 dollars by 5 dollars and get 2' do
+      (10.dollars / 5.dollars).should eq 2
+    end
+  end
+  
+  describe "#div" do
+    it 'should divide 10 dollars by 2 and get 5 dollars' do
+      (10.dollars.div(2)).should eq 5.dollars
+    end
+    
+    it 'should divide 10 dollars by 5 dollars and get 2' do
+      (10.dollars.div(5.dollars)).should eq 2
+    end
+  end
+  
+  describe "#abs" do
+    it 'should return the abs value of -10 dollars as 10 dollars' do
+      -10.dollars.abs.should eq 10.dollars
+    end
+    
+    it 'should return the abs value of 10 dollars as 10 dollars' do
+      10.dollars.abs.should eq 10.dollars
+    end
+  end
+  
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'mongoid'
+require 'database_cleaner'
+require 'mongoid_money'
+require 'rubygems'
+
+Dir["./spec/support/**/*.rb"].each {|f| require f}
+
+RSpec.configure do |config|
+  
+  Mongoid.configure do |mconfig|
+    name = "monogid_money_test"
+    host = "localhost"
+    port = 27017
+    mconfig.database = Mongo::Connection.new.db(name)
+  end
+  
+  DatabaseCleaner.strategy = :truncation
+  
+  config.before(:each) do
+    DatabaseCleaner.clean
+  end
+
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+end

data/spec/support/dummy_money.rb

@@ -0,0 +1,7 @@
+class DummyMoney
+  include Mongoid::Document
+
+  field :description
+  field :price, :type => Money
+
+end

metadata

@@ -0,0 +1,191 @@
+--- !ruby/object:Gem::Specification 
+name: mongoid_money
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Jeff Bozek
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :development
+  prerelease: false
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: mongo_ext
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.7
+  type: :development
+  prerelease: false
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
+  name: bson_ext
+  requirement: &id008 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.2"
+  type: :development
+  prerelease: false
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
+  name: database_cleaner
+  requirement: &id009 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  prerelease: false
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
+  name: mongo
+  requirement: &id010 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "1.1"
+  type: :runtime
+  prerelease: false
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
+  name: mongoid
+  requirement: &id011 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 2.0.0.rc.7
+  type: :runtime
+  prerelease: false
+  version_requirements: *id011
+description: Money datatype for Mongoid. Inspired by Ruby Money. Makes handling money simple. Stores the value in the db as cents. Currently handles USD.
+email: jeff.bozek@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README.rdoc
+files: 
+- lib/mongoid_money.rb
+- lib/mongoid_money/conversions.rb
+- lib/mongoid_money/money.rb
+- LICENSE.txt
+- README.rdoc
+- spec/conversion_spec.rb
+- spec/money_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_money.rb
+has_rdoc: true
+homepage: http://github.com/jeffbozek/mongoid_money
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: -1985478583530141391
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.3
+signing_key: 
+specification_version: 3
+summary: Money datatype for Mongoid. Inspired by Ruby Money.
+test_files: 
+- spec/conversion_spec.rb
+- spec/money_spec.rb
+- spec/spec_helper.rb
+- spec/support/dummy_money.rb