safebool 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 49890c47adb87fba1069508825a740bd74ebbf3f
-  data.tar.gz: b29817d48444282a920610adc1ab79f56a3f926b
+  metadata.gz: e5a56c5aa20a4d11dd6ce2ebba0546355956cf02
+  data.tar.gz: d2e2851c0a079a483bb3521f4904492b010eb1e5
 SHA512:
-  metadata.gz: 83a6120727830d700d61e9b79933f372d353767f533b8b2ae5562c75996702e9871ab844f19dacd25faacbe8827dae6bc65879e6e2a2306379cabe32c9f2332d
-  data.tar.gz: 236b0f27a9ddf40a7b7ae8ee77b0596c8e1a323e919c1112be22ab3a093ad15cce268596bababd9936d1807158b2eff547d0ce8d50c5c60c9a2276a0b2ead323
+  metadata.gz: c1f80ebf778f848f3db67011ef045d92ffba850f7b67e9fb4565d8851567597bad4715a30246796a43056c4bb0138de182cfccad455e7acaf24407dac7d3f716
+  data.tar.gz: a95229a84ee2dd89555e09885320a22b2daae5cf38d279f59e63005969466419c0642ff5859127fec50467194c206b819b5684bf9616843ba0a859f5f5f1f204

data/README.md

@@ -21,7 +21,7 @@ true.class            #=> TrueClass
 false.is_a?(Bool)     #=> NameError: uninitialized constant Bool
 true.is_a?(Bool)      #=> NameError: uninitialized constant Bool
 true.class.ancestors  #=> [TrueClass, Object, Kernel, BasicObject]
-false.class.ancestors #=> [TrueClass, Object, Kernel, BasicObject]
+false.class.ancestors #=> [FalseClass, Object, Kernel, BasicObject]
 
 # -or-
 
@@ -42,7 +42,7 @@ Why? Why not? Discuss.
 false.is_a?(Bool)     #=> true
 true.is_a?(Bool)      #=> true
 true.class.ancestors  #=> [TrueClass, Bool, Object, Kernel, BasicObject]
-false.class.ancestors #=> [TrueClass, Bool, Object, Kernel, BasicObject]
+false.class.ancestors #=> [FalseClass, Bool, Object, Kernel, BasicObject]
 
 # -or-
 
@@ -55,11 +55,27 @@ Bool(1)               #=> true
 0.to_b                #=> false
 Bool("false")         #=> false
 Bool(0)               #=> false
+```
+
+How about handling errors on invalid bool values when converting / parsing?
+
+1. `to_b` always return a bool even if the conversion / parsing failed e.g. `true` (for numbers) and `false` (for strings) on error
+2. `parse_bool/to_bool` always returns `nil` if the conversion / parsing failed
+3. `Bool()` always raises a `TypeError` if the conversion / parsing failed
 
+
+``` ruby
+"2".to_b              #=> false
+"2".to_bool           #=> nil
+2.to_b                #=> true
+2.to_bool             #=> nil     
+Bool("2")             #=> TypeError: cannot convert "2":String to Bool; method parse_bool/to_bool expected
+Bool(2)               #=> TypeError: cannot convert 2:Fixnum to Bool; method parse_bool/to_bool expected
 ...
 ```
 
 
+
 More methods added to `Kernel` include `bool?`, `false?`, `true?`.
 Example:
 
@@ -77,7 +93,7 @@ false.false?  #=> true
 true.false?   #=> false
 nil.false?    #=> false
 
-# true? - returns true is object class is TrueClass, otherwise false
+# true? - returns true if object class is TrueClass, otherwise false
 
 true.true?    #=> true
 false.true?   #=> false

data/lib/safebool.rb

@@ -7,13 +7,54 @@ require 'safebool/version'    # note: let version always go first
 
 
 module Bool
-  def self.zero() false; end   ## note: false.frozen? == true  by default
 
-  def to_b()      self; end
-  def to_bool()   self; end
+  TRUE_VALUES =  ['true', 'yes', 'on', 't', 'y', '1']
+  FALSE_VALUES = ['false', 'no', 'off', 'f', 'n', '0']
+
+  def self.parse( o )
+    if o.is_a? String
+      str = o
+    else  ## try "coerce" to string
+      str = o.to_str
+    end
+
+    case str.downcase.strip
+    when *TRUE_VALUES
+      true
+    when *FALSE_VALUES
+      false
+    else
+      nil   ## note: returns nil if cannot convert to true or false
+    end
+  end
+
+
+  def self.convert( o )   ## used by "global" Bool( o ) kernel conversion method
+    value = if o.respond_to?( :to_bool )
+              o.to_bool     # returns true/false/nil
+            elsif o.respond_to?( :parse_bool )  ## check parse_bool alias
+              o.parse_bool  # returns true/false/nil
+            else
+              nil
+            end
+
+    if value.nil?
+      raise TypeError.new( "cannot convert >#{o.inspect}< of type >#{o.class.name}< to Bool; method parse_bool/to_bool expected")
+    else
+      value
+    end
+  end
+
+  def self.zero() false; end   ## note: false.frozen? == true by default
+
+
+  def to_b()       self; end
+  def parse_bool() self; end
+  alias_method :to_bool, :parse_bool
 end # module Bool
 
 
+
 class FalseClass
   include Bool     ## "hack" - enables false.is_a?(Bool)
 
@@ -50,7 +91,7 @@ module Kernel
   def false?() self.class == FalseClass; end  ## todo/discuss: use "shortcut" self == false - why? why not?
 
   ############
-  ## Returns true is object class is TrueClass, otherwise false.
+  ## Returns true if object class is TrueClass, otherwise false.
   ##
   ## true.true?   #=> true
   ## false.true?  #=> false
@@ -64,46 +105,47 @@ module Kernel
 
 
   ### "global" conversion function / method
-  def Bool( o )
-    ## todo/discuss: check convention
-    ##   only (explicit) convert if to_bool present - why? why not?
-    ##    - check to_int/to_str/etc.
-    if o.respond_to?( :to_bool )
-      o.to_bool
-    elsif o.respond_to?( :to_b )
-      o.to_b
-    else
-      raise TypeError.new( "cannot convert >#{o.class.inspect}< to Bool; method to_bool or to_b expected")
-    end
-  end
+  def Bool( o ) Bool.convert( o ); end
 end
 
 
 
+class NilClass
+  def to_b() false; end
+  def parse_bool() false; end
+  alias_method :to_bool, :parse_bool
+end
 
 class String
   def to_b
-    case self.downcase.strip
-    when 'true', 'yes', 'on', 't', 'y', '1'
-      return true
-    ## when 'nil', 'null'   # todo/discuss - add why? why not?
-    ##  return nil
-    else
-      return false
-    end
+    value = parse_bool()
+    value.nil? ? false : value   ## note return false for all undefined / unknown string values
   end
-  alias_method :to_bool, :to_b
+  def parse_bool() Bool.parse( self ); end
+  alias_method :to_bool, :parse_bool
 end
 
-
 class Symbol
   def to_b() to_s.to_b; end
-  alias_method :to_bool, :to_b
+  def parse_bool() to_s.parse_bool(); end
+  alias_method :to_bool, :parse_bool
 end
 
 class Numeric
-  def to_b() self == 0 ? false : true; end
-  alias_method :to_bool, :to_b
+  def to_b()
+    value = parse_bool()
+    value.nil? ? true : value   ## note return **true** for all undefined / unknown number/numeric values
+  end
+  def parse_bool()
+    if self == 0
+      false
+    elsif self == 1
+      true
+    else
+      nil  ## note: returns nil if cannot convert to true or false
+    end
+  end
+  alias_method :to_bool, :parse_bool
 end
 
 

data/lib/safebool/version.rb

@@ -8,8 +8,8 @@
 
 module SaferBool
 
-  MAJOR = 0
-  MINOR = 1
+  MAJOR = 1
+  MINOR = 0
   PATCH = 0
   VERSION = [MAJOR,MINOR,PATCH].join('.')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safebool
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Gerald Bauer