attr_bool 0.2.1 → 0.3.0

data/attr_bool.gemspec

@@ -1,64 +1,57 @@
 # encoding: UTF-8
 # frozen_string_literal: true
 
-#--
-# This file is part of AttrBool.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# AttrBool is free software: you can redistribute it and/or modify it under
-# the terms of the MIT License.
-# 
-# You should have received a copy of the MIT License along with AttrBool.
-# If not, see <https://choosealicense.com/licenses/mit/>.
-#++
-
-
 require_relative 'lib/attr_bool/version'
 
-Gem::Specification.new() do |spec|
+Gem::Specification.new do |spec|
   spec.name        = 'attr_bool'
   spec.version     = AttrBool::VERSION
-  spec.authors     = ['Jonathan Bradley Whited (@esotericpig)']
-  spec.email       = ['bradley@esotericpig.com']
+  spec.authors     = ['Bradley Whited']
+  spec.email       = ['code@esotericpig.com']
   spec.licenses    = ['MIT']
   spec.homepage    = 'https://github.com/esotericpig/attr_bool'
-  spec.summary     = 'Finally attr_accessor & attr_reader with question marks for booleans!?'
-  spec.description = <<-EOD.gsub(/\s+/,' ').strip()
+  spec.summary     = 'Finally attr_accessor? & attr_reader? with question marks for booleans/predicates!?'
+  spec.description = <<~DESC
     #{spec.summary}
-    Simply use: attr_accessor?, attr_reader?, attr_bool, attr_bool?.
-    Default values can also be passed in as the last argument
-      or with the 'default: ' keyword argument.
-    In a Module/Class, extend 'AttrBool::Ext',
-      or in the file, require 'attr_bool/core_ext'.
-  EOD
-  
+
+    Pick one:
+      (1) in your top module, add `using AttrBool::Ref`,
+      or (2) in your class/module, add `extend AttrBool::Ext`,
+      or (3) in your app/script (not library), include `require 'attr_bool/core_ext'`.
+
+    Now simply use any:
+      [ attr_accessor?, attr_reader?, attr_writer?, attr_bool, attr_bool?, attr_bool! ].
+
+    Keywords: attr, attribute, attributes, bool, boolean, booleans, predicate, predicates
+  DESC
+
   spec.metadata = {
-    'homepage_uri'    => 'https://github.com/esotericpig/attr_bool',
-    'source_code_uri' => 'https://github.com/esotericpig/attr_bool',
-    'bug_tracker_uri' => 'https://github.com/esotericpig/attr_bool/issues',
-    'changelog_uri'   => 'https://github.com/esotericpig/attr_bool/blob/master/CHANGELOG.md',
+    'rubygems_mfa_required' => 'true',
+    'homepage_uri'          => spec.homepage,
+    'source_code_uri'       => 'https://github.com/esotericpig/attr_bool',
+    'bug_tracker_uri'       => 'https://github.com/esotericpig/attr_bool/issues',
+    'changelog_uri'         => 'https://github.com/esotericpig/attr_bool/blob/main/CHANGELOG.md',
   }
-  
-  spec.required_ruby_version = '>= 2.4'
+
+  spec.required_ruby_version = '>= 3.1'
   spec.require_paths         = ['lib']
-  
+  spec.bindir                = 'bin'
+  spec.executables           = []
+
+  spec.extra_rdoc_files = %w[LICENSE.txt README.md]
+  spec.rdoc_options     = [
+    %w[--embed-mixins --hyperlink-all --line-numbers --show-hash],
+    '--encoding','UTF-8',
+    '--markup','markdown',
+    '--title',"AttrBool v#{AttrBool::VERSION}",
+    '--main','README.md',
+  ].flatten
+
   spec.files = [
-    Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{erb,rb}')),
-    %W[ Gemfile #{spec.name}.gemspec Rakefile ],
-    %w[ LICENSE.txt ],
-  ].flatten()
-  
-  spec.add_development_dependency 'bundler'   ,'~> 2.1'
-  spec.add_development_dependency 'minitest'  ,'~> 5.14'
-  spec.add_development_dependency 'rake'      ,'~> 13.0'
-  spec.add_development_dependency 'rdoc'      ,'~> 6.2'   # YARDoc RDoc (*.rb)
-  spec.add_development_dependency 'redcarpet' ,'~> 3.5'   # YARDoc Markdown (*.md)
-  spec.add_development_dependency 'yard'      ,'~> 0.9'   # Doc
-  
-  spec.extra_rdoc_files = %w[ LICENSE.txt ]
-  
-  spec.rdoc_options = [
-    '--hyperlink-all','--show-hash',
-    '--title',"AttrBool v#{AttrBool::VERSION} Doc",
-  ]
+    Dir.glob("{#{spec.require_paths.join(',')}}/**/*.{erb,rb}"),
+    Dir.glob("#{spec.bindir}/*"),
+    Dir.glob('{spec,test}/**/*.{erb,rb}'),
+    %W[.rdoc_options Gemfile #{spec.name}.gemspec Rakefile],
+    spec.extra_rdoc_files,
+  ].flatten
 end

data/lib/attr_bool/core_ext.rb

@@ -1,29 +1,14 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of AttrBool.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# AttrBool is free software: you can redistribute it and/or modify it under
-# the terms of the MIT License.
-# 
-# You should have received a copy of the MIT License along with AttrBool.
-# If not, see <https://choosealicense.com/licenses/mit/>.
+# Copyright (c) 2020 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
 #++
 
-
 require 'attr_bool'
 
-module AttrBool
-  ###
-  # @author Jonathan Bradley Whited (@esotericpig)
-  # @since  0.2.0
-  ###
-  module CoreExt
-  end
-end
-
-# This works for both +class+ & +module+ because +class+ extends +module+.
-Module.prepend AttrBool::Ext
+# This works for both classes & modules because Class is a child of Module.
+Module.prepend(AttrBool::Ext)

data/lib/attr_bool/version.rb

@@ -1,19 +1,13 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of AttrBool.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# AttrBool is free software: you can redistribute it and/or modify it under
-# the terms of the MIT License.
-# 
-# You should have received a copy of the MIT License along with AttrBool.
-# If not, see <https://choosealicense.com/licenses/mit/>.
+# Copyright (c) 2020 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
 #++
 
-
 module AttrBool
-  VERSION = '0.2.1'
+  VERSION = '0.3.0'
 end

data/lib/attr_bool.rb

@@ -1,187 +1,229 @@
-#!/usr/bin/env ruby
 # encoding: UTF-8
 # frozen_string_literal: true
 
 #--
 # This file is part of AttrBool.
-# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
-# 
-# AttrBool is free software: you can redistribute it and/or modify it under
-# the terms of the MIT License.
-# 
-# You should have received a copy of the MIT License along with AttrBool.
-# If not, see <https://choosealicense.com/licenses/mit/>.
+# Copyright (c) 2020 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
 #++
 
-
 require 'attr_bool/version'
 
-###
-# @author Jonathan Bradley Whited (@esotericpig)
-# @since  0.1.0
-###
+##
+# Example usage:
+# ```
+# require 'attr_bool'
+#
+# class TheTodd
+#   extend AttrBool::Ext
+#   #using AttrBool::Ref  # Can use refinements instead.
+#
+#   # Can use multiple symbols and/or strings.
+#   attr_accessor? :flexing, 'bounce_pecs'
+#
+#   # Can do DSL chaining.
+#   protected attr_accessor? :high_five, 'fist_bump'
+#
+#   # Can do custom logic.
+#   attr_accessor? :headband, 'banana_hammock',
+#                  reader: -> { @wearing == :flaming },
+#                  writer: ->(value) { @wearing = value }
+#
+#   attr_reader?(:cat_fights)    { @cat_fights % 69 }
+#   attr_writer?(:hot_surgeries) { |count| @hot_surgeries += count }
+#
+#   # Can force bool values (i.e., only `true` or `false`).
+#   attr_bool  :carla_kiss   # Accessor.
+#   attr_bool? :elliot_kiss  # Reader.
+#   attr_bool! :thumbs_up    # Writer.
+# end
+# ```
 module AttrBool
-  ###
-  # Benchmarks are kind of meaningless, but after playing around with some,
-  # I found the following to be the case on my system:
-  # - +define_method+ is faster than +module_eval+ & +class_eval+
-  # - +? true : false+ (ternary operator) is faster than +!!+ (surprisingly)
-  # 
-  # To run benchmark code:
-  #   $ bundle exec rake benchmark
-  # 
-  # @author Jonathan Bradley Whited (@esotericpig)
-  # @since  0.2.0
-  ###
+  ##
+  # Example usage:
+  # ```
+  # class TheTodd
+  #   extend AttrBool::Ext
+  #
+  #   attr_accessor? :headband
+  #   attr_reader?   :banana_hammock
+  #   attr_writer?   :high_five
+  #
+  #   attr_bool      :bounce_pecs
+  #   attr_bool?     :cat_fight
+  #   attr_bool!     :hot_tub
+  # end
+  # ```
   module Ext
-    def attr_accessor?(*var_ids,default: nil,reader: nil,writer: nil,&block)
-      if block
-        reader = block if reader.nil?()
-        writer = block if writer.nil?()
-      end
-      
-      if default.nil?() && reader.nil?()
-        last = var_ids[-1]
-        
-        if !last.is_a?(String) && !last.is_a?(Symbol)
-          default = var_ids.pop()
-        end
-      end
-      
-      attr_reader?(*var_ids,default: default,&reader)
-      attr_writer?(*var_ids,&writer)
+    #--
+    # NOTE: Not using `self.` for extended/included/prepended() so that including a module that extends
+    #       `AttrBool::Ext` works without having to extend `AttrBool::Ext` again.
+    #++
+
+    def extended(mod)
+      super
+      __attr_bool_extended(mod)
     end
-    
-    def attr_reader?(*var_ids,default: nil,&block)
-      no_default = (default.nil?() && !block)
-      
-      if no_default
-        last = var_ids[-1]
-        
-        if !last.is_a?(String) && !last.is_a?(Symbol)
-          default = var_ids.pop()
-          no_default = false
-        end
-      end
-      
-      var_ids.each() do |var_id|
-        var_id_q = :"#{var_id}?"
-        
-        if no_default
-          define_method(var_id_q) do
-            instance_variable_get(:"@#{var_id}")
+
+    def included(mod)
+      super
+      __attr_bool_extended(mod)
+    end
+
+    def prepended(mod)
+      super
+      __attr_bool_extended(mod)
+    end
+
+    def attr_accessor?(*names,reader: nil,writer: nil)
+      return __attr_bool(names,reader: reader,writer: writer)
+    end
+
+    def attr_reader?(*names,&reader)
+      return __attr_bool(names,reader: reader)
+    end
+
+    def attr_writer?(*names,&writer)
+      return __attr_bool(names,writer: writer)
+    end
+
+    def attr_bool(*names,reader: nil,writer: nil)
+      return __attr_bool(names,reader: reader,writer: writer,force_bool: true)
+    end
+
+    def attr_bool?(*names,&reader)
+      return __attr_bool(names,reader: reader,force_bool: true)
+    end
+
+    def attr_bool!(*names,&writer)
+      return __attr_bool(names,writer: writer,force_bool: true)
+    end
+
+    private
+
+    def __attr_bool_extended(mod)
+      mod.extend(AttrBool::Ext) unless mod.singleton_class.ancestors.include?(AttrBool::Ext)
+    end
+
+    def __attr_bool(names,reader: false,writer: false,force_bool: false)
+      # For DSL chaining, must return the method names created, like core `attr_accessor`/etc. does.
+      # Example: protected attr_bool :banana_hammock,:bounce_pecs
+      method_names = []
+
+      # noinspection RubySimplifyBooleanInspection
+      names.map do |name|
+        ivar = :"@#{name}"
+
+        if reader != false # false, nil, or Proc.
+          name_q = :"#{name}?"
+          method_names << name_q
+
+          if reader # Proc?
+            if force_bool
+              define_method(name_q) { instance_exec(&reader) ? true : false }
+            else
+              define_method(name_q,&reader)
+            end
+          else # nil?
+            instance_variable_get(ivar) # Fail fast if `ivar` is invalid.
+
+            if force_bool
+              define_method(name_q) { instance_variable_get(ivar) ? true : false }
+            else
+              define_method(name_q) { instance_variable_get(ivar) }
+            end
           end
-        else
-          if block
-            define_method(var_id_q,&block)
-          else
-            at_var_id = :"@#{var_id}"
-            
-            define_method(var_id_q) do
-              instance_variable_defined?(at_var_id) ? instance_variable_get(at_var_id) : default
+        end
+
+        if writer != false # false, nil, or Proc.
+          name_eq = :"#{name}="
+          method_names << name_eq
+
+          if writer # Proc?
+            if force_bool
+              define_method(name_eq) { |value| instance_exec(value ? true : false,&writer) }
+            else
+              define_method(name_eq,&writer)
+            end
+          else # nil?
+            instance_variable_get(ivar) # Fail fast if `ivar` is invalid.
+
+            if force_bool
+              define_method(name_eq) { |value| instance_variable_set(ivar,value ? true : false) }
+            else
+              define_method(name_eq) { |value| instance_variable_set(ivar,value) }
             end
           end
         end
       end
+
+      return method_names
     end
-    
-    # This should only be used when you want to pass in a block/proc.
-    def attr_writer?(*var_ids,&block)
-      if block
-        var_ids.each() do |var_id|
-          define_method(:"#{var_id}=",&block)
+  end
+
+  ##
+  # Example usage:
+  # ```
+  # module TheToddMod
+  #   using AttrBool::Ref
+  #
+  #   class TheTodd
+  #     attr_accessor? :headband
+  #     attr_reader?   :banana_hammock
+  #     attr_writer?   :high_five
+  #
+  #     attr_bool      :bounce_pecs
+  #     attr_bool?     :cat_fight
+  #     attr_bool!     :hot_tub
+  #   end
+  # end
+  # ```
+  module Ref
+    # This works for both classes & modules because Class is a child of Module.
+    refine Module do
+      import_methods AttrBool::Ext
+
+      # NOTE: JRuby (and maybe other implementations?) has a bug with importing methods that internally
+      #       call other refined methods, so this is the workaround.
+      if RUBY_PLATFORM == 'java'
+        def extended(mod)
+          super
+          __attr_bool_extended(mod)
         end
-      else
-        last = var_ids[-1]
-        
-        if !last.is_a?(String) && !last.is_a?(Symbol)
-          raise ArgumentError,'default value not allowed for writer'
+
+        def included(mod)
+          super
+          __attr_bool_extended(mod)
         end
-        
-        attr_writer(*var_ids)
-      end
-    end
-    
-    def attr_bool(*var_ids,default: nil,reader: nil,writer: nil,&block)
-      if block
-        reader = block if reader.nil?()
-        writer = block if writer.nil?()
-      end
-      
-      if default.nil?() && reader.nil?()
-        last = var_ids[-1]
-        
-        if !last.is_a?(String) && !last.is_a?(Symbol)
-          default = var_ids.pop()
+
+        def prepended(mod)
+          super
+          __attr_bool_extended(mod)
         end
-      end
-      
-      attr_bool?(*var_ids,default: default,&reader)
-      attr_booler(*var_ids,&writer)
-    end
-    alias_method :attr_boolor,:attr_bool
-    
-    def attr_bool?(*var_ids,default: nil,&block)
-      no_default = default.nil?()
-      
-      if no_default
-        no_default = !block
-        
-        if no_default
-          last = var_ids[-1]
-          
-          if !last.is_a?(String) && !last.is_a?(Symbol)
-            default = var_ids.pop() ? true : false
-            no_default = false
-          end
+
+        def attr_accessor?(*names,reader: nil,writer: nil)
+          return __attr_bool(names,reader: reader,writer: writer)
         end
-      else
-        default = default ? true : false
-      end
-      
-      var_ids.each() do |var_id|
-        var_id_q = :"#{var_id}?"
-        
-        if no_default
-          define_method(var_id_q) do
-            instance_variable_get(:"@#{var_id}") ? true : false
-          end
-        else
-          if block
-            define_method(var_id_q,&block)
-          else
-            at_var_id = :"@#{var_id}"
-            
-            define_method(var_id_q) do
-              if instance_variable_defined?(at_var_id)
-                instance_variable_get(at_var_id) ? true : false
-              else
-                default
-              end
-            end
-          end
+
+        def attr_reader?(*names,&reader)
+          return __attr_bool(names,reader: reader)
         end
-      end
-    end
-    
-    def attr_booler(*var_ids,&block)
-      if !block
-        last = var_ids[-1]
-        
-        if !last.is_a?(String) && !last.is_a?(Symbol)
-          raise ArgumentError,'default value not allowed for writer'
+
+        def attr_writer?(*names,&writer)
+          return __attr_bool(names,writer: writer)
         end
-      end
-      
-      var_ids.each() do |var_id|
-        var_id_eq = :"#{var_id}="
-        
-        if block
-          define_method(var_id_eq,&block)
-        else
-          define_method(var_id_eq) do |value|
-            instance_variable_set(:"@#{var_id}",value ? true : false)
-          end
+
+        def attr_bool(*names,reader: nil,writer: nil)
+          return __attr_bool(names,reader: reader,writer: writer,force_bool: true)
+        end
+
+        def attr_bool?(*names,&reader)
+          return __attr_bool(names,reader: reader,force_bool: true)
+        end
+
+        def attr_bool!(*names,&writer)
+          return __attr_bool(names,writer: writer,force_bool: true)
         end
       end
     end

data/test/attr_bool_test.rb

@@ -0,0 +1,17 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of AttrBool.
+# Copyright (c) 2020 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
+#++
+
+require 'test_helper'
+
+describe AttrBool do
+  it 'has the version' do
+    _(AttrBool::VERSION).must_match(/\d+\.\d+\.\d+(-[0-9A-Za-z\-.]+)?(\+[0-9A-Za-z\-.]+)?/)
+  end
+end

data/test/core_ext_test.rb

@@ -0,0 +1,103 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of AttrBool.
+# Copyright (c) 2020 Bradley Whited
+#
+# SPDX-License-Identifier: MIT
+#++
+
+require 'test_helper'
+
+require 'attr_bool/core_ext'
+
+describe 'attr_bool/core_ext' do
+  it 'monkey-patches the core Class & Module only once' do
+    _(Class.ancestors.count(AttrBool::Ext)).must_equal(1)
+    _(Module.ancestors.count(AttrBool::Ext)).must_equal(1)
+  end
+
+  def self.it_has_the_attr_bools
+    it 'has the attr accessors' do
+      _(@sut).must_respond_to(:acc01=)
+      _(@sut).must_respond_to(:acc02=)
+
+      @sut.acc01 = :acc01_value
+      @sut.acc02 = :acc02_value
+
+      _(@sut.acc01?).must_equal(:acc01_value)
+      _(@sut.acc02?).must_equal(true)
+    end
+
+    it 'has the attr readers' do
+      _(@sut.read01?).must_equal(:read01_value)
+      _(@sut.read02?).must_equal(true)
+    end
+
+    it 'has the attr writers' do
+      _(@sut).must_respond_to(:write01=)
+      _(@sut).must_respond_to(:write02=)
+
+      @sut.write01 = :write01_value
+      @sut.write02 = :write02_value
+
+      _(@sut.instance_variable_get(:@write01)).must_equal(:write01_value)
+      _(@sut.instance_variable_get(:@write02)).must_equal(true)
+    end
+  end
+
+  describe 'core class' do
+    before do
+      @sut = CoreExtTest::TestBag.new
+    end
+
+    it_has_the_attr_bools
+  end
+
+  describe 'core module' do
+    before do
+      @sut = CoreExtTest::TestBagWithMixin.new
+    end
+
+    it_has_the_attr_bools
+  end
+end
+
+module CoreExtTest
+  class TestBag
+    attr_accessor? :acc01
+    attr_bool      :acc02
+    attr_reader?   :read01
+    attr_bool?     :read02
+    attr_writer?   :write01
+    attr_bool!     :write02
+
+    def initialize
+      super
+
+      @read01 = :read01_value
+      @read02 = :read02_value
+    end
+  end
+
+  module TestBagMixin
+    attr_accessor? :acc01
+    attr_bool      :acc02
+    attr_reader?   :read01
+    attr_bool?     :read02
+    attr_writer?   :write01
+    attr_bool!     :write02
+
+    def initialize
+      super
+
+      @read01 = :read01_value
+      @read02 = :read02_value
+    end
+  end
+
+  class TestBagWithMixin
+    include TestBagMixin
+  end
+end