unidom-inventory 0.6 → 0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59116b8cfb8504d2ff15c7ff9afa640d77542afc
-  data.tar.gz: 9df508c0df726dfb5b350d36dadea5a21bbae35a
+  metadata.gz: 35d04ff352b48b18c1a0d73de2221a123e203b62
+  data.tar.gz: 0a05c18f72d67c5a0d3b874b44bf23f0fce24a52
 SHA512:
-  metadata.gz: f24af042b909c72252e548c4958894850108f9cc8097db04d2e33ea81650e00b0a14ab64351174f11ab5e2fdfb65f3e93e5faa4d98a14b831070dc36faacd821
-  data.tar.gz: 49e7eca834921f0c1e8663c58301256ae87e6be4936f67f0b7200900e7fe648b323812c1d2a8102f70c64fbe1f9945ca4ea300076894447541e757709928e061
+  metadata.gz: b57410f0fe3215aebcbcaf07b0963e2ee93f8d32975c7bd2a339be7658ccf6d29687ce47493175ec3d1b207b47284e8db5d368c93a73214a5ff5f4833ed5c4d0
+  data.tar.gz: dd5f8cc480b4a8f3be19540efa99654e2f2bf926466cc7e2cece7f80a85a7f87a0775ab850eee63c2e07b8a227bcbe228bbcec92b70f826de0e2bc6bea54fff9

data/README.md

@@ -50,9 +50,9 @@ pick_item    = pick_list.items.create! inventory_item: grouped_inventory_item, q
 item_issuing = Unidom::Inventory::ItemIssuing.create! pick_item: pick_item, inventory_item: grouped_inventory_item, target_item: nil
 # target_item could be nil or any model like: shipment item or order item
 
-variance = Unidom::Inventory::InventoryItemVariance.create! inventory_item: grouped_inventory_item, reason: nil, opened_at: Time.now
+Unidom::Inventory::InventoryItemVariance.adjust! @inventory_item, quantity: 1, due_to: nil, at: Time.now, description: nil, instruction: nil
 # or the following source code do the exact same thing.
-grouped_inventory_item.variances.create! quantity: 10, reason: nil, opened_at: Time.now
+grouped_inventory_item.is_adjusted! 10, due_to: nil, at: Time.now, description: nil, instruction: nil
 ```
 
 
@@ -65,21 +65,22 @@ include Unidom::Inventory::AsInventoryItem
 
 ### As Inventory Item concern
 
-The As Inventory Item concern do the following tasks for the includer automatically: 
+The As Inventory Item concern do the following tasks for the includer automatically:  
 1. Define the belongs_to :stored macro as: ``belongs_to :stored, polymorphic: true``  
 2. Define the belongs_to :store macro as: ``belongs_to :store, polymorphic: true``  
 3. Define the belongs_to :lot macro as: ``belongs_to :lot, class_name: 'Unidom::Inventory::Lot'``  
-4. Define the has_many :pick_items macro as: ``has_many :pick_items, class_name: 'Unidom::Inventory::PickItem', as: :inventory_item``
-5. Define the has_many :variances macro as: ``has_many :variances, class_name: 'Unidom::Inventory::InventoryItemVariance', as: :inventory_item``
+4. Define the has_many :pick_items macro as: ``has_many :pick_items, class_name: 'Unidom::Inventory::PickItem', as: :inventory_item``  
+5. Define the has_many :variances macro as: ``has_many :variances, class_name: 'Unidom::Inventory::InventoryItemVariance', as: :inventory_item``  
+6. Define the #is_adjusted! method as: ``is_adjusted!(quantity, due_to: nil, at: Time.now, description: nil, instruction: nil)``
 
 ### As Store concern
 
-The As Store concern do the following tasks for the includer automatically: 
+The As Store concern do the following tasks for the includer automatically:  
 1. Define the has_many :grouped_inventory_items macro as: ``has_many :grouped_inventory_items, class_name: 'Unidom::Inventory::GroupedInventoryItem', foreign_key: :store_id``  
 2. Define the has_many :serialized_inventory_items macro as: ``has_many :serialized_inventory_items, class_name: 'Unidom::Inventory::SerializedInventoryItem', foreign_key: :store_id``
 
 ### As Stored concern
 
-The As Stored concern do the following tasks for the includer automatically: 
+The As Stored concern do the following tasks for the includer automatically:  
 1. Define the has_many :grouped_inventory_items macro as: ``has_many :grouped_inventory_items, class_name: 'Unidom::Inventory::GroupedInventoryItem', foreign_key: :stored_id``  
 2. Define the has_many :serialized_inventory_items macro as: ``has_many :serialized_inventory_items, class_name: 'Unidom::Inventory::SerializedInventoryItem', foreign_key: :stored_id``

data/app/models/unidom/inventory/concerns/as_inventory_item.rb

@@ -11,6 +11,20 @@ module Unidom::Inventory::Concerns::AsInventoryItem
     has_many :pick_items, class_name: 'Unidom::Inventory::PickItem',              as: :inventory_item
     has_many :variances,  class_name: 'Unidom::Inventory::InventoryItemVariance', as: :inventory_item
 
+    def is_adjusted!(quantity: nil, due_to: nil, at: Time.now, description: nil, instruction: nil)
+      if respond_to? :quantity
+        increment! :quantity, quantity
+      else
+        if quantity.nil?
+          quantity = -1
+          soft_destroy
+        else
+          raise ArgumentError.new('The quantity should be nil when Inventory Item Variance is adjusted.')
+        end
+      end
+      variances.create! inventory_item: self, reason: due_to, quantity: quantity, description: description, instruction: instruction, opened_at: at
+    end
+
   end
 
   module ClassMethods

data/app/models/unidom/inventory/inventory_item_variance.rb

@@ -17,4 +17,18 @@ class Unidom::Inventory::InventoryItemVariance < ActiveRecord::Base
   scope :inventory_item_is, ->(inventory_item) { where inventory_item: inventory_item }
   scope :caused_by,         ->(reason)         { where reason:         reason         }
 
+  def self.adjust!(inventory_item, quantity: nil, due_to: nil, at: Time.now, description: nil, instruction: nil)
+    if inventory_item.respond_to? :quantity
+      inventory_item.increment! :quantity, quantity
+    else
+      if quantity.nil?
+        quantity = -1
+        inventory_item.soft_destroy
+      else
+        raise ArgumentError.new('The quantity should be -1 when Inventory Item Variance adjusts a Serialized Inventory Item.')
+      end
+    end
+    create! inventory_item: inventory_item, reason: due_to, quantity: quantity, description: description, instruction: instruction, opened_at: at
+  end
+
 end

data/lib/unidom/inventory/version.rb

@@ -1,5 +1,5 @@
 module Unidom
   module Inventory
-    VERSION = '0.6'.freeze
+    VERSION = '0.7'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: unidom-inventory
 version: !ruby/object:Gem::Version
-  version: '0.6'
+  version: '0.7'
 platform: ruby
 authors:
 - Topbit Du
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-10 00:00:00.000000000 Z
+date: 2016-10-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unidom-common