contextify 0.1.2 → 0.1.3

data.tar.gz.sig

@@ -0,0 +1,2 @@
+÷G�c=HC�aS�Mp�8_��H��2�#aS��@	R����I0�Hޯ��-�� ���(����J����'���j
+ϓÂ�.��J��8�ӓ4>dw�ċ�"������i.3K�0�_cwd���X�E99l�W8g׶������0$3����&I�U�q̕�J�֫�����L�"Ч(Ѳ 7gd��w@������AE%�֑�z�E�x$�o1�a�׉��p)X�@����NO!w@

data/History.txt

@@ -1,3 +1,14 @@
+=== 0.1.3 / 2009-09-21
+
+* Require Hoe >= 2.3.3.
+* Require YARD >= 0.2.3.5.
+* Require RSpec >= 1.2.8.
+* Use 'hoe/signing' for signed RubyGems.
+* Moved to YARD based documentation.
+* Added YARD handlers for documenting contextify method calls.
+* Allow self.load_context to load objects that inherit from the contextified class.
+* All specs pass on JRuby 1.3.1.
+
 === 0.1.2 / 2009-02-06
 
 * Added self.load_context_block to Contextify.

data/Manifest.txt

@@ -12,6 +12,12 @@ lib/contextify/extensions/meta/object.rb
 lib/contextify/pending_context.rb
 lib/contextify/contextify.rb
 lib/contextify/version.rb
+lib/contextify/yard.rb
+lib/contextify/yard/handlers.rb
+lib/contextify/yard/handlers/ruby.rb
+lib/contextify/yard/handlers/ruby/contextify_handler.rb
+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

@@ -1,7 +1,8 @@
-= contextify
+= Contextify
 
 * http://contextify.rubyforge.org/
 * http://github.com/postmodern/contextify/
+* Postmodern (postmodern.mod3 at gmail.com)
 
 == DESCRIPTION:
 
@@ -17,7 +18,7 @@ classes named like the file.
     
     contextify :controller
     
-    ...
+    # ...
     
   end
 
@@ -34,13 +35,19 @@ classes named like the file.
 
   end
 
+  # load a Controller object from a file.
   controller = Controller.load_context('my_controller.rb')
   # => #<Controller: ...>
+
   controller.test1
   # => "This is the first test"
   controller.test2('one two three')
   # => "Hello one two three"
 
+== REQUIREMENTS:
+
+* {YARD}[http://yard.soen.ca/] >= 0.2.3.5
+
 == INSTALL:
 
   $ sudo gem install contextify

data/Rakefile

@@ -2,13 +2,23 @@
 
 require 'rubygems'
 require 'hoe'
+require 'hoe/signing'
 require './tasks/spec.rb'
-require './lib/contextify/version.rb'
+require './tasks/yard.rb'
 
-Hoe.new('contextify', Contextify::VERSION) do |p|
-  p.rubyforge_name = 'contextify'
-  p.developer('Postmodern', 'postmodern.mod3@gmail.com')
-  p.remote_rdoc_dir = ''
+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.spec_extras = {:has_rdoc => 'yard'}
 end
 
 # vim: syntax=Ruby

data/lib/contextify/contextify.rb

@@ -5,6 +5,12 @@ 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
 
@@ -17,7 +23,17 @@ module Contextify
         end
 
         meta_def(:load_context) do |path,*args|
-          Contextify.load_context(self.context_name,path,*args)
+          pending = Contextify.load_blocks(path)
+
+          context, block = pending.blocks.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
@@ -37,44 +53,67 @@ module Contextify
     end
 
     #
-    # Returns a Hash of all defined contexts.
+    # All contextified classes.
+    #
+    # @return [Hash{Symbol => Class}]
+    #   All defined contexts and their classes.
     #
     def Contextify.contexts
       @@contextify_contexts ||= {}
     end
 
     #
-    # Returns +true+ if there is a context defined with the specified
-    # _name_, returns +false+ otherwise.
+    # 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
 
     #
-    # Returns the Array of contexts which are waiting to be loaded.
+    # The contexts waiting to be fully loaded.
+    #
+    # @return [Array<PendingContext>]
+    #   Contexts which are waiting to be loaded.
     #
     def Contextify.waiting
       @@contextify_waiting_contexts ||= []
     end
 
     #
-    # Returns the pending context being loaded.
+    # The first context waiting to be fully loaded.
+    #
+    # @return [PendingContext]
+    #   The pending context being loaded.
     #
     def Contextify.pending
       Contextify.waiting.first
     end
 
     #
-    # Returns +true+ if there is a pending context present, returns
-    # +false+ otherwise.
+    # Determines whether there are pending contexts.
+    #
+    # @return [Boolean]
+    #   Specifies whether there is a pending context present.
     #
     def Contextify.is_pending?
       !(Contextify.waiting.empty?)
     end
 
     #
-    # Returns the first pending context with the specified _path_.
+    # 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|
@@ -87,16 +126,27 @@ module Contextify
     end
 
     #
-    # Returns +true+ if the pending context with the specified _path_
-    # is present, returns +false+ otherwise.
+    # 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
 
     #
-    # Loads all context blocks from the specified _path_, returning a
-    # PendingContext object containing the context blocks.
+    # 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)
@@ -121,15 +171,31 @@ module Contextify
     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.
+    # 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_.
     #
-    #   Contextify.load_block(:exploit,'/path/to/my_exploit.rb') # => Proc
+    # @example
+    #   Contextify.load_block(:exploit,'/path/to/my_exploit.rb')
+    #   # => Proc
     #
-    #   Contextify.load_block(:shellcode,'/path/to/my_shellcode.rb')
-    #     do |block|
-    #     ...
+    # @example
+    #   Contextify.load_block(:shellcode,'/path/to/execve.rb') do |block|
+    #     # ...
     #   end
     #
     def Contextify.load_block(name,path,&block)
@@ -140,20 +206,33 @@ module Contextify
     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.
+    # Loads the context object of a specific name and from the specific
+    # path.
     #
-    #   Contextify.load_context(:note,'/path/to/my_notes.rb') # => Note
+    # @param [Symbol, String] name
+    #   The name of the context to load.
     #
-    def Contextify.load_context(name,path,*args)
+    # @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(*args)
+      new_context = Contextify.contexts[name].new(*arguments)
 
       Contextify.load_block(name,path) do |context_block|
         new_context.instance_eval(&context_block) if context_block
@@ -163,11 +242,17 @@ module Contextify
     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.
+    # 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.
     #
-    #   Contextify.load_contexts('/path/to/misc_contexts.rb') # => [...]
+    # @example
+    #   Contextify.load_contexts('/path/to/misc_contexts.rb')
+    #   # => [...]
     #
     def Contextify.load_contexts(path,&block)
       new_objs = []

data/lib/contextify/exceptions/context_not_found.rb

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

data/lib/contextify/exceptions/unknown_context.rb

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

data/lib/contextify/pending_context.rb

@@ -8,7 +8,10 @@ module Contextify
     attr_accessor :blocks
 
     #
-    # Creates a new PendingContext object with the specified _path_.
+    # Creates a new PendingContext object.
+    #
+    # @param [String] path
+    #   The path the pending context was loaded from.
     #
     def initialize(path)
       @path = File.expand_path(path)
@@ -16,8 +19,13 @@ module Contextify
     end
 
     #
-    # Iterates over each block in the pending context, passing their name
-    # and value to the given _block_.
+    # Iterates over each block in the pending context.
+    #
+    # @yield [block]
+    #   The block will be passed each pending context block.
+    #
+    # @yieldparam [Proc] block
+    #   A pending context block.
     #
     def each_block(&block)
       @blocks.each(&block)

data/lib/contextify/version.rb

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

data/lib/contextify/yard.rb

@@ -0,0 +1 @@
+require 'contextify/yard/handlers'

data/lib/contextify/yard/handlers.rb

@@ -0,0 +1 @@
+require 'contextify/yard/handlers/ruby'

data/lib/contextify/yard/handlers/ruby.rb

@@ -0,0 +1,2 @@
+require 'contextify/yard/handlers/ruby/contextify_handler'
+require 'contextify/yard/handlers/ruby/legacy'

data/lib/contextify/yard/handlers/ruby/contextify_handler.rb

@@ -0,0 +1,33 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      class ContextifyHandler < Base
+
+        handles method_call(:contextify)
+
+        def process
+          nobj = ModuleObject.new(:root, 'Kernel')
+          obj = statement.parameters(false).first
+
+          mscope = scope
+          name = case obj.type
+          when :symbol_literal
+            obj.jump(:ident, :op, :kw, :const).source
+          when :string_literal
+            obj.jump(:string_content).source
+          end
+
+          register MethodObject.new(nobj, name, mscope) do |o|
+            o.visibility = :public
+            o.source = statement.source
+            o.signature = "def #{name}(&block)"
+            o.parameters = [['&block', nil]]
+          end
+        end
+
+      end
+    end
+  end
+end

data/lib/contextify/yard/handlers/ruby/legacy.rb

@@ -0,0 +1 @@
+require 'contextify/yard/handlers/ruby/legacy/contextify_handler'

data/lib/contextify/yard/handlers/ruby/legacy/contextify_handler.rb

@@ -0,0 +1,29 @@
+require 'yard'
+
+module YARD
+  module Handlers
+    module Ruby
+      module Legacy
+        class ContextifyHandler < Base
+
+          handles /\Acontextify\s/
+
+          def process
+            nobj = ModuleObject.new(:root, 'Kernel')
+
+            mscope = scope
+            name = statement.tokens[2,1].to_s[1..-1]
+
+            register MethodObject.new(nobj, name, mscope) do |o|
+              o.visibility = :public
+              o.source = statement.source
+              o.signature = "def #{name}(&block)"
+              o.parameters = [['&block', nil]]
+            end
+          end
+
+        end
+      end
+    end
+  end
+end

data/spec/contextify_spec.rb

@@ -65,6 +65,10 @@ describe Contextify do
     book.class.should == Book
   end
 
+  it "should return nil when loading contexts incompatible with the class" do
+    BookReview.load_context(@snow_crash_path).should be_nil
+  end
+
   describe "loaded contexts" do
     before(:all) do
       @book = Book.load_context(@snow_crash_path)

data/tasks/spec.rb

@@ -6,4 +6,5 @@ Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_opts = ['--colour', '--format', 'specdoc']
 end
 
+task :test => :spec
 task :default => :spec

metadata

@@ -1,17 +1,58 @@
 --- !ruby/object:Gem::Specification 
 name: contextify
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - Postmodern
 autorequire: 
 bindir: bin
-cert_chain: []
+cert_chain: 
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIDQDCCAiigAwIBAgIBADANBgkqhkiG9w0BAQUFADBGMRgwFgYDVQQDDA9wb3N0
+  bW9kZXJuLm1vZDMxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixk
+  ARkWA2NvbTAeFw0wOTA2MDMwNDU5MDNaFw0xMDA2MDMwNDU5MDNaMEYxGDAWBgNV
+  BAMMD3Bvc3Rtb2Rlcm4ubW9kMzEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYK
+  CZImiZPyLGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA
+  1wvANkTDHFgVih5XLjuTwTZjgBq1lBGybXJiH6Id1lY2JOMqM5FB1DDHVvvij94i
+  mJabN0zkzu6VKWC70y0IwOxY7CPokr0eFdK/D0y7mCq1P8QITv76i2YqAl0eYqIt
+  W+IhIkANQ7E6uMZIZcdnfadC6lPAtlKkqtd9crvRbFgr6e3kyflmohbRnTEJHoRd
+  7SHHsybE6DSn7oTDs6XBTNrNIn5VfZA0z01eeos/+zBm1zKJOK2+/7xtLLDuDU9G
+  +Rd+ltUBbvxUrMNZmDG29pnmN2xTRH+Q8HxD2AxlvM5SRpK6OeZaHV7PaCCAVZ4L
+  T9BFl1sfMvRlABeGEkSyuQIDAQABozkwNzAJBgNVHRMEAjAAMAsGA1UdDwQEAwIE
+  sDAdBgNVHQ4EFgQUKwsd+PqEYmBvyaTyoL+uRuk+PhEwDQYJKoZIhvcNAQEFBQAD
+  ggEBAB4TvHsrlbcXcKg6gX5BIb9tI+zGkpzo0Z7jnxMEcNO7NGGwmzafDBI/xZYv
+  xkRH3/HXbGGYDOi6Q6gWt5GujSx0bOImDtYTJTH8jnzN92HzEK5WdScm1QpZKF1e
+  cezArMbxbSPaosxTCtG6LQTkE28lFQsmFZ5xzouugS4h5+LVJiVMmiP+l3EfkjFa
+  GOURU+rNEMPWo8MCWivGW7jes6BMzWHcW7DQ0scNVmIcCIgdyMmpscuAEOSeghy9
+  /fFs57Ey2OXBL55nDOyvN/ZQ2Vab05UH4t+GCxjAPeirzL/29FBtePT6VD44c38j
+  pDj+ws7QjtH/Qcrr1l9jfN0ehDs=
+  -----END CERTIFICATE-----
 
-date: 2009-02-06 00:00:00 -08:00
+date: 2009-09-25 00:00:00 -07:00
 default_executable: 
 dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: yard
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.2.3.5
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 1.2.8
+    version: 
 - !ruby/object:Gem::Dependency 
   name: hoe
   type: :development
@@ -20,9 +61,11 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.3
+        version: 2.3.3
     version: 
-description: Load Objects from Ruby files without having to use YAML or define classes named like the file.
+description: |-
+  Load Objects from Ruby files without having to use YAML or define
+  classes named like the file.
 email: 
 - postmodern.mod3@gmail.com
 executables: []
@@ -48,11 +91,19 @@ files:
 - lib/contextify/pending_context.rb
 - lib/contextify/contextify.rb
 - lib/contextify/version.rb
+- lib/contextify/yard.rb
+- lib/contextify/yard/handlers.rb
+- lib/contextify/yard/handlers/ruby.rb
+- lib/contextify/yard/handlers/ruby/contextify_handler.rb
+- 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
-has_rdoc: true
+has_rdoc: yard
 homepage: http://contextify.rubyforge.org/
+licenses: []
+
 post_install_message: 
 rdoc_options: 
 - --main
@@ -74,9 +125,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: contextify
-rubygems_version: 1.3.1
+rubygems_version: 1.3.5
 signing_key: 
-specification_version: 2
+specification_version: 3
 summary: Load Objects from Ruby files without having to use YAML or define classes named like the file.
 test_files: []