attribool 0.1.0 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f04da5ae0d24a9e980b51a244c7d83ab90b6f4b3d288a49ab069397be78fe3d4
-  data.tar.gz: 5145d0dea86d0341d5bdbb64ae240647caca668eca6f72122bb1cf831a273ef3
+  metadata.gz: eb6bff0b78f856fe87c3d101b3f2eaf4eeeb49fcc9d5a7171857df555ec93125
+  data.tar.gz: fcf0a984bd435bd05c0b6039201419fb5aa3c40df94efb33e288d1ff069ca57d
 SHA512:
-  metadata.gz: c048e38a1a380785c5fdb7198913cb2aa686ea47f955ab649e004cf77e8e3fea08be1857a3d89e3da3647d788b0944cffceabdbbf0a5b85db560949426e60525
-  data.tar.gz: 3f522acba694671f5e8d7bf4a12221d9ac1edef9e538bf943683119c9346a68340550bee719db1167a9104ced50d9b2869e89245ec820ee5c4bae6542a6f00a2
+  metadata.gz: 47e07045578ba1f698eebdcfc72d9d0de7d634f2d8950b7067bb6c4c74baabbbadf90e92e4392872c8992c09e2954833daae5b8a496f7d01efc7e2537e8f392b
+  data.tar.gz: 70cf40cf0102b2def2b68b9c5b51103bbad23ebd9a8a01d812f6a41a766ae3fd007455ed4842f5000298d147ded173b09fd1d3b6bf6ecedf8b7ad6fd9b9f6ae2

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribool (0.1.0)
+    attribool (1.0.3)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -4,17 +4,18 @@
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 Ruby macros for creating boolean methods for attributes that may or may not be
-booleans themselves. This is done via coercion based on truthiness.
+booleans themselves. This is done via either coercion based on truthiness, or a
+user-defined condition.
 
 For example, if you have an attribute of `@name`, and you want to know if
 `@name` is not `nil`, you can declare `bool_reader :name`, which will define the
 method `name?`. This method will return true if `@name` is truthy.
 
 The `bool_reader` also comes with some handy options. For example, you can
-[define a method name](#a-bool_reader-with-method-name-or-prefix) that makes
+[define a method name](#a-bool_reader-with-method-name) that makes
 more sense. Using the same example as above, if your attribute is `@name`, but
 you'd like for your boolean method to be called `named?`, you can use
-`bool_reader :name, method: :named?`.
+`bool_reader :name, method_name: :named?`.
 [Conditionals](#a-bool_reader-with-method-name-and-conditional) can also be set
 with lambdas via the `condition:` keyword argument.
 
@@ -57,7 +58,9 @@ class Person
   attr_accessor :name
   bool_reader :name
   # OR
-  bool_reader :@name
+  # bool_reader :@name
+  # bool_reader 'name'
+  # bool_reader '@name'
 end
 
 person = Person.new
@@ -71,7 +74,7 @@ person.name?
 # true, because @name is truthy.
 ```
 
-#### A bool_reader with method name or prefix
+#### A bool_reader with method name
 ```ruby
 require 'attribool'
 
@@ -79,18 +82,15 @@ class Person
   extend Attribool
 
   attr_accessor :name
-  bool_reader :name, method: :named?
-  bool_reader :name, prefix: :has
+  bool_reader :name, method_name: :named?
 end
 
 person = Person.new
 person.named?
-person.has_name?
 # false, because @name is nil.
 
 person.name = 'John Smith'
 person.named?
-person.has_name?
 # true, because @name is truthy.
 ```
 
@@ -103,7 +103,7 @@ class Person
 
   attr_accessor :age
   # In the condition lambdas, the argument refers to the attribute's value.
-  bool_reader :age, method: :adult?, condition: ->(a) { a.to_i >= 18 }
+  bool_reader :age, method_name: :adult?, condition: ->(a) { a.to_i >= 18 }
 end
 
 person = Person.new
@@ -119,6 +119,34 @@ person.adult?
 # true, because @age is greater than 18.
 ```
 
+#### Assigning more than one bool_reader with a method name at once
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  attr_accessor :name, :age
+  # When creating multiple readers at once, if you want to specify a
+  # method_name, you must provide a Proc as the argument, where the attribute
+  # name is the argument.
+  bool_reader :age, :name, method_name: ->(m) { "has_#{m}?" }
+end
+
+person = Person.new
+person.has_age?
+person.has_name?
+# Both false, because @age and @name are nil.
+
+person.age = 10
+person.has_age?
+# true, because @age is not nil.
+
+person.name = 'Bob'
+person.has_name?
+# true, because @name is not nil.
+```
+
 #### Standard bool_accessor
 ```ruby
 require 'attribool'

data/lib/attribool/attribute.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+##
+# Abstraction for an attribute to determine its name, reader, writer, and
+# instance variable name.
+class Attribool::Attribute
+  ##
+  # The name of the attribute, without the leading "@".
+  #
+  # @return [String]
+  attr_reader :name
+
+  ##
+  # The name of the instance variable for the attribute, with the leading "@".
+  #
+  # @return [String]
+  attr_reader :ivar
+
+  ##
+  # The name of the reader for the attribute.
+  #
+  # @return [String]
+  attr_reader :reader
+
+  ##
+  # The name of the writer for the attribute.
+  #
+  # @return [String]
+  attr_reader :writer
+
+  class << self
+    ##
+    # Ensures that if multiple attributes are being defined, and +method_name+
+    # is provided, that +method_name+ is a +Proc+.
+    #
+    # @param [Integer] number_of_attributes
+    #
+    # @param [String, Symbol, Proc] method_name
+    def validate_method_name(method_name, number_of_attributes)
+      return if number_of_attributes == 1 || nil_or_proc?(method_name)
+
+      raise ArgumentError, "Must use a Proc when creating multiple methods"
+    end
+
+    private
+
+    def nil_or_proc?(method_name) # :nodoc:
+      method_name.nil? || (method_name.is_a?(Proc) && method_name.arity == 1)
+    end
+  end
+
+  ##
+  # Create an Attribute. The attribute can either be a String or a Symbol, and
+  # can also start with an "@", or not.
+  #
+  # @param [String, Symbol] attribute
+  #
+  # @param [String, Symbol, Proc, nil] reader_name
+  def initialize(attribute, reader_name = nil)
+    attribute.to_s.tap do |a|
+      @ivar = a.start_with?('@') ? a : "@#{a}"
+      @name = @ivar.delete_prefix('@')
+      @reader =
+        case reader_name
+        when Proc then reader_name.call(name)
+        when nil then "#{name}?"
+        else reader_name.to_s
+        end
+      @writer = "#{name}="
+    end
+  end
+end

data/lib/attribool/version.rb

@@ -9,19 +9,19 @@ module Attribool
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 0
+    MAJOR = 1
 
     ##
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 1
+    MINOR = 0
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 3
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
@@ -48,5 +48,9 @@ module Attribool
     end
   end
 
+  ##
+  # The version, as a string.
+  #
+  # @return [String]
   VERSION = Version.to_s.freeze
 end

data/lib/attribool.rb

@@ -1,39 +1,37 @@
 # frozen_string_literal: true
 
 require_relative 'attribool/version'
+require_relative 'attribool/attribute'
 
 ##
-# Adds macros and methods for dealing with boolean attributes.
+# Adds macros for dealing with boolean attributes.
 module Attribool
   ##
-  # Creates a method that returns a boolean for attributes that may or may
-  # not be booleans themselves.
+  # Creates methods that return a boolean for attributes that may or may not be
+  # booleans themselves. Multiple readers can be created at once
   #
-  # @param [Symbol, String] attribute
+  # @param [Symbol, String] *attributes
   #
-  # @kwarg [Boolean] allow_nil:
+  # @kwarg [Boolean] allow_nil
   #
-  # @kwarg [Lambda] condition:
+  # @kwarg [Proc] condition
   #
-  # @kwarg [Symbol, String] method:
-  #
-  # @kwarg [Symbol, String] prefix:
+  # @kwarg [Symbol, String, Proc] method_name
   def bool_reader(
-    attribute,
+    *attributes,
     allow_nil: true,
     condition: nil,
-    prefix: nil,
-    method: nil
+    method_name: nil
   )
-    attribute = attribute.to_s
-    attribute = attribute.start_with?('@') ? attribute : "@#{attribute}"
-    method ||= "#{attribute.delete_prefix('@')}?"
-    method = "#{prefix}_#{method}" if prefix
-    define_method(method) do
-      ivar = instance_variable_get(attribute)
-      raise TypeError, "#{attribute} is nil" if ivar.nil? && !allow_nil
+    Attribute.validate_method_name(method_name, attributes.size)
+
+    attributes.map { |a| Attribute.new(a, method_name) }.each do |attribute|
+      define_method(attribute.reader) do
+        value = instance_variable_get(attribute.ivar)
+        raise TypeError, "#{attribute.ivar} is nil" if value.nil? && !allow_nil
 
-      condition ? condition.call(ivar) : !!(ivar)
+        condition ? condition.call(value) : !!(value)
+      end
     end
   end
 
@@ -41,18 +39,18 @@ module Attribool
   # Creates a writer for boolean attributes. Always coerces to boolean based
   # on truthiness.
   #
-  # @param [Symbol, String] attribute
+  # @param [Symbol, String] *attributes
   #
-  # @kwarg [Boolean] strict:
-  def bool_writer(attribute, strict: false)
-    attribute = attribute.to_s
-    attribute = attribute.start_with?('@') ? attribute : "@#{attribute}"
-    define_method("#{attribute.delete_prefix('@')}=") do |v|
-      if strict && ![TrueClass, FalseClass].include?(v.class)
-        raise ArgumentError, 'Argument must be a boolean'
-      end
+  # @kwarg [Boolean] strict
+  def bool_writer(*attributes, strict: false)
+    attributes.map { |a| Attribute.new(a) }.each do |attribute|
+      define_method(attribute.writer) do |v|
+        if strict && ![TrueClass, FalseClass].include?(v.class)
+          raise ArgumentError, 'Argument must be a boolean'
+        end
 
-      instance_variable_set(attribute, !!v)
+        instance_variable_set(attribute.ivar, !!v)
+      end
     end
   end
 
@@ -60,9 +58,9 @@ module Attribool
   # Creates a simple reader and writer for booleans. This should only be used
   # when the attribute should only ever be +true+ or +false+.
   #
-  # @param [Symbol, String] attribute
-  def bool_accessor(attribute)
-    bool_reader(attribute)
-    bool_writer(attribute)
+  # @param [Symbol, String] *attributes
+  def bool_accessor(*attributes)
+    bool_reader(*attributes)
+    bool_writer(*attributes)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.3
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-21 00:00:00.000000000 Z
+date: 2022-01-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -79,6 +79,7 @@ files:
 - Rakefile
 - attribool.gemspec
 - lib/attribool.rb
+- lib/attribool/attribute.rb
 - lib/attribool/version.rb
 homepage: https://github.com/evanthegrayt/attribool
 licenses: