saki 0.0.2 → 0.0.3

data/README.markdown

@@ -1,12 +1,14 @@
 # Saki - For times when you can't swallow Cucumber
 
-Saki lets you do acceptance testing on top of RSpec with considerably more terseness than cucumber, but without sacrificing readability.  Are you tired of having DRY code, but tests that seem to babble on "for the length of a bible"?  Me too.  How about RSpec code that is hard to follow, while Ruby itself is as "human" as a programming language can get?  I hate it too.
+Saki lets you do acceptance testing on top of RSpec.  It is considerably more terse than cucumber, but does not sacrifice readability.
+
+Are you tired of having DRY code, but tests that seem to babble on "for the length of a bible"?  Me too.  How about RSpec code that is hard to follow, when Ruby itself is as "human" as a programming language can get?  I hate it too.
 
 Enter Saki stage left.
 
 ## How terse is it?
 
-Well, here's a sample that assumes a user exists and visits an edit path for that user.  Me like.
+Well, here's a sample that sets up contexts that create a user and then visit an edit path for that user.
 
 	with_existing :user do
 		on_visiting edit_path_for(:user) do
@@ -14,7 +16,7 @@ Well, here's a sample that assumes a user exists and visits an edit path for tha
 		end
 	end
 
-This code basically injects some before blocks behind the scene, so it would look like this in vanilla RSpec:
+This code basically injects some "before blocks", so it would look like this in vanilla RSpec:
 
 	context "when a user exists" do
 		before { @user = Factory :user }
@@ -24,11 +26,37 @@ This code basically injects some before blocks behind the scene, so it would loo
   		end
 	end
 
-Much more expressive don't you think?  And smooth to follow, no?
+I feel Saki is much more expressive.
+
+## What class-level methods does it use (for setting up contexts)?
+
+`with_existing` takes a factory name as a symbol and assigns it to on instance variable with the same name.
+
+`on_visiting` takes a path either as a string or as a lambda that executes within a before block to set up the path.  This is useful when the code is dependent on an instance variable for path creation.
+
+`on_visiting` has several helper functions for establishing a path: `create_path_for`, `index_path_for`, `edit_path_for`, `show_path_for` and `new_path_for`.  These paths all take resource names for establishing a path.  In cases where the resource is nested, it has a :parent => parent_resource option.  This lets you set up blocks like:
+
+    on_visiting index_path_for(:auction)
+
+`where` is a function taking as a parameter either a lambda to execute in the before block, or a symbol which is the name of a function to execute in the before block.
+
+Finally, to simplify setting up integration tests, anything you wrap in an `integrate` block (like `describe`) sets the test type to acceptance.
+
+## Installation
+
+Saki installs with two steps.  First, add to your Gemfile:
+
+    gem 'saki'
+
+Then to fill out the directories run:
+
+    rails generate saki:install
 
+Then, as long as your acceptance specs require the acceptance_helper file you should be good to go.
+    
 ## What assumptions does it make?  
 
-It assumes that you are using factory_girl and capybara, though it probably would work fine with other test factories and webrat.  If you need another factory in the mix, just redefine the default_factory method to behave how you want.
+It assumes that you are using factory_girl and capybara or webrat, though it probably would work fine with other test factories.  If you need another factory in the mix, just redefine the `default_factory` method to behave how you want.
 
 ## Note on Patches/Pull Requests
  

data/VERSION

@@ -1 +1 @@
-0.0.2
+0.0.3

data/lib/generators/saki/install_generator.rb

@@ -0,0 +1,39 @@
+require 'rails/generators'
+AcceptanceDir = "acceptance"
+
+module Saki
+  class InstallGenerator < Rails::Generators::Base
+    class_option :webrat, :desc => 'Use Webrat.', :type => :boolean
+    class_option :capybara, :desc => 'Use Capybara.', :type => :boolean
+
+    source_root File.join(File.dirname(__FILE__), 'templates')
+
+    desc <<-DESC
+Description:
+Sets up Saki in your Rails project. This will generate the
+spec/acceptance directory and the necessary files.
+
+If you haven't already, You should also run
+`rails generate rspec:install` to complete the set up.
+
+Examples:
+`rails generate saki:install`
+DESC
+
+    def initialize(args=[], options={}, config={})
+      puts "Defaulting to Capybara..." if options.empty?
+      super
+    end
+
+    def manifest
+      empty_directory "spec/#{AcceptanceDir}/support"
+      template "acceptance_helper.rb", "spec/#{AcceptanceDir}/acceptance_helper.rb"
+      copy_file "helpers.rb", "spec/#{AcceptanceDir}/support/helpers.rb"
+    end
+
+    def driver
+      @driver = options.webrat? ? 'webrat' : 'capybara'
+    end
+  end
+end
+

data/lib/generators/saki/templates/acceptance_helper.rb

@@ -0,0 +1,28 @@
+require File.dirname(__FILE__) + "/../spec_helper"
+
+<%- if driver == 'webrat' %>
+require "webrat"
+
+Webrat.configure do |config|
+config.mode = :rack
+end
+
+module Saki::Webrat
+include Rack::Test::Methods
+include Webrat::Methods
+include Webrat::Matchers
+def app
+Rails.application
+end
+end
+
+RSpec.configuration.include Saki::Webrat, :type => :acceptance
+
+<%- else -%>
+require 'capybara/rails'
+
+RSpec.configuration.include Capybara, :type => :acceptance
+<%- end -%>
+
+# Put your acceptance spec helpers inside /spec/acceptance/support
+Dir["#{File.dirname(__FILE__)}/support/**/*.rb"].each {|f| require f}

data/lib/generators/saki/templates/helpers.rb

@@ -0,0 +1,6 @@
+module HelperMethods
+  # Put helper methods you need to be available in all tests here.
+end
+
+RSpec.configuration.include HelperMethods, :type => :acceptance
+

data/lib/saki.rb

@@ -1,3 +1,5 @@
+require 'rspec/core'
+
 module Saki
   module AcceptanceHelpers
     extend ActiveSupport::Concern
@@ -123,9 +125,13 @@ module Saki
         end
       end
 
-      def where(closure, &block)
+      def where(executable, &block)
         context "anonymous closure" do
-          before { instance_eval &closure }
+          if executable.is_a? Symbol
+            before { send executable }
+          else
+            before { instance_eval &executable }
+          end
           module_eval &block
         end
       end
@@ -133,4 +139,14 @@ module Saki
   end
 end
 
+module RSpec::Core::ObjectExtensions
+  def integrate(*args, &block)
+    args << {} unless args.last.is_a?(Hash)
+    args.last.update :type => :acceptance
+    describe(*args, &block)
+  end
+end
+
+
+
 RSpec.configuration.include Saki::AcceptanceHelpers, :type => :acceptance

data/saki.gemspec

@@ -5,7 +5,7 @@
 
 Gem::Specification.new do |s|
   s.name = %q{saki}
-  s.version = "0.0.2"
+  s.version = "0.0.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Nate Kidwell"]
@@ -23,6 +23,9 @@ Gem::Specification.new do |s|
      "README.markdown",
      "Rakefile",
      "VERSION",
+     "lib/generators/saki/install_generator.rb",
+     "lib/generators/saki/templates/acceptance_helper.rb",
+     "lib/generators/saki/templates/helpers.rb",
      "lib/saki.rb",
      "saki.gemspec",
      "test/helper.rb",

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: saki
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 0
-  - 2
-  version: 0.0.2
+  - 3
+  version: 0.0.3
 platform: ruby
 authors: 
 - Nate Kidwell
@@ -48,6 +48,9 @@ files:
 - README.markdown
 - Rakefile
 - VERSION
+- lib/generators/saki/install_generator.rb
+- lib/generators/saki/templates/acceptance_helper.rb
+- lib/generators/saki/templates/helpers.rb
 - lib/saki.rb
 - saki.gemspec
 - test/helper.rb