prickle 0.0.1 → 0.0.2

data/Gemfile.lock

@@ -1,3 +1,9 @@
+PATH
+  remote: .
+  specs:
+    prickle (0.0.1)
+      capybara
+
 GEM
   remote: http://rubygems.org/
   specs:
@@ -20,6 +26,10 @@ GEM
       rack
     rack-test (0.6.1)
       rack (>= 1.0)
+    reek (1.2.8)
+      ruby2ruby (~> 1.2)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
     rspec (2.8.0)
       rspec-core (~> 2.8.0)
       rspec-expectations (~> 2.8.0)
@@ -28,12 +38,18 @@ GEM
     rspec-expectations (2.8.0)
       diff-lcs (~> 1.1.2)
     rspec-mocks (2.8.0)
+    ruby2ruby (1.3.1)
+      ruby_parser (~> 2.0)
+      sexp_processor (~> 3.0)
+    ruby_parser (2.3.1)
+      sexp_processor (~> 3.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
+    sexp_processor (3.0.10)
     sinatra (1.3.2)
       rack (~> 1.3, >= 1.3.6)
       rack-protection (~> 1.2)
@@ -47,5 +63,7 @@ PLATFORMS
 
 DEPENDENCIES
   capybara
-  rspec
-  sinatra
+  prickle!
+  reek
+  rspec (~> 2.8.0)
+  sinatra (~> 1.3.2)

data/README.md

@@ -8,42 +8,53 @@ To install prickle execute
 gem install prickle
 ```
 
-and to configure
+and to configure update your *features/support/env.rb* to include the following:
 
 ```ruby
-require 'prickle/capybara'
+require 'prickle/capybara'    # require
+
 
 World do
-    include Capybara::DSL
-    include Prickle::Capybara   #include it after Capybara
+   include Capybara::DSL
+   include Prickle::Capybara  # include  Prickle
 end
 ```
 
+## Waiting for elements to become visible
+
+To enable this feature you need to set the *Prickle::Capybara.wait_time* property.
+
+```ruby
+Prickle::Capybara.wait_time = 5
+```
+
+If you only want to extend the wait time for a particular feature, then you need to reset the wait time using *Prickle::Capybara = nil*.
+
 ## 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")
+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")
-``
+element(:link, :href => "http://google.com")    # you can also use link and paragraph (instead of a and p)
+element(:input, :name => "blue")
+```
 
 ### Apply a search, a click or a text matcher
 
-``ruby
+```ruby
 
-element(:name => "flower")*.exists?*
-element(:name => "flower")*.click*
-element(:name => "flower")*.contains_text? "Roses"*
+element(:name => "flower").exists?
+element(:name => "flower").click
+element(:name => "flower").contains_text? "Roses"
 ```
 
 ## Alternative syntax
@@ -51,20 +62,19 @@ element(:name => "flower")*.contains_text? "Roses"*
 ### Find
 
 ```ruby
-  find_by_name "green"
-
-  find_button_by_name "green" #find_<element_tag>_by_name "<name>"
+find_by_name "green"
+find_button_by_name "green" #find_<element_tag>_by_name "<name>"
 ```
 
-## Click
+### Click
 
 ```ruby
-  click_by_name "blue"
-  click_input_by_name "blue" #click_<element_tag>_by_name "<name>"
-``
+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"
+div_contains_text? "text" #<element_tag>_contains_text? "text"
 ```

data/lib/prickle/capybara.rb

@@ -1,11 +1,8 @@
-require_relative 'capybara/find'
-require_relative 'capybara/click'
-require_relative 'capybara/match'
-require_relative 'capybara/exceptions'
+require_relative 'capybara/element'
 
 module Prickle
   TAGS = { :link => 'a',
-           :paragraph => 'p'
+    :paragraph => 'p'
   }
 
   module Capybara
@@ -15,43 +12,31 @@ module Prickle
 
     end
 
-    include Prickle::Actions::Find
-    include Prickle::Actions::Click
-    include Prickle::Actions::Match
-
     def element type='*', identifier
-      @identifier = identifier
-      @type = type
-      self
+      Element.new type, identifier
     end
 
-    private
-
-    def xpath_for identifier
-      return identifier.each_pair.to_a.map do |key, value|
-        "@#{key}='#{value}'"
-      end.join ' and '
+    def find_by_name type='*', name
+      element(type, :name => name).exists?
     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 click_by_name name
+      find_by_name(name).click
     end
 
-    def type_of element
-      Prickle::TAGS[element.to_sym] || element
-    end
+    private
 
-    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
+    def method_missing method, *args
+      if method =~ /(^.*)_contains_text\?$/
+        element($1, :name => args.first).contains_text? args[1]
+      elsif method =~ /^click_(.*)_by_name$/
+        element($1, :name => args.first).click
+      elsif method =~ /^find_(.*)_by_name$/
+        element($1, :name => args.first).exists?
+      else
+        super
       end
     end
+
   end
 end

data/lib/prickle/capybara/click.rb

@@ -2,24 +2,9 @@ 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
+        find_element_by_identifier.click
       end
-
     end
   end
 end

data/lib/prickle/capybara/element.rb

@@ -0,0 +1,53 @@
+require_relative 'find'
+require_relative 'click'
+require_relative 'match'
+require_relative 'exceptions'
+
+module Prickle
+  module Capybara
+    class Element
+
+      require 'capybara/dsl'
+      include ::Capybara::DSL
+
+      def initialize type="*", identifier
+        @identifier = identifier
+        @type = type
+        self
+      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"
+          raise
+        end
+      end
+
+      def 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
+
+      include Prickle::Actions::Find
+      include Prickle::Actions::Match
+      include Prickle::Actions::Click
+
+    end
+
+  end
+end

data/lib/prickle/capybara/exceptions.rb

@@ -1,16 +1,39 @@
 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?
+    class ElementNotFound < Exception; end;
 
-        raise "#{element_text} with properties \e[1m#{identifier.to_s}\e[0m\e[31m#{text_string} was not found.\nError: #{e.message}"
+    class Error
+
+      def initialize type, identifier, text, caught_exception
+        @element_type = type
+        @element_identifier = identifier
+        @element_text = text
+        @caught_exception = caught_exception
       end
 
-    end
+      def message
+        "#{element_text} with properties #{identifier} #{text_string} was not found.\n\tError: #{@caught_exception.message}"
+      end
+
+      private
+
+      def element_text
+        return highlight(@element_type) unless @element_type == "*"
+        "Element"
+      end
 
+      def text_string
+        " and text #{highlight(@element_text)}" unless @element_text.nil?
+      end
+
+      def identifier
+        highlight(@element_identifier.to_s)
+      end
+
+      def highlight text
+        "\e[1m#{text}\e[0m\e[31m"
+      end
+    end
   end
 end

data/lib/prickle/capybara/find.rb

@@ -2,33 +2,8 @@ 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
+        find_element_by_identifier
       end
 
     end

data/lib/prickle/capybara/match.rb

@@ -4,27 +4,29 @@ module Prickle
 
       def contains_text? text
         handle_exception do
-          find_element_by_name_and_text(@type, @identifier, text)
+          find_element_by_identifier_and_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
+      private
+
+      def xpath_for_identifier
+        "//#{type_of(@type)}[#{identifier}]"
       end
 
-      private
+      def xpath_for_identifier_and_text
+        "//#{type_of(@type)}[#{identifier} and contains(text(), '#{@text}')]"
 
-      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_identifier
+        handle_exception do
+          find_element_by xpath_for_identifier
+        end
       end
 
-      def find_element_by_name_and_text element, name, text
+      def find_element_by_identifier_and_text
         handle_exception do
-          find_element_by(find_by_name_and_text_xpath(element, name, text))
+          find_element_by xpath_for_identifier_and_text
         end
       end
 

data/lib/prickle/version.rb

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

data/prickle.gemspec

@@ -0,0 +1,29 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "prickle/version"
+
+Gem::Specification.new do |s|
+  s.name        = "prickle"
+  s.version     = Prickle::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.author      = "Despo Pentara"
+  s.email       = "despo@extractmethod.com"
+  s.homepage    = "https://github.com/ExtractMethod/prickle"
+  s.summary     = "A simple DSL wrapped around Capybara for matching elements using html tags."
+  s.description = "A simple DSL wrapped around Capybara for matching elements using html tags."
+  s.required_ruby_version = '>= 1.9.2'
+
+  s.licenses = ["MIT"]
+
+  s.files              = `git ls-files`.split("\n")
+  s.test_files         = `git ls-files -- {spec}/*`.split("\n")
+  s.executables        = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths      = ["lib"]
+
+  s.add_dependency "capybara"
+
+  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 "reek"
+end
+

data/spec/extended_wait_spec.rb

@@ -4,6 +4,7 @@ describe Prickle::Capybara do
   let(:prickly) { Prickly.new }
 
   before do
+    Capybara.default_driver = :selenium
     prickly.extend Prickle::Capybara
     prickly.visit '/'
   end

data/spec/finders_spec.rb

@@ -4,6 +4,7 @@ describe Prickle::Capybara do
   let(:prickly) { Prickly.new }
 
   before do
+    Capybara.default_driver = :rack_test
     prickly.extend Prickle::Capybara
     prickly.visit '/'
   end
@@ -60,7 +61,7 @@ describe Prickle::Capybara do
 
   context 'DSL' do
     it 'can find an element' do
-      prickly.element(:name => 'blue').should == prickly
+      prickly.element(:name => 'blue').class.to_s.should == "Prickle::Capybara::Element"
     end
 
     it 'can match text in an element' do

data/spec/spec_helper.rb

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

metadata

@@ -2,7 +2,7 @@
 name: prickle
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - Despo Pentara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-10 00:00:00 +00:00
+date: 2012-02-11 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -57,6 +57,17 @@ dependencies:
         version: 1.3.2
   type: :development
   version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: reek
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+  type: :development
+  version_requirements: *id005
 description: A simple DSL wrapped around Capybara for matching elements using html tags.
 email: despo@extractmethod.com
 executables: []
@@ -72,9 +83,12 @@ files:
 - README.md
 - lib/prickle/capybara.rb
 - lib/prickle/capybara/click.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/extended_wait_spec.rb
 - spec/finders_spec.rb