custom_boolean 0.1.0

data/CHANGELOG

@@ -0,0 +1,2 @@
+27/0/10 version 0.1.0
+* release!

data/README.markdown

@@ -0,0 +1,46 @@
+Custom Boolean
+==============
+
+Cute hack to have if/else_if/else conditions with user-defined truthiness
+
+Normal conditionals:
+--------------------
+    if!(0) { 
+        puts 'true' 
+    }.
+    else { 
+        puts 'false' 
+    }
+
+    #=> 'true'
+
+A Pythonic truthiness:
+----------------------
+
+    # redefine truthiness with the `truth_test` method
+    CustomBoolean.truth_test = proc { |b| b && b != 0 && b != [] }
+
+    if!(0) { 
+        puts 'true' 
+    }.
+    else { 
+        puts 'false' 
+    }
+
+    #=> false
+
+A full example:
+------------------------
+
+    x = 5
+    if!(x == 4) {
+        puts 'x is 4' 
+    }.
+    else_if(x == 5) {
+        puts 'x is 5'
+    }.
+    else {
+        puts 'x is neither 4 nor 5'
+    }
+
+    #=> "x is 5"

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake/gempackagetask'
+require './lib/custom_boolean/version'
+
+$dlext = Config::CONFIG['DLEXT']
+
+specification = Gem::Specification.new do |s|
+  s.name = "custom_boolean"
+  s.summary = "Handrolled if/else expressions with customizable truthiness"
+  s.version = CustomBoolean::VERSION
+  s.date = Time.now.strftime '%Y-%m-%d'
+  s.author = "John Mair (banisterfiend)"
+  s.email = 'jrmair@gmail.com'
+  s.description = s.summary
+  s.require_path = 'lib'
+  s.platform = Gem::Platform::RUBY
+  s.homepage = "http://banisterfiend.wordpress.com"
+  s.has_rdoc = false
+  s.files =  ["Rakefile", "README.markdown", "CHANGELOG", 
+              "lib/custom_boolean.rb", "lib/custom_boolean/version.rb"] +
+    FileList["examples/*.rb", "test/*.rb"].to_a
+end
+
+Rake::GemPackageTask.new(specification) do |package|
+  package.need_zip = false
+  package.need_tar = false
+end
+

data/examples/example.rb

@@ -0,0 +1,18 @@
+require './lib/custom_boolean'
+
+x = 7
+if!(x == 4) {
+  puts 'x is 4' 
+}.
+else_if(x == 5) {
+  puts "x is #{x} (first else_if)"
+}.
+else_if(x == 7) {
+  puts "x is #{x} (second else_if)"
+}.
+else_if(x == 10) {
+  puts 'x is #{x} (third else_if)'
+}.
+else {
+  puts 'reached else'
+}

data/lib/custom_boolean/version.rb

@@ -0,0 +1,3 @@
+class CustomBoolean
+  VERSION = "0.1.0"
+end

data/lib/custom_boolean.rb

@@ -0,0 +1,102 @@
+# CustomBoolean by John Mair (banisterfiend)
+# MIT license
+
+module CustomBooleanOperators
+  def &(other)
+    CustomBoolean.truthy?(self) && CustomBoolean.truthy?(other)
+  end
+  alias and &
+  
+  def |(other)
+    CustomBoolean.truthy?(self) || CustomBoolean.truthy?(other)
+  end
+  alias or |
+end
+
+true.extend(CustomBooleanOperators)
+false.extend(CustomBooleanOperators)
+Object.send(:include, CustomBooleanOperators)
+
+def negate(other)
+  !CustomBoolean.truthy?(self)
+end
+  
+def if_(condition, &block)
+  truth = !!CustomBoolean.truthy?(condition)
+  bvalue = block.call if truth
+  CustomBoolean.new(truth, bvalue)
+end
+
+# bunch of aliases for if_
+alias if! if_
+alias _if if_
+alias if? if_
+
+class CustomBoolean
+  attr_accessor :truth_value, :value
+
+  class << self
+    attr_accessor :truth_test
+
+    def truthy?(condition)
+      self.truth_test.call(condition)
+    end
+  end
+
+  # exception raised when conditionals invoked after an else
+  InvalidConditional = Class.new(StandardError)
+  
+  # various ideas of truth
+  RUBY_TRUTH = proc { |expr| expr }
+  PYTHON_TRUTH = proc { |expr| expr && !(expr.respond_to?(:empty?) && expr.empty?) && expr != 0 }
+  STRICT_TRUTH = proc { |expr| raise "Expression must be strictly true or false." if expr != true && expr != false; expr }
+  PERL_TRUTH = proc { |expr| expr && expr != 0 && expr != "" && expr != "0" }
+  C_TRUTH = proc { |expr| expr && expr != 0 }
+    
+  # default truth test is Ruby's
+  self.truth_test = RUBY_TRUTH
+  
+  def initialize(truth_value, block_value)
+    self.truth_value = truth_value
+    self.value = block_value
+  end
+
+  def +@
+    self.value
+  end
+  
+  def else_if(condition, &block)
+    raise InvalidConditional, "No further conditionals allowed after an else." if self.truth_value == :else_reached
+
+    if self.truth_value
+      CustomBoolean.new(true, self.value)
+    else
+      truth = !!CustomBoolean.truthy?(condition)
+      bvalue = block.call if truth
+      CustomBoolean.new(truth, bvalue)
+    end
+  end
+
+  # a bunch of aliases for else_if
+  alias else_if? else_if
+  alias else_if! else_if
+  alias elsif else_if
+  alias elsif? else_if
+  alias elsif! else_if
+  
+  def else(&block)
+    raise InvalidConditional, "No further conditionals allowed after an else." if self.truth_value == :else_reached
+
+    if self.truth_value
+      CustomBoolean.new(:else_reached, self.value)
+    else
+      bvalue = block.call 
+      CustomBoolean.new(:else_reached, bvalue)
+    end
+  end
+
+  # a bunch of aliases for else 
+  alias else? else
+  alias else! else
+end
+

data/test/test.rb

@@ -0,0 +1,324 @@
+
+require '../lib/custom_boolean'
+require 'test/unit'
+
+class CustomBooleanTest < Test::Unit::TestCase
+  def test_if_true
+    result = if?(5 == 5) { :is_equal }
+
+    assert_equal(true, result.truth_value)
+  end
+
+  def test_if_false
+    result = if?(5 == 6) { :is_equal }
+
+    assert_equal(false, result.truth_value)
+  end
+
+  def test_else_if_true
+    result = (if?(5 == 5) { :is_equal }.
+      else_if?(6 == 6) { :is_equal })
+
+    assert_equal(true, result.truth_value)
+  end
+
+  def test_else_if_false
+    result = (if?(5 == 6) { :is_equal }.
+      else_if?(6 == 7) { :is_equal })
+
+    assert_equal(false, result.truth_value)
+  end
+
+  def test_else_true
+    result = (if?(5 == 5) { :is_equal }.
+      else? { :is_equal })
+
+    assert_equal(:is_equal, result.value)
+    assert_equal(:else_reached, result.truth_value)
+  end
+
+  def test_else_false
+    result = (if?(5 == 6) { :is_equal }.
+      else? { :is_equal })
+
+    assert_equal(:is_equal, result.value)
+  end
+
+  def test_else_if_else_false
+    result = if?(5 == 6) { :is_equal }.
+      else_if?(5 == 7) { :is_equal }.
+      else? { :is_equal }
+  
+    assert_equal(:is_equal, result.value)
+    assert_equal(:else_reached, result.truth_value)
+  end
+
+  def test_else_if_true
+    result = if?(5 == 5) { :is_equal_if }.
+      else_if?(5 == 7) { :is_equal_else_if }.
+      else? { :is_equal }
+  
+    assert_equal(:is_equal_if, result.value)
+  end
+
+  def test_else
+    result = if?(5 == 0) { :is_equal }.
+  else? { :in_else }
+
+    assert_equal(:in_else, result.value)
+
+    result = if?(5 == 5) { :is_equal }.
+  else? { :in_else }
+
+    assert_equal(:else_reached, result.truth_value)
+  end
+
+  def test_custom_truth
+    CustomBoolean.truth_test = proc { |b| b && b != 0 }
+
+    result = if?(0) { :is_equal }
+
+    assert_equal(false, result.truth_value)
+
+    # reset truth test
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_custom_truth_else
+    CustomBoolean.truth_test = proc { |b| b && b != 0 }
+
+    result = if?(0) { :is_equal }.
+             else? { :in_else }
+
+    assert_equal(:in_else, result.value)
+
+    # reset truth test
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_nested_if
+    CustomBoolean.truth_test = proc { |b| b && b != 0 }
+
+    y = :blah
+    result = if?(1) {
+      if?(0) { }.
+      else_if?(1) {
+        y = :nested
+      }
+      
+    }.
+    else_if?(1) {
+      y = :else_if
+    }
+
+    assert_equal(:nested, y)
+
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_values
+    val = :outside_if
+    val = if?(true) {
+        :in_if
+      }
+    assert_equal(:in_if, val.value)
+
+    val = if?(true) {
+      :in_if
+    }.
+    else_if?(true) {
+      :in_
+    }
+
+    assert_equal(:in_if, val.value)
+  end
+
+  def test_values_else_if_chain
+    val = if?(true) {
+      :hello
+    }.
+    elsif?(true) {
+    }.
+    else_if?(true) {
+    }
+
+    assert_equal(:hello, val.value)
+
+    val = if?(false) {
+    }.
+    elsif?(true) {
+      :goodbye
+    }.
+    else_if?(true) {
+    }
+
+    assert_equal(:goodbye, val.value)
+
+    val = if?(false) {
+    }.
+    elsif?(false) {
+    }.
+    else_if?(true) {
+      :tiger
+    }
+
+    assert_equal(:tiger, val.value)    
+  end
+
+  def test_conditional_after_else_exception
+
+    assert_raises(CustomBoolean::InvalidConditional) do
+      if?(true) {}.
+      else? {}.
+      else? {}
+    end
+
+    assert_raises(CustomBoolean::InvalidConditional) do
+      if?(false) {}.
+      else_if?(true) {}.
+    else? {}.
+      else_if?(false) {}
+    end
+  end
+
+  def test_else_if_aliases
+    assert_nothing_thrown do
+      if?(false) {}.
+      else_if(false) {}.
+      else_if!(false) {}.
+      else_if?(false) {}.
+      elsif?(true) {}.
+      elsif!(true) {}.
+      elsif(true) {}.
+      else {}
+    end
+  end
+
+  def test_perl_truth
+    CustomBoolean.truth_test = CustomBoolean::PERL_TRUTH
+
+    ["0", "", 0].each do |v|
+      val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(false, val.value)
+    end
+
+    val = if?("hello") {
+      true
+    }.
+    else? {
+      false
+    }
+    assert_equal(true, val.value)
+
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_python_truth
+    CustomBoolean.truth_test = CustomBoolean::PYTHON_TRUTH
+
+    [{}, [], "", 0].each do |v|
+      val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(false, val.value)
+    end
+
+    val = if?("hello") {
+      true
+    }.
+    else? {
+      false
+    }
+    assert_equal(true, val.value)
+
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_strict_truth
+    CustomBoolean.truth_test = CustomBoolean::STRICT_TRUTH
+
+    assert_nothing_thrown do
+      val = if?(true) {
+        true
+      }.
+      else? {
+        false
+      }
+
+      assert_equal(true, val.value)
+
+      val = if?(false) {
+        true
+      }.
+      else? {
+        false
+      }
+
+      assert_equal(false, val.value)
+    end
+
+    [nil, 0, "", "hello", [], {}].each do |v|
+      assert_raises(RuntimeError) do
+        if?(v) {}
+      end
+    end
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+
+  def test_c_truth
+    CustomBoolean.truth_test = CustomBoolean::C_TRUTH
+    
+    [nil, false, 0].each do |v|
+      val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(false, val.value)
+    end
+
+   [true, "hello", []].each do |v|
+    val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(true, val.value)
+    end
+  end
+
+  def test_ruby_truth
+    [nil, false].each do |v|
+      val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(false, val.value)
+    end
+
+   [true, "hello", []].each do |v|
+    val = if?(v) {
+        true
+      }.
+      else? {
+        false
+      }
+      assert_equal(true, val.value)
+    end
+    CustomBoolean.truth_test = CustomBoolean::RUBY_TRUTH
+  end
+end
+
+ 

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification 
+name: custom_boolean
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Mair (banisterfiend)
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-27 00:00:00 +13:00
+default_executable: 
+dependencies: []
+
+description: Handrolled if/else expressions with customizable truthiness
+email: jrmair@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- Rakefile
+- README.markdown
+- CHANGELOG
+- lib/custom_boolean.rb
+- lib/custom_boolean/version.rb
+- examples/example.rb
+- test/test.rb
+has_rdoc: true
+homepage: http://banisterfiend.wordpress.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Handrolled if/else expressions with customizable truthiness
+test_files: []
+