reactive-actions 0.1.0.pre.alpha.1

data/lib/reactive_actions/configuration.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+# ReactiveActions module provides functionality for creating and executing reactive actions in Rails applications
+module ReactiveActions
+  # Configuration class for ReactiveActions
+  # Manages settings for controller method delegation and instance variable delegation
+  class Configuration
+    attr_accessor :delegated_controller_methods, :delegated_instance_variables
+
+    def initialize
+      # Default methods to delegate
+      @delegated_controller_methods = %i[
+        render redirect_to head params
+        session cookies flash request response
+      ]
+
+      # Default instance variables to delegate
+      @delegated_instance_variables = []
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+  end
+end

data/lib/reactive_actions/engine.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require 'reactive_actions'
+
+module ReactiveActions
+  # Rails engine for the ReactiveActions gem
+  # Handles asset inclusion, autoloading, and namespace management
+  class Engine < ::Rails::Engine
+    isolate_namespace ReactiveActions
+
+    config.generators do |g|
+      g.test_framework :rspec
+      g.fixture_replacement :factory_bot
+      g.factory_bot dir: 'spec/factories'
+    end
+
+    # Tell Zeitwerk to ignore the bridge file specifically
+    initializer 'reactive_actions.zeitwerk_ignore' do
+      Rails.autoloaders.main.ignore("#{root}/lib/reactive-actions.rb")
+    end
+
+    # Configure assets for both Sprockets and Propshaft compatibility
+    initializer 'reactive_actions.assets' do |app|
+      # Add the JavaScript file to asset paths for Propshaft
+      app.config.assets.paths << root.join('app/assets/javascripts') if defined?(Propshaft)
+
+      # For Sprockets compatibility (if still being used)
+      app.config.assets.precompile += %w[reactive_actions.js] if defined?(Sprockets)
+    end
+
+    # Load and namespace action classes properly
+    initializer 'reactive_actions.load_actions', after: :load_config_initializers do |app|
+      actions_path = "#{app.root}/app/reactive_actions"
+      next unless Dir.exist?(actions_path)
+
+      # Find all action files
+      Dir.glob("#{actions_path}/**/*_action.rb").each do |file_path|
+        # Get relative path and class name
+        file_path.sub("#{actions_path}/", '')
+        class_name = File.basename(file_path, '.rb').camelize
+
+        # Skip if already defined in ReactiveActions namespace
+        next if ReactiveActions.const_defined?(class_name, false)
+
+        begin
+          # Load the file to ensure the class is defined
+          require_dependency file_path
+
+          # Try to find the class in global namespace
+          if Object.const_defined?(class_name, false)
+            original_class = Object.const_get(class_name)
+
+            # Create an alias in the ReactiveActions namespace
+            ReactiveActions.const_set(class_name, original_class)
+
+            Rails.logger.debug { "ReactiveActions: Aliased #{class_name} to ReactiveActions::#{class_name}" }
+          end
+        rescue StandardError => e
+          Rails.logger.warn "ReactiveActions: Failed to load action #{file_path}: #{e.message}"
+        end
+      end
+    end
+  end
+end

data/lib/reactive_actions/errors.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module ReactiveActions
+  # Base error class for all ReactiveActions errors
+  class Error < StandardError; end
+
+  # Raised when an action is not found
+  class ActionNotFoundError < Error; end
+
+  # Raised when an action fails to execute properly
+  class ActionExecutionError < Error; end
+
+  # Raised when parameters are invalid
+  class InvalidParametersError < Error; end
+
+  # Raised when a required parameter is missing
+  class MissingParameterError < InvalidParametersError; end
+
+  # Raised when a parameter has an invalid type or format
+  class ParameterTypeError < InvalidParametersError; end
+
+  # Raised when the user is not authorized to perform the action
+  class UnauthorizedError < Error; end
+end

data/lib/reactive_actions/reactive_action.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ReactiveActions
+  # Base class for reactive actions
+  # Provides common functionality for executing actions and handling responses
+  class ReactiveAction
+    attr_reader :action_params, :result, :controller
+
+    # Initialize a new reactive action
+    #
+    # @param [ActionController::Base] controller The controller instance
+    # @param [Hash] action_params Parameters to be used in the action
+    def initialize(controller = nil, **action_params)
+      @controller = controller
+      @action_params = action_params
+
+      # Delegate instance variables from controller to actions class
+      ReactiveActions.configuration.delegated_instance_variables.each do |instance_variable|
+        instance_variable_set("@#{instance_variable}", controller.instance_variable_get("@#{instance_variable}"))
+      end
+    end
+
+    # Execute the action and handle the response through the controller
+    def run
+      ReactiveActions.logger.info "Running action #{self.class.name} with params: #{action_params.inspect}"
+
+      begin
+        # Run the action
+        controller.instance_exec(&method(:action))
+        # Run the response
+        controller.instance_exec(&method(:response))
+      rescue ReactiveActions::Error => e
+        # Let ReactiveActions errors bubble up without modification
+        raise e
+      rescue StandardError => e
+        # Modify all other errors
+        ReactiveActions.logger.error "Error in action #{self.class.name}: #{e.message}"
+        raise ReactiveActions::ActionExecutionError, "Error executing #{self.class.name}: #{e.message}"
+      end
+    end
+
+    # The action to be implemented by subclasses
+    def action
+      raise NotImplementedError, "#{self.class.name} must implement the 'action' method"
+    end
+
+    # The response to be implemented by subclasses
+    def response
+      controller.head :ok
+    end
+
+    # Make class methods private
+    class << self
+      # This hook runs when ReactiveAction is subclassed
+      def inherited(subclass)
+        # Call super
+        super
+        # Apply controller method delegations from configuration
+        ReactiveActions.configuration.delegated_controller_methods.each do |method_name|
+          subclass.delegate method_name, to: :controller, allow_nil: true if ActionController::Base.instance_methods.include?(method_name.to_sym)
+        end
+      end
+
+      private :inherited
+    end
+  end
+end

data/lib/reactive_actions/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ReactiveActions
+  VERSION = '0.1.0-alpha.1'
+end

data/lib/reactive_actions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require 'reactive_actions/version'
+require 'reactive_actions/configuration'
+require 'reactive_actions/engine'
+require 'reactive_actions/reactive_action'
+require 'reactive_actions/errors'
+
+# Main namespace for the ReactiveActions gem
+# Provides functionality for creating and executing reactive actions in Rails applications
+module ReactiveActions
+  class << self
+    attr_writer :logger
+
+    def logger
+      @logger ||= Rails.logger
+    end
+  end
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification
+name: reactive-actions
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre.alpha.1
+platform: ruby
+authors:
+- Istvan Meszaros
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2025-05-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '7.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '9.0'
+description: A modern framework for creating HTTP API endpoints that execute server-side
+  actions in Rails applications with automatic JavaScript client integration.
+email:
+- meszarosistvan97@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- app/assets/javascripts/reactive_actions.js
+- app/controllers/reactive_actions/application_controller.rb
+- app/controllers/reactive_actions/reactive_actions_controller.rb
+- config/initializers/reactive_actions_logger.rb
+- config/routes.rb
+- lib/generators/reactive_actions/install/install_generator.rb
+- lib/generators/reactive_actions/install/templates/README
+- lib/generators/reactive_actions/install/templates/example_action.rb
+- lib/generators/reactive_actions/install/templates/initializer.rb
+- lib/reactive-actions.rb
+- lib/reactive_actions.rb
+- lib/reactive_actions/configuration.rb
+- lib/reactive_actions/engine.rb
+- lib/reactive_actions/errors.rb
+- lib/reactive_actions/reactive_action.rb
+- lib/reactive_actions/version.rb
+homepage: https://github.com/IstvanMs/reactive-actions
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/IstvanMs/reactive-actions
+  source_code_uri: https://github.com/IstvanMs/reactive-actions
+  changelog_uri: https://github.com/IstvanMs/reactive-actions/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message: |2
+      Thank you for installing ReactiveActions!
+
+      To complete the setup, please run:
+        rails generate reactive_actions:install
+
+      This will add the necessary routes to your application.
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">"
+    - !ruby/object:Gem::Version
+      version: 1.3.1
+requirements: []
+rubygems_version: 3.4.19
+signing_key: 
+specification_version: 4
+summary: ReactiveActions for Rails applications
+test_files: []