mime_actor 0.5.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5eb8de0fc146859794812ae3cb81cb99a1a775668af9681e22409fd8df0b245e
-  data.tar.gz: b39aa38f9a21c2b8a794ba1edaf01e184fbe0277cc256721e61df9f2fa98a3c4
+  metadata.gz: 031455cd4203f02b1760129516e1a8722af2f84d7580cf1799f886d98262cdea
+  data.tar.gz: 78b2841148310600b408fd3d2932741ab61280f24afb28f0b251e62bcba91419
 SHA512:
-  metadata.gz: c4c8f432f1cd6d7a1678b9ed1da3cada46a28ed9406003f4fa9cac78375567dbc15f600c11cf3ef10acd76c8d4449b24385db6397be8f5dab6fc9f1ab6b9c3d9
-  data.tar.gz: bbe236716e0a3969737388f9390349563d088581486b17b8601b150bf88ccaf8a68beadb913c1496cfad0652727a17689a0f2ad9db46c4917bac6449e36e8a21
+  metadata.gz: 2852a58bb4dc628d293e6d5974b452144496be454a2a594aec90baaffcf5fbbcdd096745778853f36cc5e8ef4eb577340175bd76533ba2be1852799ddf5cc2a6
+  data.tar.gz: f548c1d8fe2c32a2aba34c4b9189e3e02272fdcfdc850d8b88e6cb6eea54514a1c95cc8ede181656f5ba0e92111f2566db1cbc98b647dd77f0922cd2ff1357be

data/.rubocop.yml

@@ -19,6 +19,10 @@ Style/BlockComments:
 Metrics/AbcSize:
   Enabled: false
   
+Metrics/BlockLength:
+  AllowedMethods:
+    - class_methods
+
 Metrics/CyclomaticComplexity:
   Enabled: false
 

data/COMPARE.md

@@ -94,11 +94,11 @@ class EventsController < ActionController::Base
 
     act_on_format :html, :json, on: [:show, :update]
 
-    rescue_actor_from ActiveRecord::RecordNotFound, format: :json do |ex|
+    rescue_act_from ActiveRecord::RecordNotFound, format: :json do |ex|
         render status: :bad_request, json: { error: ex.message }
     end
 
-    rescue_actor_from ActiveRecord::RecordNotFound, format: :html, action: :show do |ex|
+    rescue_act_from ActiveRecord::RecordNotFound, format: :html, action: :show do |ex|
         redirect_to events_path
     end
 

data/README.md

@@ -19,11 +19,11 @@ class EventsController < ActionController::Base
     act_on_format :html, :json, on: :index
     act_on_format :html, :json, on: [:show, :update]
 
-    rescue_actor_from ActiveRecord::RecordNotFound, format: :json do |ex|
+    rescue_act_from ActiveRecord::RecordNotFound, format: :json do |ex|
         render status: :bad_request, json: { error: "Resouce not found" }
     end
 
-    rescue_actor_from ActiveRecord::RecordNotFound, format: :html, action: :show do |ex|
+    rescue_act_from ActiveRecord::RecordNotFound, format: :html, action: :show do |ex|
         redirect_to events_path
     end
 

data/lib/mime_actor/action.rb

@@ -27,7 +27,7 @@ module MimeActor
     include Rescue
     include Logging
 
-    # The core logic where rendering logics are collected as `Proc` through configuration and passed over to `ActionController::MimeResponds`
+    # The core logic where rendering logics are collected as `Proc` and passed over to `ActionController::MimeResponds`
     #
     # @param action the `action` of the controller
     #

data/lib/mime_actor/rescue.rb

@@ -16,7 +16,7 @@ module MimeActor
   # Simillar to `ActionController::Rescue` but with additional filtering logic on `action`/`format`.
   #
   # @example Rescue RuntimeError when raised for any action with `json` format
-  #   rescue_actor_from RuntimeError, format: :json, with: :handle_json_error
+  #   rescue_act_from RuntimeError, format: :json, with: :handle_json_error
   #
   module Rescue
     extend ActiveSupport::Concern
@@ -28,7 +28,7 @@ module MimeActor
       mattr_accessor :actor_rescuers, instance_writer: false, default: []
     end
 
-    module ClassMethods
+    class_methods do
       # Registers a rescue handler for the given error classes with `action`/`format` filter
       #
       # @param klazzes the error classes to rescue
@@ -38,45 +38,30 @@ module MimeActor
       # @param block the `block` to evaluate when `with` is not provided
       #
       # @example Rescue StandardError when raised for any action with `html` format
-      #   rescue_actor_from StandardError, format: :html, with: :handle_html_error
+      #   rescue_act_from StandardError, format: :html, with: :handle_html_error
       #
       # @example Rescue StandardError when raised for `show` action with `json` format
-      #   rescue_actor_from StandardError, format: :json, action: :show do |ex|
+      #   rescue_act_from StandardError, format: :json, action: :show do |ex|
       #     render status: :bad_request, json: { error: ex.message }
       #   end
       #
-      def rescue_actor_from(*klazzes, action: nil, format: nil, with: nil, &block)
+      def rescue_act_from(*klazzes, action: nil, format: nil, with: nil, &block)
         raise ArgumentError, "error filter is required" if klazzes.empty?
 
         validate!(:with, with, block)
         with = block if block_given?
 
         if action.present?
-          if action.is_a?(Enumerable)
-            validate!(:actions, action)
-          else
-            validate!(:action, action)
-          end
+          action.is_a?(Enumerable) ? validate!(:actions, action) : validate!(:action, action)
         end
 
         if format.present?
-          if format.is_a?(Enumerable)
-            validate!(:formats, format)
-          else
-            validate!(:format, format)
-          end
+          format.is_a?(Enumerable) ? validate!(:formats, format) : validate!(:format, format)
         end
 
         klazzes.each do |klazz|
-          error = case klazz
-                  when Module
-                    klazz.name
-                  when String
-                    klazz
-                  else
-                    message = "#{klazz.inspect} must be a Class/Module or a String referencing a Class/Module"
-                    raise ArgumentError, message
-                  end
+          validate!(:klazz, klazz)
+          error = klazz.is_a?(Module) ? klazz.name : klazz
 
           # append at the end because strategies are read in reverse.
           actor_rescuers << [error, format, action, with]

data/lib/mime_actor/scene.rb

@@ -31,7 +31,7 @@ module MimeActor
       mattr_accessor :acting_scenes, instance_writer: false, default: {}
     end
 
-    module ClassMethods
+    class_methods do
       # Register `action` + `format` definitions.
       #
       # @param options [Array]
@@ -39,49 +39,53 @@ module MimeActor
       # @option options [Hash] on the collection of `action`
       #
       # @example register a `html` format on action `index`
-      #   compose_scene :html, on: :index
+      #   act_on_format :html, on: :index
       # @example register `html`, `json` formats on actions `index`, `show`
-      #   compose_scene :html, :json , on: [:index, :show]
+      #   act_on_format :html, :json , on: [:index, :show]
       #
       # For each unique `action` being registered, it will have a corresponding `action` method being defined.
-      def compose_scene(*options)
+      def act_on_format(*options)
         config = options.extract_options!
         validate!(:formats, options)
 
-        actions = config[:on]
-        if !actions
-          raise ArgumentError, "action is required"
-        elsif actions.is_a?(Enumerable)
+        case actions = config[:on]
+        when Enumerable
           validate!(:actions, actions)
-        else
+        when Symbol, String
           validate!(:action, actions)
+        else
+          raise ArgumentError, "action is required"
         end
 
-        options.each do |format|
-          Array.wrap(actions).each do |action|
-            action_defined = (instance_methods + private_instance_methods).include?(action.to_sym)
-            raise MimeActor::ActionExisted, action if !acting_scenes.key?(action) && action_defined
+        Array.wrap(actions).each do |action|
+          options.each { |format| compose_scene(action, format) }
+        end
+      end
 
-            acting_scenes[action] ||= Set.new
-            acting_scenes[action] |= [format]
+      private
 
-            next if action_defined
+      def compose_scene(action, format)
+        action_defined = (instance_methods + private_instance_methods).include?(action.to_sym)
+        raise MimeActor::ActionExisted, action if !acting_scenes.key?(action) && action_defined
 
-            class_eval(
-              # def index
-              #   self.respond_to?(:start_scene) && self.start_scene(:index)
-              # end
-              <<-RUBY, __FILE__, __LINE__ + 1
-                def #{action}
-                  self.respond_to?(:start_scene) && self.start_scene(:#{action})
-                end
-              RUBY
-            )
-          end
-        end
+        acting_scenes[action] ||= Set.new
+        acting_scenes[action] |= [format]
+
+        define_scene(action) unless action_defined
       end
 
-      alias act_on_format compose_scene
+      def define_scene(action)
+        class_eval(
+          # def index
+          #   self.respond_to?(:start_scene) && self.start_scene(:index)
+          # end
+          <<-RUBY, __FILE__, __LINE__ + 1
+            def #{action}
+              self.respond_to?(:start_scene) && self.start_scene(:#{action})
+            end
+        RUBY
+        )
+      end
     end
   end
 end

data/lib/mime_actor/stage.rb

@@ -22,7 +22,7 @@ module MimeActor
       mattr_accessor :raise_on_missing_actor, instance_writer: false, default: false
     end
 
-    module ClassMethods
+    class_methods do
       # Determine if the `actor_name` belongs to a public instance method excluding methods inherited from ancestors
       #
       # @param actor_name
@@ -37,7 +37,8 @@ module MimeActor
         found
       end
 
-      # Wraps the given `block` with a `lambda`, rescue any error raised from the `block` via `rescue_actor` if defined, otherwise, error will be re-raised
+      # 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`

data/lib/mime_actor/validator.rb

@@ -25,7 +25,7 @@ module MimeActor
       mattr_accessor :scene_formats, instance_writer: false, default: Mime::SET.symbols.to_set
     end
 
-    module ClassMethods
+    class_methods do
       # Raise the error returned by validator if any.
       #
       # @param rule the name of validator
@@ -72,6 +72,15 @@ module MimeActor
         NameError.new("invalid formats, got: #{rejected.join(", ")}") if rejected.size.positive?
       end
 
+      # Validate `klazz` must be a Class/Module or a String referencing a Class/Module
+      #
+      # @param unchecked the `klazz` to be validated
+      def validate_klazz(unchecked)
+        return if unchecked.is_a?(Module) || unchecked.is_a?(String)
+
+        ArgumentError.new("#{unchecked.inspect} must be a Class/Module or a String referencing a Class/Module")
+      end
+
       # Validate `with` or `block` must be provided and if `with` is provided, it must be a Symbol or Proc
       #
       # @param unchecked the `with` to be validated
@@ -83,9 +92,7 @@ module MimeActor
         unless unchecked.present? || block.present?
           return ArgumentError.new("provide the with: keyword argument or a block")
         end
-
-        return if block.present?
-        return if unchecked.is_a?(Proc) || unchecked.is_a?(Symbol)
+        return if block.present? || unchecked.is_a?(Proc) || unchecked.is_a?(Symbol)
 
         ArgumentError.new("with handler must be a Symbol or Proc, got: #{unchecked.inspect}")
       end

data/lib/mime_actor/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mime_actor
 version: !ruby/object:Gem::Version
-  version: 0.5.4
+  version: 0.6.0
 platform: ruby
 authors:
 - Ryan Chang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-29 00:00:00.000000000 Z
+date: 2024-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack