stories 0.0.5

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2009 Damian Janowski and Michel Martens for Citrusbyte
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.markdown

@@ -0,0 +1,111 @@
+Stories
+=======
+
+Stories and User Acceptance Tests for the minimalist test framework [Contest](http://github.com/citrusbyte/contest).
+
+Description
+-----------
+
+Write user stories and user acceptace tests using Contest, the tiny add on to Test::Unit that provides nested contexts and declarative tests.
+
+Usage
+-----
+
+Declare your stories as follows:
+
+    require 'stories'
+
+    class UserStoryTest < Test::Unit::TestCase
+      story "As a user I want to create stories so I can test if they pass" do
+        setup do
+          @user = "valid user"
+        end
+
+        scenario "A valid user" do
+          assert_equal "valid user", @user
+        end
+      end
+    end
+
+If you are using Rails, you can use stories for your integration tests with Webrat:
+
+    class UserStoriesTest < ActionController::IntegrationTest
+      story "As a user I want to log in so that I can access restricted features" do
+        setup do
+          @user = User.spawn
+        end
+
+        scenario "Using good information" do
+          visit "/"
+          click_link "Log in"
+          fill_in :session_email, :with => user.email
+          fill_in :session_password, :with => user.password
+          click_button "Sign in"
+
+          assert_not_contain "Log in"
+          assert_not_contain "Sign up"
+        end
+      end
+    end
+
+You can run it normally, it's Test::Unit after all. If you want to run a particular test, say "yet more tests", try this:
+
+    $ ruby my_test.rb -n test_yet_more_tests
+
+Or with a regular expression:
+
+    $ ruby my_test.rb -n /yet_more_tests/
+
+Awesome output
+--------------
+
+You can get a nice output with your user stories with the `stories` runner:
+
+    $ ruby my_test.rb --runner=stories
+
+Now, if you want to impress everyone around you, try this:
+
+    $ ruby my_test.rb --runner=stories-pdf
+
+You will get a nicely formatted PDF with your user stories. It uses [Prawn](http://prawn.majesticseacreature.com/), so you will need to install it first.
+
+Installation
+------------
+
+    $ gem sources -a http://gems.github.com (you only have to do this once)
+    $ sudo gem install citrusbyte-stories
+
+If you want to use it with Rails, add this to config/environment.rb:
+
+    config.gem "citrusbyte-stories", :lib => 'stories', :source => 'http://gems.github.com'
+
+Then you can vendor the gem:
+
+    rake gems:install
+    rake gems:unpack
+
+License
+-------
+
+Copyright (c) 2009 Damian Janowski and Michel Martens for Citrusbyte
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,35 @@
+require 'rake'
+require 'rake/gempackagetask'
+require 'rake/testtask'
+require 'rake/clean'
+
+gem_spec_file = 'stories.gemspec'
+
+gem_spec = eval(File.read(gem_spec_file)) rescue nil
+
+task :default => :test
+
+Rake::TestTask.new(:test) do |t|
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+Rake::GemPackageTask.new(gem_spec) do |pkg|
+  pkg.need_zip = false
+  pkg.need_tar = false
+  rm_f FileList['pkg/**/*.*']
+end if gem_spec
+
+desc "Generate the gemspec file."
+task :gemspec do
+  require 'erb'
+
+  File.open(gem_spec_file, 'w') do |f|
+    f.write ERB.new(File.read("#{gem_spec_file}.erb")).result(binding)
+  end
+end
+
+desc "Builds and installs the gem."
+task :install => :repackage do
+  `sudo gem install pkg/#{gem_spec.name}-#{gem_spec.version}.gem`
+end

data/lib/stories.rb

@@ -0,0 +1,17 @@
+require "rubygems"
+require "contest"
+
+class Test::Unit::TestCase
+  class << self
+    alias story context
+    alias scenario test
+  end
+end
+
+Test::Unit::AutoRunner::RUNNERS[:stories] = proc do |r|
+  puts "Story runner not found. You need to require 'stories/runner'."
+end
+
+Test::Unit::AutoRunner::RUNNERS[:"stories-pdf"] = proc do |r|
+  puts "Story runner not found. You need to require 'stories/runner'."
+end

data/lib/stories/runner.rb

@@ -0,0 +1,149 @@
+require 'test/unit/ui/console/testrunner'
+
+$stories = []
+
+class Test::Unit::TestCase
+  class << self
+    alias original_story story
+    alias original_scenario scenario
+
+    def story(name, &block)
+      story = Stories::Story.new(name)
+
+      original_story(name) do
+        @@story = story
+        instance_eval(&block)
+      end
+
+      $stories << story
+    end
+
+    def scenario(name, &block)
+      scenario = Stories::Scenario.new(name)
+
+      original_scenario(name) do
+        @scenario = scenario
+        instance_eval(&block)
+      end
+
+      @@story.scenarios << scenario
+    end
+  end
+end
+
+module Stories
+  class Story
+    attr_accessor :name, :scenarios
+
+    def initialize(name)
+      @name = name
+      @scenarios = []
+    end
+  end
+
+  class Scenario
+    attr_accessor :name, :steps, :assertions
+
+    def initialize(name)
+      @name = name
+      @steps = []
+      @assertions = []
+    end
+  end
+
+  class Runner < Test::Unit::UI::Console::TestRunner
+    def test_finished(name)
+      print "."
+    end
+
+    def add_fault(fault)
+      print "F"
+      @faults << fault
+    end
+
+    def finished(elapsed_time)
+      puts
+
+      $stories.each_with_index do |story,i|
+        puts "- #{story.name}"
+
+        story.scenarios.each do |scenario|
+          puts "    #{scenario.name}"
+
+          unless scenario.steps.empty? && scenario.assertions.empty?
+            scenario.steps.each do |step|
+              puts "      #{step}"
+            end
+
+            scenario.assertions.each do |assertion|
+              puts "      #{assertion}"
+            end
+
+            puts
+          end
+        end
+
+        puts unless i + 1 == $stories.size
+      end
+
+      super
+      puts "%d stories, %d scenarios" % [$stories.size, $stories.inject(0) {|total,s| total + s.scenarios.size }]
+    end
+  end
+
+  module Webrat
+    def report_for(action, &block)
+      define_method(action) do |*args|
+        @scenario.steps << block.call(*args)
+        super
+      end
+    end
+
+    module_function :report_for
+  end
+end
+
+Test::Unit::AutoRunner::RUNNERS[:stories] = proc do |r|
+  Stories::Runner
+end
+
+Test::Unit::AutoRunner::RUNNERS[:"stories-pdf"] = proc do |r|
+  begin
+    Stories::Runner::PDF
+  rescue NameError
+    require File.expand_path(File.dirname(__FILE__) + "/runner/pdf")
+    Stories::Runner::PDF
+  end
+end
+
+# Common Webrat steps.
+module Stories::Webrat
+  report_for :click_link do |name|
+    "Click #{quote(name)}"
+  end
+  
+  report_for :click_button do |name|
+    "Click #{quote(name)}"
+  end
+
+  report_for :fill_in do |name, opts|
+    "Fill in #{quote(name)} with #{quote(opts[:with])}"
+  end
+
+  report_for :visit do |page|
+    "Go to #{quote(page)}"
+  end
+  
+  report_for :check do |name|
+    "Check #{quote(name)}"
+  end
+
+  report_for :assert_contain do |text|
+    "I should see #{quote(text)}"
+  end
+
+  def quote(text)
+    "“#{text}”"
+  end
+  module_function :quote
+end

data/lib/stories/runner/pdf.rb

@@ -0,0 +1,56 @@
+gem "prawn", "~> 0.4"
+require "prawn"
+
+module Stories
+  class Runner::PDF < Runner
+    def render_header(pdf)
+    end
+
+    def finished(elapsed_time)
+      super
+
+      Prawn::Document.generate("stories.pdf", :page_size => "A4") do |pdf|
+        render_header(pdf)
+
+        pdf.text "User Acceptance Tests", :size => 20, :style => :bold
+        
+        pdf.move_down(15)
+
+        $stories.each do |story|
+          pdf.text story.name, :style => :bold
+
+          story.scenarios.each_with_index do |scenario,i|
+            scenario_leading = 15
+
+            pdf.span(pdf.bounds.width - scenario_leading, :position => scenario_leading) do
+              pdf.text "— #{scenario.name}"
+
+              pdf.fill_color "666666"
+
+              unless scenario.steps.empty? && scenario.assertions.empty?
+                pdf.span(pdf.bounds.width - 30, :position => 30) do
+                  pdf.font_size(9) do
+                    render_many(pdf, scenario.steps)
+                    render_many(pdf, scenario.assertions)
+                  end
+                end
+              end
+
+              pdf.move_down(5) unless i + 1 == story.scenarios.size
+              
+              pdf.fill_color "000000"
+            end
+          end
+
+          pdf.move_down(10)
+        end
+      end
+    end
+
+    def render_many(pdf, elements)
+      elements.each do |el|
+        pdf.text el.to_s
+      end
+    end
+  end
+end

data/rails/init.rb

@@ -0,0 +1,13 @@
+if RAILS_ENV == 'test'
+
+  require File.dirname(__FILE__) + "/../lib/stories/runner"
+
+  # Require webrat and configure it to work in Rails mode.
+  require "webrat"
+
+  Webrat.configure do |config|
+    config.mode = :rails
+  end
+
+  ActionController::IntegrationTest.send(:include, Stories::Webrat)
+end

data/test/all_test.rb

@@ -0,0 +1,17 @@
+require File.dirname(__FILE__) + "/../lib/stories"
+require File.dirname(__FILE__) + "/../lib/stories/runner"
+
+# Use the story runner by default.
+Test::Unit::AutoRunner::RUNNERS[:console] = Proc.new {|r| Stories::Runner }
+
+class UserStoryTest < Test::Unit::TestCase
+  story "As a user I want to create stories so I can test if they pass" do
+    setup do
+      @user = "valid user"
+    end
+
+    scenario "A valid user" do
+      assert_equal "valid user", @user
+    end
+  end
+end

data/test/pdf_test.rb

@@ -0,0 +1,25 @@
+require File.dirname(__FILE__) + "/../lib/stories"
+require File.dirname(__FILE__) + "/../lib/stories/runner"
+require File.dirname(__FILE__) + "/../lib/stories/runner/pdf"
+
+class Stories::Runner::PDF
+  def render_header(pdf)
+    pdf.text "My custom header", :size => 20, :style => :bold
+    pdf.move_down 20
+  end
+end
+
+# Use the story runner by default.
+Test::Unit::AutoRunner::RUNNERS[:console] = Proc.new {|r| Stories::Runner::PDF }
+
+class UserStoryTest < Test::Unit::TestCase
+  story "As a user I want to create stories so I can test if they pass" do
+    setup do
+      @user = "valid user"
+    end
+
+    scenario "A valid user" do
+      assert_equal "valid user", @user
+    end
+  end
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification 
+name: stories
+version: !ruby/object:Gem::Version 
+  version: 0.0.5
+platform: ruby
+authors: 
+- Damian Janowski
+- Michel Martens
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-30 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: citrusbyte-contest
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.8
+    version: 
+description: 
+email: michel@soveran.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/stories/runner/pdf.rb
+- lib/stories/runner.rb
+- lib/stories.rb
+- README.markdown
+- LICENSE
+- Rakefile
+- rails/init.rb
+- test/all_test.rb
+- test/pdf_test.rb
+has_rdoc: false
+homepage: http://github.com/citrusbyte/stories
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.1
+signing_key: 
+specification_version: 2
+summary: Write stories and user acceptance tests using the minimalist testing framework Contest.
+test_files: []
+