attribool 0.0.3 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0939b1cbdb170d795d5e99a9a2c353ccd2105b248f941b84638a7892e2ff8508'
-  data.tar.gz: 9c446507b88ab93596f6d6f52a3717dfdf03a771885a9681b835e8e4e62cb050
+  metadata.gz: f04da5ae0d24a9e980b51a244c7d83ab90b6f4b3d288a49ab069397be78fe3d4
+  data.tar.gz: 5145d0dea86d0341d5bdbb64ae240647caca668eca6f72122bb1cf831a273ef3
 SHA512:
-  metadata.gz: feb26783987ea4569a324f461879f5e63908fc85a56438da1d0f252bd4e091f31daa45ec04a4089919e8bd0ab9d0fd2fa4f6e60d1b9d175b4fb9a7819e13e262
-  data.tar.gz: 7ad52201e1f77310a09661ce11f29d1486ab935ecc02181bc69c6d349f6aa14482b6cf99e388c23c06ce9b50741ad2cc0b646b8ffbe72bbccfaa0b21614b9dd8
+  metadata.gz: c048e38a1a380785c5fdb7198913cb2aa686ea47f955ab649e004cf77e8e3fea08be1857a3d89e3da3647d788b0944cffceabdbbf0a5b85db560949426e60525
+  data.tar.gz: 3f522acba694671f5e8d7bf4a12221d9ac1edef9e538bf943683119c9346a68340550bee719db1167a9104ced50d9b2869e89245ec820ee5c4bae6542a6f00a2

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.3)
+    attribool (0.1.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -3,22 +3,25 @@
 [![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 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.
 
 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
+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?`.
 [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 +52,12 @@ bundle exec rake install
 require 'attribool'
 
 class Person
-  include Attribool
+  extend Attribool
 
   attr_accessor :name
   bool_reader :name
+  # OR
+  bool_reader :@name
 end
 
 person = Person.new
@@ -71,7 +76,7 @@ person.name?
 require 'attribool'
 
 class Person
-  include Attribool
+  extend Attribool
 
   attr_accessor :name
   bool_reader :name, method: :named?
@@ -94,7 +99,7 @@ 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.
@@ -119,7 +124,7 @@ person.adult?
 require 'attribool'
 
 class Person
-  include Attribool
+  extend Attribool
 
   bool_accessor :living
 end
@@ -134,6 +139,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 +172,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/version.rb

@@ -15,20 +15,38 @@ module Attribool
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 0
+    MINOR = 1
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 3
+    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,70 +1,68 @@
 # frozen_string_literal: true
 
+require_relative 'attribool/version'
+
 ##
 # Adds macros and methods 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 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
+  )
+    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
 
-        condition ? condition.call(ivar) : !!(ivar)
-      end
+      condition ? condition.call(ivar) : !!(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|
-        if strict && ![TrueClass, FalseClass].include?(v.class)
-          raise ArgumentError, 'Argument must be a boolean'
-        end
-
-        instance_variable_set("@#{attribute}", !!v)
+  ##
+  # 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)
+    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
-    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)
+      instance_variable_set(attribute, !!v)
     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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.1.0
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 2021-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake