active_params 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fe7115f8e738b09dca4fa6b8db9579d78ad047c0
-  data.tar.gz: 531896b41459dd0ec27bfb8643c7a2e183fb508d
+  metadata.gz: 47ecec5d8833f17831a4d8ca416714fc356cd4b8
+  data.tar.gz: 8b0641f760e01cf63a9c7d2c35e16f1039451276
 SHA512:
-  metadata.gz: 218017f0012a0a7787e05f63d5fe8bf07d61f70029de377142b2607e11aa8eaab239957a2899985cc59ff20ff4c466c1ec09496ed73606dc81dcad7a26ba987d
-  data.tar.gz: f05f615aa69f9be8c7747ac355a759cf776ba665f93a8c359bc20659b7c4c44754bffaf0f5d296e19d7e4a5204a4562889e46b24e2845f6bbb810d150c60e85c
+  metadata.gz: 92a4f7043edb9dae18ac1d9ab9d6f94a902c7e6339364318ee2d0792c9afbeb4744cbfc1f35967d19e8416c25bc81733d125a50444a827010524a3aeb1296940
+  data.tar.gz: 5de694ee1858bac35b7c2548748d2946cd7f3989d2c0589f914fb3e7b4c1727d3930696f2a3aba4a1752e332e2d20cfa74e5350756f0a17c0dcece141e94e5f3

data/README.md

@@ -2,9 +2,9 @@
 
 Stop manually defining `strong_parameters` in each and every controller.
 
-Automatically record the necessary `strong_parameters` settings when you use your app during development mode.
+Whatever parameters that was used during `development` mode is considered permitted parameters for `production`. So automatically record them in `development` mode and simply apply `strong_parameters` in production.
 
-The `strong_parameters` will automatically apply.
+aka No more [strong parameters falls!](https://twitter.com/JuanitoFatas/status/746228574592499712) 👌
 
 ## Installation
 
@@ -32,6 +32,65 @@ class ApplicationController < ActionController::Base
 end
 ```
 
+### Rails.env.development?
+
+During `development` mode, `active_params` will generate the appropriate strong parameters settings for each param (scoped to the current http method, controller_name and action_name)
+
+For example, when you submit a form like this
+
+```
+Started POST "/users" for 127.0.0.1 at 2016-06-26 00:41:19 +0800
+Processing by UsersController#create as HTML
+  Parameters: {"utf8"=>"✓", "authenticity_token"=>"...", "user"=>{"name"=>"John", "avatar"=>"Face.png", "photos"=>["Breakfast.png", "Coffee.png"]}, "button"=>""}
+```
+
+`active_params` will create or update the `config/active_params.json` file with the settings
+
+``` json
+{
+  "POST users/create": {
+    "user": [
+      "avatar",
+      "name",
+      {
+        "photos": [
+
+        ]
+      }
+    ]
+  }
+}
+```
+
+NOTE: see [the test](https://github.com/choonkeat/active_params/blob/a84e0ab41ee7a522c6c38ee1657cfb68bc4850e9/test/active_params_test.rb#L23-L57) for a more complicated example
+
+### Rails.env.production? (and other modes)
+
+In non-development mode, `active_params` will NOT update the `config/active_params.json` file.
+
+It loads `config/active_params.json` and automatically perform the correct strong parameters setup for each request
+
+``` ruby
+params[:user] = params.require(:user).permit(:avatar, :name, photos: [])
+```
+
+So, in your controllers, you can simply reference `params[:user]` again!
+
+``` ruby
+def create
+  @user = User.new(params[:user])
+  if @user.save
+    redirect_to @user, notice: 'User was successfully created.'
+  else
+    render :new
+  end
+end
+```
+
+### Workflow
+
+When you create new features for your app & try them out in development mode, `config/active_params.json` will be automatically updated. When you commit your code, include the changes to `config/active_params.json` too.
+
 ## LICENSE
 
 MIT

data/lib/active_params/version.rb

@@ -1,3 +1,3 @@
 module ActiveParams
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/active_params.rb

@@ -9,7 +9,7 @@ module ActiveParams
         current_config[k] = result
       end
     end
-    open(ActiveParams.path, "wb") {|f| f.write(JSON.pretty_generate(global_config).tap {|s| logger.info s }) }
+    open(ActiveParams.path, "wb") {|f| f.write(JSON.pretty_generate(global_config)) }
     yield
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: active_params
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - choonkeat
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-06-25 00:00:00.000000000 Z
+date: 2016-06-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler