ripped_params 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 209b31e316f447e3b662a74a157eb6be3bc099c6
+  data.tar.gz: c20c59300c3a4a7ce036250aa087b4bb491e69c8
+SHA512:
+  metadata.gz: 35901930d96c137303027473457dfe69675f1b6961bbca31f5b885d594f03b378ea8d873476a749b654ed1b2849b6014a5edc6d44c55fad984d30a4182dcee14
+  data.tar.gz: 830666164e681294e1d377ccdf56b19dfb4fe7ca548b549eab3b30554744f405ab20b3bbba0d7215984c7338571fa2b9916700edeeb7c20f322f64976cd02ab7

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ripped_params.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Nemrow
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,78 @@
+# Ripped Params
+
+Organize all of your strong params into separated yaml files and let Ripped Params turn them into methods.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'ripped_params'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ripped_params
+
+## Usage
+
+Once installed use the command `ripped_params:install` to add the ripped_params folder into your lib folder along with an example YAML file
+
+## YAML file explained
+
+```
+---
+  :require: :project
+  :permit:
+  - :name
+  - :service_id
+  - :quote
+  - :document_attributes:
+    - :filepicker_url
+    - :category_id
+  - :start_at_text
+```
+
+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
+
+`params.require(:project)`
+
+The second key in this yaml file `permit` is what is permitted to be included in the required (`project` in this case) key.
+
+The end result of this yaml file would produce this strong param:
+
+```
+params.require(:project).permit(:name, :service_id, :quote, {:document_attributes => [:filepicker_url, :category_id]}, :start_at_text)
+```
+
+## In The Controller
+
+In each controller you want to add a Ripped Param include the following:
+
+`uses_ripped_params :project_params`
+
+This will look for a file somewhere in the ripped_params directory called "project_params.yml"
+
+You can add as many Ripped Params as you need in each controller.
+
+Ex:
+
+`uses_ripped_params :project_params, :project_without_ids_params, :any_other_params`
+
+NOTE:
+
+You can organize your folder however you please. It will find the first file in the ripped_params directory that matches the filename.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/ripped_params/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+## Final Notes
+
+![alt Ripped Guy](http://25.media.tumblr.com/tumblr_kvqpt2p9xd1qzo45to1_400.gif)

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/generators/ripped_params/install/install_generator.rb

@@ -0,0 +1,11 @@
+module RippedParams
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_yaml_templates
+        template "project_params.yml", "lib/ripped_params/project/project_params.yml"
+      end
+    end
+  end
+end

data/lib/generators/ripped_params/install/templates/project_params.yml

@@ -0,0 +1,31 @@
+---
+  :require: :project
+  :permit:
+  - :name
+  - :service_id
+  - :quote
+  - :document_attributes:
+    - :filepicker_url
+    - :category_id
+  - :start_at_text
+  - :estimated_duration
+  - :status
+  - :roles_attributes:
+    - :id
+    - :name
+    - :actor_short
+  - :tasks_attributes:
+    - :id
+    - :name
+    - :description
+    - :public
+    - :assigned_to_role
+    - :reviewer_role
+    - :due_at_offset
+    - :start_at_offset
+    - :tag_list: []
+    - :dynamic_fields_attributes:
+        - :id
+        - :kind
+        - :attribute
+        - :receiver

data/lib/ripped_params/controller_initializer.rb

@@ -0,0 +1,16 @@
+require 'ripped_params/params_builder'
+
+module RippedParams
+  module ControllerInitializer
+    class ActionController::Base
+
+      def self.uses_ripped_params(*names)
+        names.each do |name|
+          define_method name.to_s do
+            ParamsBuilder.new(params, name).build
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ripped_params/params_builder.rb

@@ -0,0 +1,38 @@
+require 'find'
+
+class NoYAMLFileFoundError < Exception; end
+
+module RippedParams
+  class ParamsBuilder
+    def initialize(params, name)
+      @params = params
+      @name = name
+    end
+
+    def build
+      @params.require(params_data[:require]).permit(params_data[:permit])
+    end
+
+    private
+      def params_data
+        @params_data ||= begin
+          raise NoYAMLFileFoundError, "Could not find #{params_yaml_file_name} in #{yaml_files_directory} directory" if !params_yaml_file_path
+          YAML.load_file(params_yaml_file_path)
+        end
+      end
+
+      def params_yaml_file_path
+        @params_yaml_file_path ||= Find.find(yaml_files_directory).find do |file_path|
+          Pathname.new(file_path).basename.to_path == params_yaml_file_name
+        end
+      end
+
+      def yaml_files_directory
+        "#{Rails.root}/lib/ripped_params"
+      end
+
+      def params_yaml_file_name
+        "#{@name}.yml"
+      end
+  end
+end

data/lib/ripped_params/railtie.rb

@@ -0,0 +1,12 @@
+require 'rails'
+require 'ripped_params/controller_initializer'
+
+module RippedParams
+  class Railtie < Rails::Railtie
+    initializer "mega_lotto.action_view" do
+      ActiveSupport.on_load(:action_controller) do
+        include RippedParams::ControllerInitializer
+      end
+    end
+  end
+end

data/lib/ripped_params/version.rb

@@ -0,0 +1,3 @@
+module RippedParams
+  VERSION = "0.0.1"
+end

data/lib/ripped_params.rb

@@ -0,0 +1,5 @@
+require "ripped_params/version"
+require "ripped_params/railtie" if defined?(Rails)
+
+module RippedParams
+end

data/ripped_params.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'ripped_params/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ripped_params"
+  spec.version       = RippedParams::VERSION
+  spec.authors       = ["Nemrow"]
+  spec.email         = ["nemrowj@gmail.com"]
+  spec.summary       = %q{Organize strong params into yaml files}
+  spec.description   = %q{Specify all strong params into separate yaml files and have then turned into controller methods}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: ripped_params
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Nemrow
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Specify all strong params into separate yaml files and have then turned
+  into controller methods
+email:
+- nemrowj@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/generators/ripped_params/install/install_generator.rb
+- lib/generators/ripped_params/install/templates/project_params.yml
+- lib/ripped_params.rb
+- lib/ripped_params/controller_initializer.rb
+- lib/ripped_params/params_builder.rb
+- lib/ripped_params/railtie.rb
+- lib/ripped_params/version.rb
+- ripped_params.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Organize strong params into yaml files
+test_files: []