attr_bool 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a62c877260d0a0c1011606c3ac052b8a3ca9f2024bebd22a616e9ec4e6c8b15f
+  data.tar.gz: 22ed6454ecab891813d979c76f9799196c903b6b5b423ecf92c343d64e761528
+SHA512:
+  metadata.gz: b0853e2ac22aa5bae184ebfe4358dfe9ab2286930de0e95dda926c0bb89b15c41cac7863dd8f1667e444d557f2b80da5c4e1355de24eab44db19bcd606eb3f16
+  data.tar.gz: 52b6a2c764429a3453251c3d6e84563c43f405a128e4d345cd56610943a70c3a9b173eee93620667a16c5931309972feb9fbf326ade849e0d6cc40ebc998dfe7

data/Gemfile

@@ -0,0 +1,7 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Jonathan Bradley Whited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/Rakefile

@@ -0,0 +1,152 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of attr_bool.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# attr_bool 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 attr_bool.
+# If not, see <https://choosealicense.com/licenses/mit/>.
+#++
+
+
+require 'bundler/gem_tasks'
+
+require 'benchmark'
+require 'rake/clean'
+require 'rake/testtask'
+require 'yard'
+
+require 'attr_bool/version'
+
+
+CLEAN.exclude('.git/','stock/')
+CLOBBER.include('doc/')
+
+
+task default: [:test]
+
+desc 'Generate doc (YARDoc)'
+task :doc => [:yard] do |task|
+end
+
+desc 'Generate doc for tests too (for checking macros)'
+task :doc_test do |task|
+  ENV['doctest'] = 'y'
+  
+  doc_task = Rake::Task[:doc]
+  
+  doc_task.reenable()
+  doc_task.invoke()
+end
+
+Rake::TestTask.new() do |task|
+  task.libs = ['lib','test']
+  task.pattern = File.join('test','**','*_test.rb')
+  task.description += ": '#{task.pattern}'"
+  task.verbose = false
+  task.warning = true
+end
+
+YARD::Rake::YardocTask.new() do |task|
+  task.files = [File.join('lib','**','*.{rb}')]
+  
+  task.options += ['--files','CHANGELOG.md,LICENSE.txt']
+  task.options += ['--readme','README.md']
+  
+  task.options << '--protected' # Show protected methods
+  #task.options += ['--template-path',File.join('yard','templates')]
+  task.options += ['--title',"attr_bool v#{AttrBool::VERSION} doc"]
+  
+  task.before = Proc.new() do
+    task.files << File.join('test','**','*.{rb}') if ENV['doctest'].to_s().casecmp?('y')
+  end
+end
+
+
+desc 'Benchmark define_method vs module_eval & ?: vs bangbang'
+task :benchmark do |task|
+  N0 = 100_000
+  N1 = 20_000_000
+  
+  module ModuleExt
+    def do_class_eval(name)
+      0.upto(N0) do |i|
+        n = "#{name}#{i}"
+        
+        class_eval("def #{n}?(); @#{n}; end")
+      end
+    end
+    
+    def do_define_method(name)
+      0.upto(N0) do |i|
+        n = "#{name}#{i}"
+        
+        define_method(:"#{n}?") do
+          instance_variable_get(:"@#{n}")
+        end
+      end
+    end
+    
+    def do_module_eval(name)
+      0.upto(N0) do |i|
+        n = "#{name}#{i}"
+        
+        module_eval("def #{n}?(); @#{n}; end")
+      end
+    end
+  end
+  
+  Module.prepend ModuleExt
+  
+  puts
+  Benchmark.bmbm() do |bm|
+    bm.report('class_eval   ') do
+      class ClassEvalTest
+        do_class_eval :ce
+      end
+    end
+    
+    bm.report('define_method') do
+      class DefineMethodTest
+        do_define_method :dm
+      end
+    end
+    
+    bm.report('module_eval  ') do
+      class ModuleEvalTest
+        do_module_eval :me
+      end
+    end
+  end
+  
+  str = 'str' # Warning workaround
+  
+  puts
+  Benchmark.bmbm() do |bm|
+    bm.report('?:') do
+      0.upto(N1) do |i|
+        x = str   ? true : false
+        x = nil   ? true : false
+        x = true  ? true : false
+        x = false ? true : false
+        x = x     ? true : false
+      end
+    end
+    
+    bm.report('!!') do
+      0.upto(N1) do |i|
+        y = !!str
+        y = !!nil
+        y = !!true
+        y = !!false
+        y = !!y
+      end
+    end
+  end
+  
+  puts
+end

data/attr_bool.gemspec

@@ -0,0 +1,53 @@
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of attr_bool.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# attr_bool 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 attr_bool.
+# If not, see <https://choosealicense.com/licenses/mit/>.
+#++
+
+
+lib = File.expand_path(File.join('..','lib'),__FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'attr_bool/version'
+
+
+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.licenses    = ['MIT']
+  spec.homepage    = 'https://github.com/esotericpig/attr_bool'
+  spec.summary     = 'Finally attr_accessor & attr_reader with question marks for booleans!?'
+  spec.description = spec.summary +
+    ' Simply use one the following: attr_accessor?, attr_reader?, attr_bool, attr_bool?.' \
+    ' Default values can also be passed in.'
+  
+  spec.metadata = {
+    'bug_tracker_uri' => 'https://github.com/esotericpig/attr_bool/issues',
+    'changelog_uri'   => 'https://github.com/esotericpig/attr_bool/blob/master/CHANGELOG.md',
+    'homepage_uri'    => 'https://github.com/esotericpig/attr_bool',
+    'source_code_uri' => 'https://github.com/esotericpig/attr_bool',
+  }
+  
+  spec.require_paths = ['lib']
+  
+  spec.files = Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{rb}')) +
+               %W( Gemfile #{spec.name}.gemspec Rakefile ) +
+               %w( LICENSE.txt )
+  
+  spec.required_ruby_version = '>= 2.4'
+  
+  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 'yard'    ,'~> 0.9'  # For doc
+end

data/lib/attr_bool.rb

@@ -0,0 +1,227 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of attr_bool.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# attr_bool 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 attr_bool.
+# If not, see <https://choosealicense.com/licenses/mit/>.
+#++
+
+
+require 'attr_bool/version'
+
+
+###
+# 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.1.0
+###
+module AttrBool
+  ###
+  # This works for both +class+ & +module+ because +class+ extends +module+.
+  # 
+  # @author Jonathan Bradley Whited (@esotericpig)
+  # @since  0.1.0
+  ###
+  module ModuleExt
+    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)
+    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}")
+          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
+          end
+        end
+      end
+    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
+      else
+        last = var_ids[-1]
+        
+        if !last.is_a?(String) && !last.is_a?(Symbol)
+          raise ArgumentError,'default value not allowed for writer'
+        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()
+        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
+        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
+        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'
+        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
+        end
+      end
+    end
+    
+    # @!macro attach attr_reader?
+    #   @!method $1?
+    #   @return [Boolean] whether +$1+ or not
+    
+    # @!macro attach attr_writer?
+    #   @!method $1=(value)
+    #   Sets +$1+ to +true+ or +false+.
+    #   @param value [Boolean] the new value of +$1+
+    
+    # @!macro attach attr_accessor?
+    #   @!method $1?
+    #     @!macro attach attr_reader?
+    #   @!method $1=(value)
+    #     @!macro attach attr_writer?
+    
+    # @!macro attach attr_bool?
+    #   @!method $1?
+    #   @return [true,false] whether +$1+ or not
+    
+    # @!macro attach attr_booler
+    #   @!method $1=(value)
+    #   Sets +$1+ to +true+ or +false+.
+    #   @param value [true,false] the new value of +$1+
+    
+    # @!macro attach attr_bool
+    #   @!method $1?
+    #     @!macro attach attr_bool?
+    #   @!method $1=(value)
+    #     @!macro attach attr_booler
+    
+    # @!macro attach attr_boolor
+    #   @!macro attach attr_bool
+  end
+end
+
+Module.prepend AttrBool::ModuleExt

data/lib/attr_bool/version.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+# encoding: UTF-8
+# frozen_string_literal: true
+
+#--
+# This file is part of attr_bool.
+# Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
+# 
+# attr_bool 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 attr_bool.
+# If not, see <https://choosealicense.com/licenses/mit/>.
+#++
+
+
+module AttrBool
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: attr_bool
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jonathan Bradley Whited (@esotericpig)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-04-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: 'Finally attr_accessor & attr_reader with question marks for booleans!?
+  Simply use one the following: attr_accessor?, attr_reader?, attr_bool, attr_bool?.
+  Default values can also be passed in.'
+email:
+- bradley@esotericpig.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- attr_bool.gemspec
+- lib/attr_bool.rb
+- lib/attr_bool/version.rb
+homepage: https://github.com/esotericpig/attr_bool
+licenses:
+- MIT
+metadata:
+  bug_tracker_uri: https://github.com/esotericpig/attr_bool/issues
+  changelog_uri: https://github.com/esotericpig/attr_bool/blob/master/CHANGELOG.md
+  homepage_uri: https://github.com/esotericpig/attr_bool
+  source_code_uri: https://github.com/esotericpig/attr_bool
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Finally attr_accessor & attr_reader with question marks for booleans!?
+test_files: []