swamp 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 713e7f0bd7a7b052bcd1f90f476fbe4ff2a8a18f
+  data.tar.gz: 7ad124d4b613d636732929afdf56fc83404a9634
+SHA512:
+  metadata.gz: 70333aa5bcd6183513b20a6c0a55b87197bce65f0d88224929b0679b43127feb66cac1608fd60e85daee6e9f04b88cef15aceccd53247ea796fc81e9b1af3631
+  data.tar.gz: 2365c3852f58d9b6952fb200e2d0bb85cfdacc2cbc332d555c90b4be0a4edd9080aeaff8de8e4f2377432a5f07fd309fb1bf3c26383a2986370f4446ded306c9

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.0.0
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+before_script:
+  - "export DISPLAY=:99.0"
+  - "sh -e /etc/init.d/xvfb start"

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in fooo.gemspec
+gemspec
+
+# gem 'rake'

data/Gemfile.lock

@@ -0,0 +1,79 @@
+PATH
+  remote: .
+  specs:
+    swamp (0.0.1)
+      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.7.7)
+    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 (~> 1.3)
+  cucumber
+  json
+  pry
+  pry-nav
+  rake
+  rspec
+  swamp!

data/README.md

@@ -0,0 +1,5 @@
+[![Build Status](https://travis-ci.org/Juraci/swamp.png?branch=master)](https://travis-ci.org/Juraci/swamp)
+swamp
+=====
+
+automatically generates the interfaces for the most common actions that a page can provide

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'cucumber/rake/task'
+
+RSpec::Core::RakeTask.new(:spec)
+Cucumber::Rake::Task.new(:cucumber)
+
+task :default => [:spec, :cucumber]

data/bin/swamp

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'swamp'
+
+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)
+swamp.run
+
+while input = gets
+  if input.chomp == 'exit'
+    exit
+  end
+  swamp.scan(input)
+end

data/features/specifications/user_scans_a_page_interactively.feature

@@ -0,0 +1,10 @@
+Feature: user scans a page interactively
+
+  As a swamp user
+  I want to scan the page interactively
+  So I can create the page objects faster
+
+  Scenario: User scans the current page hiting enter
+    Given that swamp already have scanned a page
+    When I attempt to hit enter at the terminal
+    Then swamp should scan the current page

data/features/specifications/user_scans_buttons_in_a_page.feature

@@ -0,0 +1,43 @@
+Feature: user scans buttons in a page
+
+  The user enters an url to a given page, swamp fires up the browser and go to that url
+  once the page is loaded swamp start looking for buttons then swamp generates the code
+  snippets to interact with those elements using capybara.
+
+  Background: swamp is running
+    Given that swamp is already running
+
+  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
+      """
+      def sign_up
+        source.click_button("Sign Up")
+      end
+      """
+
+  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
+      """
+      def search_button
+        source.click_button("search-button")
+      end
+      """
+
+  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
+      """
+      def buy_now
+        source.click_button("buy-now")
+      end
+      """
+
+  Scenario: A button without text id and value
+    Given I enter the url for this page: "button_without_text_id_and_value.html"
+    When swamp scans that page
+    Then swamp should not output any snippet

data/features/specifications/user_scans_fields_in_a_page.feature

@@ -0,0 +1,38 @@
+Feature: user scans fields in a page
+
+  The user enters an url to a given page, swamp fires up the browser and go to that url
+  once the page is loaded swamp start looking for fields then swamp generates the code
+  snippets to interact with those elements using capybara.
+
+  Background: swamp is running
+    Given that swamp is already running
+
+  Scenario: A standard field
+    Given I enter the url for this page: "field.html"
+    When swamp scans that page
+    Then swamp should output the following code snippet
+      """
+      def type_username(input)
+        source.fill_in("id_username", with: input)
+      end
+      """
+
+  Scenario: A field without the id attribute
+    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
+      """
+      def type_username(input)
+        source.fill_in("username", with: input)
+      end
+      """
+
+  Scenario: A 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
+    Given I enter the url for this page: "radio.html"
+    When swamp scans that page
+    Then swamp should not output any snippet

data/features/specifications/user_scans_input_buttons_in_a_page.feature

@@ -0,0 +1,28 @@
+Feature: user scans submits in a page
+
+  The user enters an url to a given page, swamp fires up the browser and go to that url
+  once the page is loaded swamp start looking for inputs of type submit then swamp generates the code
+  snippets to interact with those elements using capybara.
+
+  Background: swamp is running
+    Given that swamp is already running
+
+  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
+      """
+      def log_in
+        source.find(:css, "#u_0_b").click
+      end
+      """
+
+  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
+      """
+      def continue
+        source.find(:css, "input.button.g-button.g-button-submit[value='Continue']").click
+      end
+      """

data/features/specifications/user_scans_links_in_a_page.feature

@@ -0,0 +1,18 @@
+Feature: user scans links in a page
+
+  The user enters an url to a given page, swamp fires up the browser and go to that url
+  once the page is loaded swamp start looking for links elements in that page then swamp
+  generates the code snippets to interact with those elements using capybara.
+
+  Background: swamp is running
+    Given that swamp is already running
+
+  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
+      """
+      def link_forgot_passwd
+        source.click_link("link-forgot-passwd")
+      end
+      """

data/features/specifications/user_scans_select_box_elements_in_a_page.feature

@@ -0,0 +1,28 @@
+Feature: user scans select box elements in a page
+
+  The user enters an url to a given page, swamp fires up the browser and go to that url
+  once the page is loaded swamp start looking for select box elements in that page then swamp
+  generates the code snippets to interact with those elements using capybara.
+
+  Background: swamp is running
+    Given that swamp is already running
+
+  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
+      """
+      def select_month(option)
+        source.select(option, :from => "month")
+      end
+      """
+
+  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
+      """
+      def select_region(option)
+        source.select(option, :from => "Region")
+      end
+      """

data/features/specifications/user_starts_swamp.feature

@@ -0,0 +1,10 @@
+Feature: user starts swamp
+
+  As a swamp user
+  I want to start the application
+  So that I can magically create my page-objects
+
+  Scenario: Start swamp
+    Given swamp is not yet running
+    When I start it
+    Then I should see "Enter the url for the page to be scanned:"

data/features/step_definitions/swamp_steps.rb

@@ -0,0 +1,46 @@
+Given /^swamp is not yet running$/  do
+end
+
+When /^(?:I start it|that swamp is already running)$/  do
+  swamp.run
+end
+
+Then /^I should see "(.*?)"$/  do |outcome|
+  output.messages.should include(outcome)
+end
+
+Given /^I enter the url for this page: "(\w+\.html)"$/  do |page|
+  path = File.join(File.dirname(__FILE__), '../support/page_examples/', page)
+  @url = "file://#{path}"
+end
+
+When /^swamp scans that page$/ do
+  swamp.scan(@url)
+end
+
+Then /^swamp should output the following code snippets?$/ do |string|
+  output.messages.should include(string)
+end
+
+Then /^swamp should not output any snippet$/ do
+  prompt_message = "Enter the url for the page to be scanned:"
+  output.messages.length.should == 1
+  output.messages.should include(prompt_message)
+end
+
+Given /^that swamp already have scanned a page$/ do
+  swamp.run
+  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")
+end
+
+When /^I attempt to hit enter at the terminal$/ do
+  swamp.scan("\n")
+end
+
+Then /^swamp should scan the current page$/ do
+  output.messages.length.should == 3
+  output.messages.last.should == "def sign_up\n  source.click_button(\"Sign Up\")\nend"
+end

data/features/support/env.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH << File.expand_path('../../../lib', __FILE__)
+require 'swamp'

data/features/support/page_examples/button.html

@@ -0,0 +1 @@
+<button type="submit" class="_6j mvm _6wk _6wl signup_button _3ma _6o _6v" name="websubmit" id="u_0_2">Sign Up</button>

data/features/support/page_examples/button_without_text.html

@@ -0,0 +1 @@
+<button id="search-button" type="submit" class="no-focus search-button" tabindex="-1" value=""><span class="goog-inline-block SPRITE_search_icon_white"></span></button>

data/features/support/page_examples/button_without_text_id_and_value.html

@@ -0,0 +1 @@
+<button class="search-input-button" data-bind="css: { 'hasContent': searchQuery }, click: clearSearch "></button></div>

data/features/support/page_examples/button_without_text_without_id_with_value.html

@@ -0,0 +1 @@
+<button class="btn btn-info" data-ga-action="comprar" data-ga-category="revista-digital-detalhes" data-ga-label="revista-digital:caras:1017-maio-2013" data-track-click="true" name="button" type="submit" value="buy-now"></b></button>

data/features/support/page_examples/checkbox.html

@@ -0,0 +1 @@
+<input id="sign-up-terms-and-conditions" name="sign-up-terms-and-conditions" type="checkbox" value="true">

data/features/support/page_examples/field.html

@@ -0,0 +1 @@
+<input type="text" name="username" id="id_username" data-bind="username" class="input-large">

data/features/support/page_examples/field_without_id.html

@@ -0,0 +1 @@
+<input type="text" name="username" data-bind="username" class="input-large">

data/features/support/page_examples/input_submit.html

@@ -0,0 +1 @@
+<input value="Log In" tabindex="4" id="u_0_b" type="submit">

data/features/support/page_examples/input_submit_without_id.html

@@ -0,0 +1 @@
+<input type="submit" class="button g-button g-button-submit" value="Continue">

data/features/support/page_examples/link.html

@@ -0,0 +1 @@
+<a href="/help/index" class="bold">help</a>

data/features/support/page_examples/link_with_id.html

@@ -0,0 +1,5 @@
+<li>
+  <a id="link-forgot-passwd" href="https://accounts.google.com/RecoverAccount?service=mail&amp;continue=http%3A%2F%2Fmail.google.com%2Fmail%2F" target="_top">
+  Can't access your account?
+  </a>
+</li>

data/features/support/page_examples/radio.html

@@ -0,0 +1 @@
+<input class="radio" type="radio" name="alternativa" id="alternativa1" value="1">

data/features/support/page_examples/select_box_with_id.html

@@ -0,0 +1 @@
+<select name="birthday_month" id="month"><option value="0" selected="1">Month</option><option value="1">Jan</option><option value="2">Feb</option><option value="3">Mar</option><option value="4">Apr</option><option value="5">May</option><option value="6">Jun</option><option value="7">Jul</option><option value="8">Aug</option><option value="9">Sep</option><option value="10">Oct</option><option value="11">Nov</option><option value="12">Dec</option></select>

data/features/support/page_examples/select_box_with_name_only.html

@@ -0,0 +1 @@
+<dl><dt class="create_key"><label for="server_region">Region</label></dt><dd class="create_value regions"><div><select class="provider-select" data-bind="region" name="Region"><optgroup label="Next Generation Cloud Servers"><option value="compute,cloudServersOpenStack,IAD">Northern Virginia (IAD)</option><option value="compute,cloudServersOpenStack,DFW">Dallas (DFW)</option><option value="compute,cloudServersOpenStack,ORD">Chicago (ORD)</option><option value="compute,cloudServersOpenStack,SYD">Sydney (SYD)</option></optgroup><optgroup label="First Generation Cloud Servers"><option value="compute,cloudServers">Dallas (DFW)</option></optgroup></select><span class="tooltip_toggle"></span></div><div class="region-warning" style="display: none;"><strong><i class="icon_region"></i><span class="region-label">All Regions (Global)</span></strong> will now be shown, which may be slower<span class="tooltip_toggle"></span></div></dd></dl>

data/features/support/setup.rb

@@ -0,0 +1,42 @@
+class Output
+  def messages
+    @messages ||= []
+  end
+
+  def puts(message)
+    messages << message
+  end
+end
+
+def output
+  @output ||= Output.new
+end
+
+def buttons
+  Swamp::Buttons.new
+end
+
+def fields
+  Swamp::Fields.new
+end
+
+def input_buttons
+  Swamp::InputButtons.new
+end
+
+def select_boxes
+  Swamp::SelectBoxes.new
+end
+
+def links
+  Swamp::Links.new
+end
+
+def wrapper
+  meta_collection = [fields, buttons, input_buttons, select_boxes, links]
+  Swamp::Wrapper.new(meta_collection)
+end
+
+def swamp
+  @swamp ||= Swamp::Interface.new(output, wrapper)
+end

data/lib/swamp/base.rb

@@ -0,0 +1,29 @@
+require 'capybara'
+
+module Swamp
+  class Base
+    include Capybara::DSL
+
+    def initialize
+      setup_capybara
+    end
+
+    def setup_capybara
+      Capybara.register_driver :firefox do |app|
+        Capybara::Selenium::Driver.new(app, :browser => :firefox)
+      end
+
+      Capybara.run_server = false
+      Capybara.default_selector = :css
+      Capybara.default_driver = :selenium
+      Capybara.default_wait_time = 60
+
+      Capybara.configure do |config|
+        config.match = :smart
+        config.exact_options = true
+        config.ignore_hidden_elements = true
+        config.visible_text_only = true
+      end
+    end
+  end
+end

data/lib/swamp/builder.rb

@@ -0,0 +1,35 @@
+module Swamp
+  class Builder
+    def initialize(element)
+      @element = element
+    end
+
+    def build_snippet
+      if @element.name
+        [method_definition, @element.method_signature, line_break, identation, prefix, @element.accessor, line_break, method_end].join
+      else
+        [prefix, @element.accessor].join
+      end
+    end
+
+    def method_definition
+      "def "
+    end
+
+    def method_end
+      "end"
+    end
+
+    def prefix
+      "source."
+    end
+
+    def identation
+      "  "
+    end
+
+    def line_break
+      "\n"
+    end
+  end
+end

data/lib/swamp/button.rb

@@ -0,0 +1,11 @@
+module Swamp
+  class Button < Element
+    def method_signature
+      format(@name)
+    end
+
+    def accessor
+      "click_button(\"#{@selector}\")"
+    end
+  end
+end

data/lib/swamp/buttons.rb

@@ -0,0 +1,19 @@
+module Swamp
+  class Buttons < Elements
+    def get
+      elements = []
+      page.all("button").map do |element|
+        if element.visible?
+          if has_valid_text?(element)
+            elements << Swamp::Button.new(element.text, element.text)
+          elsif has_id?(element) and has_valid_id?(element)
+            elements << Swamp::Button.new(element["id"], element["id"])
+          elsif has_value?(element) and has_valid_value?(element)
+            elements << Swamp::Button.new(element["value"], element["value"])
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/element.rb

@@ -0,0 +1,23 @@
+module Swamp
+  class Element
+    def initialize(name, selector)
+      @name = name
+      @selector = selector
+    end
+
+    attr_reader :name
+    attr_reader :selector
+
+    def method_signature
+      raise NotImplementedError, "Must be implemented by subtypes"
+    end
+
+    def accessor
+      raise NotImplementedError, "Must be implemented by subtypes"
+    end
+
+    def format(text)
+      Swamp::Formatter.new.format(text)
+    end
+  end
+end

data/lib/swamp/elements.rb

@@ -0,0 +1,39 @@
+module Swamp
+  class Elements < Base
+    def has_id?(element)
+      element['id'] != nil and element['id'] != "" ? true : false
+    end
+
+    def has_name?(element)
+      element['name'] != nil and element['name'] != "" ? true : false
+    end
+
+    def has_value?(element)
+      element['value'] != nil and element['value'] != "" ? true : false
+    end
+
+    def has_class?(element)
+      element['class'] != nil and element['class'] != "" ? true : false
+    end
+
+    def has_valid_text?(element)
+      element.text.length >= 3 and has_no_punctuation?(element.text)
+    end
+
+    def has_valid_value?(element)
+      element["value"].length >= 3 and has_no_punctuation?(element["value"])
+    end
+
+    def has_no_punctuation?(string)
+      string.match(/[.,]/) ? false : true
+    end
+
+    def has_valid_id?(element)
+      element["id"].length <= 1 ? false : true
+    end
+
+    def formatter
+      @formatter ||= Swamp::Formatter.new
+    end
+  end
+end