swamp 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 15fa292671e998ec2b364b1893e815773df39785
-  data.tar.gz: 85175279ded0c63c318c152877a99e03003b9e4e
+  metadata.gz: 96cb6453a9c92ac8aa2bf96f8f76acd975d49c20
+  data.tar.gz: fb312b21770bfe568ed1d856295bd0510a9a301f
 SHA512:
-  metadata.gz: 53afdc9793bbf5148ee8d9da1774e59c202747d1bb8a3dc9079a12d5393d88ebcf3a6af54f1661c2f9275c1f055391ec5058e3180bf263a32c63c9e5d4aed4fa
-  data.tar.gz: 7e18435b353cbb5b647ea1f0c19653eca2e432ea94cc3819f7c22010ffb7db0ba7983fa47aa461db4289c42383ba61fafcc08623fec20610ad697b8cca48cda4
+  metadata.gz: 124b7ddfc62b2b40d89b3f32084a4ea8bf74c8847cd6d553eaad4436218ca7c5c98baab4087fe0b51856ac3d1b7a08de2af73728d993c091e7301f86758188ff
+  data.tar.gz: b23f650148dc0ea3778641aeb9393a221670979995675af3f854212b5e95e6336069b5d9cdf4fc166eb3f09b74ae3bcbfd03b9ba2e3fd4e16e9d75234214b6ac

data/README.md

@@ -108,3 +108,29 @@ When /^I attempt to sign in with valid credentials/ do
 end
 ```
 
+### Dynamically detecting elements
+
+* You can navigate in the browser that swamp opens 
+* Lets say you need to log in to have access to some page 
+* Just enter the url for this page
+* Do the login procedure in the oppened browser manually
+* Wait for the new page to load
+* Then just go to the terminal and hit ENTER
+* Swamp will detect the new elements (if any) and will generate the code snippets the same way as before
+
+## How it works?
+
+It uses capybara to fireup the browser and visit the target URL then it looks for patterns like:
+
+* Buttons
+* Fields
+* Select boxes
+* Input buttons
+* Links
+
+For each pattern found it verifies if the element is visible, has some key attributes like `id`, `name`, `text` and etc. 
+There is some logic to decide on how to best create the method's name and the capybara's selector. 
+Finally the code snippets are formatted and printed in the output.
+
+Check the `.feature` files to learn about the overall behavior.
+Check the `_spec.rb` files to learn about the internal behavior. Feel free to contribute.

data/features/specifications/user_scans_buttons_in_a_page.feature

@@ -10,7 +10,8 @@ Feature: user scans buttons in a page
   Scenario: A button that has text
     Given I enter the url for this page: "button.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "button"
+    And it should output the following code snippet
       """
       def sign_up
         source.click_button("Sign Up")
@@ -20,7 +21,8 @@ Feature: user scans buttons in a page
   Scenario: A button that doesn't has text but has id
     Given I enter the url for this page: "button_without_text.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "#search-button"
+    And it should output the following code snippet
       """
       def search_button
         source.click_button("search-button")
@@ -30,7 +32,8 @@ Feature: user scans buttons in a page
   Scenario: A button that doesn't has either text or id but has the value attribute
     Given I enter the url for this page: "button_without_text_without_id_with_value.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "button[value='buy-now']"
+    And it should output the following code snippet
       """
       def buy_now
         source.click_button("buy-now")

data/features/specifications/user_scans_fields_in_a_page.feature

@@ -10,7 +10,8 @@ Feature: user scans fields in a page
   Scenario: An input that has id, name and whose the type is text
     Given I enter the url for this page: "field.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "#id_username"
+    And it should output the following code snippet
       """
       def type_username(input)
         source.fill_in("id_username", with: input)
@@ -20,7 +21,8 @@ Feature: user scans fields in a page
   Scenario: An input that has no name, has id and whose the type is text
     Given I enter the url for this page: "field_without_name.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "#username"
+    Then it should output the following code snippet
       """
       def type_username(input)
         source.fill_in("username", with: input)
@@ -30,7 +32,8 @@ Feature: user scans fields in a page
   Scenario: An input without the id attribute that has name and the type is text
     Given I enter the url for this page: "field_without_id.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "input[name='username']"
+    Then it should output the following code snippet
       """
       def type_username(input)
         source.fill_in("username", with: input)

data/features/specifications/user_scans_input_buttons_in_a_page.feature

@@ -10,7 +10,8 @@ Feature: user scans submits in a page
   Scenario: A submit that has value and id
     Given I enter the url for this page: "input_submit.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "#u_0_b"
+    And it should output the following code snippet
       """
       def log_in
         source.find(:css, "#u_0_b").click
@@ -20,7 +21,8 @@ Feature: user scans submits in a page
   Scenario: A submit that has no id
     Given I enter the url for this page: "input_submit_without_id.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "input.button.g-button.g-button-submit[value='Continue']"
+    And it should output the following code snippet
       """
       def continue
         source.find(:css, "input.button.g-button.g-button-submit[value='Continue']").click

data/features/specifications/user_scans_links_in_a_page.feature

@@ -10,7 +10,8 @@ Feature: user scans links in a page
   Scenario: A link that has id
     Given I enter the url for this page: "link_with_id.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this link: "#link-forgot-passwd"
+    And it should output the following code snippet
       """
       def link_forgot_passwd
         source.click_link("link-forgot-passwd")

data/features/specifications/user_scans_select_box_elements_in_a_page.feature

@@ -10,7 +10,8 @@ Feature: user scans select box elements in a page
   Scenario: A select box that has id
     Given I enter the url for this page: "select_box_with_id.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "#month"
+    And it should output the following code snippet
       """
       def select_month(option)
         source.select(option, :from => "month")
@@ -20,7 +21,8 @@ Feature: user scans select box elements in a page
   Scenario: A select box that has name only
     Given I enter the url for this page: "select_box_with_name_only.html"
     When swamp scans that page
-    Then swamp should output the following code snippet
+    Then swamp should highlight this element: "select[name='Region']"
+    And it should output the following code snippet
       """
       def select_region(option)
         source.select(option, :from => "Region")

data/features/step_definitions/swamp_steps.rb

@@ -18,7 +18,7 @@ When /^swamp scans that page$/ do
   swamp.scan(@url)
 end
 
-Then /^swamp should output the following code snippets?$/ do |string|
+Then /^(?:swamp|it) should output the following code snippets?$/ do |string|
   output.messages.should include(string)
 end
 
@@ -47,3 +47,14 @@ Then /^swamp should scan the current page$/ do
   output.messages[3].should == "Scanning, please wait..."
   output.messages[4].should == "def sign_up\n  source.click_button(\"Sign Up\")\nend"
 end
+
+Then /^swamp should highlight this (element|link): "(.+)"$/ do |mode, selector|
+  page = Capybara.current_session
+  page.should have_css "#{selector}[style]"
+  if mode == "element"
+    page.find(selector)[:style].should include("border-width: 3px")
+    page.find(selector)[:style].should include("border-color: rgb(255, 0, 0)")
+  else
+    page.find(selector)[:style].should include("background-color: rgb(255, 0, 0)")
+  end
+end

data/lib/swamp/buttons.rb

@@ -5,10 +5,13 @@ module Swamp
       page.all("button").map do |element|
         if element.visible?
           if has_valid_text?(element)
+            shine %-//button[text()='#{element.text}']-, :xpath
             elements << Swamp::Button.new(element.text, element.text)
           elsif has_id?(element) and has_valid_id?(element)
+            shine %-##{element["id"]}-
             elements << Swamp::Button.new(element["id"], element["id"])
           elsif has_value?(element) and has_valid_value?(element)
+            shine %-button[value='#{element["value"]}']-
             elements << Swamp::Button.new(element["value"], element["value"])
           end
         end

data/lib/swamp/elements.rb

@@ -1,5 +1,10 @@
 module Swamp
   class Elements < Base
+
+    BORDER_SIZE = "3px"
+    BORDER_COLOR = "#ff0000"
+    BACKGROUND_COLOR = "#ff0000"
+
     def has_id?(element)
       element['id'] != nil and element['id'] != "" ? true : false
     end
@@ -35,5 +40,40 @@ module Swamp
     def formatter
       @formatter ||= Swamp::Formatter.new
     end
+
+    def shine(selector, mode = :css)
+      set_border_size(selector, BORDER_SIZE, mode)
+      set_border_color(selector, BORDER_COLOR, mode)
+    end
+
+    def shine_link(selector)
+      set_background_color selector, BACKGROUND_COLOR
+    end
+
+    private
+
+    def set_border_size(selector, size, mode)
+      if mode == :css
+        page.execute_script %-document.querySelector("#{selector}").style.borderWidth='#{size}'-
+      elsif mode == :xpath
+        page.execute_script %-document.evaluate("#{selector}", document, null, 9, null).singleNodeValue.style.borderWidth='#{size}';- rescue false
+      else
+        raise "Mode #{mode} not found"
+      end
+    end
+
+    def set_border_color(selector, color, mode = :css)
+      if mode == :css
+        page.execute_script %-document.querySelector("#{selector}").style.borderColor='#{color}'-
+      elsif mode == :xpath
+        page.execute_script %-document.evaluate("#{selector}", document, null, 9, null).singleNodeValue.style.borderColor='#{color}';- rescue false
+      else
+        raise "Mode #{mode} not found"
+      end
+    end
+
+    def set_background_color(selector, color)
+      page.execute_script %-document.querySelector("#{selector}").style.backgroundColor='#{color}'-
+    end
   end
 end

data/lib/swamp/fields.rb

@@ -5,10 +5,13 @@ module Swamp
       page.all('input').map do |element|
         if element.visible? and valid_type?(element)
           if has_id?(element) and has_name?(element)
+            shine %-##{element['id']}-
             elements << Swamp::Field.new(element['name'], element['id'])
           elsif has_id?(element)
+            shine %-##{element['id']}-
             elements << Swamp::Field.new(element['id'], element['id'])
           elsif has_name?(element)
+            shine %-input[name=#{element['name']}]-
             elements << Swamp::Field.new(element['name'], element['name'])
           end
         end

data/lib/swamp/input_buttons.rb

@@ -6,8 +6,10 @@ module Swamp
         if element.visible?
           if has_value?(element)
             if has_id?(element)
+              shine %-##{element["id"]}-
               elements << Swamp::InputButton.new(element["value"], "##{element["id"]}")
             elsif has_class?(element)
+              shine %-input.#{formatter.format_class(element["class"])}[value='#{element["value"]}']-
               elements << Swamp::InputButton.new(element["value"], "input.#{formatter.format_class(element["class"])}[value='#{element["value"]}']")
             end
           end

data/lib/swamp/links.rb

@@ -2,11 +2,10 @@ module Swamp
   class Links < Elements
     def get
       elements = []
-      page.all('a[href]').map do | element |
+      page.all('a[href][id]').map do | element |
         if element.visible?
-          if has_id?(element)
-            elements << Swamp::Link.new(element["id"], element["id"])
-          end
+          shine_link %-##{element["id"]}-
+          elements << Swamp::Link.new(element["id"], element["id"])
         end
       end
       elements

data/lib/swamp/select_boxes.rb

@@ -5,8 +5,10 @@ module Swamp
       page.all('select').map do | element |
         if element.visible?
           if has_id?(element)
+            shine %-##{element["id"]}-
             elements << Swamp::SelectBox.new(element["id"], element["id"])
           elsif has_name?(element)
+            shine %-select[name='#{element["name"]}']-
             elements << Swamp::SelectBox.new(element["name"], element["name"])
           end
         end

data/lib/swamp/version.rb

@@ -1,3 +1,3 @@
 module Swamp
-  VERSION = '1.0.1'
+  VERSION = '1.1.0'
 end

data/spec/swamp/buttons_spec.rb

@@ -7,6 +7,7 @@ module Swamp
       element = {'id' => "u_0_2"}
       element.stub(:text).and_return("Sign Up")
       element.stub(:visible?).and_return(true)
+      buttons.page.stub(:execute_script).and_return(nil)
       buttons.page.should_receive(:all).with('button').and_return([element])
       buttons.get
     end
@@ -21,7 +22,13 @@ module Swamp
           buttons.page.stub(:all).with('button').and_return([element])
         end
 
+        it "highlights the element" do
+          buttons.page.should_receive(:execute_script).twice
+          buttons.get
+        end
+
         it "returns the element in the array using the text as both the name and the selector" do
+          buttons.page.stub(:execute_script).and_return(nil)
           buttons.get.should have(1).button
           buttons.get.each.first.name.should == "Sign Up"
           buttons.get.each.first.selector.should == "Sign Up"
@@ -38,7 +45,13 @@ module Swamp
             buttons.page.stub(:all).with('button').and_return([element])
           end
 
+          it "highlights the element" do
+            buttons.page.should_receive(:execute_script).twice
+            buttons.get
+          end
+
           it "returns the element in the array using the id as both the name and the selector" do
+            buttons.page.stub(:execute_script).and_return(nil)
             buttons.get.should have(1).button
             buttons.get.each.first.name.should == "search-button"
             buttons.get.each.first.selector.should == "search-button"
@@ -55,7 +68,13 @@ module Swamp
               buttons.page.stub(:all).with('button').and_return([element])
             end
 
+            it "highlights the element" do
+              buttons.page.should_receive(:execute_script).twice
+              buttons.get
+            end
+
             it "returns the element in the array using the value as both the name and the selector" do
+              buttons.page.stub(:execute_script).and_return(nil)
               buttons.get.should have(1).button
               buttons.get.each.first.name.should == "search-button"
               buttons.get.each.first.selector.should == "search-button"

data/spec/swamp/fields_spec.rb

@@ -6,6 +6,7 @@ module Swamp
     it "delegates to capybara the responsibility to get the fields" do
       element = {'name' => "username", 'type' => "text"}
       element.stub(:visible?).and_return(true)
+      fields.page.stub(:execute_script).and_return(nil)
       fields.page.should_receive(:all).with('input').and_return([element])
       fields.get
     end
@@ -22,12 +23,19 @@ module Swamp
             fields.page.stub(:all).with('input').and_return([element])
           end
 
+          it "highlights the element" do
+            fields.page.should_receive(:execute_script).twice
+            fields.get
+          end
+
           it "returns the element in the array using the name as the method's name" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.name.should == "username"
           end
 
           it "returns the element in the array using the id as the selector" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.selector.should == "u_0_b"
           end
@@ -41,12 +49,19 @@ module Swamp
             fields.page.stub(:all).with('input').and_return([element])
           end
 
+          it "highlights the element" do
+            fields.page.should_receive(:execute_script).twice
+            fields.get
+          end
+
           it "returns the element in the array using the id as the method's name" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.name.should == "username"
           end
 
           it "returns the element in the array using the id as the selector" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.selector.should == "username"
           end
@@ -60,12 +75,19 @@ module Swamp
             fields.page.stub(:all).with('input').and_return([element])
           end
 
+          it "highlights the element" do
+            fields.page.should_receive(:execute_script).twice
+            fields.get
+          end
+
           it "returns the element in the array using the name as the method's name" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.name.should == "username"
           end
 
           it "returns the element in the array using the name as the selector" do
+            fields.page.stub(:execute_script).and_return(nil)
             fields.get.should have(1).field
             fields.get.first.selector.should == "username"
           end

data/spec/swamp/input_buttons_spec.rb

@@ -6,6 +6,7 @@ module Swamp
     it "delegates to capybara the responsibility to get the submit elements" do
       element = {'value' => "Log In", 'id' => "u_0_b"}
       element.stub(:visible?).and_return(true)
+      input_buttons.page.stub(:execute_script).and_return(nil)
       input_buttons.page.should_receive(:all).with('input[type="submit"]').and_return([element])
       input_buttons.get
     end
@@ -19,12 +20,19 @@ module Swamp
           input_buttons.page.stub(:all).with('input[type="submit"]').and_return([element])
         end
 
+        it "highlights the element" do
+          input_buttons.page.should_receive(:execute_script).twice
+          input_buttons.get
+        end
+
         it "returns the element in the array using the value as the name" do
+          input_buttons.page.stub(:execute_script).and_return(nil)
           input_buttons.get.should have(1).input_submit
           input_buttons.get.first.name.should == "Log In"
         end
 
         it "returns the element in the array using the id as the selector" do
+          input_buttons.page.stub(:execute_script).and_return(nil)
           input_buttons.get.should have(1).input_submit
           input_buttons.get.first.selector.should == "#u_0_b"
         end
@@ -38,12 +46,19 @@ module Swamp
           input_buttons.page.stub(:all).with('input[type="submit"]').and_return([element])
         end
 
+        it "highlights the element" do
+          input_buttons.page.should_receive(:execute_script).twice
+          input_buttons.get
+        end
+
         it "returns the element in the array using the value as the name" do
+          input_buttons.page.stub(:execute_script).and_return(nil)
           input_buttons.get.should have(1).input_submit
           input_buttons.get.first.name.should == "Log In"
         end
 
         it "returns the element in the array using the class concatenated with the value as the selector" do
+          input_buttons.page.stub(:execute_script).and_return(nil)
           input_buttons.get.should have(1).input_submit
           input_buttons.get.first.selector.should == "input.btn.without.id[value='Log In']"
         end

data/spec/swamp/links_spec.rb

@@ -6,7 +6,8 @@ module Swamp
     it "delegates to capybara the responsibility to get the links" do
       element = {'id' => "forgot-password", 'href' => "https://somewhere.com"}
       element.stub(:visible?).and_return(true)
-      links.page.should_receive(:all).with('a[href]').and_return([element])
+      links.page.stub(:execute_script).and_return(nil)
+      links.page.should_receive(:all).with('a[href][id]').and_return([element])
       links.get
     end
 
@@ -16,15 +17,22 @@ module Swamp
 
         before(:each) do
           element.stub(:visible?).and_return(true)
-          links.page.stub(:all).with('a[href]').and_return([element])
+          links.page.stub(:all).with('a[href][id]').and_return([element])
+        end
+
+        it "highlights the element" do
+          links.page.should_receive(:execute_script).and_return(nil)
+          links.get
         end
 
         it "returns the element in the array using the id as the name" do
+          links.page.stub(:execute_script).and_return(nil)
           links.get.should have(1).link
           links.get.first.name.should == "forgot-password"
         end
 
         it "returns the element in the array using the id as the selector" do
+          links.page.stub(:execute_script).and_return(nil)
           links.get.should have(1).select_box
           links.get.first.selector.should == "forgot-password"
         end

data/spec/swamp/select_boxes_spec.rb

@@ -6,6 +6,7 @@ module Swamp
     it "delegates to capybara the responsibility to get the select box elements" do
       element = {'id' => "month", 'name' => "birthday_month"}
       element.stub(:visible?).and_return(true)
+      select_boxes.page.stub(:execute_script).and_return(nil)
       select_boxes.page.should_receive(:all).with('select').and_return([element])
       select_boxes.get
     end
@@ -19,12 +20,19 @@ module Swamp
           select_boxes.page.stub(:all).with('select').and_return([element])
         end
 
+        it "highlights the element" do
+          select_boxes.page.should_receive(:execute_script).twice
+          select_boxes.get
+        end
+
         it "returns the element in the array using the id as the name" do
+          select_boxes.page.stub(:execute_script).and_return(nil)
           select_boxes.get.should have(1).select_box
           select_boxes.get.first.name.should == "month"
         end
 
         it "returns the element in the array using the id as the selector" do
+          select_boxes.page.stub(:execute_script).and_return(nil)
           select_boxes.get.should have(1).select_box
           select_boxes.get.first.selector.should == "month"
         end
@@ -38,12 +46,19 @@ module Swamp
           select_boxes.page.stub(:all).with('select').and_return([element])
         end
 
+        it "highlights the element" do
+          select_boxes.page.should_receive(:execute_script).twice
+          select_boxes.get
+        end
+
         it "returns the element in the array using the name as the name" do
+          select_boxes.page.stub(:execute_script).and_return(nil)
           select_boxes.get.should have(1).select_box
           select_boxes.get.first.name.should == "birthday_month"
         end
 
         it "returns the element in the array using the name as the selector" do
+          select_boxes.page.stub(:execute_script).and_return(nil)
           select_boxes.get.should have(1).select_box
           select_boxes.get.first.selector.should == "birthday_month"
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swamp
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Juraci de Lima Vieira Neto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-29 00:00:00.000000000 Z
+date: 2013-11-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara