hoardable 0.13.0 → 0.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 28edc85fff69a3851a5d2c653368d732bd9e6fe8ad5544bfa7f81147c6007aab
-  data.tar.gz: 2d7c3abc9eedaddf3180b9f368c90fa25addaffa6c54bc76bf82880b54e7fc72
+  metadata.gz: 83017b15a9b37931d02d7f5d8b7b8d3e81cab4b4cc4691f522430ae2c9be77f8
+  data.tar.gz: 1774bb8cfe7628bbc2bdd8293928dac45dce20c4724aa5c4bc435a4c59a40f0d
 SHA512:
-  metadata.gz: 76dfd695ad62332f876aad4d25e8d1b220970bcd8f2d2eeb69a91e4a441300fc356984dc5ef25be9dd01e745a305448a7f55b439199ef475932910bde02e8f9d
-  data.tar.gz: '081e30627e731ed8d9b4f42536d9e67926bb37348075efa10d2ee3f5ee3eb37476ba3b0ecf1c6ac6fb4dfa7fa700e4d02fd10c3c3f537ef7ba433e605c9d1039'
+  metadata.gz: d0b7d0024a9b8eee5982ab92af174a9a7a134445108c1c3d97945c5ad967f234743fe047f0c42726366d38b7facacc44bac530a5de9a5369de0a9e7bc27342f9
+  data.tar.gz: fb4d0de48b7d798e70c948aea4ae8adb90eaa2836c4ca2d76e952e5c02d53951205f2628bc3e620cb1824f6ac49fcc692dc19130f907c932e0ed3b78fee217e8

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
   SuggestExtensions: false
 

data/.tool-versions

@@ -1,2 +1,2 @@
-ruby 3.1.2
+ruby 3.2.1
 postgres 14.4

data/CHANGELOG.md

@@ -1,4 +1,6 @@
-## [Unreleased]
+## 0.14.0
 
-- Stability is coming.
+- *Breaking Change* - Support for Ruby 2.6 is dropped
+- Adjusts the migration and install generators to use the `fx` gem so that Rails 7+ can use `schema.rb`
+  instead of `structure.sql`
 

data/README.md

@@ -1,6 +1,6 @@
 # Hoardable ![gem version](https://img.shields.io/gem/v/hoardable?style=flat-square)
 
-Hoardable is an ActiveRecord extension for Ruby 2.6+, Rails 6.1+, and PostgreSQL that allows for versioning
+Hoardable is an ActiveRecord extension for Ruby 2.7+, Rails 6.1+, and PostgreSQL that allows for versioning
 and soft-deletion of records through the use of _uni-temporal inherited tables_.
 
 [Temporal tables](https://en.wikipedia.org/wiki/Temporal_database) are a database design pattern where each
@@ -34,8 +34,8 @@ bin/rails g hoardable:install
 bin/rails db:migrate
 ```
 
-This will generate PostgreSQL functions, an initiailzer, and set `config.active_record.schema_format = :sql`
-in `application.rb`.
+This will generate PostgreSQL functions, an enum and an initiailzer. It will also set
+`config.active_record.schema_format = :sql` in `application.rb` if you are using Rails < 7.
 
 ### Model Installation
 

data/lib/generators/hoardable/functions/hoardable_prevent_update_id.sql

@@ -0,0 +1,8 @@
+CREATE OR REPLACE FUNCTION hoardable_prevent_update_id() RETURNS trigger
+  LANGUAGE plpgsql AS
+$$BEGIN
+  IF NEW.hoardable_id <> OLD.hoardable_id THEN
+    RAISE EXCEPTION 'hoardable id cannot be updated';
+  END IF;
+  RETURN NEW;
+END;$$;

data/lib/generators/hoardable/functions/hoardable_source_set_id.sql

@@ -0,0 +1,18 @@
+CREATE OR REPLACE FUNCTION hoardable_source_set_id() RETURNS trigger
+  LANGUAGE plpgsql AS
+$$
+DECLARE
+  _pk information_schema.constraint_column_usage.column_name%TYPE;
+  _id _pk%TYPE;
+BEGIN
+  SELECT c.column_name
+    FROM information_schema.table_constraints t
+    JOIN information_schema.constraint_column_usage c
+    ON c.constraint_name = t.constraint_name
+    WHERE c.table_name = TG_TABLE_NAME AND t.constraint_type = 'PRIMARY KEY'
+    LIMIT 1
+    INTO _pk;
+  EXECUTE format('SELECT $1.%I', _pk) INTO _id USING NEW;
+  NEW.hoardable_id = _id;
+  RETURN NEW;
+END;$$;

data/lib/generators/hoardable/functions/hoardable_version_prevent_update.sql

@@ -0,0 +1,6 @@
+CREATE OR REPLACE FUNCTION hoardable_version_prevent_update() RETURNS trigger
+  LANGUAGE plpgsql AS
+$$BEGIN
+  RAISE EXCEPTION 'updating a version is not allowed';
+  RETURN NEW;
+END;$$;

data/lib/generators/hoardable/install_generator.rb

@@ -8,6 +8,7 @@ module Hoardable
   class InstallGenerator < Rails::Generators::Base
     source_root File.expand_path('templates', __dir__)
     include Rails::Generators::Migration
+    delegate :supports_schema_enums?, to: :class
 
     def create_initializer_file
       create_file(
@@ -22,12 +23,25 @@ module Hoardable
       )
     end
 
+    def change_schema_format_to_sql
+      return if supports_schema_enums?
+
+      application 'config.active_record.schema_format = :sql'
+    end
+
     def create_migration_file
       migration_template 'install.rb.erb', 'db/migrate/install_hoardable.rb'
     end
 
-    def change_schema_format_to_sql
-      application 'config.active_record.schema_format = :sql'
+    def create_functions
+      Dir.glob(File.join(__dir__, 'functions', '*.sql')).each do |file_path|
+        file_name = file_path.match(%r{([^/]+)\.sql})[1]
+        template file_path, "db/functions/#{file_name}_v01.sql"
+      end
+    end
+
+    def self.supports_schema_enums?
+      ActiveRecord.version >= ::Gem::Version.new('7.0.0')
     end
 
     def self.next_migration_number(dir)

data/lib/generators/hoardable/migration_generator.rb

@@ -9,12 +9,30 @@ module Hoardable
   class MigrationGenerator < ActiveRecord::Generators::Base
     source_root File.expand_path('templates', __dir__)
     include Rails::Generators::Migration
-    class_option :foreign_key_type, type: :string
+    class_option(
+      :foreign_key_type,
+      type: :string,
+      optional: true,
+      desc: 'explictly set / override the foreign key type of the versions table'
+    )
 
     def create_versions_table
       migration_template 'migration.rb.erb', "db/migrate/create_#{singularized_table_name}_versions.rb"
     end
 
+    def create_triggers
+      {
+        versions_prevent_update: singularized_table_name,
+        set_hoardable_id: table_name,
+        prevent_update_hoardable_id: table_name
+      }.each do |(trigger_name, trigger_table_name)|
+        template(
+          "../triggers/#{trigger_name}.sql",
+          "db/triggers/#{trigger_table_name}_#{trigger_name}_v01.sql"
+        )
+      end
+    end
+
     no_tasks do
       def foreign_key_type
         options[:foreign_key_type] ||

data/lib/generators/hoardable/templates/install.rb.erb

@@ -1,65 +1,34 @@
 # frozen_string_literal: true
 
 class InstallHoardable < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
-  def up
-    execute(
-      <<~SQL.squish
-        DO $$
-        BEGIN
-          IF NOT EXISTS (
-            SELECT 1 FROM pg_type t WHERE t.typname = 'hoardable_operation'
-          ) THEN
-            CREATE TYPE hoardable_operation AS ENUM ('update', 'delete', 'insert');
-          END IF;
-        END
-        $$;
+  def change
+    create_function :hoardable_prevent_update_id
+    create_function :hoardable_source_set_id
+    create_function :hoardable_version_prevent_update
+    <% if supports_schema_enums? %>
+    create_enum :hoardable_operation, %w[update delete insert]
+    <% else %>
+    reversible do |dir|
+      dir.up do
+        execute(
+          <<~SQL.squish
+            DO $$
+            BEGIN
+              IF NOT EXISTS (
+                SELECT 1 FROM pg_type t WHERE t.typname = 'hoardable_operation'
+              ) THEN
+                CREATE TYPE hoardable_operation AS ENUM ('update', 'delete', 'insert');
+              END IF;
+            END
+            $$;
+          SQL
+        )
+      end
 
-        CREATE OR REPLACE FUNCTION hoardable_source_set_id() RETURNS trigger
-          LANGUAGE plpgsql AS
-        $$
-        DECLARE
-          _pk information_schema.constraint_column_usage.column_name%TYPE;
-          _id _pk%TYPE;
-        BEGIN
-          SELECT c.column_name
-            FROM information_schema.table_constraints t
-            JOIN information_schema.constraint_column_usage c
-            ON c.constraint_name = t.constraint_name
-            WHERE c.table_name = TG_TABLE_NAME AND t.constraint_type = 'PRIMARY KEY'
-            LIMIT 1
-            INTO _pk;
-          EXECUTE format('SELECT $1.%I', _pk) INTO _id USING NEW;
-          NEW.hoardable_id = _id;
-          RETURN NEW;
-        END;$$;
-
-        CREATE OR REPLACE FUNCTION hoardable_prevent_update_id() RETURNS trigger
-          LANGUAGE plpgsql AS
-        $$BEGIN
-          IF NEW.hoardable_id <> OLD.hoardable_id THEN
-            RAISE EXCEPTION 'hoardable id cannot be updated';
-          END IF;
-          RETURN NEW;
-        END;$$;
-
-        CREATE OR REPLACE FUNCTION hoardable_version_prevent_update() RETURNS trigger
-          LANGUAGE plpgsql AS
-        $$BEGIN
-          RAISE EXCEPTION 'updating a version is not allowed';
-          RETURN NEW;
-        END;$$;
-      SQL
-    )
-  end
-
-  def down
-    execute(
-      <<~SQL.squish
-        DROP TYPE IF EXISTS hoardable_operation;
-        DROP FUNCTION IF EXISTS hoardable_version_prevent_update();
-        DROP FUNCTION IF EXISTS hoardable_source_set_id();
-        DROP FUNCTION IF EXISTS hoardable_prevent_update_id();
-      SQL
-    )
+      dir.down do
+        execute('DROP TYPE IF EXISTS hoardable_operation;')
+      end
+    end
+    <% end %>
   end
 end

data/lib/generators/hoardable/templates/migration.rb.erb

@@ -12,34 +12,15 @@ class Create<%= class_name.singularize.delete(':') %>Versions < ActiveRecord::Mi
     end
     reversible do |dir|
       dir.up do
-        execute(
-          <<~SQL
-            UPDATE <%= table_name %> SET hoardable_id = <%= primary_key %>;
-            CREATE TRIGGER <%= singularized_table_name %>_versions_prevent_update
-              BEFORE UPDATE ON <%= singularized_table_name %>_versions FOR EACH ROW
-              EXECUTE PROCEDURE hoardable_version_prevent_update();
-            CREATE TRIGGER <%= table_name %>_set_hoardable_id
-              BEFORE INSERT ON <%= table_name %> FOR EACH ROW
-              EXECUTE PROCEDURE hoardable_source_set_id();
-            CREATE TRIGGER <%= table_name %>_prevent_update_hoardable_id
-              BEFORE UPDATE ON <%= table_name %> FOR EACH ROW
-              EXECUTE PROCEDURE hoardable_prevent_update_id();
-          SQL
-        )
-      end
-      dir.down do
-        execute(
-          <<~SQL
-            DROP TRIGGER <%= singularized_table_name %>_versions_prevent_update
-              ON <%= singularized_table_name %>_versions;
-            DROP TRIGGER <%= table_name %>_set_hoardable_id
-              ON <%= table_name %>;
-            DROP TRIGGER <%= table_name %>_prevent_update_hoardable_id
-              ON <%= table_name %>;
-          SQL
-        )
+        execute('UPDATE <%= table_name %> SET hoardable_id = <%= primary_key %>;')
       end
     end
+    create_trigger(
+      :<%= singularized_table_name %>_versions_prevent_update,
+      on: :<%= singularized_table_name %>_versions
+    )
+    create_trigger :<%= table_name %>_set_hoardable_id, on: :<%= table_name %>
+    create_trigger :<%= table_name %>_prevent_update_hoardable_id, on: :<%= table_name %>
     change_column_null :<%= table_name %>, :hoardable_id, false
     add_index :<%= singularized_table_name %>_versions, :<%= primary_key %>, unique: true
     add_index :<%= singularized_table_name %>_versions, :hoardable_id

data/lib/generators/hoardable/triggers/prevent_update_hoardable_id.sql

@@ -0,0 +1,3 @@
+CREATE TRIGGER <%= table_name %>_prevent_update_hoardable_id
+  BEFORE UPDATE ON <%= table_name %> FOR EACH ROW
+  EXECUTE PROCEDURE hoardable_prevent_update_id();

data/lib/generators/hoardable/triggers/set_hoardable_id.sql

@@ -0,0 +1,3 @@
+CREATE TRIGGER <%= table_name %>_set_hoardable_id
+  BEFORE INSERT ON <%= table_name %> FOR EACH ROW
+  EXECUTE PROCEDURE hoardable_source_set_id();

data/lib/generators/hoardable/triggers/versions_prevent_update.sql

@@ -0,0 +1,3 @@
+CREATE TRIGGER <%= singularized_table_name %>_versions_prevent_update
+  BEFORE UPDATE ON <%= singularized_table_name %>_versions FOR EACH ROW
+  EXECUTE PROCEDURE hoardable_version_prevent_update();

data/lib/hoardable/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Hoardable
-  VERSION = '0.13.0'
+  VERSION = '0.14.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.13.0
+  version: 0.14.0
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-12-09 00:00:00.000000000 Z
+date: 2023-03-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -70,6 +70,26 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '8'
+- !ruby/object:Gem::Dependency
+  name: fx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: pg
   requirement: !ruby/object:Gem::Requirement
@@ -104,10 +124,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/hoardable/functions/hoardable_prevent_update_id.sql
+- lib/generators/hoardable/functions/hoardable_source_set_id.sql
+- lib/generators/hoardable/functions/hoardable_version_prevent_update.sql
 - lib/generators/hoardable/install_generator.rb
 - lib/generators/hoardable/migration_generator.rb
 - lib/generators/hoardable/templates/install.rb.erb
 - lib/generators/hoardable/templates/migration.rb.erb
+- lib/generators/hoardable/triggers/prevent_update_hoardable_id.sql
+- lib/generators/hoardable/triggers/set_hoardable_id.sql
+- lib/generators/hoardable/triggers/versions_prevent_update.sql
 - lib/hoardable.rb
 - lib/hoardable/associations.rb
 - lib/hoardable/belongs_to.rb
@@ -141,14 +167,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.6
 signing_key:
 specification_version: 4
 summary: An ActiveRecord extension for versioning and soft-deletion of records in