respond_for_helper 1.1.3 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d1ba35f685da02129cb708b854de5702c29007c378964f6b619ea223d25a77a6
-  data.tar.gz: 39ff8c2905ee45781517b90cc67c0cbb1e779d51bdceaf6b8e4683a2211fe748
+  metadata.gz: 9fd3094966984698be9e2a6dee739ac76fe42e610c8073831d5ae31e6a3df84c
+  data.tar.gz: 92883a30c2c987214cdd876cc1eb506df21731f6ef3231df14c5e93c86c4df45
 SHA512:
-  metadata.gz: 91070c0e93a7b25f8d483f2ab24e9a3ab1a56fa14faec724fc3c5573db60e06291b91793a4de1ef262e88b56f08642d3c1e45b35eb9a14afcfb1ab636ca9454a
-  data.tar.gz: df2dfbd5b64dc5f6e9f10a0aff0aae2d074e8373596a02bd77f806c729b82f9d978c1b21a8c5497653fc7858d753b545ae33bcf96a8516392a790e770de888af
+  metadata.gz: 6808c53b8b8897ef912ac647e021964242f0b54e1cffbd176cf5679b2e61436015ed8f7f581a0962c1d8f4d5c2c9e06a492e0c9f100222076e486a2743918f74
+  data.tar.gz: e0fcdafe477eb29958a0ca29b46b8e463820828da1daacf3d69b2bf8441c60a4a4fb369d55436e7cdaa46dc6c57a8e7599835489b3f8eeeb14bcf1e6df548ef1

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # CHANGELOG
 
+## 1.2.0
+
+* Add options for custom flash message.
+* Respect original flash message.
+
 ## 1.1.3
 
 * Set flash message before render or redirect.

data/README.md

@@ -54,18 +54,25 @@ respond_for @item, html: true, json: true, any: false
 
 ```ruby
 # Specify redirect location when succeeded.
-# The value should be one of string, symbol (action name) or proc.
+# The value should be one of symbol (action name), string or proc.
+respond_for @item, location: :index
 respond_for @item, location: url_for(@item)
+respond_for @item, location: -> { url_for(@item) }
 
 # Specify template when failed.
 # The value should be one of symbol (action name) or proc.
 respond_for @item, failure_template: :some_template
+respond_for @item, failure_template: -> { :some_template }
 
-# Specify notice message when succeeded.
+# Specify notice message when succeeded by symbol, string or proc.
+respond_for @item, notice: :notice
 respond_for @item, notice: 'Create was succceeded'
+respond_for @item, notice: -> { 'Create was succceeded' }
 
-# Specify alert message when failed.
+# Specify alert message when failed by symbol, string or proc.
+respond_for @item, alert: :alert
 respond_for @item, alert: 'Create was failed'
+respond_for @item, alert: -> { 'Create was failed' }
 ```
 
 `respond_for` also supports block like `respond_to`:

data/lib/respond_for_helper/behaviour.rb

@@ -4,12 +4,13 @@ module RespondForHelper
   class Behaviour
     TYPES = [:render, :redirect, :head]
 
-    attr_accessor :type, :target, :flash, :options
+    attr_accessor :type, :target, :flash, :flash_message, :options
 
     def initialize(attrs)
       @type = attrs.delete(:type)
       @target = attrs.delete(:target)
       @flash = attrs.delete(:flash)
+      @flash_message = attrs.delete(:flash_message)
       @options = attrs
     end
 
@@ -46,6 +47,7 @@ module RespondForHelper
 
       if @format == :html
         merge_html_options(behaviour)
+        merge_flash_options(behaviour)
       end
 
       behaviour
@@ -110,6 +112,12 @@ module RespondForHelper
       end
     end
 
+    def merge_flash_options(behaviour)
+      if @options[behaviour.flash]
+        behaviour.flash_message = @options[behaviour.flash]
+      end
+    end
+
     def change_to_render(behaviour)
       behaviour.type = :render
       behaviour.options[:status] = @result == :success ? :ok : :unprocessable_entity

data/lib/respond_for_helper/flashes/base.rb

@@ -1,47 +1,47 @@
-# frozen_string_literal: true
-
-module RespondForHelper
-  module Flashes
-    class Base
-      def initialize(type, options = {})
-        @type = type
-        @options = options
-      end
-
-      def call
-        I18n.t("respond_for.format", **translations.merge(message: message))
-      end
-
-      private
-
-      def translations
-        format_keys.each_with_object({}) do |key, map|
-          map[key] = if @options[key]
-              I18n.t("respond_for.#{key}", value: @options[key], default: '')
-            else
-              ''
-            end
-        end
-      end
-
-      def format_keys
-        I18n.t("respond_for.format").scan(/\%\{(\w+)\}/).flatten.map(&:to_sym)
-      end
-
-      def message
-        @options[@type] || I18n.t(i18n_path, default: i18n_extra_paths)
-      end
-
-      def i18n_path
-        "respond_for.message.#{@options[:controller_path]}.#{@options[:action_name]}.#{@type}"
-      end
-
-      def i18n_extra_paths
-        [ :"respond_for.message.defaults.#{@options[:action_name]}.#{@type}",
-          :"respond_for.message.#{@options[:controller_path]}.default.#{@type}",
-          :"respond_for.message.defaults.default.#{@type}",
-          '' ]
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RespondForHelper
+  module Flashes
+    class Base
+      def initialize(type, options = {})
+        @type = type
+        @options = options
+      end
+
+      def call
+        I18n.t("respond_for.format", **translations.merge(message: message))
+      end
+
+      private
+
+      def translations
+        format_keys.each_with_object({}) do |key, map|
+          map[key] = if @options[key]
+              I18n.t("respond_for.#{key}", value: @options[key], default: '')
+            else
+              ''
+            end
+        end
+      end
+
+      def format_keys
+        I18n.t("respond_for.format").scan(/\%\{(\w+)\}/).flatten.map(&:to_sym)
+      end
+
+      def message
+        @options[@type] || I18n.t(i18n_path, default: i18n_extra_paths)
+      end
+
+      def i18n_path
+        "respond_for.message.#{@options[:controller_path]}.#{@options[:action_name]}.#{@type}"
+      end
+
+      def i18n_extra_paths
+        [ :"respond_for.message.defaults.#{@options[:action_name]}.#{@type}",
+          :"respond_for.message.#{@options[:controller_path]}.default.#{@type}",
+          :"respond_for.message.defaults.default.#{@type}",
+          '' ]
+      end
+    end
+  end
+end

data/lib/respond_for_helper/formats/base.rb

@@ -1,61 +1,61 @@
-# frozen_string_literal: true
-
-module RespondForHelper
-  module Formats
-    class Base
-      class_attribute :format
-
-      attr_reader :controller, :item, :format, :result, :behaviour
-      delegate :request, :render, :head, :redirect_to, :flash, :url_for, :action_name, to: :controller
-
-      def initialize(controller, item, success, options)
-        @controller = controller
-        @item = item
-        @result = success ? :success : :failure
-        @options = options
-
-        @format = self.class.format.to_sym
-        @behaviour = Behaviours.new(@controller, @format, @result, @options).call
-      end
-
-      def call
-        if respond_to?("_#{action_name}", true)
-          send("_#{action_name}")
-        else
-          perform
-        end
-      end
-
-      private
-
-      def perform
-      end
-
-      def succeeded?
-        @result == :success
-      end
-
-      def resolve_target(target)
-        if target.respond_to?(:call)
-          @controller.instance_exec(&target)
-        elsif target.is_a?(Symbol)
-          if respond_to?(target)
-            send(target)
-          elsif @behaviour.redirect?
-            resolve_url(target)
-          else
-            target
-          end
-        else
-          target
-        end
-      end
-
-      def resolve_url(target)
-        url_for(action: target)
-      rescue ActionController::UrlGenerationError
-        url_for(action: target, id: @item)
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RespondForHelper
+  module Formats
+    class Base
+      class_attribute :format
+
+      attr_reader :controller, :item, :format, :result, :behaviour
+      delegate :request, :render, :head, :redirect_to, :flash, :url_for, :action_name, to: :controller
+
+      def initialize(controller, item, success, options)
+        @controller = controller
+        @item = item
+        @result = success ? :success : :failure
+        @options = options
+
+        @format = self.class.format.to_sym
+        @behaviour = Behaviours.new(@controller, @format, @result, @options).call
+      end
+
+      def call
+        if respond_to?("_#{action_name}", true)
+          send("_#{action_name}")
+        else
+          perform
+        end
+      end
+
+      private
+
+      def perform
+      end
+
+      def succeeded?
+        @result == :success
+      end
+
+      def resolve_target(target)
+        if target.respond_to?(:call)
+          @controller.instance_exec(&target)
+        elsif target.is_a?(Symbol)
+          if respond_to?(target)
+            send(target)
+          elsif @behaviour.redirect?
+            resolve_url(target)
+          else
+            target
+          end
+        else
+          target
+        end
+      end
+
+      def resolve_url(target)
+        url_for(action: target)
+      rescue ActionController::UrlGenerationError
+        url_for(action: target, id: @item)
+      end
+    end
+  end
+end

data/lib/respond_for_helper/formats/html.rb

@@ -1,44 +1,55 @@
-# frozen_string_literal: true
-
-module RespondForHelper
-  module Formats
-    class Html < Base
-      self.format = :html
-
-      private
-
-      def perform
-        if @behaviour.flash? && !request.xhr?
-          perform_flash
-        end
-
-        if @behaviour.render?
-          perform_render
-        elsif @behaviour.redirect?
-          perform_redirect
-        end
-      end
-
-      def perform_render
-        render resolve_target(@behaviour.target), @behaviour.options
-      end
-
-      def perform_redirect
-        redirect_to resolve_target(@behaviour.target), @behaviour.options
-      end
-
-      def perform_flash
-        key = @behaviour.flash
-        flash_content[key] = @controller.respond_for_message(key, @options)
-      end
-
-      def flash_content
-        if @behaviour.render?
-          flash.now
-        elsif @behaviour.redirect?
-          flash
-        end
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RespondForHelper
+  module Formats
+    class Html < Base
+      self.format = :html
+
+      private
+
+      def perform
+        if @behaviour.flash? && !request.xhr?
+          perform_flash
+        end
+
+        if @behaviour.render?
+          perform_render
+        elsif @behaviour.redirect?
+          perform_redirect
+        end
+      end
+
+      def perform_render
+        render resolve_target(@behaviour.target), @behaviour.options
+      end
+
+      def perform_redirect
+        redirect_to resolve_target(@behaviour.target), @behaviour.options
+      end
+
+      def perform_flash
+        flash_content[@behaviour.flash] ||= flash_message
+      end
+
+      def flash_message
+        if @behaviour.flash_message.is_a?(Proc)
+          @controller.instance_exec(&@behaviour.flash_message)
+        elsif @behaviour.flash_message.is_a?(Symbol)
+          @controller.respond_for_message(@behaviour.flash_message, @options)
+        elsif @behaviour.flash_message.is_a?(String)
+          @behaviour.flash_message
+        else
+          @controller.respond_for_message(@behaviour.flash, @options)
+        end
+      end
+
+      def flash_content
+        if @behaviour.render?
+          flash.now
+        elsif @behaviour.redirect?
+          flash
+        end
+      end
+    end
+  end
+end

data/lib/respond_for_helper/formats/json.rb

@@ -1,31 +1,31 @@
-# frozen_string_literal: true
-
-module RespondForHelper
-  module Formats
-    class Json < Base
-      self.format = :json
-
-      def item_errors
-        @item.errors
-      end
-
-      private
-
-      def perform
-        if @behaviour.render?
-          perform_render
-        elsif @behaviour.head?
-          perform_head
-        end
-      end
-
-      def perform_render
-        render @behaviour.options.merge(json: resolve_target(@behaviour.target))
-      end
-
-      def perform_head
-        head resolve_target(@behaviour.target), @behaviour.options
-      end
-    end
-  end
-end
+# frozen_string_literal: true
+
+module RespondForHelper
+  module Formats
+    class Json < Base
+      self.format = :json
+
+      def item_errors
+        @item.errors
+      end
+
+      private
+
+      def perform
+        if @behaviour.render?
+          perform_render
+        elsif @behaviour.head?
+          perform_head
+        end
+      end
+
+      def perform_render
+        render @behaviour.options.merge(json: resolve_target(@behaviour.target))
+      end
+
+      def perform_head
+        head resolve_target(@behaviour.target), @behaviour.options
+      end
+    end
+  end
+end

data/lib/respond_for_helper/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RespondForHelper
-  VERSION = '1.1.3'
+  VERSION = '1.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: respond_for_helper
 version: !ruby/object:Gem::Version
-  version: 1.1.3
+  version: 1.2.0
 platform: ruby
 authors:
 - Yoshikazu Kaneta
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-07-17 00:00:00.000000000 Z
+date: 2024-08-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails