allowable 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dd4c802b74f2cef0f4e342689bbe18bdb5f9d6db
+  data.tar.gz: f034111133e060edbc1e95c809d565ab22f7d3b1
+SHA512:
+  metadata.gz: 7322dafe2fe77333cd801c086d8acd54eefafcea9b81d9befa7795eeebd55b908ac7ac0b9bb96fda1057d44778c3df344b1a5e4b5392975fdb5b38730939be13
+  data.tar.gz: 6eb308d093112989a07acd046753350146c987df73bfc92622d2e777c0b4cb51b5f18878e1b63e2405d0d05d8686a4b11e2fe73990c0375696c8f88f9beaddb0

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 M. Simon Borg
+
+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,109 @@
+# Allowable
+[![Gem Version](https://badge.fury.io/rb/allowable.svg)](https://badge.fury.io/rb/allowable)
+[![Code Climate](https://codeclimate.com/github/msimonborg/allowable/badges/gpa.svg)](https://codeclimate.com/github/msimonborg/allowable)
+[![Build Status](https://travis-ci.org/msimonborg/allowable.svg?branch=master)](https://travis-ci.org/msimonborg/allowable)
+[![Coverage Status](https://coveralls.io/repos/github/msimonborg/allowable/badge.svg?branch=master)](https://coveralls.io/github/msimonborg/allowable?branch=master)
+
+Filter hashes by setting  allowed or forbidden values for specific keys.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'allowable'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install allowable
+
+## Usage
+The gem will add four methods to `Hash`: `#allow`, `#allow!`, `#forbid`, and `#forbid!`
+
+```ruby
+hash = { one: 'one', two: 'two' }
+
+hash.forbid(one: 'one') # => { two: 'two' }
+
+hash.allow(one: 'two') # => { two: 'two' }
+
+hash.allow(one: ['one', 'two']) # => { one: 'one', two: 'two' }
+
+hash.forbid(one: ['one', 'two']) # => { two: 'two' }
+
+hash.allow!(one: 'two') # => { two: 'two' }
+
+hash.forbid!(two: 'two') # => {}
+
+hash # => {}
+```
+
+#### Type sensitive for `Hash`
+
+```ruby
+hash = { 'one' => 'one', 'two' => 'two' }
+
+hash.forbid(one: 'one') # => { "one" => "one", "two" => "two" }
+
+hash.forbid('one' => 'one') # => { "two" => "two" }
+```
+
+## With Rails and strong parameters
+
+When added to the `Gemfile` in a Rails project, `ActionController::Parameters` will automatically receive these methods so you can use them with your `strong_parameters`:
+
+```ruby
+def user_params
+  params.require(:user).permit(:email, :password, :role).forbid(role: ['sys_admin', 'owner'])
+end
+```
+
+#### Type insensitive for `HashWithIndifferentAccess`
+```ruby
+params = ActionController::Parameters.new('one' => 'one', 'two' => 'two').permit(:one, :two)
+
+params.forbid(one: 'one').to_h # => { "two" => "two" }
+
+params.forbid('one' => 'one').to_h # => { "two" => "two" }
+```
+
+If your custom `Hash`-like class implements `#delete` and the `#[]` finder, you can `include Allowable` to mix in the methods.
+
+```ruby
+class MyHash
+  include Allowable
+end
+```
+
+## Platform support
+
+This gem should work with Ruby >= 2.0.0, however at the moment it is only tested for Ruby >= 2.2.2
+
+Tested against:
+* MRI 2.2.2
+* MRI 2.3.0
+* MRI 2.3.4
+* MRI 2.4.1
+* JRuby 9.1.6.0
+* JRuby HEAD
+* MRI HEAD
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/allowable.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/lib/allowable.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require 'allowable/version'
+require 'allowable/allowable'
+require 'allowable/core_ext/hash'
+require 'allowable/railtie' if defined? Rails

data/lib/allowable/allow.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Allowable
+  # Adds the #allow and #allow! methods
+  module Allow
+    def allow(filters = {})
+      dup.allow!(filters)
+    end
+
+    def allow!(filters = {})
+      filters.each do |key, val|
+        delete(key) unless Array(val).include?(self[key])
+      end
+      self
+    end
+  end
+end

data/lib/allowable/allowable.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'allowable/allow'
+require 'allowable/forbid'
+
+# Filter hashes by setting  allowed or forbidden values for specific keys.
+#
+#     hash = { one: 'one', two: 'two' }
+#
+#     hash.forbid(one: 'one') # => { two: 'two' }
+#
+#     hash.allow(one: 'two') # => { two: 'two' }
+#
+#     hash.allow(one: ['one', 'two']) # => { one: 'one', two: 'two' }
+#
+#     hash.forbid(one: ['one', 'two']) # => { two: 'two' }
+#
+#     hash.allow!(one: 'two') # => { two: 'two' }
+#
+#     hash.forbid!(two: 'two') # => {}
+#
+#     hash # => {}
+module Allowable
+  include Forbid
+  include Allow
+end

data/lib/allowable/core_ext/hash.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+# Add #allow, #allow!, #forbid, and #forbid! to Hash
+class Hash
+  include Allowable
+end

data/lib/allowable/forbid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Allowable
+  # Adds the #forbid and #forbid! methods
+  module Forbid
+    def forbid(filters = {})
+      dup.forbid!(filters)
+    end
+
+    def forbid!(filters = {})
+      filters.each do |key, val|
+        delete(key) if Array(val).include?(self[key])
+      end
+      self
+    end
+  end
+end

data/lib/allowable/railtie.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require 'rails/railtie'
+
+module Allowable
+  # Railtie initializer that adds Allowable methods to controller params
+  class Railtie < ::Rails::Railtie
+    initializer :allowable do
+      ActiveSupport.on_load :action_controller do
+        ActionController::Parameters.send :include, Allowable
+      end
+    end
+  end
+end

data/lib/allowable/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Allowable
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: allowable
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- M. Simon Borg
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Filter hash keys based on allowed and forbidden values.
+email:
+- msimonborg@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/allowable.rb
+- lib/allowable/allow.rb
+- lib/allowable/allowable.rb
+- lib/allowable/core_ext/hash.rb
+- lib/allowable/forbid.rb
+- lib/allowable/railtie.rb
+- lib/allowable/version.rb
+homepage: https://github.com/msimonborg/allowable
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Filter hash keys based on allowed and forbidden values.
+test_files: []