keepr 0.3.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6939306095b85a2adcb973912222080ca16a6819
-  data.tar.gz: 0300cc5a158f99c95f9ce0685500cb3a4690c5d7
+SHA256:
+  metadata.gz: d2680eedcb47403d6bcbae90de674d208f8a9ab06570b20e122c0c641c42e114
+  data.tar.gz: c33827bf895e0e15ea763a5217eb2efa3ff0f9fa5a48ae74ee4c07750a56ee28
 SHA512:
-  metadata.gz: 1ddbc32cc11e4005ba21ddc8fc95fdd2617d199d559c03ea0bf26c6ee5e319ff9e5a19518bee0365e415c564595b26ef69c7ecf9fb96abb7bc2fe16250f8898b
-  data.tar.gz: a064b44c2a03afc6ff936e081d81b20ce427089a78aa5dd75006e3e8b3b9cc8a60d4c9e507a443eeecf4e607a1877a9645ea6489d83da0776c1a34ed1ab77da0
+  metadata.gz: f9c5e2703b9ce01a2aed1b29c096ffc879518a10528fb1f31092c6fb5602c7b566eade957974ec381904525c3d3ff455937fbb38f12fa700778b6d9b06d1256f
+  data.tar.gz: bb4d6e29f65dd0fac3d5b3f3ff764511387e543371df91318bf1117b1a8d4aba9bc9dc245ac94b6a07bdf063aa8f5a93ed70322899067306881b3162e1ac4091

data/.travis.yml

@@ -1,17 +1,21 @@
+os: linux
+dist: xenial
 language: ruby
 rvm:
-  - 2.0.0
-  - 2.1.10
-  - 2.2.5
-  - 2.3.1
+  - 2.5.8
+  - 2.6.6
+  - 2.7.2
 gemfile:
-  - ci/Gemfile-rails-4-1
   - ci/Gemfile-rails-4-2
   - ci/Gemfile-rails-5-0
+  - ci/Gemfile-rails-5-1
+  - ci/Gemfile-rails-5-2
+  - ci/Gemfile-rails-6-0
 matrix:
   exclude:
-    - rvm: 2.0.0
-      gemfile: ci/Gemfile-rails-5-0
-    - rvm: 2.1.10
-      gemfile: ci/Gemfile-rails-5-0
-before_install: gem update bundler
+    - rvm: 2.7.2
+      gemfile: ci/Gemfile-rails-4-2
+script:
+  - bundle exec rake
+before_install:
+  - gem update bundler

data/Gemfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 
 # Specify your gem's dependencies in keepr.gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2016 Georg Ledermann
+Copyright (c) 2013-2020 Georg Ledermann <georg@ledermann.dev>
 
 MIT License
 

data/README.md

@@ -4,7 +4,7 @@ This Ruby gem provides a double entry accounting system for use in any Rails app
 
 [![Build Status](https://travis-ci.org/ledermann/keepr.svg?branch=master)](https://travis-ci.org/ledermann/keepr)
 [![Code Climate](https://codeclimate.com/github/ledermann/keepr/badges/gpa.svg)](https://codeclimate.com/github/ledermann/keepr)
-[![Coverage Status](https://coveralls.io/repos/ledermann/keepr/badge.svg?branch=master)](https://coveralls.io/r/ledermann/keepr?branch=master)
+[![Coverage Status](https://coveralls.io/repos/github/ledermann/keepr/badge.svg?branch=master)](https://coveralls.io/github/ledermann/keepr?branch=master)
 
 ## Features
 
@@ -19,8 +19,8 @@ This Ruby gem provides a double entry accounting system for use in any Rails app
 
 ## Dependencies
 
-* Ruby 2.0.0 or later
-* Rails 4.1 or newer (including Rails 5)
+* Ruby 2.5+
+* Rails 4.2+ (including Rails 6.0)
 
 
 ## Installation
@@ -64,4 +64,4 @@ TODO: Write usage instructions here
 * https://github.com/bigfleet/accountable
 
 
-Copyright (c) 2013-2016 [Georg Ledermann](http://www.georg-ledermann.de), released under the MIT license
+Copyright (c) 2013-2020 [Georg Ledermann](https://ledermann.dev), released under the MIT license

data/Rakefile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec

data/ci/Gemfile-rails-4-2

@@ -1,12 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 4.2.6'
-gem 'ancestry'
-gem 'sqlite3'
+gem 'activerecord', '~> 4.2.11'
+gem 'ancestry', '>= 3.1.0'
+gem 'sqlite3', '~> 1.3.6'
 gem 'rake'
 gem 'rspec'
 gem 'simplecov'
-gem 'coveralls'
+gem 'coveralls', '~> 0.8'
 gem 'database_cleaner'
-gem 'factory_girl'
+gem 'factory_bot'
 gem 'datev'

data/ci/Gemfile-rails-5-0

@@ -1,12 +1,12 @@
 source 'https://rubygems.org'
 
-gem 'activerecord', '~> 5.0.0'
-gem 'ancestry'
-gem 'sqlite3'
+gem 'activerecord', '~> 5.0.7'
+gem 'ancestry', '>= 3.1.0'
+gem 'sqlite3', '~> 1.3.6'
 gem 'rake'
 gem 'rspec'
 gem 'simplecov'
-gem 'coveralls'
+gem 'coveralls', '~> 0.8'
 gem 'database_cleaner'
-gem 'factory_girl'
+gem 'factory_bot'
 gem 'datev'

data/ci/Gemfile-rails-5-1

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.1.7'
+gem 'ancestry', '>= 3.1.0'
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+gem 'coveralls', '~> 0.8'
+gem 'database_cleaner'
+gem 'factory_bot'
+gem 'datev'

data/ci/Gemfile-rails-5-2

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 5.2.3'
+gem 'ancestry', '>= 3.1.0'
+gem "sqlite3", "~> 1.3", ">= 1.3.6"
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+gem 'coveralls', '~> 0.8'
+gem 'database_cleaner'
+gem 'factory_bot'
+gem 'datev'

data/ci/Gemfile-rails-6-0

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+gem 'activerecord', '~> 6.0.0'
+gem 'ancestry', '>= 3.1.0'
+gem 'sqlite3', "~> 1.4"
+gem 'rake'
+gem 'rspec'
+gem 'simplecov'
+gem 'coveralls', '~> 0.8'
+gem 'database_cleaner'
+gem 'factory_bot'
+gem 'datev'

data/keepr.gemspec

@@ -1,34 +1,35 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'keepr/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "keepr"
+  spec.name          = 'keepr'
   spec.version       = Keepr::VERSION
   spec.authors       = 'Georg Ledermann'
-  spec.email         = 'mail@georg-ledermann.de'
-  spec.description   = %q{Double entry bookkeeping with Rails}
-  spec.summary       = %q{Some basic ActiveRecord models to build a double entry bookkeeping application}
+  spec.email         = 'georg@ledermann.dev'
+  spec.description   = 'Double entry bookkeeping with Rails'
+  spec.summary       = 'Some basic ActiveRecord models to build a double entry bookkeeping application'
   spec.homepage      = 'https://github.com/ledermann/keepr'
   spec.license       = 'MIT'
-  spec.required_ruby_version = '>= 2.0.0'
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.files         = `git ls-files`.split($/)
+  spec.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'activerecord', '>= 4.1'
-  spec.add_dependency 'ancestry'
+  spec.add_dependency 'activerecord', '>= 4.2'
+  spec.add_dependency 'ancestry', '>= 3.1.0'
   spec.add_dependency 'datev', '>= 0.5.0'
 
   spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'coveralls', '~> 0.8'
+  spec.add_development_dependency 'database_cleaner'
+  spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'sqlite3'
   spec.add_development_dependency 'rspec'
-  spec.add_development_dependency 'database_cleaner'
-  spec.add_development_dependency 'factory_girl'
-  spec.add_development_dependency 'coveralls'
   spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'sqlite3'
 end

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rails/generators'
 require 'rails/generators/migration'
 
@@ -6,7 +8,7 @@ module Keepr
     include Rails::Generators::Migration
 
     desc 'Generates migration for keepr'
-    source_root File.expand_path('../templates', __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     def create_migration_file
       migration_template 'migration.rb', 'db/migrate/keepr_migration.rb'
@@ -14,9 +16,9 @@ module Keepr
 
     def self.next_migration_number(dirname)
       if ActiveRecord::Base.timestamped_migrations
-        Time.now.utc.strftime("%Y%m%d%H%M%S")
+        Time.now.utc.strftime('%Y%m%d%H%M%S')
       else
-        "%.3d" % (current_migration_number(dirname) + 1)
+        format('%.3d', (current_migration_number(dirname) + 1))
       end
     end
   end

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

@@ -1,55 +1,57 @@
-class KeeprMigration < ActiveRecord::Migration
+# frozen_string_literal: true
+
+class KeeprMigration < Keepr::MIGRATION_BASE_CLASS
   def self.up
     create_table Keepr::Group, force: true do |t|
-      t.integer    :target, :null => false
+      t.integer    :target, null: false
       t.string     :number
-      t.string     :name, :null => false
-      t.boolean    :is_result, :null => false, :default => false
-      t.string     :ancestry, :index => true
+      t.string     :name, null: false
+      t.boolean    :is_result, null: false, default: false
+      t.string     :ancestry, index: true
     end
 
     create_table Keepr::Tax, force: true do |t|
-      t.string     :name, :null => false
+      t.string     :name, null: false
       t.string     :description
-      t.decimal    :value, :precision => 8, :scale => 2, :null => false
-      t.references :keepr_account, :null => false, :index => true
+      t.decimal    :value, precision: 8, scale: 2, null: false
+      t.references :keepr_account, null: false, index: true
     end
 
     create_table Keepr::CostCenter, force: true do |t|
-      t.string     :number, :null => false
-      t.string     :name, :null => false
+      t.string     :number, null: false
+      t.string     :name, null: false
       t.text       :note
     end
 
     create_table Keepr::Account, force: true do |t|
-      t.integer    :number, :null => false, :index => true
-      t.string     :ancestry, :index => true
-      t.string     :name, :null => false
-      t.integer    :kind, :null => false
-      t.references :keepr_group, :index => true
-      t.references :accountable, :polymorphic => true, :index => true
-      t.references :keepr_tax, :index => true
+      t.integer    :number, null: false, index: true
+      t.string     :ancestry, index: true
+      t.string     :name, null: false
+      t.integer    :kind, null: false
+      t.references :keepr_group, index: true
+      t.references :accountable, polymorphic: true, index: true
+      t.references :keepr_tax, index: true
       t.datetime   :created_at
       t.datetime   :updated_at
     end
 
     create_table Keepr::Journal, force: true do |t|
       t.string   :number
-      t.date     :date, :null => false, :index => true
+      t.date     :date, null: false, index: true
       t.string   :subject
-      t.references :accountable, :polymorphic => true, :index => true
+      t.references :accountable, polymorphic: true, index: true
       t.text     :note
-      t.boolean  :permanent, :null => false, :default => false
+      t.boolean  :permanent, null: false, default: false
       t.datetime :created_at
       t.datetime :updated_at
     end
 
     create_table Keepr::Posting, force: true do |t|
-      t.references :keepr_account, :null => false, :index => true
-      t.references :keepr_journal, :null => false, :index => true
-      t.decimal    :amount, :precision => 8, :scale => 2, :null => false
-      t.references :keepr_cost_center, :index => true
-      t.references :accountable, :polymorphic => true, :index => true
+      t.references :keepr_account, null: false, index: true
+      t.references :keepr_journal, null: false, index: true
+      t.decimal    :amount, precision: 8, scale: 2, null: false
+      t.references :keepr_cost_center, index: true
+      t.references :accountable, polymorphic: true, index: true
     end
   end
 

data/lib/keepr.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'ancestry'
 require 'datev'
 
@@ -17,3 +19,9 @@ require 'keepr/active_record_extension'
 class ActiveRecord::Base
   include Keepr::ActiveRecordExtension
 end
+
+Keepr::MIGRATION_BASE_CLASS = if ActiveRecord::VERSION::MAJOR >= 5
+                                ActiveRecord::Migration[5.0]
+                              else
+                                ActiveRecord::Migration
+                              end

data/lib/keepr/account.rb

@@ -1,66 +1,65 @@
+# frozen_string_literal: true
+
 class Keepr::Account < ActiveRecord::Base
   self.table_name = 'keepr_accounts'
 
-  has_ancestry :orphan_strategy => :restrict
+  has_ancestry orphan_strategy: :restrict
 
-  enum :kind => [ :asset, :liability, :revenue, :expense, :neutral, :debtor, :creditor ]
+  enum kind: %i[asset liability revenue expense forward debtor creditor]
 
   validates_presence_of :number, :name
   validates_uniqueness_of :number
   validate :group_validation
   validate :tax_validation
 
-  has_many :keepr_postings, :class_name => 'Keepr::Posting', :foreign_key => 'keepr_account_id', :dependent => :restrict_with_error
-  has_many :keepr_taxes, :class_name => 'Keepr::Tax', :foreign_key => 'keepr_account_id', :dependent => :restrict_with_error
+  has_many :keepr_postings, class_name: 'Keepr::Posting', foreign_key: 'keepr_account_id', dependent: :restrict_with_error
+  has_many :keepr_taxes, class_name: 'Keepr::Tax', foreign_key: 'keepr_account_id', dependent: :restrict_with_error
 
-  belongs_to :keepr_tax, :class_name => 'Keepr::Tax'
-  belongs_to :keepr_group, :class_name => 'Keepr::Group'
-  belongs_to :accountable, :polymorphic => true
+  belongs_to :keepr_tax, class_name: 'Keepr::Tax'
+  belongs_to :keepr_group, class_name: 'Keepr::Group'
+  belongs_to :accountable, polymorphic: true
 
   default_scope { order(:number) }
 
-  def self.with_sums(options={})
+  def self.with_sums(options = {})
     raise ArgumentError unless options.is_a?(Hash)
 
-    subquery = Keepr::Posting.
-                 select('SUM(keepr_postings.amount)').
-                 joins(:keepr_journal).
-                 where('keepr_postings.keepr_account_id = keepr_accounts.id')
+    subquery = Keepr::Posting
+               .select('SUM(keepr_postings.amount)')
+               .joins(:keepr_journal)
+               .where('keepr_postings.keepr_account_id = keepr_accounts.id')
 
     date           = options[:date]
     permanent_only = options[:permanent_only]
 
-    if date
-      if date.is_a?(Date)
-        subquery = subquery.where "keepr_journals.date <= '#{date.to_s(:db)}'"
-      elsif date.is_a?(Range)
-        subquery = subquery.where "keepr_journals.date BETWEEN '#{date.first.to_s(:db)}' AND '#{date.last.to_s(:db)}'"
-      else
-        raise ArgumentError
-      end
+    case date
+    when nil
+    when Date
+      subquery = subquery.where('keepr_journals.date <= ?', date)
+    when Range
+      subquery = subquery.where(keepr_journals: { date: date.first..date.last })
+    else
+      raise ArgumentError
     end
 
-    if permanent_only
-      subquery = subquery.where "keepr_journals.permanent = #{connection.quoted_true}"
-    end
+    subquery = subquery.where(keepr_journals: { permanent: true }) if permanent_only
 
     select "keepr_accounts.*, (#{subquery.to_sql}) AS sum_amount"
   end
 
-  def self.merged_with_sums(options={})
+  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
+    while (account = accounts[position])
       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 RuntimeError
-        end
+        parent_account = accounts.find { |a| a.id == account.parent_id }
+        raise RuntimeError unless parent_account
+
+        parent_account.sum_amount ||= 0
+        parent_account.sum_amount += account.sum_amount
+        accounts.delete_at(position)
       else
         position += 1
       end
@@ -74,28 +73,33 @@ class Keepr::Account < ActiveRecord::Base
   end
 
   def keepr_postings
-    Keepr::Posting.
-      joins(:keepr_account).
-      where(subtree_conditions)
+    Keepr::Posting
+      .joins(:keepr_account)
+      .merge(subtree)
   end
 
-  def balance(date=nil)
-    if date
-      if date.is_a?(Date)
-        keepr_postings.joins(:keepr_journal).where("keepr_journals.date <= '#{date.to_s(:db)}'").sum(:amount)
-      elsif date.is_a?(Range)
-        keepr_postings.joins(:keepr_journal).where("keepr_journals.date BETWEEN '#{date.first.to_s(:db)}' AND '#{date.last.to_s(:db)}'").sum(:amount)
-      else
-        raise ArgumentError
-      end
-    else
-      keepr_postings.sum(:amount)
-    end
+  def balance(date = nil)
+    scope = case date
+            when nil
+              keepr_postings
+            when Date
+              keepr_postings
+            .joins(:keepr_journal)
+            .where('keepr_journals.date <= ?', date)
+            when Range
+              keepr_postings
+            .joins(:keepr_journal)
+            .where(keepr_journals: { date: date.first..date.last })
+            else
+              raise ArgumentError
+            end
+
+    scope.sum(:amount)
   end
 
   def number_as_string
     if number < 1000
-      "%04d" % number
+      format('%04d', number)
     else
       number.to_s
     end
@@ -105,21 +109,22 @@ class Keepr::Account < ActiveRecord::Base
     "#{number_as_string} (#{name})"
   end
 
-private
-  def group_validation
-    if keepr_group.present?
-      if asset?
-        errors.add(:kind, :group_mismatch) unless keepr_group.asset?
-      elsif liability?
-        errors.add(:kind, :group_mismatch) unless keepr_group.liability?
-      elsif profit_and_loss?
-        errors.add(:kind, :group_mismatch) unless keepr_group.profit_and_loss?
-      else
-        errors.add(:kind, :group_conflict)
-      end
+  private
 
-      errors.add(:keepr_group_id, :no_group_allowed_for_result) if keepr_group.is_result
+  def group_validation
+    return unless keepr_group.present?
+
+    if asset?
+      errors.add(:kind, :group_mismatch) unless keepr_group.asset?
+    elsif liability?
+      errors.add(:kind, :group_mismatch) unless keepr_group.liability?
+    elsif profit_and_loss?
+      errors.add(:kind, :group_mismatch) unless keepr_group.profit_and_loss?
+    else
+      errors.add(:kind, :group_conflict)
     end
+
+    errors.add(:keepr_group_id, :no_group_allowed_for_result) if keepr_group.is_result
   end
 
   def tax_validation