prickle 0.0.2 → 0.0.3

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+ - 1.9.2
+ - 1.9.3
+ - ruby-head
+
+before_script:
+ - sh -e /etc/init.d/xvfb start
+ - export DISPLAY=:99.0

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    prickle (0.0.1)
+    prickle (0.0.2)
       capybara
 
 GEM
@@ -26,6 +26,7 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
+    rake (0.9.2)
     reek (1.2.8)
       ruby2ruby (~> 1.2)
       ruby_parser (~> 2.0)
@@ -64,6 +65,7 @@ PLATFORMS
 DEPENDENCIES
   capybara
   prickle!
+  rake
   reek
   rspec (~> 2.8.0)
   sinatra (~> 1.3.2)

data/README.md

@@ -1,3 +1,7 @@
+# Prickle
+
+[![Build Status](https://secure.travis-ci.org/ExtractMethod/prickle.png)](http://travis-ci.org/ExtractMethod/prickle)
+
 ![](http://github.com/despo/prickle/raw/master/prickle.png)
 
 ## Configuration
@@ -78,3 +82,20 @@ click_input_by_name "blue" #click_<element_tag>_by_name "<name>"
 ```ruby
 div_contains_text? "text" #<element_tag>_contains_text? "text"
 ```
+
+## Popup actions
+
+```ruby
+confirm_popup  # can be used for both confirmation boxed and alert boxes
+dismiss_popup
+popup_message
+
+popup_message_contains? "<text>"
+```
+
+## Capturing screenshots
+
+```ruby
+capture_screen
+capture_screen "<file>"
+```

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.rspec_path = 'rspec'
+  t.rspec_opts = ["-cfd"]
+end
+
+task :default => :spec

data/lib/prickle/capybara/actions.rb

@@ -0,0 +1,20 @@
+module Prickle
+  module Capybara
+    module Actions
+
+      def click
+        find_element.click
+      end
+
+      def contains_text? text
+        @text = text
+        find_element
+      end
+
+      def exists?
+        find_element
+      end
+
+    end
+  end
+end

data/lib/prickle/capybara/element.rb

@@ -1,53 +1,66 @@
-require_relative 'find'
-require_relative 'click'
-require_relative 'match'
+require 'capybara/dsl'
+require_relative 'actions'
 require_relative 'exceptions'
 
 module Prickle
   module Capybara
     class Element
 
-      require 'capybara/dsl'
       include ::Capybara::DSL
 
-      def initialize type="*", identifier
+      OF_ANY_TYPE = "*"
+      CONVERTED_TYPES = { :link => 'a',
+                          :paragraph => 'p'
+                        }
+
+      private
+
+      def initialize type=OF_ANY_TYPE, identifier
         @identifier = identifier
         @type = type
         self
       end
 
+      def find_element
+        handle_exception { find_element_by xpath }
+      end
+
+      def find_element_by xpath
+        wait_until(Prickle::Capybara.wait_time) do
+          find(:xpath, xpath).visible?
+        end unless Prickle::Capybara.wait_time.nil?
+
+        find(:xpath, xpath)
+      end
+
       def handle_exception &block
         begin
           block.call
         rescue Exception => e
-          raise ElementNotFound, Error.new(@type, @identifier, @text, e).message if e.class.to_s == "Capybara::ElementNotFound"
+          error_message = Error.new(@type, @identifier, @text, e).message
+          raise ElementNotFound, error_message if e.class.to_s == "Capybara::ElementNotFound"
           raise
         end
       end
 
       def identifier
-        return @identifier.each_pair.to_a.map do |key, value|
-          "@#{key}='#{value}'"
-        end.join ' and '
+        return @identifier.each_pair.to_a.map { |k, v| "@#{k}='#{v}'" }.join " and "
       end
 
-      def find_element_by xpath
-        wait_until(Prickle::Capybara.wait_time) do
-          find(:xpath, xpath).visible?
-        end unless Prickle::Capybara.wait_time.nil?
-
-        find(:xpath, xpath)
+      def type
+        CONVERTED_TYPES[@type.to_sym] || @type
       end
 
-      def type_of element
-        Prickle::TAGS[element.to_sym] || element
+      def xpath
+        xpath = "//#{type}[#{identifier}"
+        xpath << " and contains(text(), '#{@text}')" if @text
+        xpath << "]"
       end
 
-      include Prickle::Actions::Find
-      include Prickle::Actions::Match
-      include Prickle::Actions::Click
+      public
 
-    end
+      include Prickle::Capybara::Actions
 
+    end
   end
 end

data/lib/prickle/capybara/exceptions.rb

@@ -3,9 +3,11 @@ module Prickle
 
     class ElementNotFound < Exception; end;
 
+    class MessageNotContainedInPopup < Exception; end;
+
     class Error
 
-      def initialize type, identifier, text, caught_exception
+      def initialize type=nil, identifier=nil, text=nil, caught_exception=nil
         @element_type = type
         @element_identifier = identifier
         @element_text = text
@@ -16,6 +18,10 @@ module Prickle
         "#{element_text} with properties #{identifier} #{text_string} was not found.\n\tError: #{@caught_exception.message}"
       end
 
+      def not_contained_in_popup message
+        "Text #{highlight(message)} is not contained in the popup."
+      end
+
       private
 
       def element_text
@@ -35,5 +41,6 @@ module Prickle
         "\e[1m#{text}\e[0m\e[31m"
       end
     end
+
   end
 end

data/lib/prickle/capybara.rb

@@ -1,27 +1,43 @@
 require_relative 'capybara/element'
 
 module Prickle
-  TAGS = { :link => 'a',
-    :paragraph => 'p'
-  }
-
   module Capybara
 
     class << self
-      attr_accessor :wait_time
+      attr_accessor :wait_time, :image_dir
+
+    end
+
+    def capture_screen name=Time.now.strftime("%Y%m%d-%H.%M.%s")
+      page.driver.browser.save_screenshot Capybara.image_dir + name + ".jpg"
+    end
 
+    def click_by_name name
+      find_by_name(name).click
     end
 
-    def element type='*', identifier
+    def confirm_popup
+      page.driver.browser.switch_to.alert.accept
+    end
+
+    def dismiss_popup
+      page.driver.browser.switch_to.alert.dismiss
+    end
+
+    def element type=Element::OF_ANY_TYPE, identifier
       Element.new type, identifier
     end
 
-    def find_by_name type='*', name
+    def find_by_name type=Element::OF_ANY_TYPE, name
       element(type, :name => name).exists?
     end
 
-    def click_by_name name
-      find_by_name(name).click
+    def popup_message
+      page.driver.browser.switch_to.alert.text
+    end
+
+    def popup_message_contains? message
+      raise Capybara::MessageNotContainedInPopup, Error.new.not_contained_in_popup(message) unless popup_message.eql? message
     end
 
     private

data/lib/prickle/version.rb

@@ -1,3 +1,3 @@
 module Prickle
-  VERSION = '0.0.2'
+  VERSION = '0.0.3'
 end

data/prickle.gemspec

@@ -24,6 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency "capybara"
   s.add_development_dependency "rspec", "~> 2.8.0"
   s.add_development_dependency "sinatra", "~> 1.3.2"
+  s.add_development_dependency "rake"
   s.add_development_dependency "reek"
 end
 

data/spec/capybara_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Prickle::Capybara do
+  let(:prickly) { Prickly.new }
+
+  before do
+    Capybara.default_driver = :selenium
+    Prickle::Capybara.wait_time = nil
+  end
+
+  before(:each) do
+    prickly.visit '/'
+  end
+
+  context 'Managing popups', :javascript => true do
+
+    it 'can confirm an alert box' do
+      prickly.click_by_name 'popups'
+      prickly.confirm_popup
+    end
+
+    it 'can confirm a popup' do
+      prickly.click_by_name 'confirm_box'
+      prickly.confirm_popup
+    end
+
+    it 'can dismiss a popup' do
+      prickly.click_by_name 'confirm_box'
+      prickly.dismiss_popup
+      prickly.popup_message.should eq "Aborting."
+      prickly.confirm_popup
+    end
+
+    context "matching text" do
+      it "can verify the content of a popup" do
+        prickly.click_by_name "popups"
+        prickly.popup_message_contains? "Hello"
+        prickly.dismiss_popup
+      end
+    end
+  end
+
+  context 'Screenshots', :javascript => true do
+
+    it 'can capture the screen' do
+      screenshot_name = Time.now.strftime("%Y%m%d-%H.%M.%s")
+      prickly.capture_screen screenshot_name
+      `ls #{Prickle::Capybara.image_dir}`.should include "#{screenshot_name}"
+    end
+
+    after do
+      `rm -f #{Prickle::Capybara.image_dir}/*.jpg`
+    end
+  end
+end

data/spec/element_spec.rb

@@ -0,0 +1,42 @@
+require 'spec_helper'
+
+describe Prickle::Capybara::Element do
+  let(:prickly) { Prickly.new }
+
+  before do
+    prickly.visit '/'
+  end
+
+  it 'can find an element' do
+    prickly.element(:name => 'blue').class.to_s.should == "Prickle::Capybara::Element"
+  end
+
+  it 'can match text in an element' do
+    prickly.element(:name => 'yellow').contains_text? "Hello!"
+  end
+
+  it 'can match text in specific elements' do
+    prickly.element(:li, :name => 'purple').contains_text? "Im not purple!"
+  end
+
+  it 'can match on link type elements' do
+    prickly.element(:link, :name => 'orangey').contains_text? "Me too!"
+  end
+
+  it 'can click specific element types by name' do
+    prickly.element(:paragraph, :name => 'yellow').click
+  end
+
+  it 'can find an element by type and identifier' do
+    prickly.element(:paragraph, :id => 'coffee').exists?
+  end
+
+  it 'can find and click on element by type and identifier' do
+    prickly.element(:link, :href => 'http://google.com').click
+  end
+
+  it 'can find an element by multiple identifiers' do
+    prickly.element(:name => 'orangey', :class => 'pink').contains_text? "Blue hippos"
+  end
+end
+

data/spec/extended_wait_spec.rb

@@ -5,11 +5,10 @@ describe Prickle::Capybara do
 
   before do
     Capybara.default_driver = :selenium
-    prickly.extend Prickle::Capybara
     prickly.visit '/'
   end
 
-  context 'Extended waits' do
+  context 'Extended waits', :javascript => true do
 
     before(:each) do
       Prickle::Capybara.wait_time = nil

data/spec/finders_spec.rb

@@ -4,8 +4,6 @@ describe Prickle::Capybara do
   let(:prickly) { Prickly.new }
 
   before do
-    Capybara.default_driver = :rack_test
-    prickly.extend Prickle::Capybara
     prickly.visit '/'
   end
 
@@ -58,38 +56,4 @@ describe Prickle::Capybara do
       prickly.paragraph_contains_text? "yellow", "Hello!"
     end
   end
-
-  context 'DSL' do
-    it 'can find an element' do
-      prickly.element(:name => 'blue').class.to_s.should == "Prickle::Capybara::Element"
-    end
-
-    it 'can match text in an element' do
-      prickly.element(:name => 'yellow').contains_text? "Hello!"
-    end
-
-    it 'can match text in specific elements' do
-      prickly.element(:li, :name => 'purple').contains_text? "Im not purple!"
-    end
-
-    it 'can match on link type elements' do
-      prickly.element(:link, :name => 'orangey').contains_text? "Me too!"
-    end
-
-    it 'can click specific element types by name' do
-      prickly.element(:paragraph, :name => 'yellow').click
-    end
-
-    it 'can find an element by type and identifier' do
-      prickly.element(:paragraph, :id => 'coffee').exists?
-    end
-
-    it 'can find and click on element by type and identifier' do
-      prickly.element(:link, :href => 'http://google.com').click
-    end
-
-    it 'can find an element by multiple identifiers' do
-      prickly.element(:name => 'orangey', :class => 'pink').contains_text? "Blue hippos"
-    end
-  end
 end

data/spec/spec_helper.rb

@@ -5,9 +5,11 @@ require 'prickle/capybara'
 
 class Prickly
   include Capybara::DSL
+  include Prickle::Capybara
 
 end
 
 require_relative 'stub/app'
 Capybara.app = Sinatra::Application
 Capybara.default_wait_time = 0
+Prickle::Capybara.image_dir = File.dirname(__FILE__) + "/tmp/"

data/spec/stub/index.html

@@ -19,6 +19,11 @@
     <p id='coffee'>Capuccino</p>
 
     <a href="http://google.com">google</a>
+
+    <button name="popups" onclick="alert('Hello');">erm</button>
+
+    <button name="confirm_box" onclick="if(!confirm('Click yes to continue'))alert('Aborting.');">erm</button>
+
     <script>
       $(document).ready(function() {
         $('.hidden').hide();

metadata

@@ -2,7 +2,7 @@
 name: prickle
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Despo Pentara
@@ -58,7 +58,7 @@ dependencies:
   type: :development
   version_requirements: *id004
 - !ruby/object:Gem::Dependency 
-  name: reek
+  name: rake
   prerelease: false
   requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
@@ -68,6 +68,17 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id006
 description: A simple DSL wrapped around Capybara for matching elements using html tags.
 email: despo@extractmethod.com
 executables: []
@@ -78,23 +89,26 @@ extra_rdoc_files: []
 
 files: 
 - .rvmrc
+- .travis.yml
 - Gemfile
 - Gemfile.lock
 - README.md
+- Rakefile
 - lib/prickle/capybara.rb
-- lib/prickle/capybara/click.rb
+- lib/prickle/capybara/actions.rb
 - lib/prickle/capybara/element.rb
 - lib/prickle/capybara/exceptions.rb
-- lib/prickle/capybara/find.rb
-- lib/prickle/capybara/match.rb
 - lib/prickle/version.rb
 - prickle.gemspec
 - prickle.png
+- spec/capybara_spec.rb
+- spec/element_spec.rb
 - spec/extended_wait_spec.rb
 - spec/finders_spec.rb
 - spec/spec_helper.rb
 - spec/stub/app.rb
 - spec/stub/index.html
+- spec/tmp/.keep_me
 has_rdoc: true
 homepage: https://github.com/ExtractMethod/prickle
 licenses: 

data/lib/prickle/capybara/click.rb

@@ -1,10 +0,0 @@
-module Prickle
-  module Actions
-    module Click
-
-      def click
-        find_element_by_identifier.click
-      end
-    end
-  end
-end

data/lib/prickle/capybara/find.rb

@@ -1,11 +0,0 @@
-module Prickle
-  module Actions
-    module Find
-
-      def exists?
-        find_element_by_identifier
-      end
-
-    end
-  end
-end

data/lib/prickle/capybara/match.rb

@@ -1,35 +0,0 @@
-module Prickle
-  module Actions
-    module Match
-
-      def contains_text? text
-        handle_exception do
-          find_element_by_identifier_and_text
-        end
-      end
-
-      private
-
-      def xpath_for_identifier
-        "//#{type_of(@type)}[#{identifier}]"
-      end
-
-      def xpath_for_identifier_and_text
-        "//#{type_of(@type)}[#{identifier} and contains(text(), '#{@text}')]"
-
-      end
-      def find_element_by_identifier
-        handle_exception do
-          find_element_by xpath_for_identifier
-        end
-      end
-
-      def find_element_by_identifier_and_text
-        handle_exception do
-          find_element_by xpath_for_identifier_and_text
-        end
-      end
-
-    end
-  end
-end