attr_bool 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a62c877260d0a0c1011606c3ac052b8a3ca9f2024bebd22a616e9ec4e6c8b15f
-  data.tar.gz: 22ed6454ecab891813d979c76f9799196c903b6b5b423ecf92c343d64e761528
+  metadata.gz: '08774043d349869b1a07f48acc95fb7c4239a6f7cbb7616db959adb82f204972'
+  data.tar.gz: 8076675a422c70291b7e5c775a6b8bb1ab7483e2987786ce53af438e2190ad72
 SHA512:
-  metadata.gz: b0853e2ac22aa5bae184ebfe4358dfe9ab2286930de0e95dda926c0bb89b15c41cac7863dd8f1667e444d557f2b80da5c4e1355de24eab44db19bcd606eb3f16
-  data.tar.gz: 52b6a2c764429a3453251c3d6e84563c43f405a128e4d345cd56610943a70c3a9b173eee93620667a16c5931309972feb9fbf326ade849e0d6cc40ebc998dfe7
+  metadata.gz: 2bda865800a81e391929d58265b5d094384ba9f516c8ac2bb893d4f742d5bbd18e33eb43c4b237ac63993adca625db3dd0cd2e8fc69bbae33bc18f5da94da512
+  data.tar.gz: 78fe47e718bc4c9bd8988b17f9aca267b72861398c809761ae35288c96c860e663179867834debf4368a74f07c5c069a5b0f9bae08b1ec348ade1b58e93ade47

data/Rakefile

@@ -2,13 +2,13 @@
 # frozen_string_literal: true
 
 #--
-# This file is part of attr_bool.
+# This file is part of AttrBool.
 # Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
 # 
-# attr_bool is free software: you can redistribute it and/or modify it under
+# 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 attr_bool.
+# You should have received a copy of the MIT License along with AttrBool.
 # If not, see <https://choosealicense.com/licenses/mit/>.
 #++
 
@@ -22,18 +22,16 @@ require 'yard'
 
 require 'attr_bool/version'
 
-
-CLEAN.exclude('.git/','stock/')
+CLEAN.exclude('{.git,stock}/**/*')
 CLOBBER.include('doc/')
 
-
 task default: [:test]
 
-desc 'Generate doc (YARDoc)'
+desc 'Generate doc'
 task :doc => [:yard] do |task|
 end
 
-desc 'Generate doc for tests too (for checking macros)'
+desc 'Generate doc for tests too'
 task :doc_test do |task|
   ENV['doctest'] = 'y'
   
@@ -44,6 +42,7 @@ task :doc_test do |task|
 end
 
 Rake::TestTask.new() do |task|
+  task.deps << :doc_test
   task.libs = ['lib','test']
   task.pattern = File.join('test','**','*_test.rb')
   task.description += ": '#{task.pattern}'"
@@ -54,20 +53,15 @@ 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.options += ['--title',"AttrBool 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'
+desc 'Benchmark define_method vs module_eval and ?: vs bangbang'
 task :benchmark do |task|
   N0 = 100_000
   N1 = 20_000_000

data/attr_bool.gemspec

@@ -2,22 +2,18 @@
 # frozen_string_literal: true
 
 #--
-# This file is part of attr_bool.
+# This file is part of AttrBool.
 # Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
 # 
-# attr_bool is free software: you can redistribute it and/or modify it under
+# 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 attr_bool.
+# You should have received a copy of the MIT License along with AttrBool.
 # 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'
-
+require_relative 'lib/attr_bool/version'
 
 Gem::Specification.new() do |spec|
   spec.name        = 'attr_bool'
@@ -32,22 +28,32 @@ Gem::Specification.new() do |spec|
     ' 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',
+    'bug_tracker_uri' => 'https://github.com/esotericpig/attr_bool/issues',
+    'changelog_uri'   => 'https://github.com/esotericpig/attr_bool/blob/master/CHANGELOG.md',
   }
   
-  spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.4'
+  spec.require_paths         = ['lib']
+  
+  spec.files = [
+    Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{erb,rb}')),
+    %W[ Gemfile #{spec.name}.gemspec Rakefile ],
+    %w[ LICENSE.txt ],
+  ].flatten()
   
-  spec.files = Dir.glob(File.join("{#{spec.require_paths.join(',')}}",'**','*.{rb}')) +
-               %W( Gemfile #{spec.name}.gemspec Rakefile ) +
-               %w( LICENSE.txt )
+  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.required_ruby_version = '>= 2.4'
+  spec.extra_rdoc_files = %w[ LICENSE.txt ]
   
-  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
+  spec.rdoc_options = [
+    '--hyperlink-all','--show-hash',
+    '--title',"AttrBool v#{AttrBool::VERSION} Doc",
+  ]
 end

data/lib/attr_bool.rb

@@ -3,40 +3,37 @@
 # frozen_string_literal: true
 
 #--
-# This file is part of attr_bool.
+# This file is part of AttrBool.
 # Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
 # 
-# attr_bool is free software: you can redistribute it and/or modify it under
+# 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 attr_bool.
+# You should have received a copy of the MIT License along with AttrBool.
 # 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+.
+  # 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
+  # @since  0.2.0
   ###
-  module ModuleExt
+  module Ext
     def attr_accessor?(*var_ids,default: nil,reader: nil,writer: nil,&block)
       if block
         reader = block if reader.nil?()
@@ -188,40 +185,5 @@ module AttrBool
         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/core_ext.rb

@@ -0,0 +1,29 @@
+#!/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/>.
+#++
+
+
+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

data/lib/attr_bool/version.rb

@@ -3,17 +3,17 @@
 # frozen_string_literal: true
 
 #--
-# This file is part of attr_bool.
+# This file is part of AttrBool.
 # Copyright (c) 2020 Jonathan Bradley Whited (@esotericpig)
 # 
-# attr_bool is free software: you can redistribute it and/or modify it under
+# 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 attr_bool.
+# You should have received a copy of the MIT License along with AttrBool.
 # If not, see <https://choosealicense.com/licenses/mit/>.
 #++
 
 
 module AttrBool
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: attr_bool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jonathan Bradley Whited (@esotericpig)
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-04-19 00:00:00.000000000 Z
+date: 2020-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '13.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.2'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -73,24 +101,30 @@ email:
 - bradley@esotericpig.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- LICENSE.txt
 files:
 - Gemfile
 - LICENSE.txt
 - Rakefile
 - attr_bool.gemspec
 - lib/attr_bool.rb
+- lib/attr_bool/core_ext.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
+  bug_tracker_uri: https://github.com/esotericpig/attr_bool/issues
+  changelog_uri: https://github.com/esotericpig/attr_bool/blob/master/CHANGELOG.md
 post_install_message: 
-rdoc_options: []
+rdoc_options:
+- "--hyperlink-all"
+- "--show-hash"
+- "--title"
+- AttrBool v0.2.0 Doc
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement