amountable 0.0.8 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21da815a77cf49ea8198ec6a9ee67072afed01a4
-  data.tar.gz: 525fec01a9c194b843de35586bc8959e0feeedeb
+  metadata.gz: a50976a37bd54567185d9369a702a40dd5b38795
+  data.tar.gz: df9bce5b74e8ce773e8b068787be2b80a2184234
 SHA512:
-  metadata.gz: 17529880cfb83aa122f7d2a78f9ec4ff5fb6aec4b168db82e697f2c5f8398519bd8bbc3d6d20631c75a7b7d24c9c54dc9e4f32283e61860d44d3ade1dfe63182
-  data.tar.gz: 5dcd1a9780767a74ade416770b254b425994dacc572eb05c71ac0950c186e394a2fb39645508794538252ee2fd6f9e73bcbc63fd9f40ebd152aed72ac7870b61
+  metadata.gz: f644fbc7e790baa2cb469b681e80bd0c1f5dfb461d0364b808fe0a414cb37cbf9513c6c9063de6803eb7dd4b26b97235f382fff620bf9522973f55f1c11cf190
+  data.tar.gz: 121c40b69da25971c5bcd59a2c7d385d26ea8e19e9d296e4054e24be18c93973cd910a80d2cc52ca736a2599f7bb860c14b9cfe50a74f0c6df119f52c828288b

data/README.md

@@ -40,6 +40,7 @@ Setup your model
 ```ruby
 class Order < ActiveRecord::Base
   include Amountable
+  act_as_amountable
   amount :subtotal, sets: [:total]
   amount :delivery_fee, sets: [:total, :fees]
   amount :bags_fee, sets: [:total, :fees]
@@ -48,6 +49,14 @@ class Order < ActiveRecord::Base
 end
 ```
 
+`act_as_amountable` can take the `storage` option:
+
+```
+  act_as_amountable storage: :table
+```
+
+where `storage` can be either `:table`, the `amounts` table will be used to store amounts, or `:jsonb`, a JSONB field will be used on the amountable object to store amounts are json. If you use the JSONB format, you can specify the name of the column with the `column` option. The default value for the `storage` option is `:table`.
+
 then create it
 
 ```ruby
@@ -74,3 +83,5 @@ When you run the migration, an `amounts` table will be created with a polymorphi
 When the an order is created with some amounts, the associated `Amount` objects are persisted.
 
 `Amount` objects are persisted in bulk, so there are no N + 1 queries. If an amount is zero, no `Amount` model is created.
+
+If you choose the JSONB storage option, the `amounts` table will not be used. Instead a JSONB column on the target model will be used.

data/lib/amountable.rb

@@ -4,31 +4,37 @@ module Amountable
   extend ActiveSupport::Autoload
   autoload :Amount
   autoload :VERSION
+  autoload :TableMethods
+  autoload :JsonbMethods
 
   class InvalidAmountName < StandardError; end
+  class MissingColumn < StandardError; end
+
+  ALLOWED_STORAGE = %i(table json).freeze
 
   def self.included(base)
 
     base.extend Amountable::ClassMethods
 
     base.class_eval do
-      has_many :amounts, as: :amountable, dependent: :destroy, autosave: false
       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'
 
       def all_amounts
         @all_amounts ||= amounts.to_set
       end
 
       def find_amount(name)
-        (@amounts_by_name ||= {})[name.to_sym] ||= all_amounts.find { |am| am.name == name.to_s }
+        (@amounts_by_name ||= {})[name.to_sym] ||= amounts.to_set.find { |am| am.name == name.to_s }
       end
 
       def find_amounts(names)
-        all_amounts.select { |am| names.include?(am.name.to_sym) }
+        amounts.to_set.select { |am| names.include?(am.name.to_sym) }
       end
 
       def validate_amount_names
@@ -49,48 +55,31 @@ module Amountable
           end
         end
       end
-
-      def save(args = {})
-        ActiveRecord::Base.transaction do
-          save_amounts if super(args)
-        end
-      end
-
-      def save!(args = {})
-        ActiveRecord::Base.transaction do
-          save_amounts! if super(args)
-        end
-      end
-
-      def save_amounts(bang: false)
-        amounts_to_insert = []
-        amounts.each do |amount|
-          if amount.new_record?
-            amount.amountable_id = self.id
-            amounts_to_insert << amount
-          else
-            bang ? amount.save! : amount.save
-          end
-        end
-        Amount.import(amounts_to_insert, timestamps: true, validate: false)
-        amounts_to_insert.each do |amount|
-          amount.instance_variable_set(:@new_record, false)
-        end
-        true
-      end
-
-      def save_amounts!; save_amounts(bang: true); end
-
     end
   end
 
   module ClassMethods
 
+    # Possible storage values: [:table, :jsonb]
+    def act_as_amountable(options = {})
+      case (options[:storage] || :table).to_sym
+      when :table
+        has_many :amounts, as: :amountable, dependent: :destroy, autosave: false
+        include Amountable::TableMethods
+      when :jsonb
+        self.amounts_column_name = options[:column].to_s if options[:column]
+        raise MissingColumn.new("You need an amounts jsonb field on the #{self.table_name} table.") unless column_names.include?(self.amounts_column_name)
+        include Amountable::JsonbMethods
+      else
+        raise ArgumentError.new("Please specify a storage: #{ALLOWED_STORAGE}")
+      end
+    end
+
     def amount_set(set_name, component)
       self.amount_sets[set_name.to_sym] << component.to_sym
 
       define_method set_name do
-        find_amounts(self.amount_sets[set_name.to_sym]).sum(Money.zero, &:value)
+        get_set(set_name)
       end
     end
 
@@ -98,22 +87,11 @@ module Amountable
       (self.amount_names ||= Set.new) << name
 
       define_method name do
-        (find_amount(name) || NilAmount.new).value
+        (find_amount(name) || ::NilAmount.new).value
       end
 
       define_method "#{name}=" do |value|
-        amount = find_amount(name) || amounts.build(name: name)
-        amount.value = value.to_money
-        if value.zero?
-          amounts.delete(amount)
-          all_amounts.delete(amount)
-          @amounts_by_name.delete(name)
-          amount.destroy if amount.persisted?
-        else
-          all_amounts << amount if amount.new_record?
-          (@amounts_by_name ||= {})[name.to_sym] = amount
-        end
-        value.to_money
+        set_amount(name, value)
       end
 
       Array(options[:summable] || options[:summables] || options[:set] || options[:sets] || options[:amount_set] || options[:amount_sets]).each do |set|

data/lib/amountable/amount.rb

@@ -9,6 +9,13 @@ class Amount < ActiveRecord::Base
   validates :name, presence: true
   validates :name, uniqueness: {scope: [:amountable_id, :amountable_type]}
 
+  attr_accessor :persistable
+
+  def save
+    raise StandardError.new("Can't persist amount to database") if persistable == false
+    super
+  end
+
   module Operations
 
     def +(other_value)

data/lib/amountable/jsonb_methods.rb

@@ -0,0 +1,51 @@
+# Copyright 2015-2016, Instacart
+
+module Amountable
+  module JsonbMethods
+    extend ActiveSupport::Autoload
+
+    def amounts
+      @_amounts ||= attribute(amounts_column_name).to_h['amounts'].to_h.map do |name, amount|
+        Amount.new(name: name, value_cents: amount['cents'], value_currency: amount['value_currency'], persistable: false, amountable: self)
+      end.to_set
+    end
+
+    def set_amount(name, value)
+      value = value.to_money
+      return value if value.zero?
+      initialize_column
+      amounts_json = attribute(amounts_column_name)
+      amounts_json['amounts'] ||= {}
+      amounts_json['amounts'][name.to_s] = {'cents' => value.fractional, 'currency' => value.currency.iso_code}
+      set_json(amounts_json)
+      @_amounts = nil
+      @amounts_by_name = nil
+      refresh_sets
+      value
+    end
+
+    def refresh_sets
+      initialize_column
+      amounts_json = attribute(amounts_column_name)
+      amounts_json['sets'] = {}
+      amount_sets.each do |name, amount_names|
+        sum = find_amounts(amount_names).sum(Money.zero, &:value)
+        amounts_json['sets'][name.to_s] = {'cents' => sum.fractional, 'currency' => sum.currency.iso_code}
+      end
+      set_json(amounts_json)
+    end
+
+    def get_set(name)
+      value = attribute(amounts_column_name).to_h['sets'].to_h[name.to_s].to_h
+      Money.new(value['cents'].to_i, value['currency'] || 'USD')
+    end
+
+    def set_json(json)
+      send("#{amounts_column_name}=", json)
+    end
+
+    def initialize_column
+      send("#{amounts_column_name}=", {}) if attribute(amounts_column_name).nil?
+    end
+  end
+end

data/lib/amountable/table_methods.rb

@@ -0,0 +1,58 @@
+# Copyright 2015-2016, Instacart
+
+module Amountable
+  module TableMethods
+    extend ActiveSupport::Autoload
+
+    def set_amount(name, value)
+      amount = find_amount(name) || amounts.build(name: name)
+      amount.value = value.to_money
+      if value.zero?
+        amounts.delete(amount)
+        all_amounts.delete(amount)
+        @amounts_by_name.delete(name)
+        amount.destroy if amount.persisted?
+      else
+        all_amounts << amount if amount.new_record?
+        (@amounts_by_name ||= {})[name.to_sym] = amount
+      end
+      amount.value
+    end
+
+    def save(args = {})
+      ActiveRecord::Base.transaction do
+        save_amounts if super(args)
+      end
+    end
+
+    def save!(args = {})
+      ActiveRecord::Base.transaction do
+        save_amounts! if super(args)
+      end
+    end
+
+    def save_amounts(bang: false)
+      amounts_to_insert = []
+      amounts.each do |amount|
+        if amount.new_record?
+          amount.amountable_id = self.id
+          amounts_to_insert << amount
+        else
+          bang ? amount.save! : amount.save
+        end
+      end
+      Amount.import(amounts_to_insert, timestamps: true, validate: false)
+      amounts_to_insert.each do |amount|
+        amount.instance_variable_set(:@new_record, false)
+      end
+      true
+    end
+
+    def save_amounts!; save_amounts(bang: true); end
+
+    def get_set(name)
+      find_amounts(self.amount_sets[name.to_sym]).sum(Money.zero, &:value)
+    end
+
+  end
+end

data/lib/amountable/version.rb

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

data/spec/amountable/amount_spec.rb

@@ -34,4 +34,8 @@ describe Amount do
     expect(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)
+  end
+
 end

data/spec/amountable/amountable_spec.rb

@@ -4,55 +4,85 @@ require 'spec_helper'
 
 describe Amountable do
 
-  it 'should' do
-    order = Order.new
-    expect { order.save }.not_to change { Amount.count }
-    %i(sub_total taxes total).each do |name|
-      expect(order.send(name)).to eq(Money.zero)
-    end
-    order.sub_total = Money.new(100)
-    expect(order.sub_total).to eq(Money.new(100))
-    expect(order.total).to eq(Money.new(100))
-    expect(order.all_amounts.size).to eq(1)
-    order.all_amounts.first.tap do |amount|
-      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(amount.persisted?).to be true
+  context 'storage == :table' do
+    it 'should' do
+      order = Order.new
+      expect { order.save }.not_to change { Amount.count }
+      %i(sub_total taxes total).each do |name|
+        expect(order.send(name)).to eq(Money.zero)
+      end
+      order.sub_total = Money.new(100)
+      expect(order.sub_total).to eq(Money.new(100))
+      expect(order.total).to eq(Money.new(100))
+      expect(order.all_amounts.size).to eq(1)
+      order.all_amounts.first.tap do |amount|
+        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(amount.persisted?).to be true
+      end
+      expect do
+        expect(order.update_attributes(sub_total: Money.new(200)))
+      end.not_to change { Amount.count }
     end
-    expect do
-      expect(order.update_attributes(sub_total: Money.new(200)))
-    end.not_to change { Amount.count }
-  end
 
-  describe 'name=' do
-    let (:order) { Order.create }
+    describe 'name=' do
+      let (:order) { Order.create }
 
-    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 }
-    end
+      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 }
+      end
 
-    it 'should not persist Money.zero if using ActiveRecord persistence' do
-      expect { order.update(sub_total: Money.zero) }.not_to change { 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 }
+      end
+
+      it 'should work with ActiveRecord#update' do
+        expect { order.update(sub_total: Money.new(1)) }.to change { Amount.count }.by(1)
+      end
 
-    it 'should work with ActiveRecord#update' do
-      expect { order.update(sub_total: Money.new(1)) }.to change { Amount.count }.by(1)
+      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.amounts.empty?).to be true
+      end
     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.amounts.empty?).to be true
+    it 'should insert amounts in bulk' do
+      order = Order.create
+      expect do
+        order.update(sub_total: Money.new(100), taxes: Money.new(200))
+      end.to make_database_queries(count: 1, manipulative: true)
     end
   end
 
-  it 'should insert amounts in bulk' do
-    order = Order.create
-    expect do
-      order.update(sub_total: Money.new(100), taxes: Money.new(200))
-    end.to make_database_queries(count: 1, manipulative: true)
+  context 'storage == :jsonb' do
+    it 'should' do
+      subscription = Subscription.new
+      expect { subscription.save }.not_to change { Amount.count }
+      expect(subscription.amounts).to eq(Set.new)
+      expect(subscription.attributes['amounts']).to be_nil
+      %i(sub_total taxes total).each do |name|
+        expect(subscription.send(name)).to eq(Money.zero)
+      end
+      subscription.sub_total = Money.new(100)
+      expect(subscription.sub_total).to eq(Money.new(100))
+      expect(subscription.attributes['amounts']).to eq({'amounts' => {'sub_total' => {'cents' => 100, 'currency' => 'USD'}}, 'sets' => {'total' => {'cents' => 100, 'currency' => 'USD'}}})
+      expect(subscription.total).to eq(Money.new(100))
+      expect(subscription.amounts.size).to eq(1)
+      subscription.amounts.first.tap do |amount|
+        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(amount.persisted?).to be false
+      end
+      subscription.update_attributes(sub_total: Money.new(200))
+      expect(subscription.sub_total).to eq(Money.new(200))
+      expect(subscription.total).to eq(Money.new(200))
+    end
   end
+
 end

data/spec/internal/app/models/order.rb

@@ -3,7 +3,7 @@
 class Order < ActiveRecord::Base
 
   include Amountable
-
+  act_as_amountable
   amount :sub_total, sets: [:total]
   amount :taxes, sets: [:total]
 

data/spec/internal/app/models/subscription.rb

@@ -0,0 +1,12 @@
+# Copyright 2015-2016, Instacart
+
+if jsonb_available?
+  class Subscription < ActiveRecord::Base
+
+    include Amountable
+    act_as_amountable storage: :jsonb
+    amount :sub_total, sets: [:total]
+    amount :taxes, sets: [:total]
+
+  end
+end

data/spec/internal/db/schema.rb

@@ -17,4 +17,12 @@ ActiveRecord::Schema.define do
     t.datetime "created_at"
     t.datetime "updated_at"
   end
+
+  if jsonb_available?
+    create_table "subscriptions", force: :cascade do |t|
+      t.datetime "created_at"
+      t.datetime "updated_at"
+      t.jsonb    "amounts"
+    end
+  end
 end

data/spec/support/database.rb

@@ -29,6 +29,16 @@ rescue
   ActiveRecord::Base.establish_connection(config)
 end
 
+def jsonb_available?
+  return @@jsonb_available if defined?(@@jsonb_available)
+  @@jsonb_available = if ActiveRecord::Base.connection.class.ancestors.include?(ActiveRecord::Import::PostgreSQLAdapter)
+    version = /PostgreSQL\s(\d+.\d+.\d+)\s/.match(ActiveRecord::Base.connection.execute("select version();")[0]['version'])[1].split('.').map(&:to_i)
+    version[0] >= 9 && version[1] >= 3
+  else
+    false
+  end
+end
+
 require_relative '../internal/db/schema'
 
 Dir[spec_dir.join('internal/app/models/*.rb')].each { |file| require_relative file }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: amountable
 version: !ruby/object:Gem::Version
-  version: 0.0.8
+  version: 0.1.0
 platform: ruby
 authors:
 - Emmanuel Turlay
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-07 00:00:00.000000000 Z
+date: 2016-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -209,11 +209,14 @@ files:
 - db/migrate/0_create_amounts.rb
 - lib/amountable.rb
 - lib/amountable/amount.rb
+- lib/amountable/jsonb_methods.rb
+- lib/amountable/table_methods.rb
 - lib/amountable/version.rb
 - spec/amountable/amount_spec.rb
 - spec/amountable/amountable_spec.rb
 - spec/amountable/nil_amount_spec.rb
 - spec/internal/app/models/order.rb
+- spec/internal/app/models/subscription.rb
 - spec/internal/config/database.yml
 - spec/internal/config/database.yml.sample
 - spec/internal/db/schema.rb
@@ -239,7 +242,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: Easy Money fields for your Rails models.
@@ -248,6 +251,7 @@ test_files:
 - spec/amountable/amountable_spec.rb
 - spec/amountable/nil_amount_spec.rb
 - spec/internal/app/models/order.rb
+- spec/internal/app/models/subscription.rb
 - spec/internal/config/database.yml
 - spec/internal/config/database.yml.sample
 - spec/internal/db/schema.rb