attribool 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc735929535da353af1b584656aafb3ba6ba46b7996af32ae37dedc30bcfb0a2
-  data.tar.gz: 116a6a7fd8f9803773d10a6fff0b294f73bb9f5eb872db573f11273f8fc1ddcb
+  metadata.gz: e18815dc8107a42c84084e2c35614d8111f7ae827224b4b78cbb3e920ff9c970
+  data.tar.gz: 84642d3baca03e19bf84794ed88f2696d1f639801b79f55cd9fc2636309f8061
 SHA512:
-  metadata.gz: 73fc2ab7f625fdfbb7577cda39c60eb86f6f53511fa685b2c0b86a79c90d22876123fcd34db74a76deb25eabc223cf891964fac36f962732af87a0c0c9aabcb0
-  data.tar.gz: ec6dc2496637c4c21c3c252a4c02fa1d574b4e4e033b74bd9019d5a8c286febba0990cd6d5659cc15be20b6a6c6dc3428f23a8bcb11ded8ed6a884403f78f682
+  metadata.gz: 3984a29d0285e92995b01d36ba9fbe0fe4919b9800116bff642ff5e7f0ee8e3fe1c4444a5bb1f3494f87e41228c31b4f0a7eec086ae3f3e5f07f255a5943ba41
+  data.tar.gz: 68246fd9004eb745078a8399ee4dc160ba2b06535a12fad81173958053c738c523fe5df152e266e2103e74f84715f9ca0bb309726eb30159e313f45efd9a8761

data/lib/attribool/attribute.rb

@@ -1,10 +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
 
-  def initialize(attribute)
-    attribute = attribute.to_s
-    @ivar = attribute.start_with?('@') ? attribute : "@#{attribute}"
-    @name = @ivar.delete_prefix('@')
+  ##
+  # 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

@@ -21,7 +21,7 @@ module Attribool
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 0
+    PATCH = 1
 
     ##
     # Version as +[MAJOR, MINOR, PATCH]+
@@ -48,5 +48,9 @@ module Attribool
     end
   end
 
+  ##
+  # The version, as a string.
+  #
+  # @return [String]
   VERSION = Version.to_s.freeze
 end

data/lib/attribool.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative 'attribool/version'
-require_relative 'attribool/method_name'
 require_relative 'attribool/attribute'
 
 ##
@@ -24,9 +23,10 @@ module Attribool
     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
+    Attribute.validate_method_name(attributes.size, method_name)
+
+    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
 
@@ -44,7 +44,7 @@ module Attribool
   # @kwarg [Boolean] strict
   def bool_writer(*attributes, strict: false)
     attributes.map { |a| Attribute.new(a) }.each do |attribute|
-      define_method("#{attribute.name}=") do |v|
+      define_method(attribute.writer) do |v|
         if strict && ![TrueClass, FalseClass].include?(v.class)
           raise ArgumentError, 'Argument must be a boolean'
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attribool
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Evan Gray
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-01-06 00:00:00.000000000 Z
+date: 2022-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -80,7 +80,6 @@ files:
 - 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:

data/lib/attribool/method_name.rb

@@ -1,18 +0,0 @@
-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