ripped_params 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +22 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +78 -0
- data/Rakefile +2 -0
- data/lib/generators/ripped_params/install/install_generator.rb +11 -0
- data/lib/generators/ripped_params/install/templates/project_params.yml +31 -0
- data/lib/ripped_params/controller_initializer.rb +16 -0
- data/lib/ripped_params/params_builder.rb +38 -0
- data/lib/ripped_params/railtie.rb +12 -0
- data/lib/ripped_params/version.rb +3 -0
- data/lib/ripped_params.rb +5 -0
- data/ripped_params.gemspec +24 -0
- metadata +100 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 209b31e316f447e3b662a74a157eb6be3bc099c6
|
4
|
+
data.tar.gz: c20c59300c3a4a7ce036250aa087b4bb491e69c8
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 35901930d96c137303027473457dfe69675f1b6961bbca31f5b885d594f03b378ea8d873476a749b654ed1b2849b6014a5edc6d44c55fad984d30a4182dcee14
|
7
|
+
data.tar.gz: 830666164e681294e1d377ccdf56b19dfb4fe7ca548b549eab3b30554744f405ab20b3bbba0d7215984c7338571fa2b9916700edeeb7c20f322f64976cd02ab7
|
data/.gitignore
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
*.gem
|
2
|
+
*.rbc
|
3
|
+
.bundle
|
4
|
+
.config
|
5
|
+
.yardoc
|
6
|
+
Gemfile.lock
|
7
|
+
InstalledFiles
|
8
|
+
_yardoc
|
9
|
+
coverage
|
10
|
+
doc/
|
11
|
+
lib/bundler/man
|
12
|
+
pkg
|
13
|
+
rdoc
|
14
|
+
spec/reports
|
15
|
+
test/tmp
|
16
|
+
test/version_tmp
|
17
|
+
tmp
|
18
|
+
*.bundle
|
19
|
+
*.so
|
20
|
+
*.o
|
21
|
+
*.a
|
22
|
+
mkmf.log
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 Nemrow
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,78 @@
|
|
1
|
+
# Ripped Params
|
2
|
+
|
3
|
+
Organize all of your strong params into separated yaml files and let Ripped Params turn them into methods.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
gem 'ripped_params'
|
10
|
+
|
11
|
+
And then execute:
|
12
|
+
|
13
|
+
$ bundle
|
14
|
+
|
15
|
+
Or install it yourself as:
|
16
|
+
|
17
|
+
$ gem install ripped_params
|
18
|
+
|
19
|
+
## Usage
|
20
|
+
|
21
|
+
Once installed use the command `ripped_params:install` to add the ripped_params folder into your lib folder along with an example YAML file
|
22
|
+
|
23
|
+
## YAML file explained
|
24
|
+
|
25
|
+
```
|
26
|
+
---
|
27
|
+
:require: :project
|
28
|
+
:permit:
|
29
|
+
- :name
|
30
|
+
- :service_id
|
31
|
+
- :quote
|
32
|
+
- :document_attributes:
|
33
|
+
- :filepicker_url
|
34
|
+
- :category_id
|
35
|
+
- :start_at_text
|
36
|
+
```
|
37
|
+
|
38
|
+
The first key in this file `require`, is the key in the params that the strong params are going to require. In this case it would require the `project` key in the params
|
39
|
+
|
40
|
+
`params.require(:project)`
|
41
|
+
|
42
|
+
The second key in this yaml file `permit` is what is permitted to be included in the required (`project` in this case) key.
|
43
|
+
|
44
|
+
The end result of this yaml file would produce this strong param:
|
45
|
+
|
46
|
+
```
|
47
|
+
params.require(:project).permit(:name, :service_id, :quote, {:document_attributes => [:filepicker_url, :category_id]}, :start_at_text)
|
48
|
+
```
|
49
|
+
|
50
|
+
## In The Controller
|
51
|
+
|
52
|
+
In each controller you want to add a Ripped Param include the following:
|
53
|
+
|
54
|
+
`uses_ripped_params :project_params`
|
55
|
+
|
56
|
+
This will look for a file somewhere in the ripped_params directory called "project_params.yml"
|
57
|
+
|
58
|
+
You can add as many Ripped Params as you need in each controller.
|
59
|
+
|
60
|
+
Ex:
|
61
|
+
|
62
|
+
`uses_ripped_params :project_params, :project_without_ids_params, :any_other_params`
|
63
|
+
|
64
|
+
NOTE:
|
65
|
+
|
66
|
+
You can organize your folder however you please. It will find the first file in the ripped_params directory that matches the filename.
|
67
|
+
|
68
|
+
## Contributing
|
69
|
+
|
70
|
+
1. Fork it ( https://github.com/[my-github-username]/ripped_params/fork )
|
71
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
72
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
73
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
74
|
+
5. Create a new Pull Request
|
75
|
+
|
76
|
+
## Final Notes
|
77
|
+
|
78
|
+

|
data/Rakefile
ADDED
@@ -0,0 +1,11 @@
|
|
1
|
+
module RippedParams
|
2
|
+
module Generators
|
3
|
+
class InstallGenerator < Rails::Generators::Base
|
4
|
+
source_root File.expand_path("../templates", __FILE__)
|
5
|
+
|
6
|
+
def create_yaml_templates
|
7
|
+
template "project_params.yml", "lib/ripped_params/project/project_params.yml"
|
8
|
+
end
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
@@ -0,0 +1,31 @@
|
|
1
|
+
---
|
2
|
+
:require: :project
|
3
|
+
:permit:
|
4
|
+
- :name
|
5
|
+
- :service_id
|
6
|
+
- :quote
|
7
|
+
- :document_attributes:
|
8
|
+
- :filepicker_url
|
9
|
+
- :category_id
|
10
|
+
- :start_at_text
|
11
|
+
- :estimated_duration
|
12
|
+
- :status
|
13
|
+
- :roles_attributes:
|
14
|
+
- :id
|
15
|
+
- :name
|
16
|
+
- :actor_short
|
17
|
+
- :tasks_attributes:
|
18
|
+
- :id
|
19
|
+
- :name
|
20
|
+
- :description
|
21
|
+
- :public
|
22
|
+
- :assigned_to_role
|
23
|
+
- :reviewer_role
|
24
|
+
- :due_at_offset
|
25
|
+
- :start_at_offset
|
26
|
+
- :tag_list: []
|
27
|
+
- :dynamic_fields_attributes:
|
28
|
+
- :id
|
29
|
+
- :kind
|
30
|
+
- :attribute
|
31
|
+
- :receiver
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'ripped_params/params_builder'
|
2
|
+
|
3
|
+
module RippedParams
|
4
|
+
module ControllerInitializer
|
5
|
+
class ActionController::Base
|
6
|
+
|
7
|
+
def self.uses_ripped_params(*names)
|
8
|
+
names.each do |name|
|
9
|
+
define_method name.to_s do
|
10
|
+
ParamsBuilder.new(params, name).build
|
11
|
+
end
|
12
|
+
end
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
@@ -0,0 +1,38 @@
|
|
1
|
+
require 'find'
|
2
|
+
|
3
|
+
class NoYAMLFileFoundError < Exception; end
|
4
|
+
|
5
|
+
module RippedParams
|
6
|
+
class ParamsBuilder
|
7
|
+
def initialize(params, name)
|
8
|
+
@params = params
|
9
|
+
@name = name
|
10
|
+
end
|
11
|
+
|
12
|
+
def build
|
13
|
+
@params.require(params_data[:require]).permit(params_data[:permit])
|
14
|
+
end
|
15
|
+
|
16
|
+
private
|
17
|
+
def params_data
|
18
|
+
@params_data ||= begin
|
19
|
+
raise NoYAMLFileFoundError, "Could not find #{params_yaml_file_name} in #{yaml_files_directory} directory" if !params_yaml_file_path
|
20
|
+
YAML.load_file(params_yaml_file_path)
|
21
|
+
end
|
22
|
+
end
|
23
|
+
|
24
|
+
def params_yaml_file_path
|
25
|
+
@params_yaml_file_path ||= Find.find(yaml_files_directory).find do |file_path|
|
26
|
+
Pathname.new(file_path).basename.to_path == params_yaml_file_name
|
27
|
+
end
|
28
|
+
end
|
29
|
+
|
30
|
+
def yaml_files_directory
|
31
|
+
"#{Rails.root}/lib/ripped_params"
|
32
|
+
end
|
33
|
+
|
34
|
+
def params_yaml_file_name
|
35
|
+
"#{@name}.yml"
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
@@ -0,0 +1,12 @@
|
|
1
|
+
require 'rails'
|
2
|
+
require 'ripped_params/controller_initializer'
|
3
|
+
|
4
|
+
module RippedParams
|
5
|
+
class Railtie < Rails::Railtie
|
6
|
+
initializer "mega_lotto.action_view" do
|
7
|
+
ActiveSupport.on_load(:action_controller) do
|
8
|
+
include RippedParams::ControllerInitializer
|
9
|
+
end
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'ripped_params/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "ripped_params"
|
8
|
+
spec.version = RippedParams::VERSION
|
9
|
+
spec.authors = ["Nemrow"]
|
10
|
+
spec.email = ["nemrowj@gmail.com"]
|
11
|
+
spec.summary = %q{Organize strong params into yaml files}
|
12
|
+
spec.description = %q{Specify all strong params into separate yaml files and have then turned into controller methods}
|
13
|
+
spec.homepage = ""
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_development_dependency "bundler", "~> 1.6"
|
22
|
+
spec.add_development_dependency "rake"
|
23
|
+
spec.add_development_dependency "byebug"
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,100 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: ripped_params
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Nemrow
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-10-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: bundler
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ~>
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '1.6'
|
20
|
+
type: :development
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ~>
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '1.6'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rake
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '>='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '>='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: byebug
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - '>='
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - '>='
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '0'
|
55
|
+
description: Specify all strong params into separate yaml files and have then turned
|
56
|
+
into controller methods
|
57
|
+
email:
|
58
|
+
- nemrowj@gmail.com
|
59
|
+
executables: []
|
60
|
+
extensions: []
|
61
|
+
extra_rdoc_files: []
|
62
|
+
files:
|
63
|
+
- .gitignore
|
64
|
+
- Gemfile
|
65
|
+
- LICENSE.txt
|
66
|
+
- README.md
|
67
|
+
- Rakefile
|
68
|
+
- lib/generators/ripped_params/install/install_generator.rb
|
69
|
+
- lib/generators/ripped_params/install/templates/project_params.yml
|
70
|
+
- lib/ripped_params.rb
|
71
|
+
- lib/ripped_params/controller_initializer.rb
|
72
|
+
- lib/ripped_params/params_builder.rb
|
73
|
+
- lib/ripped_params/railtie.rb
|
74
|
+
- lib/ripped_params/version.rb
|
75
|
+
- ripped_params.gemspec
|
76
|
+
homepage: ''
|
77
|
+
licenses:
|
78
|
+
- MIT
|
79
|
+
metadata: {}
|
80
|
+
post_install_message:
|
81
|
+
rdoc_options: []
|
82
|
+
require_paths:
|
83
|
+
- lib
|
84
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - '>='
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: '0'
|
89
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
90
|
+
requirements:
|
91
|
+
- - '>='
|
92
|
+
- !ruby/object:Gem::Version
|
93
|
+
version: '0'
|
94
|
+
requirements: []
|
95
|
+
rubyforge_project:
|
96
|
+
rubygems_version: 2.2.2
|
97
|
+
signing_key:
|
98
|
+
specification_version: 4
|
99
|
+
summary: Organize strong params into yaml files
|
100
|
+
test_files: []
|