banditmask 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b0ba2ce5f3058aca2b5b0aea9b05215a6b76026f
+  data.tar.gz: 5b41de6797071fc9e82a73da1bd341855a5e5594
+SHA512:
+  metadata.gz: 6fbe95e064c17ddf564ef77d757df53c5fab34f648974d412e29e2e8fddf42abc945e17bc74f053419d7d04529b662c173113e35ae64329810c71e4e9c658829
+  data.tar.gz: 60c69509a022d36d2a1d33fa72e94ea41e503ea37b5198a126cf9f2be04ec8ff7dce4addcc33d2d1d2e576ba9672f1ad94cc394724278a0daf3c94725df4b5c4

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.1.6
+  - 2.2.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in banditmask.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 John Parker
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,77 @@
+# 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
+
+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 }
+```
+
+To 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 << :write
+```
+
+Ask whether specific bits are enabled.
+
+```ruby
+mask.include? :read    # => true
+mask.include? :write   # => true
+mask.include? :execute # => false
+```
+
+Retrieve a list of all currently enabled bits.
+
+```ruby
+mask.names # => [:read, :write]
+```
+
+## 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

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/test_*.rb'
+end
+
+task default: :test

data/banditmask.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'banditmask/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "banditmask"
+  spec.version       = BanditMask::VERSION
+  spec.authors       = ["John Parker"]
+  spec.email         = ["jparker@urgetopunt.com"]
+
+  spec.summary       = %q{Generic implementation of a bitmask.}
+  spec.description   = %q{BanditMask provides a generic wrapper class to manage a bitmask attribute.}
+  spec.homepage      = "https://github.com/jparker/banditmask"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.1'
+
+  spec.add_development_dependency "bundler", "~> 1.9"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency 'minitest', '~> 5.7'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "banditmask"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/banditmask/version.rb

@@ -0,0 +1,3 @@
+class BanditMask
+  VERSION = "0.1.0"
+end

data/lib/banditmask.rb

@@ -0,0 +1,103 @@
+require "banditmask/version"
+
+class BanditMask
+  attr_reader :mask
+
+  def initialize(mask = 0b0) # :nodoc:
+    @mask = mask
+  end
+
+  ##
+  # Returns a Hash mapping all defined names to their respective bits.
+  #
+  #   class BanditMask
+  #     bit :read, 0b01
+  #     bit :write, 0b10
+  #   end
+  #
+  #   BanditMask.bits # => { :read => 1, :write => 2 }
+  def self.bits
+    @bits ||= {}
+  end
+
+  ##
+  # Maps +name+ to +value+ in the global list of defined bits.
+  #
+  #   class BanditMask
+  #     bit :read, 0b001
+  #     bit :write, 0b010
+  #     bit :execute, 0b100
+  #   end
+  def self.bit(name, value)
+    bits.update name => value
+  end
+
+  ##
+  # Clears all defined bits.
+  def self.reset_bits!
+    @bits = {}
+  end
+
+  ##
+  # Returns integer value of current bitmask.
+  def to_i
+    mask
+  end
+
+  ##
+  # Returns an array of names of the currently enabled bits.
+  #
+  #   class BanditMask
+  #     bit :read, 0b01
+  #     bit :write, 0b10
+  #   end
+  #
+  #   mask = BanditMask.new 0b01
+  #   mask.names # => [:read]
+  def names
+    self.class.bits.select { |name, _| include? name }.keys
+  end
+  alias_method :to_a, :names
+
+  ##
+  # Enables the bit named +name+. Returns +self+, so calles to #<< can be
+  # chained (think Array#<<). Raises +ArgumentError+ if +name+ does not
+  # correspond to a bit that was previously declared with BanditMask.bit.
+  #
+  #   class BanditMask
+  #     bit :read, 0b01
+  #     bit :write, 0b10
+  #   end
+  #
+  #   mask = BanditMask.new
+  #   mask << :read << :write
+  def <<(name)
+    @mask |= name_to_bit(name)
+    self
+  end
+
+  ##
+  # Returns true if +name+ is among the currently enabled bits. Returns false
+  # otherwise. Raises +ArgumentError+ if +name+ does not correspond to a bit
+  # that was previously declared with BanditMask.bit.
+  #
+  #   class BanditMask
+  #     bit :read, 0b01
+  #     bit :write, 0b10
+  #   end
+  #
+  #   mask = BanditMask.new 0b01
+  #   mask.include? :read  # => true
+  #   mask.include? :write # => false
+  def include?(name)
+    @mask & name_to_bit(name) != 0
+  end
+
+  private
+
+  def name_to_bit(name)
+    self.class.bits.fetch(name) do
+      raise ArgumentError, "undefined bit: #{name.inspect}"
+    end
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: banditmask
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- John Parker
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.9'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.7'
+description: BanditMask provides a generic wrapper class to manage a bitmask attribute.
+email:
+- jparker@urgetopunt.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- banditmask.gemspec
+- bin/console
+- bin/setup
+- lib/banditmask.rb
+- lib/banditmask/version.rb
+homepage: https://github.com/jparker/banditmask
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Generic implementation of a bitmask.
+test_files: []