keepr 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 22676859e13394e7e8c59591b1419b2cd0cb18ed
-  data.tar.gz: 305b1e01ebb0d82b85b05823c7f48313d276a535
+  metadata.gz: 41676e1855dcb2af4b7df3fad8ed257251832317
+  data.tar.gz: eb275e943f86edd5efa5cf2b92fe4627ef28d152
 SHA512:
-  metadata.gz: f1bf2927bffefa894f91ef505973958195a922d3cb0486974986a65722e81ac6260cb237b18723fdec717517a6b9f987503a9f2ff93553e919e024addaaaa00d
-  data.tar.gz: 642fc11d40a0ad3cf0a5e9336abaf1d719030851d2d54a10ab259ee15ba28a0cdea9d685441aa4b5657a6162ed41434a5abc838d4dc3a53e43602cf36765decd
+  metadata.gz: a491c1d52227749de2aca883072cb6f91ded6a09cc8f51dbee18353a22b3ec12c8150201b269e5f60f361d57b7786959e54afccba7eecf12fb73c5c962db37f9
+  data.tar.gz: c1e1703a56d273389ba00bd2dd4360941b933d72f4ddb3778f88d665175b940dfb5da38901996e4763ff82bdb690d27eef41648a0b0b6e6a596d5159494fb584

data/.travis.yml

@@ -1,8 +1,8 @@
 language: ruby
 rvm:
   - 1.9.3
-  - 2.1.5
-  - 2.2.0
+  - 2.1.6
+  - 2.2.2
 gemfile:
   - ci/Gemfile-rails-4-1
   - ci/Gemfile-rails-4-2

data/README.md

@@ -3,7 +3,7 @@
 This Ruby gem provides a double entry accounting system for use in any Rails application. It stores all the data via ActiveRecord in the SQL database.
 
 [![Build Status](https://travis-ci.org/ledermann/keepr.svg?branch=master)](https://travis-ci.org/ledermann/keepr)
-
+[![Coverage Status](https://coveralls.io/repos/ledermann/keepr/badge.svg?branch=master)](https://coveralls.io/r/ledermann/keepr?branch=master)
 
 ## Features
 

data/ci/Gemfile-rails-4-1

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.1.0'
+gem 'activerecord', '~> 4.1.10'
 gem 'ancestry'
 gem 'sqlite3'
 gem 'rake'
@@ -9,3 +9,4 @@ gem 'simplecov'
 gem 'coveralls'
 gem 'database_cleaner'
 gem 'factory_girl'
+gem 'coveralls'

data/ci/Gemfile-rails-4-2

@@ -1,6 +1,6 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.2.0'
+gem 'activerecord', '~> 4.2.1'
 gem 'ancestry'
 gem 'sqlite3'
 gem 'rake'
@@ -9,3 +9,4 @@ gem 'simplecov'
 gem 'coveralls'
 gem 'database_cleaner'
 gem 'factory_girl'
+gem 'coveralls'

data/keepr.gemspec

@@ -28,4 +28,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'factory_girl'
+  spec.add_development_dependency 'coveralls'
 end

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

@@ -46,6 +46,7 @@ class KeeprMigration < ActiveRecord::Migration
       t.string   :subject
       t.references :accountable, :polymorphic => true
       t.text     :note
+      t.boolean  :permanent, :null => false, :default => false
       t.datetime :created_at
       t.datetime :updated_at
     end

data/lib/keepr/account.rb

@@ -3,7 +3,7 @@ class Keepr::Account < ActiveRecord::Base
 
   has_ancestry :orphan_strategy => :restrict
 
-  enum :kind => [ :asset, :liability, :revenue, :expense, :neutral ]
+  enum :kind => [ :asset, :liability, :revenue, :expense, :neutral, :debtor, :creditor ]
 
   validates_presence_of :number, :name
   validates_uniqueness_of :number
@@ -19,14 +19,21 @@ class Keepr::Account < ActiveRecord::Base
 
   default_scope { order(:number) }
 
-  def self.with_sums(date=nil)
+  def self.with_sums(options={})
+    raise ArgumentError unless options.is_a?(Hash)
+
     scope = select('keepr_accounts.*, SUM(amount) AS sum_amount').
               group('keepr_accounts.id').
               joins('LEFT JOIN keepr_postings ON keepr_postings.keepr_account_id = keepr_accounts.id')
 
-    if date
+    date           = options[:date]
+    permanent_only = options[:permanent_only]
+
+    if date || permanent_only
       scope = scope.joins('LEFT JOIN keepr_journals ON keepr_journals.id = keepr_postings.keepr_journal_id')
+    end
 
+    if date
       if date.is_a?(Date)
         scope = scope.where("keepr_journals.id IS NULL OR keepr_journals.date <= '#{date.to_s(:db)}'")
       elsif date.is_a?(Range)
@@ -36,22 +43,24 @@ class Keepr::Account < ActiveRecord::Base
       end
     end
 
+    if permanent_only
+      scope = scope.where("keepr_journals.id IS NULL OR keepr_journals.permanent = #{connection.quoted_true}")
+    end
+
     scope
   end
 
-  def self.merged_with_sums(date=nil)
-    accounts = with_sums(date).to_a
+  def self.merged_with_sums(options={})
+    accounts = with_sums(options).to_a
 
     # Sum up child accounts to parent
     position = 0
     while account = accounts[position] do
-      if account.parent_id
+      if account.parent_id && account.sum_amount
         if parent_account = accounts.find { |a| a.id == account.parent_id }
           parent_account.sum_amount ||= 0
           parent_account.sum_amount += account.sum_amount
           accounts.delete_at(position)
-        else
-          raise
         end
       else
         position += 1
@@ -101,11 +110,11 @@ private
   def group_validation
     if keepr_group.present?
       if asset?
-        errors.add(:kind, 'does match group') unless keepr_group.asset?
+        errors.add(:kind, 'does not match group') unless keepr_group.asset?
       elsif liability?
-        errors.add(:kind, 'does match group') unless keepr_group.liability?
+        errors.add(:kind, 'does not match group') unless keepr_group.liability?
       elsif profit_and_loss?
-        errors.add(:kind, 'does match group') unless keepr_group.profit_and_loss?
+        errors.add(:kind, 'does not match group') unless keepr_group.profit_and_loss?
       else
         errors.add(:kind, 'conflicts with group')
       end

data/lib/keepr/active_record_extension.rb

@@ -4,8 +4,14 @@ module Keepr::ActiveRecordExtension
   end
 
   module ClassMethods
-    def has_keepr_account
+    def has_one_keepr_account
       has_one :keepr_account, :class_name => 'Keepr::Account', :as => :accountable
+      has_many :keepr_postings, :class_name => 'Keepr::Posting', :through => :keepr_account
+    end
+
+    def has_many_keepr_accounts
+      has_many :keepr_accounts, :class_name => 'Keepr::Account', :as => :accountable
+      has_many :keepr_postings, :class_name => 'Keepr::Posting', :through => :keepr_accounts
     end
 
     def is_keepr_accountable

data/lib/keepr/group.rb

@@ -11,6 +11,8 @@ class Keepr::Group < ActiveRecord::Base
 
   before_validation :get_from_parent
 
+  validate :check_result_and_target
+
   def self.result
     where(:is_result => true).first
   end
@@ -30,4 +32,10 @@ private
       self.target = self.parent.target
     end
   end
+
+  def check_result_and_target
+    if is_result
+      errors.add(:base, 'is_result allowed for liability target only') unless liability?
+    end
+  end
 end

data/lib/keepr/groups_creator.rb

@@ -1,6 +1,8 @@
 # encoding: utf-8
 class Keepr::GroupsCreator
   def initialize(target)
+    raise ArgumentError unless [ :balance, :profit_and_loss ].include?(target)
+
     @target = target
   end
 
@@ -11,8 +13,6 @@ class Keepr::GroupsCreator
       load 'liability.txt', :target => :liability
     when :profit_and_loss
       load 'profit_and_loss.txt', :target => :profit_and_loss
-    else
-      raise ArgumentError
     end
   end
 

data/lib/keepr/journal.rb

@@ -28,6 +28,8 @@ class Keepr::Journal < ActiveRecord::Base
   end
 
   after_initialize :set_defaults
+  before_update :check_permanent
+  before_destroy :check_permanent
 
 private
   def existing_postings
@@ -45,4 +47,11 @@ private
       errors.add(:base, 'Debit does not match credit!')
     end
   end
+
+  def check_permanent
+    if self.permanent_was
+      errors.add(:base, 'Is permanent and cannot be changed!')
+      false
+    end
+  end
 end

data/lib/keepr/version.rb

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

data/spec/account_spec.rb

@@ -28,6 +28,7 @@ describe Keepr::Account do
 
   before :each do
     Keepr::Journal.create! :date => Date.yesterday,
+                           :permanent => true,
                            :keepr_postings_attributes => [
                              { :keepr_account => account_1000, :amount => 20, :side => 'debit' },
                              { :keepr_account => account_1200, :amount => 20, :side => 'credit' }
@@ -52,20 +53,38 @@ describe Keepr::Account do
                             ]
   end
 
-  describe "with group" do
-    let!(:result_group) { FactoryGirl.create(:group, :is_result => true) }
-    let!(:normal_group) { FactoryGirl.create(:group, :is_result => false) }
+  describe 'validations' do
+    let!(:result_group)    { FactoryGirl.create(:group, :target => :liability, :is_result => true) }
+    let!(:liability_group) { FactoryGirl.create(:group, :target => :liability) }
+    let!(:asset_group)     { FactoryGirl.create(:group, :target => :asset) }
 
-    it "should not be assigned to result group" do
-      account = FactoryGirl.build(:account, :number => 123, :keepr_group => result_group)
+    it "should not allow assigning to result group" do
+      account = FactoryGirl.build(:account, :keepr_group => result_group)
       expect(account).to_not be_valid
-      expect(account.errors[:keepr_group_id]).to be_present
+      expect(account.errors[:keepr_group_id]).to include('is a result group')
     end
 
-    it "should be assigned to normal group" do
-      account = FactoryGirl.build(:account, :number => 123, :keepr_group => normal_group)
+    it "should not allow assigning asset account to liability group" do
+      account = FactoryGirl.build(:account, :kind => :asset, :keepr_group => liability_group)
+      expect(account).to_not be_valid
+      expect(account.errors[:kind]).to include('does not match group')
+    end
+
+    it "should not allow assigning liability account to asset group" do
+      account = FactoryGirl.build(:account, :kind => :liability, :keepr_group => asset_group)
+      expect(account).to_not be_valid
+      expect(account.errors[:kind]).to include('does not match group')
+    end
+
+    it "should not allow assigning neutral account to asset group" do
+      account = FactoryGirl.build(:account, :kind => :neutral, :keepr_group => asset_group)
+      expect(account).to_not be_valid
+      expect(account.errors[:kind]).to include('conflicts with group')
+    end
+
+    it "should allow target match" do
+      account = FactoryGirl.build(:account, :kind => :asset, :keepr_group => asset_group)
       expect(account).to be_valid
-      expect(account.errors[:keepr_group_id]).to be_blank
     end
   end
 
@@ -99,37 +118,58 @@ describe Keepr::Account do
   end
 
   describe :with_sums do
-    it 'should work without param' do
-      account1, account2 = Keepr::Account.with_sums.having('sum_amount <> 0')
+    context 'without param' do
+      it 'should work' do
+        account1, account2 = Keepr::Account.with_sums
 
-      expect(account1.number).to eq(1000)
-      expect(account1.balance).to eq(110)
-      expect(account2.number).to eq(1200)
-      expect(account2.balance).to eq(-110)
+        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
     end
 
-    it 'should work with Date' do
-      account1, account2 = Keepr::Account.with_sums(Date.yesterday).having('sum_amount <> 0')
+    context 'with date option' do
+      it 'should work with Date' do
+        account1, account2 = Keepr::Account.with_sums(:date => Date.yesterday)
+
+        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 => Date.today..Date.tomorrow)
+
+        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
 
-      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)
+      it 'should raise for other class' do
+        expect { Keepr::Account.with_sums(:date => Time.current) }.to raise_error(ArgumentError)
+        expect { Keepr::Account.with_sums(:date => :foo)         }.to raise_error(ArgumentError)
+      end
     end
 
-    it 'should work with Range' do
-      account1, account2 = Keepr::Account.with_sums(Date.today..Date.tomorrow).having('sum_amount <> 0')
+    context 'with permanent_only option' do
+      it 'should filter the permanent journals' do
+        account1, account2 = Keepr::Account.with_sums(:permanent_only => true)
 
-      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)
+        expect(account1.number).to eq(1000)
+        expect(account1.sum_amount).to eq(20)
+        expect(account2.number).to eq(1200)
+        expect(account2.sum_amount).to eq(-20)
+      end
     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)
+    context 'with non-hash param' do
+      it 'should raise' do
+        expect { Keepr::Account.with_sums(0)    }.to raise_error(ArgumentError)
+        expect { Keepr::Account.with_sums(:foo) }.to raise_error(ArgumentError)
+      end
     end
   end
 end
@@ -137,6 +177,7 @@ 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_10001) { FactoryGirl.create(:account, :number => 10001, :parent => account_1400) }
   let!(:account_8400) { FactoryGirl.create(:account, :number => 8400) }
 
   before :each do
@@ -200,7 +241,7 @@ describe Keepr::Account, 'with tax' do
                                  :name      => 'Erlöse 19% USt',
                                  :kind      => :revenue,
                                  :keepr_tax => tax
-    expect(tax_account).to be_valid
+    expect(account).to be_valid
   end
 
   it "should avoid circular reference" do

data/spec/active_record_extension_spec.rb

@@ -1,17 +1,54 @@
 require 'spec_helper'
 
 describe Keepr::ActiveRecordExtension do
-  let!(:account_1000) { FactoryGirl.create(:account, :number => 1000, :kind => :asset) }
-  let!(:account_1200) { FactoryGirl.create(:account, :number => 1200, :kind => :asset) }
+  let(:account_1000) { FactoryGirl.create(:account, :number => 1000, :kind => :asset) }
+  let(:account_1200) { FactoryGirl.create(:account, :number => 1200, :kind => :asset) }
 
   describe 'ledger with associated account' do
-    subject do
-      ledger = Ledger.create! :bank_name => 'Sparkasse'
-      account_1200.update_attributes! :accountable => ledger
-      ledger
+    let(:ledger) { Ledger.create! :bank_name => 'Sparkasse' }
+    let!(:account) { ledger.create_keepr_account! :number => '1250', :kind => :asset, :name => 'Girokonto' }
+
+    it 'has keepr_account' do
+      expect(ledger.keepr_account).to eq(account)
+    end
+
+    it 'has keepr_postings' do
+      journal = Keepr::Journal.create! :keepr_postings_attributes => [
+                               { :keepr_account => account,      :amount => 30, :side => 'debit'  },
+                               { :keepr_account => account_1200, :amount => 30, :side => 'credit' }
+                             ]
+      other_journal = Keepr::Journal.create! :keepr_postings_attributes => [
+                               { :keepr_account => account_1000, :amount => 20, :side => 'debit'  },
+                               { :keepr_account => account_1200, :amount => 20, :side => 'credit' }
+                             ]
+
+      expect(ledger.keepr_postings.count).to eq(1)
+      expect(ledger.keepr_postings.first.amount).to eq(30)
     end
+  end
 
-    it { expect(subject.keepr_account).to be_present }
+  describe 'contact with multiple associated accounts' do
+    let(:contact) { Contact.create! :name => 'John Doe' }
+    let(:account1) { contact.keepr_accounts.create! :number => '70001', :kind => :debtor, :name => "Doe's main account" }
+    let(:account2) { contact.keepr_accounts.create! :number => '70002', :kind => :debtor, :name => "Doe's second account" }
+
+    it 'has multiple keepr_accounts' do
+      expect(contact.keepr_accounts).to eq([account1, account2])
+    end
+
+    it 'has keepr_postings' do
+      journal = Keepr::Journal.create! :keepr_postings_attributes => [
+                               { :keepr_account => account1,     :amount => 30, :side => 'debit'  },
+                               { :keepr_account => account_1200, :amount => 30, :side => 'credit' }
+                             ]
+      other_journal = Keepr::Journal.create! :keepr_postings_attributes => [
+                               { :keepr_account => account_1000, :amount => 20, :side => 'debit'  },
+                               { :keepr_account => account_1200, :amount => 20, :side => 'credit' }
+                             ]
+
+      expect(contact.keepr_postings.count).to eq(1)
+      expect(contact.keepr_postings.first.amount).to eq(30)
+    end
   end
 
   describe 'Document with associated journal' do

data/spec/factories/account.rb

@@ -1,6 +1,6 @@
 FactoryGirl.define do
   factory :account, class: Keepr::Account do
-    number 1000
+    number 12345
     kind :asset
     name 'Foo'
   end

data/spec/group_spec.rb

@@ -1,6 +1,21 @@
 require 'spec_helper'
 
 describe Keepr::Group do
+  describe 'validations' do
+    it "should allow is_result for liability" do
+      group = Keepr::Group.new(:is_result => true, :target => :liability, :name => 'foo')
+      expect(group.valid?).to eq(true)
+    end
+
+    [ :asset, :profit_and_loss ].each do |target|
+      it "should not allow is_result for #{target}" do
+        group = Keepr::Group.new(:is_result => true, :target => target, :name => 'foo')
+        expect(group.valid?).to eq(false)
+        expect(group.errors[:base]).to include('is_result allowed for liability target only')
+      end
+    end
+  end
+
   describe :get_from_parent do
     it 'should preset parent' do
       root = FactoryGirl.create :group, :target => :asset

data/spec/journal_spec.rb

@@ -76,6 +76,22 @@ describe Keepr::Journal do
     end
   end
 
+  describe :permanent do
+    before :each do
+      simple_journal.update_attributes! :permanent => true
+    end
+
+    it "should not allow update" do
+      expect(simple_journal.update_attributes :subject => 'foo').to eq(false)
+      expect(simple_journal.errors[:base]).to include('Is permanent and cannot be changed!')
+    end
+
+    it "should not allow destroy" do
+      expect(simple_journal.destroy).to eq(false)
+      expect(simple_journal.errors[:base]).to include('Is permanent and cannot be changed!')
+    end
+  end
+
   describe :postings do
     it 'should return postings' do
       expect(simple_journal.keepr_postings.size).to eq(2)

data/spec/spec_helper.rb

@@ -1,3 +1,14 @@
+require 'simplecov'
+require 'coveralls'
+
+SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+  SimpleCov::Formatter::HTMLFormatter,
+  Coveralls::SimpleCov::Formatter
+]
+SimpleCov.start do
+  add_filter '/spec/'
+end
+
 require 'active_record'
 require 'database_cleaner'
 require 'keepr'
@@ -31,6 +42,11 @@ RSpec.configure do |config|
     DatabaseCleaner.clean_with(:truncation)
   end
 
+  config.after(:suite) do
+    KeeprMigration.down
+    SpecMigration.down
+  end
+
   config.before(:each) do
     DatabaseCleaner.start
   end

data/spec/support/contact.rb

@@ -0,0 +1,3 @@
+class Contact < ActiveRecord::Base
+  has_many_keepr_accounts
+end

data/spec/support/ledger.rb

@@ -1,3 +1,3 @@
 class Ledger < ActiveRecord::Base
-  has_keepr_account
+  has_one_keepr_account
 end

data/spec/support/spec_migration.rb

@@ -1,5 +1,9 @@
 class SpecMigration < ActiveRecord::Migration
   def self.up
+    create_table :contacts, force: true do |t|
+      t.string :name
+    end
+
     create_table :ledgers, force: true do |t|
       t.string :bank_name
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keepr
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -122,6 +122,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Double entry bookkeeping with Rails
 email: mail@georg-ledermann.de
 executables: []
@@ -165,6 +179,7 @@ files:
 - spec/journal_spec.rb
 - spec/posting_spec.rb
 - spec/spec_helper.rb
+- spec/support/contact.rb
 - spec/support/document.rb
 - spec/support/ledger.rb
 - spec/support/spec_migration.rb
@@ -189,7 +204,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Some basic ActiveRecord models to build a double entry bookkeeping application
@@ -207,6 +222,7 @@ test_files:
 - spec/journal_spec.rb
 - spec/posting_spec.rb
 - spec/spec_helper.rb
+- spec/support/contact.rb
 - spec/support/document.rb
 - spec/support/ledger.rb
 - spec/support/spec_migration.rb