resourcerer 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fca34cdbd0b9675cd1e3dc66a1e664acca9c3c45
-  data.tar.gz: 64565620b02df20d0988d258973f3cc1e843c7eb
+  metadata.gz: 55448f1a54313470f4c84d50243ad79ce0f13750
+  data.tar.gz: 30de7964ebdff67394987395145c00e156cdafe9
 SHA512:
-  metadata.gz: 2f6bc395bf6917acfb7030d6275ab4f77d559d0a5c7bda6ac8ece7b9618fce610137f06e6c1dd17f440b42f0c1669bc548d4f9dd2489bd0d67e144d7f522d0f5
-  data.tar.gz: bb1d46a0030aa19625c4391511af787d4eab12a95161f946fc5c4c84ddbe0ef75c934cec8723fb5e77dac14532f7bbbf8af567718c65d15f54d8e86b07e63823
+  metadata.gz: 0201a4f045934bd7b2bfc9fd7ca32b324386d618c84ee9da16963d73002472d801c7487972151a29d856c3f926725748f05a08e05844819cd29fec7c736ee4d5
+  data.tar.gz: b06fb4cbbc6216be391e6bf9af24019596a4af8bd0459fd30f2e3178c6d99be48743ee17474b0497f4c5f2e773686a918fe9f504f43fb1d5fa1f1186a0b3f593

data/README.md

@@ -3,7 +3,7 @@ Resourcerer
 What `resourcerer` proposes is that you go from this:
 
 ```ruby
-class Controller
+class PersonController < ApplicationController
   def new
     @person = Person.new
   end
@@ -40,7 +40,7 @@ end
 To something like this:
 
 ```ruby
-class Controller
+class PersonController < ApplicationController
   resource :person
 
   def create
@@ -70,7 +70,9 @@ The idea is that you don't have to write boilerplate for standard CRUD actions,
 
 ## Usage
 
-Let's see what Resourcerer is doing behind the curtains :smiley:. This examples assume that you are using Rails 4 Strong Parameters.
+Let's see what Resourcerer is doing behind the curtains :smiley:.
+
+This examples assume that you are using Rails 4 Strong Parameters.
 
 ### Obtaining a resource:
 
@@ -115,6 +117,12 @@ resource(:company, model: :enterprise)
 resource(:enterprise, finder_param: :company_id)
 ```
 
+**Specify the model attribute to use to perform the search:**
+
+```ruby
+resource(:enterprise, find_by: :name)
+```
+
 **Specify how to obtain the object attributes:**
 
 ```ruby
@@ -125,6 +133,27 @@ resource(:employee, attributes_method: :person_params)
 resource(:person, param_key: :employee)
 ```
 
+### DSL
+Resourcer also features a nice DSL, which is helpful when you need more control over the resource
+lifecycle.
+
+You can also access every configuration option available above:
+```ruby
+resource(:employee) do
+  model :person
+  find_by :name
+  find {|name| company.find_employee(name) }
+  build { company.new_employee }
+  assign { params.require(:employee).permit(:name) }
+end
+# is the same as:
+resource(:employee, model: :person, finder_attribute: :name, finder: ->(name){ company.find_employee(name) }, builder: ->{ company.new_employee }, attributes: ->{ params.require(:employee).permit(:name) })
+```
+The DSL is more convenient when you have an object oriented design and want to allow an object to handle its collections, or as a quick way to set the StrongParameters method.
+
+Configuration options play well together, and the defaults try to make intelligent use of them. For example,
+setting the `finder_attribute` in the example abovie changes the `finder_param` to `person_name` instead of `person_id`, and the value of that parameter is provided to the finder block.
+
 ### Setting a distinct object for a single action
 
 There are times when one action in a controller is different from the
@@ -174,7 +203,7 @@ resource(:post, strategy: VerifiableStrategy)
 If you use decorators, you can go from something like this:
 
 ```ruby
-class Controller
+class PersonController < ApplicationController
   def new
     @person = Person.new.decorate
   end
@@ -213,7 +242,7 @@ end
 To something like this by adding [presenter_rails](https://github.com/ElMassimo/presenter_rails) to the mix:
 
 ```ruby
-class Controller
+class PersonController < ApplicationController
   resource(:person)
   
   present :person do
@@ -254,5 +283,12 @@ Both allow you to find or initialize a resource and assign attributes, removing
 Resourcerer does not expose an object to the view in any way, scope the query to a collection method if defined, nor deal with collections.
 
 
+### Caveats
+#### When using StrongParametersStrategy
+Since attributes are assigned on every POST, PUT, and PATCH request, sometimes when using Strong Parameters it's not desirable that the attributes method is called. For that reason, the presence of `params[param_key]` is checked before assigning attributes.
+##### Troubleshooting
+- _The attributes are not being assigned_: Check that the resource name matches the param used in the attributes method, and set the `param_key` configuration if they are different.
+- _Need an error to be thrown if the params are not present_: Use the `EagerStrongParametersStrategy`, available in the sample strategies in this repository, you can set it using the `strategy` configuration option.
+
 ### Special Thanks
 Resourcerer was inspired by [decent_exposure](https://github.com/voxdolo/decent_exposure).

data/lib/resourcerer/strategy.rb

@@ -41,7 +41,7 @@ module Resourcerer
     end
 
     def finder_attribute
-      config.finder_attribute || :id
+      config.find_by || :id
     end
 
     def params

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resourcerer
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Máximo Mussini