cobble 0.1.2 → 0.1.3

data/lib/cobble.rb

@@ -5,10 +5,12 @@ Dir.glob(File.join(File.dirname(__FILE__), 'cobble', '**/*.rb')).each do |f|
   require File.expand_path(f)
 end
 
+# Shortcut for Cobble.create(name, *args, &block)
 def Cobble(name, *args, &block)
   Cobble.create(name, *args, &block)
 end
 
+# Shortcut for Cobble, really only used to ease transition from FactoryGirl
 def Factory(name, *args, &block)
   puts "*** WARNING *** You should migrate over to using the proper Cobble methods as this won't be here forever!"
   Cobble.create(name, *args, &block)

data/lib/cobble/errors.rb

@@ -2,6 +2,7 @@ class Cobble
   module Errors # :nodoc:
     class NoFakeRegistered < StandardError
       
+      # Raised if Fake has been registered by that name.
       def initialize(name) # :nodoc:
         super("No fake has been registered for '#{name}'!")
       end

data/lib/cobble/fakes.rb

@@ -1,25 +1,41 @@
 class Cobble
+  # A registry for procs that can be called to generate random, or fake, data.
   class Fakes
     include Singleton
   
+    # List of all the fake procs in the system.
     attr_accessor :list
   
-    def initialize
+    def initialize # :nodoc:
       self.reset!
     end
   
-    def reset!
+    def reset! # :nodoc:
       self.list = {}
     end
   
+    # Add a new proc to the system.
+    # 
+    # Example:
+    #   Cobble::Fakes.add(:birth_date) {(rand(80) + 13).years.ago}
     def add(name, &block)
       self.list[name.to_sym] = block
     end
-  
+    
+    # Create an alias from one fake proc to another.
+    # 
+    # Example:
+    #   Cobble::Fakes.add(:birth_date) {(rand(80) + 13).years.ago}
+    #   Cobble::Fakes.alias(:birthday, :birth_date)
     def alias(from, to)
       self.list[from.to_sym] = Cobble::Fakes::Alias.new(to)
     end
   
+    # Executes the specified fake proc. Raise Cobble::Errors::NoFakeRegistered
+    # if the fake proc is not registered with the system.
+    # 
+    # Example:
+    #   Cobble::Fakes.execute(:email) # => 'bob@example.com'
     def execute(name, *args)
       block = self.list[name.to_sym]
       if block.is_a?(Cobble::Fakes::Alias)
@@ -32,13 +48,13 @@ class Cobble
     end
   
     class << self
-      def method_missing(sym, *args, &block)
+      def method_missing(sym, *args, &block) # :nodoc:
         Cobble::Fakes.instance.send(sym, *args, &block)
       end
     end # class << self
   
     private
-    class Alias
+    class Alias # :nodoc:
       attr_accessor :to
       def initialize(to)
         self.to = to

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: cobble
 version: !ruby/object:Gem::Version 
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors: 
 - markbates
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-15 00:00:00 -05:00
+date: 2010-02-16 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency