stark_parameters 0.0.1

data/.bundle/install.log

@@ -0,0 +1,29 @@
+# Logfile created on 2014-03-11 14:48:55 +0100 by logger.rb/31641
+I, [2014-03-11T14:48:55.511655 #30778]  INFO -- : 0:  rake (10.1.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rake-10.1.1.gemspec
+I, [2014-03-11T14:48:55.512455 #30778]  INFO -- : 0:  i18n (0.6.9) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/i18n-0.6.9.gemspec
+I, [2014-03-11T14:48:55.513137 #30778]  INFO -- : 0:  multi_json (1.9.0) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/multi_json-1.9.0.gemspec
+I, [2014-03-11T14:48:57.734092 #30778]  INFO -- : 0:  activesupport (3.2.17) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/activesupport-3.2.17.gemspec
+I, [2014-03-11T14:48:57.734649 #30778]  INFO -- : 0:  builder (3.0.4) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/builder-3.0.4.gemspec
+I, [2014-03-11T14:48:59.627458 #30778]  INFO -- : 0:  activemodel (3.2.17) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/activemodel-3.2.17.gemspec
+I, [2014-03-11T14:48:59.628237 #30778]  INFO -- : 0:  erubis (2.7.0) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/erubis-2.7.0.gemspec
+I, [2014-03-11T14:48:59.628729 #30778]  INFO -- : 0:  journey (1.0.4) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/journey-1.0.4.gemspec
+I, [2014-03-11T14:48:59.629323 #30778]  INFO -- : 0:  rack (1.4.5) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rack-1.4.5.gemspec
+I, [2014-03-11T14:48:59.630046 #30778]  INFO -- : 0:  rack-cache (1.2) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rack-cache-1.2.gemspec
+I, [2014-03-11T14:48:59.630637 #30778]  INFO -- : 0:  rack-test (0.6.2) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rack-test-0.6.2.gemspec
+I, [2014-03-11T14:48:59.631292 #30778]  INFO -- : 0:  hike (1.2.3) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/hike-1.2.3.gemspec
+I, [2014-03-11T14:48:59.631972 #30778]  INFO -- : 0:  tilt (1.4.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/tilt-1.4.1.gemspec
+I, [2014-03-11T14:48:59.632640 #30778]  INFO -- : 0:  sprockets (2.2.2) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/sprockets-2.2.2.gemspec
+I, [2014-03-11T14:49:01.473503 #30778]  INFO -- : 0:  actionpack (3.2.17) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/actionpack-3.2.17.gemspec
+I, [2014-03-11T14:49:01.474060 #30778]  INFO -- : 0:  diff-lcs (1.2.5) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/diff-lcs-1.2.5.gemspec
+I, [2014-03-11T14:49:01.474420 #30778]  INFO -- : 0:  json (1.8.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/json-1.8.1.gemspec
+I, [2014-03-11T14:49:01.474753 #30778]  INFO -- : 0:  rack-ssl (1.3.3) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rack-ssl-1.3.3.gemspec
+I, [2014-03-11T14:49:01.475088 #30778]  INFO -- : 0:  rdoc (3.12.2) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rdoc-3.12.2.gemspec
+I, [2014-03-11T14:49:01.475418 #30778]  INFO -- : 0:  thor (0.18.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/thor-0.18.1.gemspec
+I, [2014-03-11T14:49:03.970720 #30778]  INFO -- : 0:  railties (3.2.17) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/railties-3.2.17.gemspec
+I, [2014-03-11T14:49:05.795065 #30778]  INFO -- : 0:  rspec-core (2.14.8) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rspec-core-2.14.8.gemspec
+I, [2014-03-11T14:49:05.795698 #30778]  INFO -- : 0:  rspec-expectations (2.14.5) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rspec-expectations-2.14.5.gemspec
+I, [2014-03-11T14:49:05.796160 #30778]  INFO -- : 0:  rspec-mocks (2.14.6) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rspec-mocks-2.14.6.gemspec
+I, [2014-03-11T14:49:05.796544 #30778]  INFO -- : 0:  rspec (2.14.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/rspec-2.14.1.gemspec
+I, [2014-03-11T14:49:05.796917 #30778]  INFO -- : 0:  strong_parameters (0.2.3) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/strong_parameters-0.2.3.gemspec
+I, [2014-03-11T14:49:05.813289 #30778]  INFO -- : 0:  stark parameters (0.0.1) from /Users/ryanlevick/Sites/personal/stark-parameters/stark_parameters.gemspec
+I, [2014-03-11T14:49:05.813731 #30778]  INFO -- : 0:  bundler (1.5.1) from /Users/ryanlevick/.rbenv/versions/1.9.3-p385/lib/ruby/gems/1.9.1/specifications/bundler-1.5.1.gemspec

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ryan Levick
+
+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,48 @@
+# StarkParameters
+
+## Usage
+
+Include `StarkParameters` in any class with which you want to be able to validate params.
+
+You can require, permit and alias params.
+
+StarkParameters uses [Strong Parameters](https://github.com/rails/strong_parameters)
+under the hood so missing require params also raise an `ActionController::ParameterMissing` error.
+Also nested permits work just as they do in Strong Parameters
+
+## Example
+
+```ruby
+# Rails Controller
+
+class UsersContoller < ApplicationController
+  def index
+    @users = User.find_by(UserIndexParams.new(params).params)
+  end
+
+  def create
+    @user = User.create!(UserCreateParams.new(params).params)
+  end
+end
+
+class UserIndexParams
+  include StarkParameters
+
+  require :email, as: :email_id
+end
+
+class UserCreateParams
+  include StarkParameters
+
+  require :email, as: :email_id
+  permit  :name, as: name_id
+  require  [:facebook_id, :google_id]
+end
+```
+
+In the index action an email would be required but would be passed to `find_by`
+as `email_id`.
+
+In the create action an `email` would be required but passed in as `email_id`,
+name would be permitted and passed as `name_id` if present, and either a
+`facebook_id` or a `google_id` would be required.

data/Rakefile

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

data/lib/stark_parameters/version.rb

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

data/lib/stark_parameters.rb

@@ -0,0 +1,73 @@
+module StarkParameters
+
+  def self.included(klass)
+    klass.send :extend, ClassMethods
+    klass.required_params = []
+    klass.permitted_params = []
+    klass.aliases = {}
+  end
+
+  def initialize(params)
+    @params = make_strong_parameter(params)
+  end
+
+  def params
+    make_strong_parameter(permitted_params.merge(required_params))
+  end
+
+  private
+
+  def permitted_params
+    self.class.permitted_params.each_with_object({}) do |permitted_param, hash|
+      param_key = permitted_param.is_a?(Hash) ? permitted_param.keys.first : permitted_param
+      permitted_value = @params.permit(permitted_param).values.first
+      hash[(self.class.aliases[param_key] || param_key).to_s] = permitted_value if permitted_value
+    end
+  end
+
+  def required_params
+    self.class.required_params.each_with_object({}) do |required_params, hash|
+      param_key = require_one(required_params)
+      hash[(self.class.aliases[param_key] || param_key).to_s] = @params[param_key]
+    end
+  end
+
+
+  def make_strong_parameter(hash)
+    return hash if hash.is_a? ActionController::Parameters
+    ActionController::Parameters.new(hash)
+  end
+
+  def require_one(to_require)
+    present_param = to_require.detect {|p| @params.include?(p) }
+    unless present_param
+      raise ActionController::ParameterMissing.new(to_require.join(" or "))
+    end
+    present_param
+  end
+
+  module ClassMethods
+    attr_accessor :required_params, :permitted_params, :aliases
+
+    def require(required_params, options = {})
+      required_params = Array(required_params)
+      if new_name = options[:as]
+        required_params.each { |rp| @aliases[rp] = new_name }
+      end
+      @required_params.push required_params
+    end
+
+    def permit(permitted_param, options = {})
+      if new_name = options[:as]
+        param_key = if permitted_param.is_a? Hash
+          permitted_param.keys.first
+        else
+          permitted_param
+        end
+
+        @aliases[param_key] = new_name
+      end
+      @permitted_params.push permitted_param
+    end
+  end
+end

data/spec/lib/stark_parameters_spec.rb

@@ -0,0 +1,52 @@
+require "spec_helper"
+
+describe StarkParameters do
+  let(:test_klass) do
+    Class.new do
+      include StarkParameters
+
+      require :name
+      require :id
+      require :email, as: :login
+      permit  author: [:id, :name]
+      permit  :password, as: :pword
+      require [:last_name, :surname]
+    end
+  end
+
+  let(:full_params) do
+    {
+      "id" => 1,
+      "name" => "Ryan",
+      "email" => "ryan@6wunderkinder.com",
+      "password" => "fdsafdsa",
+      "surname" => "Levick",
+      "author" => { "id" => 1, "name" => "Steve" }
+    }
+  end
+
+  let(:validator) { test_klass.new(params) }
+
+  context "when all params are there" do
+    let(:params) { full_params }
+
+    it { expect(validator.params.to_hash).to include("name" => "Ryan") }
+    it { expect(validator.params.to_hash).to include("surname" => "Levick") }
+    it { expect(validator.params.to_hash).to include("author" => { "id" => 1, "name" => "Steve" }) }
+    it { expect(validator.params.to_hash).to include("login" => "ryan@6wunderkinder.com") }
+    it { expect(validator.params.to_hash.keys).to_not include("email") }
+  end
+
+  context "when required param is missing" do
+    let(:params) { full_params.except("name")  }
+
+    it { expect{ validator.params }.to raise_error(ActionController::ParameterMissing) }
+  end
+
+  context "when permitted param is missing" do
+    let(:params) { full_params.except("author")  }
+
+    it { expect{ validator.params }.to_not raise_error }
+    it { expect(validator.params.to_hash.keys).to_not include("author") }
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "stark_parameters"
+require "strong_parameters"

data/stark_parameters.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'stark_parameters/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "stark_parameters"
+  gem.version       = StarkParameters::VERSION
+  gem.authors       = ["rylev"]
+  gem.email         = ["ryan.levick@gmail.com"]
+  gem.description   = %q{Making Strong Parameters Stark}
+  gem.summary       = %q{Wraps Strong Parameters with additonal functionality}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'strong_parameters'
+
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+end

metadata

@@ -0,0 +1,106 @@
+--- !ruby/object:Gem::Specification
+name: stark_parameters
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- rylev
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-12 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: strong_parameters
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Making Strong Parameters Stark
+email:
+- ryan.levick@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .bundle/install.log
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/stark_parameters.rb
+- lib/stark_parameters/version.rb
+- spec/lib/stark_parameters_spec.rb
+- spec/spec_helper.rb
+- stark_parameters.gemspec
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Wraps Strong Parameters with additonal functionality
+test_files:
+- spec/lib/stark_parameters_spec.rb
+- spec/spec_helper.rb