acts_as_active 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d77b8db36fd55b8e5a5fd11c5d3c66086ca2edc782802accbc6dd868f7edd0e
-  data.tar.gz: c815c49b4daaa44a2b2dc752c744016ca3125a31be46700342053270759be6b6
+  metadata.gz: c452d929cd97ab9aa78b33e2b6f470c05e54ef62771b5ab4b7894c567dfd0549
+  data.tar.gz: 26205d4a6a40162ee0ca68a9e0d622d802aecf4de082dc324ebb4403be3c1db5
 SHA512:
-  metadata.gz: f2bd60fd0f26c0e240179e2980c552aa69a83907742a33e3d979530ac4613e0227ce3c7357017ff22baa81019617809997e7af9e8fe9e2d19375dc385e89002d
-  data.tar.gz: 4fad00c674233c6b94b4eb4f2dbd1fe6011ac414cfa5946c85c9f2d31596dcf207c034d58c15c61c81be93a3981b95ff613fc44979af0ecfc3f50819d187849a
+  metadata.gz: ebc15ecf2c2ba7b55c53c6bce2d32b8c37b15602e0cf4685425337e66e42d9df5c0f11ee58c5d8813d637fd290706230b233df5c87982808ccebe9d22e871abd
+  data.tar.gz: 1043c825d41ad29fa487ade82b69be49cecb1810c05229282b1e1ff1fdd28a95d0a6190d58918b21344f722bac8911a916e27224396275e47c3e5d7739bc9ac0

data/README.md

@@ -18,6 +18,12 @@ If bundler is not being used to manage dependencies, install the gem by executin
 gem install acts_as_active
 ```
 
+Generators: ActsAsActive supports a metadata field in either json or jsonb format, depending on your database and preference (MySQL or PostgreSQL).
+
+```bash
+rails g acts_as_active:install --metadata=json/jsonb/auto
+```
+
 ## Usage
 
 ```ruby
@@ -25,7 +31,7 @@ class Record < ApplicationRecord
   acts_as_active on: [:create, :update],                 # ➜ Track different actions
                  if:           -> { track_activity? },   # ➜ On different conditions
                  unless:       -> { skip_tracking? },
-                 after_record: -> ( activity ) { puts "Modified: #{activity}" }   # ➜ Hook: runs after an activity is created or updated
+                 after_record: -> (activity) { activity.update(metadata: {be: "BOP!"}) }   # ➜ Hook: runs after an activity is created or updated
 end
 ```
 
@@ -57,6 +63,40 @@ ActsAsActive::Activity.where(trackable: record)  # Query the namespaced model di
 ActsAsActive::Activity.all                       # Get all activities across all trackable types
 ```
 
+## Metadata usage
+
+PostgreSQL
+
+```ruby
+# Where metadata contains key/value
+ActsAsActive::Activity.where("metadata @> ?", { source: "api" }.to_json)
+
+# Where nested key/value
+ActsAsActive::Activity.where("metadata @> ?", { user: { id: 42 } }.to_json)
+```
+
+MySQL/SQLite
+
+```ruby
+# MySQL: Find where metadata->source == 'api'
+ActsAsActive::Activity.where("JSON_UNQUOTE(JSON_EXTRACT(metadata, '$.source')) = ?", "api")
+
+# SQLite (with JSON1 extension):
+ActsAsActive::Activity.where("json_extract(metadata, '$.source') = ?", "api")
+```
+
+Writing to metadata
+
+```ruby
+activity.update!(
+  metadata: {
+    source: "api",
+    user: { id: 42, name: "Amit" },
+    tags: ["Dig", "Be", "Bop"]
+  }
+)
+```
+
 ## Run Tests
 
 ```bash

data/lib/acts_as_active/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActsAsActive
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/generators/acts_as_active/install_generator.rb

@@ -4,17 +4,21 @@ require "rails/generators/migration"
 module ActsAsActive
   module Generators
     class InstallGenerator < Rails::Generators::Base
+      desc "Generates the migration for ActsAsActive"
       include Rails::Generators::Migration
 
+      class_option :metadata, type: :string, default: "auto", desc: "jsonb|json|none|auto"
       source_root File.expand_path("templates", __dir__)
-      desc "Generates the migration for ActsAsActive"
 
       def self.next_migration_number(dirname)
         Time.now.utc.strftime("%Y%m%d%H%M%S")
       end
 
       def copy_migration
-        migration_template "create_activities.rb", "db/migrate/create_activities.rb"
+        @metadata_choice = normalize_metadata_choice(options[:metadata])
+        puts "!!! metadata_choice #{@metadata_choice}"
+        @adapter_name    = (ActiveRecord::Base.connection.adapter_name rescue "Unknown")
+        migration_template "create_acts_as_active_activities.rb.erb", "db/migrate/create_acts_as_active_activities.rb"
         create_model
       end
 
@@ -30,6 +34,15 @@ module ActsAsActive
           end
         RUBY
       end
+
+      private
+
+      def normalize_metadata_choice(choice)
+        case choice&.downcase
+        when "jsonb", "json", "none" then choice.downcase
+        else "auto"
+        end
+      end
     end
   end
 end

data/lib/generators/acts_as_active/templates/create_acts_as_active_activities.rb.erb

@@ -0,0 +1,40 @@
+ class CreateActsAsActiveActivities < ActiveRecord::Migration[7.1]
+  def change
+    create_table :acts_as_active_activities do |t|
+      t.string     :trackable_type, null: false
+      t.bigint     :trackable_id,   null: false
+      t.references :actor, polymorphic: true, null: true
+      t.date       :occurred_on,    null: false
+      t.integer    :count,          null: false, default: 0
+<%
+  adapter = @adapter_name.to_s
+  choice  = @metadata_choice
+
+  def pg?(name) = name =~ /PostgreSQL/i
+  col_type =
+    if choice == "jsonb" || (choice == "auto" && pg?(adapter))
+      :jsonb
+    elsif choice == "json"
+      :json
+    elsif choice == "auto"
+      :json
+    else
+      nil
+    end
+%>
+
+<% if col_type %>
+      t.<%= col_type %> :metadata, null: false, default: {}
+<% end %>
+      t.timestamps
+    end
+
+    add_index :acts_as_active_activities,
+              %i[trackable_type trackable_id occurred_on],
+              unique: true, name: "idx_aaa_trackable_on_day"
+<% if col_type == :jsonb && pg?(@adapter_name) %>
+    add_index :acts_as_active_activities, :metadata, using: :gin
+<% end %>
+
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: acts_as_active
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Amit Leshed
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-08-11 00:00:00.000000000 Z
+date: 2025-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -69,7 +69,7 @@ files:
 - lib/acts_as_active/railtie.rb
 - lib/acts_as_active/version.rb
 - lib/generators/acts_as_active/install_generator.rb
-- lib/generators/acts_as_active/templates/create_activities.rb
+- lib/generators/acts_as_active/templates/create_acts_as_active_activities.rb.erb
 - sig/acts_as_active.rbs
 homepage: https://www.amitleshed.com
 licenses:

data/lib/generators/acts_as_active/templates/create_activities.rb

@@ -1,15 +0,0 @@
-class CreateActivities < ActiveRecord::Migration[7.1]
-  def change
-    create_table :acts_as_active_activities do |t|
-      t.string     :trackable_type, null: false
-      t.bigint     :trackable_id,   null: false
-      t.references :actor, polymorphic: true, null: true
-      t.date       :occurred_on,    null: false
-      t.integer    :count,          null: false, default: 0
-
-      t.timestamps
-    end
-
-    add_index :acts_as_active_activities, [:trackable_type, :trackable_id, :occurred_on], unique: true, name: "index_activities_on_trackable_and_occurred_on"
-  end
-end