banditry 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: c854743c128a72638b17245379ce66aeb3266f3e
-  data.tar.gz: 7d2b541357f00ac37354f6e38dd60aa8b9c59526
+SHA256:
+  metadata.gz: 4fc53e6ac5a0128f9f263684976d027e13e7706f73b4b1e3b2bf96d6dc5a426b
+  data.tar.gz: 6cc90f58e9e9ac6018700d8cd3b8af276c755d9868b0e3de294c922db893fa97
 SHA512:
-  metadata.gz: 2bdac37736e2c1f3d00f0dc63917676dc93ff4e2cfe5b6986b4df2ab81158506f98ba0d9c906d0fbc891a2c16f37ea2b266cddb879754e1ecb52df1f85d765ed
-  data.tar.gz: 75d713fe996892ff04be45ceb278bba6126e79e30a7d0d9211432b8995a71480b4b4585c96fcc3a7ec63d8b48653750eb814e1b11ae5d3a15811df624d0d8337
+  metadata.gz: 23a0d96adfefb4419bc7fe09e14ed8c18f4a4422599cd2009e3e13cee5ae58a2066c9b5c652d6e54707a6814c6a00b832449554095f91b75220e1c48e219e414
+  data.tar.gz: 51675f7f1aff47d96aecc6e4cd420c591a9ef15a007bac07e10868edf58325b8dcf77eec47bf5c56ffc75f59e35645d75f5cfdf476899744b2d12045e38be392

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
 rvm:
-  - 2.1.6
-  - 2.2.2
+  - 2.3.6
+  - 2.4.4
+  - 2.5.1

data/README.md

@@ -20,6 +20,9 @@ Or install it yourself as:
 
     $ gem install banditry
 
+NB: Banditry likely works on earlier versions of Ruby, but is only tested
+against versions 2.3 and above.
+
 ## Usage
 
 ### Banditry::BanditMask

data/banditry.gemspec

@@ -19,10 +19,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.1'
+  spec.required_ruby_version = '>= 2.2'
 
-  spec.add_development_dependency "bundler", "~> 1.9"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 12.0"
   spec.add_development_dependency 'minitest', '~> 5.7'
 
   spec.add_development_dependency 'pry'

data/lib/banditry/bandit_mask.rb

@@ -1,5 +1,9 @@
+# frozen-string-literal: true
+
 module Banditry
   class BanditMask
+    include Enumerable
+
     attr_reader :bitmask
 
     def initialize(bitmask = nil) # :nodoc:
@@ -28,7 +32,7 @@ module Banditry
     #     bit :execute, 0b100
     #   end
     def self.bit(name, value)
-      bits.update name => value
+      bits.update name.to_sym => value
     end
 
     ##
@@ -52,6 +56,25 @@ module Banditry
     end
     alias_method :to_a, :bits
 
+    ##
+    # Delegates to #bits.
+    #
+    #   class MyMask < Banditry::BanditMask
+    #     bit :read, 0b001
+    #     bit :write, 0b010
+    #     bit :execute, 0b100
+    #   end
+    #
+    #   mask = MyMask.new 0b101
+    #   mask.each do |bit|
+    #     # => :read
+    #     # => :execute
+    #   end
+    #   mask.each # => #<Enumerator: ...>
+    def each(&block)
+      bits.each(&block)
+    end
+
     ##
     # Enables the bit named +bit+. Returns +self+, so calls to #<< can be
     # chained. (Think Array#<<.) Raises +ArgumentError+ if +bit+ does not
@@ -114,6 +137,13 @@ module Banditry
 
     alias_method :eql?, :==
 
+    ##
+    # Returns +true+ if bitmask is zero (no bits are enabled) and +false+
+    # otherwise.
+    def empty?
+      bitmask.zero?
+    end
+
     ##
     # Returns an object hash. Two Banditry::BanditMask objects have identical
     # hashes if they have identical bitmasks and are instances of the same
@@ -153,7 +183,8 @@ module Banditry
     # Returns the integer value for the bit named +bit+. Raises +ArgumentError+
     # if +bit+ has not been previously defined with Banditry::BanditMask.bit.
     def bit_value(bit)
-      self.class.bits.fetch(bit) do
+      bit = bit.to_sym
+      self.class.bits.fetch bit do
         raise ArgumentError, "undefined bit: #{bit.inspect}"
       end
     end

data/lib/banditry/version.rb

@@ -1,3 +1,5 @@
+# frozen-string-literal: true
+
 module Banditry
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/banditry.rb

@@ -1,5 +1,8 @@
+# frozen-string-literal: true
+
 require 'banditry/version'
 require 'banditry/bandit_mask'
+require 'forwardable'
 
 module Banditry
   class BanditryError < StandardError
@@ -49,6 +52,9 @@ module Banditry
   #   file.mode_mask       # => 5
   def bandit_mask(attribute, as:, with: BanditMask)
     class_eval do
+      extend SingleForwardable
+
+      generate_class_method as, with
       generate_reader attribute, as, with
       generate_writer attribute, as, with
       generate_query attribute, as, with
@@ -57,38 +63,46 @@ module Banditry
 
   private
 
-  def generate_reader(attr, virt, cls)
+  def generate_class_method(virt, bandit)
     respond_to? virt and
-      raise MethodCollisionError, "method `#{virt}` already exists"
+      raise MethodCollisionError, "method `#{self}.#{virt}` already exists"
+
+    def_single_delegator bandit, :bits, virt
+  end
+
+  def generate_reader(attr, virt, bandit)
+    instance_methods.include? virt and
+      raise MethodCollisionError, "method `#{self}##{virt}` already exists"
 
-    define_method virt do
-      instance_variable_get(:"@#{virt}") ||
-        instance_variable_set(:"@#{virt}", cls.new(send(attr)))
+    define_method virt do |reload = false|
+      reload = true if !instance_variable_defined? :"@#{virt}"
+      instance_variable_set :"@#{virt}", bandit.new(send(attr)) if reload
+      instance_variable_get :"@#{virt}"
     end
   end
 
-  def generate_writer(attr, virt, cls)
-    respond_to? :"#{virt}=" and
-      raise MethodCollisionError, "method `#{virt}=` already exists"
+  def generate_writer(attr, virt, bandit)
+    instance_methods.include? :"#{virt}=" and
+      raise MethodCollisionError, "method `#{self}##{virt}=` already exists"
 
     define_method :"#{virt}=" do |bits|
       mask = case bits
              when BanditMask
                bits
              else
-               bits.inject(cls.new) { |bm, bit| bm << bit }
+               bits.inject(bandit.new) { |bm, bit| bm << bit }
              end
       send :"#{attr}=", Integer(mask)
       instance_variable_set :"@#{virt}", mask
     end
   end
 
-  def generate_query(attr, virt, cls)
-    respond_to? :"#{virt}?" and
-      raise MethodCollisionError, "method `#{virt}?` already exists"
+  def generate_query(attr, virt, bandit)
+    instance_methods.include? :"#{virt}?" and
+      raise MethodCollisionError, "method `#{self}##{virt}?` already exists"
 
     define_method :"#{virt}?" do |*bits|
-      cls.new(send(attr)).include? *bits
+      bandit.new(send(attr)).include?(*bits)
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: banditry
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - John Parker
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-07 00:00:00.000000000 Z
+date: 2018-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.9'
+        version: '1.15'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -98,7 +98,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.1'
+      version: '2.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -106,7 +106,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.7.7
 signing_key: 
 specification_version: 4
 summary: Generic implementation of a bitmask.