stockor 0.1.5

data/lib/skr/models/uom.rb

@@ -0,0 +1,63 @@
+module Skr
+
+    class Uom < Skr::Model
+
+        belongs_to :sku, :inverse_of=>:uoms
+
+        validates :price,  :numericality=>true, :allow_nil=>false
+        validates :sku,    :presence=>true, :on=>:update
+        validates :code,   :presence=>true
+        validates :size,   :numericality => true, :length=>{:minimum=>1}
+        validates :weight, :height, :width, :depth, :numericality=>{:greater_than=>0.1}, :allow_nil=>true
+
+        export_methods :combined_uom, mandatory: true
+
+        def combined_uom
+            if self.size.nil? || self.code.nil?
+                ''
+            elsif 1 == self.size
+                self.code
+            else
+                "#{self.code}/#{self.size}"
+            end
+        end
+
+        def has_dimensions?
+            ! self.dimensions.include?(nil)
+        end
+
+        def dimensions
+            [ width, height, depth ]
+        end
+
+        def volume
+            if has_dimensions?
+                dimensions.inject(:*)
+            else
+                nil
+            end
+        end
+
+        def blank?
+            self.code.blank? || self.size.to_i == 0
+        end
+
+
+        def self.ea
+            Uom.new({ :code=>'EA',:size=>1, :price=>0.0 })
+        end
+
+    end
+
+
+end # Skr module
+
+
+__END__
+
+        def for_public(user=nil,options={})
+            as_json({
+                :only=>%w{ code size base_price },
+                :methods=>%w{ combined_uom dimensions volume }
+            })
+        end

data/lib/skr/models/user_proxy.rb

@@ -0,0 +1,60 @@
+module Skr
+
+    # The UserProxy is a stand-in for the real user
+    # model that will be implementation specific by the user of Stockor Core
+    class UserProxy
+
+        # The user who's currently interacting with Stockor.
+        # Defaults to 0, indicating anonymous or unknown
+        # @return [Object,FixNum] whatever was set using scoped_to, or 0 if nothing was set
+        def self.current
+            Thread.current[:skr_user_proxy]
+        end
+
+        # Retrieve the current id of the user we're proxying for.
+        # get's a bit complicated since we can proxy both for a user object
+        # or just the user's id
+        # @return [Fixnum] current user's ID.  If the current user is not set, returns 0
+        def self.current_id
+            if self.current.nil?
+                0
+            else
+                self.current.is_a?(Fixnum) ? self.current : self.current.id
+            end
+        end
+
+        # sets the user for the duration of the block
+        # @example Inside a Rails controller
+        #
+        #     class DocumentsController < ApplicationController
+        #         around_filter :set_skr_user
+        #
+        #         # update's the Document's owner to current
+        #         # But sets all the notes to be owned by admin
+        #         def update_owner
+        #             doc = Document.find(params[:id])
+        #             doc.current_owner = Skr::UserProxy.current
+        #             Skr::UserProxy.scoped_to( User.admin ) do
+        #                 doc.notes.each{ |note| note.set_owner_to_current! } # will set to Skr::UserProxy.current
+        #             end
+        #         end
+        #
+        #         private
+        #
+        #         def set_skr_user
+        #             user = SuperUserModel.find( session[:user] )
+        #             Skr::UserProxy.scoped_to( user ) do
+        #                  yield
+        #             end
+        #          end
+        #      end
+        #
+        # @return [UserProxy] self
+        def self.scoped_to( user )
+            prev_user, Thread.current[:skr_user_proxy] = self.current, user
+            yield user
+        ensure
+            Thread.current[:skr_user_proxy] = prev_user
+        end
+    end
+end

data/lib/skr/models/vendor.rb

@@ -0,0 +1,33 @@
+module Skr
+
+    # Vendors is a companies you purchase goods and services from.
+    # They have both a billing and shipping address,
+    # a gl account that payables should be applied against, and a payment term.
+    class Vendor < Skr::Model
+
+        # Common code shared with {Customer}
+        include BusinessEntity
+
+        belongs_to :gl_payables_account, class_name: 'Skr::GlAccount', export: true
+        belongs_to :gl_freight_account,  class_name: 'Skr::GlAccount', export: true
+
+        has_many :purchase_orders, inverse_of: :vendor
+        has_many :vouchers,        inverse_of: :vendor
+        has_many :vendor_skus,     class_name: 'Skr::SkuVendor', inverse_of: :vendor
+
+        delegate_and_export  :gl_payables_account_number
+        validates :gl_payables_account, set: true
+
+        has_many :sku_vendors
+
+        private
+
+        def set_defaults
+            self.terms               ||= PaymentTerm.find_by_code(Skr.config.customer_terms_code)
+            self.gl_payables_account ||= GlAccount.default_for( :ap )
+            self.gl_freight_account  ||= GlAccount.default_for( :freight )
+        end
+
+    end
+
+end # Skr module

data/lib/skr/models/vo_line.rb

@@ -0,0 +1,35 @@
+module Skr
+
+    class VoLine < Skr::Model
+
+        acts_as_uom
+
+        is_sku_loc_line parent: 'voucher'
+
+        belongs_to :voucher
+        belongs_to :sku_vendor
+        belongs_to :po_line
+        has_one :sku, :through => :sku_vendor, export: true
+
+        validates :sku_vendor, :voucher,   set: true
+        validates :sku_code, :description, :presence => true
+
+        validates :qty, numericality: { gt: 0 }
+
+        before_validation :set_defaults, one: :create
+
+        private
+
+        def set_defaults
+            if po_line
+                self.sku_vendor = po_line.sku.sku_vendors.for_vendor( self.voucher.vendor )
+                %w{ price sku_code part_code description uom_code uom_size }.each do | attr |
+                    self[ attr ] ||= po_line[ attr ]
+                end
+            end
+            true
+        end
+    end
+
+
+end # Skr module

data/lib/skr/models/voucher.rb

@@ -0,0 +1,119 @@
+module Skr
+
+    # A voucher is a record of a {Vendor}'s demand for payment, or a record of
+    # It transistions through the following states
+    #
+    #  * Saved; A {PurchaseOrder} has been recieved but an Invoice has not been received fromt the Vendor
+    #     * It credit's each line's {Sku#gl_asset_account} and debit's the System default inventory_receipts_clearing
+    #  * Confirmed; An Invoice has been received and verified as accurate.
+    #     * Debit: {Vendor#gl_payables_account}, Credit: inventory_receipts_clearing
+    #  * Paid;  A payment has been made against the Voucher
+    #     * Debit {Vendor#gl_payables_account}, Credit: Deposit clearing account
+    class Voucher < Skr::Model
+
+        has_visible_id
+
+        has_sku_loc_lines
+
+        belongs_to :vendor,   export: true
+        belongs_to :customer, export: true
+
+        belongs_to :purchase_order
+        belongs_to :terms, :class_name=>'Skr::PaymentTerm', export: true
+        belongs_to :location
+
+        has_many :gl_transactions, :as=>:source
+        has_many :lines, :class_name=>'Skr::VoLine', export: { writable: true },
+                 :inverse_of=>:voucher, :autosave=>true, validate: true
+
+        before_validation :set_defaults, :on=>:create
+
+        export_scope :with_details, lambda { | *args |
+            compose_query_using_detail_view( view: 'vo_details', join_to: 'voucher_id' )
+        }
+
+        export_scope :unpaid, lambda{ | unused=nil |
+            where(['vouchers.state <> ? and payment_lines.id is null', 'pending']).includes(:payment_line)
+        }
+
+        state_machine do
+            state :pending, initial: true
+            state :confirmed
+            state :paid
+
+            event :mark_confirmed do
+                transitions from: :pending, to: :confirmed
+                before :record_confirmation_in_gl
+            end
+
+            event :mark_paid do
+                transitions from: :confirmed, to: :paid, guards: :ensure_payment_line
+                before :record_payment_in_gl
+            end
+
+
+        end
+
+        def po_receipt=(por)
+            self.vendor = por.vendor
+            self.purchase_order = por.purchase_order
+            self.terms = self.purchase_order.terms
+            self.refno = por.refno
+        end
+
+        # def payment_line=(pl)
+        #     pl.refno = self.refno
+        #     pl.description = "Payment on PO #{self.visible_id}"
+        #     super
+        # end
+
+        # def description_for_gl_transaction(gl_tran)
+        # end
+
+        # def does_create_own_gl_records?
+        #     true
+        # end
+
+        private
+
+        def ensure_payment_line
+            payment_line.present?
+        end
+
+        def set_defaults
+#            self.freight  ||= 0.0
+            if self.purchase_order
+                self.vendor   = self.purchase_order.vendor
+                #self.location = self.purchase_order.location
+                self.terms  ||= self.purchase_order.terms
+            end
+        end
+
+
+
+        def record_confirmation_in_gl
+            self.confirmation_date ||= Date.today
+            GlTransaction.push_or_save(
+              :owner   =>  self, amount: total,
+              :debit   =>  vendor.gl_payables_account,
+              :credit  => GlAccount.default_for( :inventory_receipts_clearing ),
+              :options => { description: "Voucher #{self.visible_id}" }
+            )
+            true
+        end
+
+        def record_payment_in_gl
+            gl = self.gl_transactions.build({
+                :source      =>self,
+                :location    => self.purchase_order.location,
+                :amount      =>self.total,
+                :description =>'Voucher Payment' })
+            gl.credit.account = self.vendor.gl_payables_account
+            gl.debit.account  = self.payment_line.payment.bank_account.gl_account
+            gl.save!
+        end
+
+    end
+
+
+end # Skr module

data/lib/skr/standard_pricing_provider.rb

@@ -0,0 +1,14 @@
+module Skr
+
+    class StandardPricingProvider
+
+        # The default implementation returns the price for the given UOM
+        # Custom implementations will return from a pricing library
+        # @return [BigDecimal] the "standard" price for the SKU
+        def self.price( sku_loc: nil, customer: nil, uom: nil, qty: 1 )
+            sku_loc.sku.uoms.with_code( uom.code ).price
+        end
+
+    end
+end
+

data/lib/skr/version.rb

@@ -0,0 +1,3 @@
+module Skr
+    VERSION='0.1.5'
+end

data/lib/skr.rb

@@ -0,0 +1,18 @@
+require "lanes"
+require 'require_all'
+require "lanes/access"
+require_relative "skr/version"
+require_relative "skr/extension"
+require_rel "skr/configuration"
+
+# The main namespace for Skr
+module Skr
+    def self.table_name_prefix
+        "skr_"
+    end
+end
+
+require_rel "skr/concerns/*.rb"
+require_rel "skr/model"
+require_rel 'skr/models/*.rb'
+require_relative "skr/access_roles"

data/lib/stockor.rb

@@ -0,0 +1,4 @@
+# This file exists so that clients that auto-load
+# based on the gem name will pull in code from the skr
+# namespace
+require_relative "skr.rb"

data/lib/tasks/debug-activity.rake

@@ -0,0 +1,58 @@
+namespace :demo do
+  task :activity do
+
+    require 'faker'
+    require 'lanes/api/pub_sub'
+
+    Lanes::DB.establish_connection
+    Lanes::API::PubSub.initialize
+
+    attributes = {
+      Skr::Address  => [:name,:email,:phone,:line1,:line2,:city,:state,:postal_code],
+      Skr::Vendor   => [:name,:notes],
+      Skr::Customer => [:name,:notes]
+    }
+
+    attribute_values={
+      name:        ->{ Faker::Name.name                 },
+      notes:       ->{ Faker::Company.catch_phrase      },
+      email:       ->{ Faker::Internet.email            },
+      phone:       ->{ Faker::PhoneNumber.phone_number  },
+      line1:       ->{ Faker::Address.street_address    },
+      line2:       ->{ Faker::Address.secondary_address },
+      city:        ->{ Faker::Address.city              },
+      state:       ->{ Faker::Address.state_abbr        },
+      postal_code: ->{ Faker::Address.zip_code          }
+    }
+    module Lanes::API::Updates
+      def self.user_info_for_change(model)
+        { id: rand(4)+1, name: Faker::Name.name, email: Faker::Internet.email }
+      end
+    end
+
+    loop do
+
+      [ Skr::Customer ].each do | klass |
+        Thread.current[:demo_user_info] = {
+          name:  Faker::Name.name, email: Faker::Internet.email
+        }
+
+        record = klass.order(:code).first
+        update = case rand(3)
+                 when 0 then record
+                 when 1 then record.billing_address
+                 when 2 then record.shipping_address
+                 end
+
+        attribute = attributes[update.class].sample
+        value     = attribute_values[attribute].call
+
+        printf("%15s %15s(%3s) %13s => %-20s\n", klass, update.class, update.id, attribute, value )
+
+        update.update_attribute( attribute, value )
+      end
+      sleep 10
+
+    end
+  end
+end

data/spec/fixtures/skr/address.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/customer.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/gl_account.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/gl_manual_entry.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/gl_period.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/gl_posting.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/gl_transaction.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/ia_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/ia_reason.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/inv_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/inventory_adjustment.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/invoice.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/location.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/payment_term.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/pick_ticket.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/po_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/po_receipt.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/por_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/pt_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/purchase_order.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/sales_order.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/sku.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/sku_loc.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/sku_tran.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/sku_vendor.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/so_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/uom.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/vendor.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/vo_line.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/fixtures/skr/voucher.yml

@@ -0,0 +1,2 @@
+# Read about fixtures at http://api.rubyonrails.org/classes/ActiveRecord/FixtureSet.html
+

data/spec/skr/address.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::Address do
+
+    it "can be instantiated" do
+        model = Address.new
+        model.must_be_instance_of(Address)
+    end
+
+end

data/spec/skr/concerns/code_identifier_spec.rb

@@ -0,0 +1,45 @@
+require "lanes/spec_helper"
+
+
+class CodeIdentifierTest < Lanes::TestCase
+
+    class CodeIdentifierTestModel
+        class_attribute :blocks
+        attr_accessor :code
+
+        include Lanes::Concerns::CodeIdentifier
+
+        def self.before_validation( opts={}, &block )
+            self.blocks||=[]
+            self.blocks.push( block )
+        end
+
+        def self.validates( *opts )
+        end
+
+        def run_validations
+            self.class.blocks.each{ |b| self.instance_eval(&b) }
+        end
+
+        def [](name)
+            :name == name ? 'A Long String of Nonsense' : ''
+        end
+
+        has_code_identifier :from => :name
+    end
+
+    def test_that_it_uppercases
+        ci = CodeIdentifierTestModel.new
+        ci.code='test'
+        ci.run_validations
+        assert_equal 'TEST', ci.code
+    end
+
+    def test_that_it_generates
+        ci = CodeIdentifierTestModel.new
+        ci.run_validations
+        assert ci.code.present?, "Code wasn't auto-generated"
+        assert_equal 'ALOSTOFNON',  ci.code
+    end
+
+end

data/spec/skr/customer.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::Customer do
+
+    it "can be instantiated" do
+        model = Customer.new
+        model.must_be_instance_of(Customer)
+    end
+
+end

data/spec/skr/gl_account.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::GlAccount do
+
+    it "can be instantiated" do
+        model = GlAccount.new
+        model.must_be_instance_of(GlAccount)
+    end
+
+end

data/spec/skr/gl_manual_entry.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::GlManualEntry do
+
+    it "can be instantiated" do
+        model = GlManualEntry.new
+        model.must_be_instance_of(GlManualEntry)
+    end
+
+end

data/spec/skr/gl_period.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::GlPeriod do
+
+    it "can be instantiated" do
+        model = GlPeriod.new
+        model.must_be_instance_of(GlPeriod)
+    end
+
+end

data/spec/skr/gl_posting.rb

@@ -0,0 +1,10 @@
+require_relative 'spec_helper'
+
+describe Skr::GlPosting do
+
+    it "can be instantiated" do
+        model = GlPosting.new
+        model.must_be_instance_of(GlPosting)
+    end
+
+end