JustinLove-bondage 0.1.0

data/History.txt

@@ -0,0 +1,13 @@
+== 0.1.0 2009-02-15
+
+* Added a to_s method which adds "+Bondage" to the class name.
+* Specs were working from TextMate, but there was an array ordering mismatch from the command line.
+* Redid readme so the file is constructed from pieces, to avoid some include kinks.
+
+== 0.0.1 2009-02-14
+
+* Initial release:
+  * Hashes of local, global, etc.
+  * Enumerable for locals
+  * [] syntax for getting/setting variables
+  * Sanitize identifier names

data/MIT-LICENSE.txt

@@ -0,0 +1,22 @@
+(The MIT License)
+
+Copyright (c) 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.

data/Manifest.txt

@@ -0,0 +1,16 @@
+History.txt
+MIT-LICENSE.txt
+Manifest.txt
+README.rdoc
+Rakefile
+description.rdoc
+lib/bondage.rb
+script/console
+script/destroy
+script/generate
+spec/bondage_spec.rb
+spec/spec.opts
+spec/spec_helper.rb
+synopsis.rb
+tasks/readme.rake
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,74 @@
+= bondage
+
+* http://github.com/JustinLove/bondage
+
+== 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:
+
+* Note that hashes provided by locals & co are plain old hashes (writing to them won't affect the binding) with references to the real data (modifying the values themselves will be reflected in the binding.)
+* Warning: Uses eval internally, so don't use it with untrusted data.  An attempt is made to sanitize identifier names.  However, if your implementation doesn't support ObjectSpace, the second argument to []= is still evaled directly.
+
+== 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 (c) 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.

data/Rakefile

@@ -0,0 +1,28 @@
+%w[rubygems rake rake/clean fileutils newgem rubigen].each { |f| require f }
+require File.dirname(__FILE__) + '/lib/bondage'
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new('bondage', Bondage::VERSION) do |p|
+  p.developer('Justin Love', 'git@JustinLove.name')
+  p.changes              = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  #p.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+  p.rubyforge_name       = p.name # TODO this is default value
+  # p.extra_deps         = [
+  #   ['activesupport','>= 2.0.2'],
+  # ]
+  p.extra_dev_deps = [
+    ['newgem', ">= #{::Newgem::VERSION}"]
+  ]
+  
+  p.clean_globs |= %w[**/.DS_Store tmp *.log]
+  path = (p.rubyforge_name == p.name) ? p.rubyforge_name : "\#{p.rubyforge_name}/\#{p.name}"
+  p.remote_rdoc_dir = File.join(path.gsub(/^#{p.rubyforge_name}\/?/,''), 'rdoc')
+  p.rsync_args = '-av --delete --ignore-errors'
+end
+
+require 'newgem/tasks' # load /tasks/*.rake
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# task :default => [:spec, :features]

data/description.rdoc

@@ -0,0 +1,12 @@
+= bondage
+
+* http://github.com/JustinLove/bondage
+
+== 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:
+
+* Note that hashes provided by locals & co are plain old hashes (writing to them won't affect the binding) with references to the real data (modifying the values themselves will be reflected in the binding.)
+* Warning: Uses eval internally, so don't use it with untrusted data.  An attempt is made to sanitize identifier names.  However, if your implementation doesn't support ObjectSpace, the second argument to []= is still evaled directly.

data/lib/bondage.rb

@@ -0,0 +1,68 @@
+$:.unshift(File.dirname(__FILE__)) unless
+  $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+#:include:description.rdoc
+#== SYNOPSIS
+#:include:synopsis.rb
+
+module Bondage
+  VERSION = '0.1.0'
+  
+  # Adds "+Bondage" to default string
+  def to_s
+    c = self.class.to_s
+    super.sub(c, c + "+Bondage")
+  end
+  
+  # Hash of local variables
+  def locals; list_all :local_variables; end
+  # Hash of global variables (with '$')
+  def globals; list_all :global_variables; end
+  # Hash of instance variables (with '@')
+  def instvars; list_all :instance_variables; end
+  # Hash of class variables (with '@@')
+  def classvars; list_all :class_variables; end
+  # Hash of constants
+  def consts; list_all :constants; end
+  
+  # Iterator over locals; base for Enumerable methods.
+  def each(&proc)
+    locals.each(&proc)
+  end
+  include Enumerable
+  
+  # Return the value of the symbol in the binding.
+  def lookup(name)
+    begin
+      eval(sanitize(name));
+    rescue NameError
+      return nil
+    end
+  end
+  
+  alias_method :[], :lookup
+
+  # Assign the variable within the binding
+  # * If your implementation supports ObjectSpace, this is relatively safe.
+  #   This preserves object identity.  (Copy by reference.)
+  # * If not, the right-hand-side gets it's string value eval'ed
+  def []=(name, value)
+    if defined?(ObjectSpace)
+      eval("#{sanitize(name)} = ObjectSpace._id2ref(#{value.object_id})")
+    else
+      eval("#{sanitize(name)} = #{value}")
+    end
+  end
+
+  private
+  def list_all(kind)
+    eval(kind.to_s).inject({}) {|hash, var|
+      hash[var.to_sym] = lookup(var)
+      hash
+    }
+  end
+  
+  def sanitize(name)
+    name.to_s.gsub(/[^$@\w]/, '_')
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/bondage.rb'}"
+puts "Loading bondage gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/bondage_spec.rb

@@ -0,0 +1,111 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+
+describe "well behaved Bondage", :shared => true do
+  it "extends" do
+    @object.should be_kind_of(Bondage)
+  end
+  
+  it "shows up in to_s" do
+    @object.to_s.should match(/Bondage/)
+  end
+  
+  it "look up locals" do
+    @object.locals[:x].should == 1
+    @object.locals[:y].should == 2
+    @object.locals[:z].should be_nil
+  end
+  
+  it "look up globals" do
+    @object.globals[:$a].should == $a
+    @object.globals[:$b].should == $b
+    @object.globals[:$c].should be_nil
+  end
+
+  it "look up instance" do
+    @object.instvars[:@object].should == @object
+  end
+  
+  it "look up class variables" do
+    b = class Blarg
+      @@blarg = :bleep
+      binding.extend(Bondage)
+    end
+    b.classvars[:@@blarg].should == :bleep
+  end
+  
+  it "looks up constants" do
+    b = class Blarg
+      if !defined?(Bleep)
+        Bleep = 5
+      end
+      binding.extend(Bondage)
+    end
+    b.consts[:Bleep].should == 5
+  end
+  
+  it "supports each on locals" do
+    seen = []
+    @object.each {|var, value| seen << var}
+    seen.should include(:x)
+    seen.should include(:y)
+  end
+  
+  it "can enumerate" do
+    @object.find {|var, value| value == 1}.should == [:x, 1]
+  end
+
+  it "looks up names" do
+    @object[:x].should == 1
+    @object[$a].should == $a
+    @object[:z].should be_nil
+  end
+  
+  it "sets names" do
+    @object[:w] = 5
+    eval("w", @object).should == 5
+  end
+  
+  it "sets complex values" do
+    a = [1, 2, 3]
+    @object[:u] = a
+    @object[:u].object_id.should == a.object_id
+  end
+  
+  it "avoids identifier injection" do
+    @object[:"raise 'gotcha'; x"].should == nil
+  end
+
+  it "avoids identifier injection on assignment" do
+    @object[:"raise 'gotcha'; v"] = 6
+  end
+end
+
+describe "extended" do
+  before do
+    x = 1
+    y = 2
+    $a = 3
+    $b = 4
+    @object = binding.extend(Bondage)
+  end
+
+  it_should_behave_like "well behaved Bondage"
+end
+
+describe "monkey patched" do
+  before :all do
+    class Binding
+      include Bondage
+    end
+  end
+  
+  before do
+    x = 1
+    y = 2
+    $a = 3
+    $b = 4
+    @object = binding
+  end
+
+  it_should_behave_like "well behaved Bondage"
+end

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'bondage'

data/synopsis.rb

@@ -0,0 +1,26 @@
+  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

data/tasks/readme.rake

@@ -0,0 +1,8 @@
+file "README.rdoc" => %w{
+    description.rdoc
+    frag/synopsis_header.rdoc
+    synopsis.rb
+    frag/misc.rdoc
+    MIT-LICENSE.txt} do |t|
+  sh "cat #{t.prerequisites.join(' ')} > #{t.name}"
+end

data/tasks/rspec.rake

@@ -0,0 +1,21 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  require 'spec'
+end
+begin
+  require 'spec/rake/spectask'
+rescue LoadError
+  puts <<-EOS
+To use rspec for testing you must install rspec gem:
+    gem install rspec
+EOS
+  exit(0)
+end
+
+desc "Run the specs under spec/models"
+Spec::Rake::SpecTask.new do |t|
+  t.spec_opts = ['--options', "spec/spec.opts"]
+  t.spec_files = FileList['spec/**/*_spec.rb']
+end

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: JustinLove-bondage
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Justin Love
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-02-15 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: newgem
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.0
+    version: 
+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.
+email: 
+- git@JustinLove.name
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- MIT-LICENSE.txt
+- Manifest.txt
+- README.rdoc
+- description.rdoc
+files: 
+- History.txt
+- MIT-LICENSE.txt
+- Manifest.txt
+- README.rdoc
+- Rakefile
+- description.rdoc
+- lib/bondage.rb
+- script/console
+- script/destroy
+- script/generate
+- spec/bondage_spec.rb
+- spec/spec.opts
+- spec/spec_helper.rb
+- synopsis.rb
+- tasks/readme.rake
+- tasks/rspec.rake
+has_rdoc: true
+homepage: http://github.com/JustinLove/bondage
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: bondage
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: class Binding stinks, module Bondage stinks less
+test_files: []
+