featured_model 0.1.0 → 0.1.2

data/.gitignore

@@ -1,4 +1,5 @@
 *.sw?
+*.tmproj
 .DS_Store
 coverage
 rdoc

data/README.rdoc

@@ -1,9 +1,58 @@
-= featured_model
+h1. featured_model
 
-Cucumber step definitions to create model instances with dynamic attributes and associations.
+Warning! As reflected by the incredibly low version number, this is a new work in progress.  We are sharing it with you early and often in the hope you will find it useful and help us make it better quicker.
+
+We love using "fixjour":http://github.com/nakajima/fixjour in RSpec for creating test instances of our models.  featured_model allows us the same flexibility in Cucumber.
+
+For example, doing this in RSpec:
+<pre>@address = create_address(:city => "Madison", :state => "WI", :zip_code => "53703")
+@order = create_order(:status => "open", :order_id_amazon => "1234", :address => @address)</pre>
+
+can be done in Cucumber as:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison"</pre>
+
+h2. Installation
+
+  coming soon...
+
+h2. Usage
+
+Start your call off with @"a new <model-name>"@ where @<model-name>@ is a lower case version of the class name you want to build with fixjour.  Underscores can be replaced with spaces.
+
+For example:
+<pre>Given a new address</pre>
+
+| actual class name | @<model-name>@ |
+| Order | order |
+| LineItem | line item |
+
+h3. Add attribute values
+
+Add the first attribute to your call using the @'with'@ operator:
+<pre>Given a new address with city "Madison"</pre>
+
+Add as many additional attributes as you want using the @'and'@ operator:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"</pre>
+
+h3. Add associations
+
+We specify the associated object using attributes, instead of ActiveRecord id numbers. This is more in the spirit of functional Cucumber testing to not depend on details an end user would not understand.
+
+Use the @'for'@ operator to specify an association.  You must give the association enough attributes to find the correct, desired associated object in the database.
+
+In this example, we create a new order and setting its address to the address created on the line before.
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison"</pre>
+
+Note how we did not have to specify all the attributes for the associated object.  We just give the minimal attributes in order to find the correct object.  In this case, city "Madison" is enough since there is no other address in the database with city set to "Madison".  If your test has more addresses in play, then you'll need to specify more attributes.
+
+In other words, the example above can also be written as:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison" and state "WI" and zip code "53703"</pre>
+
+h2. Note on Patches/Pull Requests
 
-== Note on Patches/Pull Requests
- 
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -13,11 +62,14 @@ Cucumber step definitions to create model instances with dynamic attributes and
    bump version in a commit by itself I can ignore when I pull)
 * Send me a pull request. Bonus points for topic branches.
 
-== Contributors
+h2. Contributors
+
 listrophy
 bendycode
 coreyhaines
+arta
+randland
 
-== Copyright
+h2. Copyright
 
 Copyright (c) 2009 bendyworks. See LICENSE for details.

data/README.textile

@@ -0,0 +1,75 @@
+h1. featured_model
+
+Warning! As reflected by the incredibly low version number, this is a new work in progress.  We are sharing it with you early and often in the hope you will find it useful and help us make it better quicker.
+
+We love using "fixjour":http://github.com/nakajima/fixjour in RSpec for creating test instances of our models.  featured_model allows us the same flexibility in Cucumber.
+
+For example, doing this in RSpec:
+<pre>@address = create_address(:city => "Madison", :state => "WI", :zip_code => "53703")
+@order = create_order(:status => "open", :order_id_amazon => "1234", :address => @address)</pre>
+
+can be done in Cucumber as:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison"</pre>
+
+h2. Installation
+
+  coming soon...
+
+h2. Usage
+
+Start your call off with @"a new <model-name>"@ where @<model-name>@ is a lower case version of the class name you want to build with fixjour.  Underscores can be replaced with spaces.
+
+For example:
+<pre>Given a new address</pre>
+
+| actual class name | @<model-name>@ |
+| Order | order |
+| LineItem | line item |
+
+h3. Add attribute values
+
+Add the first attribute to your call using the @'with'@ operator:
+<pre>Given a new address with city "Madison"</pre>
+
+Add as many additional attributes as you want using the @'and'@ operator:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"</pre>
+
+h3. Add associations
+
+We specify the associated object using attributes, instead of ActiveRecord id numbers. This is more in the spirit of functional Cucumber testing to not depend on details an end user would not understand.
+
+Use the @'for'@ operator to specify an association.  You must give the association enough attributes to find the correct, desired associated object in the database.
+
+In this example, we create a new order and setting its address to the address created on the line before.
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison"</pre>
+
+Note how we did not have to specify all the attributes for the associated object.  We just give the minimal attributes in order to find the correct object.  In this case, city "Madison" is enough since there is no other address in the database with city set to "Madison".  If your test has more addresses in play, then you'll need to specify more attributes.
+
+In other words, the example above can also be written as:
+<pre>Given a new address with city "Madison" and state "WI" and zip code "53703"
+And a new order with status "open" and order id amazon "1234" for address with city "Madison" and state "WI" and zip code "53703"</pre>
+
+h2. Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+h2. Contributors
+
+listrophy
+bendycode
+coreyhaines
+arta
+randland
+
+h2. Copyright
+
+Copyright (c) 2009 bendyworks. See LICENSE for details.

data/Rakefile

@@ -9,11 +9,12 @@ begin
     gem.description = %Q{Additional steps that add a bunch of functionality for creating models with one line}
     gem.email = "stephen@bendyworks.com"
     gem.homepage = "http://github.com/bendyworks/featured_model"
-    gem.authors = ["bendycode"]
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "cucumber"
+    gem.authors = ["bendycode", 'listrophy', 'arta', 'randland']
+    gem.add_development_dependency "fixjour"
+    # gem.add_development_dependency "cucumber"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end
+  Jeweler::GemcutterTasks.new
 rescue LoadError
   puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
 end

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.1.2

data/featured_model.gemspec

@@ -5,22 +5,24 @@
 
 Gem::Specification.new do |s|
   s.name = %q{featured_model}
-  s.version = "0.1.0"
+  s.version = "0.1.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["bendycode"]
-  s.date = %q{2009-10-06}
+  s.authors = ["bendycode", "listrophy", "arta", "randland"]
+  s.date = %q{2009-10-30}
   s.description = %q{Additional steps that add a bunch of functionality for creating models with one line}
   s.email = %q{stephen@bendyworks.com}
   s.extra_rdoc_files = [
     "LICENSE",
-     "README.rdoc"
+     "README.rdoc",
+     "README.textile"
   ]
   s.files = [
     ".document",
      ".gitignore",
      "LICENSE",
      "README.rdoc",
+     "README.textile",
      "Rakefile",
      "VERSION",
      "featured_model.gemspec",
@@ -43,14 +45,11 @@ Gem::Specification.new do |s|
     s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<cucumber>, [">= 0"])
+      s.add_development_dependency(%q<fixjour>, [">= 0"])
     else
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<cucumber>, [">= 0"])
+      s.add_dependency(%q<fixjour>, [">= 0"])
     end
   else
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<cucumber>, [">= 0"])
+    s.add_dependency(%q<fixjour>, [">= 0"])
   end
 end

data/lib/featured_model/steps.rb

@@ -1,4 +1,19 @@
-Given /^a new (\S+)(.*)$/ do |model_name, args|
+Given /^a new (\S+)(.*) with:$/ do |model_name, args, attr_table|
+  combined_args = args
+  attr_table.raw.each do |attr_array|
+    attr_name = attr_array[0]
+    attr_value = attr_array[1]
+    attr_phrase = " with #{attr_name} \"#{attr_value}\""
+    combined_args += attr_phrase
+  end
+  create_dynamic_instance model_name, combined_args
+end
+
+Given /^a new (\S+)(.*[^:])$/ do |model_name, args|
+  create_dynamic_instance model_name, args
+end
+
+def create_dynamic_instance model_name, args
   attributes = {}
   parsing_state = ""
   args.scan(/(for|with|and) ([^\"]+) "([^\"]*)"/).each do |declaration|
@@ -11,11 +26,15 @@ Given /^a new (\S+)(.*)$/ do |model_name, args|
       associated_model, lookup_attribute = key.split(' with ').map {|x| x.gsub(/ /, '_')}
       fk_name = associated_model
       klass = Address
+
+      # TODO: Pick up these aliases dynamically from the ActiveRecord declarations.
+      # it should not live here
       if associated_model == 'address'
         fk_name = 'shipping_address'
       else
         klass = associated_model.classify.constantize
       end
+
       attributes[fk_name + '_id'] = klass.first(:conditions => {lookup_attribute => value}).id
     else        ; raise('unknown join word "%s"' % parsing_state)
     end

metadata

@@ -1,29 +1,22 @@
 --- !ruby/object:Gem::Specification 
 name: featured_model
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.1.2
 platform: ruby
 authors: 
 - bendycode
+- listrophy
+- arta
+- randland
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-10-06 00:00:00 -05:00
+date: 2009-10-30 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rspec
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: cucumber
+  name: fixjour
   type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
@@ -41,11 +34,13 @@ extensions: []
 extra_rdoc_files: 
 - LICENSE
 - README.rdoc
+- README.textile
 files: 
 - .document
 - .gitignore
 - LICENSE
 - README.rdoc
+- README.textile
 - Rakefile
 - VERSION
 - featured_model.gemspec