amountable 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a50976a37bd54567185d9369a702a40dd5b38795
-  data.tar.gz: df9bce5b74e8ce773e8b068787be2b80a2184234
+  metadata.gz: 70fd4bd67ff8f0f3c0a67ea5701fb035934c3a8f
+  data.tar.gz: 3a7f3ce3ff221dcbe13378f3ebe18958385e787d
 SHA512:
-  metadata.gz: f644fbc7e790baa2cb469b681e80bd0c1f5dfb461d0364b808fe0a414cb37cbf9513c6c9063de6803eb7dd4b26b97235f382fff620bf9522973f55f1c11cf190
-  data.tar.gz: 121c40b69da25971c5bcd59a2c7d385d26ea8e19e9d296e4054e24be18c93973cd910a80d2cc52ca736a2599f7bb860c14b9cfe50a74f0c6df119f52c828288b
+  metadata.gz: b785e2e1a02a280a3e6125c4e3731b1281eb02760a17405f669e1d1669d089131a3c9e01cc084ffa2bc6673ca3721dcc5060c974e892aaad973d2deb2d3097a8
+  data.tar.gz: 3063523fcfa424dc576bdb2ad3cf7a2e2eca9378098cde60a06fbb150d40c8a6313ab7e4cd77f6a6c51e04ed9ecc8b1c0b3d2a38e9a849fc80fb51a3c96b32f3

data/README.md

@@ -39,7 +39,6 @@ Setup your model
 
 ```ruby
 class Order < ActiveRecord::Base
-  include Amountable
   act_as_amountable
   amount :subtotal, sets: [:total]
   amount :delivery_fee, sets: [:total, :fees]

data/lib/amountable.rb

@@ -2,7 +2,9 @@
 
 module Amountable
   extend ActiveSupport::Autoload
+  autoload :Operations
   autoload :Amount
+  autoload :NilAmount
   autoload :VERSION
   autoload :TableMethods
   autoload :JsonbMethods
@@ -13,46 +15,38 @@ module Amountable
   ALLOWED_STORAGE = %i(table json).freeze
 
   def self.included(base)
-
     base.extend Amountable::ClassMethods
+  end
 
-    base.class_eval do
-      validate :validate_amount_names
-      class_attribute :amount_names
-      class_attribute :amount_sets
-      class_attribute :amounts_column_name
-      self.amount_sets = Hash.new { |h, k| h[k] = Set.new }
-      self.amount_names = Set.new
-      self.amounts_column_name = 'amounts'
+  module InstanceMethods
 
-      def all_amounts
-        @all_amounts ||= amounts.to_set
-      end
+    def all_amounts
+      @all_amounts ||= amounts.to_set
+    end
 
-      def find_amount(name)
-        (@amounts_by_name ||= {})[name.to_sym] ||= amounts.to_set.find { |am| am.name == name.to_s }
-      end
+    def find_amount(name)
+      (@amounts_by_name ||= {})[name.to_sym] ||= amounts.to_set.find { |am| am.name == name.to_s }
+    end
 
-      def find_amounts(names)
-        amounts.to_set.select { |am| names.include?(am.name.to_sym) }
-      end
+    def find_amounts(names)
+      amounts.to_set.select { |am| names.include?(am.name.to_sym) }
+    end
 
-      def validate_amount_names
-        amounts.each do |amount|
-          errors.add(:amounts, "#{amount.name} is not an allowed amount name.") unless self.class.allowed_amount_name?(amount.name)
-        end
+    def validate_amount_names
+      amounts.each do |amount|
+        errors.add(:amounts, "#{amount.name} is not an allowed amount name.") unless self.class.allowed_amount_name?(amount.name)
       end
+    end
 
-      def serializable_hash(opts = nil)
-        opts ||= {}
-        super(opts).tap do |base|
-          unless opts[:except].to_a.include?(:amounts)
-            amounts_json = (self.class.amount_names + self.class.amount_sets.keys).inject({}) do |mem, name|
-              mem.merge!(name.to_s => send(name).to_f) unless opts[:except].to_a.include?(name.to_sym)
-              mem
-            end
-            base.merge!(amounts_json)
+    def serializable_hash(opts = nil)
+      opts ||= {}
+      super(opts).tap do |base|
+        unless opts[:except].to_a.include?(:amounts)
+          amounts_json = (self.class.amount_names + self.class.amount_sets.keys).inject({}) do |mem, name|
+            mem.merge!(name.to_s => send(name).to_f) unless opts[:except].to_a.include?(name.to_sym)
+            mem
           end
+          base.merge!(amounts_json)
         end
       end
     end
@@ -62,9 +56,15 @@ module Amountable
 
     # Possible storage values: [:table, :jsonb]
     def act_as_amountable(options = {})
+      class_attribute :amount_names
+      class_attribute :amount_sets
+      class_attribute :amounts_column_name
+      self.amount_sets = Hash.new { |h, k| h[k] = Set.new }
+      self.amount_names = Set.new
+      self.amounts_column_name = 'amounts'
       case (options[:storage] || :table).to_sym
       when :table
-        has_many :amounts, as: :amountable, dependent: :destroy, autosave: false
+        has_many :amounts, class_name: 'Amountable::Amount', as: :amountable, dependent: :destroy, autosave: false
         include Amountable::TableMethods
       when :jsonb
         self.amounts_column_name = options[:column].to_s if options[:column]
@@ -73,6 +73,8 @@ module Amountable
       else
         raise ArgumentError.new("Please specify a storage: #{ALLOWED_STORAGE}")
       end
+      validate :validate_amount_names
+      include Amountable::InstanceMethods
     end
 
     def amount_set(set_name, component)
@@ -87,7 +89,7 @@ module Amountable
       (self.amount_names ||= Set.new) << name
 
       define_method name do
-        (find_amount(name) || ::NilAmount.new).value
+        (find_amount(name) || Amountable::NilAmount.new).value
       end
 
       define_method "#{name}=" do |value|
@@ -105,3 +107,7 @@ module Amountable
 
   end
 end
+
+ActiveSupport.on_load(:active_record) do
+  include Amountable
+end

data/lib/amountable/amount.rb

@@ -1,49 +1,23 @@
 # Copyright 2015-2016, Instacart
 
-class Amount < ActiveRecord::Base
+module Amountable
+  class Amount < ActiveRecord::Base
 
-  belongs_to :amountable, polymorphic: true
+    include Amountable::Operations
 
-  monetize :value_cents
+    belongs_to :amountable, polymorphic: true
 
-  validates :name, presence: true
-  validates :name, uniqueness: {scope: [:amountable_id, :amountable_type]}
+    monetize :value_cents
 
-  attr_accessor :persistable
+    validates :name, presence: true
+    validates :name, uniqueness: {scope: [:amountable_id, :amountable_type]}
 
-  def save
-    raise StandardError.new("Can't persist amount to database") if persistable == false
-    super
-  end
-
-  module Operations
-
-    def +(other_value)
-      value + other_value.to_money
-    end
-
-    def -(other_value)
-      value - other_value.to_money
-    end
-
-    def *(multiplier)
-      value * multiplier
-    end
-
-    def /(divisor)
-      value / divisor
-    end
+    attr_accessor :persistable
 
-    def to_money
-      value
+    def save
+      raise StandardError.new("Can't persist amount to database") if persistable == false
+      super
     end
 
   end
-  include Operations
-end
-
-class NilAmount
-  include Amount::Operations
-  def value; Money.zero; end
-  def amountable; nil; end
-end
+end

data/lib/amountable/nil_amount.rb

@@ -0,0 +1,9 @@
+# Copyright 2015-2016, Instacart
+
+module Amountable
+  class NilAmount
+    include Amountable::Operations
+    def value; Money.zero; end
+    def amountable; nil; end
+  end
+end

data/lib/amountable/operations.rb

@@ -0,0 +1,27 @@
+# Copyright 2015-2016, Instacart
+
+module Amountable
+  module Operations
+
+    def +(other_value)
+      value + other_value.to_money
+    end
+
+    def -(other_value)
+      value - other_value.to_money
+    end
+
+    def *(multiplier)
+      value * multiplier
+    end
+
+    def /(divisor)
+      value / divisor
+    end
+
+    def to_money
+      value
+    end
+
+  end
+end

data/lib/amountable/version.rb

@@ -1,5 +1,5 @@
 # Copyright 2015-2016, Instacart
 
 module Amountable
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/amountable/amount_spec.rb

@@ -2,20 +2,20 @@
 
 require 'spec_helper'
 
-describe Amount do
+describe Amountable::Amount do
 
   it 'should validate name presence' do
-    Amount.new.tap do |amount|
+    subject.tap do |amount|
       expect(amount.valid?).to be false
       expect(amount.errors[:name]).not_to be nil
     end
   end
 
   it 'should validate name uniqueness' do
-    Amount.new(name: 'test', amountable_id: 1, amountable_type: 'Amountable').tap do |amount|
+    Amountable::Amount.new(name: 'test', amountable_id: 1, amountable_type: 'Amountable').tap do |amount|
       expect(amount.valid?).to be true
       amount.save
-      Amount.new(name: 'test', amountable_id: 2, amountable_type: 'Amountable').tap do |other_amount|
+      Amountable::Amount.new(name: 'test', amountable_id: 2, amountable_type: 'Amountable').tap do |other_amount|
         expect(other_amount.valid?).to be true
         other_amount.amountable_id = amount.amountable_id
         expect(other_amount.valid?).to be false
@@ -25,17 +25,17 @@ describe Amount do
   end
 
   it 'should have operations' do
-    expect(Amount.new(value: Money.new(1)) + Amount.new(value: Money.new(2))).to eq(Money.new(3))
-    expect(Amount.new(value: Money.new(1)) + 0.02).to eq(Money.new(3))
-    expect(Amount.new(value: Money.new(2)) - Amount.new(value: Money.new(1))).to eq(Money.new(1))
-    expect(Amount.new(value: Money.new(2)) - 0.01).to eq(Money.new(1))
-    expect(Amount.new(value: Money.new(2)) * 3).to eq(Money.new(6))
-    expect(Amount.new(value: Money.new(6)) / 3).to eq(Money.new(2))
-    expect(Amount.new(value: Money.new(2)).to_money).to eq(Money.new(2))
+    expect(Amountable::Amount.new(value: Money.new(1)) + Amountable::Amount.new(value: Money.new(2))).to eq(Money.new(3))
+    expect(Amountable::Amount.new(value: Money.new(1)) + 0.02).to eq(Money.new(3))
+    expect(Amountable::Amount.new(value: Money.new(2)) - Amountable::Amount.new(value: Money.new(1))).to eq(Money.new(1))
+    expect(Amountable::Amount.new(value: Money.new(2)) - 0.01).to eq(Money.new(1))
+    expect(Amountable::Amount.new(value: Money.new(2)) * 3).to eq(Money.new(6))
+    expect(Amountable::Amount.new(value: Money.new(6)) / 3).to eq(Money.new(2))
+    expect(Amountable::Amount.new(value: Money.new(2)).to_money).to eq(Money.new(2))
   end
 
   it 'should not save if not persistable' do
-    expect { Amount.new(persistable: false).save }.to raise_exception(StandardError)
+    expect { subject.new(persistable: false).save }.to raise_exception(StandardError)
   end
 
 end

data/spec/amountable/amountable_spec.rb

@@ -7,7 +7,7 @@ describe Amountable do
   context 'storage == :table' do
     it 'should' do
       order = Order.new
-      expect { order.save }.not_to change { Amount.count }
+      expect { order.save }.not_to change { Amountable::Amount.count }
       %i(sub_total taxes total).each do |name|
         expect(order.send(name)).to eq(Money.zero)
       end
@@ -19,12 +19,12 @@ describe Amountable do
         expect(amount.name).to eq('sub_total')
         expect(amount.value).to eq(Money.new(100))
         expect(amount.new_record?).to be true
-        expect { order.save }.to change { Amount.count }.by(1)
+        expect { order.save }.to change { Amountable::Amount.count }.by(1)
         expect(amount.persisted?).to be true
       end
       expect do
         expect(order.update_attributes(sub_total: Money.new(200)))
-      end.not_to change { Amount.count }
+      end.not_to change { Amountable::Amount.count }
     end
 
     describe 'name=' do
@@ -32,20 +32,20 @@ describe Amountable do
 
       it 'should not persist Money.zero' do
         expect(order.sub_total = Money.zero).to eq(Money.zero)
-        expect { order.save }.not_to change { Amount.count }
+        expect { order.save }.not_to change { Amountable::Amount.count }
       end
 
       it 'should not persist Money.zero if using ActiveRecord persistence' do
-        expect { order.update(sub_total: Money.zero) }.not_to change { Amount.count }
+        expect { order.update(sub_total: Money.zero) }.not_to change { Amountable::Amount.count }
       end
 
       it 'should work with ActiveRecord#update' do
-        expect { order.update(sub_total: Money.new(1)) }.to change { Amount.count }.by(1)
+        expect { order.update(sub_total: Money.new(1)) }.to change { Amountable::Amount.count }.by(1)
       end
 
       it 'should destroy Amount if exist and assigning Money.zero' do
         order.update(sub_total: Money.new(1))
-        expect { order.sub_total = Money.zero }.to change { Amount.count }.by(-1)
+        expect { order.sub_total = Money.zero }.to change { Amountable::Amount.count }.by(-1)
         expect(order.amounts.empty?).to be true
       end
     end
@@ -61,7 +61,7 @@ describe Amountable do
   context 'storage == :jsonb' do
     it 'should' do
       subscription = Subscription.new
-      expect { subscription.save }.not_to change { Amount.count }
+      expect { subscription.save }.not_to change { Amountable::Amount.count }
       expect(subscription.amounts).to eq(Set.new)
       expect(subscription.attributes['amounts']).to be_nil
       %i(sub_total taxes total).each do |name|
@@ -76,7 +76,7 @@ describe Amountable do
         expect(amount.name).to eq('sub_total')
         expect(amount.value).to eq(Money.new(100))
         expect(amount.new_record?).to be true
-        expect { subscription.save }.not_to change { Amount.count }
+        expect { subscription.save }.not_to change { Amountable::Amount.count }
         expect(amount.persisted?).to be false
       end
       subscription.update_attributes(sub_total: Money.new(200))

data/spec/amountable/nil_amount_spec.rb

@@ -2,24 +2,24 @@
 
 require 'spec_helper'
 
-describe NilAmount do
+describe Amountable::NilAmount do
 
   it 'should return 0' do
-    expect(NilAmount.new.value).to eq(Money.zero)
+    expect(subject.value).to eq(Money.zero)
   end
 
   it 'should have nil amountable' do
-    expect(NilAmount.new.amountable).to be nil
+    expect(subject.amountable).to be nil
   end
 
   it 'should have operations' do
-    expect(NilAmount.new + Amount.new(value: Money.new(2))).to eq(Money.new(2))
-    expect(NilAmount.new + 0.02).to eq(Money.new(2))
-    expect(NilAmount.new - Amount.new(value: Money.new(1))).to eq(Money.new(-1))
-    expect(NilAmount.new - 0.01).to eq(Money.new(-1))
-    expect(NilAmount.new * 3).to eq(Money.zero)
-    expect(NilAmount.new / 3).to eq(Money.zero)
-    expect(NilAmount.new.to_money).to eq(Money.zero)
+    expect(subject + Amountable::Amount.new(value: Money.new(2))).to eq(Money.new(2))
+    expect(subject + 0.02).to eq(Money.new(2))
+    expect(subject - Amountable::Amount.new(value: Money.new(1))).to eq(Money.new(-1))
+    expect(subject - 0.01).to eq(Money.new(-1))
+    expect(subject * 3).to eq(Money.zero)
+    expect(subject / 3).to eq(Money.zero)
+    expect(subject.to_money).to eq(Money.zero)
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amountable
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Emmanuel Turlay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-04 00:00:00.000000000 Z
+date: 2016-10-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -210,6 +210,8 @@ files:
 - lib/amountable.rb
 - lib/amountable/amount.rb
 - lib/amountable/jsonb_methods.rb
+- lib/amountable/nil_amount.rb
+- lib/amountable/operations.rb
 - lib/amountable/table_methods.rb
 - lib/amountable/version.rb
 - spec/amountable/amount_spec.rb