allowable 1.0.2 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a158170af78796338bf4cf75bf5e4e2ec58c52d
-  data.tar.gz: 61fed37bc38d0175c977c7e18054a45fb3ad671f
+  metadata.gz: efa2ac1dd6e30afa5a91724b2eec484f143c978e
+  data.tar.gz: 68b89445aa30b0b245210f4e5eb0da1fffef917c
 SHA512:
-  metadata.gz: 932e5d6d255a5cadab770b07c1a9500316ce9ad75ee55386fe96c62de631c15ce5d2611c1ff3a0f50850355bd3f029b25483cc98cd7555e5e3aa2243081ff9ea
-  data.tar.gz: 279294123d8af70b000b5be1576a5e2f710d278f6b82cf779574fb69a9d8f66ca75efbae42469bf0664a3dcdc654afbbe2358b718bf58af51ab513729c800415
+  metadata.gz: 0a7f2d873f4c981ec505373e842e19a1591545b5152bd63d7fea1342b48962426c699896c95d8167e95fbd49b634caab02908573e9209faa4f85ea324d78bf0a
+  data.tar.gz: f646f7720e71e9b444aefc5d0dbff1f4074e6a291042406f64f42df12efb4198924476e5738a6aa2c6953a9b1991ed415616ac73b611fc2f7d0e4c7deece38bd

data/CHANGELOG.md

@@ -1,4 +1,10 @@
 # Changelog
+1.1.0
+-----
+* Include in `ActiveSupport::HashWithIndifferentAccess`, which also expands Rails compatibility down to version 3.2.
+* Expand testing with `Appraisal` gem. Test against Rails 3.2, 4.2, and 5.1, and Ruby >= 1.9.3
+* Consolidate all methods into `Allowable` module, remove `Allowable::Allow` and `Allowable::Forbid`
+
 1.0.2
 -----
 * Match array values e.g. `{ key: ['val_one', 'val_two'] }.forbid(key: ['val_one', 'val_two']) # => {}` TODO: Slows down benchmarked performance of `#allow`, need to figure out why

data/README.md

@@ -42,9 +42,9 @@ hash.forbid!(two: 'two') # => {}
 
 hash # => {}
 
-hash.merge(one: ['one', 1]) # => { one: ["one", 1], two: "two" }
+hash.merge(one: ['one', 1]).forbid(one: 'one') # => { one: ["one", 1] }
 
-hash.merge(one: ['one', 1]).forbid(one: ['one', 1]) # => { two: "two" }
+hash.merge(one: ['one', 1]).forbid(one: ['one', 1]) # => {}
 ```
 
 #### Type sensitive for `Hash`
@@ -59,7 +59,9 @@ 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`:
+If `ActiveSupport::HashWithIndifferentAccess` is defined it will receive the methods. This automatically makes them available in `ActionController::Parameters` for Rails 4 and 3. Rails 3 requires that you add `gem 'strong_parameters'` to your `Gemfile` in order to use strong parameters.
+
+Starting in Rails 5, `ActionController::Parameters` no longer inherits from `ActiveSupport::HashWithIndifferentAccess`. When `allowable` is added to the `Gemfile` in a Rails 5+ project, load hooks will add the methods directly to `ActionController::Parameters` so you can use them with your strong parameters.
 
 ```ruby
 def user_params
@@ -67,7 +69,7 @@ def user_params
 end
 ```
 
-#### Type insensitive for `HashWithIndifferentAccess`
+#### Type insensitive for `HashWithIndifferentAccess` and `ActionController::Parameters`
 ```ruby
 params = ActionController::Parameters.new('one' => 'one', 'two' => 'two').permit(:one, :two)
 
@@ -86,11 +88,14 @@ end
 
 ## Platform support
 
-The core module should work with all rubies, however at the moment it is only tested for MRI Ruby >= 2.2.2 and JRuby 9.1.6.0
+The core module should work with all rubies. It is tested for MRI Ruby >= 1.9.3 and JRuby 9.1.6.0
 
-The Rails plugin is currently being tested only with Rails 5.1.2. Rails >= 4.2.0 should not experience any issues.
+Rails compatibility is currently being tested only for versions ~> 3.2, ~> 4.2, and ~> 5.1.
 
 Tested against:
+* MRI 1.9.3
+* MRI 2.0.0
+* MRI 2.1.10
 * MRI 2.2.2
 * MRI 2.3.0
 * MRI 2.3.4

data/lib/allowable.rb

@@ -3,4 +3,12 @@
 require 'allowable/version'
 require 'allowable/allowable'
 require 'allowable/core_ext/hash'
+
+begin
+  require 'active_support/core_ext/hash/indifferent_access'
+  ActiveSupport::HashWithIndifferentAccess.send :include, Allowable
+rescue LoadError
+  # do nothing
+end
+
 require 'allowable/railtie' if defined? Rails

data/lib/allowable/allowable.rb

@@ -1,8 +1,5 @@
 # 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' }
@@ -21,6 +18,25 @@ require 'allowable/forbid'
 #
 #     hash # => {}
 module Allowable
-  include Forbid
-  include Allow
+  def allow(filters = {})
+    dup.allow!(filters)
+  end
+
+  def allow!(filters = {})
+    filters.each do |key, val|
+      delete(key) unless Array(val).include?(self[key]) || val == self[key]
+    end
+    self
+  end
+
+  def forbid(filters = {})
+    dup.forbid!(filters)
+  end
+
+  def forbid!(filters = {})
+    filters.each do |key, val|
+      delete(key) if Array(val).include?(self[key]) || val == self[key]
+    end
+    self
+  end
 end

data/lib/allowable/core_ext/hash.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'allowable/allowable'
+
 # Add #allow, #allow!, #forbid, and #forbid! to Hash
 class Hash
   include Allowable

data/lib/allowable/railtie.rb

@@ -5,9 +5,11 @@ 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
+    if Rails::VERSION::MAJOR >= 5
+      initializer :allowable do
+        ActiveSupport.on_load :action_controller do
+          ActionController::Parameters.send :include, ::Allowable
+        end
       end
     end
   end

data/lib/allowable/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: allowable
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 1.1.0
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-04 00:00:00.000000000 Z
+date: 2017-08-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -49,10 +49,8 @@ files:
 - 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

data/lib/allowable/allow.rb

@@ -1,17 +0,0 @@
-# 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]) || val == self[key]
-      end
-      self
-    end
-  end
-end

data/lib/allowable/forbid.rb

@@ -1,17 +0,0 @@
-# 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]) || val == self[key]
-      end
-      self
-    end
-  end
-end