primedia-endeca_factory 0.3.0 → 0.4.0

data/README.rdoc

@@ -0,0 +1,50 @@
+= endeca_factory
+
+== DESCRIPTION:
+
+A gem that provides a factory for creating Endeca test objects.
+
+== SYNOPSIS:
+
+    class Listing < Endeca::Document
+      reader :title, :subject, :description
+    end
+    
+    Listing.factory({
+      :title       => "A Title",
+      :subject     => "A Subject",
+      :description => "A Description"
+    })
+
+== REQUIREMENTS:
+
+* endeca
+
+== INSTALL:
+
+  sudo gem install primedia-endeca_factory --source=http://gems.github.com
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 Primedia
+
+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

@@ -15,7 +15,7 @@ spec = Gem::Specification.new do |s|
   s.version = GEM_VERSION
   s.platform = Gem::Platform::RUBY
   s.has_rdoc = true
-  s.extra_rdoc_files = ["README", "LICENSE"]
+  s.extra_rdoc_files = ["README.rdoc", "LICENSE"]
   s.summary = SUMMARY
   s.description = s.summary
   s.authors = AUTHORS
@@ -25,7 +25,7 @@ spec = Gem::Specification.new do |s|
   
   s.require_path = 'lib'
   s.autorequire = GEM
-  s.files = %w(LICENSE README Rakefile) + Dir.glob("{lib,spec}/**/*")
+  s.files = %w(LICENSE README.rdoc Rakefile) + Dir.glob("{lib,spec}/**/*")
 end
 
 task :default => :spec

data/lib/endeca_factory.rb

@@ -2,24 +2,19 @@ require 'rubygems'
 require 'endeca'
 require File.join(File.dirname(__FILE__), 'core_ext')
 
-module Endeca
+module Endeca #:nodoc:
+  # Endeca::Factory creates stubbed Endeca objects. It expects a hash (or array of
+  # hashes) and the class of the Document object(s) to be created.
   class Factory
-    VERSION = "0.3.0"
-    def self.version
+    VERSION = "0.4.0" #:nodoc:
+    def self.version #:nodoc:
       VERSION
-    end
-
-    def self.create(params, klass)
-      new(params, klass).objects
-    end
-
-    attr_reader :objects
+    end    
 
     class << self; private :new end
-    
-    private
+    attr_reader :objects #:nodoc:
 
-    def initialize(params, klass)
+    def initialize(params, klass) #:nodoc:
       params = params.dup
       @klass = klass
       case params
@@ -29,6 +24,20 @@ module Endeca
       end
     end
 
+    # Creates stubbed Endeca::Document and Endeca::DocumentCollection objects.
+    # Pass a hash to return a single stubbed Endeca::Document object or an
+    # array of hashes to return an Endeca::DocumentCollection object with
+    # +documents+ stubbed to return the collection of documents built from the
+    # array of hashes.
+    #    
+    # Example:
+    #   Endeca::Factory.create({:title => "A Title"}, Listing)
+    def self.create(params, klass)
+      new(params, klass).objects
+    end
+    
+    private
+
     def build_from_hash(params);
       @klass.new.tap do |document|
         params.each do |method, value|
@@ -66,6 +75,13 @@ module Endeca
   end
   
   class Document
+    # Creates stubbed Endeca::Document and Endeca::DocumentCollection objects
+    # using its class as the Document class. See Endeca::Factory.create for
+    # usage.
+    #     
+    # Example:
+    #     
+    #   Listing.factory([{:title => "A Title"}, {:title => "Another Title"}])
     def self.factory(params)
       Factory.create(params, self)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: primedia-endeca_factory
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Jason Noble
@@ -30,11 +30,11 @@ executables: []
 extensions: []
 
 extra_rdoc_files: 
-- README
+- README.rdoc
 - LICENSE
 files: 
 - LICENSE
-- README
+- README.rdoc
 - Rakefile
 - lib/core_ext.rb
 - lib/endeca_factory.rb

data/README

@@ -1,3 +0,0 @@
-== endeca_factory
-
-A gem that provides...