attribool 0.0.2 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 04a8612ea59018c8c1ace211692e9100676136ac77613627b8e8b0b295cf3bae
-  data.tar.gz: fe39cccfee3277bd92028940a54313e10861445a1b486d4791942875a3cb918a
+  metadata.gz: e18815dc8107a42c84084e2c35614d8111f7ae827224b4b78cbb3e920ff9c970
+  data.tar.gz: 84642d3baca03e19bf84794ed88f2696d1f639801b79f55cd9fc2636309f8061
 SHA512:
-  metadata.gz: 762bd93ec17802176022253614871443f0e388892558d455b697b90e69d26be00917f6cd5b803f105e6ace168985e85a4c14305059e92886500bbb3f035efcff
-  data.tar.gz: 1b125fffc61d42dc9a8b63b77b625f57786ca03c44a2045a7bb1685bb5ea1d6c8e36ffa5fa6104b14fde943e79bedcfb8d5b92da88a59c1b0dd1f692b67098d2
+  metadata.gz: 3984a29d0285e92995b01d36ba9fbe0fe4919b9800116bff642ff5e7f0ee8e3fe1c4444a5bb1f3494f87e41228c31b4f0a7eec086ae3f3e5f07f255a5943ba41
+  data.tar.gz: 68246fd9004eb745078a8399ee4dc160ba2b06535a12fad81173958053c738c523fe5df152e266e2103e74f84715f9ca0bb309726eb30159e313f45efd9a8761

data/.github/workflows/ruby.yml

@@ -1,3 +1,10 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
 name: Ruby
 
 on:
@@ -10,15 +17,19 @@ jobs:
   test:
 
     runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
 
     steps:
     - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
       with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install
-        bundle exec rake test
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    attribool (0.0.1)
+    attribool (1.0.0)
 
 GEM
   remote: https://rubygems.org/
@@ -28,4 +28,4 @@ DEPENDENCIES
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH
-   2.1.4
+   2.2.17

data/README.md

@@ -3,22 +3,26 @@
 [![Gem Version](https://badge.fury.io/rb/attribool.svg)](https://badge.fury.io/rb/attribool)
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
-> Pre-release version. Everything works, but not everything is documented.
-
 Ruby macros for creating boolean methods for attributes that may or may not be
-booleans themselves. This is done via coercion based on truthiness. 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.
+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
-more sense.  Using the same example, as above, if your attribute is `@name`, but
+[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.
 
+The first argument is always the instance variable to check for truthiness.
+Because of this, it is also valid syntax to use `bool_reader :@name`, if it
+makes more sense to you.
+
 Macros also exist for `bool_writer` and `bool_accessor`. When a writer
 method is defined, the value will always be coerced into a boolean before
 setting the attribute.
@@ -49,10 +53,14 @@ bundle exec rake install
 require 'attribool'
 
 class Person
-  include Attribool
+  extend Attribool
 
   attr_accessor :name
   bool_reader :name
+  # OR
+  # bool_reader :@name
+  # bool_reader 'name'
+  # bool_reader '@name'
 end
 
 person = Person.new
@@ -66,26 +74,23 @@ person.name?
 # true, because @name is truthy.
 ```
 
-#### A bool_reader with method name or prefix
+#### A bool_reader with method name
 ```ruby
 require 'attribool'
 
 class Person
-  include Attribool
+  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.
 ```
 
@@ -94,11 +99,11 @@ person.has_name?
 require 'attribool'
 
 class Person
-  include Attribool
+  extend Attribool
 
   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
@@ -114,12 +119,40 @@ 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'
 
 class Person
-  include Attribool
+  extend Attribool
 
   bool_accessor :living
 end
@@ -134,6 +167,29 @@ person.living?
 # Be aware -- if you pass anything truthy, it will be coerced to true!
 ```
 
+#### Standard bool_writer
+In most cases where you'd use a `bool_writer`, you'd probably want to just use
+`bool_accessor`. This example is to show that, even when using `bool_accessor`,
+the value is coerced to a boolean when the value is set by `bool_writer`.
+```ruby
+require 'attribool'
+
+class Person
+  extend Attribool
+
+  attr_reader :living
+  bool_writer :living
+end
+
+person = Person.new
+person.living
+# nil
+
+person.living = 'blah'
+person.living
+# true, because 'blah' was coerced into a boolean because strings are truthy.
+```
+
 ## Reporting Bugs and Requesting Features
 If you have an idea or find a bug, please [create an
 issue](https://github.com/evanthegrayt/attribool/issues/new). Just make sure
@@ -144,4 +200,4 @@ Request.
 I do these projects for fun, and I enjoy knowing that they're helpful to people.
 Consider starring [the repository](https://github.com/evanthegrayt/attribool)
 if you like it! If you love it, follow me [on
-Github](https://github.com/evanthegrayt)!
+GitHub](https://github.com/evanthegrayt)!

data/attribool.gemspec

@@ -2,7 +2,7 @@ require_relative 'lib/attribool/version'
 
 Gem::Specification.new do |spec|
   spec.name          = 'attribool'
-  spec.version       = Attribool::Version.to_s
+  spec.version       = Attribool::VERSION
   spec.authors       = ['Evan Gray']
   spec.email         = 'evanthegrayt@vivaldi.net'
   spec.license       = 'MIT'

data/lib/attribool/attribute.rb

@@ -0,0 +1,62 @@
+##
+# 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
+
+  ##
+  # 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 self.validate_method_name(number_of_attributes, method_name)
+    if number_of_attributes > 1 && method_name && !method_name.is_a?(Proc)
+      raise ArgumentError, "Must use a Proc when creating multiple methods"
+    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,7 +9,7 @@ module Attribool
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 0
+    MAJOR = 1
 
     ##
     # Minor version.
@@ -21,14 +21,36 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 2
+    PATCH = 1
+
+    ##
+    # Version as +[MAJOR, MINOR, PATCH]+
+    #
+    # @return [Array]
+    def self.to_a
+      [MAJOR, MINOR, PATCH]
+    end
 
     ##
     # Version as +MAJOR.MINOR.PATCH+
     #
     # @return [String]
     def self.to_s
-      "#{MAJOR}.#{MINOR}.#{PATCH}"
+      to_a.join('.')
+    end
+
+    ##
+    # Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+
+    #
+    # @return [Hash]
+    def self.to_h
+      %i[major minor patch].zip(to_a).to_h
     end
   end
+
+  ##
+  # The version, as a string.
+  #
+  # @return [String]
+  VERSION = Version.to_s.freeze
 end

data/lib/attribool.rb

@@ -1,70 +1,66 @@
 # 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
-  def self.included(klass) # :nodoc:
-    klass.extend(ClassMethods)
-  end
-
   ##
-  # Class methods to be added to the class when included.
-  module ClassMethods
-    ##
-    # Creates a method that returns a boolean for attributes that may or may
-    # not be booleans themselves.
-    #
-    # @param [Symbol, String] attribute
-    #
-    # @kwarg [Boolean] allow_nil:
-    #
-    # @kwarg [Lambda] condition:
-    #
-    # @kwarg [Symbol, String] method:
-    #
-    # @kwarg [Symbol, String] prefix:
-    def bool_reader(
-      attribute,
-      allow_nil: true,
-      condition: nil,
-      prefix: nil,
-      method: nil
-    )
-      method ||= "#{attribute}?"
-      method = "#{prefix}_#{method}" if prefix
-      define_method(method) do
-        ivar = instance_variable_get("@#{attribute}")
-        raise TypeError, "#{attribute} is nil" if ivar.nil? && !allow_nil
+  # 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] *attributes
+  #
+  # @kwarg [Boolean] allow_nil
+  #
+  # @kwarg [Proc] condition
+  #
+  # @kwarg [Symbol, String, Proc] method_name
+  def bool_reader(
+    *attributes,
+    allow_nil: true,
+    condition: nil,
+    method_name: nil
+  )
+    Attribute.validate_method_name(attributes.size, method_name)
 
-        condition ? condition.call(ivar) : !!(ivar)
+    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(value) : !!(value)
       end
     end
+  end
 
-    ##
-    # Creates a writer for boolean attributes. Always coerces to boolean based
-    # on truthiness.
-    #
-    # @param [Symbol, String] attribute
-    #
-    # @kwarg [Boolean] strict:
-    def bool_writer(attribute, strict: false)
-      define_method("#{attribute}=") do |v|
+  ##
+  # Creates a writer for boolean attributes. Always coerces to boolean based
+  # on truthiness.
+  #
+  # @param [Symbol, String] *attributes
+  #
+  # @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
 
-    ##
-    # 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)
-    end
+  ##
+  # 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] *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.0.2
+  version: 1.0.1
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2022-01-27 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: