stockor 0.1.5

data/db/seed/chart_of_accounts.yml

@@ -0,0 +1,168 @@
+# Asset Accounts
+-
+  number: 1000
+  name: Cash
+  description: Cash on hand and held in bank accounts
+-
+  number: 1010
+  name: Deposit Holding
+  description: Cash and equivalent waiting for deposit
+-
+  number: 1110
+  name: Inventory
+  description: Inventory on hand and awaiting sale
+-
+  number: 1115
+  name: Inventory in Transist
+  description: Inventory on a transfer between locations
+  
+-
+  number: 1200
+  name: Accounts Receivable
+  description: Amounts owed to the company for services performed or products sold but not yet paid for.
+-
+  number: 1300
+  name: Prepayment Revenue
+  description: Amounts received in advance of providing goods and services but not yet delivered.
+-
+  number: 1750	
+  name: Buildings
+  description: Cost to purchase or construct buildings for use by the company.
+-
+  number: 1800
+  name: Equipment
+  description: Cost to acquire and prepare equipment for use by the company.
+-
+  number: 1900
+  name: Sales Tax Received
+  description: Amount received for sales tax.
+
+#  Liability Accounts
+
+-
+  number: 2100
+  name: Notes Payable
+  description: Balance due on outstanding loans
+-
+  number: 2200
+  name: Accounts Payable
+  description: Amount owed to suppliers for goods and services
+-
+  number: 2300
+  name: Wages Payable
+  description: Amount owed to employees for hours worked but not yet paid. 
+
+-
+  number: 2400
+  name: Sales Tax
+  description: Sales tax expense
+
+-
+  number: 2500
+  name: Interest Payable
+  description: Amount owed for interest on Notes Payable.
+
+- 
+  number: 2600
+  name: Inventory Receipts Clearing
+  description: Inventory received but vendor invoice not yet confirmed
+
+# Equity Accounts
+
+-
+  number: 3100
+  name: Capital
+  description: Amount the invested in the company (through cash or other assets) plus earnings of the company not withdrawn by the owner.
+-
+  number: 3200
+  name: Drawing
+  description: Profit draws by owner
+
+# Revenue Accounts
+-
+  number: 4100
+  name: Sales
+  description: Amounts earned from selling physical goods.
+
+-
+  number: 4200
+  name: Service Revenues
+  description: Amounts earned from providing services to clients.
+
+# Cost of Goods
+-
+  number: 5100
+  name: Inventory Costs
+  description: Cost of Goods Sold
+
+-
+  number: 5150
+  name: Transfer Costs
+  description: Goods in transit on a transfer
+
+# Expenses
+-
+  number: 6100
+  name: Advertising Expense
+  description: Costs incurred by the company during the accounting period for ads, promotions, and other selling and expenses (other than salaries).
+
+-
+  number: 6200
+  name: Salaries Expense
+  description: Expenses incurred for the work performed by employees.
+-
+  number: 6300
+  name: Supplies Expense
+  description: Cost of supplies used up during the accounting period.
+-
+  number: 6310
+  name: Lost Supplies Expense
+  description: Supplies that have been physicaly misplaced and cannot be found
+-
+  number: 6320
+  name: Damaged Supplies Expense
+  description: Supplies that have been damaged and were disposed of
+-
+  number: 6410
+  name: Outbound Shipping Expense
+  description: Cost of shipping goods to customers
+
+-
+  number: 6420
+  name: Inbound Shipping Expense
+  description: Cost of vendors shipping goods to us
+
+-
+  number: 6500
+  name: Depreciation Expense
+  description: Cost of long-term assets allocated to expense during the current accounting period.
+
+-
+  number: 6600
+  name: Rent Expense
+  description: Cost of occupying rented facilities during the accounting period.
+-
+  number: 6700
+  name: Utilities Expense
+  description: Costs for electricity, heat, water, and sewer that were used during the accounting period.
+-
+  number: 6750
+  name: IT Expense
+  description: Cost of maintaining information systems
+-
+  number: 6760
+  name: Telephone Expense
+  description: Cost of telephone used during the current accounting period.
+
+#  Other Revenues
+-
+  number: 7100
+  name: Non operating Revenue
+  description: Revenue realized by other means
+
+#  Other Expense
+-
+  number: 8100
+  name: Non operating Expense
+  description: Expense incurred by other means
+

data/db/seed/payment_terms.yml

@@ -0,0 +1,60 @@
+-
+  code: CREDCARD
+  description: Payment due at time of sale with credit card
+  days: 0
+  discount_days: 0
+  discount_amount: 0
+-
+  code: CHECK
+  description: Payment due at time of sale by check
+  days: 0
+  discount_days: 0
+  discount_amount: 0
+-
+  code: CASH
+  description: Payment due at time of sale with cash
+  days: 0
+  discount_days: 0
+  discount_amount: 0
+-
+  code: NET10
+  description: Payment due in 10 days, no discount for early payment
+  days: 10
+  discount_days: 0
+  discount_amount: 0
+
+-
+  code: NET15
+  description: Payment due in 15 days, no discount for early payment
+  days: 15
+  discount_days: 0
+  discount_amount: 0
+
+-
+  code: NET30
+  description: Payment due in 30 days, no discount for early payment
+  days: 30
+  discount_days: 0
+  discount_amount: 0
+
+-
+  code: NET45
+  description: Payment due in 45 days, no discount for early payment
+  days: 45
+  discount_days: 0
+  discount_amount: 0
+
+-
+  code: NET60
+  description: Payment due in 60 days, no discount for early payment
+  days: 60
+  discount_days: 0
+  discount_amount: 0
+
+-
+  code: 2P10NET30
+  description: Payment due in 30 days, 2 % discount if payed with 10 days
+  days: 30
+  discount_days: 10
+  discount_amount: 2
+

data/db/seed.rb

@@ -0,0 +1,29 @@
+require 'pathname'
+require 'yaml'
+require_relative '../lib/skr'
+
+
+module Skr
+
+    user = Lanes::User.where(login: 'admin').first!
+    Lanes::User.scoped_to(user) do
+        seeds_path = Pathname.new(__FILE__).dirname.join('seed')
+
+        unless Location.default
+            Location.create( code: Skr.config.default_location_code, name: "System default",
+              address: Address.new(name:"System default")
+            )
+        end
+
+        YAML::load( seeds_path.join('chart_of_accounts.yml').read ).each do | acct_data |
+            GlAccount.where(number: acct_data['number'].to_s).any? || GlAccount.create!(acct_data)
+        end
+
+        YAML::load( seeds_path.join('payment_terms.yml').read ).each do | acct_data |
+            PaymentTerm.where(code: acct_data['code'].to_s).any? || PaymentTerm.create!(acct_data)
+        end
+
+
+    end
+
+end

data/lib/skr/access_roles.rb

@@ -0,0 +1,28 @@
+require 'lanes/access'
+
+module Lanes::Access
+    module Roles
+
+
+        # re-open the exising Support role
+        class Support
+            grant Skr::Customer
+        end
+
+
+        class Accounting < Lanes::Access::Role
+            grant Skr::Customer, Skr::PaymentTerm
+
+            lock_writes Skr::Customer, :terms_id
+        end
+
+
+        class Purchasing < Lanes::Access::Role
+            self.read  << Skr::Customer
+        end
+
+    end
+
+    Role.grant_global_access(:read, Skr::PaymentTerm)
+
+end

data/lib/skr/concerns/acts_as_uom.rb

@@ -0,0 +1,47 @@
+module Skr
+    module Concerns
+
+        # @see ClassMethods
+        module ActsAsUOM
+
+            extend ActiveSupport::Concern
+
+            module ClassMethods
+                def acts_as_uom( opts = {})
+                    include InstanceMethods
+
+                    export_methods :ea_qty, :combined_uom, :optional=>false
+                end
+            end
+
+            module InstanceMethods
+                def combined_uom
+                    if self.uom_size.nil? || self.uom_code.nil?
+                        ''
+                    elsif 1 == self.uom_size
+                        self.uom_code
+                    else
+                        "#{self.uom_code}/#{self.uom_size}"
+                    end
+                end
+
+                def ea_qty
+                    self.uom_size * self.qty
+                end
+
+                def uom=(uom)
+                    self.uom_size = uom.size
+                    self.uom_code = uom.code
+                end
+
+                def uom
+                    Uom.new({ size: self.uom_size, code: self.uom_code })
+                end
+
+            end
+
+        end
+
+    end
+
+end

data/lib/skr/concerns/code_identifier.rb

@@ -0,0 +1,43 @@
+module Skr
+    module Concerns
+
+        # @see ClassMethods
+        module CodeIdentifier
+
+            extend ActiveSupport::Concern
+
+            # ### Code Identifier Concern
+            # This adds the {#has_code_identifier} class method
+            module ClassMethods
+
+                # A 2-10 character string that identifies an entity, such as a Customer, Vendor, or SKU.
+                # The code is often assigned by the user, but may also
+                # be auto-generated by {Skr::Strings.code_identifier}
+                #
+                # @param max_length [Integer] how long the code is allowed to be
+                # @param from [Symbol], method to call for a string to base the code upon
+                def has_code_identifier( from: nil, max_length: 10 )
+
+                    validates :code, :length=>2..max_length, :presence=>true, :uniqueness=>true
+
+                    alias_attribute :record_identifier, :code
+
+                    if from
+                        before_validation(:on=>:create) do
+                            source = self[from]
+                            unless source.blank?
+                                self.code ||= Skr::Strings.code_identifier( source, length:max_length )
+                            end
+                        end
+                    end
+
+                    before_validation do
+                        self.code = self.code.upcase unless self.code.blank?
+                    end
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/gl_tran_extensions.rb

@@ -0,0 +1,18 @@
+module Skr
+    module Concerns
+
+        module GlTran
+
+            module Postings
+
+                def total
+                    total = BigDecimal.new('0')
+                    each{ |pst| total+=pst.amount }
+                    total
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/has_gl_transaction.rb

@@ -0,0 +1,67 @@
+require 'active_record/validations'
+
+module Skr
+
+    class InvalidGlTransaction < ActiveRecord::RecordInvalid
+    end
+
+
+    module Concerns
+
+        module HasGlTransaction
+
+            extend ActiveSupport::Concern
+
+            module InstanceMethods
+
+                # N.B. We are overriding ActiveRecord::Base#save
+                # This is so we can wrap the save call inside a {GlTransaction.record} block
+                # which will collect any GlPostings and then collapse them down at the end of the block
+                # in order to prevent multiple postings to the same account.
+                def save(*)
+                    opts = options_for_gl_transaction
+                    # do nothing if the options specified an if clause and the method returns false
+                    if opts.present? and opts.has_key?(:if) and self.send( opts[:if] ) == false
+                        super
+                    else
+                        save_status = false
+                        # First we wrap it up in our transaction since we don't have the benefit of
+                        # save's rollback_active_record_state! block
+                        # I'm tempted to appropriate it's usage, but am not since it's not documented (that I've found)
+                        # and is thus likely to change
+                        GlTransaction.transaction( requires_new: true ) do
+                            # Enclose in GlTransaction#record block
+                            gl_transaction = GlTransaction.record do
+                                save_status = super # ActiveRecord::Base#save
+                                # If save was successfull, pass attributes back to GlTransaction#record.
+                                # Otherwise pass false back so it knows to not save the GlTransaction
+                                save_status ? { attributes: self.send( opts[:attributes] ) } : false
+                            end
+                            # if we saved successfully, but the GlTransaction did not;
+                            #   Copy the errors to the model and abort the transaction
+                            if save_status && gl_transaction.errors.any?
+                                self.errors[:gl_transaction] += gl_transaction.errors.full_messages
+                                save_status = false
+                                raise InvalidGlTransaction.new(gl_transaction)
+                            end
+                        end
+                        return save_status
+                    end
+                end
+
+            end
+
+            module ClassMethods
+
+                def has_gl_transaction( options={} )
+                    options.merge!( attributes: :attributes_for_gl_transaction )
+                    cattr_accessor :options_for_gl_transaction
+                    self.options_for_gl_transaction = options unless options.empty?
+                    self.send :include, InstanceMethods
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/has_sku_loc_lines.rb

@@ -0,0 +1,47 @@
+module Skr
+    module Concerns
+
+        module HasSkuLocLines
+
+            extend ActiveSupport::Concern
+
+            module InstanceMethods
+
+                def other_charge_lines
+                    self.lines.select{|l| l.sku.is_other_charge? }
+                end
+
+                def regular_lines
+                    self.lines.reject{|l| l.sku.is_other_charge? }
+                end
+
+                def regular_lines_total
+                    self.regular_lines.sum{|l|l.extended_price}
+                end
+
+                def subtotal
+                    self.regular_lines.inject(0){|sum,line| sum + line.extended_price }
+                end
+
+                def total
+                    if total = self.read_attribute('total')
+                        BigDecimal.new(total)
+                    elsif self.new_record? || self.association(:lines).loaded?
+                        self.lines.inject( BigDecimal.new('0') ){|sum,line| sum += line.extended_price }
+                    else
+                        BigDecimal.new( self.lines.sum('price*qty') )
+                    end
+                end
+            end
+
+            module ClassMethods
+
+                def has_sku_loc_lines
+                    self.send :include, InstanceMethods
+                    export_methods :total
+                end
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/immutable_model.rb

@@ -0,0 +1,32 @@
+module Skr
+    module Concerns
+
+        module ImmutableModel
+
+            extend ActiveSupport::Concern
+
+            module ClassMethods
+
+                # Once it's created it may not be updated or destroyed.
+                # @raise [ActiveRecord::ReadOnlyRecord] if destroy, delete or save is called after it's been created.
+                def is_immutable(options = {})
+
+                    options[:except] = [*options[:except]].map{|name| name.to_s } # make sure except is present and an array
+
+                    before_destroy do
+                        raise ActiveRecord::ReadOnlyRecord.new( "Can not destroy #{self.class.model_name}, only create is allowed" )
+                    end
+
+                    before_update do
+                        unless ( changes.keys - change_tracking_fields - options[:except] ).blank?
+                            raise ActiveRecord::ReadOnlyRecord.new(  "Can not update, only create #{self.class.model_name}" )
+                        end
+                    end
+
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/inv_extensions.rb

@@ -0,0 +1,24 @@
+module Skr
+    module Concerns
+
+        module INV
+
+            module Lines
+
+                def from_pick_ticket!
+                    proxy_association.owner.pick_ticket.lines.each do | line |
+                        build({ pt_line: line, qty: line.qty_to_ship })
+                    end
+                end
+
+                def from_sales_order!
+                    proxy_association.owner.sales_order.lines.each do | line |
+                        build({ so_line: line, qty: line.qty_allocated })
+                    end
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/is_order_like.rb

@@ -0,0 +1,47 @@
+module Skr
+    module Concerns
+
+        module IsOrderLike
+            extend ActiveSupport::Concern
+
+            module InstanceMethods
+
+
+                # Set's the customer.  It also defaults the terms, addresses,and tax_exempt status to the customer's defaults
+                # @param cust [Customer]
+                # @return Customer
+                def customer=(cust)
+                    super
+                    self.terms ||= cust.terms
+                    self.is_tax_exempt    = cust.is_tax_exempt        if     self.is_tax_exempt.nil?
+                    self.billing_address  = cust.billing_address.dup  unless self.billing_address.present?
+                    self.shipping_address = cust.shipping_address.dup unless self.shipping_address.present?
+                end
+
+                protected
+
+                def set_order_defaults
+                    self.location ||= Location.default
+                    self.terms    ||= customer.terms if self.customer
+                    true
+                end
+
+            end
+
+            module ClassMethods
+
+                def is_order_like
+                    self.send :include, InstanceMethods
+                    has_sku_loc_lines # pull in the sku_loc_lines module
+
+                    validates_associated :lines
+
+                    before_validation :set_order_defaults, :on=>:create
+
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/concerns/is_sku_loc_line.rb

@@ -0,0 +1,65 @@
+module Skr
+    module Concerns
+
+        module IsSkuLocLine
+
+            extend ActiveSupport::Concern
+
+            module InstanceMethods
+                def uom_record
+                    if self.association(:sku).loaded? && self.sku.association(:uoms).loaded?
+                        self.sku.uoms.detect{|uom| uom.code == self.uom_code }
+                    else
+                        self.sku.uoms.where({ code: self.uom_code }).first
+                    end
+                end
+
+                def ea_qty
+                    self.qty*self.uom_size
+                end
+
+                def is_other_charge?
+                    self.sku.is_other_charge?
+                end
+
+                def extended_price
+                    self.price && self.qty ? self.price * self.qty : BigDecimal.new(0)
+                end
+
+                private
+
+                def ensure_sku_does_not_change
+                    errors.add(:sku, "can not be updated") if changes['sku_code']
+                    if change = changes['sku_loc_id']
+                        # allow if the sku_id is the same on both old & new locations
+                        unless 1 == SkuLoc.where( id: change ).pluck('sku_id').uniq.length
+                            errors.add(:sku, "must be the same in both locations") if sku_code_changed?
+                        end
+                    end
+                end
+            end
+
+            module ClassMethods
+
+                def is_sku_loc_line( parent: nil )
+                    self.send :include, InstanceMethods
+
+                    validate  :ensure_sku_does_not_change, :on=>:update
+
+                    if parent
+                        before_create do
+                            self.position ||= ( self.send( parent ).lines.maximum(:position) || 0 ) + 1
+                        end
+                    end
+
+                    export_methods :extended_price, :optional=>false
+
+                end
+
+
+            end
+
+        end
+
+    end
+end