forbidium 1.2.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5b41e5cb910d5e3f0c7bc288c1bef273770f904d
-  data.tar.gz: b629928ec78b528e5d85b48073eebf32cf95fbf1
+  metadata.gz: 81868b5c81c95377d8fe37c1f64dc9ba68cf1153
+  data.tar.gz: 84efec5075cca2d2b3f11016c178d181093d5cdd
 SHA512:
-  metadata.gz: 70373e7f8f34e3a1e31c27c02bfe1fcaaf08434718661f90e620f66987a7b53cf9d6aef56339fbc175fccbb2e3413333aa36b43a4b1ca223be4969520a6b4a6d
-  data.tar.gz: 24599ce3d6152468d7239364844281ef3f1689607bc4b68538c8382320f06d95ce6908f84fd31c21a61d5788a04bfe2c62a51868b861b544ff788e3f7582ce1a
+  metadata.gz: 76f8da6a468c88063cc2181ec50e9b760b8a77264a129b9a291437ac34c2986afa6ac7f39913b60485e656f2fd8ed0b9fa4ee8fa72dfcf6a3b9e4229bf37f94a
+  data.tar.gz: 7615c7b7b5455fa33b93271e362de02687aa967e3b3aa12113eec7298463300ab89a74741e45acdf207344286a13912f057bada2f0a80dadd308f6a319599280

data/README.md

@@ -1,97 +1,11 @@
-# Forbidium
-[![Gem Version](https://badge.fury.io/rb/forbidium.svg)](https://badge.fury.io/rb/forbidium)
-[![Code Climate](https://codeclimate.com/github/msimonborg/forbidium/badges/gpa.svg)](https://codeclimate.com/github/msimonborg/forbidium)
-[![Build Status](https://travis-ci.org/msimonborg/forbidium.svg?branch=master)](https://travis-ci.org/msimonborg/forbidium)
-[![Coverage Status](https://coveralls.io/repos/github/msimonborg/forbidium/badge.svg?branch=master)](https://coveralls.io/github/msimonborg/forbidium?branch=master)
+# I was Forbidium
+# Now I'm [Allowable](https://github.com/msimonborg/allowable)
 
-Filter hashes by setting  allowed or forbidden values for specific keys.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'forbidium'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install forbidium
-
-## 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" }
-```
-
-When added to the `Gemfile` in a Rails project, `ActionController::Parameters` will also 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 the `#[]` finder and `#delete`, you can `include Forbidium` to mix in the methods.
-
-## Platform support
-
-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).
+I'll still work. All I do is install the latest version of `allowable` and `include Allowable`. You might as well do that directly.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/forbidium.
+Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/allowable.
 
 
 ## License

data/lib/forbidium.rb

@@ -1,6 +1,27 @@
 # frozen_string_literal: true
 
+require 'allowable'
 require 'forbidium/version'
-require 'forbidium/forbidium'
-require 'forbidium/core_ext/hash'
-require 'forbidium/railtie' if defined? Rails
+
+# frozen_string_literal: true
+
+# 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 Forbidium
+  include Allowable
+end

data/lib/forbidium/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Forbidium
-  VERSION = '1.2.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forbidium
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 2.0.0
 platform: ruby
 authors:
 - M. Simon Borg
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: allowable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -38,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-description: Filter hash keys based on allowed and forbidden values.
+description: Filter hash keys based on allowed and forbidden values. Renamed "Allowable".
 email:
 - msimonborg@gmail.com
 executables: []
@@ -49,17 +63,15 @@ files:
 - LICENSE.txt
 - README.md
 - lib/forbidium.rb
-- lib/forbidium/allow.rb
-- lib/forbidium/core_ext/hash.rb
-- lib/forbidium/forbid.rb
-- lib/forbidium/forbidium.rb
-- lib/forbidium/railtie.rb
 - lib/forbidium/version.rb
 homepage: https://github.com/msimonborg/forbidium
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: "`Forbidium` has been renamed to `Allowable`. Please remove
+  `forbidium` from your Gemfile and replace it with `allowable`. `forbidium` just
+  installs the latest version of `allowable` anyway, so it will still work. But you
+  won't be able to lock the version. Do the right thing and switch to `allowable`"
 rdoc_options: []
 require_paths:
 - lib
@@ -78,5 +90,5 @@ rubyforge_project:
 rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
-summary: Filter hash keys based on allowed and forbidden values.
+summary: Filter hash keys based on allowed and forbidden values. Renamed "Allowable".
 test_files: []

data/lib/forbidium/allow.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Forbidium
-  # 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/forbidium/core_ext/hash.rb

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

data/lib/forbidium/forbid.rb

@@ -1,17 +0,0 @@
-# frozen_string_literal: true
-
-module Forbidium
-  # 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/forbidium/forbidium.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-require 'forbidium/allow'
-require 'forbidium/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 Forbidium
-  include Forbid
-  include Allow
-end

data/lib/forbidium/railtie.rb

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