forbidium 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 33983919de674f2464e0cb78171385da8a910fd6
-  data.tar.gz: b4d2974d67829e77af19f50aff1bcb5ec37f3439
+  metadata.gz: 5b41e5cb910d5e3f0c7bc288c1bef273770f904d
+  data.tar.gz: b629928ec78b528e5d85b48073eebf32cf95fbf1
 SHA512:
-  metadata.gz: e813b97fb3f4b71695a3931bd9bc09497277183762efd1cde423339b52bd732462298fa718868c623b271675e6054e4e20fbc6d01f31ba0362c3d94d894305bc
-  data.tar.gz: be946d5a94cac7867ceaa2f5e92537441e38fc3096d2faae9280f945862af054a66957d3911b9141886c565db53f16869811d71d016349c5fcde9feda4abb4f4
+  metadata.gz: 70373e7f8f34e3a1e31c27c02bfe1fcaaf08434718661f90e620f66987a7b53cf9d6aef56339fbc175fccbb2e3413333aa36b43a4b1ca223be4969520a6b4a6d
+  data.tar.gz: 24599ce3d6152468d7239364844281ef3f1689607bc4b68538c8382320f06d95ce6908f84fd31c21a61d5788a04bfe2c62a51868b861b544ff788e3f7582ce1a

data/CHANGELOG.md

@@ -0,0 +1,18 @@
+# Changelog
+1.2.0
+-----
+* `HashWithIndifferentAccess` and `Hash` do not need different implementations. Same module can be included in both and achieve the correct results. To mixin the methods to any `Hash`-like class just `include Forbidium`
+
+1.1.1
+-----
+* Relax Ruby version back to >= 2.0.0, since it will work and should be compatible with `ActiveSupport` >= 4.2.0, but only test >= 2.2.2 because of compatibility with Rails 5.x in dummy app testing.
+
+1.1.0
+-----
+* Respect key types in `Hash`es: filter key types must match hash key types to affect output. Different implementation for `ActionController::Parameters`, since it is `HashWithIndifferentAccess`; symbol key filters will affect string keys in params.
+* Require Ruby >= 2.2.0
+
+1.0.1
+-----
+* Require Ruby >= 2.0.0
+* Substantial performance improvement by accessing hash keys directly instead of iterating with `#delete_if`

data/README.md

@@ -43,6 +43,16 @@ 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
@@ -51,6 +61,17 @@ def user_params
 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:

data/lib/forbidium.rb

@@ -2,7 +2,5 @@
 
 require 'forbidium/version'
 require 'forbidium/forbidium'
-require 'forbidium/action_controller/parameters'
-require 'forbidium/hash'
 require 'forbidium/core_ext/hash'
 require 'forbidium/railtie' if defined? Rails

data/lib/forbidium/allow.rb

@@ -0,0 +1,17 @@
+# 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

@@ -2,5 +2,5 @@
 
 # Add #allow, #allow!, #forbid, and #forbid! to Hash
 class Hash
-  include Forbidium::Hash
+  include Forbidium
 end

data/lib/forbidium/forbid.rb

@@ -0,0 +1,17 @@
+# 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,5 +1,8 @@
 # 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' }
@@ -18,15 +21,6 @@
 #
 #     hash # => {}
 module Forbidium
-  module Allow # :nodoc:
-    def allow(filters = {})
-      dup.allow!(filters)
-    end
-  end
-
-  module Forbid # :nodoc:
-    def forbid(filters = {})
-      dup.forbid!(filters)
-    end
-  end
+  include Forbid
+  include Allow
 end

data/lib/forbidium/railtie.rb

@@ -7,9 +7,7 @@ module Forbidium
   class Railtie < ::Rails::Railtie
     initializer :forbidium do
       ActiveSupport.on_load :action_controller do
-        ::ActionController::Parameters.send(
-          :include, Forbidium::ActionController::Parameters
-        )
+        ActionController::Parameters.send :include, Forbidium
       end
     end
   end

data/lib/forbidium/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forbidium
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-02 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -45,13 +45,14 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
 - LICENSE.txt
 - README.md
 - lib/forbidium.rb
-- lib/forbidium/action_controller/parameters.rb
+- lib/forbidium/allow.rb
 - lib/forbidium/core_ext/hash.rb
+- lib/forbidium/forbid.rb
 - lib/forbidium/forbidium.rb
-- lib/forbidium/hash.rb
 - lib/forbidium/railtie.rb
 - lib/forbidium/version.rb
 homepage: https://github.com/msimonborg/forbidium

data/lib/forbidium/action_controller/parameters.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-module Forbidium
-  module ActionController # :nodoc:
-    module Parameters # :nodoc:
-      # Adds the #forbid and #forbid! methods
-      module Forbid # :nodoc:
-        include Forbidium::Forbid
-
-        def forbid!(filters = {})
-          filters.each do |key, val|
-            delete(key) if Array(val).include?(self[key])
-            if key.is_a? Symbol
-              delete(key.to_s) if Array(val).include?(self[key.to_s])
-            end
-          end
-          self
-        end
-      end
-
-      # Adds the #allow and #allow! methods
-      module Allow # :nodoc:
-        include Forbidium::Allow
-
-        def allow!(filters = {})
-          filters.each do |key, val|
-            delete(key) unless Array(val).include?(self[key])
-            if key.is_a? Symbol
-              delete(key.to_s) unless Array(val).include?(self[key.to_s])
-            end
-          end
-          self
-        end
-      end
-
-      include Allow
-      include Forbid
-    end
-  end
-end

data/lib/forbidium/hash.rb

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