attribool 2.0.1 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f70889d0edf2407bfaee163da31ab791d35bea5921024e54fbab658792c81d46
-  data.tar.gz: 0ed3735087e12402627c1773564efa42e2710696d9e932dcd5073a369cf0f6d8
+  metadata.gz: 63c34a661a7575ad39598073bbfc995f6e18d822c9587ee4cf9b28ed6ead7d96
+  data.tar.gz: 4d3b761b8ed920a44e145727e7d07eb6d2fa2c22ea0b0d91d24569248362f03a
 SHA512:
-  metadata.gz: df790e07a5164be0da050dce51747bfa73a5884637304854706ffc5948347fc4faf3cb300a8cef35849b3ad65f145813ee8dc3a98fde5234fb8fb0fd7c493a36
-  data.tar.gz: b6740fa6386e012e9a39040abde54e9e091f194ac3c1b7bc1a4127d72cd4eff829b27d76a1ee1c34e507330dfcb0804555d7aba98980608851b7e4ccf6522f88
+  metadata.gz: 927ecdcc2b35fa4448beda19e02c968441cd858933bfdbcb261b11e494e5a46676b9c36e17f61e9f4f9400f6af547662b84d11b28c17df664a710a840595ed79
+  data.tar.gz: d7a9895258e80fb76ba7eee27a8af15b16cef705097bbc2a1a77d459c100f3a54b52c3127251455308a5aa2f744a0e0596b802b24792c6e0ef0ff9d0ea2f1b95

data/Gemfile.lock

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

data/lib/attribool/attribute_list.rb

@@ -8,13 +8,24 @@ module Attribool
     include Enumerable
 
     ##
-    # Generate the list.
+    # Create an +AttributeList+ from a list of attribute names.
     #
-    # @param [String, Symbol] *attributes
+    # @param [String, Symbol] *attribute_names
     #
     # @kwarg [nil, String, Symbol, Proc] method_name
-    def initialize(*attributes, method_name: nil)
-      @entries = attributes.map { |a| Attribool::Attribute.new(a, method_name) }
+    #
+    # @return [AttributeList]
+    def self.build(*attribute_names, method_name: nil)
+      new(*attribute_names.map { |a| Attribool::Attribute.new(a, method_name) })
+    end
+
+    ##
+    # Construct the list.
+    #
+    # @param [String, Symbol] *attributes
+    def initialize(*attributes)
+      ValidatorService.call(:attribute_list, *attributes)
+      @entries = attributes
     end
 
     ##

data/lib/attribool/validator_service.rb

@@ -1,17 +1,38 @@
 # frozen_string_literal: true
 
 module Attribool
+  ##
+  # A simple interface to run validators, which should implement a +valid?+
+  # method which returns true if conditions are valid, and an +error+ method
+  # which returns an exception class and message to be raised when validations
+  # fail.
   class ValidatorService
-    def self.call(validator, *args)
-      new(validator, *args).validate
+    ##
+    # Run the validator.
+    #
+    # @param [Symbol] validator_name
+    #
+    # @param [Object] *args to be forwarded to validator
+    def self.call(validator_name, *args)
+      new(::Attribool::Validators.fetch(validator_name), *args).validate
     end
 
+    ##
+    # Construct the service and inject the validator.
+    #
+    # @param [Class] Validator
+    #
+    # @param [Object] *args
     def initialize(validator, *args)
-      @validator = ::Attribool::Validators.const_get(
-        "#{validator.to_s.split("_").map(&:capitalize).join}Validator"
-      ).new(*args)
+      @validator = validator.new(*args)
     end
 
+    ##
+    # Raises the validator's exception unless its conditions are met.
+    #
+    # @return [Boolean]
+    #
+    # @raise [Exception] if validation fails
     def validate
       @validator.valid? || raise(@validator.error)
     end

data/lib/attribool/validators/attribute_list_validator.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Attribool::Validators
+  ##
+  # Ensures that every item is an instance of +Attribool::Attribute+.
+  class AttributeListValidator
+    ##
+    # Construct the validator.
+    #
+    # @param [Attribool::Attribute] *items
+    def initialize(*items)
+      @items = items
+    end
+
+    ##
+    # Are all items an instance of +Attribool::Attribute+?
+    #
+    # @return [Boolean]
+    def valid?
+      @items.all?(Attribool::Attribute)
+    end
+
+    ##
+    # The exception to raise if validations fail.
+    #
+    # @return [TypeError] the exception with message
+    def error
+      TypeError.new("All items must be an instance of Attribool::Attribute")
+    end
+  end
+end

data/lib/attribool/validators/condition_validator.rb

@@ -1,15 +1,29 @@
 # frozen_string_literal: true
 
 module Attribool::Validators
+  ##
+  # Ensures that a condition is either +nil+ or a +Proc+.
   class ConditionValidator
+    ##
+    # Construct the validator.
+    #
+    # @param [nil, Proc] condition
     def initialize(condition)
       @condition = condition
     end
 
+    ##
+    # Is the condition either +nil+ or a +Proc+?
+    #
+    # @return [Boolean]
     def valid?
       @condition.nil? || @condition.is_a?(Proc)
     end
 
+    ##
+    # The exception to raise if validations fail.
+    #
+    # @return [ArgumentError] the exception with message
     def error
       ArgumentError.new("Condition is not a proc")
     end

data/lib/attribool/validators/method_name_validator.rb

@@ -5,15 +5,25 @@ module Attribool::Validators
   # Ensures that if multiple attributes are being defined, and +method_name+
   # is provided, that +method_name+ is a +Proc+.
   class MethodNameValidator
+    ##
+    # Construct the validator.
+    #
+    # @param [Attribool::Attribute] *items
     def initialize(method_name, number_of_attributes)
       @method_name = method_name
       @number_of_attributes = number_of_attributes
     end
 
+    ##
+    # Is there either one attribute, or is +method_name+ +nil+ or a +Proc+?
     def valid?
       @number_of_attributes == 1 || nil_or_proc?
     end
 
+    ##
+    # The exception to raise if validations fail.
+    #
+    # @return [ArgumentError] the exception with message
     def error
       ArgumentError.new("Must use a Proc when creating multiple methods")
     end

data/lib/attribool/validators/nil_attribute_validator.rb

@@ -1,17 +1,35 @@
 # frozen_string_literal: true
 
 module Attribool::Validators
+  ##
+  # Ensures that a value is not +nil+, unless +nil+ is allowed as a value.
   class NilAttributeValidator
+    ##
+    # Construct the validator.
+    #
+    # @param [String, Symbol] ivar
+    #
+    # @param [Object] value
+    #
+    # @param [Boolean] allow_nil
     def initialize(ivar, value, allow_nil)
       @ivar = ivar
       @value = value
       @allow_nil = allow_nil
     end
 
+    ##
+    # Do we either allow values to be +nil+, or is the value not +nil+?
+    #
+    # @return [Boolean]
     def valid?
       @allow_nil || !@value.nil?
     end
 
+    ##
+    # The exception to raise if validations fail.
+    #
+    # @return [TypeError] the exception with message
     def error
       TypeError.new("#{@ivar} is nil")
     end

data/lib/attribool/validators/strict_boolean_validator.rb

@@ -1,16 +1,32 @@
 # frozen_string_literal: true
 
 module Attribool::Validators
+  ##
+  # Ensures that a value is a boolean, unless strictness isn't enforced.
   class StrictBooleanValidator
+    ##
+    # Construct the validator.
+    #
+    # @param [Object] value
+    #
+    # @param [Boolean] strict
     def initialize(value, strict)
       @value = value
       @strict = strict
     end
 
+    ##
+    # Is +strict+ set to +false+, or is +@value+ a boolean?
+    #
+    # @return [Boolean]
     def valid?
       !@strict || [TrueClass, FalseClass].include?(@value.class)
     end
 
+    ##
+    # The exception to raise if validations fail.
+    #
+    # @return [ArgumentError] the exception with message
     def error
       ArgumentError.new("#{@value} is not a boolean")
     end

data/lib/attribool/validators.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Attribool
+  ##
+  # Namespace for Validators. Also provides a method for fetching a validator.
+  module Validators
+    module_function
+
+    ##
+    # Fetches a Validator class.
+    #
+    # @param [String, Symbol] validator_name
+    #
+    # @return [Class]
+    #
+    # @example
+    #   Attribool::Validators.fetch(:nil_attribute)
+    #   # => NilAttributeValidator
+    def fetch(validator_name)
+      const_get(
+        "#{validator_name.to_s.split("_").map(&:capitalize).join}Validator"
+      )
+    end
+  end
+end

data/lib/attribool/value.rb

@@ -1,13 +1,25 @@
 # frozen_string_literal: true
 
 module Attribool
+  ##
+  # An abstraction of any class that can convert itself to a boolean.
   class Value
+    ##
+    # Construct the value with an optional +Proc+ condition.
+    #
+    # @param [Object] value
+    #
+    # @param [Proc] condition (default: nil)
     def initialize(value, condition = nil)
       ValidatorService.call(:condition, condition)
       @value = value
       @condition = condition
     end
 
+    ##
+    # Convert the value or the condition to a boolean based off truthiness.
+    #
+    # @return [Boolean]
     def to_boolean
       !!(@condition ? @condition.call(@value) : @value)
     end

data/lib/attribool/version.rb

@@ -21,14 +21,14 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 1
+    PATCH = 3
 
     module_function
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
     #
-    # @return [Array]
+    # @return [Array<Integer>]
     def to_a
       [MAJOR, MINOR, PATCH]
     end

data/lib/attribool.rb

@@ -3,6 +3,7 @@
 require_relative "attribool/version"
 require_relative "attribool/value"
 require_relative "attribool/attribute"
+require_relative "attribool/validators"
 require_relative "attribool/reader_name"
 require_relative "attribool/attribute_list"
 require_relative "attribool/validator_service"
@@ -10,6 +11,7 @@ require_relative "attribool/validators/condition_validator"
 require_relative "attribool/validators/method_name_validator"
 require_relative "attribool/validators/nil_attribute_validator"
 require_relative "attribool/validators/strict_boolean_validator"
+require_relative "attribool/validators/attribute_list_validator"
 
 ##
 # Adds macros for dealing with boolean attributes.
@@ -44,7 +46,7 @@ module Attribool
   def bool_reader(*attributes, allow_nil: true, method_name: nil, condition: nil)
     ValidatorService.call(:method_name, method_name, attributes.size)
 
-    AttributeList.new(*attributes, method_name: method_name).each do |attribute|
+    AttributeList.build(*attributes, method_name: method_name).each do |attribute|
       define_method(attribute.reader) do
         instance_variable_get(attribute.ivar).then do |value|
           ValidatorService.call(:nil_attribute, attribute.ivar, value, allow_nil)
@@ -63,7 +65,7 @@ module Attribool
   #
   # @kwarg [Boolean] strict
   def bool_writer(*attributes, strict: false)
-    AttributeList.new(*attributes).each do |attribute|
+    AttributeList.build(*attributes).each do |attribute|
       define_method(attribute.writer) do |value|
         ValidatorService.call(:strict_boolean, value, strict)
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.0.3
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-05-26 00:00:00.000000000 Z
+date: 2023-06-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -111,6 +111,8 @@ files:
 - lib/attribool/attribute_list.rb
 - lib/attribool/reader_name.rb
 - lib/attribool/validator_service.rb
+- lib/attribool/validators.rb
+- lib/attribool/validators/attribute_list_validator.rb
 - lib/attribool/validators/condition_validator.rb
 - lib/attribool/validators/method_name_validator.rb
 - lib/attribool/validators/nil_attribute_validator.rb