ianwhite-pickle 0.1.9 → 0.1.10

data/History.txt

@@ -1,3 +1,10 @@
+== 0.1.10 - 13 Feb 2009
+
+* 2 minor enhancements
+  * Made pickle paths generator compatible with latest cucumber
+  * Simplified and Rakefile, including auto push api docs to gh-pages on ci build
+
+
 == 0.1.9 - 29 Jan 2009
 
 * 1 minor enhancement

data/README.rdoc

@@ -0,0 +1,195 @@
+= {ianwhite}[http://github.com/ianwhite] / {pickle}[http://github.com/ianwhite/pickle] >>{info}[http://ianwhite.github.com/pickle] >>{api}[http://ianwhite.github.com/pickle/doc]
+
+Pickle gives you cucumber steps that create your models easily from factory-girl or
+machinist factories/blueprints.  You can also just use ActiveRecord but it's not as cool.
+
+References to the models are stored, not necessarily for the purpose of checking the db
+(although you could use it for that), but for enabling easy reference to urls, and for
+building complex givens which require a bunch of models collaborating
+
+== Install
+
+Install pickle either as a rails plugin, or a gem
+
+  # plugin
+  script/plugin install git://github.com/ianwhite/pickle.git
+  
+  # or, plugin as submodule
+  git submodule add git://github.com/ianwhite/pickle.git vendor/plugins/pickle
+
+  # or, gem
+  sudo gem install ianwhite-pickle
+  
+== Get Started
+
+(you'd better install cucumber)
+
+  script/generate pickle [paths] [email]
+
+Now have a look at <tt>features/step_definitions/pickle_steps.rb</tt>
+
+If you want path steps and email steps then just add 'paths' and/or 'email'.  The code/steps will be
+written to <tt>features/env/paths.rb</tt> and
+<tt>features/step_definitions/email_steps.rb</tt> respectively.
+
+=== Using with plain ole Active Record
+
+If you have an AR called 'Post', with required fields 'title', and 'body', then you can now write 
+steps like this
+
+  Given a post exists with title: "My Post", body: "My body"
+
+=== Using with factory-girl or machinist
+
+But you're using Machinist or FactoryGirl right?!  To leverage all of the factories/blueprints
+you've written, you can just do stuff like
+
+  Given a user exists
+  And another user exists with role: "admin"
+
+  # later
+  Then a user should exist with name: "Fred"
+  And that user should be activated # this uses rspec predicate matchers
+
+==== Machinst: require your blueprints and reset Shams
+
+In your <tt>features/support/env.rb</tt> add the following lines at the bottom
+
+  require "#{Rails.root}/spec/blueprints" # or wherever they live
+  Before { Sham.reset } # reset Shams in between scenarios
+
+=== Configuring Pickle
+
+You can tell pickle to use another factory adapter (see Pickle::Adapter), or
+create mappings from english expressions to pickle model names.  You can also
+override many of the options on the Pickle::Config object if you so choose 
+
+  require 'pickle/world'
+
+  Pickle.configure do |config|
+    config.adapters = [:machinist, YourOwnAdapterClass]
+    config.map 'me', 'myself', 'my', 'I', :to => 'user: "me"'
+  end
+
+== API
+
+=== Steps
+
+When you run <tt>script/generate pickle</tt> you get the following steps
+
+==== Given steps
+
+"Given <b>a model</b> exists",  e.g.
+
+  Given a user exists
+  Given a user: "fred" exists
+  Given the user exists
+  
+"Given <b>a model</b> exists with <b>fields</b>",  e.g.
+
+  Given a user exists with name: "Fred"
+  Given a user exists with name: "Fred", activated: false
+  
+You can refer to other models in the fields
+
+  Given a user exists
+  And a post exists with author: the user
+  
+  Given a person: "fred" exists
+  And a person: "ethel" exists
+  And a fatherhood exists with parent: user "fred", child: user "ethel"
+  
+"Given <b>n</b> models exist", e.g.
+  
+  Given 10 users exist
+  
+"Given <b>n</b> <b>models</b> exist with <b>fields</b>", examples:
+
+  Given 10 users exist with activated: false
+
+==== Then steps
+
+===== Asserting existence of models
+
+"Then <b>a model</b> should exist",  e.g.
+
+  Then a user should exist
+
+"Then <b>a model</b> should exist with <b>fields</b>", e.g.
+
+  Then a user: "fred" should exist with name: "Fred" # we can label the found user for later use
+  
+You can use other models, booleans, numerics, and strings as fields
+
+  Then a person should exist with child: person "ethel"
+  Then a user should exist with activated: false
+  Then a user should exist with activated: true, email: "fred@gmail.com"
+  
+"Then <b>n</b> <b>models</b> should exist", e.g.
+
+  Then 10 events should exist
+  
+"Then <b>n</b> <b>models</b> should exist with <b>fields</b>", e.g.
+
+  Then 2 people should exist with father: person "fred"
+  
+===== Asserting associations
+
+One-to-one assocs: "Then <b>a model</b> should be <b>other model</b>'s <b>association</b>", e.g.
+
+  Then the person: "fred" should be person: "ethel"'s father
+  
+Many-to-one assocs: "Then <b>a model</b> should be [in|one of] <b>other model</b>'s <b>association</b>", e.g.
+
+  Then the person: "ethel" should be one of person: "fred"'s children
+  Then the comment should be in the post's comments
+  
+===== Asserting predicate methods
+
+"Then <b>a model</b> should [be|have] [a|an] <b>predicate</b>", e.g.
+
+  Then the user should have a status # => user.status?.should == true
+  Then the car: "batmobile" should be fast # => car.fast?.should == true
+  
+"Then <b>a model</b> should [be|have] [a|an] <b>predicate</b>", e.g.
+
+  Then person: "fred" should not be childless # => fred.childless?.should == false
+  
+=== Regexps for use in your own steps
+
+By default you get some regexps available in the main namespace for use
+in creating your own steps: `capture_model`, `capture_fields`, and others (see lib/pickle.rb)
+
+(You can use any of the regexps that Pickle uses by using the Pickle.parser namespace, see
+Pickle::Parser::Matchers for the methods available)
+
+*capture_model*
+
+  Given /^#{capture_model} exists$/ do |model_name|
+    model(model_name).should_not == nil
+  end
+
+  Then /^I should be at the (.*?) page$/ |page|
+    if page =~ /#{capture_model}'s/
+      url_for(model($1))
+    else
+      # ...
+    end
+  end
+
+  Then /^#{capture_model} should be one of #{capture_model}'s posts$/ do |post, forum|
+    model(forum).posts.should include(post)
+  end 
+
+*capture_fields*
+
+This is useful for setting attributes, and knows about pickle model names so that you
+can build up composite objects with ease
+
+  Given /^#{capture_model} exists with #{capture_fields}$/ do |model_name, fields|
+    create_model(model_name, fields)
+  end
+
+  # example of use
+  Given a user exists
+  And a post exists with author: the user # this step will assign the above user as :author on the post

data/lib/pickle/version.rb

@@ -2,7 +2,7 @@ module Pickle
   module Version
     Major = 0
     Minor = 1
-    Tiny  = 9
+    Tiny  = 10
     
     String = [Major, Minor, Tiny].join('.')
   end

data/rails_generators/pickle/pickle_generator.rb

@@ -19,7 +19,7 @@ class PickleGenerator < Rails::Generator::Base
         env_assigns[:pickle_path] = true unless current_env.include?("require 'pickle/path/world'")
         current_paths = File.read('features/support/paths.rb')
         unless current_paths.include?('#{capture_model}')
-          if current_paths =~ /^(.*)(\n\s+else\n\s+raise ".*"\n\s+end\nend\s*)$/m
+          if current_paths =~ /^(.*)(\n\s+else\n\s+raise "Can't find.*".*$)/m
             env_assigns[:current_paths_header] = $1
             env_assigns[:current_paths_footer] = $2
             m.template 'paths.rb', File.join('features/support', "paths.rb"), :assigns => env_assigns, :collision => :force

data/rails_generators/pickle/templates/paths.rb

@@ -1,20 +1,20 @@
 <%= current_paths_header %>
-  # added by script/generate pickle path
-  
-  when /^#{capture_model}(?:'s)? page$/                           # eg. the forum's page
-    path_to_pickle $1
-    
-  when /^#{capture_model}(?:'s)? #{capture_model}(?:'s)? page$/   # eg. the forum's post's page
-    path_to_pickle $1, $2
+    # added by script/generate pickle path
+
+    when /^#{capture_model}(?:'s)? page$/                           # eg. the forum's page
+      path_to_pickle $1
+
+    when /^#{capture_model}(?:'s)? #{capture_model}(?:'s)? page$/   # eg. the forum's post's page
+      path_to_pickle $1, $2
 
-  when /^#{capture_model}(?:'s)? #{capture_model}'s (.+?) page$/  # eg. the forum's post's comments page
-    path_to_pickle $1, $2, :extra => $3                           #  or the forum's post's edit page
+    when /^#{capture_model}(?:'s)? #{capture_model}'s (.+?) page$/  # eg. the forum's post's comments page
+      path_to_pickle $1, $2, :extra => $3                           #  or the forum's post's edit page
 
-  when /^#{capture_model}(?:'s)? (.+?) page$/                     # eg. the forum's posts page
-    path_to_pickle $1, :extra => $2                               #  or the forum's edit page
+    when /^#{capture_model}(?:'s)? (.+?) page$/                     # eg. the forum's posts page
+      path_to_pickle $1, :extra => $2                               #  or the forum's edit page
 
-  when /^the (.+?) page$/                                         # translate to named route
-    send "#{$1.downcase.gsub(' ','_')}_path"
+    when /^the (.+?) page$/                                         # translate to named route
+      send "#{$1.downcase.gsub(' ','_')}_path"
   
-  # end added by pickle path
+    # end added by pickle path
 <%= current_paths_footer %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ianwhite-pickle
 version: !ruby/object:Gem::Version 
-  version: 0.1.9
+  version: 0.1.10
 platform: ruby
 authors: 
 - Ian White
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-29 00:00:00 -08:00
+date: 2009-02-13 00:00:00 -08:00
 default_executable: 
 dependencies: []
 
@@ -42,7 +42,7 @@ files:
 - rails_generators/pickle/templates/paths.rb
 - rails_generators/pickle/templates/pickle_steps.rb
 - License.txt
-- README.textile
+- README.rdoc
 - Todo.txt
 - History.txt
 - spec/lib/pickle_adapter_spec.rb