custom_boolean 0.1.4 → 0.1.5

data/CHANGELOG

@@ -5,7 +5,6 @@
 * added more examples and tests
 27/9/10 version 0.1.1
 * added boolean operators
-	
 27/9/10 version 0.1.0
 * release!
 	

data/README.markdown

@@ -1,16 +1,22 @@
 Custom Boolean
 ==============
 
-Cute hack to have if/else_if/else conditions with user-defined
-truthiness.
+Tired of the way Ruby sees truth? Want to experiment with the
+way other languages see it? No? Oh well, you may still want to have a play...
+
+CustomBoolean is a little hack to bring user-defined truthiness to
+`if/else_if/else`-like expressions.
 
 * Implements various preset truth tests: Ruby, Python, Perl, C, Strict Boolean.
 * Provides ability to completely customize truthiness.
 * Provides common Boolean Operators (and, or, not) compatible with CustomBoolean
+* Read the [documentation](http://rdoc.info/github/banister/custom_boolean/master/frames)
+* See the [source code](http://github.com/banister/custom_boolean)
+* Install the [gem](https://rubygems.org/gems/custom_boolean) `gem install custom_boolean`
 
 Normal conditionals:
 --------------------
-    if!(0) { 
+    if_(0) { 
         puts 'true' 
     }.
     else { 
@@ -25,7 +31,7 @@ A Pythonic truthiness:
     # redefine truthiness with the `truth_test` method
     CustomBoolean.truth_test = CustomBoolean::PYTHON_TRUTH
 
-    if!(0) { 
+    if_(0) { 
         puts 'true' 
     }.
     else { 
@@ -38,7 +44,7 @@ A full example:
 ------------------------
 
     x = 5
-    if!(x == 4) {
+    if_(x == 4) {
         puts 'x is 4' 
     }.
     else_if(x == 5) {
@@ -57,11 +63,11 @@ Nested ifs work fine:
     x = :delighted
     y = :aroused
     
-    if?(x == :sad) {
+    if_(x == :sad) {
       puts 'evaluates to true' 
     }.
     else_if(x == :delighted) {
-      if?(y == :happy) {
+      if_(y == :happy) {
         puts 'delighted and happy'
       }.
       else_if(y == :aroused) {
@@ -72,13 +78,13 @@ Nested ifs work fine:
     else {
       puts 'not delighted'
     }
-
+    #=> "delighted and aroused"
 
 If expressions
 ----------------
 
-    # prefixing `if!` with `+` invokes if-expression behaviour
-    +if!(false) {
+    # prefixing `if_` with `+` invokes if-expression behaviour
+    +if_(false) {
       :hello
     }.
     else {
@@ -99,7 +105,7 @@ Use as follows:
 
     CustomBoolean.truth_test = CustomBoolean::C_TRUTH
 
-    +if!(0) {
+    +if_(0) {
       true
     }.
     else {
@@ -116,7 +122,7 @@ Customizable truthiness
     # only :horse is true
     CustomBoolean.truth_test = proc { |b| b == :horse }
     
-    if!(true) {
+    if_(true) {
       puts 'evaluates to true' 
     }.
     else {
@@ -124,7 +130,7 @@ Customizable truthiness
     }
     # => 'reached else
     
-    if!(:horse) {
+    if_(:horse) {
       puts 'evaluates to true' 
     }.
     else {
@@ -132,17 +138,18 @@ Customizable truthiness
     }
     #=> 'evaluates to true'
 
+
 Boolean operators
 -----------------
 
-The ordinary `&&` and `||` and `!` operators do not implement
-CustomBoolean truthiness. Instead use `Object#and`, `Object#or`, and
-`Object#negate` (or `Object#&` and `Object#|` and `true.&` and `false.|`, etc)
+The ordinary && and || and ! operators do not implement
+CustomBoolean truthiness. Instead use Object#and, Object#or, and
+Object#negate (or Object#& and Object#| and true.& and false.|, etc)
 
     # use perl truthiness where "0" is false
     CustomBoolean.truth_test = CustomBoolean::PERL_TRUTH
 
-    +if!(true & "0") {
+    +if_(true & "0") {
       true
     }.
     else {
@@ -151,23 +158,23 @@ CustomBoolean truthiness. Instead use `Object#and`, `Object#or`, and
     #=> false
 
     # Or use Object#and
-    +if!(true.and "0") {...}
+    +if_(true.and "0") {...}
 
     # Use negate (rather than not)
-    +if!(negate("0")) { true } ##=> true   
+    +if_(negate("0")) { true } ##=> true   
     
 Testing truthiness of expressions
 ----------------------------------
 
 You can test the truthiness of an expression without using the
-full machinery of if!/else_if/else. Just use the
+full machinery of if_/else_if/else. Just use the
 `CustomBoolean.truthy?()` function:
 
     CustomBoolean.truth_test = CustomBoolean::PERL_TRUTH
     CustomBoolean.truthy?("0") #=> false
     
 Feedback
------------
+---------
 
 Problems or bugs, file an issue!
 

data/lib/custom_boolean.rb

@@ -97,13 +97,7 @@ class CustomBoolean
 
   class << self
 
-    # @return [Proc] The proc that defines the truth test
-    attr_accessor :truth_test
-
-    # Tests whether *condition* is truthy according to
-    # CustomBoolean truthiness.
-    # CustomBoolean truthiness is determined by the proc referenced
-    # by CustomBoolean.truth_test.
+    # Determines the truth test to apply (for CustomBoolean truthiness)
     # 
     # Built in Truth tests include:
     # 
@@ -119,13 +113,29 @@ class CustomBoolean
     # 
     # @example changing truthiness to a preset 
     #   CustomBoolean.truth_test = CustomBoolean::PYTHON_TRUTH
-    # @example user-defined truthiness  
+    # @example user-defined truthiness 
     #   # only :horse is true:
     #   CustomBoolean.truth_test = proc { |expr| expr == :horse }
-    # @param condition an expression to evaluate
+    # @param [Proc] truth_test_proc The Proc that defines the truth test
+    # @return [Proc] The proc that defines the truth test
+    attr_accessor :truth_test
+
+    # Tests whether *expression* is truthy according to
+    # CustomBoolean truthiness.
+    # CustomBoolean truthiness is determined by the proc referenced
+    # by CustomBoolean.truth_test.
+    # @param expr an expression to evaluate
     # @return [Boolean]
-    def truthy?(condition)
-      self.truth_test.call(condition)
+    # @example using C truthiness
+    #   CustomBoolean.truth_test = CustomBoolean::C_TRUTH
+    #   CustomBoolean.truthy?(0) #=> false
+    # @example defining and using *horse* truthiness :)
+    #   # only :horse is *true*
+    #   CustomBoolean.truth_test = proc { |expr| expr == :horse }
+    #   CustomBoolean.truthy?(:horse) #=> true
+    #   CustomBoolean.truthy?(true) #=> false
+    def truthy?(expr)
+      self.truth_test.call(expr)
     end
   end
 
@@ -152,10 +162,10 @@ class CustomBoolean
   # @return [Object] extracts the value of the if, transforming it
   #   into an if-expression
   # @example single if-expression example
-  #   +if(true) { :hello } #=> :hello
-  #   +if(false) { :hello } #=> nil
+  #   +if_(true) { :hello } #=> :hello
+  #   +if_(false) { :hello } #=> nil
   # @example if-else-expression example
-  #   +if(false) {
+  #   +if_(false) {
   #     :hello
   #   }.
   #   else {

data/lib/custom_boolean/version.rb

@@ -1,3 +1,3 @@
 class CustomBoolean
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/test/test.rb

@@ -295,9 +295,12 @@ class CustomBooleanTest < Test::Unit::TestCase
       }
       assert_equal(true, val.value)
     end
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
   end
 
   def test_ruby_truth
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+
     [nil, false].each do |v|
       val = if?(v) {
         true

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: custom_boolean
 version: !ruby/object:Gem::Version 
-  hash: 19
   prerelease: false
   segments: 
   - 0
   - 1
-  - 4
-  version: 0.1.4
+  - 5
+  version: 0.1.5
 platform: ruby
 authors: 
 - John Mair (banisterfiend)
@@ -15,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-28 00:00:00 +13:00
+date: 2010-09-29 00:00:00 +13:00
 default_executable: 
 dependencies: []
 
@@ -53,7 +52,6 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"
@@ -62,7 +60,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
-      hash: 3
       segments: 
       - 0
       version: "0"