stockor-core 0.2

data/lib/skr/core/testing/fixtures/skr/sku_trans.yml

@@ -0,0 +1,9 @@
+
+free_adj:
+  origin: first(Skr::InventoryAdjustment)
+  sku_loc: hatdefault
+  cost: 3.22
+  origin_description: 'IA Adj'
+  prior_qty: 25
+  mac: 0.64
+  prior_mac: 0.64

data/lib/skr/core/testing/fixtures/skr/sku_vendors.yml

@@ -0,0 +1,35 @@
+string_bigco:
+  sku: string
+  vendor: bigco
+  part_code: STRINGBALL
+  list_price: 12.42
+  cost: 8.33
+  uom_size: 100
+  uom_code: FT
+
+hat_bigco:
+  sku: hat
+  vendor: bigco
+  part_code: "Hat 'O Glory"
+  list_price: 42.42
+  cost: 34.33
+  uom_size: 10
+  uom_code: BX
+
+glove_bigco:
+  sku: glove
+  vendor: bigco
+  part_code: GLOVEYDOVEY
+  list_price: 42.42
+  cost: 34.33
+  uom_size: 10
+  uom_code: BX
+
+glove_bob:
+  sku: glove
+  vendor: bob
+  part_code: BLACKGLOVE
+  list_price: 138.42
+  cost: 88.33
+  uom_size: 100
+  uom_code: CASE

data/lib/skr/core/testing/fixtures/skr/skus.yml

@@ -0,0 +1,50 @@
+
+hat:
+  code: HAT
+  description: A Large Top Hat
+  default_vendor: bigco
+  default_uom_code: EA
+  is_other_charge: false
+  does_track_inventory: true
+  gl_asset_account: inventory
+  can_backorder: false
+
+glove:
+  code: GLOVE
+  description: A small black riding glove
+  default_vendor: bigco
+  default_uom_code: PR
+  is_other_charge: false
+  does_track_inventory: true
+  gl_asset_account: inventory
+  can_backorder: false
+
+string:
+  code: STRING
+  description: A bunch of string
+  default_vendor: bigco
+  default_uom_code: FT
+  is_other_charge: false
+  does_track_inventory: true
+  gl_asset_account: inventory
+  can_backorder: false
+
+tax:
+  code: TAX
+  is_other_charge: true
+  does_track_inventory: false
+  description: Sales Tax
+  default_vendor: bigco
+  default_uom_code: EA
+  gl_asset_account: tax
+  can_backorder: false
+
+ship:
+  code: SHIP
+  is_other_charge: true
+  does_track_inventory: false
+  description: Sales Ship
+  default_vendor: bigco
+  default_uom_code: EA
+  gl_asset_account: ship
+  can_backorder: false

data/lib/skr/core/testing/fixtures/skr/so_lines.yml

@@ -0,0 +1,71 @@
+
+first_string:
+   sales_order: first
+   sku_loc: stringdefault
+   sku_code: STRING
+   description: Some String, custom color AQUA
+   uom_code: YARD
+   uom_size: 3
+   position: 1
+   price: 1.42
+   qty_picking: 0
+   qty: 2
+   qty_allocated: 0
+   qty_invoiced: 0
+
+picking_hat:
+   sales_order: picking
+   sku_loc: hatdefault
+   sku_code: HAT
+   description: A first Item
+   uom_code: EA
+   uom_size: 1
+   position: 2
+   price: 1.42
+   qty: 25
+   qty_allocated: 5
+   qty_picking: 5
+   qty_invoiced: 0
+
+picking_glove:
+   sales_order: picking
+   sku_loc: glovedefault
+   sku_code: GLOVE
+   description: Lily White Gloves
+   uom_code: PR
+   uom_size: 1
+   position: 2
+   price: 3.39
+   qty: 20
+   qty_allocated: 1
+   qty_picking: 1
+   qty_invoiced: 0
+
+
+complete_hat:
+   sales_order: complete
+   sku_code: HAT
+   sku_loc: hatdefault
+   description: Top Hat
+   uom_code: EA
+   uom_size: 1
+   position: 1
+   price: 1.42
+   qty: 5
+   qty_allocated: 0
+   qty_picking: 0
+   qty_invoiced: 5
+
+complete_glove:
+   sales_order: complete
+   sku_loc: glovedefault
+   sku_code: GLOVE
+   description: Lily White Gloves
+   uom_code: PR
+   uom_size: 1
+   position: 2
+   price: 3.39
+   qty: 2
+   qty_allocated: 0
+   qty_picking: 0
+   qty_invoiced: 2

data/lib/skr/core/testing/fixtures/skr/uoms.yml

@@ -0,0 +1,61 @@
+
+
+HATEA:
+  sku: hat
+  size: 1
+  code: EA
+  price: 3.11
+  weight: 1.8
+  height: 12
+  width: 8
+  depth: 1.2
+
+HATCA:
+  sku: hat
+  size: 20
+  code: CASE
+  price: 3.23
+  weight: 21.9
+  height: 22
+  width: 22
+  depth: 28
+
+GLOVEPR:
+  sku: glove
+  size: 1
+  code: PR
+  price: 3.39
+  weight: 0.8
+  height: 10
+  width: 5
+  depth: 0.2
+  
+GLOVECA:
+  sku: glove
+  size: 10
+  code: CA
+  price: 13.39
+  weight: 0.8
+  height: 10
+  width: 5
+  depth: 0.2
+
+STRINGFT:
+  sku: string
+  size: 1
+  code: FT
+  price: 0.11
+  weight: 0.1
+  height: 12
+  width: 0.1
+  depth: 0.1
+
+STRINGYARD:
+  sku: string
+  size: 3
+  code: YARD
+  price: 0.87
+  weight: 0.2
+  height: 12
+  width: 0.1
+  depth: 0.1

data/lib/skr/core/testing/fixtures/skr/vendors.yml

@@ -0,0 +1,48 @@
+
+
+bigco:
+  code: BIGCO
+  name: Mr Bob
+  terms: default_test
+  gl_payables_account: ap
+  gl_freight_account: shipping
+  billing_address: bigco
+  shipping_address: bigco_wh
+
+unused:
+  code: UNUSED
+  terms: default_test
+  name: Mr Unused Person
+  gl_payables_account: ap
+  gl_freight_account: shipping
+  billing_address: bigco
+  shipping_address: bigco_wh
+
+bob:
+  code: BOB
+  terms: default_test
+  name: Mr Bob
+  gl_payables_account: ap
+  gl_freight_account: shipping
+  billing_address: bigco
+  shipping_address: bigco_wh
+
+demo:
+  code: Demo
+  terms: default_test
+  name: Mr Bob
+  gl_payables_account: ap
+  gl_freight_account: shipping
+  billing_address: bigco
+  shipping_address: bigco_wh
+
+joe:
+  code: Sam
+  terms: default_bob
+  gl_payables_account: ap
+  gl_freight_account: shipping
+  billing_address: joe
+  shipping_address: joe
+  name: Joe Man
+
+

data/lib/skr/core/testing/fixtures/skr/vo_lines.yml

@@ -0,0 +1,12 @@
+
+first:
+   voucher: first
+   sku_vendor: hat_bigco
+   qty: 3
+   uom_code: EA
+   uom_size: 1
+   price: 1.42
+   sku_code: HAT
+   part_code: "Hat 'O Glory"
+   description: A hatty hat
+   position: 1

data/lib/skr/core/testing/fixtures/skr/vouchers.yml

@@ -0,0 +1,8 @@
+
+
+first:
+  purchase_order: first
+  terms: net30 
+  state: pending
+  vendor: bigco
+  confirmation_date: <%= Date.today - 1.week %>

data/lib/skr/core/testing/helper.rb

@@ -0,0 +1,18 @@
+require 'minitest/autorun'
+require 'skr/core'
+
+require 'active_record'
+require 'active_record/fixtures'
+require_relative "../../core"
+
+ENV["RAILS_ENV"] = "test"
+RAILS_ENV = "test"
+I18n.enforce_available_locales = true
+Skr::Core::DB.establish_connection('test')
+Skr::Core.logger=Logger.new( File.open('log/test.log', File::WRONLY | File::APPEND | File::CREAT ))
+ActiveRecord::Base.logger = Skr::Core.logger
+ActiveSupport::Dependencies.mechanism = :require
+
+require_relative 'assertions'
+require_relative 'fixtures'
+require_relative 'test_case'

data/lib/skr/core/testing/test_case.rb

@@ -0,0 +1,17 @@
+module Skr
+
+    class TestCase < ActiveSupport::TestCase
+        include ActiveRecord::TestFixtures
+        include Skr
+
+        setup do
+            Thread.current[:skr_user_proxy] = Skr::NullUser.new
+        end
+
+        self.fixture_path = Skr::Core::Testing.fixtures_path
+        self.use_transactional_fixtures = true
+
+        fixtures :all
+    end
+
+end

data/lib/skr/core/version.rb

@@ -0,0 +1,5 @@
+module Skr
+  module Core
+    VERSION = "0.2"
+  end
+end

data/lib/skr/customer.rb

@@ -0,0 +1,34 @@
+module Skr
+
+    # Customers are Companies (or individuals) that purchase {Sku}s.
+    # They have both a billing and shipping address,
+    # a gl account that payments should be applied against, and a payment term.
+    #
+    class Customer < Skr::Model
+
+        # Common code shared with {Vendor}
+        include BusinessEntity
+
+        belongs_to :gl_receivables_account, class_name: 'Skr::GlAccount', export: true
+
+        has_many :sales_orders, inverse_of: :customer
+        has_many :invoices,     inverse_of: :customer, listen: { save: :update_balance! }
+
+        delegate_and_export :gl_receivables_account_number
+
+        validates :gl_receivables_account, set: true
+
+        # Updates the amount the customer owes, which is the sum of the amount unpaid on open invoices
+        def update_balance!(*)
+            update_attributes open_balance: invoices.open_for_customer(self)
+                                                    .with_details.sum('details.total')
+        end
+
+      private
+
+        def set_defaults
+            self.terms                  ||= PaymentTerm.find_by_code(Core.config.customer_terms_code)
+            self.gl_receivables_account ||= GlAccount.default_for( :ar )
+        end
+    end
+end # Skr module

data/lib/skr/gl_account.rb

@@ -0,0 +1,56 @@
+module Skr
+
+    # A GlAccount *(short for General Ledger Account)* is used
+    # to define each class of items for
+    # which money or the equivalent is spent or received.
+    class GlAccount < Skr::Model
+
+        # @private
+        DEFAULT_ACCOUNTS = {}
+
+        is_immutable except: [:name, :is_active]
+
+        validates :name, :description, :presence => true
+
+        # @!attribute description
+        #   A short description of the GL Account
+
+        # A future improvement would be to allow arbitrary account masks.  For now, keep it simple
+        # with mandatory 4 characters + 2 char branch code
+        validates :number, :presence => true, :numericality=>true, :length=>{ :is=>4 }
+
+        # @return [GlAccount] the default account for the key from {Skr::Core::Configuration.default_gl_accounts}
+        def self.default_for( lookup )
+            number = Core.config.default_gl_accounts[ lookup ]
+            raise RuntimeError.new("Unkown GL default account lookup code: {lookup}") unless number
+            DEFAULT_ACCOUNTS[ lookup ] ||= GlAccount.find_by_number( number )
+        end
+
+        # @return [String] the account number combined with location branch code
+        def number_for_location( location )
+            self.number + location.gl_branch_code
+        end
+
+        # @return [String] the account number combined with the default branch code
+        def default_number
+            self.number + Skr::Core.config.default_branch_code
+        end
+
+        # @return [BigDecimal] The balance for the current period
+        def trial_balance
+            balance_for( GlPeriod.current )
+        end
+
+        # @return [String] the account number suitable for querying all branches
+        def account_mask
+            number + '%'
+        end
+
+        # @return [BigDecimal] the balance for a given period
+        def balance_for( period, mask = self.account_mask )
+            GlPosting.matching( period, account_mask ).sum(:amount)
+        end
+
+    end
+
+end