model_timeline 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7406b06646ef46c0b8d2541835ebeaa5e0f71638c600d0b7de45903bb36b2c81
-  data.tar.gz: dad655ebda19102a5e09eb3a51d07ac15cfbca051527ee3c3a71d979ab2a4543
+  metadata.gz: 6a6a1184662cefc583a463199b9ba93d0962f3c3c4d6fbcf2940074f0d508c71
+  data.tar.gz: 2380ec1607093282a3de23d9d20760ff4a09db115b1f84dc572cc8a57af5ac49
 SHA512:
-  metadata.gz: 4f618bea0cc20328d5d2a61352c753ec39fbe04f90b7f909ba93df236ab28a4e239515c3b0b70913381149e99996c189ebb41afe5e2a2d6649e3fdb0fabf24b4
-  data.tar.gz: d145d2798077f4bbb13191f966d8b73433330e5360b808862f14ddc3f1e4d7e6d97d231ad9e0828a5f63f4f759453550eb5cb132781a9a5dfa15b21b816ec36b
+  metadata.gz: 92139b98feed631b10c0cf102c0e702f9c8e901f9dfa3d769487c45611c95ceb22271233032d05e78d91fb23417d56e42e5571bcab46ee10c3dedd201c89a12f
+  data.tar.gz: d69052dbea970f0edade2611df282db871087ac850ccabce1f0aa56888d86fed35e8c399f603578cd364fbc5ce11fb8b69c6eb0ff9df7891fb6640a482fa0d97

data/README.md

@@ -127,7 +127,6 @@ end
 
 ### Using Metadata
 
-<!-- ! THIS IS WRONG, NEEDS TO BE UPDATED.  -->
 ModelTimeline allows you to include custom metadata with your timeline entries, which is especially useful for tracking changes across related entities or adding domain-specific context.
 
 #### Adding Metadata Through Configuration
@@ -147,8 +146,7 @@ end
 ```
 
 If your timeline table has columns that match the keys in your `meta` hash, these values will be stored in
-those dedicated columns. Otherwise they will be ignored. (This might change in the future and a metadata column might be
-added to put additional metadata that doesn't have a dedicated column.)
+those dedicated columns. Otherwise, they will be stored inside `metadata` column.
 
 #### Adding Metadata at Runtime
 
@@ -172,13 +170,16 @@ For tracking related entities more effectively, you can create a custom timeline
 class CreatePostTimelineEntries < ActiveRecord::Migration[6.1]
   def change
     create_table :post_timeline_entries do |t|
-      # Standard ModelTimeline columns
-      t.string   :timelineable_type
-      t.integer  :timelineable_id
-      t.string   :action
-      t.jsonb    :object_changes
-      t.integer  :user_id
-      t.string   :ip_address
+      # Default Columns - All of them are required.
+      t.string :timelineable_type
+      t.bigint :timelineable_id
+      t.string :action, null: false
+      t.jsonb :object_changes, default: {}, null: false
+      t.jsonb :metadata, default: {}, null: false
+      t.string :user_type
+      t.bigint :user_id
+      t.string :username
+      t.inet :ip_address
 
       # Custom columns that can be populated via the meta option
       t.integer  :post_id
@@ -186,9 +187,12 @@ class CreatePostTimelineEntries < ActiveRecord::Migration[6.1]
       t.timestamps
     end
 
-    add_index :post_timeline_entries, [:timelineable_type, :timelineable_id]
-    add_index :post_timeline_entries, :post_id
-    add_index :post_timeline_entries, :user_id
+    add_index :post_timeline_entries, [:timelineable_type, :timelineable_id], name: 'idx_timeline_on_timelineable'
+    add_index :post_timeline_entries, [:user_type, :user_id], name: 'idx_timeline_on_user'
+    add_index :post_timeline_entries, :object_changes, using: :gin, name: 'idx_timeline_on_changes'
+    add_index :post_timeline_entries, :metadata, using: :gin, name: 'idx_timeline_on_meta'
+    add_index :post_timeline_entries, :ip_address, name: 'idx_timeline_on_ip'
+    add_index :post_timeline_entries, :post_id, name: 'idx_timeline_on_post_id'
   end
 end
 ```

data/lib/model_timeline/generators/templates/migration.rb.tt

@@ -7,6 +7,7 @@ class CreateModelTimelineTables < ActiveRecord::Migration[<%= ActiveRecord::Migr
 
       # Use PostgreSQL's JSONB type for better performance
       t.jsonb :object_changes, default: {}, null: false
+      t.jsonb :metadata, default: {}, null: false
 
       # Polymorphic user association
       t.string :user_type
@@ -22,6 +23,7 @@ class CreateModelTimelineTables < ActiveRecord::Migration[<%= ActiveRecord::Migr
     add_index :<%= @table_name %>, [:timelineable_type, :timelineable_id], name: 'idx_timeline_on_timelineable'
     add_index :<%= @table_name %>, [:user_type, :user_id], name: 'idx_timeline_on_user'
     add_index :<%= @table_name %>, :object_changes, using: :gin, name: 'idx_timeline_on_changes'
+    add_index :<%= @table_name %>, :metadata, using: :gin, name: 'idx_timeline_on_meta'
     add_index :<%= @table_name %>, :ip_address, name: 'idx_timeline_on_ip'
   end
 end

data/lib/model_timeline/timelineable.rb

@@ -107,9 +107,10 @@ module ModelTimeline
           timelineable_id: id,
           action: action,
           object_changes: object_changes,
+          metadata: object_metadata(config),
           ip_address: current_ip_address,
           **current_user_attributes,
-          **collect_metadata(config[:meta], config_key)
+          **column_metadata(config)
         )
       end
 
@@ -128,9 +129,10 @@ module ModelTimeline
           timelineable_id: id,
           action: 'destroy',
           object_changes: {},
+          metadata: object_metadata(config),
           ip_address: current_ip_address,
           **current_user_attributes,
-          **collect_metadata(config[:meta], config_key)
+          **column_metadata(config)
         )
       end
 
@@ -186,8 +188,7 @@ module ModelTimeline
       # @param meta_config [Hash] The metadata configuration
       # @param config_key [String] The configuration key for this model
       # @return [Hash] Collected metadata
-      def collect_metadata(meta_config, config_key)
-        config = self.class.loggers[config_key]
+      def collect_metadata(meta_config)
         metadata = {}
 
         # First, add any thread-level metadata
@@ -206,9 +207,19 @@ module ModelTimeline
           metadata[key] = resolved_value
         end
 
-        # Only include keys that exist as columns in the timeline entry table
+        metadata
+      end
+
+      def column_metadata(config)
+        metadata = collect_metadata(config[:meta])
         column_names = config[:klass].column_names.map(&:to_sym)
         metadata.slice(*column_names)
       end
+
+      def object_metadata(config)
+        metadata = collect_metadata(config[:meta])
+        column_names = config[:klass].column_names.map(&:to_sym)
+        metadata.except(*column_names)
+      end
   end
 end

data/lib/model_timeline/version.rb

@@ -5,5 +5,5 @@ module ModelTimeline
   # Follows semantic versioning (https://semver.org/).
   #
   # @return [String] The current version in the format "MAJOR.MINOR.PATCH"
-  VERSION = '0.1.0'
+  VERSION = '0.1.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: model_timeline
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Alexandre Stapenhorst