whitelist 0.0.1

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Ben Alavi
+
+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.markdown

@@ -0,0 +1,72 @@
+Whitelist
+=======
+
+Easy to use filter for parameter hashes.
+
+Description
+-----------
+
+Whitelist helps you filter a parameters hash to get only the values you
+care about.
+
+It's a very common pattern to forbid access to key attributes in models.
+One obvious example is ActiveRecord's use of the attr_accessible
+decorator.
+
+The problem with ActiveRecord's approach is that it assumes you want the
+same restrictions to apply for every context, which is not always the
+case. A common scenario is to have different access levels for different
+kinds of users, or higher restrictions for user generated data and a
+lower barrier for developer generated data.
+
+Whitelist approaches this problem by providing a simple mechanism for
+filtering hashes, with some fair assumptions to abstract recurring
+patterns.
+
+Usage
+-----
+
+    params[:foo] = nil
+
+    # Returns an empty hash if the value provided is nil.
+    whitelist(params[:foo])           #=> {}
+
+    params[:foo] = { :bar => 1, :baz => 2 }
+
+    # Returns a copy of params[:hash] with the keys provided.
+    whitelist(params[:foo], :bar)     #=> { :bar => 1 }
+
+    # It also accepts a symbol as the first parameter, and interprets it as a key for params.
+    whitelist(:foo, :bar)             #=> { :bar => 1 }
+    whitelist(:foo)                   #=> {}
+
+Installation
+------------
+
+    $ sudo gem install whitelist
+
+License
+-------
+
+Copyright (c) 2009 Ben Alavi
+
+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/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end

data/lib/whitelist.rb

@@ -0,0 +1,35 @@
+module Whitelist
+
+  # Whitelist a hash by filtering the provided keys.
+  #
+  # @overload whitelist hash, :foo, :bar, :baz
+  #   Returns a copy of hash with the keys provided.
+  # @overload whitelist :hash, :foo, :bar, :baz
+  #   Returns a copy of params[:hash] with the keys provided.
+  # @example Different ways of using whitelist:
+  #     params[:foo] = nil
+
+  #     # Returns an empty hash if the value provided is nil.
+  #     whitelist(params[:foo])           #=> {}
+
+  #     params[:foo] = { :bar => 1, :baz => 2 }
+
+  #     # Returns a copy of params[:hash] with the keys provided.
+  #     whitelist(params[:foo], :bar)     #=> { :bar => 1 }
+
+  #     # It also accepts a symbol as the first parameter, and interprets it as a key for params.
+  #     whitelist(:foo, :bar)             #=> { :bar => 1 }
+  #     whitelist(:foo)                   #=> {}
+  def whitelist(hash, *keys)
+    return {} if hash.nil?
+    return {} if keys.empty?
+    return whitelist(params[hash], *keys) if hash.is_a?(Symbol)
+
+    result = Hash.new
+    keys.each do |key|
+      next unless hash.member?(key)
+      result[key] = hash[key]
+    end
+    result
+  end
+end

data/test/all_test.rb

@@ -0,0 +1,37 @@
+require 'rubygems'
+require 'contest'
+require File.dirname(__FILE__) + "/../lib/whitelist"
+
+def params
+  { :a => 1, :b => 2, :c => { :d => 3 } }
+end
+
+include Whitelist
+
+class TestWhitelist < Test::Unit::TestCase
+  setup do
+    @hash = { :a => 1, :b => 2, :c => { :d => 3 } }
+  end
+
+  context "without a whitelist " do
+    should "return an empty hash" do
+      assert_equal Hash.new, whitelist(@hash)
+    end
+  end
+
+  context "with a nil value as the first parameter" do
+    should "also return an empty hash" do
+      assert_equal Hash.new, whitelist(nil)
+    end
+  end
+
+  context "with a symbol as the first parameter" do
+    should "pull the hash from the params method" do
+      assert_equal @hash[:c], whitelist(:c, :d)
+    end
+
+    should "return an empty hash if the key is not found" do
+      assert_equal Hash.new, whitelist(:c, :f)
+    end
+  end
+end

data/whitelist.gemspec

@@ -0,0 +1,11 @@
+Gem::Specification.new do |s|
+  s.name = 'whitelist'
+  s.version = '0.0.1'
+  s.summary = %{Easy to use filter for parameter hashes}
+  s.description = %{Whitelist helps you filter a parameters hash to get only the values you care about.}
+  s.authors = ["Ben Alavi"]
+  s.email = ["ben.alavi@citrusbyte.com"]
+  s.homepage = "http://github.com/citrusbyte/whitelist"
+  s.files = ["lib/whitelist.rb", "README.markdown", "LICENSE", "Rakefile", "test/all_test.rb", "whitelist.gemspec"]
+  s.rubyforge_project = "whitelist"
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification 
+name: whitelist
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Ben Alavi
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-07-30 00:00:00 -03:00
+default_executable: 
+dependencies: []
+
+description: Whitelist helps you filter a parameters hash to get only the values you care about.
+email: 
+- ben.alavi@citrusbyte.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/whitelist.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- test/all_test.rb
+- whitelist.gemspec
+has_rdoc: true
+homepage: http://github.com/citrusbyte/whitelist
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: whitelist
+rubygems_version: 1.3.4
+signing_key: 
+specification_version: 3
+summary: Easy to use filter for parameter hashes
+test_files: []
+