skinny_controllers 0.7.2 → 0.7.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba15227b9adedda091b2ab60873770d72841113a
-  data.tar.gz: 0785496d5b14b0b8b6d528206c6e53ea3afac60b
+  metadata.gz: a12f7c66cb3fb07308f8aa6ab246be35b70831e7
+  data.tar.gz: 6e6acbd5421a2da92d57c3db2ac144f2eae343b9
 SHA512:
-  metadata.gz: e18a2022b30e4ce519424d2e4338466baf1dbc96510a99a84b741394ece1d7f999d1b27b666002fb8077f67aa9fc5e16f2118f11448a6a9b392e4a188c0c1b37
-  data.tar.gz: 25a46fa59a9aabddb3f58c535ca02e17845dd01c0af00abecca0414854b8817c77e9a73eb27e36bce6b4e88a6f736137618a3cc9ba46a35b0288a55606597e0d
+  metadata.gz: cbd2f49c04417e59e35c426c537da234608b93ce4c58fa7609c6b1b786f9bf734d710eaacf7120207640325b9d3d61f66596cb1f4787760bb9c962a746b0df5d
+  data.tar.gz: 9ca0a73f862a34887ecd528efb4cf62ba6b5615e26a374b8462c9681003ca6b99018df0129367c185063cbe50c43f67869f102d0458de2294d563ad6df3da932

data/README.md

@@ -9,9 +9,7 @@ An implementation of role-based policies and operations to help controllers lose
 
 The goal of this project is to help API apps be more slim, and separate logic as much as possible.
 
-This gem is inspired by [trailblazer](https://github.com/apotonick/trailblazer), following similar patterns, yet allowing the structure of the rails app to not be entirely overhauled.
-
-Please note that this is a work in progress, and that the defaults are subject to change. If you have an idea or suggestion for improved defaults, please submit an issue or pull request. :-)
+If you have an idea or suggestion for improved defaults, please submit an issue or pull request. :-)
 
 # Installation
 
@@ -110,6 +108,16 @@ def host_params
 end
 ```
 
+The parameters for directly calling an operation are as follows:
+
+| # | Parameter | Default when directly calling an operation | Implicit default via `model` | Purpose |
+|---|-------------------|--------------------------------------------|------------------------------|------------------------------------------|
+| 0 | current_user | n/a | `current_user` | the user performing the action |
+| 1 | controller_params | n/a | `params` | the full params hash from the controller |
+| 2 | params_for_action | `controller_params` | `create_params`, `index_params`, etc |  e.g.: requiring a foreign key when looking up index |
+| 3 | action | `controller_params[:action]` | `action_name` | the name of the current action |
+| 4 | model_key | `nil` | underscored model class name | the underscored model class name |
+
 ### For JSON-API
 
 Strong parameters must be used on create/update actions.
@@ -255,7 +263,18 @@ The following options are available:
 |`accessible_to_scope`| `accessible_to`| scope / class method on an object that the user might be able to access |
 |`action_map`| see [skinny_controllers.rb](./lib/skinny_controllers.rb#L61)| |
 
-## TODO
 
- - Configurable Error Renderer
-   - Default to JSON API format errors?
+-------------------------------------------------------
+
+## How is this different from trailblazer?
+
+This may not be horribly apparent, but here is a table overviewing some highlevel differences
+
+| Feature | - | skinny_controllers | [trailblazer](https://github.com/apotonick/trailblazer) |
+|--|--|--|--|
+| Purpose |-| API - works very well with [ActiveModel::Serializers](https://github.com/rails-api/active_model_serializers)| General - additional featers for server-side rendered views |
+| Added Layers |-| Operations, Policies | Operations, Policies, Forms |
+| Validation |-| stay in models | moved to operations via contract block |
+| Additional objects| -| none | contacts, representers, callbacks, cells |
+| Rendering | -| done in the controller, and up to the dev to decide how that is done. `ActiveModel::Serializers` with JSON-API is highly recommended | representers provide a way to define serializers for json, xml, json-api, etc |
+| App Structure | - | same as rails. `app/operations` and `app/policies` are added | encourages a new structure 'concepts', where cells, view templates, assets, operations, etc are all under `concepts/{model-name}` |

data/lib/skinny_controllers/diet.rb

@@ -3,8 +3,10 @@ module SkinnyControllers
     extend ActiveSupport::Concern
 
     included do
-      cattr_accessor :model_class
-      cattr_accessor :model_key
+      class << self
+        attr_accessor :model_class
+        attr_accessor :model_key
+      end
     end
 
     # TODO: what if we want multiple operations per action?
@@ -14,7 +16,7 @@ module SkinnyControllers
       @operation ||= operation_class.new(
         current_user,
         params, params_for_action,
-        action_name, model_key)
+        action_name, self.class.model_key)
     end
 
     # Assumes the operation name from the controller name
@@ -22,7 +24,7 @@ module SkinnyControllers
     # @example SomeObjectsController => Operation::SomeObject::Action
     # @return [Class] the operation class for the model and verb
     def operation_class
-      Lookup::Operation.from_controller(self.class.name, verb_for_action, model_class)
+      Lookup::Operation.from_controller(self.class.name, verb_for_action, self.class.model_class)
     end
 
     # abstraction for `operation.run`
@@ -49,12 +51,15 @@ module SkinnyControllers
     def params_for_action
       return {} if action_name == 'destroy'
 
+      key = self.class.model_key
+      # model_class should be a class
+      klass = self.class.model_class
+
       model_key =
-        if self.model_key.present?
-          self.model_key
-        elsif model_class
-          # model_class should be a class
-          model_class.name.underscore
+        if key.present?
+          key
+        elsif klass
+          klass.name.underscore
         else
           Lookup::Controller.model_name(self.class.name).underscore
         end

data/lib/skinny_controllers/lookup/operation.rb

@@ -43,8 +43,6 @@ module SkinnyControllers
         namespace || Namespace.create_namespace(desired_namespace)
       end
 
-
-
       # @example 'Object' => 'ObjectOperations'
       # @return [String] the operation namespace based on the model name
       def namespace_from_model(model_name)

data/lib/skinny_controllers/lookup/policy.rb

@@ -20,11 +20,11 @@ module SkinnyControllers
         default_policy = SkinnyControllers::Policy::Default
         namespace_klass = Object
         # if we are namespaced, we need to get / create the namespace if it doesn't exist already
-        if (name.include?('::'))
+        if name.include?('::')
           namespaces = name.split('::')
           namespace = namespaces[0..-2].join('::').presence
           namespace = namespace == name ? 'Object' : namespace
-          if (namespace.presence && namespace != name )
+          if namespace.presence && namespace != name
             namespace_klass = Namespace.create_namespace(namespace)
           end
         end

data/lib/skinny_controllers/version.rb

@@ -1,3 +1,3 @@
 module SkinnyControllers
-  VERSION = '0.7.2'
+  VERSION = '0.7.3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: skinny_controllers
 version: !ruby/object:Gem::Version
-  version: 0.7.2
+  version: 0.7.3
 platform: ruby
 authors:
 - L. Preston Sego III
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-01 00:00:00.000000000 Z
+date: 2016-02-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -222,8 +222,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
-summary: SkinnyControllers-0.7.2
+summary: SkinnyControllers-0.7.3
 test_files: []