Module: Banditry

Defined in:
lib/banditry.rb,
lib/banditry/version.rb,
lib/banditry/bandit_mask.rb

Defined Under Namespace

Classes: BanditMask, BanditryError, MethodCollisionError

Constant Summary collapse

VERSION = 
'0.4.0'

Instance Method Summary collapse

Instance Method Details

#bandit_mask(attribute, as:, with: BanditMask) ⇒ Object

Creates wrapper methods for reading, writing, and querying the bitmask stored in attribute using the class with. with defaults to Banditry::BanditMask, but you can (and probably should) define your own class inheriting from+Banditry::BanditMask to fill this role. The name of the accessor methods will be derived from as, e.g., if as is :foo, the methods will be named :foo, :foo=, and :foo?.

The reader method will return a Banditry::BanditMask representation of attribute.

The writer method overwrites the current bitmask if with an Array of bits, or it updates the current bitmask if sent an individual bit, e.g., using #|.

In addition to the accessor methods, a query method that delegates to Banditry::BanditMask#include? will be added.

class FileMask < Banditry::BanditMask
  bit :r, 0b001
  bit :w, 0b010
  bit :x, 0b100
end

class FileObject
  attr_accessor :mode_mask

  extend Banditry
  bandit_mask :mode_mask, as: :mode, with: FileMask
end

file = FileObject.new
file.mode_mask       # => nil
file.mode |= :r
file.mode_mask       # => 1
file.mode |= :w
file.mode_mask       # => 3
file.mode = [:r, :x]
file.mode_mask       # => 5



50
51
52
53
54
55
56
 
# File 'lib/banditry.rb', line 50

def bandit_mask(attribute, as:, with: BanditMask)
  class_eval do
    generate_reader attribute, as, with
    generate_writer attribute, as, with
    generate_query attribute, as, with
  end
end