contextify 0.1.3 → 0.1.4

data/{History.txt → History.rdoc}

@@ -1,3 +1,14 @@
+=== 0.1.4 / 2009-01-30
+
+* Require RSpec >= 1.3.0.
+* Require YARD >= 0.5.3.
+* Added {Contextify::ClassMethods}.
+* Added {Contextify::PendingContext#each_class}.
+* Added {Contextify::PendingContext#each}.
+* Fixed a bug in {Contextify::PendingContext#each_block}.
+* Fixed a typo where {Contextify} methods where being defined within
+  the {Contextify.included} method.
+
 === 0.1.3 / 2009-09-21
 
 * Require Hoe >= 2.3.3.

data/Manifest.txt

@@ -1,6 +1,6 @@
-History.txt
+History.rdoc
 Manifest.txt
-README.txt
+README.rdoc
 Rakefile
 lib/contextify.rb
 lib/contextify/exceptions.rb
@@ -10,6 +10,7 @@ lib/contextify/extensions.rb
 lib/contextify/extensions/meta.rb
 lib/contextify/extensions/meta/object.rb
 lib/contextify/pending_context.rb
+lib/contextify/class_methods.rb
 lib/contextify/contextify.rb
 lib/contextify/version.rb
 lib/contextify/yard.rb
@@ -20,4 +21,3 @@ lib/contextify/yard/handlers/ruby/legacy.rb
 lib/contextify/yard/handlers/ruby/legacy/contextify_handler.rb
 spec/contextify_spec.rb
 spec/spec_helper.rb
-tasks/spec.rb

data/{README.txt → README.rdoc}

@@ -44,10 +44,6 @@ classes named like the file.
   controller.test2('one two three')
   # => "Hello one two three"
 
-== REQUIREMENTS:
-
-* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
-
 == INSTALL:
 
   $ sudo gem install contextify
@@ -56,7 +52,7 @@ classes named like the file.
 
 The MIT License
 
-Copyright (c) 2008-2009 Hal Brodigan
+Copyright (c) 2008-2010 Hal Brodigan
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -3,22 +3,21 @@
 require 'rubygems'
 require 'hoe'
 require 'hoe/signing'
-require './tasks/spec.rb'
-require './tasks/yard.rb'
+
+Hoe.plugin :yard
 
 Hoe.spec('contextify') do
-  self.rubyforge_name = 'contextify'
   self.developer('Postmodern', 'postmodern.mod3@gmail.com')
-  self.remote_rdoc_dir = ''
-  self.extra_deps = [
-    ['yard', '>=0.2.3.5']
-  ]
 
-  self.extra_dev_deps = [
-    ['rspec', '>=1.2.8']
-  ]
+  self.rspec_options += ['--colour', '--format', 'specdoc']
 
-  self.spec_extras = {:has_rdoc => 'yard'}
+  self.yard_options += ['--protected']
+  self.remote_yard_dir = ''
+
+  self.extra_dev_deps += [
+    ['rspec', '>=1.3.0'],
+    ['yard', '>=0.5.3']
+  ]
 end
 
 # vim: syntax=Ruby

data/lib/contextify/class_methods.rb

@@ -0,0 +1,51 @@
+require 'contextify/extensions'
+
+module Contextify
+  module ClassMethods
+    #
+    # Contextifies the class.
+    #
+    # @param [Symbol, String] name
+    #   The context name to assign to the class.
+    #
+    def contextify(name)
+      name = name.to_s
+
+      Contextify.contexts[name] = self
+
+      meta_def(:context_name) { name }
+
+      meta_def(:load_context_block) do |path|
+        Contextify.load_block(name,path)
+      end
+
+      meta_def(:load_context) do |path,*args|
+        pending = Contextify.load_blocks(path)
+
+        context, block = pending.find do |name,block|
+          Contextify.contexts[name].ancestors.include?(self)
+        end
+
+        if (context && block)
+          obj = Contextify.contexts[name].new(*args)
+          obj.instance_eval(&block)
+          obj
+        end
+      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
+end

data/lib/contextify/contextify.rb

@@ -1,275 +1,229 @@
 require 'contextify/exceptions'
-require 'contextify/extensions'
+require 'contextify/class_methods'
 require 'contextify/pending_context'
 
 module Contextify
   def self.included(base)
-    base.module_eval do
-      #
-      # Contextifies the class.
-      #
-      # @param [Symbol, String] name
-      #   The context name to assign to the class.
-      #
-      def self.contextify(name)
-        name = name.to_s
-
-        Contextify.contexts[name] = self
+    base.extend ClassMethods
+  end
 
-        meta_def(:context_name) { name }
+  #
+  # All contextified classes.
+  #
+  # @return [Hash{Symbol => Class}]
+  #   All defined contexts and their classes.
+  #
+  def Contextify.contexts
+    @@contextify_contexts ||= {}
+  end
 
-        meta_def(:load_context_block) do |path|
-          Contextify.load_block(name,path)
-        end
+  #
+  # Determines whether a context with a specific name has been defined.
+  #
+  # @param [Symbol, String] name
+  #   The name of the context to search for.
+  #
+  # @return [Boolean]
+  #   Specifies whether there is a context defined with the specified
+  #   name.
+  #
+  def Contextify.is_context?(name)
+    Contextify.contexts.has_key?(name.to_s)
+  end
 
-        meta_def(:load_context) do |path,*args|
-          pending = Contextify.load_blocks(path)
+  #
+  # The contexts waiting to be fully loaded.
+  #
+  # @return [Array<PendingContext>]
+  #   Contexts which are waiting to be loaded.
+  #
+  def Contextify.waiting
+    @@contextify_waiting_contexts ||= []
+  end
 
-          context, block = pending.blocks.find do |name,block|
-            Contextify.contexts[name].ancestors.include?(self)
-          end
+  #
+  # The first context waiting to be fully loaded.
+  #
+  # @return [PendingContext]
+  #   The pending context being loaded.
+  #
+  def Contextify.pending
+    Contextify.waiting.first
+  end
 
-          if (context && block)
-            obj = Contextify.contexts[name].new(*args)
-            obj.instance_eval(&block)
-            obj
-          end
-        end
+  #
+  # Determines whether there are pending contexts.
+  #
+  # @return [Boolean]
+  #   Specifies whether there is a pending context present.
+  #
+  def Contextify.is_pending?
+    !(Contextify.waiting.empty?)
+  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
-        }
+  #
+  # Finds the first pending context being loaded from a specific path.
+  #
+  # @param [String] path
+  #   The path which is being loaded.
+  #
+  # @return [PendingContext]
+  #   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
 
-    #
-    # All contextified classes.
-    #
-    # @return [Hash{Symbol => Class}]
-    #   All defined contexts and their classes.
-    #
-    def Contextify.contexts
-      @@contextify_contexts ||= {}
-    end
-
-    #
-    # Determines whether a context with a specific name has been defined.
-    #
-    # @param [Symbol, String] name
-    #   The name of the context to search for.
-    #
-    # @return [Boolean]
-    #   Specifies whether there is a context defined with the specified
-    #   name.
-    #
-    def Contextify.is_context?(name)
-      Contextify.contexts.has_key?(name.to_s)
-    end
-
-    #
-    # The contexts waiting to be fully loaded.
-    #
-    # @return [Array<PendingContext>]
-    #   Contexts which are waiting to be loaded.
-    #
-    def Contextify.waiting
-      @@contextify_waiting_contexts ||= []
-    end
+    return nil
+  end
 
-    #
-    # The first context waiting to be fully loaded.
-    #
-    # @return [PendingContext]
-    #   The pending context being loaded.
-    #
-    def Contextify.pending
-      Contextify.waiting.first
-    end
+  #
+  # Determines whether contexts are being loaded from a specific path.
+  #
+  # @param [String] path
+  #   The path to check if contexts are being loaded from.
+  #
+  # @return [Boolean]
+  #   Specifies whether pending contexts are being loaded from the
+  #   specified path.
+  #
+  def Contextify.is_loading?(path)
+    !(Contextify.loading(path).nil?)
+  end
 
-    #
-    # Determines whether there are pending contexts.
-    #
-    # @return [Boolean]
-    #   Specifies whether there is a pending context present.
-    #
-    def Contextify.is_pending?
-      !(Contextify.waiting.empty?)
+  #
+  # Loads all context blocks from a specific path.
+  #
+  # @param [String] path
+  #   The path to load all context blocks from.
+  #
+  # @return [PendingContext]
+  #   The pending context which contains the 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
 
-    #
-    # Finds the first pending context being loaded from a specific path.
-    #
-    # @param [String] path
-    #   The path which is being loaded.
-    #
-    # @return [PendingContext]
-    #   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
+    # prevent circular loading of contexts
+    unless Contextify.is_pending?
+      # push on the new pending context
+      Contextify.waiting.unshift(PendingContext.new(path))
 
-      return nil
+      load(path)
     end
 
-    #
-    # Determines whether contexts are being loaded from a specific path.
-    #
-    # @param [String] path
-    #   The path to check if contexts are being loaded from.
-    #
-    # @return [Boolean]
-    #   Specifies whether pending contexts are being loaded from the
-    #   specified path.
-    #
-    def Contextify.is_loading?(path)
-      !(Contextify.loading(path).nil?)
-    end
+    # pop off and return the pending context
+    pending_context = Contextify.waiting.shift
 
-    #
-    # Loads all context blocks from a specific path.
-    #
-    # @param [String] path
-    #   The path to load all context blocks from.
-    #
-    # @return [PendingContext]
-    #   The pending context which contains the 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
+    block.call(pending_context) if block
+    return pending_context
+  end
 
-      # pop off and return the pending context
-      pending_context = Contextify.waiting.shift
+  #
+  # Loads the context block for the context with the specific name
+  # from a specific path.
+  #
+  # @param [Symbol, String] name
+  #   The name of the context to load the block for.
+  #
+  # @param [String] path
+  #   The path to load the context block from.
+  #
+  # @yield [block]
+  #   The block which will receive the context block.
+  #
+  # @yieldparam [Proc] block
+  #   The context block loaded from the specified _path_.
+  #
+  # @return [Proc]
+  #   The block for the context with the specified _name_.
+  #
+  # @example
+  #   Contextify.load_block(:exploit,'/path/to/my_exploit.rb')
+  #   # => Proc
+  #
+  # @example
+  #   Contextify.load_block(:shellcode,'/path/to/execve.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
 
-      block.call(pending_context) if block
-      return pending_context
+  #
+  # Loads the context object of a specific name and from the specific
+  # path.
+  #
+  # @param [Symbol, String] name
+  #   The name of the context to load.
+  #
+  # @param [String] path
+  #   The path to load the context object from.
+  #
+  # @return [Object]
+  #   The loaded context object.
+  #
+  # @raise [UnknownContext]
+  #   No context was defined with the specific name.
+  #
+  # @example
+  #   Contextify.load_context(:note,'/path/to/my_notes.rb')
+  #   # => Note
+  #
+  def Contextify.load_context(name,path,*arguments)
+    name = name.to_s
+
+    unless Contextify.is_context?(name)
+      raise(UnknownContext,"unknown context #{name.dump}",caller)
     end
 
-    #
-    # Loads the context block for the context with the specific name
-    # from a specific path.
-    #
-    # @param [Symbol, String] name
-    #   The name of the context to load the block for.
-    #
-    # @param [String] path
-    #   The path to load the context block from.
-    #
-    # @yield [block]
-    #   The block which will receive the context block.
-    #
-    # @yieldparam [Proc] block
-    #   The context block loaded from the specified _path_.
-    #
-    # @return [Proc]
-    #   The block for the context with the specified _name_.
-    #
-    # @example
-    #   Contextify.load_block(:exploit,'/path/to/my_exploit.rb')
-    #   # => Proc
-    #
-    # @example
-    #   Contextify.load_block(:shellcode,'/path/to/execve.rb') do |block|
-    #     # ...
-    #   end
-    #
-    def Contextify.load_block(name,path,&block)
-      context_block = Contextify.load_blocks(path).blocks[name.to_s]
+    new_context = Contextify.contexts[name].new(*arguments)
 
-      block.call(context_block) if block
-      return context_block
+    Contextify.load_block(name,path) do |context_block|
+      new_context.instance_eval(&context_block) if context_block
     end
 
-    #
-    # Loads the context object of a specific name and from the specific
-    # path.
-    #
-    # @param [Symbol, String] name
-    #   The name of the context to load.
-    #
-    # @param [String] path
-    #   The path to load the context object from.
-    #
-    # @return [Object]
-    #   The loaded context object.
-    #
-    # @raise [UnknownContext]
-    #   No context was defined with the specific name.
-    #
-    # @example
-    #   Contextify.load_context(:note,'/path/to/my_notes.rb')
-    #   # => Note
-    #
-    def Contextify.load_context(name,path,*arguments)
-      name = name.to_s
-
-      unless Contextify.is_context?(name)
-        raise(UnknownContext,"unknown context #{name.dump}",caller)
-      end
-
-      new_context = Contextify.contexts[name].new(*arguments)
-
-      Contextify.load_block(name,path) do |context_block|
-        new_context.instance_eval(&context_block) if context_block
-      end
-
-      return new_context
-    end
-
-    #
-    # Loads all context objects from a specific path.
-    #
-    # @param [String] path
-    #   The path to load all context objects from.
-    #
-    # @return [Array]
-    #   The array of loaded context objects.
-    #
-    # @example
-    #   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)
+    return new_context
+  end
 
-            block.call(new_obj) if block
-            new_objs << new_obj
-          end
+  #
+  # Loads all context objects from a specific path.
+  #
+  # @param [String] path
+  #   The path to load all context objects from.
+  #
+  # @return [Array]
+  #   The array of loaded context objects.
+  #
+  # @example
+  #   Contextify.load_contexts('/path/to/misc_contexts.rb')
+  #   # => [...]
+  #
+  def Contextify.load_contexts(path,&block)
+    new_objs = []
+
+    Contextify.load_blocks(path) do |pending|
+      pending.each 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
-
-      return new_objs
     end
+
+    return new_objs
   end
 end

data/lib/contextify/pending_context.rb

@@ -1,6 +1,8 @@
 module Contextify
   class PendingContext
 
+    include Enumerable
+
     # The path being loaded
     attr_reader :path
 
@@ -18,6 +20,21 @@ module Contextify
       @blocks = {}
     end
 
+    #
+    # Iterates over each context name in the pending context.
+    #
+    # @yield [name]
+    #   The block will be passed each name of the pending context blocks.
+    #
+    # @yieldparam [String] name
+    #   The name of a pending context block.
+    #
+    def each_class(&block)
+      @blocks.each_key do |name|
+        block.call(Contextify.contexts[name])
+      end
+    end
+
     #
     # Iterates over each block in the pending context.
     #
@@ -28,6 +45,23 @@ module Contextify
     #   A pending context block.
     #
     def each_block(&block)
+      @blocks.each_value(&block)
+    end
+
+    #
+    # Iterates over each context name and block in the pending context.
+    #
+    # @yield [name, block]
+    #   The block will be passed each pending context block and it's
+    #   context name.
+    #
+    # @yieldparam [String] name
+    #   The context name of the block.
+    #
+    # @yieldparam [Proc] block
+    #   A pending context block.
+    #
+    def each(&block)
       @blocks.each(&block)
     end
 

data/lib/contextify/version.rb

@@ -1,3 +1,3 @@
 module Contextify
-  VERSION = '0.1.3'
+  VERSION = '0.1.4'
 end

data/spec/spec_helper.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: contextify
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Postmodern
@@ -30,18 +30,38 @@ cert_chain:
   pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
   -----END CERTIFICATE-----
 
-date: 2009-09-25 00:00:00 -07:00
+date: 2010-01-30 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: yard
-  type: :runtime
+  name: rubyforge
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.0.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: gemcutter
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.2.3.5
+        version: 0.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe-yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.1.2
     version: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -51,7 +71,17 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.2.8
+        version: 1.3.0
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.5.3
     version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
@@ -61,7 +91,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
+        version: 2.5.0
     version: 
 description: |-
   Load Objects from Ruby files without having to use YAML or define
@@ -73,13 +103,12 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- History.txt
 - Manifest.txt
-- README.txt
+- History.rdoc
 files: 
-- History.txt
+- History.rdoc
 - Manifest.txt
-- README.txt
+- README.rdoc
 - Rakefile
 - lib/contextify.rb
 - lib/contextify/exceptions.rb
@@ -89,6 +118,7 @@ files:
 - lib/contextify/extensions/meta.rb
 - lib/contextify/extensions/meta/object.rb
 - lib/contextify/pending_context.rb
+- lib/contextify/class_methods.rb
 - lib/contextify/contextify.rb
 - lib/contextify/version.rb
 - lib/contextify/yard.rb
@@ -99,15 +129,16 @@ files:
 - lib/contextify/yard/handlers/ruby/legacy/contextify_handler.rb
 - spec/contextify_spec.rb
 - spec/spec_helper.rb
-- tasks/spec.rb
 has_rdoc: yard
 homepage: http://contextify.rubyforge.org/
 licenses: []
 
 post_install_message: 
 rdoc_options: 
-- --main
-- README.txt
+- --protected
+- --title
+- Contextify Documentation
+- --quiet
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 

data/tasks/spec.rb

@@ -1,10 +0,0 @@
-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 :test => :spec
-task :default => :spec