banditmask 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c07c68905cfe2a56b3ba19fa9192604e505fe06e
-  data.tar.gz: 5787ac69e4472405d2e0408203e788128eaabb19
+  metadata.gz: 2bc728e7282f48a7f2b68abe40960893619622ab
+  data.tar.gz: e364832686de46d7229a5b72a39a786338f0dc1d
 SHA512:
-  metadata.gz: 5535575ab548f020d6043df8927ba7da1fe90bf094c76894890894f1c9c153dabf6fab2501ed23be227c169a8d53af94c41b579a6631777b0c30611876a51c9e
-  data.tar.gz: b0a80aa7a44e9e02d32465d9bc4c200d697bb5fdefe63239328faad9255e3b387d06fbf5fe44717017ae239be4ec500915b23fc9a70ac3bc3cb8b5eb10e3b3a9
+  metadata.gz: 8eb4c9763f19f7ffbc936a2f49ab59569bd04277c9d54b151a1f51c4a5cad1bfb5cc865fad8e2b51a89acc24487f51a57f83f2825af8838da697ecc6ee690bb4
+  data.tar.gz: 06260ac70e9fc1ce9d4a2fab8951adda40443d044a7a4e898cc669915522eafc52e702d73d0b85e7dc70647e30d5e00c0c2995a79e2536b3d291becbddf8caae

data/README.md

@@ -1,134 +1,3 @@
-# [![Gem Version](https://badge.fury.io/rb/banditmask.svg)](http://badge.fury.io/rb/banditmask) [![Build Status](https://travis-ci.org/jparker/banditmask.svg?branch=master)](https://travis-ci.org/jparker/banditmask)
-
 # BanditMask
 
-BanditMask provides a generic wrapper for working with bitmasks.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'banditmask'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install banditmask
-
-## Usage
-
-### BanditMask
-
-Create a class which inherits from BanditMask, and declare the available bit
-names and their corresponding values.
-
-```ruby
-class ChmodMask < BanditMask
-  bit :read,    0b001
-  bit :write,   0b010
-  bit :execute, 0b100
-end
-
-ChmodMask.bits # => { :read => 1, :write => 2, :execute => 4 }
-```
-
-Instantiate a new mask class:
-
-```ruby
-mask = ChmodMask.new
-# or
-current_bitmask = 0b001 | 0b010
-mask = ChmodMask.new current_bitmask
-```
-
-Enable bits by name.
-
-```ruby
-mask << :read << :execute
-```
-
-Ask whether specific bits are enabled.
-
-```ruby
-mask.include? :read           # => true
-mask.include? :write          # => false
-mask.include? :execute        # => true
-mask.include? :read, :write   # => false
-mask.include? :read, :execute # => true
-```
-
-Retrieve a list of all currently enabled bits.
-
-```ruby
-mask.bits # => [:read, :execute]
-```
-
-### BanditMask::Banditry
-
-In a class with a bitmask attribute, extend BanditMask::Banditry and call
-BanditMask::Banditry.bandit_mask to add accessor methods for working with the
-bitmask attribute.
-
-```ruby
-class ObjectWithBitmaskAttribute
-  attr_accessor :bitmask
-
-  extend BanditMask::Banditry
-  bandit_mask :bitmask, as: :bits, with: ChmodMask
-end
-
-obj = ObjectWithBitmaskAttribute.new
-obj.bitmask = 0b001
-```
-
-This gives you a reader method which returns the BanditMask representation
-of the bitmask attribute.
-
-```ruby
-obj.bits # => #<ChmodMask:0x007f941b9518c8 @bitmask=1>
-```
-
-It also gives you a writer method which lets you modify the bitmask. The
-writer accepts BanditMask objects or an Array of bits.
-
-```ruby
-obj.bits |= :write
-obj.bitmask # => 3
-obj.bits = [:read, :execute]
-obj.bitmask # => 5
-```
-
-Finally, it gives you a query method for checking whether particular bits are
-set on the bitmask.
-
-```ruby
-obj.bits? :read           # => true
-obj.bits? :write          # => false
-obj.bits? :execute        # => true
-obj.bits? :read, :write   # => false
-obj.bits? :read, :execute # => true
-```
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, 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` to create a git tag for the version, push git
-commits and tags, and push the `.gem` file to
-[rubygems.org](https://rubygems.org).
-
-## Contributing
-
-1. Fork it ( https://github.com/[my-github-username]/banditmask/fork )
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create a new Pull Request
+Moved to [banditry](https://github.com/jparker/banditry).

data/banditmask.gemspec

@@ -26,4 +26,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'minitest', '~> 5.7'
 
   spec.add_development_dependency 'pry'
+
+  spec.post_install_message = <<-END
+!     The 'banditmask' gem has been deprecated and has been replaced by 'banditry'.
+!
+!     See: https://rubygems.org/gems/banditry
+!     And: https://github.com/jparker/banditry
+  END
 end

data/lib/banditmask.rb

@@ -1,3 +1,6 @@
+warn '[DEPRECATION] This gem has been renamed to banditry and will no ' \
+  'longer be supported. Please switch to banditry as soon as possible.'
+
 require 'banditmask/version'
 require 'banditmask/banditry'
 

data/lib/banditmask/version.rb

@@ -1,3 +1,3 @@
 class BanditMask
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: banditmask
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - John Parker
@@ -89,7 +89,11 @@ homepage: https://github.com/jparker/banditmask
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  !     The 'banditmask' gem has been deprecated and has been replaced by 'banditry'.
+  !
+  !     See: https://rubygems.org/gems/banditry
+  !     And: https://github.com/jparker/banditry
 rdoc_options: []
 require_paths:
 - lib