attribool 0.0.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 469b94667c5be65a2901c9049f8290711c823fc7d08226140471c4c8820e66df
-  data.tar.gz: 526c90658fc7f1ac712383083a5c38ced3088f3ed91fc32af3a6801e7c0352cc
+  metadata.gz: dc735929535da353af1b584656aafb3ba6ba46b7996af32ae37dedc30bcfb0a2
+  data.tar.gz: 116a6a7fd8f9803773d10a6fff0b294f73bb9f5eb872db573f11273f8fc1ddcb
 SHA512:
-  metadata.gz: 90be0ebf1c939bf765d0dd3848cf273b00606d4e00335418b1fc44de239ffb5f2042032525a22f9b205b9b10b6ff71126ba0a3c01449d2957fe328f4be354359
-  data.tar.gz: 48dbb1b70a57413523a962d29432343e5c7117f06ceae8063a7de1a5306595bab5f469db638a25bed1074efee037982e4a776c75334168e9d6e0064359e9e240
+  metadata.gz: 73fc2ab7f625fdfbb7577cda39c60eb86f6f53511fa685b2c0b86a79c90d22876123fcd34db74a76deb25eabc223cf891964fac36f962732af87a0c0c9aabcb0
+  data.tar.gz: ec6dc2496637c4c21c3c252a4c02fa1d574b4e4e033b74bd9019d5a8c286febba0990cd6d5659cc15be20b6a6c6dc3428f23a8bcb11ded8ed6a884403f78f682

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# 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:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+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
+    # 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: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -1,2 +1,3 @@
 attribool-*.gem
 coverage/*
+docs/*

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

@@ -1,22 +1,34 @@
 # Attribool
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fevanthegrayt%2Fattribool%2Fbadge%3Fref%3Dmaster&style=flat)](https://actions-badge.atrox.dev/evanthegrayt/attribool/goto?ref=master)
+[![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)
+
 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.
 
+You can read the documentation [here](https://evanthegrayt.github.io/attribool/).
+
 ## Installation
 #### Via Gemfile
 ```ruby
@@ -45,6 +57,10 @@ class Person
 
   attr_accessor :name
   bool_reader :name
+  # OR
+  # bool_reader :@name
+  # bool_reader 'name'
+  # bool_reader '@name'
 end
 
 person = Person.new
@@ -58,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'
 
@@ -66,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.
 ```
 
@@ -90,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
@@ -106,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'
@@ -123,5 +164,40 @@ person.living?
 person.living = true
 person.living?
 # true, because @living is true.
-# Be aware -- if you pass a string, it will be coerced to true!
+# 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
+the topic doesn't already exist. Better yet, you can always submit a Pull
+Request.
+
+## Self-Promotion
+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)!

data/Rakefile

@@ -14,7 +14,7 @@ end
 
 RDoc::Task.new do |rdoc|
   rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'doc'
+  rdoc.rdoc_dir = 'docs'
   rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
 end
 

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'
@@ -19,10 +19,8 @@ Gem::Specification.new do |spec|
 
   spec.metadata['allowed_push_host'] = 'https://rubygems.org'
   spec.metadata['homepage_uri'] = spec.homepage
-  spec.metadata['source_code_uri'] =
-    'https://github.com/evanthegrayt/attribool'
-  spec.metadata['documentation_uri'] =
-    'https://evanthegrayt.github.io/attribool/doc/index.html'
+  spec.metadata['source_code_uri'] = 'https://github.com/evanthegrayt/attribool'
+  spec.metadata['documentation_uri'] = 'https://evanthegrayt.github.io/attribool/'
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})

data/lib/attribool/attribute.rb

@@ -0,0 +1,10 @@
+class Attribool::Attribute
+  attr_reader :name
+  attr_reader :ivar
+
+  def initialize(attribute)
+    attribute = attribute.to_s
+    @ivar = attribute.start_with?('@') ? attribute : "@#{attribute}"
+    @name = @ivar.delete_prefix('@')
+  end
+end

data/lib/attribool/method_name.rb

@@ -0,0 +1,18 @@
+class Attribool::MethodName
+  attr_reader :name
+
+  def self.validate(method_name, number_of_attributes)
+    if number_of_attributes > 1 && method_name && !method_name.is_a?(Proc)
+      raise ArgumentError, "Must use a Proc when creating multiple methods"
+    end
+  end
+
+  def initialize(attribute, method_name)
+    @name =
+      case method_name
+      when Proc then method_name.call(attribute)
+      when nil then "#{attribute}?"
+      else method_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,32 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 1
+    PATCH = 0
+
+    ##
+    # 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
+
+  VERSION = Version.to_s.freeze
 end

data/lib/attribool.rb

@@ -1,96 +1,66 @@
 # frozen_string_literal: true
 
+require_relative 'attribool/version'
+require_relative 'attribool/method_name'
+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)
-    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
-
-        condition ? condition.call(ivar) : to_boolean(ivar)
-      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|
-        validate_boolean(v) if strict
+  # 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
+  )
+    MethodName.validate(method_name, attributes.size)
+    attributes.map { |a| Attribute.new(a) }.each do |attribute|
+      define_method(MethodName.new(attribute.name, method_name).name) do
+        value = instance_variable_get(attribute.ivar)
+        raise TypeError, "#{attribute.ivar} is nil" if value.nil? && !allow_nil
 
-        instance_variable_set("@#{attribute}", to_boolean(v))
+        condition ? condition.call(value) : !!(value)
       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
   end
 
   ##
-  # Is the argument a boolean?
+  # Creates a writer for boolean attributes. Always coerces to boolean based
+  # on truthiness.
   #
-  # @param [Object] attribute
+  # @param [Symbol, String] *attributes
   #
-  # @return [Boolean]
-  def boolean?(attribute)
-    [TrueClass, FalseClass].include?(attribute.class)
-  end
+  # @kwarg [Boolean] strict
+  def bool_writer(*attributes, strict: false)
+    attributes.map { |a| Attribute.new(a) }.each do |attribute|
+      define_method("#{attribute.name}=") do |v|
+        if strict && ![TrueClass, FalseClass].include?(v.class)
+          raise ArgumentError, 'Argument must be a boolean'
+        end
 
-  ##
-  # Converts an Object to a boolean.
-  #
-  # @param [Object] attribute
-  #
-  # @return [Boolean]
-  def to_boolean(attribute)
-    !!attribute
+        instance_variable_set(attribute.ivar, !!v)
+      end
+    end
   end
 
-  private
-
   ##
-  # Raises if argument is not a boolean.
-  def validate_boolean(attribute) # :nodoc:
-    raise ArgumentError, 'Argument must be a boolean' unless boolean?(attribute)
+  # 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.1
+  version: 1.0.0
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-22 00:00:00.000000000 Z
+date: 2022-01-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -70,6 +70,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ruby.yml"
 - ".gitignore"
 - Gemfile
 - Gemfile.lock
@@ -78,6 +79,8 @@ files:
 - Rakefile
 - attribool.gemspec
 - lib/attribool.rb
+- lib/attribool/attribute.rb
+- lib/attribool/method_name.rb
 - lib/attribool/version.rb
 homepage: https://github.com/evanthegrayt/attribool
 licenses:
@@ -86,7 +89,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/evanthegrayt/attribool
   source_code_uri: https://github.com/evanthegrayt/attribool
-  documentation_uri: https://evanthegrayt.github.io/attribool/doc/index.html
+  documentation_uri: https://evanthegrayt.github.io/attribool/
 post_install_message:
 rdoc_options: []
 require_paths: