gizmo 0.0.4 → 0.0.5

data/README.markdown

@@ -14,12 +14,25 @@ So, we've gone back to the drawing board and come up with a friendlier, cuddlier
 **Gizmo** is a simple page model testing framework used and sponsored by [realestate.com.au](http://www.realestate.com.au). The aim of the project is to DRY up testing assertions by abstracting code that defines your page, resulting in a consistent, easy to maintain test suite. The code is maintained by Contributors from REA, and largely based on concepts brought to REA by [Mark Ryall](http://github.com/markryall) and other [thoughtworkers](http://thoughtworks.com.au/)
 
 
+Install
+------------
+
+    sudo gem install gizmo
+
+
 Usage
 ------------
 * [with Cucumber](http://wiki.github.com/icaruswings/gizmo/cucumber)
 * [with RSpec](http://wiki.github.com/icaruswings/gizmo/rspec)
 
 
+Development
+------------
+* Source hosted at [Github](http://github.com/icaruswings/gizmo).
+* Please direct questions, discussions at the [mailing list](http://groups.google.com/group/gizmo-gem).
+* Report issues in the [Github issue tracker](http://github.com/icaruswings/gizmo/issues)
+
+
 Contributing
 ------------
 * Fork the project.

data/VERSION

@@ -1 +1 @@
-0.0.4
+0.0.5

data/features/github_example.feature

@@ -5,8 +5,7 @@ Feature:
 
     Scenario: A user can perform a search from the homepage
         Given a user is on the github homepage
-        When the user enters "gizmo" into the search box
-        And the user clicks the magnifying glass icon
+        When the user enters "gizmo" into the search box and clicks the magnifying glass icon
         And the user clicks on the "icaruswings / gizmo" link
         Then the user is on the "gizmo" github repository details page
         And the user is on a github repository details page which belongs to "icaruswings"

data/features/step_definitions/github_example_steps.rb

@@ -2,15 +2,9 @@ Given /^a user is on the github homepage$/ do
   visit "http://github.com"
 end
 
-When /^the user enters "([^\"]*)" into the search box$/ do |text|
+When /^the user enters "([^\"]*)" into the search box and clicks the magnifying glass icon$/ do |query|
   on_page_with :github_search do |page|
-    fill_in page.search_form.input.attr('name').value, :with => text
-  end
-end
-
-When /^the user clicks the magnifying glass icon$/ do
-  on_page_with :github_search do |page|
-    click page.search_form.submit.attr('alt').value
+    page.perform :search, query
   end
 end
 
@@ -26,12 +20,12 @@ end
 
 Then /^the user is on the "([^\"]*)" github repository details page$/ do |repo_name|
   on_page_with :github_repo_details do |page|
-    page.repo_details.name == repo_name
+    page.repo_details.name.should == repo_name
   end
 end
 
 Then /^the user is on a github repository details page which belongs to "([^\"]*)"$/ do |author|
   on_page_with :github_repo_details do |page|
-    page.repo_details.author == author
+    page.repo_details.author.should == author
   end
 end

data/features/support/pages/page_with_github_repo_details.rb

@@ -1,5 +1,7 @@
 module PageWithGithubRepoDetails
 
+  include Gizmo::PageMixin
+
   def valid?
     has_selector?("div.repohead")
   end
@@ -11,4 +13,4 @@ module PageWithGithubRepoDetails
     end
   end
 
-end
+end

data/features/support/pages/page_with_github_search.rb

@@ -1,5 +1,7 @@
 module PageWithGithubSearch
 
+  include Gizmo::PageMixin
+
   def valid?
     has_selector?("div.search")
   end
@@ -7,10 +9,15 @@ module PageWithGithubSearch
   def search_form
     element_struct do |form|
       form.container = @document.css("div.search")
-      form.element = container = form.container.css("form")
+      form.element = container= form.container.css("form")
       form.input = container.css("input[name=q]")
       form.submit = container.css("input[alt=search]")
     end
   end
 
+  define_action :search do |query|
+    fill_in search_form.input.attr('name').value, :with => query
+    click search_form.submit.attr('alt').value
+  end
+
 end

data/features/support/pages/page_with_github_search_results.rb

@@ -1,10 +1,11 @@
 module PageWithGithubSearchResults
 
+  include Gizmo::PageMixin
+
   def valid?
     has_selector?('div#code_search_results')
   end
 
-
   def search_results
     element_struct do |results|
       results.repositories = build_repositories

data/gizmo.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{gizmo}
-  s.version = "0.0.4"
+  s.version = "0.0.5"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Luke Cunningham", "Steven Holloway", "Sam Weller"]
-  s.date = %q{2010-04-10}
+  s.date = %q{2010-04-27}
   s.default_executable = %q{gizmo}
   s.description = %q{gizmo is a simple page model testing framework used and sponsored by 'realestate.com.au'. The aim of the project is to DRY up your testing assertions by abstracting code that defines your page resulting in a consistent, easy to maintain test suit}
   s.email = %q{luke@icaruswings.com}
@@ -36,13 +36,13 @@ Gem::Specification.new do |s|
      "gizmo.gemspec",
      "lib/gizmo.rb",
      "lib/gizmo/configuration.rb",
-     "lib/gizmo/extras.rb",
      "lib/gizmo/helpers.rb",
      "lib/gizmo/page.rb",
+     "lib/gizmo/page_mixin.rb",
      "spec/github_site_example_spec.rb",
      "spec/gizmo/configuration_spec.rb",
-     "spec/gizmo/extras_spec.rb",
      "spec/gizmo/helpers_spec.rb",
+     "spec/gizmo/page_mixin_spec.rb",
      "spec/gizmo/page_spec.rb",
      "spec/pages/page_with_test_mixin_stuff.rb",
      "spec/spec.opts",
@@ -56,8 +56,8 @@ Gem::Specification.new do |s|
   s.test_files = [
     "spec/github_site_example_spec.rb",
      "spec/gizmo/configuration_spec.rb",
-     "spec/gizmo/extras_spec.rb",
      "spec/gizmo/helpers_spec.rb",
+     "spec/gizmo/page_mixin_spec.rb",
      "spec/gizmo/page_spec.rb",
      "spec/pages/page_with_test_mixin_stuff.rb",
      "spec/spec_helper.rb"

data/lib/gizmo.rb

@@ -8,6 +8,7 @@ module Gizmo
 
   autoload :Page,       "gizmo/page"
   autoload :Helpers,    "gizmo/helpers"
+  autoload :PageMixin,  "gizmo/page_mixin"
 
   GizmoError = Class.new(StandardError)
   MixinNotValidError = Class.new(GizmoError)
@@ -16,5 +17,4 @@ module Gizmo
 
 end
 
-require "gizmo/configuration"
-require "gizmo/extras"
+require "gizmo/configuration"

data/lib/gizmo/helpers.rb

@@ -3,8 +3,9 @@ module Gizmo
   module Helpers
 
     def on_page &block
-      raise NilResponseError, "Doh! response object is nil. This generally means your scenario has not yet visited a page!" if response.nil?
-      yield Page.new(self, response.body, current_url)
+      resp = response
+      raise NilResponseError, "Doh! response object is nil. This generally means your scenario has not yet visited a page!" if resp.nil?
+      yield Page.new(self, resp.body, current_url)
     end
 
     def on_page_with *module_names
@@ -22,11 +23,12 @@ module Gizmo
 
     def load_mixin! mixin_name
       begin
+        mixin_dir = Gizmo.configuration.mixin_dir
         const_name = "PageWith#{mixin_name.to_s.camelize}"
-        require "#{Gizmo.configuration.mixin_dir}/page_with_#{mixin_name}.rb" unless Object.const_defined?(const_name)
+        require "#{mixin_dir}/page_with_#{mixin_name}.rb" unless Object.const_defined?(const_name)
         Object.const_get(const_name)
       rescue LoadError
-        raise MixinNotFoundError, "Expected a page mixin file at #{Gizmo.configuration.mixin_dir}/page_with_#{mixin_name}.rb generate one with `gizmo -g #{mixin_name}`"
+        raise MixinNotFoundError, "Expected a page mixin file at #{mixin_dir}/page_with_#{mixin_name}.rb generate one with `gizmo -g #{mixin_name}`"
       end
     end
 

data/lib/gizmo/page.rb

@@ -2,14 +2,9 @@ module Gizmo
 
   class Page
 
-    attr_reader :mixins, :url, :document
-
-    def extended_with base
-      @mixins << base
-    end
+    attr_reader :url, :document
 
     def initialize driver, content, url
-      @mixins = []
       @browser = driver
       @document = Nokogiri::HTML(content)
       @url = url
@@ -21,7 +16,7 @@ module Gizmo
     # then you will get an error message saying "Page did not have mixin #{name}"
     #eg.
     # def valid?
-    #   has_selector('some_element_selector')
+    #   has_selector?('some_element_selector')
     # end
     def valid?; true; end
 
@@ -29,8 +24,26 @@ module Gizmo
       @document.css(css_selector).length > 0
     end
 
+    def perform action_name, *params
+      method_name = "#{action_name.to_s}_action".to_sym
+      raise NoMethodError, "No action named '#{action_name}' has been defined" unless respond_to? method_name
+      send(method_name, *params)
+    end
+
+    def method_missing name, *args
+      method_name = name.to_sym
+      return super unless browser.respond_to?(method_name)
+      browser.send(method_name, *args)
+    end
+
     private
 
+    def browser; @browser; end
+
+    def define_action action_name, &block
+      self.class.send(:define_method, "#{action_name.to_s}_action".to_sym, &block)
+    end
+
     def element_struct
       open_struct = OpenStruct.new
       yield open_struct if block_given?

data/lib/gizmo/page_mixin.rb

@@ -0,0 +1,21 @@
+module Gizmo
+
+  module PageMixin
+
+    def self.included base
+      base.extend(InstanceMethods)
+    end
+
+    module InstanceMethods
+
+      private
+
+      def define_action action_name, &block
+        define_method("#{action_name.to_s}_action", &block)
+      end
+
+    end
+
+  end
+
+end

data/spec/github_site_example_spec.rb

@@ -25,7 +25,7 @@ describe "Github" do
 
     it "should have a text input which accepts a search query" do
       on_page_with :github_search do |page|
-        fill_in page.search_form.input.attr('name').value, :with => 'gizmo'
+        page.perform :search, 'gizmo'
       end
     end
 

data/spec/gizmo/page_mixin_spec.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Gizmo" do
+
+  before(:all) do
+    module MyModule
+      include Gizmo::PageMixin
+      define_action(:tell) { |message| message }
+    end
+    @obj = Gizmo::Page.new({},'',{}).extend(MyModule)
+  end
+
+  describe "PageMixin" do
+
+    describe "#define_action" do
+      it "should be a private method" do
+        MyModule.private_methods.should include 'define_action'
+      end
+
+      it "should define a new action" do
+        MyModule.send(:define_action, :x) { |x| x }
+        @obj.should respond_to :x_action
+      end
+
+      it "should call a defined action and return the expected response" do
+        @obj.perform(:tell, "hello world").should == "hello world"
+      end
+
+    end
+
+  end
+
+end

data/spec/gizmo/page_spec.rb

@@ -21,19 +21,11 @@ describe "Gizmo" do
         @response ||= mock('response', :body => mock_response)
       end
 
-      def current_url
-        'http://www.example.com'
-      end
-
-      @page = Gizmo::Page.new(self, response.body, current_url)
+      @page = Gizmo::Page.new(self, response.body, 'http://www.example.com')
     end
 
     describe "attributes and accessors" do
 
-      it "should have an instance variable @mixins" do
-        @page.instance_variable_get(:@mixins).should_not be_nil
-      end
-
       it "should have an instance variable @document" do
         @page.instance_variable_get(:@document).should_not be_nil
       end
@@ -48,36 +40,13 @@ describe "Gizmo" do
         end
       end
 
+
       describe "@url" do
         it "should return the expected string" do
           @page.instance_variable_get(:@url).should == "http://www.example.com"
         end
       end
 
-      describe "@mixins" do
-        it "should be accessible with .mixins" do
-          @page.mixins.should equal @page.instance_variable_get(:@mixins)
-        end
-
-        it "should return an array" do
-          @page.mixins.should be_an(Array)
-        end
-
-        it "should be writable using instance_variable_set" do
-          mixins = @page.mixins << :new_mixin
-          @page.instance_variable_set :@mixins, mixins
-          @page.mixins.should include :new_mixin
-        end
-      end
-
-      it "should have an attribute reader for @mixins" do
-        @page.should respond_to(:mixins)
-      end
-
-      it "should not have an attribute writer for @mixins" do
-        @page.should_not respond_to(:mixins=)
-      end
-
       it "should have an attribute reader for @url" do
         @page.should respond_to(:url)
       end
@@ -94,20 +63,28 @@ describe "Gizmo" do
         @page.should_not respond_to(:document=)
       end
 
+      it "should have a private attribute reader for browser" do
+        @page.private_methods.should include "browser"
+      end
+
     end
 
-    describe "#extended_with" do
+    it "should have a #perform method" do
+      @page.should respond_to :perform
+    end
 
-      it "should add the mixin name to the Page's @mixin instance attribute" do
-        on_page_with(:my_mixin, :my_other_mixin) do |page|
-          [:my_mixin, :my_other_mixin].each { |m| page.mixins.should include Object.const_get("PageWith#{m.to_s.camelize}") }
-        end
+    describe "delegate session methods to @browser" do
+      it "should be a private method" do
+        @page.should_not respond_to :click_link
       end
 
+      it "should define a new action within page" do
+        @page.send(:define_action, :tell) { |message| message }
+        @page.should respond_to :tell_action
+      end
     end
 
     describe "#has_selector?" do
-
       it "should return true if @document contains one or more elements matching the selector" do
         @page.has_selector?('p.one_of_these').should be_true
         @page.has_selector?('p.two_of_these').should be_true
@@ -116,11 +93,10 @@ describe "Gizmo" do
       it "should return false if @document does not contain one or more elements matching the selector" do
         @page.has_selector?('p.does_not_exist').should be_false
       end
-
     end
 
-    describe "#element_struct" do
 
+    describe "#element_struct" do
       it "should provide an override for OpenStruct to make it yield to a block" do
         @page.send(:element_struct) { |o| o.should be_an OpenStruct }
       end
@@ -128,7 +104,6 @@ describe "Gizmo" do
       it "should return an OpenStruct if not given a block" do
         @page.send(:element_struct).should be_an OpenStruct
       end
-
     end
 
   end

data/spec/spec_helper.rb

@@ -7,7 +7,7 @@ require 'spec/autorun'
 begin require 'redgreen' unless ENV['TM_CURRENT_LINE']; rescue LoadError; end
 
 Spec::Runner.configure do |config|
-  include Gizmo::Helpers
+  config.include Gizmo::Helpers
 
   config.before do
     Gizmo.configure do |config|

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Luke Cunningham
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-10 00:00:00 +10:00
+date: 2010-04-27 00:00:00 +10:00
 default_executable: gizmo
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -144,13 +144,13 @@ files:
 - gizmo.gemspec
 - lib/gizmo.rb
 - lib/gizmo/configuration.rb
-- lib/gizmo/extras.rb
 - lib/gizmo/helpers.rb
 - lib/gizmo/page.rb
+- lib/gizmo/page_mixin.rb
 - spec/github_site_example_spec.rb
 - spec/gizmo/configuration_spec.rb
-- spec/gizmo/extras_spec.rb
 - spec/gizmo/helpers_spec.rb
+- spec/gizmo/page_mixin_spec.rb
 - spec/gizmo/page_spec.rb
 - spec/pages/page_with_test_mixin_stuff.rb
 - spec/spec.opts
@@ -188,8 +188,8 @@ summary: simple page model testing framework
 test_files: 
 - spec/github_site_example_spec.rb
 - spec/gizmo/configuration_spec.rb
-- spec/gizmo/extras_spec.rb
 - spec/gizmo/helpers_spec.rb
+- spec/gizmo/page_mixin_spec.rb
 - spec/gizmo/page_spec.rb
 - spec/pages/page_with_test_mixin_stuff.rb
 - spec/spec_helper.rb

data/lib/gizmo/extras.rb

@@ -1,8 +0,0 @@
-# Override the #extended method on Module so it calls a method
-# #extended_with if it exists - we use this to manage an array
-# of modules that have been mixed in to a Gizmo::Page object
-class Module
-  def extended mixin
-    mixin.extended_with(self) if mixin.respond_to?(:extended_with)
-  end
-end

data/spec/gizmo/extras_spec.rb

@@ -1,13 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
-
-describe "Gizmo" do
-
-  describe "Extras" do
-
-    it "should override #extended in the base Module class" do
-      Module.new.should respond_to :extended
-    end
-
-  end
-
-end