hoardable 0.12.5 → 0.12.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 931223031ac56883e27e5f11da07eae3b59793ca8a2c77ce4e20f67cdb730174
-  data.tar.gz: 452472091834577883a5d56ea8b1af4375120648eaff066119edc2459c2cf035
+  metadata.gz: f56e0b270664927191148ea5ad8bcf4f4511c482c1964d4746f31513eb23b25f
+  data.tar.gz: b69b35c7aa7f3eb013b1444c3b26115f012c8a7617ba457ce248074eca2706e0
 SHA512:
-  metadata.gz: 414a407c30d2aa0f504cd89773a83dd0b775bbbed51c8f7dbaa4225141aa34d301aac6167b6ce3553af02f03e8e2d1a053b58b4f9946814d5fb1b17282f86817
-  data.tar.gz: 995256175f51743332171ec32e232bdf01abb7288df8987d75b4e164499cf99610dc8605a9956fed3eb0edbb736b46ae24906fdf00cf5c14fa9ec99d752647d2
+  metadata.gz: 39c6176733cb67efc47e9d7985fa30427090e02c21c6abb6d54e9d2b88c975c430b4e0eafa4976457704a16c1fd8ef68c0245269f67adf0cf4a13d4e5a42c2f4
+  data.tar.gz: 975229330ca851b4d847113a3e76bd0a0ff59a86cf39a5cfa73e11f456d475a0b51df82a90ab51a6035ab1f934ce7fa87607925679fd620c4dab25ec44979cf4

data/README.md

@@ -36,11 +36,8 @@ bin/rails g hoardable:install
 bin/rails db:migrate
 ```
 
-This will generate a PostgreSQL function and an initiailzer.
-
-_Note:_ It is recommended to set `config.active_record.schema_format = :sql` in `application.rb`, so
-that the function and triggers in the migrations that prevent updates to the versions table get
-captured in your schema.
+This will generate PostgreSQL functions, an initiailzer, and set `config.active_record.schema_format
+= :sql` in `application.rb`.
 
 ### Model Installation
 
@@ -393,7 +390,7 @@ class Post < ActiveRecord::Base
 end
 ```
 
-## Action Text
+### Action Text
 
 Hoardable provides support for ActiveRecord models with `has_rich_text`. First, you must create a
 temporal table for `ActionText::RichText`:
@@ -426,6 +423,18 @@ Hoardable.at(datetime) do
 end
 ```
 
+### Known Gotchas
+
+#### Rails Fixtures
+
+Rails uses a method called
+[`disable_referential_integrity`](https://github.com/rails/rails/blob/06e9fbd954ab113108a7982357553fdef285bff1/activerecord/lib/active_record/connection_adapters/postgresql/referential_integrity.rb#L7)
+when inserting fixtures into the database. This disables PostgreSQL triggers, which Hoardable relies
+on for assigning `hoardable_id` from the primary key’s value. If you would still like to use
+fixtures, you must specify the primary key’s value and `hoardable_id` to the same identifier value
+in the fixture. This is not an issue with fixture replacement libraries like `factory_girl` or
+[`world_factory`](https://github.com/FutureProofRetail/world_factory) however.
+
 ## Gem Comparison
 
 #### [`paper_trail`](https://github.com/paper-trail-gem/paper_trail)

data/lib/generators/hoardable/install_generator.rb

@@ -26,6 +26,10 @@ module Hoardable
       migration_template 'install.rb.erb', 'db/migrate/install_hoardable.rb'
     end
 
+    def change_schema_format_to_sql
+      application 'config.active_record.schema_format = :sql'
+    end
+
     def self.next_migration_number(dir)
       ::ActiveRecord::Generators::Base.next_migration_number(dir)
     end

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

@@ -3,7 +3,7 @@
 class InstallHoardable < ActiveRecord::Migration[<%= ActiveRecord::Migration.current_version %>]
   def up
     execute(
-      <<~SQL
+      <<~SQL.squish
         DO $$
         BEGIN
           IF NOT EXISTS (
@@ -51,9 +51,10 @@ class InstallHoardable < ActiveRecord::Migration[<%= ActiveRecord::Migration.cur
       SQL
     )
   end
+
   def down
     execute(
-      <<~SQL
+      <<~SQL.squish
         DROP TYPE IF EXISTS hoardable_operation;
         DROP FUNCTION IF EXISTS hoardable_version_prevent_update();
         DROP FUNCTION IF EXISTS hoardable_source_set_id();

data/lib/hoardable/database_client.rb

@@ -40,8 +40,36 @@ module Hoardable
       )
     end
 
+    def has_one_find_conditions(reflection)
+      {
+        reflection.type => source_record.class.name.sub(/Version$/, ''),
+        reflection.foreign_key => source_record.hoardable_id,
+        'name' => (reflection.name.to_s.sub(/^rich_text_/, '') if reflection.class_name.match?(/RichText$/))
+      }.reject { |k, v| k.nil? || v.nil? }
+    end
+
+    def has_one_at_timestamp
+      Hoardable.instance_variable_get('@at') || source_record.updated_at
+    rescue NameError
+      raise(UpdatedAtColumnMissingError, source_record.class.table_name)
+    end
+
     def source_attributes_without_primary_key
-      source_record.attributes_before_type_cast.without(source_primary_key)
+      source_record.attributes_before_type_cast.without(source_primary_key, *generated_column_names).merge(
+        source_record.class.select(refreshable_column_names).find(source_record.id).slice(refreshable_column_names)
+      )
+    end
+
+    def generated_column_names
+      @generated_column_names ||= source_record.class.columns.select(&:virtual?).map(&:name)
+    rescue NoMethodError
+      []
+    end
+
+    def refreshable_column_names
+      @refreshable_column_names ||= source_record.class.columns.select(&:default_function).reject do |column|
+        column.name == source_primary_key || column.name.in?(generated_column_names)
+      end.map(&:name)
     end
 
     def initialize_temporal_range

data/lib/hoardable/engine.rb

@@ -34,9 +34,12 @@ module Hoardable
   end.freeze
   private_constant :HOARDABLE_VERSION_UPDATES
 
-  SUPPORTS_ENCRYPTED_ACTION_TEXT = ActiveRecord.version >= ::Gem::Version.new('7.0')
+  SUPPORTS_ENCRYPTED_ACTION_TEXT = ActiveRecord.version >= ::Gem::Version.new('7.0.4')
   private_constant :SUPPORTS_ENCRYPTED_ACTION_TEXT
 
+  SUPPORTS_VIRTUAL_COLUMNS = ActiveRecord.version >= ::Gem::Version.new('7.0.0')
+  private_constant :SUPPORTS_VIRTUAL_COLUMNS
+
   @context = {}
   @config = CONFIG_KEYS.to_h do |key|
     [key, true]

data/lib/hoardable/has_one.rb

@@ -17,28 +17,14 @@ module Hoardable
           def #{name}
             reflection = _reflections['#{name}']
             return super if reflection.klass.name.match?(/^ActionText/)
+            return super unless (timestamp = hoardable_client.has_one_at_timestamp)
 
-            super&.at(hoardable_at_timestamp) ||
-              reflection.klass.at(hoardable_at_timestamp).find_by(
-                {
-                  reflection.type => self.class.name.sub(/Version$/, ''),
-                  reflection.foreign_key => hoardable_id
-                }.reject { |key, _| key.blank? }
-              )
+            super&.at(timestamp) ||
+              reflection.klass.at(timestamp).find_by(hoardable_client.has_one_find_conditions(reflection))
           end
         RUBY
       end
     end
-
-    included do
-      private
-
-      def hoardable_at_timestamp
-        Hoardable.instance_variable_get('@at') || updated_at
-      rescue NameError
-        raise(UpdatedAtColumnMissingError, self.class.table_name)
-      end
-    end
   end
   private_constant :HasOne
 end

data/lib/hoardable/source_model.rb

@@ -75,6 +75,8 @@ module Hoardable
     #
     # @param datetime [DateTime, Time]
     def at(datetime)
+      return self if datetime.nil? || !created_at
+
       version_at(datetime) || (self if created_at < datetime)
     end
 

data/lib/hoardable/version.rb

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

data/lib/hoardable/version_model.rb

@@ -86,7 +86,7 @@ module Hoardable
 
       transaction do
         hoardable_source.tap do |reverted|
-          reverted.update!(hoardable_source_attributes.without(self.class.superclass.primary_key))
+          reverted.reload.update!(hoardable_source_attributes.without(self.class.superclass.primary_key))
           reverted.instance_variable_set(:@hoardable_version, self)
           reverted.run_callbacks(:reverted)
         end
@@ -130,7 +130,10 @@ module Hoardable
     end
 
     def hoardable_source_attributes
-      attributes_before_type_cast.without(self.class.column_names - self.class.superclass.column_names)
+      attributes_before_type_cast.without(
+        (self.class.column_names - self.class.superclass.column_names) +
+        (SUPPORTS_VIRTUAL_COLUMNS ? self.class.columns.select(&:virtual?).map(&:name) : [])
+      )
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hoardable
 version: !ruby/object:Gem::Version
-  version: 0.12.5
+  version: 0.12.9
 platform: ruby
 authors:
 - justin talbott
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-10-14 00:00:00.000000000 Z
+date: 2022-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord