skinny_controllers 0.10.0 → 0.10.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6cba81691573f9ad4648dcacb2733234c5ef4cd5
-  data.tar.gz: cb4d9ff187f35d0cd097da6675ed3de9f74115db
+  metadata.gz: d020916e740eec6d6047321f6797499deedd91a9
+  data.tar.gz: 38f090da8386787f87ceaaa58ab37e6b8653cd38
 SHA512:
-  metadata.gz: 64f11e00970ccbca44700ff970e54cb92a3b0e5d107b80949d03c6f2bf98deca88774f0a39c71b2b6fd3b2b4dceeae34adccba483deef8f55a7c82a2e799ea76
-  data.tar.gz: 6a96956ac79c335072e0755388bb86bd40df665454e57781553090011caa90bbf36ba51a79d1a040dd2cb15d6a59f0f11d8a7448e3f4ec405c29c3d18d7a1d6f
+  metadata.gz: 985bd27768d1256eec6b4f1c9dff4da974e6d52e6163da4dd90b9e48416042412dfff300ae1aabec922e45274799204a6bfd3e056f84946caa1650b32189face
+  data.tar.gz: d7ef3483025caa62727ca4eacce1be7300aee79ad1d428c5682985c666150e60c69c3d9d855b93da4b9e16bd5af883a7dbd2bc56d29ce4e11fec3494f248821d

data/README.md

@@ -115,12 +115,51 @@ Note that `each_serializer` and `serializer` is not part of `SkinnyControllers`,
 
 Also note that setting `model_class` may be required if your model is namespaced.
 
-#### parent_class
+#### parent_class and association_name
 
-#### association_name
+If you want to scope the finding of a resource to a parent object, `parent_class` must be set
+
+```ruby
+skinny_controllers_config parent_class: ParentClass,
+                          assaciation_name: :children,
+                          model_class: Child
+```
+
+Given the above configuration in a controller, and a request with the params:
+
+```
+{
+  id: 2,
+  parent_id: 78  
+}
+```
+
+The following query will be made:
+
+```ruby
+Parent.find(78).children.find(2)
+```
 
 #### model_params_key
 
+Date stored another a different key in `params`?
+
+```ruby
+skinny_controllers_config model_class: Child,
+                          model_params_key: :progeny
+```
+
+Given the above configuration in a controller, and a request with the params:
+
+```
+{
+  progeny: {
+    attribute1: 'value'
+  }
+}
+```
+
+The attributes inside the `progeny` sub hash will be used instead of the default, `child`.
 
 ### What if your model is namespaced?
 
@@ -129,8 +168,9 @@ All you have to do is set the `model_class`, and `model_key`.
 ```ruby
 class ItemsController < ApiController # or whatever your superclass is
   include SkinnyControllers::Diet
-  self.model_class = NameSpace::Item
-  self.model_key = 'item'
+
+  skinny_controllers_config model_class: NameSpace::Item
+                            model_params_key: :item
 end
 ```
 `model_key` specifies the key to look for params when creating / updating the model.
@@ -230,7 +270,7 @@ To achieve default functionality, this operation *may* be defined -- though, it
 module UserOperations
   class Create < SkinnyControllers::Operation::Base
     def run
-      @model = model_class.new(model_params)
+      @model = User.new(model_params)
 
       # raising an exception here allows the corresponding resource controller to
       # `rescue_from SkinnyControllers::DeniedByPolicy` and have a uniform error
@@ -294,6 +334,15 @@ end
 
 These are snippets taking from other projects.
 
+### Using ransack
+
+```ruby
+# config/initializers/skinny_controllers.rb
+SkinnyControllers.search_proc = lambda do |relation|
+  relation.ransack(params[:q]).result
+end
+```
+
 ### Finding a record when the id parameter isn't passed
 
 ```ruby
@@ -483,6 +532,7 @@ The following options are available:
 |`controller_namespace`|`''`| Global Namespace for all controllers (e.g.: `'API'`) |
 |`allow_by_default`| `true` | Default permission |
 |`action_map`| see [skinny_controllers.rb](./lib/skinny_controllers.rb#L61)| |
+| `search_proc`| passthrough | can be used to filter results, such as with using ransack |
 
 
 -------------------------------------------------------

data/lib/skinny_controllers/operation/model_helpers.rb

@@ -86,7 +86,7 @@ module SkinnyControllers
         name = name.camelize
         association = model_from_scope(id: id, type: name)
 
-        SkinnyControllers.search_proc.call(association)
+        instance_exec(association, &SkinnyControllers.search_proc)
       end
 
       def model_from_scope(scope = params[:scope])

data/lib/skinny_controllers/version.rb

@@ -1,4 +1,4 @@
 # frozen_string_literal: true
 module SkinnyControllers
-  VERSION = '0.10.0'
+  VERSION = '0.10.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: skinny_controllers
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.10.1
 platform: ruby
 authors:
 - L. Preston Sego III
@@ -238,6 +238,6 @@ rubyforge_project:
 rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: SkinnyControllers-0.10.0
+summary: SkinnyControllers-0.10.1
 test_files: []
 has_rdoc: