smerp-quotation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8b69d99e96beaa0d81e513065d9671cfafa11b57c91ff1d5e1ba782fe380c35
-  data.tar.gz: b85cba78f3e87c7edb171dc3da9120613b1464ee94f9fe4c6e87612cd1137052
+  metadata.gz: 9b31b97876363a1e89cf5bfd87e092f304d3a0d873d222a28ac9669473ed53c9
+  data.tar.gz: 758df4aba6b9319126334fd2d8b7af834bd1f582ef77c5bb14ab8180008c5c09
 SHA512:
-  metadata.gz: f9e49a67d5fabd72016b5181cba6882965a94cf96a5a32df959ddd2422be90c0a5e1ed5ad352342b204cec9878d3731eefff8330aee3ced28140e566a7e39234
-  data.tar.gz: '081ba3ccd3a13a92f0e4f2d51646454704e2c2b51bc4f9f9001ebc26ac676720351083e4c23d24b67859fc886d13a0321d3733ef1f77a3dbeacdd43cd934a523'
+  metadata.gz: 0a465d9ce3167cb1d782f9fbdf8d277be35fe554238da074c431b2235c7a446522ccec29d4a4afe3d8555c0a22999ad7282e5aefcc969ab7e1900ddb684af6ab
+  data.tar.gz: c4b6557dc0e7fe67c3daa382d0a147e968f5b4dab7e5a3a8a9fbaa53dff2bb5e6aeed47a74d5ee15a2db181a8861e4637b64983937a1811f7074135d805bccd4

data/.release_history.yml

@@ -0,0 +1,4 @@
+---
+smerp-quotation:
+- :version: 0.1.0
+  :timestamp: 1664514502.3722005

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    smerp-quotation (0.1.0)
+    smerp-quotation (0.2.0)
       acts_as_list
       acts_as_tree
       ca-data_store
       ca-data_store-ar
+      smerp-common
       state_machines-activerecord
       teLogger
       toolrack
@@ -13,25 +14,25 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (7.0.3.1)
-      actionview (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
+    actionpack (7.0.4)
+      actionview (= 7.0.4)
+      activesupport (= 7.0.4)
       rack (~> 2.0, >= 2.2.0)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (7.0.3.1)
-      activesupport (= 7.0.3.1)
+    actionview (7.0.4)
+      activesupport (= 7.0.4)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activerecord (7.0.3.1)
-      activemodel (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
-    activesupport (7.0.3.1)
+    activemodel (7.0.4)
+      activesupport (= 7.0.4)
+    activerecord (7.0.4)
+      activemodel (= 7.0.4)
+      activesupport (= 7.0.4)
+    activesupport (7.0.4)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -45,7 +46,7 @@ GEM
     ca-data_store (0.1.0)
       teLogger
       toolrack
-    ca-data_store-ar (0.1.0)
+    ca-data_store-ar (0.1.1)
       activerecord
       activesupport
       ca-data_store
@@ -94,9 +95,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.4.3)
       loofah (~> 2.3)
-    railties (7.0.3.1)
-      actionpack (= 7.0.3.1)
-      activesupport (= 7.0.3.1)
+    railties (7.0.4)
+      actionpack (= 7.0.4)
+      activesupport (= 7.0.4)
       method_source
       rake (>= 12.2)
       thor (~> 1.0)
@@ -108,14 +109,17 @@ GEM
       rspec-mocks (~> 3.11.0)
     rspec-core (3.11.0)
       rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rspec-expectations (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-mocks (3.11.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    sqlite3 (1.4.4)
+    rspec-support (3.11.1)
+    smerp-common (0.1.0)
+      teLogger
+      toolrack
+    sqlite3 (1.5.1-x86_64-linux)
     standalone_migrations (7.1.0)
       activerecord (>= 4.2.7, < 7.1.0, != 5.2.3.rc1, != 5.2.3)
       railties (>= 4.2.7, < 7.1.0, != 5.2.3.rc1, != 5.2.3)

data/db/migrate/20220901033007_create_quotation_items.rb

@@ -44,6 +44,9 @@ class CreateQuotationItems < ActiveRecord::Migration[7.0]
 
       # value stored for display
       t.decimal :line_total, default: 0.0, precision: 25, scale: 2
+     
+      # total including the distributed items included
+      t.decimal :consolidated_line_total, default: 0.0, precision: 25, scale: 2
 
       t.decimal :discount, precision: 25, scale: 2, default: 0.0
       # yaml hash structure indicate the discount is 

data/db/migrate/20220930231854_create_quotation_item_distribution.rb

@@ -0,0 +1,22 @@
+
+class CreateQuotationItemDistribution < ActiveRecord::Migration[7.0]
+  def change 
+    create_table :quotation_item_distributions do |t|
+
+      t.string  :quotation_item_id
+      t.string  :distributed_quotation_item_id
+      t.text    :distribution_calculations
+
+      t.decimal :distributed_line_total, default: 0.0
+
+      t.decimal :distributed_discount, default: 0.0
+      t.decimal :distributed_line_total_after_discount, default: 0.0
+
+      t.decimal :distributed_tax, default: 0.0
+      t.decimal :distributed_line_total_with_tax, default: 0.0
+
+      t.timestamps
+
+    end
+  end
+end

data/lib/smerp/quotation/ar_model/quotation_item.rb

@@ -22,23 +22,40 @@ module Smerp
         # polymorphic on model of products / resources
         # has_many :quotation_items, as: :quotable
 
+        # sel-reflecting relationship
+        # This item splited into how many items?
+        has_many  :quotation_item_distributions
+        has_many  :destination_quotation_items, through: :quotation_item_distributions, source: :distributed_quotation_item
+
+        # This item is included distribution from which item?
+        has_many  :source_quotation_items_link, class_name: "QuotationItemDistribution", foreign_key: "distributed_quotation_item_id"
+        has_many  :source_quotation_items, through: :source_quotation_items_link, source: :quotation_item
+
         belongs_to :quotation_item_group, optional: true
 
         before_save :update_total
         after_save :update_group_total, :update_quotation_total 
 
         before_destroy :update_total
-        after_destroy :update_group_total, :update_quotation_total 
+        after_destroy :update_group_total, :update_quotation_total, :remove_total_from_destination_quotation_items
 
         def update_total
 
-          if children.length == 0
+          if self.children.length == 0
             self.line_total = self.quantity * self.unit_price  if self.quantity_changed? or self.unit_price_changed? 
             self.line_total_after_discount = self.line_total 
             self.line_total_with_tax = self.line_total
+
+            #teLogger.debug "sync consolidated #{self.inspect} to line_total #{self.line_total.to_i}"
+            self.consolidated_line_total = self.line_total if self.new_record?
+            #teLogger.debug "sync consolidated #{self.inspect} to line_total #{self.line_total.to_i}"
+
+          else
+            #teLogger.debug "#{self.inspect} has children : #{self.children}"
           end
 
           if self.quantity_changed?
+            teLogger.debug "Quantity changed"
             # Change unit_price for record that has children
             # since unit_price is 'derived' from children's line_total
             if self.quantity > 0
@@ -49,6 +66,17 @@ module Smerp
             end
           end
 
+          #teLogger.debug "Before recalculate : #{self.inspect}"
+          ## Calculate consolidated line total
+          # Calculate line total of each item that push to this parent item
+          if not self.new_record?
+            recalculate_total_from_source_quotation_items
+          end
+          #teLogger.debug "After recalculate : #{self.inspect}"
+
+          # 
+          # Start trigger defined calculators
+          #
           res = { local: [], quotation: [] }
           extCals = { local: [], quotation: [] }
           if not_empty?(self.extended_calculators)
@@ -112,7 +140,9 @@ module Smerp
           }
 
           self.extended_calculators = YAML.dump(res)
+          ## Calculator execution completed
 
+          teLogger.debug "before save done : #{self.inspect}"
         end
 
         def update_group_total
@@ -120,7 +150,7 @@ module Smerp
           grp = self.quotation_item_group
           if not grp.nil?
             # update total
-            grp.group_total = grp.children.sum(:group_total) + grp.quotation_items.sum(:line_total)
+            grp.group_total = grp.children.sum(:group_total) + grp.quotation_items.sum(:consolidated_line_total)
             grp.group_discount = grp.children.sum(:group_discount) + grp.quotation_items.sum(:discount)
             grp.group_tax = grp.children.sum(:group_tax) + grp.quotation_items.sum(:tax)
             grp.save
@@ -143,21 +173,22 @@ module Smerp
               if self.parent.quantity > 0
                 # for children item that has a parent
                 # update parent line_total
-                self.parent.line_total = self.parent.children.sum(:line_total)
+                self.parent.consolidated_line_total = self.parent.children.sum(:consolidated_line_total)
 
                 # update unit_price since line_total is sum of children's line_total
-                self.parent.unit_price = self.parent.line_total / self.parent.quantity
+                self.parent.unit_price = self.parent.consolidated_line_total / self.parent.quantity
 
                 self.parent.discount = self.parent.children.sum(:discount)
                 self.parent.line_total_after_discount = self.parent.children.sum(:line_total_after_discount)
                 self.parent.tax = self.parent.children.sum(:tax)
                 self.parent.line_total_with_tax = self.parent.children.sum(:line_total_with_tax)
 
-                teLogger.debug "After update from children : #{self.parent.inspect}"
+                #teLogger.debug "After update from children : #{self.parent.inspect}"
 
               else
 
                 self.parent.line_total = 0.0
+                self.parent.consolidated_line_total = 0.0
                 self.parent.unit_price = 0.0
                 self.parent.discount = 0.0
                 self.parent.line_total_after_discount = 0.0
@@ -171,15 +202,19 @@ module Smerp
               teLogger.debug "Parent #{self.parent.inspect} is NOT children linked. Skipping children update to parent." 
             end
 
-          end
+          end # if parent exist
+
+          # calculate if I'm the source to be embedded into other items
+          recalculate_total_to_destination_quotation_items
 
-          self.quotation.total = self.quotation.quotation_items.where(["parent_id is null"]).sum(:line_total)
+          self.quotation.total = self.quotation.quotation_items.where(["parent_id is null"]).sum(:consolidated_line_total)
           self.quotation.total_discount = self.quotation.quotation_items.where(["parent_id is null"]).sum(:discount)
           self.quotation.total_after_discount = self.quotation.quotation_items.where(["parent_id is null"]).sum(:line_total_after_discount)
           self.quotation.total_tax = self.quotation.quotation_items.where(["parent_id is null"]).sum(:tax)
           self.quotation.total_with_tax = self.quotation.quotation_items.where(["parent_id is null"]).sum(:line_total_with_tax)
 
           self.quotation.save
+
         end
 
 
@@ -187,6 +222,9 @@ module Smerp
           
           if self.quantity_changed? or self.unit_price_changed?
             self.line_total = self.quantity * self.unit_price
+            # reset consolidated total and calculate again
+            self.consolidated_line_total = self.line_total
+            calculate_incoming_distribution
           end
 
           if self.discount_changed?
@@ -195,24 +233,121 @@ module Smerp
 
         end
 
+        # recalculate becauase destionation line_total changed
+        # triggered before_save
+        def recalculate_total_from_source_quotation_items
+
+          #self.reload
+          ttl = self.line_total
+          self.source_quotation_items_link.each do |iqi|
+
+            srcItm = iqi.quotation_item
+
+            next if srcItm.nil?
+
+            #teLogger.debug "Calculating using source item : #{srcItm.inspect}"
+            cal = YAML.load(iqi.distribution_calculations)
+            cal.calculate(srcItm)
+
+            teLogger.debug "Distribution calculation : #{cal.result}"
+
+            ttl += cal.result[Smerp::Quotation::DistributionCalculator::DistributedAmount]
+
+            iqi.distribution_calculations = YAML.dump(cal.for_storage)
+            iqi.save
+
+          end
+
+          self.consolidated_line_total = ttl
+          
+        end
+
+        # recalculate because the source item line_total changed
+        # trigger after_save
+        def recalculate_total_to_destination_quotation_items
+    
+          #teLogger.debug "before get in : #{self.inspect}"
+          self.quotation_item_distributions.each do |qid|
+           
+            citm = qid.distributed_quotation_item
+
+            # for some reasons when one of the item is deleted first
+            # but the connection is not reloaded. 
+            # Reload before coming in doesn't really solve the issue
+            next if citm.nil?
+
+            #teLogger.debug "citm : #{citm.inspect}"
+            cal = YAML.load(qid.distribution_calculations)
+            # get the old figure
+            oldRes = cal.result.clone
+            teLogger.debug "oldRes : #{oldRes}"
+            # calculate base on 
+            #teLogger.debug "Self is : #{self.inspect}"
+            cal.calculate(self)
+            newRes = cal.result
+            teLogger.debug "newRes : #{newRes}"
+
+            #teLogger.debug "citm before process : #{citm.consolidated_line_total}"
+            citm.consolidated_line_total = (citm.consolidated_line_total - oldRes[Smerp::Quotation::DistributionCalculator::DistributedAmount] + newRes[Smerp::Quotation::DistributionCalculator::DistributedAmount])
+            #teLogger.debug "citm after process : #{citm.consolidated_line_total}"
+
+            qid.distribution_calculations = YAML.dump(cal.for_storage)
+            qid.save
+
+            # trigger other calculations
+            citm.save
+
+          end
+
+        end
+
+        # item that is being distributed to other
+        # quotation items is being destroyed
+        # Remove those portion from each and every items
+        def remove_total_from_destination_quotation_items
+
+          self.quotation_item_distributions.each do |qid|
+           
+            citm = qid.distributed_quotation_item
+
+            next if citm.nil?
+
+            cal = YAML.load(qid.distribution_calculations)
+            extRes = cal.result.clone
+
+            #teLogger.debug "before citm #{citm.inspect} / #{citm.consolidated_line_total}"
+            citm.consolidated_line_total = (citm.consolidated_line_total - extRes[Smerp::Quotation::DistributionCalculator::DistributedAmount])
+            #teLogger.debug "after deduction citm #{citm.inspect} / #{citm.consolidated_line_total}"
+
+            #teLogger.debug "qid : #{qid.inspect}"
+            qid.destroy
+
+            citm.source_quotation_items_link.reload
+
+            citm.save
+            #teLogger.debug "after citm #{citm.inspect} / #{citm.consolidated_line_total}"
+
+          end
+          
+        end
+
+        def total_distributed
+         
+          ttl = 0.0
+          self.quotation_item_distributions.each do |qid|
+            cal = YAML.load(qid.distribution_calculations)
+            ttl += cal.result[Smerp::Quotation::DistributionCalculator::DistributedAmount]
+          end
+
+          ttl
+
+        end
+
+        def balance_after_distribution
+          bal = self.line_total - self.total_distributed
+          { balance_amount: bal, balance_percentage: bal.percent_of(self.line_total) }
+        end
 
-        #def children
-        #  if @_children.nil?
-        #    @_children = QuotationItem.where(["parent_id = ?",self.id])
-        #  end
-        #  @_children
-        #end
-
-        #def parent
-        #  if self.parent_id.nil?
-        #    nil
-        #  else
-        #    if @_parent.nil?
-        #      @_parent = QuotationItem.find(self.parent_id)
-        #    end
-        #    @_parent
-        #  end
-        #end
 
         def break_children_link
 
@@ -410,6 +545,23 @@ module Smerp
         end
 
 
+        def distribute_to(distTo, val)
+       
+          dist = QuotationItemDistribution.new
+          dist.quotation_item = self
+          dist.distributed_quotation_item_id = distTo.quotation_item.id
+          cal = Smerp::Quotation::DistributionCalculator.new(val)
+          cal.input_field = :consolidated_line_total
+          dist.distribution_calculations = YAML.dump(cal.for_storage)
+          dist.save
+
+          # trigger the calculator and distribution calculations
+          distTo.save
+          distTo.reload
+
+        end
+
+
       end
     end
   end

data/lib/smerp/quotation/ar_model/quotation_item_distribution.rb

@@ -0,0 +1,31 @@
+
+
+module Smerp
+  module Quotation
+    module ArModel
+      
+      class QuotationItemDistribution < Ca::DataStore::Ar::Model
+        include TR::CondUtils
+
+        belongs_to :quotation_item
+        belongs_to :distributed_quotation_item, class_name: 'QuotationItem'
+
+
+        #after_save :distribute
+
+        #def distribute
+
+        #  cal = YAML.load(self.distribution_calculators)
+        #  cal.calculate(self.quotation_item)
+
+        #  self.distributed_quotation_item.consolidated_line_total += cal.result[Smerp::Quotation::DistributionCalculator::DistributedValue]
+
+        #  self.distributed_quotation_item.save
+
+        #end
+
+      end
+
+    end
+  end
+end

data/lib/smerp/quotation/calculators/distribution_calculator.rb

@@ -0,0 +1,73 @@
+
+
+
+module Smerp
+  module Quotation
+    class DistributionCalculator
+      include ExtendedCalculator
+      include TR::CondUtils
+
+      include TeLogger::TeLogHelper
+      teLogger_tag :distributionCal
+
+      DistributedAmount = :distributed_amount
+      ValueWithDistribution = :value_with_distribution
+
+
+      def calculate(mdl)
+        
+        srcVal = mdl.send(@input_field)
+        if not_empty?(srcVal)
+
+          srcVal = srcVal.to_f
+
+          res = { input: @input_field, input_value: srcVal }
+          case @params
+          when Smerp::Common::FinUtils::Percent
+            res[DistributedAmount] = srcVal * @params.rep_value
+          when Smerp::Common::FinUtils::RawValue
+            res[DistributedAmount] = @params.rep_value
+          else
+            res[DistributedAmount] = @params.to_f
+          end
+
+          res[ValueWithDistribution] = srcVal + res[DistributedAmount]
+
+          #if not_empty?(@output_field) and not outMdl.nil?
+
+          #  case @output_field
+          #  when Array
+          #    @output_field.each do |of|
+          #      of.each do |f, v|
+          #        outMdl.send("#{f}=", res[v])
+          #      end
+          #    end
+          #  when Hash
+          #    @output_field.each do |f,v|
+          #      outMdl.send("#{f}=", res[v])
+          #    end
+          #  when Symbol
+          #    outMdl.send("#{@output_field}=", res[DistributedAmount])
+          #  end
+
+          #  res[:output] = @output_field
+          #  res[:output_model] = outMdl
+          #  outMdl.recalculate
+
+          #end # if @output_field not empty
+
+          @result = res
+
+          trigger_listener(:after_calculation, mdl)
+
+          teLogger.debug "Distribution calculation log : #{res}"
+
+          @result
+
+        end
+
+      end
+
+    end
+  end
+end

data/lib/smerp/quotation/version.rb

@@ -2,6 +2,6 @@
 
 module Smerp
   module Quotation
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

data/schema.rb

@@ -10,7 +10,20 @@
 #
 # It's strongly recommended that you check this file into your version control system.
 
-ActiveRecord::Schema[7.0].define(version: 20220922121503548314) do
+ActiveRecord::Schema[7.0].define(version: 2022_09_30_231854) do
+  create_table "quotation_item_distributions", force: :cascade do |t|
+    t.string "quotation_item_id"
+    t.string "distributed_quotation_item_id"
+    t.text "distribution_calculations"
+    t.decimal "distributed_line_total", default: "0.0"
+    t.decimal "distributed_discount", default: "0.0"
+    t.decimal "distributed_line_total_after_discount", default: "0.0"
+    t.decimal "distributed_tax", default: "0.0"
+    t.decimal "distributed_line_total_with_tax", default: "0.0"
+    t.datetime "created_at", null: false
+    t.datetime "updated_at", null: false
+  end
+
   create_table "quotation_item_groups", force: :cascade do |t|
     t.string "name"
     t.string "quotation_id"
@@ -35,10 +48,11 @@ ActiveRecord::Schema[7.0].define(version: 20220922121503548314) do
     t.text "notes"
     t.integer "children_link", limit: 1, default: 1
     t.decimal "quantity", default: "0.0"
-    t.string "unit", default: "unit(s)"
+    t.string "unit", default: "Unit(s)"
     t.decimal "unit_price", precision: 25, scale: 2, default: "0.0"
     t.string "price_currency"
     t.decimal "line_total", precision: 25, scale: 2, default: "0.0"
+    t.decimal "consolidated_line_total", precision: 25, scale: 2, default: "0.0"
     t.decimal "discount", precision: 25, scale: 2, default: "0.0"
     t.decimal "line_total_after_discount", precision: 25, scale: 2, default: "0.0"
     t.decimal "tax", default: "0.0"

data/smerp-quotation.gemspec

@@ -37,6 +37,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'acts_as_tree'
   spec.add_dependency 'acts_as_list'
 
+  spec.add_dependency 'smerp-common'
   spec.add_dependency 'ca-data_store'
   spec.add_dependency 'ca-data_store-ar'
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smerp-quotation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ian
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-09-30 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: toolrack
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: smerp-common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: ca-data_store
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +157,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".release_history.yml"
 - ".rspec"
 - Gemfile
 - Gemfile.lock
@@ -156,12 +171,15 @@ files:
 - db/migrate/20220901033007_create_quotation_items.rb
 - db/migrate/20220918121051_create_quotation_item_groups.rb
 - db/migrate/20220922121503_create_tax_category.rb
+- db/migrate/20220930231854_create_quotation_item_distribution.rb
 - lib/smerp/quotation.rb
 - lib/smerp/quotation/ar_model/quotation.rb
 - lib/smerp/quotation/ar_model/quotation_item.rb
+- lib/smerp/quotation/ar_model/quotation_item_distribution.rb
 - lib/smerp/quotation/ar_model/quotation_item_group.rb
 - lib/smerp/quotation/ar_model/tax_category.rb
 - lib/smerp/quotation/calculators/discount_calculator.rb
+- lib/smerp/quotation/calculators/distribution_calculator.rb
 - lib/smerp/quotation/calculators/round_up_calculator.rb
 - lib/smerp/quotation/calculators/tax_calculator.rb
 - lib/smerp/quotation/extended_calculator.rb