safebool 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 00e164b8268e6072b5e8c6653d6894a0849d05f8
-  data.tar.gz: 958ff5957be5ff0fb40b77cbc3046fad3489d65e
+  metadata.gz: 49890c47adb87fba1069508825a740bd74ebbf3f
+  data.tar.gz: b29817d48444282a920610adc1ab79f56a3f926b
 SHA512:
-  metadata.gz: b8fd8ee08af9acbdfa90ca77ba5ff759e84bd67d5846d706225261994f38ba0604d4082843584ad57a359999cb4b5d5469fc76802a592ec4525c6924fdf16c13
-  data.tar.gz: 75865ab6eec156c23775359764933fafbfb50fd39735068dd77cbccfdb3b00e63850e4a01f1a1d341cad387cf539a691d66f8416250860c5fe1a001f2bbca59d
+  metadata.gz: 83a6120727830d700d61e9b79933f372d353767f533b8b2ae5562c75996702e9871ab844f19dacd25faacbe8827dae6bc65879e6e2a2306379cabe32c9f2332d
+  data.tar.gz: 236b0f27a9ddf40a7b7ae8ee77b0596c8e1a323e919c1112be22ab3a093ad15cce268596bababd9936d1807158b2eff547d0ce8d50c5c60c9a2276a0b2ead323

data/Manifest.txt

@@ -5,3 +5,5 @@ README.md
 Rakefile
 lib/safebool.rb
 lib/safebool/version.rb
+test/helper.rb
+test/test_bool.rb

data/README.md

@@ -1,5 +1,5 @@
 
-# Safe Bool Type - `Bool()`, `to_b`, `to_bool`, `bool?`, `false?`, `true?`, `true.is_a?(Bool)==true`, `false.is_a?(Bool)==true`, and More
+# Safe Bool Type - `Bool()`, `to_b`, `to_bool`, and More
 
 
 safebool gem / library - safe bool(ean) type adds `Bool()`, `to_b`, `to_bool`, `bool?`, `false?`, `true?`, `true.is_a?(Bool)==true`, `false.is_a?(Bool)==true`, and more
@@ -11,9 +11,83 @@ safebool gem / library - safe bool(ean) type adds `Bool()`, `to_b`, `to_bool`, `
 * rdoc  :: [rubydoc.info/gems/safebool](http://rubydoc.info/gems/safebool)
 
 
+
+## Why `Bool` in Ruby?
+
+
+``` ruby
+false.class           #=> FalseClass
+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]
+
+# -or-
+
+"true".to_b           #=> NoMethodError: undefined method `to_b' for String
+1.to_b                #=> NoMethodError: undefined method `to_b' for Integer
+Bool("true")          #=> NoMethodError: undefined method `Bool' for Kernel
+Bool(1)               #=> NoMethodError: undefined method `Bool' for Kernel
+...
+```
+
+Why? Why not? Discuss.
+
+
+
 ## Usage
 
-To be done
+``` ruby
+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]
+
+# -or-
+
+"true".to_b           #=> true
+1.to_b                #=> true
+Bool("true")          #=> true
+Bool(1)               #=> true
+
+"false".to_b          #=> false
+0.to_b                #=> false
+Bool("false")         #=> false
+Bool(0)               #=> false
+
+...
+```
+
+
+More methods added to `Kernel` include `bool?`, `false?`, `true?`.
+Example:
+
+
+``` ruby
+# bool? - returns true if object class is TrueClass or FalseClass, otherwise false
+
+true.bool?    #=> true
+false.bool?   #=> true
+nil.bool?     #=> false
+
+# false? - returns true if object class is FalseClass, otherwise false
+
+false.false?  #=> true
+true.false?   #=> false
+nil.false?    #=> false
+
+# true? - returns true is object class is TrueClass, otherwise false
+
+true.true?    #=> true
+false.true?   #=> false
+nil.true?     #=> false
+```
+
+And some more.
+See the [`safebool.rb`](https://github.com/s6ruby/safebool/blob/master/lib/safebool.rb) source.
+
+
 
 
 ## License

data/lib/safebool.rb

@@ -6,5 +6,107 @@ require 'pp'
 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
+end # module Bool
+
+
+class FalseClass
+  include Bool     ## "hack" - enables false.is_a?(Bool)
+
+  def zero?() true; end
+end
+
+class TrueClass
+  include Bool    ## "hack" - enables true.is_a?(Bool)
+
+  def zero?() false; end
+end
+
+
+
+
+
+
+module Kernel
+
+  ######
+  ## Returns true if object class is TrueClass or FalseClass, otherwise false.
+  ##
+  ## true.bool?   #=> true
+  ## false.bool?  #=> true
+  ## nil.bool?    #=> false
+  def bool?() self.class == TrueClass || self.class == FalseClass; end  ## todo/discuss: use "shortcut" self == true || self == false - why? why not?
+
+  #########
+  ## Returns true if object class is FalseClass, otherwise false.
+  ##
+  ## false.false?  #=> true
+  ## true.false?   #=> false
+  ## nil.false?    #=> false
+  def false?() self.class == FalseClass; end  ## todo/discuss: use "shortcut" self == false - why? why not?
+
+  ############
+  ## Returns true is object class is TrueClass, otherwise false.
+  ##
+  ## true.true?   #=> true
+  ## false.true?  #=> false
+  ## nil.true?    #=> false
+  def true?() self.class == TrueClass; end    ## todo/discuss: use "shortcut" self == true - why? why not?
+
+
+  #####
+  #   default "explicit" conversion to bool for all objects
+  def to_b() self ? true : false; end
+
+
+  ### "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
+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
+  end
+  alias_method :to_bool, :to_b
+end
+
+
+class Symbol
+  def to_b() to_s.to_b; end
+  alias_method :to_bool, :to_b
+end
+
+class Numeric
+  def to_b() self == 0 ? false : true; end
+  alias_method :to_bool, :to_b
+end
+
+
+
 
 puts SaferBool.banner    ## say hello

data/lib/safebool/version.rb

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

data/test/helper.rb

@@ -0,0 +1,8 @@
+## minitest setup
+
+require 'minitest/autorun'
+
+
+## our own code
+
+require 'safebool'

data/test/test_bool.rb

@@ -0,0 +1,96 @@
+# encoding: utf-8
+
+###
+#  to run use
+#     ruby -I ./lib -I ./test test/test_bool.rb
+
+
+require 'helper'
+
+
+class TestBool < MiniTest::Test
+
+  def test_bool
+    assert_equal true,  false.is_a?(Bool)
+    assert_equal true,  false.false?
+    assert_equal false, false.true?
+    assert_equal true,  false.bool?
+    assert_equal false, false.to_b
+
+    assert_equal true,  true.is_a?(Bool)
+    assert_equal true,  true.true?
+    assert_equal false, true.false?
+    assert_equal true,  true.bool?
+    assert_equal true,  true.to_b
+  end
+
+  def test_nil
+    assert_equal false, nil.to_b
+    assert_equal false, Bool(nil)
+
+    assert_equal false, nil.false?
+    assert_equal false, nil.true?
+    assert_equal false, nil.bool?
+  end
+
+  def test_string
+    assert_equal false, "true".false?
+    assert_equal false, "true".true?
+    assert_equal false, "true".bool?
+
+    assert_equal true, "true".to_b
+    assert_equal true, "yes".to_b
+    assert_equal true, "on".to_b
+    assert_equal true, "t".to_b
+    assert_equal true, "y".to_b
+    assert_equal true, "1".to_b
+
+    assert_equal true, "TRUE".to_b
+    assert_equal true, "YES".to_b
+    assert_equal true, "ON".to_b
+    assert_equal true, "T".to_b
+    assert_equal true, "Y".to_b
+
+    assert_equal true, Bool("true")
+    assert_equal true, Bool("yes")
+    assert_equal true, Bool("on")
+    assert_equal true, Bool("t")
+    assert_equal true, Bool("y")
+    assert_equal true, Bool("1")
+  end
+
+  def test_symbol
+    assert_equal false, :true.false?
+    assert_equal false, :true.true?
+    assert_equal false, :true.bool?
+
+    assert_equal true, :true.to_b
+    assert_equal true, :yes.to_b
+    assert_equal true, :on.to_b
+    assert_equal true, :t.to_b
+    assert_equal true, :y.to_b
+    assert_equal true, :"1".to_b
+
+    assert_equal true, Bool(:true)
+    assert_equal true, Bool(:yes)
+    assert_equal true, Bool(:on)
+    assert_equal true, Bool(:t)
+    assert_equal true, Bool(:y)
+    assert_equal true, Bool(:"1")
+  end
+
+
+  def test_integer
+    assert_equal false, 1.false?
+    assert_equal false, 1.true?
+    assert_equal false, 1.bool?
+
+    assert_equal false, 0.to_b
+    assert_equal true,  1.to_b
+    assert_equal true,  2.to_b
+
+    assert_equal false, Bool(0)
+    assert_equal true,  Bool(1)
+    assert_equal true,  Bool(2)
+  end
+end  # class TestBool

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: safebool
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Gerald Bauer
@@ -56,6 +56,8 @@ files:
 - Rakefile
 - lib/safebool.rb
 - lib/safebool/version.rb
+- test/helper.rb
+- test/test_bool.rb
 homepage: https://github.com/s6ruby/safebool
 licenses:
 - Public Domain