mime_actor 0.3.2 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b52e3908f3269eb87dbe77d561e9bdb9067446b142e526ea8198fbe6481f29c4
-  data.tar.gz: 5d89ea4e185dfefcbbc1576a63967d1d0403f2dbcc39fe20277ee5a3194d9f33
+  metadata.gz: 7f099315434127b3b7044aad85eca2f69664521753dd339af0f8b6829e0ef8dc
+  data.tar.gz: f8d79ab0813b5f3d63a8a991c9a0f39f328cc67e991738a21030a7fcaee3eae6
 SHA512:
-  metadata.gz: 23e504b9e30c8584bf7e7d65d4e6e4033bb92ad2930743e1dc6c91e2bb92226c318ba25a964d4f37cb8c7c356c2766ce5f9215909f6118d10d71b65d13288854
-  data.tar.gz: e4b8a9071b709ab56ac88f9b1605a1868be2952096517922388186a03ccdfe7ac8aba36b1d114e8a09a66cdc23e89bd6bea8a0adba3b600234ffdc758c9aa038
+  metadata.gz: ba11f403b7031051f9d56577a34dc7b2c63906aabe7b6e663fa9ef87225e0a9334d3a9f08eabbefc5f85a201c8ed73e231e4c616a2f0bac7d1a37e05607a4e81
+  data.tar.gz: 3f21642e23e14ef5a175740e7916618ed3fb99b8395197d7b5239abe0ead83d0ea498ed1b6f63fa4830e9803e2bc16c04f32c43b25544bcf57c9986f2999f528

data/.rubocop.yml

@@ -15,6 +15,19 @@ Style/BlockComments:
   Exclude:
     - spec/*_helper.rb
 
+Metrics/AbcSize:
+  Enabled: false
+  
+Metrics/CyclomaticComplexity:
+  Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/MethodLength:
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 15
+
 Style/StringLiterals:
   EnforcedStyle: double_quotes
 
@@ -32,7 +45,14 @@ Layout/HashAlignment:
   EnforcedColonStyle: table
 
 RSpec/MultipleExpectations:
-  Enabled: false
+  Max: 6
 
 RSpec/ExampleLength:
-  Enabled: false
+  CountAsOne: ['array', 'heredoc', 'method_call']
+  Max: 10
+
+RSpec/MultipleMemoizedHelpers:
+  Max: 10
+
+RSpec/NestedGroups:
+  Max: 5

data/README.md

@@ -1,6 +1,6 @@
 # mime_actor
 
-[![Gem Version](https://badge.fury.io/rb/mime_actor.svg)](https://badge.fury.io/rb/mime_actor)
+[![Gem Version](https://badge.fury.io/rb/mime_actor.png)](https://badge.fury.io/rb/mime_actor)
 [![Build](https://github.com/ryancyq/mime_actor/actions/workflows/build.yml/badge.svg)](https://github.com/ryancyq/mime_actor/actions/workflows/build.yml)
 
 Action rendering and rescue with mime type via configuration in actionpack

data/lib/mime_actor/act.rb

@@ -5,6 +5,7 @@ require "mime_actor/stage"
 require "mime_actor/rescue"
 
 require "active_support/concern"
+require "active_support/lazy_load_hooks"
 require "abstract_controller/rendering"
 require "action_controller/metal/mime_responds"
 
@@ -14,40 +15,31 @@ module MimeActor
 
     include AbstractController::Rendering # required by MimeResponds
     include ActionController::MimeResponds
+
     include Scene
     include Stage
     include Rescue
+    include Logging
 
-    module ClassMethods
-      def dispatch_act(action: nil, format: nil, context: self, &block)
-        lambda do
-          context.instance_exec(&block)
-        rescue StandardError => e
-          (respond_to?(:rescue_actor) && rescue_actor(e, action:, format:, context:)) || raise
-        end
-      end
-    end
-
-    private
-
-    def play_scene(action)
+    def start_scene(action)
       action = action&.to_sym
-      return unless acting_scenes.key?(action)
+      formats = acting_scenes.fetch(action, Set.new)
+
+      if formats.empty?
+        logger.warn { "format is empty, action: #{action}" }
+        return
+      end
 
-      mime_types = acting_scenes.fetch(action, Set.new)
       respond_to do |collector|
-        mime_types.each do |mime_type|
-          next unless (actor = find_actor("#{action}_#{mime_type}"))
-
-          dispatch = self.class.dispatch_act(
-            action:  action,
-            format:  mime_type,
-            context: self,
-            &actor
-          )
-          collector.public_send(mime_type, &dispatch)
+        formats.each do |format|
+          dispatch = self.class.dispatch_cue(action: action, format: format, context: self) do
+            cue_actor("#{action}_#{format}")
+          end
+          collector.public_send(format, &dispatch)
         end
       end
     end
+
+    ActiveSupport.run_load_hooks(:mime_actor, self)
   end
 end

data/lib/mime_actor/errors.rb

@@ -1,20 +1,45 @@
 # frozen_string_literal: true
 
+require "set"
+
 module MimeActor
   class Error < StandardError
+    def inspect
+      "<#{self.class.name}> #{message}"
+    end
+
+    def generate_message
+      self.class.name
+    end
   end
 
-  class ActorNotFound < Error
+  class ActorError < Error
     attr_reader :actor
 
     def initialize(actor)
       @actor = actor
+      super(generate_message)
+    end
+  end
 
-      super(":#{actor} not found")
+  class ActorNotFound < ActorError
+    def generate_message
+      ":#{actor} not found"
     end
+  end
 
-    def inspect
-      "<#{self.class.name}> #{message}"
+  class ActionError < Error
+    attr_reader :action
+
+    def initialize(action = nil)
+      @action = action
+      super(generate_message)
+    end
+  end
+
+  class ActionExisted < ActionError
+    def generate_message
+      "action :#{action} already existed"
     end
   end
 end

data/lib/mime_actor/logging.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "active_support/configurable"
+require "active_support/isolated_execution_state" # required by active_support/logger
+require "active_support/logger"
+require "active_support/tagged_logging"
+
+module MimeActor
+  module Logging
+    extend ActiveSupport::Concern
+
+    include ActiveSupport::Configurable
+
+    included do
+      config_accessor :logger, default: ActiveSupport::TaggedLogging.new(ActiveSupport::Logger.new($stdout))
+    end
+
+    private
+
+    def fill_run_sheet(*scenes, &)
+      return yield unless logger.respond_to?(:tagged)
+
+      scenes.unshift "MimeActor" unless logger.formatter.current_tags.include?("MimeActor")
+
+      logger.tagged(*scenes, &)
+    end
+  end
+end

data/lib/mime_actor/rescue.rb

@@ -1,55 +1,56 @@
 # frozen_string_literal: true
 
+require "mime_actor/stage"
+require "mime_actor/validator"
+
 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"
 require "active_support/core_ext/string/inflections"
-require "action_dispatch/http/mime_type"
 
 module MimeActor
   module Rescue
     extend ActiveSupport::Concern
 
+    include Stage
+    include Validator
+
     included do
       mattr_accessor :actor_rescuers, instance_writer: false, default: []
     end
 
     module ClassMethods
       def rescue_actor_from(*klazzes, action: nil, format: nil, with: nil, &block)
-        raise ArgumentError, "Error filter can't be empty" if klazzes.empty?
-        raise ArgumentError, "Provide only the with: keyword argument or a block" if with.present? && block_given?
-        raise ArgumentError, "Provide the with: keyword argument or a block" unless with.present? || block_given?
+        raise ArgumentError, "error filter is required" if klazzes.empty?
 
+        validate!(:with, with, block)
         with = block if block_given?
-        raise ArgumentError, "Rescue handler can only be Symbol/Proc" unless with.is_a?(Proc) || with.is_a?(Symbol)
 
-        if format.present?
-          case format
-          when Symbol
-            raise ArgumentError, "Unsupported format: #{format}" unless Mime::SET.symbols.include?(format.to_sym)
-          when Enumerable
-            unfiltered = format.to_set
-            filtered = unfiltered & Mime::SET.symbols.to_set
-            rejected = unfiltered - filtered
-            raise ArgumentError, "Unsupported formats: #{rejected.join(", ")}" if rejected.size.positive?
+        if action.present?
+          if action.is_a?(Enumerable)
+            validate!(:actions, action)
           else
-            raise ArgumentError, "Format filter can only be Symbol/Enumerable"
+            validate!(:action, action)
           end
         end
 
-        if action.present? && !(action.is_a?(Symbol) || action.is_a?(Enumerable))
-          raise ArgumentError, "Action filter can only be Symbol/Enumerable"
+        if format.present?
+          if format.is_a?(Enumerable)
+            validate!(:formats, format)
+          else
+            validate!(:format, format)
+          end
         end
 
         klazzes.each do |klazz|
-          error = if klazz.is_a?(Module)
+          error = case klazz
+                  when Module
                     klazz.name
-                  elsif klazz.is_a?(String)
+                  when String
                     klazz
                   else
-                    raise ArgumentError,
-                          "#{klazz.inspect} must be a class/module or a String referencing a class/module"
+                    message = "#{klazz.inspect} must be a Class/Module or a String referencing a Class/Module"
+                    raise ArgumentError, message
                   end
 
           # append at the end because strategies are read in reverse.
@@ -58,12 +59,13 @@ module MimeActor
       end
 
       def rescue_actor(error, action: nil, format: nil, context: self, visited: [])
-        visited << error
+        return if visited.include?(error)
 
+        visited << error
         if (rescuer = dispatch_rescuer(error, format:, action:, context:))
           rescuer.call(error, format, action)
           error
-        elsif error&.cause && !visited.include?(error.cause)
+        elsif error&.cause
           rescue_actor(error.cause, format:, action:, context:, visited:)
         end
       end

data/lib/mime_actor/scene.rb

@@ -1,51 +1,54 @@
 # frozen_string_literal: true
 
-require "mime_actor/stage"
+require "mime_actor/errors"
+require "mime_actor/validator"
 
 require "active_support/concern"
 require "active_support/core_ext/array/extract_options"
 require "active_support/core_ext/array/wrap"
-require "active_support/core_ext/hash/indifferent_access"
 require "active_support/core_ext/module/attribute_accessors"
-require "action_dispatch/http/mime_type"
 
 module MimeActor
   module Scene
     extend ActiveSupport::Concern
 
-    include Stage
+    include Validator
 
     included do
-      mattr_accessor :acting_scenes, instance_writer: false, default: ActiveSupport::HashWithIndifferentAccess.new
+      mattr_accessor :acting_scenes, instance_writer: false, default: {}
     end
 
     module ClassMethods
       def compose_scene(*options)
         config = options.extract_options!
-        actions = Array.wrap(config[:on])
-
-        raise ArgumentError, "Action name can't be empty, e.g. on: :create" if actions.empty?
-
-        options.each do |mime_type|
-          raise ArgumentError, "Unsupported format: #{mime_type}" unless Mime::SET.symbols.include?(mime_type.to_sym)
+        validate!(:formats, options)
+
+        actions = config[:on]
+        if !actions
+          raise ArgumentError, "action is required"
+        elsif actions.is_a?(Enumerable)
+          validate!(:actions, actions)
+        else
+          validate!(:action, actions)
+        end
 
-          actions.each do |action|
-            if !acting_scenes.key?(action) && actor?(action)
-              raise ArgumentError, "Action method already defined: #{action}"
-            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
 
             acting_scenes[action] ||= Set.new
-            acting_scenes[action] |= [mime_type.to_sym]
+            acting_scenes[action] |= [format]
 
-            next if actor?(action)
+            next if action_defined
 
             class_eval(
               # def index
-              #   self.cue_actor(:play_scene, :index)
+              #   self.respond_to?(:start_scene) && self.start_scene(:index)
               # end
               <<-RUBY, __FILE__, __LINE__ + 1
                 def #{action}
-                  self.cue_actor(:play_scene, :#{action})
+                  self.respond_to?(:start_scene) && self.start_scene(:#{action})
                 end
               RUBY
             )

data/lib/mime_actor/stage.rb

@@ -1,18 +1,16 @@
 # frozen_string_literal: true
 
 require "mime_actor/errors"
+require "mime_actor/logging"
 
 require "active_support/concern"
-require "active_support/configurable"
 require "active_support/core_ext/module/attribute_accessors"
-require "abstract_controller/logger"
 
 module MimeActor
   module Stage
     extend ActiveSupport::Concern
 
-    include ActiveSupport::Configurable
-    include AbstractController::Logger
+    include Logging
 
     included do
       mattr_accessor :raise_on_missing_actor, instance_writer: false, default: false
@@ -20,29 +18,31 @@ module MimeActor
 
     module ClassMethods
       def actor?(actor_name)
-        return action_methods.include?(actor_name.to_s) if singleton_methods.include?(:action_methods)
-
-        instance_methods.include?(actor_name.to_sym)
+        # 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
-    end
-
-    def actor?(actor_name)
-      return action_methods.include?(actor_name.to_s) if respond_to?(:action_methods)
-
-      methods.include?(actor_name.to_sym)
-    end
 
-    def find_actor(actor_name)
-      return method(actor_name) if actor?(actor_name)
-
-      error = MimeActor::ActorNotFound.new(actor_name)
-      raise error if raise_on_missing_actor
-
-      logger.warn { "Actor not found: #{error.inspect}" }
+      def dispatch_cue(action: nil, format: nil, context: self, &block)
+        lambda do
+          context.instance_exec(&block)
+        rescue StandardError => e
+          (respond_to?(:rescue_actor) && rescue_actor(e, action:, format:, context:)) || raise
+        end
+      end
     end
 
     def cue_actor(actor_name, *args)
-      return unless actor?(actor_name)
+      unless self.class.actor?(actor_name)
+        raise MimeActor::ActorNotFound, actor_name if raise_on_missing_actor
+
+        logger.warn { "actor not found, got: #{actor_name}" }
+        return
+      end
 
       result = public_send(actor_name, *args)
       if block_given?

data/lib/mime_actor/validator.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "set" # required by mime_type with ruby <= 3.1
+require "action_dispatch/http/mime_type"
+
+module MimeActor
+  module Validator
+    extend ActiveSupport::Concern
+
+    included do
+      mattr_accessor :scene_formats, instance_writer: false, default: Mime::SET.symbols.to_set
+    end
+
+    module ClassMethods
+      def validate!(rule, *args)
+        validator = "validate_#{rule}"
+        raise NameError, "Validator not found, got: #{validator}" unless respond_to?(validator, true)
+
+        error = send(validator, *args)
+        raise error if error
+      end
+
+      def validate_action(unchecked)
+        ArgumentError.new("action must be a Symbol") unless unchecked.is_a?(Symbol)
+      end
+
+      def validate_actions(unchecked)
+        rejected = unchecked.reject { |action| action.is_a?(Symbol) }
+        NameError.new("invalid actions, got: #{rejected.join(", ")}") if rejected.size.positive?
+      end
+
+      def validate_format(unchecked)
+        return ArgumentError.new("format must be a Symbol") unless unchecked.is_a?(Symbol)
+
+        NameError.new("invalid format, got: #{unchecked}") unless scene_formats.include?(unchecked)
+      end
+
+      def validate_formats(unchecked)
+        unfiltered = unchecked.to_set
+        filtered = unfiltered & scene_formats
+        rejected = unfiltered - filtered
+
+        NameError.new("invalid formats, got: #{rejected.join(", ")}") if rejected.size.positive?
+      end
+
+      def validate_with(unchecked, block)
+        if unchecked.present? && block.present?
+          return ArgumentError.new("provide either the with: keyword argument or a block")
+        end
+        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)
+
+        ArgumentError.new("with handler must be a Symbol or Proc, got: #{unchecked.inspect}")
+      end
+    end
+  end
+end

data/lib/mime_actor/version.rb

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

data/lib/mime_actor.rb

@@ -12,4 +12,6 @@ module MimeActor
   autoload :Scene
   autoload :Stage
   autoload :Rescue
+  autoload :Validator
+  autoload :Logging
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mime_actor
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.4.0
 platform: ruby
 authors:
 - Ryan Chang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -68,9 +68,11 @@ files:
 - lib/mime_actor.rb
 - lib/mime_actor/act.rb
 - lib/mime_actor/errors.rb
+- lib/mime_actor/logging.rb
 - lib/mime_actor/rescue.rb
 - lib/mime_actor/scene.rb
 - lib/mime_actor/stage.rb
+- lib/mime_actor/validator.rb
 - lib/mime_actor/version.rb
 - sig/mime_actor.rbs
 homepage: https://github.com/ryancyq/mime_actor