stockor-core 0.2

data/lib/skr/core/db.rb

@@ -0,0 +1,82 @@
+require_relative 'db/seed'
+
+module Skr
+    module Core
+        module DB
+            extend self
+
+            attr_accessor(:config_file)
+
+            def establish_connection( env = ENV['RAILS_ENV'] || 'development')
+                file = config_file || 'config/database.yml'
+                config = YAML::load( IO.read( file ) )
+                ::ActiveRecord::Base.configurations = config
+                self.connect( ::ActiveRecord::Base.configurations[ env ] )
+            end
+
+            def connect( configuration )
+                ::ActiveRecord::Base.establish_connection( configuration )
+            end
+
+            def migration_exists?( file_name ) #:nodoc:
+                Dir.glob("#{migrations_dir}/[0-9]*_*.rb").grep(/\d+_#{file_name}.rb$/).first
+            end
+
+            def configure_rake_environment
+                ActiveRecord::Tasks::DatabaseTasks.seed_loader = Skr::Core::DB
+                env = ENV['RAILS_ENV'] || 'development'
+                Skr::Core::DB.config_file ||= 'config/database.yml'
+                ENV['SCHEMA'] ||= 'db/schema.sql'
+                ENV['DB_STRUCTURE'] ||= 'db/schema.sql'
+                ActiveRecord::Base.schema_format = :sql
+                Skr::Core::DB.establish_connection( env )
+                ActiveRecord::Tasks::DatabaseTasks.database_configuration = ActiveRecord::Base.configurations
+                ActiveRecord::Tasks::DatabaseTasks.env = 'test'
+                ActiveRecord::Tasks::DatabaseTasks.migrations_paths = 'db/migrate'
+                ActiveRecord::Tasks::DatabaseTasks.current_config( :config => ActiveRecord::Base.configurations[ env ] )
+            end
+
+            def create_migration( migration_name )
+                STDERR.puts "Migration #{migration_name} already exists!" and return false if migration_exists?( migration_name )
+                migration_number = Time.now.utc.strftime("%Y%m%d%H%M%S")
+                migration_file = File.join(migrations_dir, "#{migration_number}_#{migration_name}.rb")
+                migration_class = migration_name.split("_").map(&:capitalize).join
+                File.open(migration_file, 'w') do |file|
+                    file.write <<-MIGRATION.strip_heredoc
+            class #{migration_class} < ActiveRecord::Migration
+                def change
+                end
+            end
+            MIGRATION
+                end
+            end
+
+            def migrate(version = nil)
+                silence_activerecord do
+                    migration_version = version ? version.to_i : version
+                    ::ActiveRecord::Migrator.migrate( migrations_dir, migration_version )
+                end
+            end
+
+            def rollback(step = nil)
+                silence_activerecord do
+                    migration_step = step ? step.to_i : 1
+                    ::ActiveRecord::Migrator.rollback(migrations_dir, migration_step)
+                end
+            end
+
+            private
+
+            def migrations_dir
+                ::ActiveRecord::Migrator.migrations_paths.first
+            end
+
+            def silence_activerecord(&block)
+                old_logger = ::ActiveRecord::Base.logger
+                ::ActiveRecord::Base.logger = nil
+                yield if block_given?
+                ::ActiveRecord::Base.logger = old_logger
+            end
+        end
+    end
+end

data/lib/skr/core/db/migration_helpers.rb

@@ -0,0 +1,178 @@
+require 'skr/core/configuration'
+
+module Skr
+    module Core
+        module DB
+
+            module TableFields
+
+                def skr_code_identifier
+                    column( :code, :string,  :null=>false )
+                    skr_extra_indexes['code'] = {}
+                end
+
+                def skr_visible_id
+                    column( :visible_id, :integer,  :null=>false )
+                    skr_extra_indexes['visible_id'] = {
+                        function: 'CAST(visible_id AS VARCHAR)'
+                    }
+                end
+
+                # track modifications
+                def skr_track_modifications( create_only: false )
+                    column( :created_at, :datetime,   :null=>false )
+                    column( :created_by_id, :integer, :null=>false )
+                    unless create_only
+                        column( :updated_at, :datetime,   :null=>false )
+                        column( :updated_by_id, :integer, :null=>false )
+                    end
+                end
+
+                def skr_currency( names, options )
+                    options[ :precision ] ||= 15
+                    options[ :scale ]     ||= 2
+                    column( names, :decimal, options )
+                end
+
+                # An skr_reference combines a belongs_to / has_one column
+                # with a postgresql foreign key reference.
+                def skr_reference( to_table, *args )
+                    options = args.extract_options!
+
+                    options[:column] ||= to_table.to_s + '_id'
+
+                    column( options[:column], :integer, :null=>options[:null] || false )
+                    to_table = options[:to_table] if options.has_key? :to_table
+
+                    if options[:single]
+                        to_table = to_table.to_s.pluralize
+                    end
+                    skr_foreign_keys[ to_table.to_sym ] = options
+                end
+
+                def skr_foreign_keys
+                    @skr_foreign_keys ||= {}
+                end
+
+                def skr_extra_indexes
+                    @skr_extra_indexs ||= {}
+                end
+            end
+
+            module MigrationMethods
+
+                def create_skr_table(table_name, *args, &block)
+                    definition = nil
+                    create_table( Skr::Core.config.table_prefix + table_name, *args ) do | td |
+                        # Thanks for the trick from the Foreigner gem!
+                        # in connection_adapters/abstract/schema_statements
+                        definition = td
+                        block.call(td) unless block.nil?
+                    end
+                    definition.skr_foreign_keys.each do |to_table, options |
+                        skr_add_foreign_key( table_name, to_table, options )
+                    end
+                    definition.skr_extra_indexes.each do | index_column, options |
+                        skr_add_index( table_name, index_column, options )
+                    end
+                end
+
+                def skr_add_index( table_name, columns, options={} )
+                    table_name = Skr::Core.config.table_prefix + table_name.to_s
+                    if options[:function]
+                        unique = options[:unique] ? 'unique' : ''
+                        name   = table_name + 'indx_' + columns
+                        execute( "create #{unique} index #{name} on #{table_name}(#{options[:function]})" )
+                    else
+                        add_index( table_name, columns, options  )
+                    end
+                end
+
+                def skr_add_foreign_key( table_name, to_table, options = {} )
+                    from_table = Skr::Core.config.table_prefix + table_name.to_s
+                    to_table   = Skr::Core.config.table_prefix + to_table.to_s
+                    # table_name #from_table = Skr::Core.config.table_prefix + table_name
+                    column  = options[:column] || "#{to_table.to_s.singularize}_id"
+                    foreign_key_name = options.key?(:name) ? options[:name].to_s : "#{from_table}_#{column}_fk"
+
+                    primary_key = options[:primary_key] || "id"
+                    dependency = case options[:dependent]
+                                 when :nullify then "ON DELETE SET NULL"
+                                 when :delete  then "ON DELETE CASCADE"
+                                 when :restrict then "ON DELETE RESTRICT"
+                                 else ""
+                                 end
+                    sql = "ALTER TABLE #{quote_table_name(from_table)} " +
+                          "ADD CONSTRAINT #{quote_column_name(foreign_key_name)} " +
+                          "FOREIGN KEY (#{quote_column_name(column)}) " +
+                          "REFERENCES #{quote_table_name( to_table )}(#{primary_key})"
+                    sql << " #{dependency}" if dependency.present?
+                    sql << " #{options[:options]}" if options[:options]
+
+                    execute(sql)
+                end
+
+                def drop_skr_table( table_name, *args )
+                    drop_table( Skr::Core.config.table_prefix + table_name )
+                end
+
+                def remove_skr_index( table_name, column )
+                    remove_index( Skr::Core.config.table_prefix + table_name, column )
+                end
+
+            end
+
+            module CommandRecorder
+                def create_skr_table(*args)
+                    record(:create_skr_table, args)
+                end
+
+                def drop_skr_table(*args)
+                    record(:drop_skr_table, args)
+                end
+
+                def invert_create_skr_table(args)
+                    from_table, to_table, add_options = *args
+                    add_options ||= {}
+                    if add_options[:name]
+                        options = {name: add_options[:name]}
+                    elsif add_options[:column]
+                        options = {column: add_options[:column]}
+                    else
+                        options = to_table
+                    end
+                    [:drop_skr_table, [from_table, options]]
+                end
+
+                def skr_add_index(*args)
+                    record(:skr_add_index,args)
+                end
+                def invert_skr_add_index(args)
+                    table, column = *args
+                    [:remove_skr_index, [table, column]]
+                end
+
+            end
+
+        end
+
+    end
+end
+
+class ActiveRecord::Migration
+    def skr_prefix
+        Skr::Core.config.table_prefix
+    end
+end
+
+ActiveRecord::Migration::CommandRecorder.class_eval do
+    include Skr::Core::DB::CommandRecorder
+end
+
+ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.class_eval do
+    include Skr::Core::DB::MigrationMethods
+end
+
+ActiveRecord::ConnectionAdapters::TableDefinition.class_eval do
+    include Skr::Core::DB::TableFields
+end

data/lib/skr/core/db/migrations.rb

@@ -0,0 +1,15 @@
+require 'pathname'
+
+module Skr
+    module Core
+        module DB
+            module Migrations
+                # The `paths` array is an extension point for other
+                mattr_accessor :paths
+                self.paths = [
+                  Pathname.new(__FILE__).dirname.join("../../../../db/migrate").realpath
+                ]
+            end
+        end
+    end
+end

data/lib/skr/core/db/seed.rb

@@ -0,0 +1,46 @@
+require 'pathname'
+require 'yaml'
+
+module Skr
+
+    module Core
+        module DB
+
+            class Seed
+
+                @@seeds = []
+
+                class << self
+
+                    def add(&block)
+                        @@seeds.push(block)
+                    end
+
+                    # Loads the database with seed models
+                    # Currently loads {GlAccount}, {PaymentTerm}, and {Location}
+                    def execute!
+                        seeds_path = Pathname.new(__FILE__).dirname.join('seed')
+                        unless Location.default
+                            Location.create( code: Core.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
+
+                        @@seeds.each(&:call)
+                    end
+
+                end
+
+            end
+
+        end
+    end
+end

data/lib/skr/core/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
+