contextify 0.1.0

data/History.txt

@@ -0,0 +1,4 @@
+=== 1.0.0 / 2008-12-29
+
+* Initial release.
+

data/Manifest.txt

@@ -0,0 +1,15 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/contextify.rb
+lib/contextify/exceptions/context_not_found.rb
+lib/contextify/exceptions/unknown_context.rb
+lib/contextify/extensions/meta/object.rb
+lib/contextify/extensions/meta.rb
+lib/contextify/pending_context.rb
+lib/contextify/contextify.rb
+lib/contextify/version.rb
+spec/contextify_spec.rb
+spec/spec_helper.rb
+tasks/spec.rb

data/README.txt

@@ -0,0 +1,71 @@
+= contextify
+
+* http://contextify.rubyforge.org/
+* http://github.com/postmodern/contextify/
+
+== DESCRIPTION:
+
+Load objects from Ruby files without having to use YAML or define
+classes named like the file.
+
+== EXAMPLES:
+
+  # file: controller.rb
+  class Controller
+  
+    include Contextify
+    
+    contextify :controller
+    
+    ...
+    
+  end
+
+  # file: my_controller.rb
+  controller do
+  
+    def test1
+      'This is the first test'
+    end
+  
+    def test2(mesg)
+      "Hello #{mesg}"
+    end
+
+  end
+
+  controller = Controller.load_context('my_controller.rb')
+  # => #<Controller: ...>
+  controller.test1
+  # => "This is the first test"
+  controller.test2('one two three')
+  # => "Hello one two three"
+
+== INSTALL:
+
+  $ sudo gem install contextify
+
+== LICENSE:
+
+The MIT License
+
+Copyright (c) 2008 Hal Brodigan
+
+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,14 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+require './tasks/spec.rb'
+require './lib/contextify/version.rb'
+
+Hoe.new('contextify', Contextify::VERSION) do |p|
+  p.rubyforge_name = 'contextify'
+  p.developer('Postmodern', 'postmodern.mod3@gmail.com')
+  p.remote_rdoc_dir = ''
+end
+
+# vim: syntax=Ruby

data/lib/contextify.rb

@@ -0,0 +1,2 @@
+require 'contextify/contextify'
+require 'contextify/version'

data/lib/contextify/contextify.rb

@@ -0,0 +1,187 @@
+require 'contextify/exceptions/unknown_context'
+require 'contextify/exceptions/context_not_found'
+require 'contextify/pending_context'
+require 'contextify/extensions/meta'
+
+module Contextify
+  def self.included(base)
+    base.module_eval do
+      def self.contextify(name)
+        name = name.to_s
+
+        Contextify.contexts[name] = self
+
+        meta_def(:context_name) { name }
+
+        meta_def(:load_context) do |path,*args|
+          Contextify.load_context(self.context_name,path,*args)
+        end
+
+        # define the top-level context wrappers
+        Kernel.module_eval %{
+          def #{name}(*args,&block)
+            if (args.empty? && ::Contextify.is_pending?)
+              ::Contextify.pending.blocks[#{name.dump}] = block
+              return nil
+            else
+              new_context = #{self}.new(*args)
+              new_context.instance_eval(&block) if block
+              return new_context
+            end
+          end
+        }
+      end
+    end
+
+    #
+    # Returns a Hash of all defined contexts.
+    #
+    def Contextify.contexts
+      @@contextify_contexts ||= {}
+    end
+
+    #
+    # Returns +true+ if there is a context defined with the specified
+    # _name_, returns +false+ otherwise.
+    #
+    def Contextify.is_context?(name)
+      Contextify.contexts.has_key?(name.to_s)
+    end
+
+    #
+    # Returns the Array of contexts which are waiting to be loaded.
+    #
+    def Contextify.waiting
+      @@contextify_waiting_contexts ||= []
+    end
+
+    #
+    # Returns the pending context being loaded.
+    #
+    def Contextify.pending
+      Contextify.waiting.first
+    end
+
+    #
+    # Returns +true+ if there is a pending context present, returns
+    # +false+ otherwise.
+    #
+    def Contextify.is_pending?
+      !(Contextify.waiting.empty?)
+    end
+
+    #
+    # Returns the first pending context with the specified _path_.
+    #
+    def Contextify.loading(path)
+      Contextify.waiting.each do |pending|
+        if pending.path == path
+          return pending
+        end
+      end
+
+      return nil
+    end
+
+    #
+    # Returns +true+ if the pending context with the specified _path_
+    # is present, returns +false+ otherwise.
+    #
+    def Contextify.is_loading?(path)
+      !(Contextify.loading(path).nil?)
+    end
+
+    #
+    # Loads all context blocks from the specified _path_, returning a
+    # PendingContext object containing the context blocks.
+    #
+    def Contextify.load_blocks(path,&block)
+      path = File.expand_path(path)
+
+      unless File.file?(path)
+        raise(ContextNotFound,"context #{path.dump} doest not exist",caller)
+      end
+
+      # prevent circular loading of contexts
+      unless Contextify.is_pending?
+        # push on the new pending context
+        Contextify.waiting.unshift(PendingContext.new(path))
+
+        load(path)
+      end
+
+      # pop off and return the pending context
+      pending_context = Contextify.waiting.shift
+
+      block.call(pending_context) if block
+      return pending_context
+    end
+
+    #
+    # Loads the context block of the specified _name_ from the specified
+    # _path_, returning the context block. If a _block_ is given it will
+    # be passed the loaded context block.
+    #
+    #   Contextify.load_block(:exploit,'/path/to/my_exploit.rb') # => Proc
+    #
+    #   Contextify.load_block(:shellcode,'/path/to/my_shellcode.rb')
+    #     do |block|
+    #     ...
+    #   end
+    #
+    def Contextify.load_block(name,path,&block)
+      context_block = Contextify.load_blocks(path).blocks[name.to_s]
+
+      block.call(context_block) if block
+      return context_block
+    end
+
+    #
+    # Loads the context of the specified _name_ and from the specified
+    # _path_ with the given _args_. If no contexts were defined with the
+    # specified _name_, an UnknownContext exception will be raised.
+    #
+    #   Contextify.load_context(:note,'/path/to/my_notes.rb') # => Note
+    #
+    def Contextify.load_context(name,path,*args)
+      name = name.to_s
+
+      unless Contextify.is_context?(name)
+        raise(UnknownContext,"unknown context #{name.dump}",caller)
+      end
+
+      new_context = Contextify.contexts[name].new(*args)
+
+      Contextify.load_block(name,path) do |context_block|
+        new_context.instance_eval(&context_block) if context_block
+      end
+
+      return new_context
+    end
+
+    #
+    # Loads all contexts from the specified _path_ returning an +Array+
+    # of loaded contexts. If a _block_ is given, it will be passed
+    # each loaded context.
+    #
+    #   Contextify.load_contexts('/path/to/misc_contexts.rb') # => [...]
+    #
+    def Contextify.load_contexts(path,&block)
+      new_objs = []
+
+      Contextify.load_blocks(path) do |pending|
+        pending.each_block do |name,context_block|
+          if Contextify.is_context?(name)
+            new_obj = Contextify.contexts[name].new
+            new_obj.instance_eval(&context_block)
+
+            block.call(new_obj) if block
+            new_objs << new_obj
+          end
+        end
+      end
+
+      return new_objs
+    end
+  end
+end

data/lib/contextify/exceptions/context_not_found.rb

@@ -0,0 +1,4 @@
+module Contextify
+  class ContextNotFound < RuntimeError
+  end
+end

data/lib/contextify/exceptions/unknown_context.rb

@@ -0,0 +1,4 @@
+module Contextify
+  class UnknownContext < RuntimeError
+  end
+end

data/lib/contextify/extensions/meta.rb

@@ -0,0 +1 @@
+require 'contextify/extensions/meta/object'

data/lib/contextify/extensions/meta/object.rb

@@ -0,0 +1,24 @@
+# metaprogramming assistant -- metaid.rb
+class Object # :nodoc:
+  # The hidden singleton lurks behind everyone
+  def metaclass; class << self; self; end; end
+  def meta_eval(&blk); metaclass.instance_eval(&blk); end
+
+  # A class_eval version of meta_eval
+  def metaclass_eval(&blk); metaclass.class_eval(&blk); end
+
+  # A class_def version of meta_def
+  def metaclass_def(name, &blk)
+    metaclass_eval { define_method(name, &blk) }
+  end
+  
+  # Adds methods to a metaclass
+  def meta_def(name, &blk)
+    meta_eval { define_method(name, &blk) }
+  end
+  
+  # Defines an instance method within a class
+  def class_def(name, &blk)
+    class_eval { define_method(name, &blk) }
+  end
+end

data/lib/contextify/pending_context.rb

@@ -0,0 +1,27 @@
+module Contextify
+  class PendingContext
+
+    # The path being loaded
+    attr_reader :path
+
+    # The blocks to be loaded
+    attr_accessor :blocks
+
+    #
+    # Creates a new PendingContext object with the specified _path_.
+    #
+    def initialize(path)
+      @path = File.expand_path(path)
+      @blocks = {}
+    end
+
+    #
+    # Iterates over each block in the pending context, passing their name
+    # and value to the given _block_.
+    #
+    def each_block(&block)
+      @blocks.each(&block)
+    end
+
+  end
+end

data/lib/contextify/version.rb

@@ -0,0 +1,3 @@
+module Contextify
+  VERSION = '0.1.0'
+end

data/spec/contextify_spec.rb

@@ -0,0 +1,72 @@
+require 'contextify'
+
+require 'spec_helper'
+
+describe Contextify do
+  before(:all) do
+    require 'helpers/book_context'
+    require 'helpers/book_review_context'
+
+    @contexts_dir = File.expand_path(File.join(File.dirname(__FILE__),'helpers','contexts'))
+    @snow_crash_path = File.join(@contexts_dir,'snow_crash.rb')
+    @neuromancer_path = File.join(@contexts_dir,'neuromancer_review.rb')
+  end
+
+  it "should contain defined contexts" do
+    Contextify.is_context?('book').should == true
+  end
+
+  it "should create a class-level context name" do
+    Book.context_name.should == 'book'
+  end
+
+  it "should raise an UnknownContext exception when loading unknwon-contexts" do
+    lambda {
+      Contextify.load_context(:nothing, 'some_path.rb')
+    }.should raise_error(Contextify::UnknownContext)
+  end
+
+  it "should raise a ContextNotFound exception when loading from non-existant files" do
+    lambda {
+      Contextify.load_context(:book, 'not_here.rb')
+    }.should raise_error(Contextify::ContextNotFound)
+  end
+
+  it "should load contexts by context-name from a file" do
+    @book = Contextify.load_context(:book, @snow_crash_path)
+    @book.should_not be_nil
+    @book.class.should == Book
+  end
+
+  it "should load a specific context from a file with multiple contexts" do
+    @book = Contextify.load_context(:book, @neuromancer_path)
+    @book.should_not be_nil
+    @book.class.should == Book
+
+    @review = Contextify.load_context(:book_review, @neuromancer_path)
+    @review.should_not be_nil
+    @review.class.should == BookReview
+  end
+
+  it "should provide class-level methods for loading a context" do
+    @book = Book.load_context(@snow_crash_path)
+    @book.should_not be_nil
+    @book.class.should == Book
+  end
+
+  describe "loaded contexts" do
+    before(:all) do
+      @book = Book.load_context(@snow_crash_path)
+    end
+
+    it "should have attributes" do
+      @book.title.should == 'Snow Crash'
+      @book.author.should == 'Neal Stephenson'
+    end
+
+    it "should have instance methods" do
+      @book.methods.include?('rating').should == true
+      @book.rating.should == 10
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,5 @@
+require 'rubygems'
+gem 'rspec', '>=1.1.3'
+require 'spec'
+
+require 'contextify/version'

data/tasks/spec.rb

@@ -0,0 +1,9 @@
+require 'spec/rake/spectask'
+
+desc "Run all specifications"
+Spec::Rake::SpecTask.new(:spec) do |t|
+  t.libs += ['lib', 'spec']
+  t.spec_opts = ['--colour', '--format', 'specdoc']
+end
+
+task :default => :spec

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification 
+name: contextify
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-12-29 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.8.2
+    version: 
+description: Load objects from Ruby files without having to use YAML or define classes named like the file.
+email: 
+- postmodern.mod3@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- README.txt
+files: 
+- History.txt
+- Manifest.txt
+- README.txt
+- Rakefile
+- lib/contextify.rb
+- lib/contextify/exceptions/context_not_found.rb
+- lib/contextify/exceptions/unknown_context.rb
+- lib/contextify/extensions/meta/object.rb
+- lib/contextify/extensions/meta.rb
+- lib/contextify/pending_context.rb
+- lib/contextify/contextify.rb
+- lib/contextify/version.rb
+- spec/contextify_spec.rb
+- spec/spec_helper.rb
+- tasks/spec.rb
+has_rdoc: true
+homepage: http://contextify.rubyforge.org/
+post_install_message: 
+rdoc_options: 
+- --main
+- README.txt
+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: contextify
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Load objects from Ruby files without having to use YAML or define classes named like the file.
+test_files: []
+