forbidium 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1043ce4d9d849b044c480c05b412003f0b00deb6
-  data.tar.gz: 9ccce27c23c6d6853dfc5cdca0059ff08bdfe89d
+  metadata.gz: 7357a934edea8da3fad3521e262b325f5a074aa2
+  data.tar.gz: 3314c60c18cfe8712cc6554dd30d3ab439320264
 SHA512:
-  metadata.gz: fa045780d0b51b068941114a4599035c7fedf5cac0e50fe092aad3fb890c32fa651c6b5030759c829de0cf2889e0fcf2df53370d4113f3fa6cbce3b11734aab7
-  data.tar.gz: 34c0875b4c8a3b6cc19dc14319ab31422af161517328ad21eeaf04d702936569e5fef0740a63ef749e9513da0d23baf0b0b66f06cc8020afe2e144bf3f081d7e
+  metadata.gz: 36b5426bae95cac10e625fc75fcf5e6c6d84c383808f7fefeb638e255bb6126448db590c85a1a4300181da78ae3b7343db912dbc6704784b612601955fc6e977
+  data.tar.gz: 31bdeb20fa5b6759fd6d007ccab67d96fd4f587dc131fc4f5e043391710d1a48fcab00edbb48754d9bf60c2e7c6700fec74d9381c9ac8da68f6c2086acd00706

data/README.md

@@ -1,8 +1,6 @@
 # Forbidium
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/forbidium`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Filter hashes by setting  allowed or forbidden values for specific keys.
 
 ## Installation
 
@@ -21,9 +19,23 @@ Or install it yourself as:
     $ gem install forbidium
 
 ## Usage
+```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' }
 
-TODO: Write usage instructions here
+hash.forbid(one: ['one', 'two']) # => { two: 'two' }
 
+hash.allow!(one: 'two') # => { two: 'two' }
+
+hash.forbid!(two: 'two') # => {}
+
+hash # => {}
+```
 ## 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.
@@ -32,10 +44,9 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/forbidium.
+Bug reports and pull requests are welcome on GitHub at https://github.com/msimonborg/forbidium.
 
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-

data/lib/forbidium/allow.rb

@@ -1,4 +1,5 @@
 module Forbidium
+  # Adds the #allow and #allow! methods
   module Allow
     def allow(filters = {})
       dup.allow!(filters)

data/lib/forbidium/core_ext/hash.rb

@@ -1,3 +1,4 @@
+# Add #allow, #allow!, #forbid, and #forbid! to Hash
 class Hash
   include Forbidium
 end

data/lib/forbidium/forbid.rb

@@ -1,4 +1,5 @@
 module Forbidium
+  # Adds the #forbid and #forbid! methods
   module Forbid
     def forbid(filters = {})
       dup.forbid!(filters)

data/lib/forbidium/forbidium.rb

@@ -3,6 +3,23 @@
 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
   def self.included(base)
     [Forbidium::Allow, Forbidium::Forbid].each { |mod| base.include mod }

data/lib/forbidium/railtie.rb

@@ -1,6 +1,7 @@
 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

data/lib/forbidium/version.rb

@@ -1,3 +1,3 @@
 module Forbidium
-  VERSION = '0.1.2'.freeze
+  VERSION = '1.0.0'.freeze
 end

data/lib/forbidium.rb

@@ -1,6 +1,4 @@
 require 'forbidium/version'
-
 require 'forbidium/forbidium'
 require 'forbidium/core_ext/hash'
-
 require 'forbidium/railtie' if defined? Rails

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: forbidium
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 1.0.0
 platform: ruby
 authors:
 - M. Simon Borg