forbidium 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: '008d26bbd4350a53113ea397507d127e219f0220'
-  data.tar.gz: 7e4e0a68c9c7a4adf3fc9065339be324529cea65
+  metadata.gz: 9044ce986e2a490f08eb553163ae652e7100d6e3
+  data.tar.gz: 4ace021f869f46424ef2d215b6581de7897b4c05
 SHA512:
-  metadata.gz: 6e05dd2083cb2325b6808ffdbf63748beacaf55c211eb2332e084ee72591429799e7d80a0e0eab957b5ad1695cb70dd916b34c25ee12d3ada58b0d19bc00f4c4
-  data.tar.gz: 15ce9fe7cf6407b9f2066051cf05c3481fb90782ca8de0411a95d3b781e50070b56e676d4c2bc89a09fd7e2b9138433f18e725c8d42eca4cbbb3c47b080072d8
+  metadata.gz: 3ec7e6d6f08e3e019e4318addb6a66162051dd3275bd6007d580d977f4c41940aa71664de4d0506412a581b40ad3310cb29dc01f135487ab2512cd7723e223b6
+  data.tar.gz: 6eead3f3ca067cca134c626d2d6571f8027bef6eebf50c662b4fa8529136df6cdcf1fe328c6476f0ecd8128acc353c832ca8133bbde260a0679816ea6bfcaae0

data/README.md

@@ -1,4 +1,8 @@
 # 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)
 
 Filter hashes by setting  allowed or forbidden values for specific keys.
 
@@ -19,6 +23,8 @@ 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' }
 
@@ -37,6 +43,14 @@ hash.forbid!(two: 'two') # => {}
 hash # => {}
 ```
 
+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
+```
+
 ## Platform support
 
 Tested against:

data/lib/forbidium/action_controller/parameters.rb

@@ -0,0 +1,40 @@
+# 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/core_ext/hash.rb

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

data/lib/forbidium/forbidium.rb

@@ -1,8 +1,5 @@
 # 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' }
@@ -21,7 +18,15 @@ require 'forbidium/forbid'
 #
 #     hash # => {}
 module Forbidium
-  def self.included(base)
-    [Forbidium::Allow, Forbidium::Forbid].each { |mod| base.send :include, mod }
+  module Allow # :nodoc:
+    def allow(filters = {})
+      dup.allow!(filters)
+    end
+  end
+
+  module Forbid # :nodoc:
+    def forbid(filters = {})
+      dup.forbid!(filters)
+    end
   end
 end

data/lib/forbidium/hash.rb

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

data/lib/forbidium/railtie.rb

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

data/lib/forbidium/version.rb

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

data/lib/forbidium.rb

@@ -2,5 +2,7 @@
 
 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: forbidium
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-08-01 00:00:00.000000000 Z
+date: 2017-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -48,10 +48,10 @@ files:
 - LICENSE.txt
 - README.md
 - lib/forbidium.rb
-- lib/forbidium/allow.rb
+- lib/forbidium/action_controller/parameters.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
@@ -66,7 +66,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="

data/lib/forbidium/allow.rb

@@ -1,18 +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])
-        delete(key.to_s) unless Array(val).include?(self[key.to_s])
-      end
-      self
-    end
-  end
-end

data/lib/forbidium/forbid.rb

@@ -1,18 +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])
-        delete(key.to_s) if Array(val).include?(self[key.to_s])
-      end
-      self
-    end
-  end
-end