stockor-core 0.2

data/lib/skr/core/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/lib/skr/core/logger.rb

@@ -0,0 +1,36 @@
+# -*- coding: utf-8 -*-
+
+module Skr::Core
+
+    class << self
+        def logger
+            @logger ||= (
+              if defined?(::Rails)
+                  Rails.logger
+              else
+                  Logger.new(STDERR)
+              end
+            )
+        end
+
+        def logger=( logger )
+            @logger = logger
+        end
+
+        def silence_logs( &block )
+            old_logger = Skr::Core.logger
+            begin
+                Skr::Core.logger=Logger.new( StringIO.new )
+                yield
+            ensure
+                Skr::Core.logger=old_logger
+            end
+        end
+
+        def logger_debug( output )
+            logger.debug '⚡ '*40
+            logger.debug '⚡ ' + output
+            logger.debug '⚡ '*40
+        end
+    end
+end

data/lib/skr/core/numbers.rb

@@ -0,0 +1,71 @@
+# * Utility methods that manipulate Numbers
+
+module Skr::Core::Numbers extend self
+    # Document the responsibility of the class
+    #
+    # == Heading
+    #
+    # Use headings to break up descriptions
+    #
+    # == Formatting
+    #
+    # Embody +parameters+ or +options+ in Teletype Text tags. You can also use
+    # *bold* or *italics* but must use HTML tags for <b>multiple words</b>,
+    # <i>like this</i> and <tt>like this</tt>.
+    # - See more at: http://blog.firsthand.ca/2010/09/ruby-rdoc-example.html#sthash.q9Jkcjrl.dpuf
+
+
+    # ### PercNum
+    #
+    #
+    # A "percnum" is a Stockor invention *(or abomination, depending on your POV)*.
+    # It's a string that contains a number and an optional percent sign.
+    # If the percent sign is present, the number is treated as a percentage.
+    # If desired the user may also input negative numbers which will invert the sense of the method.
+    #
+    # It's intended to be a user-friendly method to provide one input box for "discount" or "surcharge",
+    # and allow the user to input either a flat amount such as 4.50, or a percentage like 20%
+    #
+    class PercNum
+        # @param perc_or_num [BigDecimal,String, Integer] any value that BigDecimal will accept
+        def initialize( perc_or_num )
+            @is_perc    = !! perc_or_num.to_s.match( /\%\s*$/ )
+            @right_side = BigDecimal.new( perc_or_num, 5 )
+            if is_percentage?
+                @right_side *= 0.01
+            end
+        end
+
+        # Adds the PercNum to the specified amount.
+        # @param amount[BigDecimal] the amount that should be added to the PercNum
+        # @return [BigDecimal] The result of either adding (non percent) or multiplying by (percent) the amount
+        # @example
+        #     PercNum.new( '23.42' ).credit_to(  33 ).to_s  #=> '56.42'
+        #     PercNum.new( '25%'   ).credit_to( 100 ).to_s  #=> '125.0'
+        def credit_to( amount )
+            is_percentage? ? ( 1 + @right_side ) * amount : amount += @right_side
+        end
+
+        # Subtracts the PercNum to the specified amount.
+        # @param amount[BigDecimal] the amount that should be added to the PercNum
+        # @return [BigDecimal] The result of either adding (non percent) or multiplying by (percent) the amount
+        # @example
+        #     PercNum.new( '23.42' ).debit_from( 42.42 ).to_s  #=> '19.00'
+        #     PercNum.new( '25%'   ).debit_from( 100   ).to_s  #=> '75.0'
+        def debit_from( amount )
+            is_percentage? ? ( 1 - @right_side ) * amount : amount -= @right_side
+        end
+
+        ## If PercNum was initialized with a blank string
+        def present?
+            ! @right_side.zero?
+        end
+
+        # Is the PercNum percentage based or absolute
+        def is_percentage?
+            @is_perc
+        end
+    end
+
+
+end

data/lib/skr/core/rails_engine.rb

@@ -0,0 +1,5 @@
+module Skr::Core
+    class RailsEngine < Rails::Engine
+        config.autoload_paths += Dir["#{config.root}/lib/**/"]
+    end
+end

data/lib/skr/core/standard_pricing_provider.rb

@@ -0,0 +1,15 @@
+module Skr
+    module Core
+
+        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
+end

data/lib/skr/core/strings.rb

@@ -0,0 +1,57 @@
+module Skr
+    module Core
+        module Strings
+
+            # list of characters that should not be used
+            BAD_RAND_CHARS  = %w{ B 8 o O 0 i l I 1 }
+
+            # characters that should be randomly chosen from
+            RAND_CHARS = ( ('A'..'Z').to_a + ('a'..'z').to_a + ('0'..'9').to_a ) - BAD_RAND_CHARS
+
+            # Generates a random string without using commonly confused numbers and letters.
+            # It's intended for use in situations where the code will have to be
+            # read and re-entered later.
+            #
+            # The characters in BAD_RAND_CHARS are avoided since they can be confused with one another:
+            # @return [String] a random string <length> characters long.
+            def self.random( length = 12 )
+                1.upto(length).each_with_object(''){|i,s| s << RAND_CHARS[ rand(RAND_CHARS.length) ] }
+            end
+
+            # Attempts to shorten a string while keeping it somewhat
+            # like it's original self.
+            # Useful for suggesting a code for a given entity name.
+            # @param string [String] the string to shorten.
+            # @param length [Integer] how long the returned code should be
+            # @param padding [String] What to pad the code with if it is shorter than length.  False indicates no padding should be performed
+            # @return [String] a shortened version of the name with:
+            #  * Upper cased
+            #  * Spaces stripped
+            #  * Made up of a proportional number of chars from each word
+            # #### Examples:
+            #     Skr::Core::Strings.to_code_identifier('General Acme Corp')       #=> 'GENACMCORP'
+            #     Skr::Core::Strings.code_identifier('General I B', padding:false) #=> 'GENERALIB' *(no trailing X)*
+            #     Skr::Core::Strings.to_code_identifier('Top Cat', maxlen: 5 )     #=> 'TOCAT'
+            def self.code_identifier( string, length:10, padding: 'X' )
+                stripped = string.gsub(/\W/, '').upcase
+                if stripped.length < length
+                    return padding.present? ? stripped.ljust( length, padding ) : stripped
+                end
+                result = ''
+                words = string.gsub(/[^\w\s-]/,'').split(/\s+|-|_/)
+                0.upto(words.length + 1).each_with_index do | attempt_num |
+                    remainder = length
+                    result = ''
+                    string = words.each_with_index do | word, index |
+                        chars = ( remainder / (words.length-index) + attempt_num )
+                        result << word[0...chars]
+                        remainder = length - result.length
+                    end
+                    break if result.length >= length
+                end
+                result[0...length].upcase
+            end
+
+        end
+    end
+end

data/lib/skr/core/testing.rb

@@ -0,0 +1,11 @@
+require 'pathname'
+
+module Skr
+    module Core
+        module Testing
+            def self.fixtures_path
+                Pathname.new(__FILE__).dirname.join('testing/fixtures')
+            end
+        end
+    end
+end

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

@@ -0,0 +1,44 @@
+module MiniTest
+    module Assertions
+
+        def assert_logs_matching( regex, failure_message=nil, &block )
+            old_logger = Skr::Core.logger
+            begin
+                output = ""
+                Skr::Core.logger=Logger.new( StringIO.new(output) )
+                yield
+                assert_match( regex, output, failure_message )
+            ensure
+                Skr::Core.logger=old_logger
+            end
+        end
+
+
+        def assert_saves( model )
+            assert model.save, "#{model.class} failed to save: #{model.errors.full_messages.join(',')}"
+        end
+        def refute_saves( model, *errors )
+            refute model.save, "#{model.class} saved successfully when it should not have"
+            errors.each do |error|
+                if model.errors[error.to_sym].empty?
+                    raise MiniTest::Assertion, "expected #{model.class} to have an error on #{error}"
+                end
+            end
+
+        end
+
+
+        def assert_event_fires( klass, event, &block )
+            @event_results = []
+            klass.observe(event) do | *args |
+                @event_results = args
+            end
+            yield
+            raise MiniTest::Assertion, "Event #{event} was not fired" if @event_results.empty?
+        end
+
+        def last_event_results
+            @event_results
+        end
+    end
+end

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

@@ -0,0 +1,25 @@
+module FixtureHelpers
+
+    extend ActiveSupport::Concern
+
+    included do
+        alias_method_chain :table_rows, :custom_autoset_fields
+    end
+
+    def table_rows_with_custom_autoset_fields
+        results = table_rows_without_custom_autoset_fields
+        if model_class
+            results[ table_name ].each do | row |
+                row['visible_id'] = Skr::SequentialId.next_for( model_class ) if model_class.column_names.include?('visible_id')
+                row['hash_code' ] = Skr::Core::Strings.random if model_class.column_names.include?('hash_code')
+                row['created_at'] = Time.now if model_class.column_names.include?('created_at')
+                row['updated_at'] = Time.now if model_class.column_names.include?('updated_at')
+                row['created_by_id'] = 593363170  if model_class.column_names.include?('created_by_id')
+                row['updated_by_id'] = 593363170 if model_class.column_names.include?('updated_by_id')
+            end
+        end
+        results
+    end
+end
+
+ActiveRecord::FixtureSet.send :include, FixtureHelpers

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

@@ -0,0 +1,53 @@
+
+
+office:
+  name: Argosity Office
+  line1: 619 E Capitol Ave
+  city: Jefferson City
+  state: Missouri
+  postal_code: 65101
+
+junk:
+  name: Junk Spot
+  line1: 623 E Capitol Ave
+  city: Jefferson City
+  state: Missouri
+  postal_code: 65101
+
+amazon:
+  name: Amazon, Inc.
+  line1: 1200 12th Ave. South, Ste. 1200
+  city: Seattle
+  state: WA
+  postal_code: 98144
+
+away:
+  name: Away
+  line1: 12727 Southview Dr
+  city: Holts Summit
+  state: Missouri
+  postal_code: 65043
+
+bigco:
+  name: Big Co
+  email: orders@bgigco.biz
+  line1: 23 Wall Street
+  city: Manhattan
+  state: New York
+  postal_code: 10005
+
+bigco_wh:
+  name: Big Co WH
+  line1: Industrial Drive
+  city: Manhattan
+  state: New York
+  postal_code: 10005
+
+joe:
+  name: Joe Man
+  line1: joe
+  city: Freeburg
+  state: Missouri
+  postal_code: 12344
+
+  

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

@@ -0,0 +1,43 @@
+
+
+argosity:
+  code: ARGOSITY
+  terms: net30
+  name: Argosity
+  shipping_address: office
+  billing_address: away
+  gl_receivables_account: ar
+  open_balance: 13.88
+
+web_customer:
+  code: WEB
+  terms: cred_card
+  name: Website Customer
+  shipping_address: office
+  billing_address: away
+  gl_receivables_account: ar
+
+antonio:
+  code: KILLER
+  terms: cash
+  name: Antonio Montoya
+  shipping_address: office
+  billing_address: away
+  gl_receivables_account: ar
+
+
+joe:
+  code: JOE
+  terms: 10net30
+  name: Joe Man
+  shipping_address: joe
+  billing_address: joe
+  gl_receivables_account: ar
+
+bigco:
+  code: BIGCO
+  terms: 10net30
+  name: Big Company
+  shipping_address: bigco
+  billing_address:  bigco
+  gl_receivables_account: ar

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

@@ -0,0 +1,86 @@
+
+cash:
+  number: 1010
+  name: Cash
+  description: Checking account balance (as shown in company records), currency, coins, checks received from customers but not yet deposited.
+
+bank_checking:
+  number: 1011
+  name: Cash
+  description: Checking account balance (as shown in company records), currency, coins, checks received from customers but not yet deposited.
+
+inventory:
+  number: 1100
+  name: Inventory Assets
+  description: Inventory on hand and awaiting sale
+
+transfers:
+  number: 1115
+  name: Inventory in Transist
+  description: Inventory on a transfer between locations
+
+deposits:
+  number: 1200
+  name: Deposits
+  description: Deposit holding account
+
+inv_recpt:
+  number: 2600
+  name: Accounts Receivable Clearing
+  description: Inventory Receipts clearing
+
+ar:
+  number: 1220
+  name: Accounts Receivable
+  description: Amounts owed to the company for services performed or products sold but not yet paid for.
+
+tax:
+  number: 2250
+  name: Sales Tax Recv
+  description: Tax collected
+
+ap:
+  number: 2200
+  name: Accounts Payable
+  description: Amounts owed to the outside vendors for services performed or products received but not yet paid for.
+
+retained_earnings:
+  number: 3100
+  name: Retained Earnings
+  description: Stockholders equity (Common Stock, Retained Earnings)
+
+sales:
+  number: 4000
+  name: Sales
+  description: Amounts earned from selling physical goods. When a sale is provided on credit, both this account and Accounts Receivable will increase. When a service is provided for immediate cash, both this account and Cash will increase.
+
+marketing:
+  number: 6100
+  name: Marketing
+  description: Marketing Expenses
+
+inventory_write_off:
+  number: 6800
+  name: Inv Write Off
+  description: Cost of inventory written off
+
+
+inventory_purchase:
+  number: 5000
+  name: Merchandise Inventory Purchases
+  description: Expenses incurred purchasing items for resale
+
+rent:
+  number: 6600
+  name: Rent Expense
+  description: Cost of occupying rented facilities during the accounting period.
+
+shipping:
+  number: 6410
+  name: Outbound Shipping Expense
+  description: Cost of shipping products to customers
+
+inbound_shipping:
+  number: 6420
+  name: Inbound Shipping Expense
+  description: Cost of vendors shipping products to us