attr_bool 0.3.0 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 427185e002ab3a1eea72403d4b91428dca1d981049fc9b79abd2b445add682b7
-  data.tar.gz: 71328c73417dcdff6c82600d46bc15347c9aa5ca65ea73f4310d4d6b55518a9b
+  metadata.gz: 25fcf6407c75df3659d7737f4f975b095ab691e1a5a470bd24866f34988f1f76
+  data.tar.gz: 54c921a73b3e8bf2ec1cbc87377b9573faab77ef119483bec262d084f58bc3af
 SHA512:
-  metadata.gz: 4bfaabe00faf88460c364ff76a978eb8adbfc2cd40d481bdb05cab9d8eb565c2634a796042af6bc08d5e3b4b16744140c4d9f8dfce3da14780cf8e0ed43eb857
-  data.tar.gz: eb3fadb07b363bba497d12b05d112c762d1b44c66c99c6bd5b0decb0374044f2cd92055116c18f2508111c6f0ffa243a526bf6c64695992c36563e26aa3bf462
+  metadata.gz: f5679bb292206738700ca4e61e520398b3830beac8aba0584d4d50eacf800bad446f6e96ca89f167366df85b0e1d7a05daf4a3b36cff1af36fa95eeacdc47e55
+  data.tar.gz: 9e63e46286640a81f08eb25191862deb6965738920fa6ba19ba9b240000f997007f3503e4ca1ac4a0bd650b193e17246ec3e517b940f6ecd1ca9494c8de08842

data/Gemfile

@@ -6,13 +6,14 @@ source 'https://rubygems.org'
 gemspec
 
 group(:development,:test) do
-  gem 'benchmark','~>  0.4 ' # For benchmarks in Rakefile.
-  gem 'bundler'  ,'~>  2.6 '
-  gem 'rake'     ,'~> 13.3 '
-  gem 'rdoc'     ,'~>  6.14' # Doc.
-  gem 'simplecov','~>  0.22' # Test coverage.
+  gem 'bundler','~> 2.6'
+  gem 'rake','~> 13.3.0'
+
+  gem 'benchmark','~> 0.4.0' # For benchmarks in Rakefile.
+  gem 'rdoc','~> 6.14.0' # Doc.
 end
 
 group(:test) do
-  gem 'minitest','~>  5.25'
+  gem 'minitest','~> 5.25.0' # Tests.
+  gem 'simplecov','~> 0.22.0' # Test coverage.
 end

data/README.md

@@ -11,9 +11,10 @@ Easily create `attr` (attribute) methods that end with question marks (`?`) for
 ```ruby
 require 'attr_bool'
 
+#using AttrBool::Ref  # Can use refinements instead of `extend AttrBool::Ext`.
+
 class TheTodd
   extend AttrBool::Ext
-  #using AttrBool::Ref  # Can use refinements instead.
 
   attr_accessor? :headband
   attr_reader?   :banana_hammock
@@ -39,18 +40,17 @@ puts todd.cat_fight?
 Features:
 - Can use multiple symbols and/or strings.
 - Can force bool values.
-- Can define custom logic with a block/proc.
-- Returns an array of the new method names, just like the core `attr` methods, to allow DSL chaining.
+- Can define custom logic with a block/proc/lambda.
+- Can do DSL chaining, just like the core `attr` methods that return an array of the new method names.
 - Can use refinements (`using AttrBool::Ref`) instead of `extend`.
-  - This allows you to refine the top module only of your project, instead of having to extend every class.
-- Fails fast if an instance variable name is invalid (if you don't use a block/proc).
+- Fails fast if an instance variable name is invalid (if you don't use a block/proc/lambda).
 
 Anti-features:
 - No default values.
   - Initialize your instance variables in `def initialize` like normal.
-  - Using default values has performance issues and other drawbacks, so better to just match the core `attr` methods.
+  - Using default values has performance/memory issues and other drawbacks, so better to just match the core `attr` methods.
 - Uses inner `AttrBool::Ext` & `AttrBool::Ref` instead of `AttrBool`.
-  - Some gems use the `extend AttrBool` (top module) pattern, but this includes `VERSION` in all of your classes/modules.
+  - Some gems use the `extend AttrBool` (top module) pattern, but this includes the `VERSION` constant in all of your classes/modules.
 - Doesn't monkey-patch the core class/module by default.
   - If desired for apps/scripts, you still can with `require 'attr_bool/core_ext'`, but not recommended for libraries.
 
@@ -106,14 +106,14 @@ gem install attr_bool
 Or in your *Gemspec*:
 
 ```ruby
-spec.add_dependency 'attr_bool', '~> X.X'
+spec.add_dependency 'attr_bool', '~> X.X.X'
 ```
 
 Or in your *Gemfile*:
 
 ```ruby
 # Pick your poison...
-gem 'attr_bool', '~> X.X'
+gem 'attr_bool', '~> X.X.X'
 gem 'attr_bool', git: 'https://github.com/esotericpig/attr_bool.git'
 ```
 
@@ -128,7 +128,7 @@ bundle exec rake install:local
 
 ## [//](#-contents) Usage
 
-You can either add `extend AttrBool::Ext` in your class/module, add `using AttrBool::Ref` in your class/module, or include `require 'attr_bool/core_ext'`.
+You can either add `using AttrBool::Ref` in your class/module/file, add `extend AttrBool::Ext` in your class/module, or include `require 'attr_bool/core_ext'`.
 
 ```ruby
 require 'attr_bool'
@@ -143,35 +143,38 @@ class TheTodd
   # 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.
+
+  # Can do custom logic with a block/proc/lambda.
+  attr_reader?(:cat_fights)    { @cat_fights % 69 }
+  attr_writer?(:hot_surgeries) { |count| @hot_surgeries += count }
+
+  attr_accessor? :headband, 'banana_hammock',
+                 reader: -> { @wearing == :flaming },
+                 writer: ->(value) { @wearing = value }
 end
 ```
 
-If you don't want to have to add `extend AttrBool::Ext` to every class/module, you can simply refine the top module in your gem/library/app:
+If you don't want to have to add `extend AttrBool::Ext` to every inner class/module (within the same file), then you can simply refine the outer module or the file:
 
 ```ruby
 require 'attr_bool'
 
+#using AttrBool::Ref  # Can refine the entire file instead (doesn't affect other files).
+
 module TheToddMod
   using AttrBool::Ref
-end
 
-# --- Some other file.
-module TheToddMod
   class TheTodd
     attr_bool :banana_hammock
   end
+
+  class TheToddBod
+    attr_bool :bounce_pecs
+  end
 end
 ```
 
@@ -197,7 +200,7 @@ class TheTodd
 end
 ```
 
-You can either disable this Cop or adjust it accordingly:
+You can either adjust this Cop accordingly or disable it:
 
 ```yaml
 Layout/EmptyLinesAroundAttributeAccessor:

data/attr_bool.gemspec

@@ -14,8 +14,8 @@ Gem::Specification.new do |spec|
   spec.description = <<~DESC
     #{spec.summary}
 
-    Pick one:
-      (1) in your top module, add `using AttrBool::Ref`,
+    To get started, pick one:
+      (1) in your class/module/file, 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'`.
 

data/lib/attr_bool/version.rb

@@ -9,5 +9,5 @@
 #++
 
 module AttrBool
-  VERSION = '0.3.0'
+  VERSION = '0.3.2'
 end

data/lib/attr_bool.rb

@@ -15,9 +15,10 @@ require 'attr_bool/version'
 # ```
 # require 'attr_bool'
 #
+# #using AttrBool::Ref  # Can use refinements instead of `extend AttrBool::Ext`.
+#
 # class TheTodd
 #   extend AttrBool::Ext
-#   #using AttrBool::Ref  # Can use refinements instead.
 #
 #   # Can use multiple symbols and/or strings.
 #   attr_accessor? :flexing, 'bounce_pecs'
@@ -25,18 +26,18 @@ require 'attr_bool/version'
 #   # 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.
+#
+#   # Can do custom logic with a block/proc/lambda.
+#   attr_reader?(:cat_fights)    { @cat_fights % 69 }
+#   attr_writer?(:hot_surgeries) { |count| @hot_surgeries += count }
+#
+#   attr_accessor? :headband, 'banana_hammock',
+#                  reader: -> { @wearing == :flaming },
+#                  writer: ->(value) { @wearing = value }
 # end
 # ```
 module AttrBool
@@ -108,24 +109,21 @@ module AttrBool
 
     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
+      # Example:
+      #   protected attr_bool :banana_hammock,:bounce_pecs
       method_names = []
 
       # noinspection RubySimplifyBooleanInspection
-      names.map do |name|
+      names.each do |name|
+        # Most of the time, users will use the `ivar` way, so just create it once here,
+        # instead of potentially twice inside the if-blocks.
         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?
+          if reader.nil? # Not a Proc?
             instance_variable_get(ivar) # Fail fast if `ivar` is invalid.
 
             if force_bool
@@ -133,6 +131,12 @@ module AttrBool
             else
               define_method(name_q) { instance_variable_get(ivar) }
             end
+          else # Proc?
+            if force_bool
+              define_method(name_q) { instance_exec(&reader) ? true : false }
+            else
+              define_method(name_q,&reader)
+            end
           end
         end
 
@@ -140,13 +144,7 @@ module AttrBool
           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?
+          if writer.nil? # Not a Proc?
             instance_variable_get(ivar) # Fail fast if `ivar` is invalid.
 
             if force_bool
@@ -154,6 +152,12 @@ module AttrBool
             else
               define_method(name_eq) { |value| instance_variable_set(ivar,value) }
             end
+          else # Proc?
+            if force_bool
+              define_method(name_eq) { |value| instance_exec(value ? true : false,&writer) }
+            else
+              define_method(name_eq,&writer)
+            end
           end
         end
       end
@@ -165,6 +169,8 @@ module AttrBool
   ##
   # Example usage:
   # ```
+  # #using AttrBool::Ref  # Can refine the entire file instead (doesn't affect other files).
+  #
   # module TheToddMod
   #   using AttrBool::Ref
   #

data/test/ref_test.rb

@@ -29,7 +29,7 @@ describe AttrBool::Ref do
     end
 
     it 'refines the core Class & Module inside of its scope only once' do
-      # JRuby doesn't implement used_modules() currently.
+      # NOTE: JRuby doesn't implement used_modules() currently.
       if RUBY_PLATFORM != 'java'
         _(@sut.class_used_modules.count(AttrBool::Ref)).must_equal(1)
         _(@sut.module_used_modules.count(AttrBool::Ref)).must_equal(1)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: attr_bool
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.2
 platform: ruby
 authors:
 - Bradley Whited
@@ -12,8 +12,8 @@ dependencies: []
 description: |
   Finally attr_accessor? & attr_reader? with question marks for booleans/predicates!?
 
-  Pick one:
-    (1) in your top module, add `using AttrBool::Ref`,
+  To get started, pick one:
+    (1) in your class/module/file, 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'`.
 
@@ -62,7 +62,7 @@ rdoc_options:
 - "--markup"
 - markdown
 - "--title"
-- AttrBool v0.3.0
+- AttrBool v0.3.2
 - "--main"
 - README.md
 require_paths:
@@ -78,7 +78,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.1
 specification_version: 4
 summary: Finally attr_accessor? & attr_reader? with question marks for booleans/predicates!?
 test_files: []