attribool 1.0.2 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 40de41768cc69a7a822e65934217e6695907f8e2aa0896cac72073d4d7ee8620
-  data.tar.gz: 26bcc326d49235611dda2d00a230c592c192a502c4f2215698931ce76a0af80f
+  metadata.gz: cee1c79ed2d93c1f4d77b14f42d59dfd7c805afe569d9e43c999484d552c64ff
+  data.tar.gz: becb227aebe9b9878f40b3a3de4a9737623a10f364d2788830f3b440524ce0fb
 SHA512:
-  metadata.gz: f236b203d01b2f4a916c2f96c3ecc61f04d361b406700e93997fb17f5d965fd04f550858fc65ea33e5345247c3d36651bcd04a13faf454259f474743e0232c7b
-  data.tar.gz: 0bd9e8337766c2c4b9bae8a9e32cb70b898c6bdd6826b042c72a6938344840754c07af30a5737007f2c317ccbc1b8f326e1fe7af04e2982dad5fbdcd21e99ccc
+  metadata.gz: 4904af389ad68348764f519eb058aaff66cb022dcc3de3d9f1ee3ce07b620eb08552bb9f03c9316943693370ed79131d11b91950433a4950bbdc4ce7619d34a4
+  data.tar.gz: 0f0d3622f6214668c8fa150d7e1b89ab828a803803aaa4707c25fd53b72a734d5e07f3ecc9d6d6a600c6e47522729ad0097da600065f76ad43fd6a2675efa203

data/Gemfile.lock

@@ -1,22 +1,52 @@
 PATH
   remote: .
   specs:
-    attribool (1.0.2)
+    attribool (2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.2)
     docile (1.3.5)
+    json (2.6.3)
+    language_server-protocol (3.17.0.2)
+    parallel (1.22.1)
+    parser (3.1.3.0)
+      ast (~> 2.4.1)
     power_assert (2.0.0)
+    rainbow (3.1.1)
     rake (13.0.3)
+    regexp_parser (2.6.1)
+    rexml (3.2.5)
+    rubocop (1.39.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.1.2.1)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.23.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.24.0)
+      parser (>= 3.1.1.0)
+    rubocop-performance (1.15.1)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    ruby-progressbar (1.11.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.2)
+    standard (1.19.1)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (= 1.39.0)
+      rubocop-performance (= 1.15.1)
     test-unit (3.4.0)
       power_assert
+    unicode-display_width (2.3.0)
 
 PLATFORMS
   ruby
@@ -25,6 +55,7 @@ DEPENDENCIES
   attribool!
   rake (~> 13.0, >= 13.0.1)
   simplecov
+  standard
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH

data/README.md

@@ -20,8 +20,6 @@ you'd like for your boolean method to be called `named?`, you can use
 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
@@ -32,7 +30,7 @@ You can read the documentation [here](https://evanthegrayt.github.io/attribool/)
 ## Installation
 #### Via Gemfile
 ```ruby
-gem 'attribool'
+gem "attribool"
 ```
 
 #### Via rubygems
@@ -50,24 +48,20 @@ bundle exec rake install
 ## Examples
 #### Standard bool_reader
 ```ruby
-require 'attribool'
+require "attribool"
 
 class Person
   extend Attribool
 
   attr_accessor :name
   bool_reader :name
-  # OR
-  # bool_reader :@name
-  # bool_reader 'name'
-  # bool_reader '@name'
 end
 
 person = Person.new
 person.name?
 # false, because @name is nil.
 
-person.name = 'John Smith'
+person.name = "John Smith"
 person.name
 # "John Smith"
 person.name?
@@ -76,7 +70,7 @@ person.name?
 
 #### A bool_reader with method name
 ```ruby
-require 'attribool'
+require "attribool"
 
 class Person
   extend Attribool
@@ -89,14 +83,14 @@ person = Person.new
 person.named?
 # false, because @name is nil.
 
-person.name = 'John Smith'
+person.name = "John Smith"
 person.named?
 # true, because @name is truthy.
 ```
 
 #### A bool_reader with method name and conditional
 ```ruby
-require 'attribool'
+require "attribool"
 
 class Person
   extend Attribool
@@ -119,9 +113,12 @@ person.adult?
 # true, because @age is greater than 18.
 ```
 
+Note that, the result of the proc will also be coerced into a boolean, so the
+condition can just return a truthy or falsey value.
+
 #### Assigning more than one bool_reader with a method name at once
 ```ruby
-require 'attribool'
+require "attribool"
 
 class Person
   extend Attribool
@@ -142,14 +139,14 @@ person.age = 10
 person.has_age?
 # true, because @age is not nil.
 
-person.name = 'Bob'
+person.name = "Bob"
 person.has_name?
 # true, because @name is not nil.
 ```
 
 #### Standard bool_accessor
 ```ruby
-require 'attribool'
+require "attribool"
 
 class Person
   extend Attribool
@@ -172,7 +169,7 @@ 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'
+require "attribool"
 
 class Person
   extend Attribool
@@ -185,9 +182,9 @@ person = Person.new
 person.living
 # nil
 
-person.living = 'blah'
+person.living = "blah"
 person.living
-# true, because 'blah' was coerced into a boolean because strings are truthy.
+# true, because "blah" was coerced into a boolean because strings are truthy.
 ```
 
 ## Reporting Bugs and Requesting Features

data/Rakefile

@@ -1,21 +1,21 @@
 # frozen_string_literal: true
 
-require_relative 'lib/attribool'
-require 'bundler/gem_tasks'
-require 'rdoc/task'
-require 'rake/testtask'
+require_relative "lib/attribool"
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs = ['lib']
+  t.libs = ["lib"]
   t.warning = true
   t.verbose = true
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'docs'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = "docs"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
 end
 
 task default: :test

data/attribool.gemspec

@@ -1,34 +1,34 @@
-require_relative 'lib/attribool/version'
+require_relative "lib/attribool/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'attribool'
-  spec.version       = Attribool::VERSION
-  spec.authors       = ['Evan Gray']
-  spec.email         = 'evanthegrayt@vivaldi.net'
-  spec.license       = 'MIT'
-  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.name = "attribool"
+  spec.version = Attribool::VERSION
+  spec.authors = ["Evan Gray"]
+  spec.email = "evanthegrayt@vivaldi.net"
+  spec.license = "MIT"
 
-  spec.summary       = %(Macros for creating boolean attribute methods)
-  spec.description   = %(Macros for creating boolean attribute methods)
-  spec.homepage      = 'https://github.com/evanthegrayt/attribool'
+  spec.summary = %(Macros for creating boolean attribute methods)
+  spec.description = %(Macros for creating boolean attribute methods)
+  spec.homepage = "https://github.com/evanthegrayt/attribool"
 
   unless spec.respond_to?(:metadata)
-    raise 'RubyGems 2.0 or newer is required to protect against ' \
-      'public gem pushes.'
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
   end
 
-  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/'
+  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/"
 
   spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = 'bin'
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
-  spec.add_development_dependency 'simplecov'
-  spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
+  spec.bindir = "bin"
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.5"
 end

data/lib/attribool/attribute.rb

@@ -1,62 +1,47 @@
-##
-# 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
+# frozen_string_literal: true
 
+module Attribool
   ##
-  # The name of the instance variable for the attribute, with the leading "@".
-  #
-  # @return [String]
-  attr_reader :ivar
+  # Abstraction for an attribute to determine its name, reader, writer, and
+  # instance variable name.
+  class Attribute
+    ##
+    # The name of the attribute, without the leading "@".
+    #
+    # @return [String]
+    attr_reader :name
 
-  ##
-  # The name of the reader for the attribute.
-  #
-  # @return [String]
-  attr_reader :reader
+    ##
+    # The name of the instance variable for the attribute, with the leading "@".
+    #
+    # @return [String]
+    attr_reader :ivar
 
-  ##
-  # The name of the writer for the attribute.
-  #
-  # @return [String]
-  attr_reader :writer
+    ##
+    # The name of the reader for the attribute.
+    #
+    # @return [String]
+    attr_reader :reader
 
-  ##
-  # 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
+    ##
+    # The name of the writer for the attribute.
+    #
+    # @return [String]
+    attr_reader :writer
 
-  ##
-  # 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}="
+    ##
+    # Create an Attribute. The attribute can either be a String or a Symbol.
+    #
+    # @param [String, Symbol] attribute
+    #
+    # @param [String, Symbol, Proc, nil] reader_name
+    def initialize(attribute, reader_name = nil)
+      attribute.to_s.then do |a|
+        @name = a
+        @ivar = "@#{a}"
+        @reader = Attribool::ReaderName.new(name, reader_name).to_s
+        @writer = "#{name}="
+      end
     end
   end
 end

data/lib/attribool/attribute_list.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Attribool
+  ##
+  # Enumerable class that generates a list of attributes from a list of strings
+  # or symbols.
+  class AttributeList
+    include Enumerable
+
+    ##
+    # Generate the list.
+    #
+    # @param [String, Symbol] *attributes
+    #
+    # @kwarg [nil, String, Symbol, Proc] method_name
+    def initialize(*attributes, method_name: nil)
+      @entries = attributes.map { |a| Attribool::Attribute.new(a, method_name) }
+    end
+
+    ##
+    # Yield every entry in the list to a block.
+    #
+    # @param [block] &block
+    #
+    # @return [Enumerable]
+    def each(&block)
+      @entries.each(&block)
+    end
+  end
+end

data/lib/attribool/reader_name.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Attribool
+  ##
+  # Abstraction of a reader's method name.
+  class ReaderName
+    ##
+    # Instantiate new instance of ReaderName.
+    #
+    # @param [String, Syumbol] attribute
+    #
+    # @param [proc, nil, String, Symbol] name
+    def initialize(attribute, name)
+      @attribute = attribute
+      @name = name
+    end
+
+    ##
+    # Convert instance to a string.
+    #
+    # @return [String]
+    def to_s
+      case @name
+      when Proc then @name.call(@attribute)
+      when nil then "#{@attribute}?"
+      else @name.to_s
+      end
+    end
+  end
+end

data/lib/attribool/validators/method_name_validator.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Attribool::Validators
+  ##
+  # Ensures that if multiple attributes are being defined, and +method_name+
+  # is provided, that +method_name+ is a +Proc+.
+  class MethodNameValidator < Attribool::Validators::Validator
+    def initialize(method_name, number_of_attributes)
+      @method_name = method_name
+      @number_of_attributes = number_of_attributes
+      super
+    end
+
+    def valid?
+      @number_of_attributes == 1 || nil_or_proc?
+    end
+
+    def error
+      ArgumentError.new("Must use a Proc when creating multiple methods")
+    end
+
+    private
+
+    def nil_or_proc? # :nodoc:
+      @method_name.nil? || (@method_name.is_a?(Proc) && @method_name.arity == 1)
+    end
+  end
+end

data/lib/attribool/validators/nil_attribute_validator.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Attribool::Validators
+  class NilAttributeValidator < Attribool::Validators::Validator
+    def initialize(ivar, value, allow_nil)
+      @ivar = ivar
+      @value = value
+      @allow_nil = allow_nil
+      super
+    end
+
+    def valid?
+      @allow_nil || !@value.nil?
+    end
+
+    def error
+      TypeError.new("#{@ivar} is nil")
+    end
+  end
+end

data/lib/attribool/validators/strict_boolean_validator.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Attribool::Validators
+  class StrictBooleanValidator < Attribool::Validators::Validator
+    def initialize(value, strict)
+      @value = value
+      @strict = strict
+      super
+    end
+
+    def valid?
+      !@strict || [TrueClass, FalseClass].include?(@value.class)
+    end
+
+    def error
+      ArgumentError.new("#{@value} is not a boolean")
+    end
+  end
+end

data/lib/attribool/validators/validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Attribool::Validators
+  class Validator
+    def self.validate(*args)
+      new(*args).validate
+    end
+
+    def initialize(*)
+      raise "#{self.class} is an abstract class" if base_class?
+    end
+
+    def validate
+      valid? || raise(error)
+    end
+
+    def valid?
+      raise NoMethodError, "Validator must implement `valid?'"
+    end
+
+    def error
+      raise NoMethodError, "Validator must implement `error'"
+    end
+
+    private
+
+    def base_class?
+      instance_of?(Attribool::Validators::Validator)
+    end
+  end
+end

data/lib/attribool/version.rb

@@ -9,7 +9,7 @@ module Attribool
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 1
+    MAJOR = 2
 
     ##
     # Minor version.
@@ -21,13 +21,15 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 2
+    PATCH = 0
+
+    module_function
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
     #
     # @return [Array]
-    def self.to_a
+    def to_a
       [MAJOR, MINOR, PATCH]
     end
 
@@ -35,15 +37,15 @@ module Attribool
     # Version as +MAJOR.MINOR.PATCH+
     #
     # @return [String]
-    def self.to_s
-      to_a.join('.')
+    def to_s
+      to_a.join(".")
     end
 
     ##
     # Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+
     #
     # @return [Hash]
-    def self.to_h
+    def to_h
       %i[major minor patch].zip(to_a).to_h
     end
   end

data/lib/attribool.rb

@@ -1,10 +1,32 @@
 # frozen_string_literal: true
 
-require_relative 'attribool/version'
-require_relative 'attribool/attribute'
+require_relative "attribool/version"
+require_relative "attribool/attribute"
+require_relative "attribool/reader_name"
+require_relative "attribool/attribute_list"
+require_relative "attribool/validators/validator"
+require_relative "attribool/validators/method_name_validator"
+require_relative "attribool/validators/nil_attribute_validator"
+require_relative "attribool/validators/strict_boolean_validator"
 
 ##
 # Adds macros for dealing with boolean attributes.
+#
+# @example
+#   require "attribool"
+#   class Person
+#     extend Attribool
+#     attr_accessor :name
+#     bool_reader :name
+#   ends
+#   person = Person.new
+#   person.name?
+#   # false, because @name is nil.
+#   person.name = "John Smith"
+#   person.name
+#   # "John Smith"
+#   person.name?
+#   # true, because @name is truthy.
 module Attribool
   ##
   # Creates methods that return a boolean for attributes that may or may not be
@@ -17,20 +39,16 @@ module Attribool
   # @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)
+  def bool_reader(*attributes, allow_nil: true, method_name: nil, condition: nil)
+    Validators::MethodNameValidator.validate(method_name, attributes.size)
 
-    attributes.map { |a| Attribute.new(a, method_name) }.each do |attribute|
+    AttributeList.new(*attributes, method_name: 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
+        instance_variable_get(attribute.ivar).then do |value|
+          Validators::NilAttributeValidator.validate(attribute.ivar, value, allow_nil)
 
-        condition ? condition.call(value) : !!(value)
+          !!(condition ? condition.call(value) : value)
+        end
       end
     end
   end
@@ -43,13 +61,11 @@ module Attribool
   #
   # @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
+    AttributeList.new(*attributes).each do |attribute|
+      define_method(attribute.writer) do |value|
+        Validators::StrictBooleanValidator.validate(value, strict)
 
-        instance_variable_set(attribute.ivar, !!v)
+        instance_variable_set(attribute.ivar, !!value)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 1.0.2
+  version: 2.0.0
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-27 00:00:00.000000000 Z
+date: 2022-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -44,6 +44,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement
@@ -80,6 +94,12 @@ files:
 - attribool.gemspec
 - lib/attribool.rb
 - lib/attribool/attribute.rb
+- lib/attribool/attribute_list.rb
+- lib/attribool/reader_name.rb
+- lib/attribool/validators/method_name_validator.rb
+- lib/attribool/validators/nil_attribute_validator.rb
+- lib/attribool/validators/strict_boolean_validator.rb
+- lib/attribool/validators/validator.rb
 - lib/attribool/version.rb
 homepage: https://github.com/evanthegrayt/attribool
 licenses:
@@ -104,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Macros for creating boolean attribute methods