smerp-quotation 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f8b69d99e96beaa0d81e513065d9671cfafa11b57c91ff1d5e1ba782fe380c35
+  data.tar.gz: b85cba78f3e87c7edb171dc3da9120613b1464ee94f9fe4c6e87612cd1137052
+SHA512:
+  metadata.gz: f9e49a67d5fabd72016b5181cba6882965a94cf96a5a32df959ddd2422be90c0a5e1ed5ad352342b204cec9878d3731eefff8330aee3ced28140e566a7e39234
+  data.tar.gz: '081ba3ccd3a13a92f0e4f2d51646454704e2c2b51bc4f9f9001ebc26ac676720351083e4c23d24b67859fc886d13a0321d3733ef1f77a3dbeacdd43cd934a523'

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in smerp-quotation.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+#gem 'smerp-common', git: 'smerp-common', branch: 'master'
+#gem 'ca-data_store', git: 'ca-data_store', branch: 'master'
+#gem 'ca-data_store-ar', git: 'ca-data_store-ar', branch: 'master'
+

data/Gemfile.lock

@@ -0,0 +1,160 @@
+PATH
+  remote: .
+  specs:
+    smerp-quotation (0.1.0)
+      acts_as_list
+      acts_as_tree
+      ca-data_store
+      ca-data_store-ar
+      state_machines-activerecord
+      teLogger
+      toolrack
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actionpack (7.0.3.1)
+      actionview (= 7.0.3.1)
+      activesupport (= 7.0.3.1)
+      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)
+      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)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+    acts_as_list (1.0.4)
+      activerecord (>= 4.2)
+    acts_as_tree (2.9.1)
+      activerecord (>= 3.0.0)
+    base58 (0.2.3)
+    builder (3.2.4)
+    ca-data_store (0.1.0)
+      teLogger
+      toolrack
+    ca-data_store-ar (0.1.0)
+      activerecord
+      activesupport
+      ca-data_store
+      standalone_migrations
+      teLogger
+      toolrack
+    concurrent-ruby (1.1.10)
+    crass (1.0.6)
+    devops_assist (0.3.0)
+      git_cli
+      git_cli_prompt
+      gvcs
+      teLogger
+      toolrack
+      tty-prompt
+    diff-lcs (1.5.0)
+    erubi (1.11.0)
+    git_cli (0.10.0)
+      gvcs
+      ptools (~> 1.4.0)
+      teLogger
+      toolrack
+    git_cli_prompt (0.3.1)
+      teLogger
+      toolrack
+      tty-prompt
+    gvcs (0.1.0)
+    i18n (1.12.0)
+      concurrent-ruby (~> 1.0)
+    loofah (2.19.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    minitest (5.16.3)
+    nokogiri (1.13.8-x86_64-linux)
+      racc (~> 1.4)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    ptools (1.4.2)
+    racc (1.6.0)
+    rack (2.2.4)
+    rack-test (2.0.2)
+      rack (>= 1.3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      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)
+      method_source
+      rake (>= 12.2)
+      thor (~> 1.0)
+      zeitwerk (~> 2.5)
+    rake (13.0.6)
+    rspec (3.11.0)
+      rspec-core (~> 3.11.0)
+      rspec-expectations (~> 3.11.0)
+      rspec-mocks (~> 3.11.0)
+    rspec-core (3.11.0)
+      rspec-support (~> 3.11.0)
+    rspec-expectations (3.11.0)
+      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)
+    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)
+      rake (>= 10.0)
+    state_machines (0.5.0)
+    state_machines-activemodel (0.8.0)
+      activemodel (>= 5.1)
+      state_machines (>= 0.5.0)
+    state_machines-activerecord (0.8.0)
+      activerecord (>= 5.1)
+      state_machines-activemodel (>= 0.8.0)
+    teLogger (0.2.0)
+    thor (1.2.1)
+    toolrack (0.19.1)
+      base58
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.23.1)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    tzinfo (2.0.5)
+      concurrent-ruby (~> 1.0)
+    wisper (2.0.1)
+    zeitwerk (2.6.0)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devops_assist
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  smerp-quotation!
+  sqlite3
+
+BUNDLED WITH
+   2.2.28

data/README.md

@@ -0,0 +1,35 @@
+# Smerp::Quotation
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/smerp/quotation`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'smerp-quotation'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install smerp-quotation
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/smerp-quotation.

data/Rakefile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require 'devops_assist'
+
+require 'ca/data_store/ar'
+Ca::DataStore::Ar.load_tasks
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "smerp/quotation"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+Ca::DataStore::Ar.connect_database
+Ca::DataStore::Ar.show_log
+Ca::DataStore::Ar.load_model(File.join(File.dirname(__FILE__),"..","lib","smerp","quotation","ar_model"))
+
+include Smerp::Quotation
+include Smerp::Quotation::ArModel
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/database.yml

@@ -0,0 +1,5 @@
+
+
+development:
+  adapter: 'sqlite3'
+  database: 'quotation.sqlite'

data/db/config.yml

@@ -0,0 +1,5 @@
+
+
+development:
+  adapter: 'sqlite3'
+  database: 'quotation.sqlite'

data/db/migrate/20220901033002_create_quotations.rb

@@ -0,0 +1,40 @@
+
+class CreateQuotations < ActiveRecord::Migration[7.0]
+  def change 
+    create_table :quotations do |t|
+      t.string  :qid
+
+      t.string  :name
+      t.text    :address
+      t.string  :attention_to
+
+      t.text    :notes
+      t.string  :state, default: 'open'
+
+      # config specific to this quotation
+      t.text    :sqconfig
+
+      t.date    :qdate
+
+      t.datetime  :released_timestamp
+
+      t.decimal :total, default: 0.0
+
+      t.decimal :total_discount, default: 0.0
+      t.decimal :total_after_discount, default: 0.0
+
+      t.decimal :total_tax, default: 0.0
+      t.decimal :total_with_tax, default: 0.0
+
+      # standard calculator across all items
+      # such as discount, tax or rounding
+      t.text    :extended_calculators
+
+      t.text    :private_extended_calculators
+
+      t.text    :smerp_domain_info
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220901033007_create_quotation_items.rb

@@ -0,0 +1,69 @@
+
+class CreateQuotationItems < ActiveRecord::Migration[7.0]
+  def change 
+    create_table :quotation_items do |t|
+      
+      # group by quotation
+      t.string  :quotation_id 
+
+      # tree structure
+      t.string  :parent_id
+
+      # list structure
+      t.integer :position
+
+      # Item belongs in which group
+      t.string  :quotation_item_group_id
+
+      # link to source of the quotation (polymorphic)
+      # i.e. product or resource owner
+      t.string  :quotable_id
+      t.string  :quotable_type
+
+      t.string  :name
+      t.text    :notes
+
+      # flag to tell the model if update of
+      # parent field is required or not
+      # This allow manual intevention of user
+      # based details item being entered
+      t.integer :children_link, limit: 1, default: 1
+
+      # show this item in final quotation or not
+      #t.integer :show, limit: 1, default: 0
+
+      # value stored for display
+      t.decimal :quantity, default: 0.0
+      # value stored for display
+      t.string  :unit, default: "Unit(s)"
+      # value stored for display
+      # It is also the locked in value from other table such as product
+      t.decimal :unit_price, default: 0.0, precision: 25, scale: 2
+
+      t.string  :price_currency
+
+      # value stored for display
+      t.decimal :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 
+      # 1. Actual value in currency
+      # 2. Percentage from the total
+      # 3. Rounding on discounted amount
+      #t.text    :discount_calculation
+      t.decimal :line_total_after_discount, precision: 25, scale: 2, default: 0.0
+
+      t.decimal :tax, default: 0.0
+      # yaml hash structure indicate the tax code
+      # and its detail: exampted, x% etc
+      #t.text    :tax_calculation
+      t.decimal :line_total_with_tax, default: 0.0, precision: 25, scale: 2
+
+      t.text    :extended_calculators
+
+      t.text    :smerp_domain_info
+
+      t.timestamps
+    end
+  end
+end

data/db/migrate/20220918121051_create_quotation_item_groups.rb

@@ -0,0 +1,34 @@
+
+class CreateQuotationItemGroups < ActiveRecord::Migration[7.0]
+  def change 
+    create_table :quotation_item_groups do |t|
+      
+      t.string  :name
+
+      t.string  :quotation_id
+
+      # tree structure
+      t.string  :parent_id
+
+      # list structure
+      t.integer :position
+
+      # show this group name in quotation to customer?
+      #t.integer :show_name, limit: 1, default: 0
+
+      # show this group total in quotation to customer?
+      #t.integer :show_total, limit: 1, default: 0
+
+      t.decimal :group_total, default: 0.0, precision: 25, scale: 2
+
+      t.decimal :group_discount, default: 0.0, precision: 25, scale: 2
+
+      t.decimal :group_tax, default: 0.0, precision: 25, scale: 2
+
+      t.text    :smerp_domain_info
+
+      t.timestamps
+      
+    end
+  end
+end

data/db/migrate/20220922121503_create_tax_category.rb

@@ -0,0 +1,20 @@
+
+class CreateTaxCategory < ActiveRecord::Migration[7.0]
+  def change 
+    create_table :tax_category do |t|
+
+      t.string    :name
+      
+      t.string    :display_code
+
+      t.decimal   :tax, default: 0.0
+      t.text      :formula
+      t.string    :state, default: 'active'
+
+      t.text      :smerp_domain_info
+
+      t.timestamps
+
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+
+
+module Smerp
+  module Quotation
+
+    module ArModel
+      class Quotation < Ca::DataStore::Ar::Model
+        include TR::CondUtils
+
+        include TeLogger::TeLogHelper
+        teLogger_tag :quotMdl
+        
+        has_many :quotation_items, dependent: :destroy
+
+        belongs_to :customer, polymorphic: true
+
+        has_many :quotation_item_groups, dependent: :destroy
+
+        validates_uniqueness_of :qid, allow_blank: true, case_sensitive: false
+
+        # polymorphic on model of customer/vendor
+        # has_many :quotations, as: :customer
+        
+        after_initialize :set_date
+        def set_date
+          self.qdate = Time.now.utc if self.new_record?
+        end
+
+        before_save :trigger_extended_calculations
+
+        state_machine initial: :open do
+
+          after_transition :open => :released do |q,st|
+            q.released_timestamp = Time.now
+          end
+
+          event :release do
+            transition :open => :released
+          end
+
+        end
+
+        def add_ext_cal(cal)
+          if self.extended_calculators.nil?
+            res = [] 
+          else
+            res = YAML.load(self.extended_calculators)
+          end
+
+          cal.owner = :quotation
+          cal.owner_id = self.id if not self.new_record?
+
+          res << cal
+
+          self.extended_calculators = YAML.dump(res)
+        end
+
+        def add_priv_ext_cal(cal)
+          if self.private_extended_calculators.nil?
+            res = [] 
+          else
+            res = YAML.load(self.private_extended_calculators)
+          end
+
+          res << cal
+
+          self.private_extended_calculators = YAML.dump(res)
+        end
+
+        def inheritable_extended_calculators
+          if not_empty?(self.extended_calculators) 
+            YAML.load(self.extended_calculators)
+          else
+            []
+          end
+        end
+
+        def trigger_extended_calculations
+       
+          privExtCal = self.private_extended_calculators
+          if not_empty?(privExtCal)
+
+            privExtCal = YAML.load(privExtCal)
+
+            cals = []
+            privExtCal.each do |ec|
+
+              if self.send("#{ec.input_field}_changed?")
+                teLogger.debug "Executing extended calculator : #{ec.inspect}"
+                ec.calculate(self)
+              end
+
+              cals << ec.for_storage
+
+            end
+
+            self.private_extended_calculators = YAML.dump(cals)
+          end
+
+        end
+
+        def recalculate
+          # call by calculator after processing
+        end
+
+      end # class Quotation
+    end
+
+  end
+end
+