workbench 0.2 → 0.3

data/README.rdoc

@@ -31,9 +31,9 @@ system getting in the way by following a few conventions that should
 cover most use cases, while keeping it robust by getting out of the
 way.
 
-Workbench is less than 70 lines, and every line counts. Moderately
-experienced rubyists should have no trouble understanding the code,
-and there is not that much to parse.
+Workbench is less than 70 lines (excluding documentation), and every
+line counts. Moderately experienced rubyists should have no trouble
+understanding the code, and there is not that much to parse.
 
 = Usage
 
@@ -116,7 +116,8 @@ include it in their global test config or RSpec config (like so):
 See:
 
 * Workbench
-* Workbench#sequence
+* Workbench#use_class
+* Workbench#count_with
 
 = Counters
 

data/lib/workbench.rb

@@ -3,32 +3,51 @@ module Workbench
   COUNTERS = Hash.new(0)
 
   # Declare that the next builder method is to use the said class
-  # (Symbol such as :User or string such as "Models::User" are
-  # acceptable)
+  #
+  #   module Builders
+  #     extend Workbench
+  #
+  #     def user_defaults(u)
+  #       ...
+  #     end
+  #
+  #     use_class :User
+  #     def admin_user_defaults(u)
+  #       ...
+  #     end
+  #   end
+  #
+  # === Parameters:
+  #
+  # name:: - Symbol such as :User or string such as "Models::User" are
+  #          acceptable
   def use_class(name)
     @next_class = name
   end
 
-  # Declare that the next builder method is to count scoped to the following class,
+  # Declare that the next builder method is to count scoped to the following class
   #
-  # module Builders
-  #   extend Workbench
+  #   module Builders
+  #     extend Workbench
   #
-  #   def book_defaults(u, n)
-  #     ...
-  #   end
+  #     def book_defaults(u, n)
+  #       ...
+  #     end
   #
-  #   count_with :Book
-  #   def article_defaults(u, n)
-  #     ...
+  #     count_with :Book
+  #     def article_defaults(u, n)
+  #       ...
+  #     end
   #   end
-  # end
   #
-  # new_book        # n = 1
-  # new_publication # n = 2
-  # new_book        # n = 3
+  #   new_book        # n = 1
+  #   new_publication # n = 2
+  #   new_book        # n = 3
+  #
+  # === Parameters:
   #
-  # expects a Symbol such as :User or string such as "Models::User" that maps to a valid class name.
+  # +name+:: - a Symbol (ie :User) or string (is "Models::User") that
+  #            maps to a valid class name.
   def count_with(name)
     @next_count_with = name
   end

metadata

@@ -2,7 +2,7 @@
 name: workbench
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: "0.2"
+  version: "0.3"
 platform: ruby
 authors: 
 - Tim Harper
@@ -37,21 +37,36 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: rdoc
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: "3.8"
+  type: :development
+  version_requirements: *id004
 description: |
-  There are a lot of factory frameworks, why one more? In my experience
-  the otherones use fancy DSLs that were intended to increase
-  readability but instead increased confusion.
-  
-  Workbench doesn't use a fancy DSL. It uses ruby. It doesn't use any
-  fancy tricks like providing proxy objects for modification, workbench
-  builders operate on the actual model. Since it uses very little
-  tricks, it is also ORM agnostic. If your models respond to '.new' and
-  you set attributes by calling #attribute=, then Workbench will work
-  with your model.
+  Workbench strikes to reach a better balance between easy-to-read
+  factory builders, ease of use, and robustness.
   
-  I have a hard time understanding why all the complexity around factory
-  builders has grown, but often I look at the resulting DSL and say
-  "That's more work than just defining a method and calling Model.new!"
+  Workbench doesn't use any fancy tricks. It's code is small and the
+  average rubyist should have no trouble reading it. It exploits what
+  ruby provides. Instead of operating on a proxy object, builders
+  operate on the actual model. It's also ORM agnostic.
 
 email: 
 - tim@leadtune.com