deb 0.0.1

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2013 YOURNAME
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Deb'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+
+Bundler::GemHelper.install_tasks
+

data/app/models/deb/account.rb

@@ -0,0 +1,28 @@
+module Deb
+  class Account < ActiveRecord::Base
+    belongs_to :reference, polymorphic: true
+    has_many :items
+    has_many :transactions, through: :items
+
+    validates :kind, inclusion: {in: %w(asset liability equity revenue expense)}
+
+    attr_accessible :name, :kind, :short_name, :contra
+
+    def self.[](some_shot_name)
+      where(short_name: some_shot_name).first
+    end
+
+    ACCOUNTS_POSITIONS = {
+      "debit" => ["asset", "expense"],
+      "credit" => ["liability", "equity", "revenue"]
+    }
+
+    def can_be_in?(position)
+      ACCOUNTS_POSITIONS[contra? ? self.class.swap_position(position) : position].member?(kind)
+    end
+
+    def self.swap_position(value)
+      "debit" == value ? "credit" : "debit"
+    end
+  end
+end

data/app/models/deb/item.rb

@@ -0,0 +1,36 @@
+module Deb
+  class Item < ActiveRecord::Base
+    belongs_to :account
+    belongs_to :transaction
+    validates :kind, inclusion: {in: %w(debit credit)}
+    validates :account_id, presence: true
+    validate :account_kind
+    validate :positive_amount
+
+    after_create :update_balances
+
+    attr_accessible :account, :amount
+
+    def account_kind
+      errors.add(:account_id, "account cannot be in #{kind}") if !account || !account.can_be_in?(kind)
+    end
+
+    def positive_amount
+      errors.add(:amount, "should be positive") unless amount > 0
+    end
+
+    def update_balances
+      return if @balances_updated
+      @balances_updated = true
+      self.balance_before = account.current_balance
+      self.balance_after = account.current_balance + op_sign * amount
+      save!
+      account.current_balance = balance_after
+      account.save!
+    end
+
+    def op_sign
+      "debit" == kind ? -1 : 1
+    end
+  end
+end

data/app/models/deb/transaction.rb

@@ -0,0 +1,32 @@
+module Deb
+  class Transaction < ActiveRecord::Base
+    belongs_to :reference, polymorphic: true
+    has_many :items
+    has_many :accounts, through: :items
+    has_many :debit_items, class_name: "Deb::Item", conditions: {kind: "debit"}
+    has_many :debit_accounts, through: :debit_items
+    has_many :credit_items, class_name: "Deb::Item", conditions: {kind: "credit"}
+    has_many :credit_accounts, through: :credit_items
+
+    validate :proper_amounts
+
+    attr_accessible :reference, :description
+
+    def self.start(&block)
+      Docile.dsl_eval(Deb::Builder.new, &block).build
+    end
+
+    def self.start!(&block)
+      transaction do
+        start(&block).save!
+      end
+    end
+
+    def proper_amounts
+      errors.add(:base, "no debit items") if debit_items.blank?
+      errors.add(:base, "no credit items") if credit_items.blank?
+      errors.add(:base, "wrong credit total is not equal debit total") unless credit_items.collect(&:amount).reduce(:+) == debit_items.collect(&:amount).reduce(:+)
+    end
+
+  end
+end

data/lib/deb/builder.rb

@@ -0,0 +1,41 @@
+module Deb
+  class Builder
+    attr_reader :debits, :credits, :description, :reference
+
+    def debit(account, amount)
+      @debits ||= {}
+      @debits[account] = amount
+    end
+
+    def credit(account, amount)
+      @credits ||= {}
+      @credits[account] = amount
+    end
+
+    def description(desc)
+      @description = desc
+    end
+
+    def reference(ref)
+      @reference = ref
+    end
+
+    def initialize
+      @debits ||= {}
+      @credits ||= {}
+    end
+
+    def build
+      Deb::Transaction.new(description: @description, reference: @reference) do |t|
+        t.reference = @reference
+        credits.each do |account, amount|
+          t.credit_items.build(account: account, amount: amount)
+        end
+        debits.each do |account, amount|
+          t.debit_items.build(account: account, amount: amount)
+        end
+      end
+    end
+
+  end
+end

data/lib/deb/engine.rb

@@ -0,0 +1,8 @@
+require "rails"
+require "docile"
+
+module Deb
+  class Engine < ::Rails::Engine
+    isolate_namespace Deb
+  end
+end

data/lib/deb/version.rb

@@ -0,0 +1,3 @@
+module Deb
+  VERSION = "0.0.1"
+end

data/lib/deb.rb

@@ -0,0 +1,5 @@
+require "deb/engine"
+require "deb/builder"
+
+module Deb
+end

data/lib/generators/deb/deb_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class DebGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+  source_root File.expand_path('../templates', __FILE__)
+
+  def self.next_migration_number(path)
+    Time.now.utc.strftime("%Y%m%d%H%M%S")
+  end
+
+ def create_migration_file
+   migration_template 'migration.rb', 'db/migrate/create_deb_tables.rb'
+ end
+end
+

data/lib/generators/deb/templates/migration.rb

@@ -0,0 +1,40 @@
+class CreateDebTables < ActiveRecord::Migration
+  def self.up
+    create_table :deb_accounts do |t|
+      t.string :name
+      t.string :kind
+      t.string :short_name, limit: 16
+      t.references :reference, polymorphic: true
+      t.boolean :contra
+      t.decimal :current_balance, precision: 20, scale: 2, default: 0
+      t.timestamps
+    end
+    add_index :deb_accounts, :short_name
+    add_index :deb_accounts, [:reference_type, :reference_id, :kind], name: "deb_accounts_default"
+
+    create_table :deb_transactions do |t|
+      t.string :description
+      t.references :reference, polymorphic: true
+      t.timestamps
+    end
+    add_index :deb_transactions, [:reference_type, :reference_id], name: "deb_transactions_default"
+
+    create_table :deb_items do |t|
+      t.string :kind
+      t.integer :account_id
+      t.integer :transaction_id
+      t.decimal :amount, precision: 20, scale: 2, default: 0
+      t.decimal :balance_before, precision: 20, scale: 2, default: 0
+      t.decimal :balance_after, precision: 20, scale: 2, default: 0
+    end 
+    add_index :deb_items, :account_id
+    add_index :deb_items, [:transaction_id, :kind]
+  end
+
+  def self.down
+    drop_table :deb_accounts
+    drop_table :deb_transactions
+    drop_table :deb_items
+  end
+end
+

data/lib/tasks/deb_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :deb do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: deb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Boris Nadion
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-07-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: 
+email:
+- boris@astrails.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- app/models/deb/account.rb
+- app/models/deb/item.rb
+- app/models/deb/transaction.rb
+- lib/deb/builder.rb
+- lib/deb/engine.rb
+- lib/deb/version.rb
+- lib/deb.rb
+- lib/generators/deb/deb_generator.rb
+- lib/generators/deb/templates/migration.rb
+- lib/tasks/deb_tasks.rake
+- MIT-LICENSE
+- Rakefile
+- README.markdown
+homepage: https://github.com/astrails/deb
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3835187591091313650
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3835187591091313650
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Double Entry Bookkeeping for Rails
+test_files: []