scheherazade 0.0.1 → 0.0.2

data/README.md

@@ -8,22 +8,22 @@ Scheherazade
 
 * imagines plausible characters (creates valid objects automatically)
 * keeps track of her story (reuse objects within a given context)
-* isn't wearing much (minimal DSL, no instance_eval)
+* isn't wearing much (minimal DSL, no `instance_eval`)
 
 ## Simple Example
 
-  # Say we have a model like:
-  class Department
-    belongs_to :company
-    has_many :employees
-    validates_presence_of :company, :name
-  end
-
-  # Without any configuration, if we write in a test:
-  story.imagine(Department) # creates a Department,
-                            # with a default name,
-                            # associated to a new Company
-  story.imagine(Department) # creates another Department
+    # Say we have a model like:
+    class Department
+      belongs_to :company
+      has_many :employees
+      validates_presence_of :company, :name
+    end
+
+    # Without any configuration, if we write in a test:
+    story.imagine(Department) # creates a Department,
+                              # with a default name,
+                              # associated to a new Company
+    story.imagine(Department) # creates another Department
                             # with another name
                             # and associated to the same Company
 
@@ -33,7 +33,7 @@ For FactoryGirl (or Machinist) users: a Factory (or Blueprint) corresponds loose
 
 ### Characters (Models)
 
-Scheherazade creates ActiveRecord objects. The types of objects are called a 'character'. A generic character could be a `User` (or equivalently `:user`) or there could be more specialized characters (say `:admin`).
+Scheherazade creates ActiveRecord objects. The types of objects are called a *character*. A generic character could be a `User` (or equivalently `:user`) or there could be more specialized characters (say `:admin`).
 
 All your models have a default character type; you can use the class directly or the corresponding symbol. Specialized characters must be defined within the current story before they can be used.
 
@@ -61,37 +61,31 @@ Scheherazade is meant to testing and has a logging feature that makes it easier
 
 ## Documentation
 
-The main class is `Story` and there are 2 important methods: Story#imagine and Story#fill. Story#get is a simple shorthand to get the current character or create it if there isn't any.
+The main class is `Story` and there are 2 important methods: `Story#imagine` and `Story#fill`. `Story#get` is a simple shorthand to get the current character or create it if there isn't any.
 
 ## Complete example
 
-  class User
-    belongs_to :blog
-    validates_presence_of :first_name, :last_name
-  end
-
-  class Blog
-    has_many :users
-    has_one :admin, :class_name => "User", :condition => {:admin => true}
-    validates_presence_of :admin
+    class User
+      belongs_to :blog
+      validates_presence_of :first_name, :last_name
+    end
 
-    has_many :posts
-  end
+    class Blog
+      has_many :users
+      has_one :admin, :class_name => "User", :condition => {:admin => true}
+      validates_presence_of :admin
 
-  story.instance_eval do
-    fill User, :email do
-      fill :admin, :admin => true,
-           :nickname => ->(user, sequence){"The boss #{sequence}"}
+      has_many :posts
     end
 
-    fill Blog, :posts
-  end
-
-## To do
+    story.instance_eval do
+      fill User, :email do
+        fill :admin, :admin => true,
+             :nickname => ->(user, sequence){"The boss #{sequence}"}
+      end
 
-Configurable automatic attributes
-Finish doc
-Finish specs
+      fill Blog, :posts
+    end
 
 ## Why? Scheherazade vs FactoryGirl vs Machinist
 
@@ -131,6 +125,26 @@ And then execute:
 
     $ bundle
 
+To avoid pollution from one test/spec to another, you should start and end a story before each. For example with Rspec:
+
+    RSpec.configure do |config|
+      config.before(:each) do
+        story.begin
+      end
+
+      config.after(:each) do
+        story.end
+      end
+
+Not sure if future versions should probably support that out of the box...?
+
+## To do
+
+Configurable automatic attributes
+Finish support for associations with integers/arrays
+Finish doc
+Finish specs
+
 ## Contributing
 
 1. Fork it

data/lib/scheherazade/story.rb

@@ -3,7 +3,7 @@ module Scheherazade
     attr_reader :fill_attributes, :characters, :counter, :current
 
     def self.current
-      Thread.current[:scheherazade_stories].last
+      (Thread.current[:scheherazade_stories] ||= []).last || TOP
     end
 
     # Begins a story within the current story.
@@ -49,6 +49,8 @@ module Scheherazade
       @built = []
     end
 
+    TOP = new(nil)
+
     # Creates a character with the given attributes
     #
     # A character can be designated either by the model (e.g. `User`), the corresponding
@@ -142,6 +144,9 @@ module Scheherazade
       @after_imagine[current_fill] = block
     end
 
+    alias_method :==, :equal?
+    alias_method :eql?, :equal?
+
     protected
     def current_fill
       @filling.last or raise "Expected to be inside a story.fill"
@@ -165,5 +170,3 @@ module Scheherazade
 
   end
 end
-
-Scheherazade::Story.begin

data/lib/scheherazade/version.rb

@@ -1,3 +1,3 @@
 module Scheherazade
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: scheherazade
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
@@ -91,7 +91,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3557737727214523228
+      hash: -2747982078447649607
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -100,7 +100,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3557737727214523228
+      hash: -2747982078447649607
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24