mime_actor 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f099315434127b3b7044aad85eca2f69664521753dd339af0f8b6829e0ef8dc
-  data.tar.gz: f8d79ab0813b5f3d63a8a991c9a0f39f328cc67e991738a21030a7fcaee3eae6
+  metadata.gz: 21576d34311aa9a06ac9542d118390900d8b9e3d9860fb6ed7d1a4a9b672bf96
+  data.tar.gz: a2ca714375f7892e1506bf55b5fcdbbaa3b1ea7884b9f2ad7a1b4284d3fed08a
 SHA512:
-  metadata.gz: ba11f403b7031051f9d56577a34dc7b2c63906aabe7b6e663fa9ef87225e0a9334d3a9f08eabbefc5f85a201c8ed73e231e4c616a2f0bac7d1a37e05607a4e81
-  data.tar.gz: 3f21642e23e14ef5a175740e7916618ed3fb99b8395197d7b5239abe0ead83d0ea498ed1b6f63fa4830e9803e2bc16c04f32c43b25544bcf57c9986f2999f528
+  metadata.gz: c24629937c5b2d7626588b1ef8ffa1d334450bda5dafe90693d0c65bfc5200d8122e0fdbd315206538c85cb6d8aae29eedf7f07289b3971a13f0a6903d757c0b
+  data.tar.gz: 07d9061ef2e41f55b0e5e9718f9a719a4da2309232be87bf59f638e2a0f9502cfbcdaa6f054f9e2764b9c9b5a9bb1cd5a3a8544a6844902d5dd1f72d07b8ea1f

data/.hound.yml

@@ -0,0 +1,2 @@
+rubocop:
+  enabled: false

data/.rubocop.yml

@@ -7,6 +7,7 @@ AllCops:
   NewCops: enable
   Exclude:
     - bin/*
+    - vendor/**/*
 
 Style/Documentation:
   Enabled: false

data/README.md

@@ -1,25 +1,89 @@
 # mime_actor
 
 [![Gem Version](https://badge.fury.io/rb/mime_actor.png)](https://badge.fury.io/rb/mime_actor)
+[![codecov](https://codecov.io/gh/ryancyq/mime_actor/graph/badge.svg?token=4C091RHXC3)](https://codecov.io/gh/ryancyq/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
+Render + Rescue handlers for different MIME types in Rails
 
-## Installation
+## Usage
 
-Install the gem and add to the application's Gemfile by executing:
+MimeActor allows you to do something like below:
+```rb
+class EventsController < ActionController::Base
+    # AbstractController::Callbacks here to load model with params
+    before_action only: :index { @events = Event.all }
+    before_action only: [:show, :update] { @event = Event.find(params.require(:event_id)) }
 
-    $ bundle add mime_actor
+    compose_scene :html, :json, on: :index
+    compose_scene :html, :json, on: [:show, :update]
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+    rescue_actor_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|
+        redirect_to events_path
+    end
+
+    def index_html
+        @event_categories = EventCategory.all
+        render :index # render html using @events and @event_categories
+    end
+
+    def index_json
+        render json: @events # render json using #as_json
+    end
+
+    def show_html
+        render :show # render html using @event
+    end
+
+    def update_html
+        redirect_to event_path(@event.id) # redirect to show upon sucessful update
+    rescue ActiveRecord::RecordNotFound
+        render :edit
+    end
+
+    def show_json
+        render json: @event # render json using #as_json
+    end
 
-    $ gem install mime_actor
+    def update_json
+        # ...
+        render json: @event # render json using #as_json
+    end
+end
+```
 
-## Getting Started
+## Features
+
+- Action customisation for ActionController per MIME type
+- Customisation are deduplicated automatically when configured multiple times
+- Flexible rescue handler definition for the combination of Action/MIME type or both
+- Built on top of `ActionController::Metal::MimeResponds`
+- Fully compatible with other `ActionController` functionalities 
+
+## Requirements
+
+- Ruby: MRI 3.1+
+- Rails: 5.0+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+```sh
+bundle add mime_actor
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+```sh
+gem install mime_actor
+```
 
 ## Development
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 

data/lib/mime_actor/{act.rb → action.rb}

@@ -10,7 +10,7 @@ require "abstract_controller/rendering"
 require "action_controller/metal/mime_responds"
 
 module MimeActor
-  module Act
+  module Action
     extend ActiveSupport::Concern
 
     include AbstractController::Rendering # required by MimeResponds
@@ -26,7 +26,7 @@ module MimeActor
       formats = acting_scenes.fetch(action, Set.new)
 
       if formats.empty?
-        logger.warn { "format is empty, action: #{action}" }
+        logger.warn { "format is empty for action :#{action}" }
         return
       end
 

data/lib/mime_actor/stage.rb

@@ -40,7 +40,7 @@ module MimeActor
       unless self.class.actor?(actor_name)
         raise MimeActor::ActorNotFound, actor_name if raise_on_missing_actor
 
-        logger.warn { "actor not found, got: #{actor_name}" }
+        logger.warn { "actor not found, expected :#{actor_name}" }
         return
       end
 

data/lib/mime_actor/version.rb

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

data/lib/mime_actor.rb

@@ -8,7 +8,7 @@ require "active_support/dependencies/autoload"
 module MimeActor
   extend ActiveSupport::Autoload
 
-  autoload :Act
+  autoload :Action
   autoload :Scene
   autoload :Stage
   autoload :Rescue

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: mime_actor
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Ryan Chang
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-06-27 00:00:00.000000000 Z
+date: 2024-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack
@@ -59,6 +59,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".hound.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".ruby-version"
@@ -66,7 +67,7 @@ files:
 - README.md
 - Rakefile
 - lib/mime_actor.rb
-- lib/mime_actor/act.rb
+- lib/mime_actor/action.rb
 - lib/mime_actor/errors.rb
 - lib/mime_actor/logging.rb
 - lib/mime_actor/rescue.rb