swamp 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72f601901bae303907f20a56ceaed96006e6a5ca
-  data.tar.gz: be3344d7497cfd4ac6fc6581fbe36c3e8de6cfe1
+  metadata.gz: 15fa292671e998ec2b364b1893e815773df39785
+  data.tar.gz: 85175279ded0c63c318c152877a99e03003b9e4e
 SHA512:
-  metadata.gz: 83936ff3cab3c8652958e68e2875edcee976ccba2c9f2cde8f1827dba4a158034e225e6f33ea88629a83867c34036f68ecdebd4775102a3fe10f19516419e9b8
-  data.tar.gz: 3b60605c340ec0f5f4643b0d49edb2802ab759da30e110048d36bf0c104a2f6746be7f612f22441ae22c8b232a8439a6d0482113f43f6f73f5e7602af410db6e
+  metadata.gz: 53afdc9793bbf5148ee8d9da1774e59c202747d1bb8a3dc9079a12d5393d88ebcf3a6af54f1661c2f9275c1f055391ec5058e3180bf263a32c63c9e5d4aed4fa
+  data.tar.gz: 7e18435b353cbb5b647ea1f0c19653eca2e432ea94cc3819f7c22010ffb7db0ba7983fa47aa461db4289c42383ba61fafcc08623fec20610ad697b8cca48cda4

data/.gitignore

@@ -2,6 +2,7 @@
 *.rbc
 .bundle
 .config
+Gemfile.lock
 coverage
 InstalledFiles
 lib/bundler/man

data/README.md

@@ -1,5 +1,110 @@
+# Swamp
+
 [![Build Status](https://travis-ci.org/Juraci/swamp.png?branch=master)](https://travis-ci.org/Juraci/swamp)
+
+Automatically generates the interfaces for the most common actions that a page can provide, 
+so you can use the generated methods to quickly create your page objects using [capybara](https://github.com/jnicklas/capybara) and [capybara-page-object](https://github.com/andyw8/capybara-page-object).
+
+## How to install
+
+It requires Ruby 1.9.3 or later and Firefox 24.0 or later. To install, type:
+
+```bash
+gem install swamp
+```
+
+## How to use
+
+* In the terminal type: 
+
+```shell
 swamp
-=====
+```
+* It will ask you to provide an URL:
+
+```shell
+Enter the url for the page to be scanned:
+```
+
+* Provide a valid one, beginning with `http://` or `https://` for instance:
+
+```shell
+Enter the url for the page to be scanned:
+https://accounts.google.com
+```
+
+* Hit enter and wait for the code snippets, like this: 
+
+```shell
+Enter the url for the page to be scanned:
+https://accounts.google.com
+
+Scanning, please wait...
+
+def type_email(input)
+  source.fill_in("Email", with: input)
+end
+def type_passwd(input)
+  source.fill_in("Passwd", with: input)
+end
+def sign_in
+  source.find(:css, "#signIn").click
+end
+def select_lang_chooser(option)
+  source.select(option, :from => "lang-chooser")
+end
+def link_forgot_passwd
+  source.click_link("link-forgot-passwd")
+end
+def link_signup
+  source.click_link("link-signup")
+end
+```
+(notice that the method names are a best guess and you are always free to change them)
+
+* Copy the code snippets and paste inside your capybara-page-object classes like this:
+
+```ruby
+module PageObjects
+  class SignIn < CapybaraPageObject::Page
+  
+    path ""
+  
+    def type_email(input)
+      source.fill_in("Email", with: input)
+    end
+  
+    def type_passwd(input)
+      source.fill_in("Passwd", with: input)
+    end
+  
+    def sign_in
+      source.find(:css, "#signIn").click
+    end
+  
+    def select_lang_chooser(option)
+      source.select(option, :from => "lang-chooser")
+    end
+  
+    def link_forgot_passwd
+      source.click_link("link-forgot-passwd")
+    end
+
+    def link_signup
+      source.click_link("link-signup")
+    end
+  end
+end
+```
+
+* Then just call the methods passing the expected parameters when necessary. For instance:
+
+```ruby
+When /^I attempt to sign in with valid credentials/ do
+  sign_in_page = PageObjects::SignIn.visit
+  sign_in_page.type_email "username@email.com"
+  sign_in_page.type_passwd "mypassword"
+  sign_in_page.sign_in
+end
+```
 
-automatically generates the interfaces for the most common actions that a page can provide

data/features/specifications/user_scans_a_page_interactively.feature

@@ -1,4 +1,4 @@
-Feature: user scans a page interactively
+  Feature: user scans a page interactively
 
   As a swamp user
   I want to scan the page interactively
@@ -9,3 +9,10 @@ Feature: user scans a page interactively
     When I attempt to hit enter at the terminal
     Then swamp should scan the current page
     And I should see "Scanning, please wait..."
+
+  Scenario: User scans the current page but it has no detectable elements
+    Given that swamp is already running
+    And I enter the url for this page: "no_elements.html"
+    When swamp scans that page
+    Then swamp should not output any snippet
+    And I should see "No elements were detected"

data/features/specifications/user_scans_fields_in_a_page.feature

@@ -7,7 +7,7 @@ Feature: user scans fields in a page
   Background: swamp is running
     Given that swamp is already running
 
-  Scenario: A standard field
+  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
@@ -17,7 +17,17 @@ Feature: user scans fields in a page
       end
       """
 
-  Scenario: A field without the id attribute
+  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
+      """
+      def type_username(input)
+        source.fill_in("username", with: input)
+      end
+      """
+
+  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
@@ -27,12 +37,12 @@ Feature: user scans fields in a page
       end
       """
 
-  Scenario: A checkbox
+  Scenario: An input whose the type is checkbox
     Given I enter the url for this page: "checkbox.html"
     When swamp scans that page
     Then swamp should not output any snippet
 
-  Scenario: A radio
+  Scenario: An input whose the type is radio
     Given I enter the url for this page: "radio.html"
     When swamp scans that page
     Then swamp should not output any snippet

data/features/step_definitions/swamp_steps.rb

@@ -23,9 +23,11 @@ Then /^swamp should output the following code snippets?$/ do |string|
 end
 
 Then /^swamp should not output any snippet$/ do
-  prompt_message = "Enter the url for the page to be scanned:"
-  output.should have_at_least(1).messages
-  output.messages.should include(prompt_message)
+  output.should have_at_most(3).messages
+  output.messages.each do |m|
+    m.should_not include("def")
+    m.should_not include("source.")
+  end
 end
 
 Given /^that swamp already have scanned a page$/ do
@@ -41,6 +43,7 @@ When /^I attempt to hit enter at the terminal$/ do
 end
 
 Then /^swamp should scan the current page$/ do
-  output.should have_at_least(3).messages
-  output.messages.last.should == "def sign_up\n  source.click_button(\"Sign Up\")\nend"
+  output.should have_at_most(5).messages
+  output.messages[3].should == "Scanning, please wait..."
+  output.messages[4].should == "def sign_up\n  source.click_button(\"Sign Up\")\nend"
 end

data/features/support/page_examples/field_without_name.html

@@ -0,0 +1 @@
+<input id="username" placeholder="Digite" class="texto usuario" type="text" maxlength="30">

data/lib/swamp/fields.rb

@@ -3,10 +3,12 @@ module Swamp
     def get
       elements = []
       page.all('input').map do |element|
-        if element.visible? and has_name?(element) and valid_type?(element)
-          if has_id?(element)
+        if element.visible? and valid_type?(element)
+          if has_id?(element) and has_name?(element)
             elements << Swamp::Field.new(element['name'], element['id'])
-          else
+          elsif has_id?(element)
+            elements << Swamp::Field.new(element['id'], element['id'])
+          elsif has_name?(element)
             elements << Swamp::Field.new(element['name'], element['name'])
           end
         end
@@ -15,7 +17,7 @@ module Swamp
     end
 
     def valid_type?(element)
-      element['type'] != "radio" and element['type'] != "checkbox" and element['type'] != "submit" ? true : false
+      element['type'] != "button" and element['type'] != "radio" and element['type'] != "checkbox" and element['type'] != "submit" ? true : false
     end
   end
 end

data/lib/swamp/interface.rb

@@ -3,6 +3,7 @@ module Swamp
 
     WELCOME_MESSAGE = ['Enter the url for the page to be scanned:']
     INVALID_REQUEST_MESSAGE = ['Please enter a valid url!']
+    NO_ELEMENTS_MESSAGE = ['No elements were detected']
 
     def initialize(output, wrapper)
       @output = output
@@ -15,16 +16,10 @@ module Swamp
 
     def scan(input)
       @output.puts "Scanning, please wait..."
-      evaluator = Swamp::Evaluator.new(input, @wrapper)
-      messages = (evaluator.valid_url? or evaluator.refresh_command?) ? request(input) : INVALID_REQUEST_MESSAGE
+      messages = valid_request?(input) ? request(input) : INVALID_REQUEST_MESSAGE
       present messages
     end
 
-    def request(input)
-      @wrapper.explore(input)
-      @wrapper.scan
-    end
-
     private
 
     def present(messages)
@@ -32,5 +27,18 @@ module Swamp
         @output.puts(message)
       end
     end
+
+    def valid_request?(input)
+      evaluator(input).valid_url? or evaluator(input).refresh_command?
+    end
+
+    def evaluator(input)
+      Swamp::Evaluator.new(input, @wrapper)
+    end
+
+    def request(input)
+      @wrapper.explore(input)
+      @wrapper.scan.empty? ? NO_ELEMENTS_MESSAGE : @wrapper.scan
+    end
   end
 end

data/lib/swamp/version.rb

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

data/spec/swamp/fields_spec.rb

@@ -11,64 +11,72 @@ module Swamp
     end
 
     context "when the input element is visible" do
-      context "when the name attribute is present" do
-        context "when it has the id attribute" do
-          it "returns the element in the array using the name as the name and the id as the selector" do
-            element = {'name' => "username", 'type' => "text", 'id' => "u_0_b"}
+      context "when it has a valid type" do
+        let (:type) { ["text", "email", "password"].sample }
+
+        context "when it has the id and the name attribute" do
+          let (:element) { {'name' => "username", 'type' => type, 'id' => "u_0_b"} }
+
+          before(:each) do
             element.stub(:visible?).and_return(true)
             fields.page.stub(:all).with('input').and_return([element])
+          end
+
+          it "returns the element in the array using the name as the method's name" do
             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.get.should have(1).field
             fields.get.first.selector.should == "u_0_b"
           end
         end
 
-        context "when its type is text" do
-          it "returns the element in the array" do
-            element = {'name' => "username", 'type' => "text"}
+        context "when it has only the id attribute" do
+          let (:element) { {'type' => type, 'id' => "username"} }
+
+          before(:each) do
             element.stub(:visible?).and_return(true)
             fields.page.stub(:all).with('input').and_return([element])
+          end
+
+          it "returns the element in the array using the id as the method's name" do
             fields.get.should have(1).field
             fields.get.first.name.should == "username"
-            fields.get.first.selector.should == "username"
           end
-        end
 
-        context "when its type is email" do
-          it "returns the element in the array" do
-            element = {'name' => "useremail", 'type' => "email"}
-            element.stub(:visible?).and_return(true)
-            fields.page.stub(:all).with('input').and_return([element])
+          it "returns the element in the array using the id as the selector" do
             fields.get.should have(1).field
-            fields.get.first.name.should == "useremail"
-            fields.get.first.selector.should == "useremail"
+            fields.get.first.selector.should == "username"
           end
         end
 
-        context "when its type is password" do
-          it "returns the element in the array" do
-            element = {'name' => "password", 'type' => "password"}
+        context "when it has only the name attribute" do
+          let (:element) { {'name' => "username", 'type' => type} }
+
+          before(:each) do
             element.stub(:visible?).and_return(true)
             fields.page.stub(:all).with('input').and_return([element])
+          end
+
+          it "returns the element in the array using the name as the method's name" do
             fields.get.should have(1).field
-            fields.get.first.name.should == "password"
-            fields.get.first.selector.should == "password"
+            fields.get.first.name.should == "username"
           end
-        end
 
-        context "when the input element type is invalid" do
-          it "returns an empty array" do
-            element = {'name' => "username", 'type' => "radio"}
-            element.stub(:visible?).and_return(true)
-            fields.page.stub(:all).with('input').and_return([element])
-            fields.get.should == []
+          it "returns the element in the array using the name as the selector" do
+            fields.get.should have(1).field
+            fields.get.first.selector.should == "username"
           end
         end
       end
 
-      context "when the input element has no name attribute" do
+      context "when the input element type is invalid" do
+        let (:type) { ["radio", "checkbox", "submit", "button"].sample }
+
         it "returns an empty array" do
-          element = {'name' => "", 'type' => "text"}
+          element = {'name' => "username", 'type' => type}
           element.stub(:visible?).and_return(true)
           fields.page.stub(:all).with('input').and_return([element])
           fields.get.should == []

data/spec/swamp/interface_spec.rb

@@ -29,10 +29,20 @@ module Swamp
       end
 
       context "when it scans a valid url" do
-        it "sends the code snippets of the scanned page to the output" do
-          wrapper.stub(:scan).and_return(["code_snippet"])
-          output.should_receive(:puts).with("code_snippet")
-          interface.scan("http://www.fakepage.com")
+        context "when elements were found" do
+          it "sends the code snippets of the scanned page to the output" do
+            wrapper.stub(:scan).and_return(["code_snippet"])
+            output.should_receive(:puts).with("code_snippet")
+            interface.scan("http://www.fakepage.com")
+          end
+        end
+
+        context "when no elements were found" do
+          it "sends a warning message to the output telling that no elements were found" do
+            wrapper.stub(:scan).and_return([])
+            output.should_receive(:puts).with("No elements were detected")
+            interface.scan("http://www.fakepage.com")
+          end
         end
       end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swamp
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Juraci de Lima Vieira Neto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-02 00:00:00.000000000 Z
+date: 2013-10-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: capybara
@@ -149,7 +149,6 @@ files:
 - .rspec
 - .travis.yml
 - Gemfile
-- Gemfile.lock
 - README.md
 - Rakefile
 - bin/swamp
@@ -170,11 +169,13 @@ files:
 - features/support/page_examples/checkbox.html
 - features/support/page_examples/field.html
 - features/support/page_examples/field_without_id.html
+- features/support/page_examples/field_without_name.html
 - features/support/page_examples/input_submit.html
 - features/support/page_examples/input_submit_without_id.html
 - features/support/page_examples/link.html
 - features/support/page_examples/link.html~
 - features/support/page_examples/link_with_id.html
+- features/support/page_examples/no_elements.html
 - features/support/page_examples/radio.html
 - features/support/page_examples/select_box_with_id.html
 - features/support/page_examples/select_box_with_name_only.html
@@ -254,11 +255,13 @@ test_files:
 - features/support/page_examples/checkbox.html
 - features/support/page_examples/field.html
 - features/support/page_examples/field_without_id.html
+- features/support/page_examples/field_without_name.html
 - features/support/page_examples/input_submit.html
 - features/support/page_examples/input_submit_without_id.html
 - features/support/page_examples/link.html
 - features/support/page_examples/link.html~
 - features/support/page_examples/link_with_id.html
+- features/support/page_examples/no_elements.html
 - features/support/page_examples/radio.html
 - features/support/page_examples/select_box_with_id.html
 - features/support/page_examples/select_box_with_name_only.html

data/Gemfile.lock

@@ -1,79 +0,0 @@
-PATH
-  remote: .
-  specs:
-    swamp (0.0.5)
-      capybara
-      selenium-webdriver
-
-GEM
-  remote: https://rubygems.org/
-  specs:
-    builder (3.2.2)
-    capybara (2.1.0)
-      mime-types (>= 1.16)
-      nokogiri (>= 1.3.3)
-      rack (>= 1.0.0)
-      rack-test (>= 0.5.4)
-      xpath (~> 2.0)
-    childprocess (0.3.9)
-      ffi (~> 1.0, >= 1.0.11)
-    coderay (1.0.9)
-    cucumber (1.3.8)
-      builder (>= 2.1.2)
-      diff-lcs (>= 1.1.3)
-      gherkin (~> 2.12.1)
-      multi_json (>= 1.7.5, < 2.0)
-      multi_test (>= 0.0.2)
-    diff-lcs (1.2.4)
-    ffi (1.9.0)
-    gherkin (2.12.1)
-      multi_json (~> 1.3)
-    json (1.8.0)
-    method_source (0.8.2)
-    mime-types (1.25)
-    mini_portile (0.5.1)
-    multi_json (1.8.0)
-    multi_test (0.0.2)
-    nokogiri (1.6.0)
-      mini_portile (~> 0.5.0)
-    pry (0.9.12.2)
-      coderay (~> 1.0.5)
-      method_source (~> 0.8)
-      slop (~> 3.4)
-    pry-nav (0.2.3)
-      pry (~> 0.9.10)
-    rack (1.5.2)
-    rack-test (0.6.2)
-      rack (>= 1.0)
-    rake (10.1.0)
-    rspec (2.14.1)
-      rspec-core (~> 2.14.0)
-      rspec-expectations (~> 2.14.0)
-      rspec-mocks (~> 2.14.0)
-    rspec-core (2.14.5)
-    rspec-expectations (2.14.3)
-      diff-lcs (>= 1.1.3, < 2.0)
-    rspec-mocks (2.14.3)
-    rubyzip (0.9.9)
-    selenium-webdriver (2.35.1)
-      childprocess (>= 0.2.5)
-      multi_json (~> 1.0)
-      rubyzip (< 1.0.0)
-      websocket (~> 1.0.4)
-    slop (3.4.6)
-    websocket (1.0.7)
-    xpath (2.0.0)
-      nokogiri (~> 1.3)
-
-PLATFORMS
-  ruby
-
-DEPENDENCIES
-  bundler
-  cucumber
-  json
-  pry
-  pry-nav
-  rake
-  rspec
-  swamp!