swamp 1.1.2 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6ab9f667564af8b8a224893d26848f2eed6e4c7
-  data.tar.gz: 47ba68f51f80b0a25b8fd1344c6e1faa2f30adb9
+  metadata.gz: 321488f9c4e58a1213185e05bce1473a6777bf6d
+  data.tar.gz: 929ab8a776d0303b5c211b1cd9e0787435d6ebd5
 SHA512:
-  metadata.gz: 95d1df06d75df7a27a5a48f96e97caf2364f07f8dddfe241906e5eb7b126b04f15487ea990d2bd148288b075c83edfe02324bdb80d7c5b17b9770bc434c9b2a6
-  data.tar.gz: 725f4c672d632660446e777a8688dfdb8a03183f45b4ceba59f5fff02e117edd972d5d99d2029181657f7e975f85519b29f1c7fd7362aabb21ff6200bd61c30a
+  metadata.gz: 3f9c38ba1d09493db01a42820a7befd550ba1d0b8d7fd20dc72d5423e81ea37e0a31e9415075a5a9441439c6bed341b6596ed3c3fe6b945466250c0c74caa317
+  data.tar.gz: 5324834c433679cf9a7409ceac75d3f9f4d886e759d1db0b8ce249e8714e4766aa4f5869b763d9d776272009b7519c560d5db135687e819fb78d7feab97018ec

data/README.md

@@ -3,7 +3,7 @@
 [![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).
+so you can use the generated methods to quickly create your page objects using [capybara](https://github.com/jnicklas/capybara).
 
 ## How to install
 
@@ -42,22 +42,22 @@ https://accounts.google.com
 Scanning, please wait...
 
 def type_email(input)
-  source.fill_in("Email", with: input)
+  page.fill_in("Email", with: input)
 end
 def type_passwd(input)
-  source.fill_in("Passwd", with: input)
+  page.fill_in("Passwd", with: input)
 end
 def sign_in
-  source.find(:css, "#signIn").click
+  page.find(:css, "#signIn").click
 end
 def select_lang_chooser(option)
-  source.select(option, :from => "lang-chooser")
+  page.select(option, :from => "lang-chooser")
 end
 def link_forgot_passwd
-  source.click_link("link-forgot-passwd")
+  page.click_link("link-forgot-passwd")
 end
 def link_signup
-  source.click_link("link-signup")
+  page.click_link("link-signup")
 end
 ```
 (notice that the method names are a best guess and you are always free to change them)
@@ -66,32 +66,32 @@ end
 
 ```ruby
 module PageObjects
-  class SignIn < CapybaraPageObject::Page
+  class SignIn
   
     path ""
   
     def type_email(input)
-      source.fill_in("Email", with: input)
+      page.fill_in("Email", with: input)
     end
   
     def type_passwd(input)
-      source.fill_in("Passwd", with: input)
+      page.fill_in("Passwd", with: input)
     end
   
     def sign_in
-      source.find(:css, "#signIn").click
+      page.find(:css, "#signIn").click
     end
   
     def select_lang_chooser(option)
-      source.select(option, :from => "lang-chooser")
+      page.select(option, :from => "lang-chooser")
     end
   
     def link_forgot_passwd
-      source.click_link("link-forgot-passwd")
+      page.click_link("link-forgot-passwd")
     end
 
     def link_signup
-      source.click_link("link-signup")
+      page.click_link("link-signup")
     end
   end
 end
@@ -118,6 +118,22 @@ end
 * 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
 
+### Generating code snippets to use with [capybara-page-object](https://github.com/andyw8/capybara-page-object)
+
+You can easily change the scope from "page" to "source" by using the following command:
+
+```shell
+:scope = source
+```
+
+then the code snippets will be generated with the "source" scope like this:
+
+```shell
+    def link_signup
+      source.click_link("link-signup")
+    end
+```
+
 ## How it works?
 
 It uses capybara to fireup the browser and visit the target URL then it looks for patterns like:

data/bin/swamp

@@ -2,19 +2,23 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'swamp'
 
+setup = Swamp::Setup.new
 fields = Swamp::Fields.new
 buttons = Swamp::Buttons.new
 input_buttons = Swamp::InputButtons.new
 select_boxes = Swamp::SelectBoxes.new
 links = Swamp::Links.new
 meta_collection = [fields, buttons, input_buttons, select_boxes, links]
-wrapper = Swamp::Wrapper.new(meta_collection)
-swamp = Swamp::Interface.new(STDOUT, wrapper)
+wrapper = Swamp::Wrapper.new(meta_collection, setup)
+swamp = Swamp::Interface.new(STDOUT, wrapper, setup)
 swamp.run
 
 while input = gets
   if input.chomp == 'exit'
     exit
+  elsif input[0] == ':'
+    swamp.setup_command(input)
+  else
+    swamp.scan(input)
   end
-  swamp.scan(input)
 end

data/features/specifications/scope_changing.feature

@@ -0,0 +1,34 @@
+Feature: user changes the scope in the runtime
+
+  As a swamp user
+  I want to change the scope from "page" to "source"
+  So I can have snippets that are compatible with capybara-page-object gem
+
+  Scenario Outline: User receives feedback from swamp on command execution
+    Given that swamp is already running
+    When I attempt to execute the command <command>
+    Then I should see <expected>
+
+    Examples: Happy paths
+      | command           | expected                         |
+      | ":scope = source" | "Option :scope set to source" |
+      | ":scope = page"   | "Option :scope set to page"   |
+
+    Examples: Corner cases
+      | command              | expected                         |
+      | ":scope=source"      | "Option :scope set to source" |
+      | ":scope =  page"     | "Option :scope set to page"   |
+      | ":scope = "          | "Invalid command"                |
+      | ":whatever = random" | "Invalid command"                |
+      | ": = "               | "Invalid command"                |
+
+  Scenario: User changes the scope from page to source
+    Given that swamp is already running
+    When I attempt to execute the command ":scope = source"
+    And I attempt to scan this page: "button.html"
+    Then swamp should output the following code snippet
+      """
+      def sign_up
+        source.click_button("Sign Up")
+      end
+      """

data/features/specifications/user_scans_buttons_in_a_page.feature

@@ -14,7 +14,7 @@ Feature: user scans buttons in a page
     And it should output the following code snippet
       """
       def sign_up
-        source.click_button("Sign Up")
+        page.click_button("Sign Up")
       end
       """
 
@@ -25,7 +25,7 @@ Feature: user scans buttons in a page
     And it should output the following code snippet
       """
       def search_button
-        source.click_button("search-button")
+        page.click_button("search-button")
       end
       """
 
@@ -36,7 +36,7 @@ Feature: user scans buttons in a page
     And it should output the following code snippet
       """
       def buy_now
-        source.click_button("buy-now")
+        page.click_button("buy-now")
       end
       """
 

data/features/specifications/user_scans_fields_in_a_page.feature

@@ -14,7 +14,7 @@ Feature: user scans fields in a page
     And it should output the following code snippet
       """
       def type_username(input)
-        source.fill_in("id_username", with: input)
+        page.fill_in("id_username", with: input)
       end
       """
 
@@ -25,7 +25,7 @@ Feature: user scans fields in a page
     Then it should output the following code snippet
       """
       def type_username(input)
-        source.fill_in("username", with: input)
+        page.fill_in("username", with: input)
       end
       """
 
@@ -36,7 +36,7 @@ Feature: user scans fields in a page
     Then it should output the following code snippet
       """
       def type_username(input)
-        source.fill_in("username", with: input)
+        page.fill_in("username", with: input)
       end
       """
 

data/features/specifications/user_scans_input_buttons_in_a_page.feature

@@ -14,7 +14,7 @@ Feature: user scans submits in a page
     And it should output the following code snippet
       """
       def log_in
-        source.find(:css, "#u_0_b").click
+        page.find(:css, "#u_0_b").click
       end
       """
 
@@ -25,6 +25,6 @@ Feature: user scans submits in a page
     And it should output the following code snippet
       """
       def continue
-        source.find(:css, "input.button.g-button.g-button-submit[value='Continue']").click
+        page.find(:css, "input.button.g-button.g-button-submit[value='Continue']").click
       end
       """

data/features/specifications/user_scans_links_in_a_page.feature

@@ -14,6 +14,6 @@ Feature: user scans links in a page
     And it should output the following code snippet
       """
       def link_forgot_passwd
-        source.click_link("link-forgot-passwd")
+        page.click_link("link-forgot-passwd")
       end
       """

data/features/specifications/user_scans_select_box_elements_in_a_page.feature

@@ -14,7 +14,7 @@ Feature: user scans select box elements in a page
     And it should output the following code snippet
       """
       def select_month(option)
-        source.select(option, :from => "month")
+        page.select(option, :from => "month")
       end
       """
 
@@ -25,7 +25,7 @@ Feature: user scans select box elements in a page
     And it should output the following code snippet
       """
       def select_region(option)
-        source.select(option, :from => "Region")
+        page.select(option, :from => "Region")
       end
       """
 
@@ -36,6 +36,6 @@ Feature: user scans select box elements in a page
     And it should output the following code snippet
       """
       def provider_select(option)
-        source.find(:css, "select.provider-select option[value='#{option}']").click
+        page.find(:css, "select.provider-select option[value='#{option}']").click
       end
       """

data/features/step_definitions/swamp_steps.rb

@@ -6,7 +6,7 @@ When /^(?:I start it|that swamp is already running)$/  do
 end
 
 Then /^I should see "(.*?)"$/  do |outcome|
-  output.messages.should include(outcome)
+  fake_output.messages.should include(outcome)
 end
 
 Given /^I enter the url for this page: "(\w+\.html)"$/  do |page|
@@ -18,15 +18,22 @@ When /^swamp scans that page$/ do
   swamp.scan(@url)
 end
 
+When /^I attempt to scan this page: "(\w+\.html)"$/ do |page|
+  path = File.join(File.dirname(__FILE__), '../support/page_examples/', page)
+  url = "file://#{path}"
+  swamp.scan(url)
+end
+
 Then /^(?:swamp|it) should output the following code snippets?$/ do |string|
-  output.messages.should include(string)
+  fake_output.messages.should include(string)
 end
 
 Then /^swamp should not output any snippet$/ do
-  output.should have_at_most(3).messages
-  output.messages.each do |m|
+  fake_output.messages.size.should <= 3
+  fake_output.messages.each do |m|
     m.should_not include("def")
     m.should_not include("source.")
+    m.should_not include("page.")
   end
 end
 
@@ -35,7 +42,7 @@ Given /^that swamp already have scanned a page$/ do
   path = File.join(File.dirname(__FILE__), '../support/page_examples/', "button.html")
   @url = "file://#{path}"
   swamp.scan(@url)
-  output.messages.should include("def sign_up\n  source.click_button(\"Sign Up\")\nend")
+  fake_output.messages.should include("def sign_up\n  page.click_button(\"Sign Up\")\nend")
 end
 
 When /^I attempt to hit enter at the terminal$/ do
@@ -43,9 +50,9 @@ When /^I attempt to hit enter at the terminal$/ do
 end
 
 Then /^swamp should scan the current page$/ do
-  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"
+  fake_output.messages.size.should <= 5
+  fake_output.messages[3].should == "Scanning, please wait..."
+  fake_output.messages[4].should == "def sign_up\n  page.click_button(\"Sign Up\")\nend"
 end
 
 Then /^swamp should highlight this (element|link): "(.+)"$/ do |mode, selector|
@@ -58,3 +65,7 @@ Then /^swamp should highlight this (element|link): "(.+)"$/ do |mode, selector|
     page.find(selector)[:style].should include("background-color: rgb(255, 0, 0)")
   end
 end
+
+When /^I attempt to execute the command "(.*?)"$/ do |command|
+  swamp.setup_command(command)
+end

data/features/support/setup.rb

@@ -8,8 +8,12 @@ class Output
   end
 end
 
-def output
-  @output ||= Output.new
+def fake_output
+  @fake_output ||= Output.new
+end
+
+def setup
+  @setup ||= Swamp::Setup.new
 end
 
 def buttons
@@ -34,9 +38,10 @@ end
 
 def wrapper
   meta_collection = [fields, buttons, input_buttons, select_boxes, links]
-  Swamp::Wrapper.new(meta_collection)
+  Swamp::Wrapper.new(meta_collection, setup)
 end
 
+
 def swamp
-  @swamp ||= Swamp::Interface.new(output, wrapper)
+  @swamp ||= Swamp::Interface.new(fake_output, wrapper, setup)
 end

data/lib/swamp.rb

@@ -1,4 +1,6 @@
 require 'swamp/version'
+require 'swamp/assertions'
+require 'swamp/setup'
 require 'swamp/interface'
 require 'swamp/evaluator'
 require 'swamp/base'

data/lib/swamp/assertions.rb

@@ -0,0 +1,7 @@
+module Swamp
+  module Assertions
+    def assert &block
+      raise ArgumentError unless block.call
+    end
+  end
+end

data/lib/swamp/builder.rb

@@ -1,14 +1,18 @@
 module Swamp
   class Builder
-    def initialize(element)
+
+    attr_reader :element
+
+    def initialize(element, setup)
       @element = element
+      @setup = setup
     end
 
     def build_snippet
-      if @element.name
-        [method_definition, @element.method_signature, line_break, identation, prefix, @element.accessor, line_break, method_end].join
+      if element.name
+        [method_definition, element.method_signature, line_break, identation, scope, element.accessor, line_break, method_end].join
       else
-        [prefix, @element.accessor].join
+        [scope, element.accessor].join
       end
     end
 
@@ -20,8 +24,8 @@ module Swamp
       "end"
     end
 
-    def prefix
-      "source."
+    def scope
+      [@setup.scope, "."].join
     end
 
     def identation

data/lib/swamp/interface.rb

@@ -5,9 +5,10 @@ module Swamp
     INVALID_REQUEST_MESSAGE = ['Please enter a valid url!']
     NO_ELEMENTS_MESSAGE = ['No elements were detected']
 
-    def initialize(output, wrapper)
+    def initialize(output, wrapper, setup)
       @output = output
       @wrapper = wrapper
+      @setup = setup
     end
 
     def run
@@ -20,7 +21,10 @@ module Swamp
       present messages
     end
 
-    private
+    def setup_command(input)
+      messages = @setup.handle_command(input)
+      present messages
+    end
 
     def present(messages)
       messages.each do |message|
@@ -28,6 +32,8 @@ module Swamp
       end
     end
 
+    private
+
     def valid_request?(input)
       evaluator(input).valid_url? or evaluator(input).refresh_command?
     end