object_loader 1.0.0

data/.rspec

@@ -0,0 +1 @@
+--colour --format documentation

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown --title 'ObjectLoader Documentation' --protected --files ChangeLog.md,LICENSE.txt

data/ChangeLog.md

@@ -0,0 +1,59 @@
+### 1.0.0 / 2011-03-22
+
+* Renamed Contextify to {ObjectLoader}.
+* Refactored the API.
+
+### 0.2.0 / 2010-10-27
+
+* Added `Contextify::ContextifiedClassMethods`.
+* Fixed a block-variable shadowing bug in
+  `Contextify::ClassMethods#contextify`.
+* Removed the `metaid.rb` extension.
+
+### 0.1.6 / 2010-05-23
+
+* Moved the Contextify YARD handlers into the
+  [yard-contextify](http://github.com/postmodern/yard-contextify) library.
+
+### 0.1.5 / 2009-02-02
+
+* Prevent exceptions from jamming the `Contextify.waiting` queue when
+  loading context files with `Contextify.load_blocks`.
+* Added specs for loading and recovering from erroneous context files.
+
+### 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.
+* 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.
+* Added specs for Contextify.load_block and self.load_context_block.
+
+### 0.1.1 / 2009-01-17
+
+* Include missing files in Manifest.
+* All specs pass in Ruby 1.9.1-rc1.
+
+### 0.1.0 / 2008-12-29
+
+* Initial release.
+

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008-2011 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/README.md

@@ -0,0 +1,54 @@
+# ObjectLoader
+
+* [Source](http://github.com/postmodern/object_loader)
+* [Issues](http://github.com/postmodern/object_loader/issues)
+* [Documentation](http://rubydoc.info/gems/object_loader)
+* [Email](mailto:postmodern.mod3 at gmail.com)
+
+## Description
+
+ObjectLoader can load Ruby Objects containing methods and procs from
+Ruby files without having to use YAML or define classes named like the file.
+
+## Examples
+
+    # file: controller.rb
+    class Controller
+  
+      include ObjectLoader
+    
+      # ...
+    
+    end
+
+    # file: my_controller.rb
+    Controller.object do
+  
+      def test1
+        'This is the first test'
+      end
+  
+      def test2(mesg)
+        "Hello #{mesg}"
+      end
+
+    end
+
+    # load a Controller object from a file.
+    controller = Controller.load_object('my_controller.rb')
+    # => #<Controller: ...>
+
+    controller.test1
+    # => "This is the first test"
+    controller.test2('one two three')
+    # => "Hello one two three"
+
+## Install
+
+    $ sudo gem install object_loader
+
+## Copyright
+
+Copyright (c) 2011 Hal Brodigan
+
+See {file:LICENSE.txt} for license information.

data/Rakefile

@@ -0,0 +1,36 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  gem 'ore-tasks', '~> 0.4'
+  require 'ore/tasks'
+
+  Ore::Tasks.new
+rescue LoadError => e
+  STDERR.puts e.message
+  STDERR.puts "Run `gem install ore-tasks` to install 'ore/tasks'."
+end
+
+begin
+  gem 'rspec', '~> 2.4'
+  require 'rspec/core/rake_task'
+
+  RSpec::Core::RakeTask.new
+rescue LoadError => e
+  task :spec do
+    abort "Please run `gem install rspec` to install RSpec."
+  end
+end
+task :test => :spec
+task :default => :spec
+
+begin
+  gem 'yard', '~> 0.6.0'
+  require 'yard'
+
+  YARD::Rake::YardocTask.new  
+rescue LoadError => e
+  task :yard do
+    abort "Please run `gem install yard` to install YARD."
+  end
+end

data/gemspec.yml

@@ -0,0 +1,15 @@
+name: object_loader
+summary: Loads Ruby Objects containing methods and procs from Ruby files.
+description:
+  ObjectLoader can load Ruby Objects containing methods and procs from Ruby
+  files without having to use YAML or define classes named like the file.
+license: MIT
+authors: Postmodern
+email: postmodern.mod3@gmail.com
+homepage: http://github.com/postmodern/object_loader
+has_yard: true
+
+development_dependencies:
+  ore-tasks: ~> 0.4
+  rspec: ~> 2.4
+  yard: ~> 0.6.0

data/lib/object_loader/class_methods.rb

@@ -0,0 +1,69 @@
+module ObjectLoader
+  module ClassMethods
+    #
+    # Loads a block for the Class.
+    #
+    # @param [String] path
+    #   The path to load the block from.
+    #
+    # @return [Proc]
+    #   The block defined for the Class.
+    #
+    # @since 1.0.0
+    #
+    def load_object_block(path)
+      ObjectLoader.load_blocks(path)[self]
+    end
+
+    #
+    # Loads a compatible object.
+    #
+    # @param [String] path
+    #   The path to load the object from.
+    #
+    # @param [Array] arguments
+    #   Additional arguments to use when creating the object.
+    #
+    # @return [Object]
+    #   The loaded object.
+    #
+    # @since 1.0.0
+    #
+    def load_object(path,*arguments)
+      pending = ObjectLoader.load_blocks(path)
+
+      pending_class, pending_block = pending.find do |klass,block|
+        klass.ancestors.include?(self)
+      end
+
+      if (pending_class && pending_block)
+        obj = pending_class.new(*arguments)
+        obj.instance_eval(&pending_block)
+        obj
+      end
+    end
+
+    #
+    # Creates a loadable object using the arguments and block.
+    #
+    # @param [Array] args
+    #   Additional arguments to pass to the Classes `new` method.
+    #
+    # @yield []
+    #   The given block will be instance evaled into the newly created
+    #   object when the object is loaded.
+    #
+    # @since 1.0.0
+    #
+    def object(*args,&block)
+      if (args.empty? && ObjectLoader.is_pending?)
+        ObjectLoader.pending[self] = block
+        return nil
+      else
+        new_object = self.new(*args)
+        new_object.instance_eval(&block) if block
+        return new_object
+      end
+    end
+  end
+end

data/lib/object_loader/exceptions/object_not_found.rb

@@ -0,0 +1,4 @@
+module ObjectLoader
+  class ObjectNotFound < StandardError
+  end
+end

data/lib/object_loader/exceptions.rb

@@ -0,0 +1 @@
+require 'object_loader/exceptions/object_not_found'

data/lib/object_loader/object_loader.rb

@@ -0,0 +1,152 @@
+require 'object_loader/exceptions/object_not_found'
+require 'object_loader/class_methods'
+require 'object_loader/pending_object'
+
+module ObjectLoader
+  #
+  # Includes {ClassMethods} into the class.
+  #
+  # @param [Class] base
+  #   The class that {ObjectLoader} is being included into.
+  #
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  #
+  # The pending objects waiting to be fully loaded.
+  #
+  # @return [Array<PendingObject>]
+  #   Contexts which are waiting to be loaded.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.queue
+    @@queue ||= []
+  end
+
+  #
+  # The first pending object waiting to be fully loaded.
+  #
+  # @return [PendingObject]
+  #   The pending object being loaded.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.pending
+    queue.first
+  end
+
+  #
+  # Determines whether there are pending objects.
+  #
+  # @return [Boolean]
+  #   Specifies whether there is a pending object present.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.is_pending?
+    !(queue.empty?)
+  end
+
+  #
+  # Finds the first pending object being loaded from a specific path.
+  #
+  # @param [String] path
+  #   The path which is being loaded.
+  #
+  # @return [PendingObject]
+  #   The first pending object with the specified path.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.loading(path)
+    queue.find { |pending| pending.path == path }
+  end
+
+  #
+  # Determines whether objects are being loaded from a specific path.
+  #
+  # @param [String] path
+  #   The path to check if objects are being loaded from.
+  #
+  # @return [Boolean]
+  #   Specifies whether pending objects are being loaded from the
+  #   specified path.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.is_loading?(path)
+    !(loading(path).nil?)
+  end
+
+  #
+  # Loads all object blocks from a specific path.
+  #
+  # @param [String] path
+  #   The path to load all object blocks from.
+  #
+  # @return [PendingObject]
+  #   The pending object which contains the blocks.
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.load_blocks(path)
+    path = File.expand_path(path)
+
+    unless File.file?(path)
+      raise(ObjectNotFound,"#{path.dump} doest not exist",caller)
+    end
+
+    # prevent circular loading of objects
+    unless is_pending?
+      # push on the new pending object
+      queue.unshift(PendingObject.new(path))
+
+      begin
+        load(path)
+      rescue Exception => e
+        # if any error is encountered, pop off the object
+        queue.shift
+        raise(e)
+      end
+    end
+
+    # pop off and return the pending object
+    pending_object = queue.shift
+
+    yield pending_object if block_given?
+    return pending_object
+  end
+
+  #
+  # Loads all objects from a specific path.
+  #
+  # @param [String] path
+  #   The path to load all objects from.
+  #
+  # @return [Array]
+  #   The array of loaded objects.
+  #
+  # @example
+  #   ObjectLoader.load_objects('/path/to/misc_object.rb')
+  #   # => [...]
+  #
+  # @since 1.0.0
+  #
+  def ObjectLoader.load_objects(path)
+    new_objects = []
+
+    load_blocks(path) do |pending|
+      pending.each do |klass,block|
+        new_object = klass.new
+        new_object.instance_eval(&block)
+
+        yield new_object if block_given?
+        new_objects << new_object
+      end
+    end
+
+    return new_objects
+  end
+end

data/lib/object_loader/pending_object.rb

@@ -0,0 +1,23 @@
+module ObjectLoader
+  class PendingObject < Hash
+
+    # The path being loaded
+    attr_reader :path
+
+    #
+    # Creates a new {PendingObject} object.
+    #
+    # @param [String] path
+    #   The path the pending object was loaded from.
+    #
+    def initialize(path)
+      @path = File.expand_path(path)
+
+      super()
+    end
+
+    alias each_class each_key
+    alias each_block each_value
+
+  end
+end

data/lib/object_loader/version.rb

@@ -0,0 +1,4 @@
+module ObjectLoader
+  # object_loader version
+  VERSION = '1.0.0'
+end

data/lib/object_loader.rb

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

data/object_loader.gemspec

@@ -0,0 +1,15 @@
+# -*- encoding: utf-8 -*-
+
+begin
+  Ore::Specification.new do |gemspec|
+    # custom logic here
+  end
+rescue NameError
+  begin
+    require 'ore/specification'
+    retry
+  rescue LoadError
+    STDERR.puts "The '#{__FILE__}' file requires Ore."
+    STDERR.puts "Run `gem install ore-core` to install Ore."
+  end
+end

data/spec/helpers/book.rb

@@ -0,0 +1,13 @@
+require 'object_loader'
+
+class Book
+
+  include ObjectLoader
+
+  # Title of the book
+  attr_accessor :title
+
+  # Author of the book
+  attr_accessor :author
+
+end

data/spec/helpers/book_review.rb

@@ -0,0 +1,19 @@
+require 'object_loader'
+
+class BookReview
+
+  include ObjectLoader
+
+  # Title of the book
+  attr_accessor :book_title
+
+  # Author of the book
+  attr_accessor :book_author
+
+  # Author of this review
+  attr_accessor :author
+
+  # Summary
+  attr_accessor :summary
+
+end

data/spec/helpers/objects/discrete_structures.rb

@@ -0,0 +1,6 @@
+TextBook.object do
+
+  @title = 'Discrete Structures, Logic, and Computability, 2nd Edition'
+  @author = 'James L. Hein'
+
+end

data/spec/helpers/objects/load_error.rb

@@ -0,0 +1,4 @@
+require 'load/errors/should/not/stop/object_loader'
+
+Book.object do
+end

data/spec/helpers/objects/name_error.rb

@@ -0,0 +1,2 @@
+Foo.object do
+end

data/spec/helpers/objects/neuromancer_review.rb

@@ -0,0 +1,19 @@
+Book.object do
+
+  @title = 'Neuromancer'
+  @author = 'William Gibson'
+
+end
+
+BookReview.object do
+
+  @book_title = 'Neuromancer'
+  @book_author = 'William Gibson'
+
+  @author = 'postmodern'
+  @summary = %{
+    Classic cyber-punk book. Provides you with a very realistic and gritty
+    vision of the future and the characters that inhabit it.
+  }
+
+end

data/spec/helpers/objects/no_method_error.rb

@@ -0,0 +1,2 @@
+Book.objecttttttttttttt do
+end

data/spec/helpers/objects/snow_crash.rb

@@ -0,0 +1,10 @@
+Book.object do
+
+  @title = 'Snow Crash'
+  @author = 'Neal Stephenson'
+
+  def rating
+    10
+  end
+
+end

data/spec/helpers/objects/syntax_error.rb

@@ -0,0 +1,5 @@
+Book.object do
+
+  def
+
+end

data/spec/helpers/objects.rb

@@ -0,0 +1,13 @@
+require 'helpers/book'
+require 'helpers/text_book'
+require 'helpers/book_review'
+
+module Helpers
+  module Objects
+    DIR = File.expand_path(File.join(File.dirname(__FILE__),'objects'))
+
+    def object_path(name)
+      File.join(Helpers::Objects::DIR,"#{name}.rb")
+    end
+  end
+end

data/spec/helpers/text_book.rb

@@ -0,0 +1,4 @@
+require 'helpers/book'
+
+class TextBook < Book
+end

data/spec/object_loader_spec.rb

@@ -0,0 +1,122 @@
+require 'spec_helper'
+require 'helpers/objects'
+
+require 'object_loader'
+
+describe ObjectLoader do
+  include Helpers::Objects
+
+  let(:snow_crash_path) { object_path(:snow_crash) }
+  let(:discrete_structures_path) { object_path(:discrete_structures) }
+  let(:neuromancer_path) { object_path(:neuromancer_review) }
+
+  let(:syntax_error_path) { object_path(:syntax_error) }
+  let(:load_error_path) { object_path(:load_error) }
+  let(:name_error_path) { object_path(:name_error) }
+  let(:no_method_error_path) { object_path(:no_method_error) }
+
+  it "should raise ObjectNotFound when loading from non-existant files" do
+    lambda {
+      Book.load_object('not_here.rb')
+    }.should raise_error(ObjectLoader::ObjectNotFound)
+  end
+
+  it "should load arbitrary blocks from a file" do
+    blocks = ObjectLoader.load_blocks(snow_crash_path)
+
+    blocks.should_not be_empty
+  end
+
+  it "should recover from SyntaxError exceptions" do
+    lambda {
+      ObjectLoader.load_blocks(syntax_error_path)
+    }.should raise_error(SyntaxError)
+
+    ObjectLoader.loading(syntax_error_path).should be_nil
+  end
+
+  it "should recover from LoadError exceptions" do
+    lambda {
+      ObjectLoader.load_blocks(load_error_path)
+    }.should raise_error(LoadError)
+
+    ObjectLoader.loading(load_error_path).should be_nil
+  end
+
+  it "should recover from NameError exceptions" do
+    lambda {
+      ObjectLoader.load_blocks(name_error_path)
+    }.should raise_error(NameError)
+
+    ObjectLoader.loading(name_error_path).should be_nil
+  end
+
+  it "should recover from NoMethodError exceptions" do
+    lambda {
+      ObjectLoader.load_blocks(no_method_error_path)
+    }.should raise_error(NoMethodError)
+
+    ObjectLoader.loading(no_method_error_path).should be_nil
+  end
+
+  it "should load a block for a specific Class from a file" do
+    block = Book.load_object_block(snow_crash_path)
+
+    block.should_not be_nil
+  end
+
+  it "should provide class-level methods for loading an object" do
+    book = Book.load_object(snow_crash_path)
+
+    book.should_not be_nil
+    book.class.should == Book
+  end
+
+  it "should load objects for a specific Class from a file" do
+    book = Book.load_object(snow_crash_path)
+
+    book.should_not be_nil
+    book.class.should == Book
+  end
+
+  it "should load the object of a specific Class from a file with multiple objects" do
+    review = BookReview.load_object(neuromancer_path)
+
+    review.should_not be_nil
+    review.class.should == BookReview
+  end
+
+  it "should not load objects if none are of a specific Class" do
+    book = Book.load_object(neuromancer_path)
+
+    book.should_not be_nil
+    book.class.should == Book
+  end
+
+  it "should load the object which inherit from a specific Class" do
+    book = Book.load_object(discrete_structures_path)
+
+    book.should_not be_nil
+    book.class.should == TextBook
+  end
+
+  it "should return nil when loading objects incompatible with the Class" do
+    BookReview.load_object(snow_crash_path).should be_nil
+  end
+
+  describe "loaded objects" do
+    before(:all) do
+      @book = Book.load_object(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.respond_to?(:rating).should == true
+      @book.rating.should == 10
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+gem 'rspec', '~> 2.4'
+require 'rspec'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: object_loader
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Postmodern
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-03-22 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: ore-tasks
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "0.4"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: "2.4"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 0.6.0
+  type: :development
+  version_requirements: *id003
+description: ObjectLoader can load Ruby Objects containing methods and procs 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: 
+- README.md
+files: 
+- .gemtest
+- .rspec
+- .yardopts
+- ChangeLog.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gemspec.yml
+- lib/object_loader.rb
+- lib/object_loader/class_methods.rb
+- lib/object_loader/exceptions.rb
+- lib/object_loader/exceptions/object_not_found.rb
+- lib/object_loader/object_loader.rb
+- lib/object_loader/pending_object.rb
+- lib/object_loader/version.rb
+- object_loader.gemspec
+- spec/helpers/book.rb
+- spec/helpers/book_review.rb
+- spec/helpers/objects.rb
+- spec/helpers/objects/discrete_structures.rb
+- spec/helpers/objects/load_error.rb
+- spec/helpers/objects/name_error.rb
+- spec/helpers/objects/neuromancer_review.rb
+- spec/helpers/objects/no_method_error.rb
+- spec/helpers/objects/snow_crash.rb
+- spec/helpers/objects/syntax_error.rb
+- spec/helpers/text_book.rb
+- spec/object_loader_spec.rb
+- spec/spec_helper.rb
+has_rdoc: yard
+homepage: http://github.com/postmodern/object_loader
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: object_loader
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Loads Ruby Objects containing methods and procs from Ruby files.
+test_files: 
+- spec/object_loader_spec.rb