prickle 0.0.3 → 0.0.4

data/.gitignore

@@ -0,0 +1,3 @@
+Gemfile.lock
+*.gem
+

data/.rspec

@@ -0,0 +1 @@
+-cfd

data/README.md

@@ -45,6 +45,12 @@ element(:id => "key")
 element(:class => "key", :id => "button")
 ```
 
+You can also find elements by a value contained in the identifier
+
+```ruby
+element(:name.like => "blue") # will match <button name="blue_12345">
+```
+
 ### Find elements by type and html tag(s)
 
 ```ruby

data/lib/prickle/capybara/element.rb

@@ -1,6 +1,5 @@
 require 'capybara/dsl'
 require_relative 'actions'
-require_relative 'exceptions'
 
 module Prickle
   module Capybara
@@ -21,11 +20,35 @@ module Prickle
         self
       end
 
+      def identifier
+        @identifier.each_pair.inject([]) do |xpath_str, (key, value)|
+          xpath_str << convert_to_xpath(key, value)
+        end.join " and "
+      end
+
+      def convert_to_xpath key, value
+        if key.to_s.include? "<value>"
+          key.sub "<value>", value
+        else
+          "@#{key}='#{value}'"
+        end
+      end
+
+      def type
+        CONVERTED_TYPES[@type.to_sym] || @type
+      end
+
       def find_element
-        handle_exception { find_element_by xpath }
+        handle_exception { find_element_by_xpath }
       end
 
-      def find_element_by xpath
+      def xpath
+        xpath = "//#{type}[#{identifier}"
+        xpath << " and contains(text(), '#{@text}')" if @text
+        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?
@@ -37,24 +60,13 @@ module Prickle
         begin
           block.call
         rescue Exception => e
-          error_message = Error.new(@type, @identifier, @text, e).message
-          raise ElementNotFound, error_message if e.class.to_s == "Capybara::ElementNotFound"
+          raise element_not_found(e) if e.class == ::Capybara::ElementNotFound
           raise
         end
       end
 
-      def identifier
-        return @identifier.each_pair.to_a.map { |k, v| "@#{k}='#{v}'" }.join " and "
-      end
-
-      def type
-        CONVERTED_TYPES[@type.to_sym] || @type
-      end
-
-      def xpath
-        xpath = "//#{type}[#{identifier}"
-        xpath << " and contains(text(), '#{@text}')" if @text
-        xpath << "]"
+      def element_not_found caught_exception
+        Exceptions::ElementNotFound.new(@type, identifier, @text, caught_exception)
       end
 
       public

data/lib/prickle/capybara.rb

@@ -1,4 +1,6 @@
 require_relative 'capybara/element'
+require_relative 'exceptions'
+require_relative 'core_ext/symbol'
 
 module Prickle
   module Capybara
@@ -8,7 +10,7 @@ module Prickle
 
     end
 
-    def capture_screen name=Time.now.strftime("%Y%m%d-%H.%M.%s")
+    def capture_screen name=screenshot_name
       page.driver.browser.save_screenshot Capybara.image_dir + name + ".jpg"
     end
 
@@ -37,11 +39,13 @@ module Prickle
     end
 
     def popup_message_contains? message
-      raise Capybara::MessageNotContainedInPopup, Error.new.not_contained_in_popup(message) unless popup_message.eql? message
+      raise Exceptions::MessageNotContainedInPopup.new(message) unless popup_message.eql? message
     end
 
     private
 
+    TIME_FORMATTER = "%Y%m%d-%H.%M.%s"
+
     def method_missing method, *args
       if method =~ /(^.*)_contains_text\?$/
         element($1, :name => args.first).contains_text? args[1]
@@ -54,5 +58,10 @@ module Prickle
       end
     end
 
+    def screenshot_name
+      Time.now.strftime(TIME_FORMATTER)
+    end
+
   end
+
 end

data/lib/prickle/core_ext/symbol.rb

@@ -0,0 +1,6 @@
+class Symbol
+
+  def like
+    "contains(@#{self.to_s}, '<value>')"
+  end
+end

data/lib/prickle/exceptions/messages.rb

@@ -0,0 +1,55 @@
+module Prickle
+  module Exceptions
+    module Message
+
+      private
+      def highlight text
+        "\e[1m#{text}\e[0m\e[31m"
+      end
+
+      class ElementNotFound
+        include Message
+
+        def initialize type=nil, identifier=nil, text=nil, caught_exception=nil
+          @element_type = type
+          @element_identifier = identifier
+          @element_text = text
+          @caught_exception = caught_exception
+        end
+
+        def to_s
+          "#{element_text} with identifier #{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
+      end
+
+      class TextNotContainedInPopup
+        include Message
+
+        def initialize message
+          @message = message
+        end
+
+        def to_s
+          "Text #{highlight(@message)} is not contained in the popup."
+        end
+      end
+
+    end
+
+  end
+end

data/lib/prickle/exceptions.rb

@@ -0,0 +1,26 @@
+require_relative 'exceptions/messages'
+
+module Prickle
+  module Exceptions
+
+    def message
+      @message
+    end
+
+    class ElementNotFound < Exception
+      include Prickle::Exceptions
+
+      def initialize(type, identifier, text, caught_exception)
+        @message = Message::ElementNotFound.new(type, identifier, text, caught_exception).to_s
+      end
+    end
+
+    class MessageNotContainedInPopup < Exception
+      include Prickle::Exceptions
+
+      def initialize message
+        @message = Message::TextNotContainedInPopup.new(message).to_s
+      end
+    end
+  end
+end

data/lib/prickle/version.rb

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

data/prickle.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |s|
   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.summary     = "A simple DSL extending Capybara."
+  s.description = "A simple DSL extending Capybara."
   s.required_ruby_version = '>= 1.9.2'
 
   s.licenses = ["MIT"]

data/spec/element_spec.rb

@@ -11,6 +11,14 @@ describe Prickle::Capybara::Element do
     prickly.element(:name => 'blue').class.to_s.should == "Prickle::Capybara::Element"
   end
 
+  it 'can find an element by a string contained in its identifier' do
+    prickly.element(:name.like => 'purpli').contains_text? "erm"
+  end
+
+  it 'can find an element by a contained and an exact match in its identifier' do
+    prickly.element(:name.like => 'purpli', :id => 'one').contains_text? "erm"
+  end
+
   it 'can match text in an element' do
     prickly.element(:name => 'yellow').contains_text? "Hello!"
   end

data/spec/extended_wait_spec.rb

@@ -22,7 +22,7 @@ describe Prickle::Capybara do
       end
 
       it "can fail if an element doesn't appear after the default wait time" do
-        Prickle::Capybara.wait_time = 2
+        Prickle::Capybara.wait_time = 1
         expect { prickly.element(:name => 'lagged').contains_text? "I lag" }.to raise_error Capybara::TimeoutError
       end
     end

data/spec/stub/index.html

@@ -23,6 +23,7 @@
     <button name="popups" onclick="alert('Hello');">erm</button>
 
     <button name="confirm_box" onclick="if(!confirm('Click yes to continue'))alert('Aborting.');">erm</button>
+    <button name="purplish" id="one"  >erm</button>
 
     <script>
       $(document).ready(function() {

metadata

@@ -2,7 +2,7 @@
 name: prickle
 version: !ruby/object:Gem::Version 
   prerelease: 
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors: 
 - Despo Pentara
@@ -10,7 +10,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-11 00:00:00 +00:00
+date: 2012-02-12 00:00:00 +00:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,7 @@ dependencies:
         version: "0"
   type: :development
   version_requirements: *id006
-description: A simple DSL wrapped around Capybara for matching elements using html tags.
+description: A simple DSL extending Capybara.
 email: despo@extractmethod.com
 executables: []
 
@@ -88,16 +88,19 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- .gitignore
+- .rspec
 - .rvmrc
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - lib/prickle/capybara.rb
 - lib/prickle/capybara/actions.rb
 - lib/prickle/capybara/element.rb
-- lib/prickle/capybara/exceptions.rb
+- lib/prickle/core_ext/symbol.rb
+- lib/prickle/exceptions.rb
+- lib/prickle/exceptions/messages.rb
 - lib/prickle/version.rb
 - prickle.gemspec
 - prickle.png
@@ -136,6 +139,6 @@ 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.
+summary: A simple DSL extending Capybara.
 test_files: []
 

data/Gemfile.lock

@@ -1,71 +0,0 @@
-PATH
-  remote: .
-  specs:
-    prickle (0.0.2)
-      capybara
-
-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)
-    rake (0.9.2)
-    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)
-      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)
-    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)
-      tilt (~> 1.3, >= 1.3.3)
-    tilt (1.3.3)
-    xpath (0.1.4)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  capybara
-  prickle!
-  rake
-  reek
-  rspec (~> 2.8.0)
-  sinatra (~> 1.3.2)

data/lib/prickle/capybara/exceptions.rb

@@ -1,46 +0,0 @@
-module Prickle
-  module Capybara
-
-    class ElementNotFound < Exception; end;
-
-    class MessageNotContainedInPopup < Exception; end;
-
-    class Error
-
-      def initialize type=nil, identifier=nil, text=nil, caught_exception=nil
-        @element_type = type
-        @element_identifier = identifier
-        @element_text = text
-        @caught_exception = caught_exception
-      end
-
-      def message
-        "#{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
-        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