stockor-core 0.2

data/README.md

@@ -0,0 +1,88 @@
+# Stockor Core
+
+Stockor is a ERP system that contains all the tools you'll need to run a small to medium sized business on the internet.
+
+The core gem records business activity for a company to include:
+
+ * Invoicing
+ * Sales Orders
+ * Purchase Orders
+ * SKUs
+ * Multi-Location Inventory management
+ * Customers
+ * Vendors
+ * General Ledger chart of accounts
+
+## Read more at [stockor.org](http://stockor.org/)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'stockor-core'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install stockor-core
+
+Usage
+------------------------------
+
+##### Creating a GL posting
+
+       require 'skr/core'
+       customer = Customer.find_by_code "MONEYBAGS"
+       GlTransaction.record( source: invoice, description: "Invoice Example" ) do | transaction |
+         transaction.location = Location.default # <- could also specify in record's options
+         Sku.where( code: ['HAT','STRING'] ).each do | sku |
+           transaction.add_posting( amount: sku.default_price,
+                                    debit:  sku.gl_asset_account,
+                                    credit: customer.gl_receivables_account )
+         end
+       end
+
+##### Create a SalesOrder
+
+        customer = Customer.find_by_code "VIP1"
+        so = SalesOrder.new( customer: customer )
+        Sku.where( code: ['HAT','STRING'] ).each do | sku |
+            so.lines.build(
+              sku_loc: sku.sku_locs.default
+            )
+        end
+        so.save
+
+##### Create a PurchaseOrder
+
+        vendor = Vendor.find_by_code "BIGCO"
+        po = PurchaseOrder.new( vendor: vendor )
+        Sku.where( code: ['HAT','STRING'] ).each do | sku |
+            po.lines.build(
+              sku_vendor: sku.sku_vendors.for_vendor( vendor )
+            )
+        end
+        po.save
+
+#### Create an Invoice
+
+        invoice = Invoice.new( customer: Customer.find_by_code("ACME")
+        invoice.lines.build({ sku: Sku.find_by_code('LABOR'), qty: 1, price: 8.27 })
+        invoice.save
+
+
+## Contributing
+
+The standard instructions are always good:
+
+ 1. Fork it ( http://github.com/argosity/stockor-core/fork )
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
+ 4. Push to the branch (`git push origin my-new-feature`)
+ 5. Create new Pull Request
+
+
+Really though, if you've got a feature you've added we're glad to work with you.  Get us the code however you're able to and we can figure it out.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'bundler/setup'
+require "bundler/gem_tasks"
+require 'rake/testtask'
+require 'yard'
+require 'yard-activerecord'
+require_relative 'yard_ext/all'
+require 'guard'
+
+Dir.glob('tasks/*.rake').each { |r| load r}
+
+
+Rake::TestTask.new do |t|
+    t.libs << 'test'
+    t.pattern = "test/*_test.rb"
+end
+
+
+YARD::Rake::YardocTask.new do |t|
+    t.files   = ['lib/skr/concerns/*.rb','lib/**/*.rb','db/schema.rb']
+    t.options = ["--title=Stockor Core Documentation",
+                 "--markup=markdown",
+                 "--template-path=yard_ext/templates",
+                 "--readme=README.md"]
+end
+
+
+desc "Open an irb session preloaded with skr-core"
+task :console do
+    require 'irb'
+    require 'irb/completion'
+    require 'pp'
+    require 'skr/core'
+    include Skr
+    Skr::Core::DB.establish_connection
+    ActiveRecord::Base.logger = Logger.new STDOUT
+    ARGV.clear
+    IRB.start
+end
+
+
+task :doc => 'db:environment' do
+    env = ENV['RAILS_ENV'] || 'development'
+    ENV['SCHEMA']       = 'db/schema.rb'
+    ENV['DB_STRUCTURE'] = 'db/schema.rb'
+    Rake::Task["db:schema:dump"].invoke
+    Rake::Task["yard"].invoke
+end
+
+
+task :guard => [ 'db:migrate', 'db:test:clone_structure' ] do
+    # NAS: I've never figured out how to run Guard from a rake task
+    # Guard.setup
+    # Guard.run_all
+    # ^ this will work but only runs the task once
+    # and doesn't listen for changes.  Which kinda defeats the purpose
+    # For now just shell out until I can figure it out
+    sh "bundle exec guard"
+end

data/config/database.yml

@@ -0,0 +1,9 @@
+development:
+  adapter: postgresql
+  database: skr_dev
+  host: /tmp
+
+test:
+  adapter: postgresql
+  database: skr_test
+  host: /tmp

data/db/migrate/20120110142845_create_skr_sequential_ids.rb

@@ -0,0 +1,35 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrSequentialIds < ActiveRecord::Migration
+    def up
+        # rails can suck it here, there's no reason to have a id(int)
+        create_skr_table :sequential_ids, :id=>false do |t|
+            t.string :name, :null=>false
+            t.integer :current_value, :null=>false, :default=>0
+        end
+
+        execute "alter table #{Skr::Core.config.table_prefix}sequential_ids add primary key (name)"
+        execute <<-EOS
+create or replace function #{Skr::Core.config.table_prefix}next_sequential_id( varchar )
+returns integer AS '
+declare
+    next_id integer;
+begin
+    select current_value into next_id from skr_sequential_ids where name = $1 for update;
+    if not found then
+        insert into skr_sequential_ids ( name, current_value ) values ( $1, 1 );
+        return 1;
+    else
+        update skr_sequential_ids set current_value = next_id+1 where name = $1;
+        return next_id+1;
+    end if;
+end;
+' language plpgsql;
+EOS
+    end
+
+    def down
+        drop_skr_table :sequential_ids
+        execute "drop function #{Skr::Core.config.table_prefix}next_sequential_id(varchar)"
+    end
+end

data/db/migrate/20140202185309_create_skr_gl_accounts.rb

@@ -0,0 +1,15 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrGlAccounts < ActiveRecord::Migration
+    def change
+
+        create_skr_table "gl_accounts" do |t|
+            t.string   "number",                       null: false
+            t.string   "name",                         null: false
+            t.text     "description",                  null: false
+            t.boolean  "is_active",     default: true, null: false
+            t.skr_track_modifications
+          end
+
+    end
+end

data/db/migrate/20140202193316_create_skr_gl_periods.rb

@@ -0,0 +1,16 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrGlPeriods < ActiveRecord::Migration
+
+    def change
+
+        create_skr_table "gl_periods" do |t|
+            t.integer  "year",     limit: 2, null: false
+            t.integer  "period",   limit: 2, null: false
+            t.boolean  "is_locked", default: false, null: false
+            t.skr_track_modifications
+          end
+
+    end
+
+end

data/db/migrate/20140202193318_create_skr_gl_transactions.rb

@@ -0,0 +1,14 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrGlTransactions < ActiveRecord::Migration
+    def change
+
+        create_skr_table "gl_transactions" do |t|
+            t.skr_reference "period",       to_table: 'gl_periods'
+            t.belongs_to    "source",       polymorphic: true
+            t.text          "description",  null: false
+            t.skr_track_modifications       create_only: true # since it can't be updated
+          end
+
+    end
+end

data/db/migrate/20140202193319_create_skr_gl_postings.rb

@@ -0,0 +1,16 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrGlPostings < ActiveRecord::Migration
+    def change
+        create_skr_table "gl_postings" do |t|
+            t.skr_reference :gl_transaction,   single: true
+            t.string       "account_number",   null: false
+            t.skr_currency "amount",           null: false
+            t.boolean      "is_debit",         null: false
+            t.integer      "year",             null: false, limit: 2
+            t.integer      "period",           null: false, limit: 2
+            t.skr_track_modifications          create_only: true # since it can't be updated
+        end
+        skr_add_index :gl_postings, [:period,:year,:account_number]
+    end
+end

data/db/migrate/20140202193700_create_skr_gl_manual_entries.rb

@@ -0,0 +1,13 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrGlManualEntries < ActiveRecord::Migration
+    def change
+
+        create_skr_table "gl_manual_entries" do |t|
+            t.skr_visible_id
+            t.text "notes"
+            t.skr_track_modifications
+          end
+
+    end
+end

data/db/migrate/20140213040608_create_skr_payment_terms.rb

@@ -0,0 +1,16 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrPaymentTerms < ActiveRecord::Migration
+    def change
+
+        create_skr_table "payment_terms" do |t|
+            t.skr_code_identifier
+            t.integer  "days",             null: false, :default=>0
+            t.string   "description",      null: false
+            t.integer  "discount_days"
+            t.string   "discount_amount"
+            t.skr_track_modifications
+        end
+
+    end
+end

data/db/migrate/20140220031700_create_skr_addresses.rb

@@ -0,0 +1,19 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrAddresses < ActiveRecord::Migration
+    def change
+
+        create_skr_table "addresses" do |t|
+            t.string   "name"
+            t.string   "email"
+            t.string   "phone"
+            t.string   "line1"
+            t.string   "line2"
+            t.string   "city"
+            t.string   "state"
+            t.string   "postal_code"
+            t.skr_track_modifications
+          end
+
+    end
+end

data/db/migrate/20140220031800_create_skr_locations.rb

@@ -0,0 +1,19 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrLocations < ActiveRecord::Migration
+    def change
+
+        create_skr_table "locations" do |t|
+            t.skr_code_identifier
+            t.string   "name",           null: false
+            t.skr_reference :address,    null: false, single: true
+            t.boolean  "is_active",      null: false, default: true
+            t.string   "gl_branch_code",
+                       default: Skr::Core.config.default_branch_code,
+                       null: false,
+                       limit: 2
+            t.skr_track_modifications
+          end
+
+    end
+end

data/db/migrate/20140220190836_create_skr_vendors.rb

@@ -0,0 +1,22 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrVendors < ActiveRecord::Migration
+    def change
+
+        create_skr_table "vendors" do |t|
+            t.skr_reference :billing_address,     null: false, to_table: :addresses
+            t.skr_reference :shipping_address,    null: false, to_table: :addresses
+            t.skr_reference :terms,               null: false, to_table: :payment_terms
+            t.skr_reference :gl_payables_account, null: false, to_table: :gl_accounts
+            t.skr_reference :gl_freight_account,  null: false, to_table: :gl_accounts
+            t.string   "code",                    null: false
+            t.string   "hash_code",               null: false
+            t.string   "name",                    null: false
+            t.text     "notes"
+            t.string   "account_code"
+            t.string   "website"
+            t.skr_track_modifications
+          end
+
+    end
+end

data/db/migrate/20140220203029_create_skr_customers.rb

@@ -0,0 +1,22 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrCustomers < ActiveRecord::Migration
+    def change
+
+        create_skr_table "customers" do |t|
+            t.skr_code_identifier
+            t.skr_reference :billing_address,        null: false, to_table: :addresses
+            t.skr_reference :shipping_address,       null: false, to_table: :addresses
+            t.skr_reference :terms,                  null: false, to_table: :payment_terms
+            t.skr_reference :gl_receivables_account, null: false, to_table: :gl_accounts
+            t.skr_currency :credit_limit,            default: 0.0
+            t.skr_currency :open_balance,            default: 0.0
+            t.string   "hash_code",                  null: false
+            t.string   "name",                       null: false
+            t.text     "notes"
+            t.text     "website"
+            t.hstore   "options", default: {}
+            t.skr_track_modifications
+        end
+    end
+end

data/db/migrate/20140224034759_create_skr_skus.rb

@@ -0,0 +1,22 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrSkus < ActiveRecord::Migration
+
+    def change
+
+        create_skr_table "skus" do |t|
+            t.skr_reference "default_vendor",   null: false, to_table: 'vendors'
+            t.skr_reference "gl_asset_account", null: false, to_table: 'gl_accounts'
+            t.string   "default_uom_code",      null: false
+            t.string   "code",                  null: false
+            t.string   "description",           null: false
+            t.boolean  "is_other_charge",       null: false, default: false
+            t.boolean  "does_track_inventory",  null: false, default: false
+            t.boolean  "can_backorder",         null: false, default: false
+            t.skr_track_modifications
+        end
+
+        #skr_add_index :
+    end
+
+end

data/db/migrate/20140225032853_create_skr_sku_locs.rb

@@ -0,0 +1,21 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrSkuLocs < ActiveRecord::Migration
+
+    def change
+
+        create_skr_table "sku_locs" do |t|
+            t.skr_reference :sku,       null: false, single: true
+            t.skr_reference :location,  null: false, single: true
+            t.decimal  "mac",            precision: 15, scale: 4, default: 0.0, null: false
+            t.integer  "qty",            default: 0,   null: false
+            t.integer  "qty_allocated",  default: 0,   null: false
+            t.integer  "qty_picking",    default: 0,   null: false
+            t.integer  "qty_reserved",   default: 0,   null: false
+            t.string   "bin"
+            t.skr_track_modifications
+        end
+
+
+    end
+end

data/db/migrate/20140320030501_create_skr_uoms.rb

@@ -0,0 +1,19 @@
+require 'skr/core/db/migration_helpers'
+
+class CreateSkrUoms < ActiveRecord::Migration
+    def change
+
+        create_skr_table "uoms" do |t|
+            t.skr_reference :sku,  null: false, single: true
+            t.skr_currency "price",    null: false, precision: 15, scale: 2
+            t.integer      "size",     null: false, default: 1, limit: 2
+            t.string       "code",     null: false, default: "EA"
+            t.decimal      "weight",   precision: 6,  scale: 1
+            t.decimal      "height",   precision: 6,  scale: 1
+            t.decimal      "width",    precision: 6,  scale: 1
+            t.decimal      "depth",    precision: 6,  scale: 1
+            t.skr_track_modifications
+        end
+
+    end
+end