actify 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b181ccd204525447ca9d58c74484f0c462281b2c06036d37a5e18895f39e5463
-  data.tar.gz: 3114b05c900c3b0e37711d9bf8fd6b7f7c5e44afed997c452d69c5d4e902543e
+  metadata.gz: c2913716ba42355268f383ec908eb7b7cea22f1929512b636b2b183c9fd68181
+  data.tar.gz: 5ec5793bc6ef9eabafac9940ad991149ff07d1e1b883d91d48060cd17ae9a137
 SHA512:
-  metadata.gz: 88e0e02c37af8bedadbe5f6ffa1298e9230f58d8ebcbf51f22907c78c901da136684ffa9ff1a11e3de8615a3b118b15c304e1b9f6c2f16f693d036b8b75517ad
-  data.tar.gz: c4aa854bb3ed3749eed3ef8b0647cff2c5aa4f783542695ac0c64268b578c07861ea7267e13c9b43b2433ab504510564ab2bc8d4e2d50dfb729008804a0bf397
+  metadata.gz: 0dae8c31d8c79c6f1c4e2562bf09ee50284770cc38e8d23dc2b1dd5431ecc897ee55b5dd7d4c24b826df624dbf1e3f587f21db06411f56ccba004a23fa90ae05
+  data.tar.gz: b8233cefc428c863087171bc27f93625651987eb88e311e9f18f32c7758cf270783f0791d3fb0732ebbebd618a670201660b163c48afca2dbfb05f9c37230b5e

data/Gemfile.lock

@@ -0,0 +1,65 @@
+PATH
+  remote: .
+  specs:
+    actify (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.3)
+    diff-lcs (1.6.2)
+    json (2.12.2)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.27.0)
+    parser (3.3.8.0)
+      ast (~> 2.4.1)
+      racc
+    prism (1.4.0)
+    racc (1.8.1)
+    rainbow (3.1.1)
+    rake (13.3.0)
+    regexp_parser (2.10.0)
+    rspec (3.13.1)
+      rspec-core (~> 3.13.0)
+      rspec-expectations (~> 3.13.0)
+      rspec-mocks (~> 3.13.0)
+    rspec-core (3.13.5)
+      rspec-support (~> 3.13.0)
+    rspec-expectations (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-mocks (3.13.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.13.0)
+    rspec-support (3.13.4)
+    rubocop (1.77.0)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.45.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.45.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.4)
+    ruby-progressbar (1.13.0)
+    unicode-display_width (3.1.4)
+      unicode-emoji (~> 4.0, >= 4.0.4)
+    unicode-emoji (4.0.4)
+
+PLATFORMS
+  arm64-darwin-23
+
+DEPENDENCIES
+  actify!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.21)
+
+BUNDLED WITH
+   2.3.27

data/lib/actify/generators/actify/install_generator.rb

@@ -0,0 +1,48 @@
+require "rails/generators"
+require "rails/generators/migration"
+
+module Actify
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("../../../templates", __FILE__)
+      desc "Creates a migration for action_logs table"
+
+      def copy_migration
+        migration_template(
+          "create_action_logs.rb.tt",
+          "db/migrate/create_action_logs.rb",
+          migration_version: migration_version
+        )
+      end
+
+      def copy_model
+        template "action_log.rb.tt", "app/models/action_log.rb"
+      end
+
+      def run_migration
+        say_status("migrating", "Running `rails db:migrate`", :green)
+        rake("db:migrate")
+      end
+
+      def self.next_migration_number(dirname)
+        if @prev_migration_nr
+          @prev_migration_nr += 1
+        else
+          timestamp = Time.now.utc.strftime("%Y%m%d%H%M%S")
+          @prev_migration_nr = timestamp.to_i
+        end
+
+        @prev_migration_nr.to_s
+      end
+
+      private
+
+      # Detect version from Rails project
+      def migration_version
+        "[#{ActiveRecord::Migration.current_version.to_s[0..2]}]"
+      end
+    end
+  end
+end

data/lib/actify/railtie.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "rails/railtie"
+require "rails/generators"
+
+module Actify
+  # Railtie to integrate Actify with Rails
+  class Railtie < Rails::Railtie
+    # Load custom Rails commands
+    railtie_name :actify
+
+    generators do
+      require File.expand_path("../generators/actify/install_generator", __FILE__)
+    end
+  end
+end

data/lib/actify/templates/action_log.rb.tt

@@ -0,0 +1,6 @@
+class ActionLog < ApplicationRecord
+  belongs_to :actor, class_name: "User"
+  belongs_to :actionable, polymorphic: true
+
+  enum status: %i[created aborted finished failed]
+end

data/lib/actify/templates/create_action_logs.rb.tt

@@ -0,0 +1,21 @@
+class CreateActionLogs < ActiveRecord::Migration<%= migration_version %>
+  def change
+    create_table :action_logs do |t|
+      t.string :status
+      t.string :actor_id
+      t.string :action_code
+      t.string :actionable_type
+      t.string :actionable_id
+      t.string :action_label
+      t.text :action_data
+      t.text :context
+      t.text :object_before
+      t.text :object_after
+
+      t.timestamps
+    end
+
+    add_index :action_logs, [:actionable_type, :actionable_id]
+    add_index :action_logs, :actor_id
+  end
+end

data/lib/actify/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Actify
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

data/lib/actify.rb

@@ -1,11 +1,159 @@
 # frozen_string_literal: true
 
+require "actify/railtie" if defined?(Rails)
 require_relative "actify/version"
+require_relative "action"
 
+# This module allows models to define and execute custom actions with various hooks,
+# authorization checks, and lifecycle callbacks.
 module Actify
-  class Error < StandardError; end
+  def self.included(base)
+    return if base.const_defined?(:Actions)
 
-  def self.perform(action)
-    "Performing: #{action}"
+    base.const_set :Actions, (Module.new do
+      def self.all
+        @actions
+      end
+
+      def self.[](code)
+        (@actions || {})[code]
+      end
+    end)
+
+    class << base
+      def use_policy_in_actionable(accept = true) # rubocop:disable Style/OptionalBooleanParameter
+        @use_policy = accept
+      end
+
+      def action(name, options = {}, &block)
+        options["use_policy"] = @use_policy if (options.keys & [:use_policy, "use_policy"]).empty?
+        action_def = Def.new(name, options)
+
+        existing_action = const_get(:Actions).class_eval do
+          (@actions || {})[name]
+        end
+
+        if existing_action
+          action_def.action = existing_action
+          action_def.with_options(options)
+        end
+
+        action_def.instance_eval(&block) if block_given?
+
+        const_get(:Actions).class_eval do
+          @actions ||= {}
+          @actions[name] = action_def.action
+        end
+      end
+    end
+
+    base.action :create, label: "Create" do
+      show? { false }
+      commit do |object, ctx|
+      end
+    end
+
+    base.action :update, label: "Update" do
+      show? { false }
+      commit do |object, ctx|
+      end
+    end
+  end
+
+  # Context class to hold action context data
+  # It is a Hash-like object that provides access to common attributes like actor, data
+  class Context < Hash
+    %i[actor data].each do |attr_name|
+      define_method attr_name do
+        self[attr_name]
+      end
+
+      define_method "#{attr_name}=".to_sym do |value|
+        self[attr_name] = value
+      end
+    end
+
+    def initialize(options = {}) # rubocop:disable Lint/MissingSuper
+      # TODO: check option validity
+      options.each do |key, value|
+        self[key] = value
+      end
+    end
+  end
+
+  class Def # rubocop:disable Style/Documentation
+    attr_accessor :action
+
+    def initialize(name, options = {})
+      @action = Action.new
+      @action.code = name
+
+      with_options options
+    end
+
+    def with_options(options)
+      options.each do |key, value|
+        send(key.to_s, value)
+      end
+    end
+
+    def label(label)
+      @action.label = label
+    end
+
+    def order(order)
+      @action.order = order
+    end
+
+    def type(type)
+      @action.type = type
+    end
+
+    def use_policy(use_policy)
+      @action.use_policy = use_policy
+    end
+
+    def execute_before_action(action_code, options = {})
+      @action.before_actions << {
+        action_code: action_code,
+        options: options
+      }
+    end
+
+    def execute_after_action(action_code, options = {})
+      @action.after_actions << {
+        action_code: action_code,
+        options: options
+      }
+    end
+
+    def show?(&block)
+      @action.hdl_show = block
+    end
+
+    def authorized?(&block)
+      @action.hdl_authorized = block
+    end
+
+    def commitable?(&block)
+      @action.hdl_commitable = block
+    end
+
+    def commit(&block)
+      @action.hdl_commit = block
+    end
+
+    def finalize(&block)
+      @action.hdl_finalize = block
+    end
+  end
+
+  class Error < StandardError
+  end
+
+  class ActorMissingError < Error
+  end
+
+  class InvalidDataError < Error
   end
 end

data/lib/action.rb

@@ -0,0 +1,155 @@
+# frozen_string_literal: true
+
+class Action # rubocop:disable Metrics/ClassLength,Style/Documentation
+  attr_accessor :code, :label, :order, :use_policy, :after_actions, :before_actions, :hdl_show, :hdl_authorized,
+                :hdl_commitable, :hdl_commit, :hdl_finalize
+
+  def initialize
+    @order = 0
+    @after_actions = []
+    @before_actions = []
+    @error = nil
+  end
+
+  def commit!(object, context)
+    execute(object, context)
+  end
+
+  def show?(object, context)
+    if use_policy
+      if hdl_show
+        instance_exec(object, context, &hdl_show)
+      else
+        authorized?(object, context) && commitable?(object, context)
+      end
+    else
+      !hdl_show || instance_exec(object, context, &hdl_show)
+    end
+  end
+
+  def authorized?(object, context) # rubocop:disable Metrics/MethodLength
+    # if use_policy
+    #   if hdl_authorized
+    #     instance_exec(object, context, &hdl_authorized)
+    #   else
+    #     context_for_policy = context.merge({ user: context[:actor] })
+    #     policy = Pundit.policy!(context_for_policy, object)
+    #     policy.send("#{code}?")
+    #   end
+    # else
+    #   !hdl_authorized || instance_exec(object, context, &hdl_authorized)
+    # end
+    !hdl_authorized || instance_exec(object, context, &hdl_authorized)
+  end
+
+  def commitable?(object, context)
+    !hdl_commitable || instance_exec(object, context, &hdl_commitable)
+  end
+
+  def after_action?(action_code)
+    !!after_actions.detect { |after_action| after_action[:action_code] == action_code }
+  end
+
+  def before_action?(action_code)
+    !!before_actions.detect { |before_action| before_action[:action_code] == action_code }
+  end
+
+  private
+
+  def commit(object, context)
+    instance_exec object, context, &hdl_commit
+  end
+
+  def verify_context(context)
+    return if context.actor
+
+    raise Actify::ActorMissingError, "Actor is required to commit action"
+  end
+
+  def execute(object, context) # rubocop:disable Metrics/AbcSize,Metrics/MethodLength
+    verify_context(context)
+
+    log = initialize_action_log(object, context)
+
+    if !(commitable = authorized?(object, context))
+      log.status = ActionLog.statuses[:aborted]
+      log.error = { message: "Unauthorized" }
+    elsif !(commmitable = commitable && commitable?(object, context))
+      log.status = ActionLog.statuses[:aborted]
+      log.error = { message: "Wrong context" }
+    end
+
+    if commmitable
+      begin
+        execute_before_actions object, context
+
+        commit object, context
+
+        execute_after_actions object, context
+
+        log.status = ActionLog.statuses[:finished]
+      rescue StandardError => e
+        log.status = ActionLog.statuses[:aborted]
+        log.error = { message: e.message }
+      end
+    end
+
+    finalize_action_log log, object, context
+
+    log
+  end
+
+  def finalize_action_log(log, object, context)
+    object_before = {}
+    object_after = {}
+
+    object.previous_changes.each do |k, v|
+      object_before[k] = v[0]
+      object_after[k] = v[1]
+    end
+
+    log.object_before = object_before
+    log.object_after = object_after
+
+    instance_exec(log, object, context, &hdl_finalize) if hdl_finalize
+
+    log.save!
+  end
+
+  def execute_before_actions(object, context)
+    to_run_actions = object.class::Actions.all.select do |_code, action|
+      action.before_action? code
+    end
+
+    to_run_actions.each_value do |action|
+      # if action.executable?(context, object, params)
+      action.commit! object, context
+      # end
+    end
+  end
+
+  def execute_after_actions(object, context)
+    to_run_actions = object.class::Actions.all.select do |_code, action|
+      action.after_action? code
+    end
+
+    to_run_actions.each_value do |action|
+      # if action.executable?(context, object, params)
+      action.commit! object, context
+      # end
+    end
+  end
+
+  def initialize_action_log(object, context) # rubocop:disable Metrics/MethodLength
+    ActionLog.create!(
+      status: ActionLog.statuses[:created],
+      actor_id: context.actor.id,
+      actionable: object,
+      action_code: code,
+      action_label: label,
+      action_data: context.data.to_s,
+      context: context.to_s,
+      object_before: object.to_s
+    )
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - nguyenta99
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2025-07-03 00:00:00.000000000 Z
+date: 2025-07-05 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
@@ -22,11 +22,17 @@ files:
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
+- Gemfile.lock
 - LICENSE.txt
 - README.md
 - Rakefile
 - lib/actify.rb
+- lib/actify/generators/actify/install_generator.rb
+- lib/actify/railtie.rb
+- lib/actify/templates/action_log.rb.tt
+- lib/actify/templates/create_action_logs.rb.tt
 - lib/actify/version.rb
+- lib/action.rb
 - sig/actify.rbs
 homepage: https://nguyenta99.com
 licenses: