typical_situation 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e4c1f0edb5145c0cbeab8bd20520a2be77459ff68280f2dfd99350e51c66c288
-  data.tar.gz: f72c7aba90b5984f87ddd5cba2982c512292e4ac1f44603a07eec230db4ccdee
+  metadata.gz: 4fdb5e52424eb45d6f3b9bf32e1977a9b4c1375b5b89487a9a700c8450be40a6
+  data.tar.gz: a92d7ed71e6d90bf6555b1326daef2a69082739230c7476cf6db596cfb565e8d
 SHA512:
-  metadata.gz: cee57ac0c5eea896aea026f06a9889cb832ce98a303e95a6a18d9b91fe9fee9d54a5bcb19fbfa8f52279a73416aa818a2fbb88335113c29c04d2b299ebc51b8e
-  data.tar.gz: de2e3f522926679ae805b952c06ca33409d953d0d4ed3a1482081337bc1d6b87ab20bc7bbc89727037deb5fca5cef51732972c158b13c60d593d1a4a774e1835
+  metadata.gz: 1b2f4d58609addf3c35eb05a98f1df8b5507728c7aca7d03c342466256064e9490d420f5c373479affdfa46aef1d8b5555d0c8269a5742489d17d536d546e391
+  data.tar.gz: bc4fab13796303a61ac7ceee09ecdc42a61aa46ccfe03b3a636df64aadd6fa85e7dd48e451c0e55812932657a3b590a9dff56c57d69122097b166ecb62c3d7e8

data/README.md

@@ -1,6 +1,6 @@
 # Typical Situation [![Spec CI](https://github.com/apsislabs/typical_situation/workflows/Spec%20CI/badge.svg)](https://github.com/apsislabs/typical_situation/actions)
 
-The missing Ruby on Rails ActionController REST API mixin.
+The missing Ruby on Rails ActionController REST API mixin. Originally forked from https://github.com/mars/typical_situation
 
 A Ruby mixin (module) providing the seven standard resource actions & responses for an ActiveRecord :model_type & :collection.
 
@@ -199,6 +199,58 @@ end
 
 By default, `TypicalSituation` permits all parameters (`permit!`) when these methods return `nil` or an empty array. Override them to restrict parameters for security.
 
+#### Flash Messages
+
+Add to `config/locales/en.yml`:
+
+```yaml
+en:
+  typical_situation:
+    flash:
+      create:
+        success: "%{resource} was successfully created"
+      update:
+        success: "%{resource} was successfully updated"
+      destroy:
+        success: "%{resource} was successfully deleted"
+```
+
+**Custom messages per resource:**
+
+```yaml
+en:
+  posts:
+    flash:
+      create:
+        success: "Your blog post is now live"
+```
+
+Override translation helper:
+
+```ruby
+def translate_with_resource(key)
+  model_key = "#{resource_name}.flash.#{key}"
+  if I18n.exists?(model_key)
+    I18n.t(model_key, resource: resource_name.humanize)
+  else
+    I18n.t("typical_situation.flash.#{key}", resource: resource_name.humanize)
+  end
+end
+```
+
+**Custom flash logic:**
+
+```ruby
+def set_success_flash(action)
+  case action
+  when :create
+    flash[:notice] = "Your #{resource_name.humanize.downcase} is live"
+  when :destroy
+    flash[:warning] = translate_with_resource("#{action}.success")
+  end
+end
+```
+
 #### Authorization
 
 Control access to resources by overriding the `authorized?` method:

data/config/locales/typical_situation.en.yml

@@ -0,0 +1,9 @@
+en:
+  typical_situation:
+    flash:
+      create:
+        success: "%{resource} was successfully created"
+      update:
+        success: "%{resource} was successfully updated"
+      destroy:
+        success: "%{resource} was successfully deleted"

data/lib/typical_situation/flash_messages.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module TypicalSituation
+  module FlashMessages
+    private
+
+    def set_success_flash(action)
+      flash[:notice] = translate_with_resource("#{action}.success")
+    end
+
+    def set_error_flash
+      return unless @resource&.errors&.any?
+
+      flash[:error] = @resource.errors.full_messages.join(", ")
+    end
+
+    def translate_with_resource(key)
+      I18n.t(
+        "typical_situation.flash.#{key}",
+        resource: model_type.to_s.humanize
+      )
+    end
+  end
+end

data/lib/typical_situation/responses.rb

@@ -45,6 +45,7 @@ module TypicalSituation
           yield(format) if block_given?
 
           format.html do
+            set_success_flash(:update)
             set_single_instance
             changed_so_redirect || render
           end
@@ -63,6 +64,7 @@ module TypicalSituation
           yield(format) if block_given?
 
           format.html do
+            set_success_flash(:create)
             set_single_instance
             changed_so_redirect || render
           end
@@ -93,6 +95,7 @@ module TypicalSituation
 
     def respond_as_gone
       if has_errors?
+        set_error_flash
         respond_as_error
       else
         respond_to do |format|
@@ -149,6 +152,8 @@ module TypicalSituation
 
     # HTML response when @resource deleted.
     def gone_so_redirect
+      set_error_flash if has_errors?
+      set_success_flash(:destroy) unless has_errors?
       redirect_to after_resource_destroyed_path(@resource)
       true
     end

data/lib/typical_situation/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TypicalSituation
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/lib/typical_situation.rb

@@ -2,6 +2,7 @@
 
 require "typical_situation/identity"
 require "typical_situation/permissions"
+require "typical_situation/flash_messages"
 require "typical_situation/actions"
 require "typical_situation/operations"
 require "typical_situation/responses"
@@ -12,6 +13,7 @@ module TypicalSituation
 
   include Identity
   include Permissions
+  include FlashMessages
   include Operations
   include Responses
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: typical_situation
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Mars Hall
@@ -190,8 +190,10 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
+- config/locales/typical_situation.en.yml
 - lib/typical_situation.rb
 - lib/typical_situation/actions.rb
+- lib/typical_situation/flash_messages.rb
 - lib/typical_situation/identity.rb
 - lib/typical_situation/operations.rb
 - lib/typical_situation/permissions.rb