ledger_accountable 0.1.4.pre → 0.1.10.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f94845e66b1f81f8b7897908a9c88fe5c12d63d91882045e721ade66851dca5b
-  data.tar.gz: 32851e373387e7da3ad970b810cd4b445f9a033e72bf77883698939e1c2caeea
+  metadata.gz: ac88f44a2ed372e0fc36652d28f53d0071b097b4e10fc2b525b2a1160270aa8a
+  data.tar.gz: cc8e49541b0f74349cf529cdf603fcf605d58f2a4e70cb0ad025d30392fbcd3e
 SHA512:
-  metadata.gz: c652558bbafd396ed31cf47c2f354c16d986b9f6a087f09c8601e7d93e12772feb850f103b2e265abf51184bba80e5c6af19089f71b431ea438cea1054883da2
-  data.tar.gz: 2b9395f031cddb37a6392608f77c038382b8f6d45d625edebec41fb7248302a7d5d2ef1a6b8919b5bc58ea3708fcdda6111337fa9f0596b734bacaa445f4abf0
+  metadata.gz: 0c23089df526659562248f287324f3fea80510fc8abdd90afdcb6f74bf1100028b5b24c0c44e242d7eb1c48deb5ff874705e29f55d401858897d93b4810210ef
+  data.tar.gz: e41cd6c46bf0f74776af0918d3d8e8ae7da4436dc6e3703c755098c57d635aff0282c5addc4881d6489e4b02d973bea24899cd4c6d62dc39d9b3da50f92dfe76

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+## 0.1.8.pre
+
+- Switch gem publish workflow to RubyGems Trusted Publishing (OIDC) via `rubygems/release-gem@v1`.
+- Remove API-key/OTP-based push logic from release workflow.
+
+## 0.1.7.pre
+
+- Add `spec.license = 'MIT'` to gemspec to satisfy RubyGems license metadata expectations.
+
+## 0.1.6.pre
+
+- Pin GitHub Actions workflows to `ubuntu-22.04` to restore Ruby `3.0.6` compatibility for CI and gem publishing.
+
+## 0.1.5.pre
+
+- Add default `ledger_entries` read-performance indexes to new-install generator migration.
+- Add `rails generate ledger_accountable --add-indexes` upgrade path for existing installations.
+- Add additive index migration template with idempotent guards (`index_exists?`) and adapter-aware behavior:
+  - PostgreSQL: `algorithm: :concurrently` with `disable_ddl_transaction!`
+  - Other adapters: standard `add_index`
+- Document existing-install upgrade flow and default index set in README.

data/README.md

@@ -24,6 +24,12 @@ To create the requisite migrations and models, run:
 $ rails generate ledger_accountable
 ```
 
+For existing installations that already have `ledger_entries`, generate only the additive index migration:
+
+```bash
+$ rails generate ledger_accountable --add-indexes
+```
+
 ## Usage
 
 ### `LedgerAccountable::LedgerOwner`
@@ -114,4 +120,21 @@ Ledger entries are automatically created in the following scenarios:
 
 When a LedgerItem changes owners, both a `deletion` entry for the old owner and an `addition` entry for the new owner are created in the same transaction
 
+## Upgrading Existing Installations
+
+Existing apps should run:
+
+```bash
+$ rails generate ledger_accountable --add-indexes
+```
+
+This generates an additive migration that adds the default read-performance indexes for `ledger_entries`:
+
+- `[:owner_type, :owner_id, :transaction_type]`
+- `[:owner_type, :owner_id, :entry_type]`
+- `[:owner_type, :owner_id, :created_at, :id]`
+- `[:ledger_item_type, :ledger_item_id, :created_at, :id]`
+
+For PostgreSQL, indexes are added with `algorithm: :concurrently`. Other adapters use standard `add_index`.
+
 <!-- TODO: documentation for alternate object destruction libraries: callbacks to trigger ledger removal for objects that aren't destroyed -->

data/lib/generators/ledger_accountable/ledger_accountable_generator.rb

@@ -5,20 +5,36 @@ class LedgerAccountableGenerator < Rails::Generators::Base
   include Rails::Generators::Migration
 
   source_root File.expand_path('templates', __dir__)
+  class_option :add_indexes, type: :boolean, default: false,
+                            desc: 'Generate only an additive migration to add missing ledger_entries indexes'
 
   def create_model_file
+    return if options[:add_indexes]
+
     template 'ledger_entry.rb', 'app/models/ledger_entry.rb'
   end
 
   def create_migration_file
+    return if options[:add_indexes]
+
     migration_template 'migration.rb', 'db/migrate/create_ledger_entries.rb'
   end
 
+  def create_add_indexes_migration_file
+    return unless options[:add_indexes]
+
+    migration_template 'add_indexes_migration.rb', 'db/migrate/add_indexes_to_ledger_entries.rb'
+  end
+
   def create_initializer_file
+    return if options[:add_indexes]
+
     template 'initializer.rb', 'config/initializers/ledger_accountable.rb'
   end
 
   def copy_localization_file
+    return if options[:add_indexes]
+
     copy_file '../../../locale/en.yml', 'config/locales/ledger.en.yml'
   end
 
@@ -27,4 +43,4 @@ class LedgerAccountableGenerator < Rails::Generators::Base
   def self.next_migration_number(path)
     ActiveRecord::Generators::Base.next_migration_number(path)
   end
-end
+end

data/lib/generators/ledger_accountable/templates/add_indexes_migration.rb

@@ -0,0 +1,41 @@
+class AddIndexesToLedgerEntries < ActiveRecord::Migration[6.1]
+  disable_ddl_transaction!
+
+  def up
+    add_index_unless_exists :ledger_entries, [:owner_type, :owner_id, :transaction_type],
+                            name: 'index_ledger_entries_on_owner_and_transaction_type'
+    add_index_unless_exists :ledger_entries, [:owner_type, :owner_id, :entry_type],
+                            name: 'index_ledger_entries_on_owner_and_entry_type'
+    add_index_unless_exists :ledger_entries, [:owner_type, :owner_id, :created_at, :id],
+                            name: 'index_ledger_entries_on_owner_and_created_at_and_id'
+    add_index_unless_exists :ledger_entries, [:ledger_item_type, :ledger_item_id, :created_at, :id],
+                            name: 'index_ledger_entries_on_item_and_created_at_and_id'
+  end
+
+  def down
+    remove_index_if_exists :ledger_entries, name: 'index_ledger_entries_on_owner_and_transaction_type'
+    remove_index_if_exists :ledger_entries, name: 'index_ledger_entries_on_owner_and_entry_type'
+    remove_index_if_exists :ledger_entries, name: 'index_ledger_entries_on_owner_and_created_at_and_id'
+    remove_index_if_exists :ledger_entries, name: 'index_ledger_entries_on_item_and_created_at_and_id'
+  end
+
+  private
+
+  def add_index_unless_exists(table_name, columns, name:)
+    return if index_exists?(table_name, columns, name: name)
+
+    options = { name: name }
+    options[:algorithm] = :concurrently if postgresql?
+    add_index(table_name, columns, **options)
+  end
+
+  def remove_index_if_exists(table_name, name:)
+    return unless index_exists?(table_name, name: name)
+
+    remove_index(table_name, name: name)
+  end
+
+  def postgresql?
+    connection.adapter_name.downcase.include?('postgres')
+  end
+end

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

@@ -10,5 +10,14 @@ class CreateLedgerEntries < ActiveRecord::Migration[6.1]
 
       t.timestamps
     end
+
+    add_index :ledger_entries, [:owner_type, :owner_id, :transaction_type],
+              name: 'index_ledger_entries_on_owner_and_transaction_type'
+    add_index :ledger_entries, [:owner_type, :owner_id, :entry_type],
+              name: 'index_ledger_entries_on_owner_and_entry_type'
+    add_index :ledger_entries, [:owner_type, :owner_id, :created_at, :id],
+              name: 'index_ledger_entries_on_owner_and_created_at_and_id'
+    add_index :ledger_entries, [:ledger_item_type, :ledger_item_id, :created_at, :id],
+              name: 'index_ledger_entries_on_item_and_created_at_and_id'
   end
 end

data/lib/ledger_accountable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module LedgerAccountable
-  VERSION = '0.1.4.pre'
+  VERSION = '0.1.10.pre'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ledger_accountable
 version: !ruby/object:Gem::Version
-  version: 0.1.4.pre
+  version: 0.1.10.pre
 platform: ruby
 authors:
 - Brendan Maclean
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-12-11 00:00:00.000000000 Z
+date: 2026-05-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -105,6 +105,7 @@ files:
 - LICENSE
 - README.md
 - lib/generators/ledger_accountable/ledger_accountable_generator.rb
+- lib/generators/ledger_accountable/templates/add_indexes_migration.rb
 - lib/generators/ledger_accountable/templates/initializer.rb
 - lib/generators/ledger_accountable/templates/ledger_entry.rb
 - lib/generators/ledger_accountable/templates/migration.rb
@@ -116,7 +117,8 @@ files:
 - lib/ledger_accountable/version.rb
 - lib/locale/en.yml
 homepage: https://github.com/bmaclean/ledger-accountable
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/bmaclean/ledger-accountable
   source_code_uri: https://github.com/bmaclean/ledger-accountable
@@ -130,14 +132,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.6
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
-rubygems_version: 3.2.33
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Ledger accounting for Rails models