RubyGems - sinatra-tests - Versions diffs - 0.1.5 → 0.1.6 - Mend

sinatra-tests 0.1.5 → 0.1.6

Files changed (14) hide show

data/README.rdoc +165 -12
data/Rakefile +3 -3
data/VERSION +1 -1
data/lib/sinatra/tests.rb +4 -2
data/lib/sinatra/tests/rspec/matchers.rb +224 -0
data/lib/sinatra/tests/rspec/shared_specs.rb +342 -0
data/sinatra-tests.gemspec +22 -17
data/spec/sinatra/tests/rspec/matchers_spec.rb +274 -0
data/spec/sinatra/tests/test_case_spec.rb +0 -15
data/spec/sinatra/tests/tests_spec.rb +30 -0
data/spec/spec_helper.rb +7 -9
metadata +52 -26
data/lib/sinatra/tests/init.rb +0 -174
data/lib/sinatra/tests/shared_specs.rb +0 -450

data/README.rdoc CHANGED

@@ -1,23 +1,23 @@
 = Sinatra::Tests
-Commonly used bits when testing Sinatra apps/gems.
+A Sinatra extension and repository of common RSpec helpers when testing your Sinatra apps/gems.
 == Installation
-  #  Add GitHub to your RubyGems sources
-  $  gem sources -a http://gems.github.com
+  #  Add Gemcutter to your RubyGems sources
+  $  gem sources -a http://gemcutter.com
-  $  (sudo)? gem install kematzy-sinatra-tests
+  $  (sudo)? gem install sinatra-tests
 === Dependencies
 This Gem depends upon the following:
 * sinatra ( >= 0.10.1 )
-* rspec (>= 1.2.7 )
-* rack-test (>= 0.4.1)
+* rspec (>= 1.3.0 )
+* rack-test (>= 0.5.3)
+* rspec_hpricot_matchers (>= 0.1.0)
 == Getting Started
@@ -45,7 +45,8 @@ Declare the following Spec block:
   Spec::Runner.configure do |config|
     config.include RspecHpricotMatchers
-    config.include Sinatra::Tests::SharedSpecs
+    config.include Sinatra::Tests::TestCase
+    config.include Sinatra::Tests::RSpec::SharedSpecs
   end
@@ -66,10 +67,7 @@ In your TestApp block, register the Sinatra::Tests extension, by adding the foll
 And finally define the TestCase block like this:
   class Test::Unit::TestCase
-    include Sinatra::Tests::TestCase
     Sinatra::Base.set :environment, :test
   end
 That's all. Now onto the niceties this provides you.
@@ -77,7 +75,142 @@ That's all. Now onto the niceties this provides you.
 == USAGE
-TODO:: write more documentation here
+=== RSpec Matchers
+==== :be_even
+A simple matcher that tests for an even number
+  1.should_not be_even
+  2.should be_even
+==== :have_a_page_title(:title_text)
+A simple matcher that tests for a <head> with a <title> tag with the given text.
+  body.should have_a_page_title("Home | Site Title")
+  body.should have_a_page_title(/Home/)
+==== :have_a_page_header(:text, :tag)
+A simple matcher that tests for <h(1..6)> header tag with the given text.
+<b>NB!</b> Throws an Exception when there's more than one page header on the page.
+  body.should have_a_page_header('Page Header')
+  body.should have_a_page_header(/Contact Information/, 'h1')
+  body.should have_a_page_header(/Contact Information/, 'body > h1')
+==== :have_a_ui_btn(:tag, :action, :model_name_singluar, :link_text)
+A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn :action-link'
+and a number of other specific values, derived from the other arguments passed.
+  body.should have_a_ui_btn('div', :edit, :article, 'Edit')
+    => expects <a href="/articles/:id/edit" class="ui-btn edit-link" title="edit article">Edit</a>
+  body.should have_a_ui_btn('div', :delete, :article) =>
+    => expects <a href="/articles/:id" class="ui-btn delete-link" title="delete article">DELETE</a>
+==== :have_an_edit_btn(:tag, :model_name_singluar)
+A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn edit-link'
+  body.should have_an_edit_btn('td.actions', :post)
+  body.should have_an_edit_btn('td.actions', :post, 'Custom Btn Text')
+==== :have_a_delete_btn(:tag, :model_name_singluar)
+A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn delete-link'
+  body.should have_a_delete_btn('td.actions', :post)
+  body.should have_a_delete_btn('td.actions', :post, 'Custom Btn Text')
+==== :have_a_show_btn(:tag, :model_name_singluar)
+A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn show-link'
+  body.should have_a_show_btn('td.actions', :post)
+  body.should have_a_show_btn('td.actions', :post, 'Custom Btn Text')
+=== RSpec SharedSpecs
+These are just some of the shared specs that I have been using, but they are being changed at the moment,
+so no guarantees of them surviving or remaining in their current form / functionality.
+==== DEBUG
+Dump a list of methods for the current <tt>app</tt>
+  it_should_behave_like "debug => app.methods"
+Tests the body output for a <tt><debug></tt> tag, ie: prints out the entire body content
+  it_should_behave_like "debug"
+==== RESPONSE
+Checks that we got a 200 status (OK), and content-type is <tt>text/html</tt>
+  it_should_behave_like "HTTP headers"
+  it_should_behave_like "HTML"
+Checks that we got a 200 status (OK), and content-type is <tt>text/css</tt>
+  it_should_behave_like "CSS"
+==== HTML OUTPUT
+Checks that the page has a <tt><div id="main-content"></div></tt>
+  it_should_behave_like "div#main-content"
+Checks that the page has an <tt><h2></tt> tag within the <tt><div id="main-content"></div></tt>
+  it_should_behave_like "div#main-content > h2"
+More to be addded later...
+==== FORMS
+Checks that the page has a form with a <tt><input type="hidden"...></tt> tag.
+  it_should_behave_like "forms > faux method > input.hidden"
+More to be addded later...
@@ -91,6 +224,26 @@ For a better understanding of this Gem, make sure you study the '<tt>sinatra-tes
 If something is not behaving intuitively, it is a bug, and should be reported.
 Report it here: http://github.com/kematzy/sinatra-tests/issues
+== TODOs
+* Add more tests to various matchers.
+* Create a test suite for the Shared Specs.
+* Add Test::Unit (assert*) matchers and shared tests. (Please fork and add if you want this!)
+== 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.
 == Credits
 Copyright (c) 2009 Kematzy [ kematzy gmail com ]

data/Rakefile CHANGED

@@ -10,9 +10,9 @@ begin
     gem.homepage = "http://github.com/kematzy/sinatra-tests"
     gem.authors = ["kematzy"]
     gem.add_dependency('sinatra', '>= 0.10.1')
-    gem.add_dependency('rack-test', '>= 0.4.1')
-    gem.add_dependency('rspec', '>= 1.2.8')
-    gem.add_dependency('rspec_hpricot_matchers', '>= 1.0.0')
+    gem.add_dependency('rack-test', '>= 0.5.3')
+    gem.add_dependency('rspec', '>= 1.3.0')
+    gem.add_dependency('rspec_hpricot_matchers', '>= 1.0')
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION CHANGED

	@@ -1 +1 @@
1	- 0.1.5
1	+ 0.1.6

data/lib/sinatra/tests.rb CHANGED

@@ -7,10 +7,12 @@ require 'spec'
 require 'spec/interop/test'
 require 'rspec_hpricot_matchers'
+# NB! I'm loading a private framework here,
+require 'alt/rext/string' unless String.respond_to?(:plural)
 module Sinatra
   module Tests
-    VERSION = '0.1.5' unless const_defined?(:VERSION)
+    VERSION = '0.1.6' unless const_defined?(:VERSION)
     def self.version; "Sinatra::Tests v#{VERSION}"; end
@@ -34,6 +36,6 @@ module Sinatra
   end #/module Test
 end #/module Sinatra
-%w(test_case shared_specs).each do |f|
+%w(test_case rspec/matchers rspec/shared_specs).each do |f|
   require "sinatra/tests/#{f}"
 end

data/lib/sinatra/tests/rspec/matchers.rb ADDED

@@ -0,0 +1,224 @@
+module Sinatra
+  module Tests
+    module RSpec
+      module Matchers
+        ##
+        # A simple matcher that tests for an even number
+        #
+        # ==== Examples
+        #
+        #   1.should_not be_even
+        #   2.should be_even
+        #
+        # @api public
+        def be_even
+          simple_matcher("an even number") { |given| given % 2 == 0 }
+        end
+        ##
+        # A simple matcher that tests for a <head> with a <title> tag
+        # with the given text.
+        #
+        # ==== Examples
+        #
+        #   body.should have_a_page_title("Home | Default Site Title")
+        #
+        #   body.should have_a_page_title(/Home/)
+        #
+        # @api public
+        def have_a_page_title(expected)
+          simple_matcher("have a page title in the <head> element with [#{expected}]") do |given, matcher|
+            given.should have_tag('head > title', expected)
+          end
+        end
+        ##
+        # A simple matcher that tests for <h(1..6)> header tag with the given text.
+        #
+        # NB! Throws an Exception when there's more than one page header on the page.
+        #
+        # ==== Examples
+        #
+        #   body.should have_a_page_header('Page Header')
+        #
+        #   body.should have_a_page_header(/Contact Information/, 'h1')
+        #
+        # @api public
+        def have_a_page_header(expected, tag = 'h2')
+          simple_matcher("have an '#{tag}' page header with [#{expected.inspect}]") do |given, matcher|
+            given.should have_tag(tag, expected, :count => 1)
+          end
+        end
+        ##
+        # TODO: add some comments here
+        #
+        # ==== Examples
+        #
+        #
+        # @api private
+        def have_a_td_actions(model, buttons = %w(delete edit))
+          simple_matcher do |given, matcher|
+            tag = "table##{model.to_s.plural}-table > tbody > tr > td.actions"
+            given.should have_tag(tag) do |td|
+              td.attributes['id'].should match(/#{model.to_s.singular}-actions-\d+/)
+            end
+            buttons.each do |btn|
+              given.should have_a_ui_btn(tag, btn.to_sym, model)
+            end
+          end
+        end
+        ##
+        # A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn'
+        # and a number of other specific values.
+        #
+        #
+        # ==== Examples
+        #
+        #   body.should have_a_ui_btn('div', :edit, :article, 'Edit') =>
+        #
+        #     => returns true when there is a <a href="/articles/:id/edit" class="ui-btn edit-link" title="edit article">Edit</a>
+        #
+        #
+        #   body.should have_a_ui_btn('div', :delete, :article) =>
+        #
+        #     => returns true when there is a <a href="/articles/:id" class="ui-btn delete-link" title="delete article">DELETE</a>
+        #
+        #
+        # @api private
+        def have_a_ui_btn(tag, type, model, text=nil)
+          text = type.to_s.upcase if text.nil?
+          simple_matcher("have a #{tag} with a ui-btn as a #{type}-btn for a [#{model}] with text #{text}") do |given, matcher|
+            given.should have_tag(tag + ' > a.ui-btn',text) do |a|
+              a.attributes['class'].should match(/#{type}-link/)
+              a.attributes['title'].should match(/#{type} #{model.to_s.singular}/)
+              if type == 'edit'
+                a.attributes['href'].should match(/\/#{model.to_s.plural}\/\d+\/edit/)
+              else
+                a.attributes['href'].should match(/\/#{model.to_s.plural}\/\d+/)
+              end
+            end
+          end
+        end
+        ##
+        # A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn edit-link'
+        #
+        # ==== Examples
+        #
+        #   body.should have_an_edit_btn('td.actions', :post)
+        #
+        #   body.should have_an_edit_btn('td.actions', :post, 'Custom Btn Text')
+        #
+        # @api private
+        def have_an_edit_btn(tag, model, text="EDIT")
+          have_a_ui_btn(tag, :edit, model, text)
+        end
+        ##
+        # A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn delete-link'
+        #
+        # ==== Examples
+        #
+        #   body.should have_a_delete_btn('td.actions', :post)
+        #
+        #   body.should have_a_delete_btn('td.actions', :post, 'Custom Btn Text')
+        #
+        # @api private
+        def have_a_delete_btn(tag, model, text="DELETE")
+          have_a_ui_btn(tag, :delete, model, text)
+        end
+        ##
+        # A simple matcher that tests for a <tt><a href></tt> tag with class 'ui-btn show-link'
+        #
+        # ==== Examples
+        #
+        #   body.should have_a_show_btn('td.actions', :post)
+        #
+        #   body.should have_a_show_btn('td.actions', :post, 'Custom Btn Text')
+        #
+        # @api private
+        def have_a_show_btn(tag, model, text="SHOW")
+          have_a_ui_btn(tag, :show, model, text)
+        end
+        # :stopdoc:
+        # def have_id_attribute(tag, id)
+        #   simple_matcher do |given, matcher|
+        #     given.should have_tag(tag).attributes['id'].should match(id)
+        #   end
+        # end
+        # def have_link_title(title)
+        #   simple_matcher do |given, matcher|
+        #     given.attributes['title'].should == title
+        #   end
+        # end
+        ##
+        # TODO: add some comments here
+        #
+        # ==== Examples
+        #
+        #
+        # @api private
+        def have_an_ui_form_header(model, options = {} )
+        end
+        ##
+        # TODO: add some comments here
+        #
+        # ==== Examples
+        #
+        #
+        # @api private
+        def have_a_ui_form_message(state, msg = nil)
+          simple_matcher do |given, matcher|
+            if msg.nil?
+              given.should have_tag("form > div.ui-form-message.#{state} > p") #ignoring message
+            else
+              given.should have_tag("form > div.ui-form-message.#{state} > p", msg)
+            end
+          end
+        end
+        ##
+        # TODO: add some comments here
+        #
+        # ==== Examples
+        #
+        #
+        # @api private
+        def have_an_admin_header(options ={})
+          simple_matcher do |given, matcher|
+            matcher.description = "be an admin_header with [#{options.inspect}]"
+            matcher.failure_message = "expected #{given} to have an admin-section-header with these values #{options.inspect}"
+            given.should have_tag('div.admin-section-header')
+            if options[:model]
+              given.should have_tag('div.admin-section-header > div.section > h2', /#{options[:model].to_s}/i )
+              if options[:add_new]
+                given.should have_tag("div.admin-section-header > div.actions > h4 > a[@href=/#{options[:model].to_s.downcase}/new]", /ADD NEW #{options[:model].to_s.singular}:?/i )
+              end
+            end
+          end
+        end
+        # :doc:
+      end #/module Matchers
+    end #/module RSpec
+  end #/module Tests
+end #/module Sinatra