mongoid_money_field 2.1.0 → 3.0.0

data/.travis.yml

@@ -0,0 +1,16 @@
+language: ruby
+services: mongodb
+gemfile:
+  - gemfiles/mongoid2.gemfile
+  - gemfiles/mongoid3.gemfile
+rvm:
+  - 1.9.2
+  - 1.9.3
+  - rbx-19mode
+  - jruby-19mode
+matrix:
+  exclude:
+    - rvm: 1.9.2
+      gemfile: gemfiles/mongoid3.gemfile
+    - rvm: rbx-19mode
+      gemfile: gemfiles/mongoid2.gemfile

data/Gemfile

@@ -4,9 +4,9 @@ gem 'mongoid', '>= 2.4.0'
 gem 'money'
 
 group :development do
-  gem "rspec", "~> 2.8.0"
+  gem "rspec", "~> 2.11.0"
   gem "rdoc", "~> 3.12"
-  gem "bundler", "~> 1.1.0"
+  gem "bundler", "~> 1.2.1"
   gem "jeweler", "~> 1.8.3"
   gem "simplecov", '>= 0.4.0', :require => false
   gem "database_cleaner", "~> 0.8.0"

data/Gemfile.lock

@@ -32,14 +32,14 @@ GEM
     rake (0.9.2.2)
     rdoc (3.12)
       json (~> 1.4)
-    rspec (2.8.0)
-      rspec-core (~> 2.8.0)
-      rspec-expectations (~> 2.8.0)
-      rspec-mocks (~> 2.8.0)
-    rspec-core (2.8.0)
-    rspec-expectations (2.8.0)
-      diff-lcs (~> 1.1.2)
-    rspec-mocks (2.8.0)
+    rspec (2.11.0)
+      rspec-core (~> 2.11.0)
+      rspec-expectations (~> 2.11.0)
+      rspec-mocks (~> 2.11.0)
+    rspec-core (2.11.1)
+    rspec-expectations (2.11.3)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.11.3)
     simplecov (0.6.1)
       multi_json (~> 1.0)
       simplecov-html (~> 0.5.3)
@@ -50,11 +50,11 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.0)
+  bundler (~> 1.2.1)
   database_cleaner (~> 0.8.0)
   jeweler (~> 1.8.3)
   money
   mongoid (>= 2.4.0)
   rdoc (~> 3.12)
-  rspec (~> 2.8.0)
+  rspec (~> 2.11.0)
   simplecov (>= 0.4.0)

data/README.rdoc

@@ -1,8 +1,12 @@
 == mongoid money field
 
+{<img src="https://secure.travis-ci.org/glebtv/mongoid_money_field.png" alt="Build Status" />}[http://travis-ci.org/glebtv/mongoid_money_field]
+{<img src="https://gemnasium.com/glebtv/mongoid_money_field.png" alt="Dependency Status" />}[https://gemnasium.com/glebtv/mongoid_money_field]
+
 This is a super simple gem to use RubyMoney money type columns with mongoid
 
 https://github.com/RubyMoney/money
+
 https://github.com/mongoid/mongoid
 
 == Description
@@ -11,12 +15,20 @@ A simple gem that creates a Money datatype using RubyMoney for Mongoid.
 
 Inspired by https://gist.github.com/840500
 
+== updating
+v3 breaks backwards compatibility in favour of having syntax and defaults similar to field mongoid macro
+to get the same behaviour as 1.0 please add `default: 0` to field declaration, like this
+
+    money_field :price, default: 0
+
+please avoid using v2, i realized that API was stupid after commiting it.
+
 == Installation
 
 Include the gem in your Gemfile
 
     gem 'mongoid_money_field'
-    
+
 == Usage
 
     class DummyMoney
@@ -24,15 +36,24 @@ Include the gem in your Gemfile
       include Mongoid::MoneyField
       
       field :description
-      
-      money_field :cart_total # defaults to 0
-      money_field_without_default :price, :old_price # defaults to nil
+
+      # defaults to 0
+      money_field :cart_total, default: 0
+
+      # defaults to nil
+      money_field :price, :old_price, default: nil # defaults to nil
 
       # to disallow changing currency (and to not store it in database)
-      money_field_with_options :price2, fixed_currency: 'GBP'
+      money_field :price2, fixed_currency: 'GBP'
 
       # set a default
-      money_field_with_options :price3, default: '1.23 RUB'
+      money_field :price3, default: '1.23 RUB'
+
+      # make required
+      money_field :price4, required: true, default_currency: nil
+
+      # default_currency is Money.default_currency.iso_code if not specified
+      # fixed_currency overrides default_currency if set
     end
 
 All Money values are converted and stored in mongo as cents and currency in two separate fields.

data/VERSION

@@ -1 +1 @@
-2.1.0
+3.0.0

data/gemfiles/mongoid2.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'mongoid', '~> 2.4.0'
+gem 'money'
+gem "rake", "~> 0.9.2.2"
+gem "rspec", "~> 2.11.0"
+gem "rdoc", "~> 3.12"
+gem "bundler"
+gem "jeweler", "~> 1.8.3"
+gem "simplecov", '>= 0.4.0', :require => false
+gem "database_cleaner", "~> 0.8.0"

data/gemfiles/mongoid3.gemfile

@@ -0,0 +1,11 @@
+source "http://rubygems.org"
+
+gem 'mongoid', '~> 3.0.0'
+gem 'money'
+gem "rake", "~> 0.9.2.2"
+gem "rspec", "~> 2.11.0"
+gem "rdoc", "~> 3.12"
+gem "bundler"
+gem "jeweler", "~> 1.8.3"
+gem "simplecov", '>= 0.4.0', :require => false
+gem "database_cleaner", "~> 0.8.0"

data/lib/mongoid_money_field.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require 'money'
 
 module Mongoid
@@ -9,27 +11,56 @@ module Mongoid
 
     module ClassMethods
 
-      def money_field_with_options(columns, opts = {})
+      def money_field(*columns)
+        opts = columns.last.is_a?(Hash) ? columns.pop : {}
+        opts = {
+            fixed_currency: nil,
+            default: nil,
+            required: false,
+            default_currency: nil
+        }.merge(opts)
+
         [columns].flatten.each do |name|
-          opts = {fixed_currency: nil, default: nil}.merge(opts)
+          default_money = nil
 
           if opts[:default].nil?
             default = nil
-            default_currency = ::Money.default_currency.iso_code if opts[:fixed_currency].nil?
           else
             default_money = Money.parse(opts[:default])
             default = default_money.cents
-            default_currency = default_money.currency.iso_code if opts[:fixed_currency].nil?
           end
 
           attr_cents = (name.to_s + '_cents').to_sym
-          field attr_cents, type: Integer, default: default
+          attr_currency = (name.to_s + '_currency').to_sym
 
+          field attr_cents, type: Integer, default: default
           if opts[:fixed_currency].nil?
-            attr_currency = (name.to_s + '_currency').to_sym
-            field attr_currency, type: String,  default: default_currency
+            default_currency = nil
+            if opts[:default_currency].nil?
+              unless default_money.nil?
+                default_currency = default_money.currency.iso_code
+              end
+            else
+              default_currency = opts[:default_currency]
+            end
+
+            field attr_currency, type: String, default: default_currency
+          end
+
+          if opts[:required]
+            validate do
+              cents = read_attribute(attr_cents)
+
+              if cents.nil?
+                errors.add(name, errors.generate_message(name, :error, default: "invalid value for #{name}"))
+              end
+              if opts[:fixed_currency].nil? && read_attribute(attr_currency).nil?
+                errors.add(name, errors.generate_message(name, :error, default: "invalid value for #{name} currency"))
+              end
+            end
           end
 
+
           define_method(name) do
             cents = read_attribute(attr_cents)
 
@@ -54,7 +85,15 @@ module Mongoid
               end
               nil
             else
-              money = value.to_money
+              if opts[:default_currency].nil?
+                money = value.to_money
+              else
+                old_default = Money.default_currency
+                Money.default_currency = Money::Currency.new(opts[:default_currency])
+                money = value.to_money
+                Money.default_currency = old_default
+              end
+
               write_attribute(attr_cents, money.cents)
               if opts[:fixed_currency].nil?
                 write_attribute(attr_currency, money.currency.iso_code)
@@ -64,14 +103,6 @@ module Mongoid
           end
         end
       end
-
-      def money_field(*columns)
-        money_field_with_options(columns, default: 0)
-      end
-      
-      def money_field_without_default(*columns)
-        money_field_with_options(columns)
-      end
     end
   end
 end

data/mongoid_money_field.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = "mongoid_money_field"
-  s.version = "2.1.0"
+  s.version = "3.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["glebtv"]
@@ -19,24 +19,29 @@ Gem::Specification.new do |s|
     ".document",
     ".rspec",
     ".rvmrc",
+    ".travis.yml",
     "Gemfile",
     "Gemfile.lock",
     "MIT-LICENSE.txt",
     "README.rdoc",
     "Rakefile",
     "VERSION",
+    "gemfiles/mongoid2.gemfile",
+    "gemfiles/mongoid3.gemfile",
     "lib/mongoid_money_field.rb",
     "mongoid_money_field.gemspec",
     "spec/money_spec.rb",
-    "spec/mongoid.yml",
     "spec/spec_helper.rb",
     "spec/support/dummy_embedded.rb",
     "spec/support/dummy_money.rb",
+    "spec/support/dummy_money_required.rb",
     "spec/support/dummy_money_with_default.rb",
     "spec/support/dummy_money_with_default_with_currency.rb",
     "spec/support/dummy_money_with_fixed_currency.rb",
     "spec/support/dummy_money_without_default.rb",
-    "spec/support/dummy_prices.rb"
+    "spec/support/dummy_override_default_currency.rb",
+    "spec/support/dummy_prices.rb",
+    "spec/support/dummy_with_default_currency.rb"
   ]
   s.homepage = "http://github.com/glebtv/mongoid_money_field"
   s.licenses = ["MIT"]
@@ -50,18 +55,18 @@ Gem::Specification.new do |s|
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<mongoid>, [">= 2.4.0"])
       s.add_runtime_dependency(%q<money>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_development_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_development_dependency(%q<simplecov>, [">= 0.4.0"])
       s.add_development_dependency(%q<database_cleaner>, ["~> 0.8.0"])
     else
       s.add_dependency(%q<mongoid>, [">= 2.4.0"])
       s.add_dependency(%q<money>, [">= 0"])
-      s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.11.0"])
       s.add_dependency(%q<rdoc>, ["~> 3.12"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.2.1"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
       s.add_dependency(%q<simplecov>, [">= 0.4.0"])
       s.add_dependency(%q<database_cleaner>, ["~> 0.8.0"])
@@ -69,9 +74,9 @@ Gem::Specification.new do |s|
   else
     s.add_dependency(%q<mongoid>, [">= 2.4.0"])
     s.add_dependency(%q<money>, [">= 0"])
-    s.add_dependency(%q<rspec>, ["~> 2.8.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.11.0"])
     s.add_dependency(%q<rdoc>, ["~> 3.12"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.2.1"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.3"])
     s.add_dependency(%q<simplecov>, [">= 0.4.0"])
     s.add_dependency(%q<database_cleaner>, ["~> 0.8.0"])

data/spec/money_spec.rb

@@ -1,9 +1,52 @@
+# coding: utf-8
+
 require 'spec_helper'
 
 describe Mongoid::MoneyField do
-  
+
+  describe 'when money field is required' do
+    it 'should be valid to save when field is filled in' do
+      dummy = DummyMoneyRequired.new
+      dummy.price = '$10'
+      dummy.should be_valid
+      dummy.save.should eq true
+    end
+
+    it 'should be not valid to save when field is not filled in' do
+      dummy = DummyMoneyRequired.new
+      dummy.should_not be_valid
+      dummy.errors.count.should eq 2
+      dummy.errors.messages[:price][0].should eq "invalid value for price"
+      dummy.errors.messages[:price][1].should eq "invalid value for price currency"
+      dummy.save.should eq false
+    end
+
+    it 'should be not valid to save when field is filled in but currency is not' do
+      dummy = DummyMoneyRequired.new
+      dummy.price_cents = 123
+      dummy.should_not be_valid
+      dummy.errors.count.should eq 1
+      dummy.errors.messages[:price][0].should eq "invalid value for price currency"
+      dummy.save.should eq false
+    end
+  end
+
+  describe 'when both default currency and fixed currency is specified' do
+    it 'should use fixed currency instead of default' do
+      DummyOverrideDefaultCurrency.create!(price: '1.23')
+      DummyOverrideDefaultCurrency.first.price.currency.iso_code.should eq 'GBP'
+    end
+  end
+
+  describe 'when default currency is specified' do
+    it 'should use it instead of Money.default_currency' do
+      DummyWithDefaultCurrency.create!(price: '1.23')
+      DummyWithDefaultCurrency.first.price.currency.iso_code.should eq 'EUR'
+      Money.default_currency.iso_code.should eq 'RUB'
+    end
+  end
+
   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'
@@ -99,7 +142,7 @@ describe Mongoid::MoneyField do
       dummy.price.currency.iso_code.should eq Money.default_currency.iso_code
       dummy.price.cents.should eq 100
       
-      dummy.price_nodef.should be_nil
+      dummy.price2.should be_nil
 
       dummy.price1.cents.should eq 0
     end

data/spec/spec_helper.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 require 'rspec'
@@ -15,8 +17,18 @@ Money.default_currency = Money::Currency.new("RUB")
 # Requires supporting files with custom matchers and macros, etc,
 # in ./support/ and its subdirectories.
 Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}
-Mongoid.load!("#{File.dirname(__FILE__)}/mongoid.yml", :test)
-Mongoid.logger = Logger.new($stdout)
+
+def mongoid3?
+  defined?(Mongoid::VERSION) && Gem::Version.new(Mongoid::VERSION) >= Gem::Version.new('3.0.0.rc')
+end
+
+Mongoid.configure do |config|
+  if mongoid3?
+    config.sessions[:default] = { :database => 'mongoid_money_field_test', :hosts => ['localhost:27017'] }
+  else
+    config.master = Mongo::Connection.new.db('mongoid_money_field_test')
+  end
+end
 
 DatabaseCleaner.orm = "mongoid"
 

data/spec/support/dummy_embedded.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 class DummyOrder
   include Mongoid::Document
   embeds_many :dummy_line_items

data/spec/support/dummy_money.rb

@@ -1,9 +1,10 @@
+# coding: utf-8
+
 class DummyMoney
   include Mongoid::Document
   include Mongoid::MoneyField
   
   field :description
   
-  money_field :price
-
+  money_field :price, default: 0
 end

data/spec/support/dummy_money_required.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+class DummyMoneyRequired
+  include Mongoid::Document
+  include Mongoid::MoneyField
+
+  field :description
+
+  money_field :price, required: true, default_currency: nil
+end

data/spec/support/dummy_money_with_default.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 class DummyMoneyWithDefault
   include Mongoid::Document
   include Mongoid::MoneyField
 
   field :description
 
-  money_field_with_options :price, default: 1.00
+  money_field :price, default: 1.00
 end

data/spec/support/dummy_money_with_default_with_currency.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 class DummyMoneyWithDefaultWithCurrency
   include Mongoid::Document
   include Mongoid::MoneyField
 
   field :description
 
-  money_field_with_options :price, default: '1.00 GBP'
+  money_field :price, default: '1.00 GBP'
 end

data/spec/support/dummy_money_with_fixed_currency.rb

@@ -1,8 +1,10 @@
+# coding: utf-8
+
 class DummyMoneyWithFixedCurrency
   include Mongoid::Document
   include Mongoid::MoneyField
 
   field :description
 
-  money_field_with_options :price, fixed_currency: 'GBP'
+  money_field :price, fixed_currency: 'GBP'
 end

data/spec/support/dummy_money_without_default.rb

@@ -1,9 +1,11 @@
+# coding: utf-8
+
 class DummyMoneyWithoutDefault
   include Mongoid::Document
   include Mongoid::MoneyField
   
   field :description
   
-  money_field_without_default :price
+  money_field :price
 
 end

data/spec/support/dummy_override_default_currency.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+class DummyOverrideDefaultCurrency
+  include Mongoid::Document
+  include Mongoid::MoneyField
+
+  field :description
+
+  money_field :price, required: true, default_currency: 'RUB', fixed_currency: 'GBP'
+end

data/spec/support/dummy_prices.rb

@@ -1,12 +1,13 @@
+# coding: utf-8
+
 class DummyPrices
   include Mongoid::Document
   include Mongoid::MoneyField
   
   field :description
   
-  money_field :price1, :price2, :price3
+  money_field :price1, default: 0
+  money_field :price2, :price3
 
-  money_field_with_options :price, default: 1.00
-  
-  money_field_without_default :price_nodef
+  money_field :price, default: 1.00
 end

data/spec/support/dummy_with_default_currency.rb

@@ -0,0 +1,10 @@
+# coding: utf-8
+
+class DummyWithDefaultCurrency
+  include Mongoid::Document
+  include Mongoid::MoneyField
+
+  field :description
+
+  money_field :price, default_currency: 'EUR'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mongoid_money_field
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.11.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.11.0
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -82,7 +82,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -90,7 +90,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.2.1
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -149,24 +149,29 @@ files:
 - .document
 - .rspec
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - MIT-LICENSE.txt
 - README.rdoc
 - Rakefile
 - VERSION
+- gemfiles/mongoid2.gemfile
+- gemfiles/mongoid3.gemfile
 - lib/mongoid_money_field.rb
 - mongoid_money_field.gemspec
 - spec/money_spec.rb
-- spec/mongoid.yml
 - spec/spec_helper.rb
 - spec/support/dummy_embedded.rb
 - spec/support/dummy_money.rb
+- spec/support/dummy_money_required.rb
 - spec/support/dummy_money_with_default.rb
 - spec/support/dummy_money_with_default_with_currency.rb
 - spec/support/dummy_money_with_fixed_currency.rb
 - spec/support/dummy_money_without_default.rb
+- spec/support/dummy_override_default_currency.rb
 - spec/support/dummy_prices.rb
+- spec/support/dummy_with_default_currency.rb
 homepage: http://github.com/glebtv/mongoid_money_field
 licenses:
 - MIT
@@ -182,7 +187,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1966677237532462947
+      hash: 2451846497476326695
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:

data/spec/mongoid.yml

@@ -1,6 +0,0 @@
-test:
-  sessions:
-    default:
-      database: mongoid_money_field
-      hosts:
-        - mg2.gleb.tv:27017