prickle 0.0.1

data/.rvmrc

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional.
+environment_id="ruby-1.9.2-p180@prickle"
+
+#
+# Uncomment following line if you want options to be set only for given project.
+#
+# PROJECT_JRUBY_OPTS=( --1.9 )
+
+#
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+#
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments" \
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+
+  if [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]]
+  then
+    . "${rvm_path:-$HOME/.rvm}/hooks/after_use"
+  fi
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  if ! rvm --create use  "$environment_id"
+  then
+    echo "Failed to create RVM environment '${environment_id}'."
+    exit 1
+  fi
+fi
+
+#
+# If you use an RVM gemset file to install a list of gems (*.gems), you can have
+# it be automatically loaded. Uncomment the following and adjust the filename if
+# necessary.
+#
+# filename=".gems"
+# if [[ -s "$filename" ]]
+# then
+#   rvm gemset import "$filename" | grep -v already | grep -v listed | grep -v complete | sed '/^$/d'
+# fi
+
+# If you use bundler, this might be useful to you:
+# if command -v bundle && [[ -s Gemfile ]]
+# then
+#   bundle install
+# fi
+
+

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,51 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    capybara (1.1.2)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (~> 2.0)
+      xpath (~> 0.1.4)
+    childprocess (0.3.1)
+      ffi (~> 1.0.6)
+    diff-lcs (1.1.3)
+    ffi (1.0.11)
+    mime-types (1.17.2)
+    multi_json (1.0.4)
+    nokogiri (1.5.0)
+    rack (1.4.1)
+    rack-protection (1.2.0)
+      rack
+    rack-test (0.6.1)
+      rack (>= 1.0)
+    rspec (2.8.0)
+      rspec-core (~> 2.8.0)
+      rspec-expectations (~> 2.8.0)
+      rspec-mocks (~> 2.8.0)
+    rspec-core (2.8.0)
+    rspec-expectations (2.8.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.8.0)
+    rubyzip (0.9.6.1)
+    selenium-webdriver (2.19.0)
+      childprocess (>= 0.2.5)
+      ffi (~> 1.0.9)
+      multi_json (~> 1.0.4)
+      rubyzip
+    sinatra (1.3.2)
+      rack (~> 1.3, >= 1.3.6)
+      rack-protection (~> 1.2)
+      tilt (~> 1.3, >= 1.3.3)
+    tilt (1.3.3)
+    xpath (0.1.4)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  rspec
+  sinatra

data/README.md

@@ -0,0 +1,70 @@
+![](http://github.com/despo/prickle/raw/master/prickle.png)
+
+## Configuration
+
+To install prickle execute
+
+```ruby
+gem install prickle
+```
+
+and to configure
+
+```ruby
+require 'prickle/capybara'
+
+World do
+    include Capybara::DSL
+    include Prickle::Capybara   #include it after Capybara
+end
+```
+
+## Usage
+
+### Find elements by any html tag(s)
+
+```ruby
+  element(:href => "http://google.com")
+  element(:name => "blue")
+  element(:id => "key")
+  element(:class => "key", :id => "button")
+```
+
+### Find elements by type and html tag(s)
+
+```ruby
+  element(:link,:href => "http://google.com")
+  element(:input, :name => "blue")
+``
+
+### Apply a search, a click or a text matcher
+
+``ruby
+
+element(:name => "flower")*.exists?*
+element(:name => "flower")*.click*
+element(:name => "flower")*.contains_text? "Roses"*
+```
+
+## Alternative syntax
+
+### Find
+
+```ruby
+  find_by_name "green"
+
+  find_button_by_name "green" #find_<element_tag>_by_name "<name>"
+```
+
+## Click
+
+```ruby
+  click_by_name "blue"
+  click_input_by_name "blue" #click_<element_tag>_by_name "<name>"
+``
+
+### Match text
+
+```ruby
+  div_contains_text? "text" #<element_tag>_contains_text? "text"
+```

data/lib/prickle/capybara/click.rb

@@ -0,0 +1,25 @@
+module Prickle
+  module Actions
+    module Click
+
+      def click_by_name name
+        find_by_name(name).click
+      end
+
+      def click
+        find_element_by_identifier(@type, @identifier).click
+      end
+
+      private
+
+      def method_missing method, *args
+        if method =~ /^click_(.*)_by_name$/
+          find_by_name($1, args.first).click
+        else
+          super
+        end
+      end
+
+    end
+  end
+end

data/lib/prickle/capybara/exceptions.rb

@@ -0,0 +1,16 @@
+module Prickle
+  module Capybara
+    class ElementNotFound < Exception
+
+      def initialize type, identifier, text, e
+        element_text = "Element"
+        element_text = "\e[1m#{type}\e[0m\e[31m" unless type == "*"
+        text_string = " and text \e[1m#{text}\e[0m\e[31m" unless text.nil?
+
+        raise "#{element_text} with properties \e[1m#{identifier.to_s}\e[0m\e[31m#{text_string} was not found.\nError: #{e.message}"
+      end
+
+    end
+
+  end
+end

data/lib/prickle/capybara/find.rb

@@ -0,0 +1,36 @@
+module Prickle
+  module Actions
+    module Find
+
+      def find_by_name type='*', name
+        find_element_by_identifier type, { :name => name }
+      end
+
+      def exists?
+        find_element_by_identifier @type, @identifier
+      end
+
+      private
+
+      def method_missing method, *args
+        if method =~ /^find_(.*)_by_name$/
+          find_by_name $1, args.first
+        else
+          super
+        end
+      end
+
+      def find_by_identifier_xpath element, identifier
+        "//#{type_of(element)}[#{xpath_for(identifier)}]"
+      end
+
+      def find_element_by_identifier element, identifier
+        @type = element; @identifier = identifier
+        handle_exception do
+          find_element_by(find_by_identifier_xpath(element, identifier ))
+        end
+      end
+
+    end
+  end
+end

data/lib/prickle/capybara/match.rb

@@ -0,0 +1,33 @@
+module Prickle
+  module Actions
+    module Match
+
+      def contains_text? text
+        handle_exception do
+          find_element_by_name_and_text(@type, @identifier, text)
+        end
+      end
+
+      def method_missing method, *args
+        if method =~ /(^.*)_contains_text\?$/
+          find_element_by_name_and_text($1,  { :name => args.first } , args[1])
+        else
+          super
+        end
+      end
+
+      private
+
+      def find_by_name_and_text_xpath element, identifier, text
+        "//#{type_of(element)}[#{xpath_for(identifier)} and contains(text(), '#{text}')]"
+      end
+
+      def find_element_by_name_and_text element, name, text
+        handle_exception do
+          find_element_by(find_by_name_and_text_xpath(element, name, text))
+        end
+      end
+
+    end
+  end
+end

data/lib/prickle/capybara.rb

@@ -0,0 +1,57 @@
+require_relative 'capybara/find'
+require_relative 'capybara/click'
+require_relative 'capybara/match'
+require_relative 'capybara/exceptions'
+
+module Prickle
+  TAGS = { :link => 'a',
+           :paragraph => 'p'
+  }
+
+  module Capybara
+
+    class << self
+      attr_accessor :wait_time
+
+    end
+
+    include Prickle::Actions::Find
+    include Prickle::Actions::Click
+    include Prickle::Actions::Match
+
+    def element type='*', identifier
+      @identifier = identifier
+      @type = type
+      self
+    end
+
+    private
+
+    def xpath_for identifier
+      return identifier.each_pair.to_a.map do |key, value|
+        "@#{key}='#{value}'"
+      end.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)
+    end
+
+    def type_of element
+      Prickle::TAGS[element.to_sym] || element
+    end
+
+    def handle_exception &block
+      begin
+        block.call
+      rescue Exception => e
+        raise Capybara::ElementNotFound.new(@type, @identifier, @text, e) if e.class.to_s == "Capybara::ElementNotFound"
+        raise
+      end
+    end
+  end
+end

data/spec/extended_wait_spec.rb

@@ -0,0 +1,49 @@
+require 'spec_helper'
+
+describe Prickle::Capybara do
+  let(:prickly) { Prickly.new }
+
+  before do
+    prickly.extend Prickle::Capybara
+    prickly.visit '/'
+  end
+
+  context 'Extended waits' do
+
+    before(:each) do
+      Prickle::Capybara.wait_time = nil
+      prickly.visit '/'
+    end
+
+    context "matching text" do
+      it 'can wait for an element to appear' do
+        Prickle::Capybara.wait_time = 4
+        prickly.element(:name => 'lagged').contains_text? "I lag"
+      end
+
+      it "can fail if an element doesn't appear after the default wait time" do
+        Prickle::Capybara.wait_time = 2
+        expect { prickly.element(:name => 'lagged').contains_text? "I lag" }.to raise_error Capybara::TimeoutError
+      end
+    end
+
+    context "finding elements" do
+      it 'can wait for an element to appear' do
+        Prickle::Capybara.wait_time = 4
+        prickly.find_by_name('lagged')
+      end
+    end
+
+    context "clicking elements" do
+      it 'fails to click an element that has not appeared yet' do
+        Prickle::Capybara.wait_time = 1
+        expect { prickly.click_by_name('lagged') }.to raise_error Capybara::TimeoutError
+      end
+
+      it 'can click an element after it appears' do
+        Prickle::Capybara.wait_time = 4
+        prickly.click_by_name('lagged')
+      end
+    end
+  end
+end

data/spec/finders_spec.rb

@@ -0,0 +1,94 @@
+require 'spec_helper'
+
+describe Prickle::Capybara do
+  let(:prickly) { Prickly.new }
+
+  before do
+    prickly.extend Prickle::Capybara
+    prickly.visit '/'
+  end
+
+  context 'finding elements' do
+    it 'can find any element by name' do
+      prickly.find_by_name 'red'
+    end
+
+    context 'can find by element type and name' do
+      it 'can find a blue input type element' do
+        prickly.find_input_by_name 'blue'
+      end
+
+      it 'can find a pink button' do
+        prickly.find_button_by_name 'pink'
+      end
+
+      it "but it cannot find a pink link because it's not on the page" do
+        expect { prickly.find_a_by_name('pink') }.to raise_error
+      end
+    end
+
+    it 'can find a link' do
+      prickly.find_link_by_name 'red-dots'
+    end
+  end
+
+  context 'clicking on elements' do
+    it 'can click any element by name' do
+      prickly.click_by_name 'blue'
+    end
+
+    it 'can click any element by name and type' do
+      prickly.element(:input, :name => 'blue').click
+    end
+
+    context 'can click by element type and name' do
+      it 'can find a blue input type element' do
+        prickly.click_input_by_name 'blue'
+      end
+
+      it "but it cannot find a blue link because it's not on the page" do
+        expect { prickly.click_link_by_name 'blue' }.to raise_error
+      end
+    end
+  end
+
+  context 'matching text' do
+    it 'can find text in a paragraph' do
+      prickly.paragraph_contains_text? "yellow", "Hello!"
+    end
+  end
+
+  context 'DSL' do
+    it 'can find an element' do
+      prickly.element(:name => 'blue').should == prickly
+    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

@@ -0,0 +1,16 @@
+require File.join(File.dirname(__FILE__), "..", "lib", "prickle", "capybara")
+
+require 'rspec'
+require 'capybara'
+require 'capybara/dsl'
+require 'prickle/capybara'
+
+class Prickly
+  include Capybara::DSL
+
+end
+
+require_relative 'stub/app'
+Capybara.app = Sinatra::Application
+Capybara.default_driver = :selenium
+Capybara.default_wait_time = 0

data/spec/stub/app.rb

@@ -0,0 +1,5 @@
+require 'sinatra'
+
+get '/' do
+  File.read(File.join(File.dirname(__FILE__), 'index.html'))
+end

data/spec/stub/index.html

@@ -0,0 +1,34 @@
+<html>
+  <head>
+    <script type="text/javascript" src="http://ajax.googleapis.com/ajax/libs/jquery/1.7.1/jquery.min.js"></script>
+  </head>
+  <body>
+    <input name="red" type="button" />
+    <input name="blue" type="button" />
+
+    <button name="pink"></button>
+    <a name="red-dots"></button>
+    <p name="yellow">Hello!</p>
+
+    <li name="purple">Im not purple!</li>
+    <a name="orangey">Me too!!</a>
+
+    <div name='lagged' class='hidden'> I lag</div>
+    <div name='orangey'  class='pink'> Blue hippos</div>
+
+    <p id='coffee'>Capuccino</p>
+
+    <a href="http://google.com">google</a>
+    <script>
+      $(document).ready(function() {
+        $('.hidden').hide();
+        setTimeout(showHidden, 3000);
+      });
+
+      function showHidden() {
+        $('.hidden').show();
+      }
+
+    </script>
+  </body>
+</html>

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification 
+name: prickle
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- Despo Pentara
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-10 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: capybara
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 2.8.0
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.3.2
+  type: :development
+  version_requirements: *id004
+description: A simple DSL wrapped around Capybara for matching elements using html tags.
+email: despo@extractmethod.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .rvmrc
+- Gemfile
+- Gemfile.lock
+- README.md
+- lib/prickle/capybara.rb
+- lib/prickle/capybara/click.rb
+- lib/prickle/capybara/exceptions.rb
+- lib/prickle/capybara/find.rb
+- lib/prickle/capybara/match.rb
+- prickle.png
+- spec/extended_wait_spec.rb
+- spec/finders_spec.rb
+- spec/spec_helper.rb
+- spec/stub/app.rb
+- spec/stub/index.html
+has_rdoc: true
+homepage: https://github.com/ExtractMethod/prickle
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: A simple DSL wrapped around Capybara for matching elements using html tags.
+test_files: []
+