stockor-core 0.2

data/db/migrate/20140400164729_create_skr_vouchers.rb

@@ -0,0 +1,22 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrVouchers < ActiveRecord::Migration
+    def change
+
+        create_skr_table "vouchers" do |t|
+            t.skr_visible_id
+
+            t.skr_reference :vendor,         single: true, null: false
+            t.skr_reference :purchase_order, single: true, null: true
+
+            t.skr_reference :terms,          to_table: 'payment_terms'
+
+            t.string   "state",              null: false
+            t.string   "refno"
+
+            t.date     "confirmation_date",     null: true # starts out as non-confirmed
+            t.skr_track_modifications
+        end
+
+    end
+end

data/db/migrate/20140400164733_create_skr_vo_lines.rb

@@ -0,0 +1,21 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrVoLines < ActiveRecord::Migration
+    def change
+        create_skr_table "vo_lines" do |t|
+            t.skr_reference :voucher,        null: false, single: true
+            t.skr_reference :sku_vendor,     null: false, single: true
+            t.skr_reference :po_line,        null: true,  single: true
+            t.string   "sku_code",           null: false
+            t.string   "part_code",          null: false
+            t.string   "description",        null: false
+            t.string   "uom_code",           null: false
+            t.integer  "uom_size",           null: false, limit: 2
+            t.integer  "position",           null: false, limit: 2
+            t.integer  "qty",                null: false, default: 0
+            t.skr_currency  "price",         null: false
+            t.skr_track_modifications
+        end
+
+    end
+end

data/db/migrate/20140401164729_create_skr_po_receipt.rb

@@ -0,0 +1,16 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrPoReceipt < ActiveRecord::Migration
+    def change
+        create_skr_table "po_receipts" do |t|
+            t.skr_visible_id
+            t.skr_reference :location,       single: true
+            t.skr_currency  :freight,        null: false, default: 0.0
+            t.skr_reference :purchase_order, single: true, null: false
+            t.skr_reference :vendor,         single: true, null: false
+            t.skr_reference :voucher,        single: true, null: true
+            t.string :refno
+            t.skr_track_modifications create_only: true
+         end
+    end
+end

data/db/migrate/20140401164740_create_skr_por_line.rb

@@ -0,0 +1,21 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrPorLine < ActiveRecord::Migration
+    def change
+        create_skr_table "por_lines" do |t|
+            t.skr_reference :po_receipt,     null: false, to_table: 'po_receipts'
+            t.skr_reference :po_line,        null: true,  single: true
+            t.skr_reference :sku_loc,        null: false, single: true
+            t.skr_reference :sku_vendor,     null: true, single: true
+            t.string   "sku_code",           null: false
+            t.string   "part_code",          null: false
+            t.string   "description",        null: false
+            t.string   "uom_code",           null: false
+            t.integer  "uom_size",           null: false, limit: 2
+            t.integer  "position",           null: false, limit: 2
+            t.integer  "qty",                null: false, default: 0
+            t.skr_currency  "price",         null: false
+            t.skr_track_modifications create_only: true
+        end
+    end
+end

data/db/migrate/20140422024010_create_skr_inv_details_view.rb

@@ -0,0 +1,42 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrInvDetailsView < ActiveRecord::Migration
+
+    def up
+      execute <<-EOS.squish
+      create view #{skr_prefix}inv_details as
+         select
+           inv.id as invoice_id,
+           so.visible_id as sales_order_visible_id,
+           pt.id as pick_ticket_id,
+           to_char(so.created_at,'YYYY-MM-DD')   as string_order_date,
+           to_char(inv.created_at,'YYYY-MM-DD')  as string_invoice_date,
+           cust.code as customer_code, cust.name as customer_name,
+           ba.name as bill_addr_name,
+           coalesce( ttls.total,0.0 ) as total,
+           coalesce( ttls.num_lines, 0 ) as num_lines,
+           coalesce( ttls.other_charge_total, 0 ) as total_other_charge_amount,
+           coalesce( ttls.total,0.0 ) - coalesce( ttls.other_charge_total, 0.0 ) as subtotal_amount
+         from #{skr_prefix}invoices inv
+         join #{skr_prefix}customers cust on cust.id = inv.customer_id
+         left join #{skr_prefix}addresses ba on ba.id = inv.billing_address_id
+         left join #{skr_prefix}sales_orders so on so.id = inv.sales_order_id
+         left join #{skr_prefix}pick_tickets pt on pt.id = inv.pick_ticket_id
+         left join (
+             select
+               invoice_id,
+               sum(ivl.qty*ivl.price) as total,
+               sum( case when s.is_other_charge then ivl.qty*ivl.price else 0 end ) as other_charge_total,
+               count(ivl.*) as num_lines
+             from #{skr_prefix}inv_lines ivl
+             join #{skr_prefix}sku_locs sl on sl.id = ivl.sku_loc_id
+             join #{skr_prefix}skus s on s.id = sl.sku_id
+             group by invoice_id
+          ) ttls on ttls.invoice_id = inv.id
+      EOS
+    end
+
+    def down
+        execute "drop view #{skr_prefix}inv_details"
+    end
+end

data/lib/generators/stockor/migrations/install_generator.rb

@@ -0,0 +1,42 @@
+require 'skr/core/db/migrations'
+
+module Stockor
+
+    module Migrations
+
+        class InstallGenerator < Rails::Generators::Base
+            include Rails::Generators::Migration
+
+            source_root Skr::Core::DB::Migrations.paths.first
+
+            Skr::Core::DB::Migrations.paths.slice(1..-1).each do | source_path |
+                source_paths << source_path
+            end
+
+            desc "Install Stockor migrations"
+            def self.next_migration_number(path)
+                unless @prev_migration_nr
+                    @prev_migration_nr = Time.now.utc.strftime("%Y%m%d%H%M%S").to_i
+                else
+                    @prev_migration_nr += 1
+                end
+                @prev_migration_nr.to_s
+            end
+
+            def copy_migrations
+                Skr::Core::DB::Migrations.paths.each do | source_path |
+
+                    Pathname.glob( source_path.join('*') ).each do | migration |
+                        from = File.basename( migration )
+                        dest = from.gsub(/^\d+_(.*).rb$/,'\\1.rb')
+                        if self.class.migration_exists?("db/migrate", "#{dest}")
+                            say_status("skipped", "Migration #{dest} already exists")
+                        else
+                            migration_template( from, "db/migrate/#{dest}" )
+                        end
+                    end
+                end
+            end
+        end
+    end
+end

data/lib/skr/address.rb

@@ -0,0 +1,97 @@
+module Skr
+
+    # A postal address with optional email and phone number
+    # By default all fields may be left blank.
+    #
+    # Validations may be selectively enabled by using the #enable_validations method
+    class Address < Skr::Model
+
+        # @!attribute email
+        #   The email address to use
+
+        # @!attribute ensure_not_blank
+        #   Must the Address be filled out?  The {#blank?} method must return false
+        #   @return [Boolean]
+        # @!attribute validate_email
+        #   Will the email be validated to meet the {EmailValidator} requirements?
+        #   @return [Boolean]
+        # @!attribute validate_phone
+        #   Should the phone field be validated to be not blank?
+        #   @return [Boolean]
+        attr_accessor :ensure_not_blank, :validate_email, :validate_phone
+
+        validates  :name, :line1, :city, :state, :postal_code, :presence=>true, :if=>:ensure_not_blank
+        validates  :email, :presence=>true, :email=>true, :if=>:validate_email
+        validates  :phone, :presence=>true, :if=>:validate_phone
+       
+        # @return [Address] a blank copy of an address
+        def self.blank
+            Address.new({ name: '', line1: '', city: '', state: '', postal_code: '' })
+        end
+
+        # @return [String] the name and email formatted for inclusion in an email
+        def email_with_name
+            "#{name} <#{email}>"
+        end
+
+        # fill in missing fields from postal_code using the ZipCode lookup table
+        def fill_missing_from_zip
+            if ( self.postal_code.present? &&
+                 ( self.city.blank? || self.state.blank? ) &&
+                 zc = ZipCode.find_by_code( self.postal_code )
+               )
+                self.city  ||= zc.city
+                self.state ||= zc.state
+            end
+        end
+
+        # @return [Boolean] is any of (name line1 city state postal_code) blank?
+        def blank?
+            return !! %w{ name line1 city state postal_code }.detect{ |field| self[field].blank? }
+        end
+
+        # split the name on space
+        # @return [Hash]
+        #   * :first [String] Portion of name before first space
+        #   * :last  [String] Portion of name after last space
+        def seperated_name
+            {:first=>name.to_s.split(' ').first, :last=> name.to_s.split(' ').last }
+        end
+
+        # enable selected validations
+        # @option options [Boolean] :include_email should the email be validated
+        # @option options [Boolean] :include_phone should the phone number be validated
+        def enable_validations( options = {} )
+            self.ensure_not_blank = true
+            self.validate_email = options[:include_email]
+            self.validate_phone = options[:include_phone]
+        end
+
+        # @param include [Array] list of extra fields to include in the address
+        # @return [String] Address converted to string, formatted with line breaks in the typical US style of display
+        # @example
+        #     address = Address.new( name: 'Bob\s Uncle',phone: '877-555-5555', line1: 'PO Box 87',
+        #                            city: 'Nowhereville', state: 'Urgandishly' postal_code: 'ASCN 1ZZ' )
+        #     address.to_s( :include => :phone ) #=>
+        #             Bob's Uncle
+        #             PO Box 87
+        #             Nowhereville, Urgandishly ASCN 1ZZ
+        #             877-5550-5555
+        def to_s( include: [] )
+            ret = ""
+            %w{ name line1 line2 }.each{ |a| ret << self[a] + "\n" unless self[a].blank? }
+            ret << city.to_s
+            ret << ' ' + state unless state.blank?
+            ret << ', ' + postal_code.to_s unless postal_code.blank?
+            include = [ *include ]
+            if include.any?
+                ret << "\n" + include.map{ | field | self[ field ] }.join(' ')
+            end
+            ret
+        end
+
+
+    end
+
+
+end # end Skr module

data/lib/skr/business_entity.rb

@@ -0,0 +1,25 @@
+module Skr
+
+    module BusinessEntity
+
+        extend ActiveSupport::Concern
+
+        included do
+            has_random_hash_code
+            has_code_identifier from: 'name'
+
+            belongs_to :billing_address,  class_name: 'Skr::Address',     export: { writable: true }
+            belongs_to :shipping_address, class_name: 'Skr::Address',     export: { writable: true }
+            belongs_to :terms,            class_name: 'Skr::PaymentTerm', export: { writable: true }
+
+            delegate_and_export :terms_code, :terms_description
+
+            validates :name,  presence: true
+            validates :terms, :billing_address, :shipping_address, set: true
+
+            before_validation :set_defaults, :on=>:create
+        end
+
+    end
+
+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/all.rb

@@ -0,0 +1,30 @@
+require_relative "queries"
+require_relative "attr_accessor_with_default"
+require_relative "json_attribute_access"
+require_relative "track_modifications"
+require_relative "code_identifier"
+require_relative "random_hash_code"
+
+require_relative "visible_id_identifier"
+require_relative "immutable_model"
+require_relative "export_scope"
+require_relative "export_associations"
+require_relative "export_join_tables"
+require_relative "export_methods"
+
+require_relative "locked_fields"
+require_relative "json_attribute_access"
+require_relative "sanitize_json"
+require_relative "pub_sub"
+require_relative "association_extensions"
+require_relative "acts_as_uom"
+require_relative "state_machine"
+require_relative "has_sku_loc_lines"
+require_relative "has_gl_transaction"
+require_relative "is_order_like"
+require_relative "is_sku_loc_line"
+require_relative "sku_extensions"
+require_relative "gl_tran_extensions"
+require_relative "so_extensions"
+require_relative "pt_extensions"
+require_relative "inv_extensions"

data/lib/skr/concerns/association_extensions.rb

@@ -0,0 +1,85 @@
+module Skr::Concerns
+
+
+    # Custom implentation of has_many and belongs_to
+    #
+    module AssociationExtensions
+
+        extend ActiveSupport::Concern
+
+        module ClassMethods
+
+            def has_one(name, scope = nil, options = {})
+                opts = extract_private_options( scope, options )
+                associations = super
+                handle_private_options( name, opts ) unless opts.empty?
+                associations
+            end
+
+            def belongs_to(name, scope = nil, options = {} )
+                opts = extract_private_options( scope, options )
+                associations = super
+                handle_private_options( name, opts ) unless opts.empty?
+                associations
+            end
+
+            def has_many(name, scope=nil,options={}, &extension )
+                opts = extract_private_options( scope, options )
+                associations = super
+                handle_private_options( name, opts ) unless opts.empty?
+                associations
+            end
+
+            private
+
+            def handle_private_options( name, opts )
+                association = reflect_on_association( name.to_sym )
+                setup_listeners( association, opts[:listen] ) if opts[:listen]
+                setup_association_export( association, opts[:export] ) if opts[:export]
+            end
+
+            def extract_private_options( scope, options )
+                if scope.is_a?(Hash)
+                    scope.extract!( :export, :listen )
+                else
+                    options.extract!( :export, :listen )
+                end
+            end
+
+            # This gets complex; We
+            #   First setup proc's for each listener,
+            #   then attempt to load the associations's class
+            #   If that succeds, we're done, otherwise we add it
+            #   to PubSub's pending queue
+            def setup_listeners( association, listeners )
+                targets = {}
+                if listeners.any? && association.options[:inverse_of].nil?
+                    raise RuntimeError.new "Setting listener on #{name}##{association.name} " +
+                        "but the association does not have " +
+                        "an inverse_of specified."
+                end
+                listeners.each do | name, target |
+                    targets[ name ] = Proc.new{ | record, *args |
+                        record = record.send( association.inverse_of.name )
+                        record.send( target, *( [record] + args ) ) if record
+                    }
+                end
+                begin
+                    klass = association.klass # This will throw if the class hasn't been loaded yet
+                    targets.each{ | name, proc | klass._add_event_listener( name, proc ) }
+                rescue NameError
+                    pending = PendingEventListeners.all[association.class_name.demodulize]
+                    targets.each do | name, proc |
+                        pending[name] << proc
+                    end
+                end
+            end
+
+            def setup_association_export( association, options )
+                export_associations( association.name, options == true ? {} : options )
+            end
+        end
+
+    end
+
+end