better_strong_params 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b59e698c9700c6b59debe8f0e6df3cb86b7accb8
-  data.tar.gz: 76aa30622e52567aa1e075f140771206ed01e721
+  metadata.gz: a5ce1ef091a974afc806772bf96add9d8210f9d8
+  data.tar.gz: 8003573183b9926cbd33d881120164b9aeab434d
 SHA512:
-  metadata.gz: e4a97bf01255499ac381c5714c38403b6c475c7b32625ecc7c3da44f1c31eef07238889e9b69bbf75703bae52ebc77844abe2342d23ef6633c719f692f02b824
-  data.tar.gz: 84c12902fc815691f06e8c671b4647eab618f32cc3dd11035401159c22761cd4df769c26790de0b0748c25f1e3d9e8b5f5e8fabdb48f4f35de19aa656a6a5875
+  metadata.gz: 68334d57da58ecad3a54963f8d4e136d50874f1011f62da38820c701211c4120481105c47244c6cbf285000834ae676e4e94f1a7d934f5bf0bdb20e8f0517090
+  data.tar.gz: 65c0b974a50e9374833181ae8f81b909f87dd5774ea422dd2e99a40c361a36db884207370f283f4dadad71ef8246dea198f038abfbd75e9033c8b421549051f7

data/README.md

@@ -2,6 +2,11 @@
 
 Adds a DSL to ActionController that allows to add strong params filtering without adding a specific, dirty controller method.
 
+# DSL Changes in 0.0.3
+
+- `whitelist_parameters` replaces `filter_parameters`
+- No more `create_params` or such, filtered and whitelisted attributes are now available via the regular `params` hash.
+
 ## Why?
 
 [Rails's Strong Parameters](http://edgeapi.rubyonrails.org/classes/ActionController/StrongParameters.html) is obviously a better approach than having the model decide which attributes are protected or not. The only problem I have with this is the need to add an ugly method (at least one) to the controller to filter and whitelist the parameters.
@@ -28,31 +33,31 @@ BetterStrongParams is automatically included in ActionController::Base, so you d
 
 ## Usage
 
-BetterStrongParams allows you to use the `filter_parameters` method in your controllers:
+BetterStrongParams allows you to use the `whitelist_parameters` method in your controllers:
 
 ```ruby
   class UsersController < ApplicationController
-    filter_parameters create: {post: [:title, :body]}, ...
+    whitelist_parameters post: [:title, :body], user: [:name, :age], ....
   end
 ```
 
-`filter_parameters` accepts an option hash specifing a method name, a _required_ parameter and a permitted parameters list like this
+`whitelist_parameters` a representation of a hash as you would enter in normal Strong Parameters method:
 
 ```
-  controller_action_name: {required_param_name: [permitted1, permitted2,...]}, controller_action_name2: ....
+  top_level_key: [attribute, attribute], another_top_level: [...], ...
 ```
 
-for every controller action you set using `filter_parameters`, a method named `#{controller_action}_params` will be created and will be ready to use when you want it.
+Unlike many other Strong Parameters implementations in which you would have to define a sanitizing method (`user_params`), BetterStrongParams lets you keep on using the regular `params` hash
 
 
-### Full example
+## Full example
 ```ruby
   class UsersController < ApplicationController
 
-    filter_parameters create: {user: [:name, :age]}
+    whitelist_parameters user: [:name, :age]
 
     def create
-      @user = User.new(create_params) # => create_params is available via BetterStrongParams and the filter_parameters DSL.
+      @user = User.new(params[:user]) # => params[:user] is being whitelisted without the need to define / create the extra method.
       if @user.save
         redirect_to treasure_url
       else
@@ -62,36 +67,6 @@ for every controller action you set using `filter_parameters`, a method named `#
   end
 ```
 
-or if you want a single whitelist params set for all of the controller methods, BetterStrongParams will automatically generate one method named after your controller's singular resource
-
-```ruby
-  class UsersController < ApplicationController
-
-    filter_parameters all: {user: [:name, :age]}
-
-    def create
-
-      # If you specify the 'all' option, user_params will be available.
-      @user = User.new(user_params)
-      if @user.save
-        redirect_to treasure_url
-      else
-        redirect_to jail_url
-      end
-    end
-
-    def update
-      @user = User.find(params[:id])
-      if @user.update_attributes(user_params)
-        redirect_to treasure_url
-      else
-        redirect_to jail_url
-      end
-    end
-
-  end
-```
-
 
 ## Contributing
 

data/better_strong_params.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["elad@eizesus.com"]
   spec.summary       = "Adds a DSL to ActionController that allows to add strong params filtering without adding a specific, dirty controller method."
   spec.description   = ""
-  spec.homepage      = ""
+  spec.homepage      = "https://github.com/ShinobiDevs/better_strong_params/"
   spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)

data/lib/better_strong_params.rb

@@ -8,22 +8,31 @@ module BetterStrongParams
     end
   end
 
+  module Exceptions
+    class Deprecated < RuntimeError; end
+  end
+
   module ClassMethods
+
     def filter_parameters(options = {})
-      params_method_name = options[:as] || self.name.demodulize.gsub(/Controller$/,'').singularize.downcase
-      action_names = options.keys
-      if action_names.first.to_sym == :all
-        define_method("#{params_method_name}_params") do
-          base = options[:all].keys.first
-          params.require(base).permit(*options[:all][base])
+      raise(BetterStrongParams::Exceptions::Deprecated, "filter_parameters was deprecated in version 0.0.3, please refer to https://github.com/ShinobiDevs/better_strong_params for more information on the new DSL.")
+    end
+
+    def whitelist_parameters(options = {})
+
+      alias_method :_params, :params
+
+      define_method("params") do
+        filtered = {}
+        top_level_params = options.keys
+        top_level_params.each do |top_level_param|
+          filtered[top_level_param] = _params.require(top_level_param).permit(*options[top_level_param])
         end
-      else
-        action_names.each do |action_name|
-          define_method("#{action_name.to_s}_params") do
-            base = options[action_name].keys.first
-            params.require(base).permit(*options[action_name][base])
-          end
+
+        (_params.keys.map(&:to_s) - options.keys.map(&:to_s)).each do |root_level_param|
+          filtered[root_level_param] = _params[root_level_param]
         end
+        ActionController::Parameters.new(filtered).permit!
       end
     end
   end

data/lib/better_strong_params/version.rb

@@ -1,3 +1,3 @@
 module BetterStrongParams
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: better_strong_params
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Elad Meidar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-27 00:00:00.000000000 Z
+date: 2014-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,7 +87,7 @@ files:
 - spec/fixtures/models/user.rb
 - spec/lib/better_strong_params_spec.rb
 - spec/spec_helper.rb
-homepage: ''
+homepage: https://github.com/ShinobiDevs/better_strong_params/
 licenses:
 - MIT
 metadata: {}