morty 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c0eccb25c8002383a5645689dd7514e8281142e9
-  data.tar.gz: 4eb37d866ecde867de7867a6bdeeaf8382a3379d
+SHA256:
+  metadata.gz: ca8e5765f21e862e08f9fb6cadf68a873670152ce5b6379580280553f0502948
+  data.tar.gz: 0103d960dce53fba686749e8d8de673ecdf5e026491891d9424ecb8f272edc27
 SHA512:
-  metadata.gz: 4fa0eceb9117ad0d991b80d5b65aab06b5608a922da5e12f0b45a738cbdd0ac521f73407de02f03cfd198916a94b7da13ab261f13431167335cad430e6c207eb
-  data.tar.gz: 9dcb0516a5a529bd31d1bd65babbb81b82dfbeeea6f20eb044a870e14bd1c52156059ee3e55cbf0de3a2d0dfbbbf79f53a7201a275644e291ebbe61eabccb9dc
+  metadata.gz: 292c7454d6b6367b0b567dfb492b322dc89254628250f0bda98f5b8e2628d207f8f786e72c52c60ac159400c938a0e982b6903510247cd8044e02f024ac2ee9f
+  data.tar.gz: 3ddf80e12ca731a7a46c1ca4682cd246f03c40cfbbeb288b93ea6fcb807d2c00db13ebd7aa8906dff856867b5f9838bbf6a131fd867c6284c64db8f32ee57ce7

data/.github/dependabot.yml

@@ -0,0 +1,12 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10
+- package-ecosystem: github-actions
+  directory: "/"
+  schedule:
+    interval: weekly
+  open-pull-requests-limit: 10

data/.github/workflows/ci.yml

@@ -0,0 +1,107 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    env:
+      RUBY_VERSION: ruby-4.0
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ env.RUBY_VERSION }}
+          bundler-cache: true
+
+      - name: Lint code for consistent style
+        run: bin/rubocop -f github
+
+  test:
+    runs-on: ubuntu-latest
+
+    services:
+      postgres:
+        image: postgres:16
+        env:
+          POSTGRES_PASSWORD: postgres
+        ports:
+          - 5432:5432
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          # Rails 7.0
+          - { ruby: '3.2', rails: 'rails_7.0' }
+          - { ruby: '3.3', rails: 'rails_7.0' }
+          - { ruby: '3.4', rails: 'rails_7.0' }
+          - { ruby: '4.0', rails: 'rails_7.0' }
+
+          # Rails 7.1
+          - { ruby: '3.2', rails: 'rails_7.1' }
+          - { ruby: '3.3', rails: 'rails_7.1' }
+          - { ruby: '3.4', rails: 'rails_7.1' }
+          - { ruby: '4.0', rails: 'rails_7.1' }
+
+          # Rails 7.2
+          - { ruby: '3.2', rails: 'rails_7.2' }
+          - { ruby: '3.3', rails: 'rails_7.2' }
+          - { ruby: '3.4', rails: 'rails_7.2' }
+          - { ruby: '4.0', rails: 'rails_7.2' }
+
+          # Rails 8.0
+          - { ruby: '3.2', rails: 'rails_8.0' }
+          - { ruby: '3.3', rails: 'rails_8.0' }
+          - { ruby: '3.4', rails: 'rails_8.0' }
+          - { ruby: '4.0', rails: 'rails_8.0' }
+
+          # Rails 8.1
+          - { ruby: '3.2', rails: 'rails_8.1' }
+          - { ruby: '3.3', rails: 'rails_8.1' }
+          - { ruby: '3.4', rails: 'rails_8.1' }
+          - { ruby: '4.0', rails: 'rails_8.1' }
+
+    env:
+      BUNDLE_GEMFILE: gemfiles/${{ matrix.rails }}.gemfile
+      PGHOST: localhost
+      PGUSER: postgres
+      PGPASSWORD: postgres
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Ruby ${{ matrix.ruby }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Create database
+        run: createdb morty_test -h localhost -U postgres
+
+      - name: Run tests
+        run: bundle exec rake
+        env:
+          CI: true
+          CUCUMBER_PROFILE: ci
+
+      - name: Upload test results
+        uses: actions/upload-artifact@v7
+        if: always()
+        with:
+          name: test-results-ruby${{ matrix.ruby }}-${{ matrix.rails }}
+          path: |
+            tmp/rspec.xml
+            tmp/cucumber.xml/

data/.gitignore

@@ -1,14 +1,28 @@
 /.bundle/
-/.yardoc
 /Gemfile.lock
+
+/.yardoc
 /_yardoc/
-/coverage/
 /doc/
+
+/log/*.log
+
 /pkg/
-/spec/reports/
 /tmp/
+
 *.bundle
 *.so
 *.o
 *.a
 mkmf.log
+
+/coverage/
+/spec/reports/
+
+/spec/dummy/db/*.sqlite3
+/spec/dummy/db/*.sqlite3-*
+/spec/dummy/db/structure.sql
+/spec/dummy/db/schema.rb
+/spec/dummy/log/*.log
+/spec/dummy/storage/
+/spec/dummy/tmp/

data/.rubocop.yml

@@ -0,0 +1,20 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+AllCops:
+  TargetRubyVersion: 4.0
+
+Layout/SpaceInsideArrayLiteralBrackets:
+  Enabled: false
+
+Layout/SpaceInsideArrayPercentLiteral:
+  Enabled: false
+
+Layout/SpaceBeforeComma:
+  Enabled: false
+
+Style/PercentLiteralDelimiters:
+  Enabled: false
+
+Layout/EndAlignment:
+  Enabled: false

data/Appraisals

@@ -0,0 +1,24 @@
+appraise "rails-7.0" do
+  gem "activerecord", "~> 7.0.0"
+  gem "railties",     "~> 7.0.0"
+end
+
+appraise "rails-7.1" do
+  gem "activerecord", "~> 7.1.0"
+  gem "railties",     "~> 7.1.0"
+end
+
+appraise "rails-7.2" do
+  gem "activerecord", "~> 7.2.0"
+  gem "railties",     "~> 7.2.0"
+end
+
+appraise "rails-8.0" do
+  gem "activerecord", "~> 8.0.0"
+  gem "railties",     "~> 8.0.0"
+end
+
+appraise "rails-8.1" do
+  gem "activerecord", "~> 8.1.0"
+  gem "railties",     "~> 8.1.0"
+end

data/Gemfile

@@ -1,4 +1,31 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in morty.gemspec
 gemspec
+
+gem "rails"
+gem "lookup_by", github: "companygardener/lookup_by"
+
+# Omakase Ruby styling [https://github.com/rails/rubocop-rails-omakase/]
+gem "rubocop-rails-omakase", require: false
+
+gem "appraisal", "~> 2.5.0"
+
+group :development, :test do
+  gem "rspec-rails"
+
+  gem "pg"
+  gem "puma"
+  gem "propshaft"
+end
+
+group :test do
+  gem "rspec-its"
+  gem "factory_bot_rails"
+  gem "shoulda-matchers"
+  gem "cucumber"
+  gem "simplecov", require: false
+  gem "rspec_junit_formatter"
+  gem "timecop"
+  gem "chronic"
+end

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019-2026 Erik Peterson
+
+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/README.md

@@ -1,26 +1,46 @@
 # Morty
 
-TODO: Write a gem description
+Morty is an accountant.
+
+**Depends on:**
+
+* Rails 8.1.2
+* Ruby 4.0.1
+* PostgreSQL 17
+
+Source code
+
+* [github.com/companygardener/morty][source]
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-```ruby
-gem 'morty'
-```
+    gem 'morty'
 
 And then execute:
 
-    $ bundle
+    $ bundle install
 
 Or install it yourself as:
 
     $ gem install morty
 
-## Usage
+Install migrations (Morty is a Rails engine):
+
+    $ rake morty:install:migrations
+    $ rake db:migrate
+
+## Testing
+
+Morty uses rspec and cucumber. Install them:
 
-TODO: Write usage instructions here
+  $ bundle install
+
+Run the test suite:
+
+    $ rake db:reset
+    $ rake
 
 ## Contributing
 
@@ -29,3 +49,13 @@ TODO: Write usage instructions here
 3. Commit your changes (`git commit -am 'Add some feature'`)
 4. Push to the branch (`git push origin my-new-feature`)
 5. Create a new Pull Request
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Copyright
+
+Copyright © 2025-2026 Erik Peterson. Licensed under the MIT License.
+
+[source]: https://github.com/companygardener/morty "Morty source"

data/Rakefile

@@ -1,2 +1,39 @@
+require "bundler/setup"
+
+APP_RAKEFILE = File.expand_path("spec/dummy/Rakefile", __dir__)
+load "rails/tasks/engine.rake"
+
 require "bundler/gem_tasks"
 
+require "rspec/core/rake_task"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  if ENV["CI"]
+    t.rspec_opts = "--format progress --format RspecJunitFormatter --out tmp/rspec.xml"
+  end
+end
+
+require "cucumber/rake/task"
+Cucumber::Rake::Task.new do |t|
+  t.profile = ENV["CUCUMBER_PROFILE"] if ENV["CUCUMBER_PROFILE"]
+end
+
+task :db_setup do
+  print "Preparing database..."
+  ActiveRecord::Migration.verbose = false
+  original_stdout = $stdout
+  $stdout = File.open(File::NULL, "w")
+  Rake::Task["app:db:prepare"].invoke
+ensure
+  $stdout = original_stdout
+  puts " done"
+end
+
+task spec: :db_setup
+task cucumber: :db_setup
+task default: [:spec, :cucumber]
+
+desc "Start a console with Morty loaded in the dummy app context"
+task :console do
+  ENV["APP_RAKEFILE"] = APP_RAKEFILE
+  exec "irb -r #{File.expand_path("spec/dummy/config/environment", __dir__)}"
+end

data/app/models/morty/account.rb

@@ -0,0 +1,37 @@
+module Morty
+  class Account < ApplicationRecord
+    lookup_by :account, cache: true
+
+    lookup_for :account_type, class_name: AccountType
+
+    def self.sum_over_activities(activity_ids)
+      return {} if activity_ids.empty?
+
+      rows = connection.select_all(sanitize_sql_array([
+        "SELECT account, SUM(amount) AS balance FROM morty.details WHERE activity_id IN (?) GROUP BY account",
+        activity_ids
+      ]))
+
+      rows.each_with_object({}) do |row, hash|
+        hash[row["account"].to_sym] = row["balance"].to_d
+      end
+    end
+
+    def self.sum_by_source(source, effective_date: nil, accounting_date: nil)
+      raise "pick one: effective_date or accounting_date" unless effective_date || accounting_date
+      raise "pick one: effective_date or accounting_date" if effective_date && accounting_date
+
+      date_col = effective_date ? "effective_date" : "accounting_date"
+      date_val = effective_date || accounting_date
+
+      rows = connection.select_all(sanitize_sql_array([
+        "SELECT ledger, account, SUM(amount) AS balance FROM morty.details WHERE source_id = ? AND #{date_col} <= ? GROUP BY ledger, account",
+        source.id, date_val
+      ]))
+
+      rows.each_with_object(Hash.new { |h, k| h[k] = {} }) do |row, hash|
+        hash[row["ledger"].to_sym][row["account"].to_sym] = row["balance"].to_d
+      end
+    end
+  end
+end

data/app/models/morty/account_type.rb

@@ -0,0 +1,7 @@
+module Morty
+  class AccountType < ApplicationRecord
+    lookup_by :account_type, cache: true
+
+    has_many :accounts
+  end
+end

data/app/models/morty/activity.rb

@@ -0,0 +1,147 @@
+require "colorize"
+
+module Morty
+  class Activity < ApplicationRecord
+    lookup_for :activity_type, symbolize: true
+
+    alias_attribute :amount, :activity_amount
+
+    # AR doesn't support alias_attribute for associations, so we have to do it manually
+    alias_method :type,  :activity_type
+    alias_method :type=, :activity_type=
+    alias_method :type?, :activity_type?
+
+    belongs_to :cancels, class_name: "Activity", optional: true
+
+    has_one :cancelled_by, class_name: "Activity", foreign_key: :cancels_id
+
+    has_many :entries
+
+    default_scope -> { includes(:cancelled_by, :entries) }
+
+    scope :until,       ->(date)   { where("effective_date <= ?", date) }
+    scope :with_source, ->(source) { where(source_id: source.id) }
+    scope :with_type,   ->(type)   { where(activity_type: type) }
+
+    after_initialize do
+      self.effective_date ||= accounting_date
+    end
+
+    def ==(other)
+      other.class          == self.class     &&
+      (id.nil? || other.id.nil? || other.id == id) &&
+      other.source_id      == source_id      &&
+
+      other.type           == type           &&
+      other.effective_date == effective_date &&
+      other.amount         == amount
+    end
+
+    def cancel(date, type)
+      build_cancelled_by(type: type) do |a|
+        a.source_id       = source_id
+        a.accounting_date = date
+        a.effective_date  = effective_date
+        a.amount          = amount
+        a.entries         = entries.map(&:inverse)
+        a.cancels         = self
+      end
+    end
+
+    def reverse(date, type)
+      self.class.new(type: type) do |a|
+        a.source_id       = source_id
+        a.accounting_date = date
+        a.entries         = entries.map(&:inverse)
+      end
+    end
+
+    def cancelled?
+      !! cancelled_by
+    end
+
+    def cancelling?
+      cancels? || cancelled?
+    end
+
+    def cancels?
+      !! cancels_id || cancels
+    end
+
+    def retroactive?
+      effective_date < accounting_date
+    end
+
+    # belongs_to lite
+    def source=(obj)
+      self.source_id = obj.id
+    end
+
+    def to_event
+      { amount: amount, date: effective_date, type: type }
+    end
+
+    def debug(ledger = :default)
+      result = "\n"
+
+      header = type.to_s.humanize
+      header << " $%.2f" % amount if amount
+      header << " %s\n" % accounting_date
+
+      result << header.blue
+
+      result << "\nEffective on %s" % effective_date unless accounting_date == effective_date
+
+      # entries.with_ledger(ledger)
+      list = entries.select { |e| e.ledger == ledger }
+
+      if list.any?
+        max = Account.pluck(:account).map(&:length).max
+
+        result << "\n#{ledger.to_s.humanize.yellow} ledger entries\n"
+        result << "\n"
+        result << " " * max + "  |        DR |       CR \n"
+        result << "-" * max + "--|-----------|----------\n"
+
+        amounts = Hash.new(0)
+
+        list.each do |entry|
+          amounts[entry.type.dr] += entry.amount
+          amounts[entry.type.cr] -= entry.amount
+        end
+
+        amounts.each do |account, amount|
+          if amount > 0
+            result << " %#{max}s | %9.2f |\n"      % [account, amount]
+          else
+            result << " %#{max}s |           | %9.2f\n" % [account, -amount]
+          end
+        end
+      else
+        result << "\n#{ledger.to_s.humanize} ledger has no entries\n".yellow
+      end
+
+      result << "\n"
+
+      puts result
+    end
+
+    def inspect
+      result = "#<Activity%-10s " % "[#{id || "new"}]"
+
+      result << (amount ? "$%8.2f" % amount : " %8s" % "")
+
+      result << " #{accounting_date}" if accounting_date
+
+      if effective_date != accounting_date
+        result << " #{effective_date}"
+      else
+        result << "           "
+      end
+
+      result << " #{type}" if type
+      result << ">"
+      result
+    end
+  end
+end

data/app/models/morty/activity_type.rb

@@ -0,0 +1,7 @@
+module Morty
+  class ActivityType < ApplicationRecord
+    lookup_by :activity_type, cache: true
+
+    has_many :activities
+  end
+end

data/app/models/morty/application_record.rb

@@ -0,0 +1,6 @@
+module Morty
+  class ApplicationRecord < ActiveRecord::Base
+    self.abstract_class = true
+    self.table_name_prefix = "morty."
+  end
+end

data/app/models/morty/entry.rb

@@ -0,0 +1,24 @@
+module Morty
+  class Entry < ApplicationRecord
+    belongs_to :activity
+    belongs_to :entry_type
+
+    delegate :ledger, :dr, :cr, to: :type
+
+    def inspect
+      if type
+        "#<Entry[%s] $%.2f %s DR[%s] CR[%s]>" % [id || "new", amount, ledger, dr, cr]
+      else
+        "#<Entry[new]>"
+      end
+    end
+
+    def inverse
+      self.class.new(amount:, entry_type: type.inverse)
+    end
+
+    def type
+      entry_type
+    end
+  end
+end

data/app/models/morty/entry_type.rb

@@ -0,0 +1,23 @@
+module Morty
+  class EntryType < ApplicationRecord
+    lookup_for :dr,     class_name: Account, symbolize: true
+    lookup_for :cr,     class_name: Account, symbolize: true
+    lookup_for :ledger, class_name: Ledger,  symbolize: true
+
+    has_many :entries
+
+    def self.find_by_accounts(dr, cr, ledger = :default)
+      all.detect { |obj| obj.dr == dr &&
+                         obj.cr == cr &&
+                         obj.ledger == ledger }
+    end
+
+    def inverse
+      self.class.find_by_accounts(cr, dr, ledger)
+    end
+
+    def inspect
+      "#<EntryType[%2s] %s ledger DR[%-20s] CR[%-20s]>" % [id, ledger, dr, cr]
+    end
+  end
+end

data/app/models/morty/ledger.rb

@@ -0,0 +1,8 @@
+module Morty
+  class Ledger < ApplicationRecord
+    lookup_by :ledger, cache: true
+
+    has_many :entry_types
+    has_many :entries, through: :entry_types
+  end
+end

data/config/routes.rb

@@ -0,0 +1,2 @@
+Morty::Engine.routes.draw do
+end

data/config.ru

@@ -0,0 +1,7 @@
+require "rubygems"
+require "bundler"
+
+Bundler.require :default, :development
+
+Combustion.initialize! :all
+run Combustion::Application

data/cucumber.yml

@@ -0,0 +1,2 @@
+default: --publish-quiet
+ci: --publish-quiet --format progress --format junit --out tmp/cucumber.xml

data/db/migrate/20260224063053_create_morty_schema.rb

@@ -0,0 +1,17 @@
+class CreateMortySchema < ActiveRecord::Migration[7.0]
+  def up
+    original_search_path = execute("SHOW search_path").first['search_path']
+
+    begin
+      execute Morty::Engine.root.join("db/sql/create_morty_schema.sql").read
+    ensure
+      connection.execute("SET search_path TO #{original_search_path}")
+    end
+  end
+
+  def down
+    raise "this will drop the morty schema, run with UNSAFE_MIGRATION=true to execute" unless ENV["UNSAFE_MIGRATION"]
+
+    drop_schema :morty
+  end
+end