keepr 0.0.1

data/lib/keepr/cost_center.rb

@@ -0,0 +1,8 @@
+class Keepr::CostCenter < ActiveRecord::Base
+  self.table_name = 'keepr_cost_centers'
+
+  validates_presence_of :number, :name
+  validates_uniqueness_of :number
+
+  has_many :keepr_postings, :class_name => 'Keepr::Posting', :foreign_key => 'keepr_cost_center_id', :dependent => :restrict_with_error
+end

data/lib/keepr/group.rb

@@ -0,0 +1,33 @@
+class Keepr::Group < ActiveRecord::Base
+  self.table_name = 'keepr_groups'
+
+  has_ancestry :orphan_strategy => :restrict
+
+  enum :target => [ :asset, :liability, :profit_and_loss ]
+
+  validates_presence_of :name
+
+  has_many :keepr_accounts, :class_name => 'Keepr::Account', :foreign_key => 'keepr_group_id', :dependent => :restrict_with_error
+
+  before_validation :get_from_parent
+
+  def self.result
+    where(:is_result => true).first
+  end
+
+  def keepr_postings
+    if is_result
+      Keepr::Posting.joins(:keepr_account).where(:keepr_accounts => { :kind => [ Keepr::Account.kinds[:revenue],
+                                                                                 Keepr::Account.kinds[:expense] ] })
+    else
+      Keepr::Posting.joins(:keepr_account => :keepr_group).merge(self.subtree)
+    end
+  end
+
+private
+  def get_from_parent
+    if self.parent
+      self.target = self.parent.target
+    end
+  end
+end

data/lib/keepr/groups_creator.rb

@@ -0,0 +1,51 @@
+# encoding: utf-8
+class Keepr::GroupsCreator
+  def initialize(target)
+    @target = target
+  end
+
+  def run
+    case @target
+    when :balance then
+      load 'asset.txt', :target => :asset
+      load 'liability.txt', :target => :liability
+    when :profit_and_loss
+      load 'profit_and_loss.txt', :target => :profit_and_loss
+    else
+      raise ArgumentError
+    end
+  end
+
+private
+  def load(filename, options)
+    full_filename = File.join(File.dirname(__FILE__), "groups_creator/#{filename}".downcase)
+    lines = File.readlines(full_filename)
+    last_depth = 0
+    parents = []
+
+    lines.each do |line|
+      # Count leading spaces to calc hierarchy depth
+      depth = line[/\A */].size / 2
+
+      # Remove leading spaces and separate number and name
+      number, name = line.lstrip.match(/^(.*?)\s(.+)$/).to_a[1..-1]
+
+      attributes = options.merge(:name => name, :number => number)
+      if @target == :balance && name == 'Jahresüberschuss/Jahresfehlbetrag'
+        attributes[:is_result] = true
+      end
+
+      if depth == 0
+        parents = []
+        group = Keepr::Group.create!(attributes)
+      else
+        parents.pop if depth <= last_depth
+        parents.pop if depth < last_depth
+        group = parents.last.children.create!(attributes)
+      end
+      parents.push(group)
+
+      last_depth = depth
+    end
+  end
+end

data/lib/keepr/groups_creator/asset.txt

@@ -0,0 +1,36 @@
+A. Anlagevermögen
+  I. Immaterielle Vermögensgegenstände
+    1. Selbst geschaffene gewerbliche Schutzrechte und ähnliche Rechte und Werte
+    2. entgeltlich erworbene Konzessionen, gewerbliche Schutzrechte und ähnliche Rechte und Werte sowie Lizenzen an solchen Rechten und Werten
+    3. Geschäfts- oder Firmenwert
+    4. geleistete Anzahlungen
+  II. Sachanlagen
+    1. Grundstücke, grundstücksgleiche Rechte und Bauten einschließlich der Bauten auf fremden Grundstücken
+    2. technische Anlagen und Maschinen
+    3. andere Anlagen, Betriebs- und Geschäftsausstattung
+    4. geleistete Anzahlungen und Anlagen im Bau
+  III. Finanzanlagen
+    1. Anteile an verbundenen Unternehmen
+    2. Ausleihungen an verbundene Unternehmen
+    3. Beteiligungen
+    4. Ausleihungen an Unternehmen, mit denen ein Beteiligungsverhältnis besteht
+    5. Wertpapiere des Anlagevermögens
+    6. sonstige Ausleihungen
+B. Umlaufvermögen
+  I. Vorräte
+    1. Roh-, Hilfs- und Betriebsstoffe
+    2. unfertige Erzeugnisse, unfertige Leistungen
+    3. fertige Erzeugnisse und Waren
+    4. geleistete Anzahlungen
+  II. Forderungen und sonstige Vermögensgegenstände
+    1. Forderungen aus Lieferungen und Leistungen
+    2. Forderungen gegen verbundene Unternehmen
+    3. Forderungen gegen Unternehmen, mit denen ein Beteiligungsverhältnis besteht
+    4. sonstige Vermögensgegenstände
+  III. Wertpapiere
+    1. Anteile an verbundenen Unternehmen
+    2. sonstige Wertpapiere
+  IV. Kassenbestand, Bundesbankguthaben, Guthaben bei Kreditinstituten und Schecks
+C. Rechnungsabgrenzungsposten
+D. Aktive latente Steuern
+E. Aktiver Unterschiedsbetrag aus der Vermögensverrechnung

data/lib/keepr/groups_creator/liability.txt

@@ -0,0 +1,28 @@
+A. Eigenkapital
+  I. Gezeichnetes Kapital
+  II. Kapitalrücklage
+  III. Gewinnrücklagen
+    1. gesetzliche Rücklage
+    2. Rücklage für Anteile an einem herrschenden oder mehrheitlich beteiligten Unternehmen
+    3. satzungsmäßige Rücklagen
+    4. andere Gewinnrücklagen
+  IV. Gewinnvortrag/Verlustvortrag
+  V. Jahresüberschuss/Jahresfehlbetrag
+B. Rückstellungen
+  1. Rückstellungen für Pensionen und ähnliche Verpflichtungen
+  2. Steuerrückstellungen
+  3. sonstige Rückstellungen
+C. Verbindlichkeiten
+  1. Anleihen
+    davon konvertibel
+  2. Verbindlichkeiten gegenüber Kreditinstituten
+  3. erhaltene Anzahlungen auf Bestellungen
+  4. Verbindlichkeiten aus Lieferungen und Leistungen
+  5. Verbindlichkeiten aus der Annahme gezogener Wechsel und der Ausstellung eigener Wechsel
+  6. Verbindlichkeiten gegenüber verbundenen Unternehmen
+  7. Verbindlichkeiten gegenüber Unternehmen, mit denen ein Beteiligungsverhältnis besteht
+  8. sonstige Verbindlichkeiten
+    a) davon aus Steuern
+    b) davon im Rahmen der sozialen Sicherheit
+D. Rechnungsabgrenzungsposten
+E. Passive latente Steuern

data/lib/keepr/groups_creator/profit_and_loss.txt

@@ -0,0 +1,31 @@
+01. Umsatzerlöse
+02. Erhöhung oder Verminderung des Bestands an fertigen und unfertigen Erzeugnissen
+03. andere aktivierte Eigenleistungen
+04. sonstige betriebliche Erträge
+05. Materialaufwand
+  a) Aufwendungen für Roh-, Hilfs- und Betriebsstoffe und für bezogene Waren
+  b) Aufwendungen für bezogene Leistungen
+06. Personalaufwand
+  a) Löhne und Gehälter
+  b) soziale Abgaben und Aufwendungen für Altersversorgung und für Unterstützung
+    davon für Altersversorgung
+07. Abschreibungen
+  a) auf immaterielle Vermögensgegenstände des Anlagevermögens und Sachanlagen
+  b) auf Vermögensgegenstände des Umlaufvermögens, soweit diese die in der Kapitalgesellschaft üblichen Abschreibungen überschreiten
+08. sonstige betriebliche Aufwendungen
+09. Erträge aus Beteiligungen
+  a) davon aus verbundenen Unternehmen
+10. Erträge aus anderen Wertpapieren und Ausleihungen des Finanzanlagevermögens
+  a) davon aus verbundenen Unternehmen
+11. sonstige Zinsen und ähnliche Erträge
+  a) davon aus verbundenen Unternehmen
+12. Abschreibungen auf Finanzanlagen und auf Wertpapiere des Umlaufvermögens
+13. Zinsen und ähnliche Aufwendungen
+  davon an verbundene Unternehmen
+14. Ergebnis der gewöhnlichen Geschäftstätigkeit
+15. außerordentliche Erträge
+16. außerordentliche Aufwendungen
+17. außerordentliches Ergebnis
+18. Steuern vom Einkommen und vom Ertrag
+19. sonstige Steuern
+20. Jahresüberschuss/Jahresfehlbetrag

data/lib/keepr/journal.rb

@@ -0,0 +1,48 @@
+class Keepr::Journal < ActiveRecord::Base
+  self.table_name = 'keepr_journals'
+
+  validates_presence_of :date
+  validates_uniqueness_of :number, :allow_blank => true
+
+  has_many :keepr_postings, -> { order(:amount => :desc) },
+           :class_name => 'Keepr::Posting', :foreign_key => 'keepr_journal_id', :dependent => :destroy
+
+  belongs_to :accountable, :polymorphic => true
+
+  accepts_nested_attributes_for :keepr_postings, :allow_destroy => true, :reject_if => :all_blank
+
+  default_scope { order({:date => :desc}, {:id => :desc}) }
+
+  validate :validate_postings
+
+  def credit_postings
+    existing_postings.select(&:credit?)
+  end
+
+  def debit_postings
+    existing_postings.select(&:debit?)
+  end
+
+  def amount
+    debit_postings.sum(&:amount)
+  end
+
+  after_initialize :set_defaults
+
+private
+  def existing_postings
+    keepr_postings.to_a.delete_if(&:marked_for_destruction?)
+  end
+
+  def set_defaults
+    self.date ||= Date.today
+  end
+
+  def validate_postings
+    if existing_postings.map(&:keepr_account_id).uniq.length < 2
+      errors.add(:base, 'At least two accounts have to be booked!')
+    elsif existing_postings.sum(&:raw_amount) != 0
+      errors.add(:base, 'Debit does not match credit!')
+    end
+  end
+end

data/lib/keepr/posting.rb

@@ -0,0 +1,74 @@
+class Keepr::Posting < ActiveRecord::Base
+  self.table_name = 'keepr_postings'
+
+  validates_presence_of :keepr_account_id, :amount
+  validate :cost_center_validation
+
+  belongs_to :keepr_account, :class_name => 'Keepr::Account'
+  belongs_to :keepr_journal, :class_name => 'Keepr::Journal'
+  belongs_to :keepr_cost_center, :class_name => 'Keepr::CostCenter'
+
+  SIDE_DEBIT  = 'debit'
+  SIDE_CREDIT = 'credit'
+
+  scope :debits,  -> { where('amount >= 0') }
+  scope :credits, -> { where('amount < 0') }
+
+  def side
+    @side || begin
+      (raw_amount < 0 ? SIDE_CREDIT : SIDE_DEBIT) if raw_amount
+    end
+  end
+
+  def side=(value)
+    @side = value
+
+    if credit?
+      self.raw_amount = -amount if amount
+    elsif debit?
+      self.raw_amount =  amount if amount
+    else
+      raise ArgumentError
+    end
+  end
+
+  def debit?
+    side == SIDE_DEBIT
+  end
+
+  def credit?
+    side == SIDE_CREDIT
+  end
+
+  def raw_amount
+    read_attribute(:amount)
+  end
+
+  def raw_amount=(value)
+    write_attribute(:amount, value)
+  end
+
+  def amount
+    raw_amount.try(:abs)
+  end
+
+  def amount=(value)
+    raise ArgumentError.new('Negative amount not allowed!') if value.to_f < 0
+    @side ||= SIDE_DEBIT
+
+    if credit?
+      self.raw_amount = -value
+    else
+      self.raw_amount = value
+    end
+  end
+
+private
+  def cost_center_validation
+    if keepr_cost_center
+      unless keepr_account.profit_and_loss?
+        errors.add(:keepr_cost_center_id, 'allowed for expense or revenue accounts only')
+      end
+    end
+  end
+end

data/lib/keepr/tax.rb

@@ -0,0 +1,13 @@
+class Keepr::Tax < ActiveRecord::Base
+  self.table_name = 'keepr_taxes'
+
+  validates_presence_of :name, :value, :keepr_account_id
+  validates_numericality_of :value
+
+  belongs_to :keepr_account, :class_name => 'Keepr::Account'
+  has_many :keepr_accounts, :class_name => 'Keepr::Account', :foreign_key => 'keepr_tax_id', :dependent => :restrict_with_error
+
+  validate do |tax|
+    tax.errors.add(:keepr_account_id, 'circular reference') if tax.keepr_account.try(:keepr_tax) == tax
+  end
+end

data/lib/keepr/version.rb

@@ -0,0 +1,3 @@
+module Keepr
+  VERSION = '0.0.1'
+end

data/spec/account_spec.rb

@@ -0,0 +1,210 @@
+# encoding: utf-8
+require 'spec_helper'
+
+describe Keepr::Account do
+  describe :number_as_string do
+    it "should return number with leading zeros for low values" do
+      account = Keepr::Account.new(:number => 999)
+      expect(account.number_as_string).to eq('0999')
+    end
+
+    it "should return number unchanged for high values" do
+      account = Keepr::Account.new(:number => 70000)
+      expect(account.number_as_string).to eq('70000')
+    end
+  end
+
+  describe :to_s do
+    it "should format" do
+      account = Keepr::Account.new(:number => 27, :name => 'Software')
+      expect(account.to_s).to eq('0027 (Software)')
+    end
+  end
+end
+
+describe Keepr::Account do
+  let!(:account_1000) { FactoryGirl.create(:account, :number => 1000) }
+  let!(:account_1200) { FactoryGirl.create(:account, :number => 1200) }
+
+  before :each do
+    Keepr::Journal.create! :date => Date.yesterday,
+                           :keepr_postings_attributes => [
+                             { :keepr_account => account_1000, :amount => 20, :side => 'debit' },
+                             { :keepr_account => account_1200, :amount => 20, :side => 'credit' }
+                            ]
+
+    Keepr::Journal.create! :date => Date.yesterday,
+                           :keepr_postings_attributes => [
+                             { :keepr_account => account_1000, :amount =>  10, :side => 'credit' },
+                             { :keepr_account => account_1200, :amount =>  10, :side => 'debit' },
+                            ]
+
+    Keepr::Journal.create! :date => Date.today,
+                           :keepr_postings_attributes => [
+                             { :keepr_account => account_1000, :amount => 200, :side => 'debit' },
+                             { :keepr_account => account_1200, :amount => 200, :side => 'credit' }
+                            ]
+
+    Keepr::Journal.create! :date => Date.today,
+                           :keepr_postings_attributes => [
+                             { :keepr_account => account_1000, :amount => 100, :side => 'credit' },
+                             { :keepr_account => account_1200, :amount => 100, :side => 'debit' },
+                            ]
+  end
+
+  describe "with group" do
+    let!(:result_group) { FactoryGirl.create(:group, :is_result => true) }
+    let!(:normal_group) { FactoryGirl.create(:group, :is_result => false) }
+
+    it "should not be assigned to result group" do
+      account = FactoryGirl.build(:account, :number => 123, :keepr_group => result_group)
+      expect(account).to_not be_valid
+      expect(account.errors[:keepr_group_id]).to be_present
+    end
+
+    it "should be assigned to normal group" do
+      account = FactoryGirl.build(:account, :number => 123, :keepr_group => normal_group)
+      expect(account).to be_valid
+      expect(account.errors[:keepr_group_id]).to be_blank
+    end
+  end
+
+  describe :balance do
+    it 'should calc total' do
+      expect(account_1000.balance).to eq(110)
+      expect(account_1200.balance).to eq(-110)
+    end
+
+    it 'should calc total for a given date (including)' do
+      expect(account_1000.balance(Date.today)).to eq(110)
+      expect(account_1200.balance(Date.today)).to eq(-110)
+    end
+
+    it 'should calc total for a given date (excluding)' do
+      expect(account_1000.balance(Date.yesterday)).to eq(10)
+      expect(account_1200.balance(Date.yesterday)).to eq(-10)
+    end
+
+    it 'should calc total for Range' do
+      expect(account_1000.balance(Date.yesterday...Date.today)).to eq(110)
+      expect(account_1200.balance(Date.yesterday...Date.today)).to eq(-110)
+
+      expect(account_1000.balance(Date.today...Date.tomorrow)).to eq(100)
+      expect(account_1200.balance(Date.today...Date.tomorrow)).to eq(-100)
+    end
+
+    it 'should fail for other param' do
+      expect { account_1000.balance(0) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe :with_sums do
+    it 'should work without param' do
+      account1, account2 = Keepr::Account.with_sums.having('sum_amount <> 0')
+
+      expect(account1.number).to eq(1000)
+      expect(account1.balance).to eq(110)
+      expect(account2.number).to eq(1200)
+      expect(account2.balance).to eq(-110)
+    end
+
+    it 'should work with Date' do
+      account1, account2 = Keepr::Account.with_sums(Date.yesterday).having('sum_amount <> 0')
+
+      expect(account1.number).to eq(1000)
+      expect(account1.sum_amount).to eq(10)
+      expect(account2.number).to eq(1200)
+      expect(account2.sum_amount).to eq(-10)
+    end
+
+    it 'should work with Range' do
+      account1, account2 = Keepr::Account.with_sums(Date.today..Date.tomorrow).having('sum_amount <> 0')
+
+      expect(account1.number).to eq(1000)
+      expect(account1.sum_amount).to eq(100)
+      expect(account2.number).to eq(1200)
+      expect(account2.sum_amount).to eq(-100)
+    end
+
+    it 'should raise for other param' do
+      expect { Keepr::Account.with_sums(Time.current) }.to raise_error(ArgumentError)
+      expect { Keepr::Account.with_sums(0)            }.to raise_error(ArgumentError)
+      expect { Keepr::Account.with_sums(:foo)         }.to raise_error(ArgumentError)
+    end
+  end
+end
+
+describe Keepr::Account, 'with subaccounts' do
+  let!(:account_1400) { FactoryGirl.create(:account, :number => 1400) }
+  let!(:account_10000) { FactoryGirl.create(:account, :number => 10000, :parent => account_1400) }
+  let!(:account_8400) { FactoryGirl.create(:account, :number => 8400) }
+
+  before :each do
+    Keepr::Journal.create! :date => Date.yesterday,
+                           :keepr_postings_attributes => [
+                             { :keepr_account => account_10000, :amount => 20, :side => 'debit' },
+                             { :keepr_account => account_8400, :amount => 20, :side => 'credit' }
+                            ]
+  end
+
+  describe :keepr_postings do
+    it 'should include postings from descendant accounts' do
+      expect(account_1400.keepr_postings.size).to eq(1)
+      expect(account_10000.keepr_postings.size).to eq(1)
+    end
+  end
+
+  describe :balance do
+    it 'should include postings from descendant accounts' do
+      expect(account_1400.reload.balance).to eq(20)
+      expect(account_10000.reload.balance).to eq(20)
+    end
+
+    it 'should include postings from descendant accounts with date given' do
+      expect(account_1400.balance(Date.today)).to eq(20)
+      expect(account_10000.balance(Date.today)).to eq(20)
+    end
+  end
+
+  describe :with_sums do
+    it 'should calc balance' do
+      expect(Keepr::Account.with_sums.
+                     select { |a| (a.sum_amount || 0) != 0 }.
+                     map { |a| [a.number, a.sum_amount] }).
+                     to eq([[8400, -20], [10000, 20]])
+    end
+  end
+
+  describe :merged_with_sums do
+    it 'should calc merged balance' do
+      expect(Keepr::Account.merged_with_sums.
+                     select { |a| (a.sum_amount || 0) != 0 }.
+                     map { |a| [a.number, a.sum_amount] }).
+                     to eq([[1400, 20], [8400, -20]])
+    end
+  end
+end
+
+describe Keepr::Account, 'with tax' do
+  let!(:tax_account) { Keepr::Account.create! :number => 1776,
+                                              :name => 'Umsatzsteuer 19%',
+                                              :kind => :asset }
+
+  let!(:tax) { Keepr::Tax.create! :name          => 'USt19',
+                                  :description   => 'Umsatzsteuer 19%',
+                                  :value         => 19.0,
+                                  :keepr_account => tax_account }
+
+  it "should link to tax" do
+    account = Keepr::Account.new :number    => 8400,
+                                 :name      => 'Erlöse 19% USt',
+                                 :kind      => :revenue,
+                                 :keepr_tax => tax
+    expect(tax_account).to be_valid
+  end
+
+  it "should avoid circular reference" do
+    tax_account.keepr_tax_id = tax.id
+    expect(tax_account).to be_invalid
+  end
+end