mime_actor 0.6.4 → 0.7.1

data/lib/mime_actor/scene.rb

@@ -5,36 +5,29 @@
 require "mime_actor/errors"
 require "mime_actor/validator"
 
+require "active_support/code_generator"
 require "active_support/concern"
-require "active_support/core_ext/array/wrap"
 require "active_support/core_ext/module/attribute_accessors"
-require "active_support/core_ext/object/blank"
 
 module MimeActor
   # # MimeActor Scene
   #
   # Scene provides configuration for `action` + `format` definitions
   #
-  # @example register a `html` format on action `index`
-  #   respond_act_to :html, on: :index
+  # @example register a `html` format on action `create`
+  #   act_on_action :create, format: :html
   #
-  #   # this method should be defined in the class
-  #   def index_html; end
   # @example register `html`, `json` formats on actions `index`, `show`
-  #   respond_act_to :html, :json , on: [:index, :show]
+  #   act_on_action :index, :show, format: [:html, :json]
   #
-  #   # these methods should be defined in the class
-  #   def index_html; end
-  #   def index_json; end
-  #   def show_html; end
-  #   def show_json; end
   # @example register a `html` format on action `index` with respond handler method
-  #   respond_act_to :html, on: :index, with: :render_html
+  #   act_on_action :index, format: :html, with: :render_html
   #
-  #   # this method should be defined in the class
-  #   def render_html; end
-  # @example register a `html` format on action `index` with respond handler proc
-  #   respond_act_to :html, on: :index do
+  # @example register a `html` format on action `index` with respond handler Proc
+  #   act_on_action :index, format: :html, with: -> { render html: "<h1>my header</h1>" }
+  #
+  # @example register a `html` format on action `index` with respond handler block
+  #   act_on_action :html, on: :index do
   #     render :index
   #   end
   #
@@ -52,78 +45,94 @@ module MimeActor
     module ClassMethods
       # Register `action` + `format` definitions.
       #
-      # @param formats the collection of `format`
-      # @param on the collection of `action`
-      # @param with the respond handler when `block` is not provided
-      # @param block the `block` to evaluate when `with` is not provided
+      # @param action a collection of `action`
+      # @param format a single `format` or a collection of `format`
+      # @param with the respond handler for the given `action` + `format`
+      # @param block the `block` to be yieled for the given `action` + `format`
       #
-      # @example register a `html` format on action `index`
-      #   respond_act_to :html, on: :index
+      # @example register a `html` format on action `create`
+      #   act_on_action :create, format: :html
       #
-      #   # this method should be defined in the class
-      #   def index_html; end
+      #   # an action method will be defined in the class
+      #   def indexl; end
       # @example register `html`, `json` formats on actions `index`, `show`
-      #   respond_act_to :html, :json , on: [:index, :show]
+      #   act_on_action :index, :show, format: [:html, :json]
       #
-      #   # these methods should be defined in the class
-      #   def index_html; end
-      #   def index_json; end
-      #   def show_html; end
-      #   def show_json; end
+      #   # these action methods will be defined in the class
+      #   def index; end
+      #   def show; end
       # @example register a `html` format on action `index` with respond handler method
-      #   respond_act_to :html, on: :index, with: :render_html
+      #   act_on_action :index, format: :html, with: :render_html
       #
-      #   # this method should be defined in the class
+      #   # an action method will be defined in the class
+      #   # the handler method will be called by the action method.
+      #   def index; end
+      #   # the given method should be defined in the class
       #   def render_html; end
-      # @example register a `html` format on action `index` with respond handler proc
-      #   respond_act_to :html, on: :index do
+      # @example register a `html` format on action `index` with respond handler Proc
+      #   act_on_action :index, format: :html, with: -> { render html: "<h1>my header</h1>" }
+      #
+      #   # an action method will be defined in the class,
+      #   # the handler Proc will be called by the action method.
+      #   def index; end
+      # @example register a `html` format on action `index` with respond handler block
+      #   act_on_action :html, on: :index do
       #     render :index
       #   end
       #
-      # For each unique `action` being registered, it will have a corresponding `action` method being defined.
-      def respond_act_to(*formats, on: nil, with: nil, &block)
-        validate!(:formats, formats)
-
-        raise ArgumentError, "provide either with: or a block" if with.present? && block_given?
-
-        validate!(:callable, with) if with.present?
+      #   # an action method will be defined in the class
+      #   def index; end
+      #
+      # For each unique `action` being registered, a corresponding `action` method will be defined.
+      def act_on_action(*actions, format:, with: nil, &block)
+        raise ArgumentError, "format is required" if format.nil?
+        raise ArgumentError, "provide either with: or a block" if !with.nil? && block_given?
+
+        validate!(:actions, actions)
+        validate!(:format_or_formats, format)
+        validate!(:callable, with) unless with.nil?
         with = block if block_given?
 
-        raise ArgumentError, "action is required" unless (actions = on).present?
-
-        validate!(:action_or_actions, actions)
-
-        Array.wrap(actions).each do |action|
-          formats.each { |format| compose_scene(action, format, with) }
+        actions.each do |action|
+          acting_scenes[action] ||= {}
+          Array(format).each do |action_format|
+            acting_scenes[action][action_format] = with
+          end
         end
-      end
 
-      # TODO: remove on next breaking change release
-      alias act_on_format respond_act_to
+        generate_action_methods(actions)
+      end
 
       private
 
-      def compose_scene(action, format, actor)
-        action_defined = (instance_methods + private_instance_methods).include?(action.to_sym)
-        raise MimeActor::ActionExisted, action if !acting_scenes.key?(action) && action_defined
-
-        acting_scenes[action] ||= {}
-        acting_scenes[action][format] = actor
+      def generated_action_methods
+        @generated_action_methods ||= Module.new.tap { |mod| prepend mod }
+      end
 
-        define_scene(action) unless action_defined
+      def generate_action_methods(actions)
+        ActiveSupport::CodeGenerator.batch(generated_action_methods, __FILE__, __LINE__) do |owner|
+          actions.each do |action|
+            owner.define_cached_method(action, namespace: :mime_scene) do |batch|
+              batch << action_method_template(action)
+            end
+          end
+        end
       end
 
-      def define_scene(action)
-        module_eval(
-          # def index
-          #   self.respond_to?(:start_scene) && self.start_scene
-          # end
-          <<-RUBY, __FILE__, __LINE__ + 1
-            def #{action}
-              self.respond_to?(:start_scene) && self.start_scene
+      def action_method_template(action)
+        <<-RUBY
+          def #{action}
+            if respond_to?(:start_scene)
+              start_scene do
+                raise #{MimeActor::ActionNotImplemented}, :#{action} unless defined?(super)
+                super
+              end
+            else
+              raise #{MimeActor::ActionNotImplemented}, :#{action} unless defined?(super)
+              super
             end
-          RUBY
-        )
+          end
+        RUBY
       end
     end
   end

data/lib/mime_actor/stage.rb

@@ -26,50 +26,6 @@ module MimeActor
       mattr_accessor :raise_on_actor_error, instance_writer: false, default: false
     end
 
-    module ClassMethods
-      # Determine if the `actor_name` belongs to a public instance method excluding methods inherited from ancestors
-      #
-      # @param actor_name
-      #
-      def actor?(actor_name)
-        # exclude public methods from ancestors
-        found = public_instance_methods(false).include?(actor_name.to_sym)
-        # exclude private methods from ancestors
-        if !found && private_instance_methods(false).include?(actor_name.to_sym)
-          logger.debug { "actor must be public method, #{actor_name} is private method" }
-        end
-        found
-      end
-
-      # Wraps the given `block` with a `lambda`, rescue any error raised from the `block`.
-      # Otherwise, error will be re-raised.
-      #
-      # @param action the `action` to be passed on to `rescue_actor`
-      # @param format the `format` to be passed on to `rescue_actor`
-      # @param context the context for the block evaluation
-      # @param block the `block` to be evaluated
-      #
-      # @example Dispatch a cue that prints out a text
-      #   dispatch = self.class.dispatch_act(action: :create, format: :json, context: self) do
-      #       puts "completed the dispatch"
-      #   end
-      #
-      #   dispatch.call == "completed the dispatch" # true
-      #
-      def dispatch_act(action: nil, format: nil, context: self, &block)
-        raise ArgumentError, "block must be provided" unless block_given?
-
-        lambda do
-          context.instance_exec(&block)
-        rescue StandardError => e
-          (respond_to?(:rescue_actor) && rescue_actor(e, action:, format:, context:)) || raise
-        end
-      end
-
-      # TODO: remove on next breaking change release
-      alias dispatch_cue dispatch_act
-    end
-
     # Calls the `actor` and passing arguments to it.
     # If a block is given, the result from the `actor` method will be yieled to the block.
     #
@@ -78,13 +34,13 @@ module MimeActor
     # @param actor either a method name or a Proc to evaluate
     # @param args arguments to be passed when calling the actor
     #
-    def cue_actor(actor, *args, format:)
+    def cue_actor(actor, *args, action:, format:)
       dispatcher = MimeActor::Dispatcher.build(actor, *args)
       raise TypeError, "invalid actor, got: #{actor.inspect}" unless dispatcher
 
       self.class.validate!(:format, format)
 
-      run_act_callbacks(format) do
+      run_act_callbacks(action:, format:) do
         result = dispatcher.call(self)
         block_given? ? yield(result) : result
       end
@@ -92,7 +48,7 @@ module MimeActor
       logger.error { "actor error, cause: #{e.inspect}" } unless raise_on_actor_error
       raise e if raise_on_actor_error
     rescue StandardError => e
-      rescued = rescue_actor(e, action: action_name.to_sym, format: format)
+      rescued = rescue_actor(e, action:, format:)
       rescued || raise
     end
   end

data/lib/mime_actor/validator.rb

@@ -49,6 +49,8 @@ module MimeActor
       #
       # @param unchecked the `actions` to be validated
       def validate_actions(unchecked)
+        return TypeError.new("actions must not be empty") if unchecked.empty?
+
         rejected = unchecked.reject { |action| action.is_a?(Symbol) }
         NameError.new("invalid actions, got: #{rejected.map(&:inspect).join(", ")}") if rejected.size.positive?
       end
@@ -73,6 +75,8 @@ module MimeActor
       #
       # @param unchecked the `formats` to be validated
       def validate_formats(unchecked)
+        return TypeError.new("formats must not be empty") if unchecked.empty?
+
         unfiltered = unchecked.to_set
         filtered = unfiltered & scene_formats
         rejected = unfiltered - filtered

data/lib/mime_actor/version.rb

@@ -13,8 +13,8 @@ module MimeActor
 
   module VERSION
     MAJOR = 0
-    MINOR = 6
-    BUILD = 4
+    MINOR = 7
+    BUILD = 1
     PRE   = nil
 
     STRING = [MAJOR, MINOR, BUILD, PRE].compact.join(".")

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: mime_actor
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.7.1
 platform: ruby
 authors:
 - Ryan Chang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-07-26 00:00:00.000000000 Z
+date: 2024-07-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '11.0'
+        version: '7.0'
 description: ''
 email:
 - ryancyq@gmail.com
@@ -59,6 +45,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - COMPARE.md
 - LICENSE
 - README.md
@@ -91,9 +78,9 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - "~>"
     - !ruby/object:Gem::Version
-      version: 3.1.0
+      version: '3.1'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="