bondage-0.1.2 Documentation

DESCRIPTION:

class Binding stinks, module Bondage stinks less. Bondage provides hashes of local, global, instance, etc. variables, and provides the Enumerable interface for locals directly. It also provides [] syntax to get/set binding variables directly.

FEATURES/PROBLEMS:

SYNOPSIS:

  require 'lib/bondage'

  x = 1
  y = 2

  b = binding.extend(Bondage)

  # return variable hashes
  p b.locals # => {:x=>1, :y=>2, :b=>#<Binding:0xxxxxxx>}
  p b.globals[:$PROGRAM_NAME] # => "synopis.rb"

  #concerned about the environement?
  p b.globals # => {:#!=>nil, :$SAFE=>0, ...}

  # set and retrieve
  b[:z] = ["one", "two", "three"]
  p b[:$LOAD_PATH] # => ["./lib", ...]
  p b[:@pizza] # => nil

  # supports Enumerable over locals
  p b.find {|var, value| value == 1 } # => [:x, 1]

  # Or if you're feeling really kinky
  class Binding
    include Bondage
  end

REQUIREMENTS:

Tested under Ruby 1.8.7.

INSTALL:

sudo gem install bondage

LICENSE:

(The MIT License)

Copyright © 2009 Justin Love

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ‘Software’), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED ‘AS IS’, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Files

Classes/Modules

Methods

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.