mime_actor 0.6.3 → 0.6.4.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c54b7a74eed15ac67b37d8df3879584634955ff4db0275cecc1dd4b7d531ec55
-  data.tar.gz: da797d40d7f90f5c6f8e23b61f2fe1441aef08860c6af5ff1763f49cee15ccaa
+  metadata.gz: 42ba1c04632b3b7ec4c1f1d9c1ab60571eac9e4c44272601d28dccbb45b535d0
+  data.tar.gz: 4d0ccbdba192617231ae0405580921e337412d3de9f63106ff772d33ab0d4208
 SHA512:
-  metadata.gz: 79eea272d7e8c3b625584eb8ae54790076035b511210302bb948076f54d847f34bb5c1f354d03b5fa319fbcc7c370f4c72a97b806593a732dd6207dfb8b6bbbe
-  data.tar.gz: 387780b44aafbcd60e79b7f9ebedd3c00edc40faa1acdce0c6946aad5787f053ae17ae62cab3ba84f8dd695874074e66ef867f6cfbb79e9ba947ddff837c7baa
+  metadata.gz: e8fa8dc7c8d8438a1dff0a7bed147f0603000e7491b2e3e8a70173acd9d71f65628390cc7778d50de084940aaafd56684a347b59da5a872ce485361398d0743d
+  data.tar.gz: 3c87a2ce45ec35aa56786e4fd625a3b689a27aba728d7207c5b3c0cf893afb936c5f944d0408d5ca0149267f46902c7c27ff65845397c9ddccfff12d55233a48

data/COMPARE.md

@@ -1,6 +1,57 @@
 ## Comparison in Rails
 
-### MIME Action
+When some actions render more than a single MIME type with error handling sfor different MIME type.
+```rb
+class EventsController < ActionController::Base
+  def show
+    respond_to do |format|
+      format.html { render "show" }
+      format.json { render_event_json }
+      format.pdf { render_event_pdf }
+    end
+  end
+
+  def create
+    respond_to do |format|
+      format.html do
+        create_event ? redirect_to "/events/#{@event.id}" : render "create"
+      end
+      format.json do
+        create_event!
+        render_event_json
+      rescue StandardError => error
+        render status: :bad_request, json: { error: error.message }
+      end
+    end
+  end
+
+  def update
+    # this will be executed regardless of the requested format.
+    # e.g. requesting for xml will execute #update_event but responded with :not_acceptable http status
+    success = update_event
+
+    respond_to do |format|
+      format.html { success ? redirect_to "/events/#{@event.id}" : render "update" }
+      format.json { render_event_json }
+    end
+  end
+
+  def render_event_json
+    render json: @event
+  rescue StandardError => e
+    render json: { error: e.message }
+  end
+
+  def render_event_pdf
+    # ...
+    # render pdf view or call pdf library with options
+  rescue StandardError
+    # render error page / redirect to 404 page
+  end
+end
+```
+
+### With MIME Action
 
 #### before
 ```rb
@@ -43,12 +94,12 @@ class EventsController < ActionController::Base
 end
 ```
 
-### MIME Rescue
+### With MIME Rescue
 
 #### before
 ```rb
 class EventsController < ActionController::Base
-  before_action only: %i[show update], with: :load_event
+  before_action :load_event, action: %i[show update]
 
   rescue_from ActiveRecord::RecordNotFound do |ex|
     case action_name.to_s
@@ -94,7 +145,7 @@ end
 class EventsController < ActionController::Base
   include MimeActor::Action
 
-  before_action only: %i[show update], with: :load_event
+  before_act :load_event, action: %i[show update]
 
   respond_act_to :html, on: %i[show update]
   respond_act_to :json, on: %i[show update], with: -> { render json: @event } # render json using #as_json

data/README.md

@@ -1,4 +1,4 @@
-# mime_actor
+# Mime Actor
 
 [![Version][rubygems_badge]][rubygems]
 [![CI][ci_badge]][ci_workflows]
@@ -7,15 +7,35 @@
 
 Action processing with Callback + Rescue handlers for different MIME types in Rails.
 
+In most of the Rails apps, a single `ActionController` is only responsible for rendering a single MIME type. That is usually done by calling `ActionController#respond_to` for each action in the controller.
+
+```rb
+class EventsController < ActionController::Base
+  def index
+    @events = Event.all
+    respond_to :json
+  end
+
+  def show
+    respond_to do |format|
+      format.json { render json: @event }
+    end
+  end
+end
+```
+
+However, it can be a litte bit messy when some actions render more than a single MIME type with error handling for different MIME type. See [comparison][doc_comparison] to understand more.
+
 ## Usage
 
-MimeActor allows you to do something like below:
+**Mime Actor** allows you to do something like:
 ```rb
 class EventsController < ActionController::Base
   include MimeActor::Action
 
   before_act -> { @events = Event.all }, action: :index
   before_act :load_event, action: %i[show update]
+  before_act -> { @event_categories = EventCategory.all }, action: :show, format: :html
 
   respond_act_to :html, :json, on: :update
   respond_act_to :html, on: %i[index show], with: :render_html
@@ -35,11 +55,10 @@ class EventsController < ActionController::Base
 
   def update_json
     # ...
-    render json: @event # render json using #as_json
+    render json: @event # render with #to_json
   end
 
   def render_html
-    @event_categories = EventCategory.all if action_name == :index
     render html: action_name
   end
 
@@ -53,8 +72,6 @@ class EventsController < ActionController::Base
 end
 ```
 
-Seems useful? See the [Comparison][doc_comparison] on how it can improve your existing code
-
 ## Features
 
 - Action customisation for [ActionController][doc_action_controller] per MIME type

data/lib/mime_actor/action.rb

@@ -7,6 +7,7 @@ require "mime_actor/scene"
 require "mime_actor/stage"
 
 require "active_support/concern"
+require "active_support/core_ext/module/attribute_accessors"
 require "active_support/core_ext/object/blank"
 require "active_support/lazy_load_hooks"
 require "abstract_controller/rendering"
@@ -29,6 +30,10 @@ module MimeActor
     include Stage
     include Logging
 
+    included do
+      mattr_accessor :actor_delegator, instance_writer: false, default: ->(action, format) { "#{action}_#{format}" }
+    end
+
     # The core logic where rendering logics are collected as `Proc` and passed over to `ActionController::MimeResponds`
     #
     # @example process `create` action
@@ -54,7 +59,8 @@ module MimeActor
 
       respond_to do |collector|
         formats.each do |format, actor|
-          dispatch = -> { cue_actor(actor.presence || "#{action}_#{format}", format:) }
+          callable = actor.presence || actor_delegator.call(action, format)
+          dispatch = -> { cue_actor(callable, format:) }
           collector.public_send(format, &dispatch)
         end
       end

data/lib/mime_actor/deprecator.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+require "active_support/deprecation"
+
+module MimeActor
+  def self.deprecator
+    @deprecator ||= ActiveSupport::Deprecation.new("0.7.0", "MimeActor")
+  end
+end
+
+[
+  [MimeActor::Rescue::ClassMethods, { rescue_actor: "use #rescue_actor instance method" }],
+  [MimeActor::Scene::ClassMethods, { act_on_format: :respond_act_to }],
+  [MimeActor::Stage::ClassMethods, { actor?: "no longer supported, use Object#respond_to?" }],
+  [MimeActor::Stage::ClassMethods, { dispatch_cue: "no longer support anonymous proc with rescue" }],
+  [MimeActor::Stage::ClassMethods, { dispatch_act: "no longer support anonymous proc with rescue" }]
+].each do |klazz, *args|
+  MimeActor.deprecator.deprecate_methods(klazz, *args)
+end

data/lib/mime_actor/railtie.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+# :markup: markdown
+
+module MimeActor
+  class Railtie < Rails::Railtie
+    initializer "mime_actor.deprecator", before: :load_environment_config do |app|
+      app.deprecators[:mime_actor] = MimeActor.deprecator
+    end
+  end
+end

data/lib/mime_actor/rescue.rb

@@ -47,9 +47,9 @@ module MimeActor
       #
       def rescue_act_from(*klazzes, action: nil, format: nil, with: nil, &block)
         raise ArgumentError, "error filter is required" if klazzes.empty?
-        raise ArgumentError, "provide either the with: argument or a block" unless with.present? ^ block_given?
+        raise ArgumentError, "provide either with: or a block" unless with.present? ^ block_given?
 
-        validate!(:with, with) if with.present?
+        validate!(:callable, with) if with.present?
         with = block if block_given?
 
         validate!(:action_or_actions, action) if action.present?

data/lib/mime_actor/scene.rb

@@ -84,9 +84,9 @@ module MimeActor
       def respond_act_to(*formats, on: nil, with: nil, &block)
         validate!(:formats, formats)
 
-        raise ArgumentError, "provide either the with: argument or a block" if with.present? && block_given?
+        raise ArgumentError, "provide either with: or a block" if with.present? && block_given?
 
-        validate!(:with, with) if with.present?
+        validate!(:callable, with) if with.present?
         with = block if block_given?
 
         raise ArgumentError, "action is required" unless (actions = on).present?

data/lib/mime_actor/validator.rb

@@ -96,13 +96,13 @@ module MimeActor
         TypeError.new("#{unchecked.inspect} must be a Class/Module or a String referencing a Class/Module")
       end
 
-      # Validate `with` must be a Symbol or Proc
+      # Validate `callable` must be a Symbol or Proc
       #
-      # @param unchecked the `with` to be validated
-      def validate_with(unchecked)
+      # @param unchecked the `callable` to be validated
+      def validate_callable(unchecked)
         return if unchecked.is_a?(Proc) || unchecked.is_a?(Symbol)
 
-        TypeError.new("with handler must be a Symbol or Proc, got: #{unchecked.inspect}")
+        TypeError.new("#{unchecked.inspect} must be a Symbol or Proc")
       end
     end
   end

data/lib/mime_actor/version.rb

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

data/lib/mime_actor.rb

@@ -6,30 +6,21 @@
 require "mime_actor/version"
 require "mime_actor/errors"
 
-require "active_support/dependencies/autoload"
-require "active_support/deprecation"
+# load mime_actor components
+require "mime_actor/action"
+require "mime_actor/callbacks"
+require "mime_actor/logging"
+require "mime_actor/rescue"
+require "mime_actor/scene"
+require "mime_actor/stage"
+require "mime_actor/validator"
 
-module MimeActor
-  extend ActiveSupport::Autoload
+require "mime_actor/deprecator"
 
-  autoload :Action
-  autoload :Scene
-  autoload :Stage
-  autoload :Rescue
-  autoload :Validator
-  autoload :Logging
-
-  def self.deprecator
-    @deprecator ||= ActiveSupport::Deprecation.new("0.7.0", "MimeActor")
-  end
-
-  [
-    [MimeActor::Rescue::ClassMethods, { rescue_actor: "use #rescue_actor instance method" }],
-    [MimeActor::Scene::ClassMethods, { act_on_format: :respond_act_to }],
-    [MimeActor::Stage::ClassMethods, { actor?: "no longer supported, use Object#respond_to?" }],
-    [MimeActor::Stage::ClassMethods, { dispatch_cue: "no longer support anonymous proc with rescue" }],
-    [MimeActor::Stage::ClassMethods, { dispatch_act: "no longer support anonymous proc with rescue" }]
-  ].each do |klazz, *args|
-    deprecator.deprecate_methods(klazz, *args)
-  end
+begin
+  require "rails"
+rescue LoadError
+  # noop
 end
+
+require "mime_actor/railtie" if defined?(Rails::Railtie)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mime_actor
 version: !ruby/object:Gem::Version
-  version: 0.6.3
+  version: 0.6.4.alpha
 platform: ruby
 authors:
 - Ryan Chang
@@ -65,9 +65,11 @@ files:
 - lib/mime_actor.rb
 - lib/mime_actor/action.rb
 - lib/mime_actor/callbacks.rb
+- lib/mime_actor/deprecator.rb
 - lib/mime_actor/dispatcher.rb
 - lib/mime_actor/errors.rb
 - lib/mime_actor/logging.rb
+- lib/mime_actor/railtie.rb
 - lib/mime_actor/rescue.rb
 - lib/mime_actor/scene.rb
 - lib/mime_actor/stage.rb