keepr 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d2680eedcb47403d6bcbae90de674d208f8a9ab06570b20e122c0c641c42e114
-  data.tar.gz: c33827bf895e0e15ea763a5217eb2efa3ff0f9fa5a48ae74ee4c07750a56ee28
+  metadata.gz: 52559eefe26a6b165210c72a477351e559f0b936bd098880f134991a981490ce
+  data.tar.gz: 448a874a9a03197c51e9df977c523539eb552881cf83a7ff3ddfd37be887d41a
 SHA512:
-  metadata.gz: f9c5e2703b9ce01a2aed1b29c096ffc879518a10528fb1f31092c6fb5602c7b566eade957974ec381904525c3d3ff455937fbb38f12fa700778b6d9b06d1256f
-  data.tar.gz: bb4d6e29f65dd0fac3d5b3f3ff764511387e543371df91318bf1117b1a8d4aba9bc9dc245ac94b6a07bdf063aa8f5a93ed70322899067306881b3162e1ac4091
+  metadata.gz: 621ee808cd1ff8e361e7d00e3a67690a24befdbe40b6e35757aee1b260eb9141e155e99f2a4707614b612e5a19c32c2a0d29e8ae042546f49cf7f81525a874c5
+  data.tar.gz: 86c1dc8d10841836a66db76393d379b2b57c9d623effcf32e63ba18ee481199ce7b97a2a0736b90100f3c7d0e3d64b7e1a2ddbdd61cd909f53810fba77f04ec8

data/.github/workflows/main.yml

@@ -0,0 +1,38 @@
+name: Test
+
+on: [ push, pull_request ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['3.0', '3.1', '3.2']
+        rails: ['6.1', '7.0', '7.1']
+
+    name: Test against Ruby ${{ matrix.ruby }} / Rails ${{ matrix.rails }}
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Setup System
+      run: sudo apt-get install libsqlite3-dev
+
+    - name: Setup Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+
+    - name: Install gems
+      env:
+        MATRIX_RAILS_VERSION: ${{ matrix.rails }}
+      run: |
+        export BUNDLE_GEMFILE="${GITHUB_WORKSPACE}/ci/Gemfile-rails-${MATRIX_RAILS_VERSION}"
+        bundle install --jobs 4 --retry 3
+
+    - name: RSpec
+      env:
+        COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+      run: bundle exec rake

data/LICENSE.txt

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

data/README.md

@@ -2,25 +2,25 @@
 
 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)
+[![Build Status](https://github.com/ledermann/keepr/workflows/Test/badge.svg?branch=master)](https://github.com/ledermann/keepr/actions)
 [![Code Climate](https://codeclimate.com/github/ledermann/keepr/badges/gpa.svg)](https://codeclimate.com/github/ledermann/keepr)
 [![Coverage Status](https://coveralls.io/repos/github/ledermann/keepr/badge.svg?branch=master)](https://coveralls.io/github/ledermann/keepr?branch=master)
 
 ## Features
 
-* Journal entries with two or more postings
+* Journal entries with two or more postings follow the [Double Entry](https://www.accountingcoach.com/blog/what-is-the-double-entry-system) principle
 * Accounts (including subaccounts and groups)
-* Tax
-* Cost center
-* Balance sheet
-* Profit and loss statement
-* DATEV export
+* Taxes
+* Cost centers
+* Balance sheets
+* Profit and loss statements
+* DATEV exports
 
 
 ## Dependencies
 
-* Ruby 2.5+
-* Rails 4.2+ (including Rails 6.0)
+* Ruby 3.0+
+* Rails 6.1+ (including Rails 7.1)
 
 
 ## Installation
@@ -38,9 +38,92 @@ Or install it yourself as:
     $ gem install keepr
 
 
+## Getting started
+
+After installation run the following:
+
+	rails g keepr:migration
+	rails db:migrate
+
+This will create the database migration files and add new models.
+
 ## Usage
+### Account
+All accounting entries are stored inside "accounts", per standard accounting
+principles. To create an account, use the following format:
+
+	Keepr::Account.create!(number: 27, name: 'Software', kind: :asset)
+
+"kind" is one of following values:
+
+	[asset liability revenue expense forward debtor creditor]
+
+Accounts can have "child" accounts. All entries posted in a child account will
+be shown in the "parent" account as well. To create a child account:
+
+	account_1400 = Keepr::Account.create!(number: 1400, name: 'Software', kind: :expense)
+	account_14001 = Keepr::Account.create!(number: 14001, name: 'Rails', parent: account_1400 , kind: :expense)
+
+Accounts can be organised inside of groups:
+
+	group = Keepr::Group.create!(is_result: true, target: :liability, name: 'foo')
+	Keepr::Account.create!(number: 100, name: 'Trade payable', kind: :liability, keepr_group: group)
+
+Groups also allow a parent/child hierarchy:
+
+	parent_group = Keepr::Group.create!(is_result: true, target: :liability, name: 'foo')
+	child_group = parent_group.children.create! name: 'Bar'
+
+### Journal
+
+
+Simple journal:
+
+    simple_journal = Keepr::Journal.create keepr_postings_attributes: [
+      { keepr_account: account_1000, amount: 100.99, side: 'debit' },
+      { keepr_account: account_1200, amount: 100.99, side: 'credit' }
+    ]
+
+
+Complex journal:
+
+    complex_journal = Keepr::Journal.create keepr_postings_attributes: [
+      { keepr_account: account_4920, amount: 8.40, side: 'debit' },
+      { keepr_account: account_1576, amount: 1.60, side: 'debit' },
+      { keepr_account: account_1600, amount: 10.00, side: 'credit' }
+    ]
+
+Entries can be locked for changing data:
+
+	simple_journal.update! permanent: true
+
+
+### Account balance
+We can get an account balance as follows:
+
+	account_1000.balance
+
+	account_1000.balance(Date.today)
+
+	account_1000.balance(Date.yesterday...Date.today)
+
+### Tax account
+
+	// Create Tax account
+	Keepr::Account.create! number: 1776, name: 'Umsatzsteuer 19%', kind: :asset
+
+	tax = Keepr::Tax.create! name: 'USt19',
+	                       description: 'Umsatzsteuer 19%',
+	                       value: 19.0,
+	                       keepr_account: tax_account
+
+	// Create a sale account that links to the tax account
+	account = Keepr::Account.new number: 8400,
+                                 name: 'Erlöse 19% USt',
+                                 kind: :revenue,
+                                 keepr_tax: tax
+
 
-TODO: Write usage instructions here
 
 
 ## Contributing
@@ -64,4 +147,4 @@ TODO: Write usage instructions here
 * https://github.com/bigfleet/accountable
 
 
-Copyright (c) 2013-2020 [Georg Ledermann](https://ledermann.dev), released under the MIT license
+Copyright (c) 2013-2023 [Georg Ledermann](https://ledermann.dev), released under the MIT license

data/ci/{Gemfile-rails-6-0 → Gemfile-rails-6.1}

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

data/ci/{Gemfile-rails-5-0 → Gemfile-rails-7.0}

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

data/ci/{Gemfile-rails-4-2 → Gemfile-rails-7.1}

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

data/keepr.gemspec

@@ -13,19 +13,19 @@ Gem::Specification.new do |spec|
   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.5'
+  spec.required_ruby_version = '>= 3.0'
 
   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.2'
+  spec.add_dependency 'activerecord', '>= 6.1'
   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 'coveralls_reborn'
   spec.add_development_dependency 'database_cleaner'
   spec.add_development_dependency 'factory_bot'
   spec.add_development_dependency 'rake'

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

@@ -15,11 +15,22 @@ module Keepr
     end
 
     def self.next_migration_number(dirname)
-      if ActiveRecord::Base.timestamped_migrations
+      if timestamped_migrations?
         Time.now.utc.strftime('%Y%m%d%H%M%S')
       else
         format('%.3d', (current_migration_number(dirname) + 1))
       end
     end
+
+    def self.timestamped_migrations?
+      (
+        ActiveRecord::Base.respond_to?(:timestamped_migrations) &&
+          ActiveRecord::Base.timestamped_migrations
+      ) ||
+        (
+          ActiveRecord.respond_to?(:timestamped_migrations) &&
+            ActiveRecord.timestamped_migrations
+        )
+    end
   end
 end

data/lib/keepr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Keepr
-  VERSION = '0.7.0'
+  VERSION = '0.8.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: keepr
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
 - Georg Ledermann
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '4.2'
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: ancestry
   requirement: !ruby/object:Gem::Requirement
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls
+  name: coveralls_reborn
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -170,17 +170,15 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".travis.yml"
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- 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
+- ci/Gemfile-rails-6.1
+- ci/Gemfile-rails-7.0
+- ci/Gemfile-rails-7.1
 - keepr.gemspec
 - lib/generators/keepr/migration/migration_generator.rb
 - lib/generators/keepr/migration/templates/migration.rb
@@ -239,14 +237,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.5'
+      version: '3.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.5.1
 signing_key:
 specification_version: 4
 summary: Some basic ActiveRecord models to build a double entry bookkeeping application

data/.travis.yml

@@ -1,21 +0,0 @@
-os: linux
-dist: xenial
-language: ruby
-rvm:
-  - 2.5.8
-  - 2.6.6
-  - 2.7.2
-gemfile:
-  - 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.7.2
-      gemfile: ci/Gemfile-rails-4-2
-script:
-  - bundle exec rake
-before_install:
-  - gem update bundler

data/ci/Gemfile-rails-5-1

@@ -1,12 +0,0 @@
-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

@@ -1,12 +0,0 @@
-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'