garden_variety 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9e0504f9a8b485b41628697e9b5b3061e697874d
-  data.tar.gz: 69d7067b8054ce75955a12cf47420901f4badf0b
+  metadata.gz: 40c8e32c8c62b56caaea0a4346859e6ae74bde2e
+  data.tar.gz: 44398e9e38ceaf81e1ef7a729d167b080c0f0f2e
 SHA512:
-  metadata.gz: 3cb5e7ee8a146481586d7aa7efabdd48efa03e34617c3f9cd6e46bab3a8730210cc12d3ad9c1ec5d9d17daa675b17b8f08ae6481ac8545a8cc27f7a830b9fe40
-  data.tar.gz: 1e02647816ee226bf0d46dc7933e74aff5f28a465abbf75d4722d2e69c287581b7b2da56cfbc7fd7fe629705cd19d8beb6eb800b8a7d7e0ff786b276287d822e
+  metadata.gz: e17204ddf0a4a15b2ec52af60204d0774d845d71122c41808853fa1febdb849d8c938d33ba02398fe05b41398376917a7d81de783aadf9f14b0794a4659bcc85
+  data.tar.gz: eb1a353562e16b894b1fd432b8dbd42fe09fc1ebb8da72d1d422e2257d013d14e98182b148d3713be379dc005b9a32f1f1e2a17bbe6d901ef3fe329fcbfd8eb6

data/README.md

@@ -21,7 +21,7 @@ class PostsController < ApplicationController
 end
 ```
 
-...expands to the following conventional implementation:
+...is equivalent to the following conventional implementation:
 
 ```ruby
 class PostsController < ApplicationController
@@ -67,7 +67,7 @@ class PostsController < ApplicationController
   def destroy
     self.resource = find_resource
     authorize(resource)
-    resource.destroy
+    resource.destroy!
     redirect_to action: :index
   end
 
@@ -305,6 +305,27 @@ conventional.  The *garden_variety* helper methods all work as expected
 because `RegistrationForm` responds to `assign_attributes` and `save`,
 and has a default (nullary) constructor.
 
+This pattern of overriding an action merely to respond differently upon
+success is common enough that *garden_variety* provides a concise syntax
+for it:
+
+```ruby
+class RegistrationFormsController < ApplicationController
+  garden_variety :new, :create
+
+  def create
+    super{ redirect_to root_path }
+  end
+end
+```
+
+Note here the `garden_variety` macro generates a default `create`
+action, which is then invoked with `super` in the `create` override.
+When a block is given to the default `create` action, the block is
+treated as an on-success callback which replaces the default redirect.
+This callback behavior is also available for the `update` and `destroy`
+actions.
+
 
 ### Non-REST actions
 

data/lib/garden_variety/actions.rb

@@ -29,11 +29,14 @@ module GardenVariety
 
   module CreateAction
     # Garden variety controller +create+ action.
+    # @overload create()
+    # @overload create()
+    #   @yield on-success callback, replaces default redirect
     # @return [void]
     def create
       self.resource = vest(new_resource)
       if resource.save
-        redirect_to resource
+        block_given? ? yield : redirect_to(resource)
       else
         render :new
       end
@@ -51,11 +54,14 @@ module GardenVariety
 
   module UpdateAction
     # Garden variety controller +update+ action.
+    # @overload update()
+    # @overload update()
+    #   @yield on-success callback, replaces default redirect
     # @return [void]
     def update
       self.resource = vest(find_resource)
       if resource.save
-        redirect_to resource
+        block_given? ? yield : redirect_to(resource)
       else
         render :edit
       end
@@ -64,12 +70,15 @@ module GardenVariety
 
   module DestroyAction
     # Garden variety controller +destroy+ action.
+    # @overload destroy()
+    # @overload destroy()
+    #   @yield on-success callback, replaces default redirect
     # @return [void]
     def destroy
       self.resource = find_resource
       authorize(resource)
-      resource.destroy
-      redirect_to action: :index
+      resource.destroy!
+      block_given? ? yield : redirect_to(action: :index)
     end
   end
 

data/lib/garden_variety/version.rb

@@ -1,3 +1,3 @@
 module GardenVariety
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: garden_variety
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Jonathan Hefner
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-27 00:00:00.000000000 Z
+date: 2017-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails