swamp 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 321488f9c4e58a1213185e05bce1473a6777bf6d
-  data.tar.gz: 929ab8a776d0303b5c211b1cd9e0787435d6ebd5
+  metadata.gz: d75a81ad2f5980818dc56e8a9142268169597d0a
+  data.tar.gz: 762d89066107e05871ef922878edc4127cbb7d26
 SHA512:
-  metadata.gz: 3f9c38ba1d09493db01a42820a7befd550ba1d0b8d7fd20dc72d5423e81ea37e0a31e9415075a5a9441439c6bed341b6596ed3c3fe6b945466250c0c74caa317
-  data.tar.gz: 5324834c433679cf9a7409ceac75d3f9f4d886e759d1db0b8ce249e8714e4766aa4f5869b763d9d776272009b7519c560d5db135687e819fb78d7feab97018ec
+  metadata.gz: 8487ad90dd5a1a27c3afa5678fbb39884a7517832cb062cc26c06aa4378fa475eedade961a6efa4b4ed48d9abfe5aa710f200fde997675453c783bcf081dae41
+  data.tar.gz: dad587976af09e6837e65dbd0ae6951733839b94f5120ce03416ebe39350bdea58679b3d856de119c4a0615e0c1a8e17a0c0cea1702e14a66804909577b1b7fa

data/.gitignore

@@ -13,8 +13,9 @@ test/tmp
 test/version_tmp
 tmp
 *.swp
+.idea/
 
 # YARD artifacts
 .yardoc
 _yardoc
-doc/
+doc/

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.1.1

data/Guardfile

@@ -0,0 +1,33 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+# Note: The cmd option is now required due to the increasing number of ways
+#       rspec may be run, below are examples of the most common uses.
+#  * bundler: 'bundle exec rspec'
+#  * bundler binstubs: 'bin/rspec'
+#  * spring: 'bin/rsspec' (This will use spring if running and you have
+#                          installed the spring binstubs per the docs)
+#  * zeus: 'zeus rspec' (requires the server to be started separetly)
+#  * 'just' rspec: 'rspec'
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Rails example
+  watch(%r{^app/(.+)\.rb$})                           { |m| "spec/#{m[1]}_spec.rb" }
+  watch(%r{^app/(.*)(\.erb|\.haml|\.slim)$})          { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  watch(%r{^app/controllers/(.+)_(controller)\.rb$})  { |m| ["spec/routing/#{m[1]}_routing_spec.rb", "spec/#{m[2]}s/#{m[1]}_#{m[2]}_spec.rb", "spec/acceptance/#{m[1]}_spec.rb"] }
+  watch(%r{^spec/support/(.+)\.rb$})                  { "spec" }
+  watch('config/routes.rb')                           { "spec/routing" }
+  watch('app/controllers/application_controller.rb')  { "spec/controllers" }
+  watch('spec/rails_helper.rb')                       { "spec" }
+
+  # Capybara features specs
+  watch(%r{^app/views/(.+)/.*\.(erb|haml|slim)$})     { |m| "spec/features/#{m[1]}_spec.rb" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end
+

data/README.md

@@ -68,8 +68,6 @@ end
 module PageObjects
   class SignIn
   
-    path ""
-  
     def type_email(input)
       page.fill_in("Email", with: input)
     end
@@ -108,15 +106,20 @@ When /^I attempt to sign in with valid credentials/ do
 end
 ```
 
-### Dynamically detecting elements
+### Generating code snippets to use with [SitePrism](https://github.com/natritmeyer/site_prism)
+
+You can easily change the scope from "page" to "prism" by using the following command:
+
+```shell
+:scope = prism
+```
+
+then the code snippets will be generated in the SitePrism fromat:
+
+```shell
+element :sign_up, 'button', text: 'Sign Up'
+```
 
-* 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
 
 ### Generating code snippets to use with [capybara-page-object](https://github.com/andyw8/capybara-page-object)
 
@@ -134,6 +137,17 @@ then the code snippets will be generated with the "source" scope like this:
     end
 ```
 
+### Dynamically detecting elements
+
+You can navigate in the browser that swamp opens. Lets say a page that you want to scan requires login, then just do the following:
+
+* Enter the url for this page on swamp and wait for the page to load
+* 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:

data/features/specifications/changing_scope_to_source.feature

@@ -0,0 +1,16 @@
+Feature: User chooses the source scope
+
+  As a Swamp user
+  I want to change the scope to "source"
+  So I can have snippets that are compatible with capybara-page-object gem
+
+  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/scope_changing.feature

@@ -1,34 +1,24 @@
 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
+  I want to change Swamp's scope
+  So I can have snippets that are compatible me favorite framework
 
   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: Happy paths
+    | command           | expected                      |
+    | ":scope = source" | "Option :scope set to source" |
+    | ":scope = page"   | "Option :scope set to page"   |
+    | ":scope = prism"  | "Option :scope set to prism"  |
 
-    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
-      """
+  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"             |

data/features/specifications/using_prism_scope.feature

@@ -0,0 +1,100 @@
+Feature: User chooses the prism scope
+
+  As a Swamp user
+  I want to change the scope to "prism"
+  So that I have snippets compatible with SitePrism page object
+
+  Background: Swamp is running using prism scope
+    Given that swamp is already running
+    And its using "prism" scope
+
+  Scenario: Scanning a button which has text
+    When swamp scan this page: "button.html"
+    Then it should output the following code snippet
+    """
+    element :sign_up, 'button', text: 'Sign Up'
+    """
+
+  Scenario: Scanning a button that doesn't has text but has id
+    When swamp scan this page: "button_without_text.html"
+    Then it should output the following code snippet
+    """
+    element :search_button, '#search-button'
+    """
+
+  Scenario: Scanning a button that doesn't has either text or id but has the value attribute
+    When swamp scan this page: "button_without_text_without_id_with_value.html"
+    Then it should output the following code snippet
+    """
+    element :buy_now, "[value='buy-now']"
+    """
+
+  Scenario: Scanning an input that has id, name and whose the type is text
+    When swamp scan this page: "field.html"
+    Then it should output the following code snippet
+    """
+    element :username, '#id_username'
+    """
+
+  Scenario: Scanning an input that has no name, has id and whose the type is text
+    When swamp scan this page: "field_without_name.html"
+    Then it should output the following code snippet
+    """
+    element :username, '#username'
+    """
+
+  Scenario: Scanning an input without the id attribute that has name and the type is text
+    When swamp scan this page: "field_without_id.html"
+    Then it should output the following code snippet
+    """
+    element :username, 'input[name="username"]'
+    """
+
+  Scenario: Scanning a submit that has value and id
+    When swamp scan this page: "input_submit.html"
+    Then it should output the following code snippet
+    """
+    element :log_in, '#u_0_b'
+    """
+
+  Scenario: Scanning a submit that has no id
+    When swamp scan this page: "input_submit_without_id.html"
+    Then it should output the following code snippet
+    """
+    element :continue, "input.button.g-button.g-button-submit[value='Continue']"
+    """
+  Scenario: Scanning a link that has id
+    When swamp scan this page: "link_with_id.html"
+    Then it should output the following code snippet
+    """
+    element :link_forgot_passwd, '#link-forgot-passwd'
+    """
+
+  Scenario: Scanning a select box that has id
+    When swamp scan this page: "select_box_with_id.html"
+    Then it should output the following code snippet
+    """
+    element :month, '#month'
+    """
+  Scenario: Scanning a select box that has name only
+    When swamp scan this page: "select_box_with_name_only.html"
+    Then it should output the following code snippet
+    """
+    element :region, "select[name='Region']"
+    """
+
+  Scenario: Scanning a select box that doesn't has either id or name
+    When swamp scan this page: "select_without_id_and_name.html"
+    Then it should output the following code snippet
+    """
+    element :provider_select, 'select.provider-select'
+    """
+
+
+
+
+
+
+
+
+

data/features/step_definitions/swamp_steps.rb

@@ -1,15 +1,15 @@
-Given /^swamp is not yet running$/  do
+Given /^swamp is not yet running$/ do
 end
 
-When /^(?:I start it|that swamp is already running)$/  do
+When /^(?:I start it|that swamp is already running)$/ do
   swamp.run
 end
 
-Then /^I should see "(.*?)"$/  do |outcome|
+Then /^I should see "(.*?)"$/ do |outcome|
   fake_output.messages.should include(outcome)
 end
 
-Given /^I enter the url for this page: "(\w+\.html)"$/  do |page|
+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
@@ -69,3 +69,13 @@ end
 When /^I attempt to execute the command "(.*?)"$/ do |command|
   swamp.setup_command(command)
 end
+
+Given(/^its using "(.*?)" scope$/) do |scope|
+  swamp.setup_command(":scope = #{scope}")
+end
+
+When(/^swamp scan this page: "(.*?)"$/) do |page|
+  path = File.join(File.dirname(__FILE__), '../support/page_examples/', page)
+  @url = "file://#{path}"
+  swamp.scan(@url)
+end

data/lib/swamp/builders/basic.rb

@@ -0,0 +1,39 @@
+module Swamp
+  module Builders
+    class Basic
+
+      def initialize(base)
+        @base = base
+      end
+
+      def build_snippet(element)
+        if element.name
+          [method_definition, element.method_signature, line_break, identation, base, element.accessor, line_break, method_end].join
+        else
+          [base, element.accessor].join
+        end
+      end
+
+      def method_definition
+        'def '
+      end
+
+
+      def method_end
+        'end'
+      end
+
+      def base
+        [@base, '.'].join
+      end
+
+      def identation
+        '  '
+      end
+
+      def line_break
+        "\n"
+      end
+    end
+  end
+end

data/lib/swamp/builders/prism.rb

@@ -0,0 +1,9 @@
+module Swamp
+    module Builders
+    class Prism
+      def build_snippet element
+        "element :#{element.formatted_name}, #{element.prism_selector}"
+      end
+    end
+  end
+end

data/lib/swamp/collections/buttons.rb

@@ -0,0 +1,28 @@
+module Swamp
+  class Buttons < Elements
+    def get
+      elements = []
+      page.all('button').map do |element|
+        if element.visible?
+          if has_valid_text?(element)
+            shine %\//button[text()='#{element.text}']\, :xpath
+            button = Swamp::Button.new(element.text, element.text)
+            button.prism_selector = %\'button', text: '#{element.text}'\
+            elements << button
+          elsif has_id?(element) and has_valid_id?(element)
+            shine %/##{element['id']}/
+            button = Swamp::Button.new(element['id'], element['id'])
+            button.prism_selector = "'##{element['id']}'"
+            elements << button
+          elsif has_value?(element) and has_valid_value?(element)
+            shine %/button[value='#{element['value']}']/
+            button = Swamp::Button.new(element['value'], element['value'])
+            button.prism_selector = %\"[value='#{element['value']}']"\
+            elements << button
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/{fields.rb → collections/fields.rb}

@@ -6,13 +6,19 @@ module Swamp
         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'])
+            field = Swamp::Field.new(element['name'], element['id'])
+            field.prism_selector = "'##{element['id']}'"
+            elements << field
           elsif has_id?(element)
             shine %/##{element['id']}/
-            elements << Swamp::Field.new(element['id'], element['id'])
+            field = Swamp::Field.new(element['id'], element['id'])
+            field.prism_selector = "'##{element['id']}'"
+            elements << field
           elsif has_name?(element)
             shine %/input[name=#{element['name']}]/
-            elements << Swamp::Field.new(element['name'], element['name'])
+            field = Swamp::Field.new(element['name'], element['name'])
+            field.prism_selector = %/'input[name="#{element['name']}"]'/
+            elements << field
           end
         end
       end

data/lib/swamp/{input_buttons.rb → collections/input_buttons.rb}

@@ -7,10 +7,15 @@ module Swamp
           if has_value?(element)
             if has_id?(element)
               shine %/##{element["id"]}/
-              elements << Swamp::InputButton.new(element["value"], "##{element["id"]}")
+              button = Swamp::InputButton.new(element["value"], "##{element["id"]}")
+              button.prism_selector = %\'##{element['id']}'\
+              elements << button
             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"]}']")
+              capybara_selector = "input.#{formatter.format_class(element["class"])}[value='#{element["value"]}']"
+              button = Swamp::InputButton.new(element["value"], capybara_selector)
+              button.prism_selector = %\"#{capybara_selector}"\
+              elements << button
             end
           end
         end

data/lib/swamp/{links.rb → collections/links.rb}

@@ -5,7 +5,9 @@ module Swamp
       page.all('a[href][id]').map do | element |
         if element.visible?
           shine_link %/##{element["id"]}/
-          elements << Swamp::Link.new(element["id"], element["id"])
+          link = Swamp::Link.new(element["id"], element["id"])
+          link.prism_selector = "'##{element['id']}'"
+          elements << link
         end
       end
       elements

data/lib/swamp/collections/select_boxes.rb

@@ -0,0 +1,28 @@
+module Swamp
+  class SelectBoxes < Elements
+    def get
+      elements = []
+      page.all('select').map do | element |
+        if element.visible?
+          if has_id?(element)
+            shine %/##{element["id"]}/
+            select_box = Swamp::SelectBox.new(element["id"], element["id"])
+            select_box.prism_selector = "'##{element['id']}'"
+            elements << select_box
+          elsif has_name?(element)
+            shine %/select[name='#{element["name"]}']/
+            select_box = Swamp::SelectBox.new(element["name"], element["name"])
+            select_box.prism_selector = %\"select[name='#{element['name']}']"\
+            elements << select_box
+          else
+            shine %/select.#{element["class"]}/
+            select_box = Swamp::ComplexSelectBox.new(element["class"], element["class"])
+            select_box.prism_selector = %\'select.#{element['class']}'\
+            elements << select_box
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/{button.rb → elements/button.rb}

@@ -1,5 +1,6 @@
 module Swamp
   class Button < Element
+    attr_accessor :prism_selector
     def method_signature
       format(@name)
     end

data/lib/swamp/{complex_select_box.rb → elements/complex_select_box.rb}

@@ -1,5 +1,7 @@
 module Swamp
   class ComplexSelectBox < Element
+    attr_accessor :prism_selector
+
     def method_signature
       "#{format(@name)}(option)"
     end

data/lib/swamp/{element.rb → elements/element.rb}

@@ -16,6 +16,18 @@ module Swamp
       raise NotImplementedError, "Must be implemented by subtypes"
     end
 
+    def prism_selector
+      raise NotImplementedError, "Must be implemented by subtypes"
+    end
+
+    def prism_selector=(value)
+      raise NotImplementedError, "Must be implemented by subtypes"
+    end
+
+    def formatted_name
+      format(name)
+    end
+
     def format(text)
       Swamp::Formatter.new.format(text)
     end

data/lib/swamp/{field.rb → elements/field.rb}

@@ -1,5 +1,6 @@
 module Swamp
   class Field < Element
+    attr_accessor :prism_selector
     def method_signature
       "type_#{format(@name)}(input)"
     end

data/lib/swamp/{input_button.rb → elements/input_button.rb}

@@ -1,5 +1,6 @@
 module Swamp
   class InputButton < Element
+    attr_accessor :prism_selector
     def method_signature
       format(@name)
     end

data/lib/swamp/{link.rb → elements/link.rb}

@@ -1,5 +1,6 @@
 module Swamp
   class Link < Element
+    attr_accessor :prism_selector
     def method_signature
       format(@name)
     end

data/lib/swamp/{select_box.rb → elements/select_box.rb}

@@ -1,5 +1,6 @@
 module Swamp
   class SelectBox < Element
+    attr_accessor :prism_selector
     def method_signature
       "select_#{format(@name)}(option)"
     end

data/lib/swamp/scopes/page.rb

@@ -0,0 +1,9 @@
+module Swamp
+  module Scope
+    class Page
+      def builder
+        @builder ||= Swamp::Builders::Basic.new('page')
+      end
+    end
+  end
+end

data/lib/swamp/scopes/prism.rb

@@ -0,0 +1,9 @@
+module Swamp
+  module Scope
+    class Prism
+      def builder
+        @builder ||= Swamp::Builders::Prism.new
+      end
+    end
+  end
+end

data/lib/swamp/scopes/scope.rb

@@ -0,0 +1,13 @@
+module Swamp
+  module Scope
+
+    SCOPES = {
+        source: Swamp::Scope::Source.new,
+        page: Swamp::Scope::Page.new,
+        prism: Swamp::Scope::Prism.new
+    }
+    def Scope.from_value(value)
+      SCOPES[value.to_sym]
+    end
+  end
+end

data/lib/swamp/scopes/source.rb

@@ -0,0 +1,9 @@
+module Swamp
+  module Scope
+    class Source
+      def builder
+        @builder ||= Swamp::Builders::Basic.new('source')
+      end
+    end
+  end
+end

data/lib/swamp/setup.rb

@@ -3,13 +3,13 @@ module Swamp
     attr_reader :scope
 
     COMMAND_LIST = {
-      ":scope" => ["source", "page"]
+      ":scope" => ["source", "page", "prism"]
     }
 
     include Swamp::Assertions
 
     def initialize
-      @scope = "page"
+      @scope = Swamp::Scope.from_value('page')
     end
 
     def handle_command(input)
@@ -22,11 +22,15 @@ module Swamp
         return ["Invalid command"]
       end
 
-      @scope = value
+      @scope = Swamp::Scope.from_value(value)
 
       [success_message]
     end
 
+    def builder
+      @scope.builder
+    end
+
     private
 
     def success_message

data/lib/swamp/version.rb

@@ -1,3 +1,3 @@
 module Swamp
-  VERSION = '1.2.0'
+  VERSION = '1.3.0'
 end

data/lib/swamp/wrapper.rb

@@ -18,7 +18,7 @@ module Swamp
     def scan
       found_snippets = []
       @meta_collection.each do | element_collection |
-        found_snippets += element_collection.get.map { | element | Swamp::Builder.new(element, @setup).build_snippet }
+        found_snippets += element_collection.get.map { | element | @setup.builder.build_snippet(element) }
       end
       found_snippets
     end