swamp 0.0.1

data/lib/swamp/evaluator.rb

@@ -0,0 +1,20 @@
+module Swamp
+  class Evaluator
+    def initialize(input, wrapper)
+      @input = input
+      @wrapper = wrapper
+    end
+
+    def valid_url?
+      @input.match(/^(http|https|file):\/\/.*$/i) ? true : false
+    end
+
+    def refresh_command?
+      enter_keystroke? and @wrapper.page_visited
+    end
+
+    def enter_keystroke?
+      @input == "\n"
+    end
+  end
+end

data/lib/swamp/field.rb

@@ -0,0 +1,11 @@
+module Swamp
+  class Field < Element
+    def method_signature
+      "type_#{format(@name)}(input)"
+    end
+
+    def accessor
+      "fill_in(\"#{@selector}\", with: input)"
+    end
+  end
+end

data/lib/swamp/fields.rb

@@ -0,0 +1,21 @@
+module Swamp
+  class Fields < Elements
+    def get
+      elements = []
+      page.all('input').map do |element|
+        if element.visible? and has_name?(element) and valid_type?(element)
+          if has_id?(element)
+            elements << Swamp::Field.new(element['name'], element['id'])
+          else
+            elements << Swamp::Field.new(element['name'], element['name'])
+          end
+        end
+      end
+      elements
+    end
+
+    def valid_type?(element)
+      element['type'] != "radio" and element['type'] != "checkbox" and element['type'] != "submit" ? true : false
+    end
+  end
+end

data/lib/swamp/formatter.rb

@@ -0,0 +1,51 @@
+module Swamp
+  class Formatter
+
+    def format(name)
+      @name = name
+      @name = replace_dashes
+      @name = remove_white_spaces
+      @name = replace_parentheses
+      @name = replace_brackets
+      @name = remove_suffix_symbols
+      @name = downcase_name
+    end
+
+    def format_class(name)
+      @name = name
+      @name = replace_white_spaces_with_dots
+    end
+
+    def replace_white_spaces_with_dots
+      @name.gsub(" ",".")
+    end
+
+    def replace_dashes
+      @name.gsub("-","_")
+    end
+
+    def remove_white_spaces
+      @name.gsub(" ", "_")
+    end
+
+    def replace_parentheses
+      @name.gsub("(", "_").gsub(")", "_")
+    end
+
+    def replace_brackets
+      @name.gsub("[", "_").gsub("]", "_")
+    end
+
+    def remove_suffix_symbols
+      result = @name.match(/\w+?(?<symbols>[_]+\Z)/)
+      if result != nil
+        @name = @name.chomp(result[:symbols])
+      end
+      @name
+    end
+
+    def downcase_name
+      @name.downcase
+    end
+  end
+end

data/lib/swamp/input_button.rb

@@ -0,0 +1,11 @@
+module Swamp
+  class InputButton < Element
+    def method_signature
+      format(@name)
+    end
+
+    def accessor
+      "find(:css, \"#{@selector}\").click"
+    end
+  end
+end

data/lib/swamp/input_buttons.rb

@@ -0,0 +1,19 @@
+module Swamp
+  class InputButtons < Elements
+    def get
+      elements = []
+      page.all('input[type="submit"]').map do | element |
+        if element.visible?
+          if has_value?(element)
+            if has_id?(element)
+              elements << Swamp::InputButton.new(element["value"], "##{element["id"]}")
+            elsif has_class?(element)
+              elements << Swamp::InputButton.new(element["value"], "input.#{formatter.format_class(element["class"])}[value='#{element["value"]}']")
+            end
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/interface.rb

@@ -0,0 +1,33 @@
+module Swamp
+  class Interface
+
+    WELCOME_MESSAGE = ['Enter the url for the page to be scanned:']
+    INVALID_REQUEST_MESSAGE = ['Please enter a valid url!']
+
+    def initialize(output, wrapper)
+      @output = output
+      @wrapper = wrapper
+    end
+
+    def run
+      present(WELCOME_MESSAGE)
+    end
+
+    def scan(input)
+      evaluator = Swamp::Evaluator.new(input, @wrapper)
+      messages = (evaluator.valid_url? or evaluator.refresh_command?) ? request(input) : INVALID_REQUEST_MESSAGE
+      present messages
+    end
+
+    def request(input)
+      @wrapper.explore(input)
+      @wrapper.scan
+    end
+
+    def present(messages)
+      messages.each do |message|
+        @output.puts(message)
+      end
+    end
+  end
+end

data/lib/swamp/link.rb

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

data/lib/swamp/links.rb

@@ -0,0 +1,15 @@
+module Swamp
+  class Links < Elements
+    def get
+      elements = []
+      page.all('a[href]').map do | element |
+        if element.visible?
+          if has_id?(element)
+            elements << Swamp::Link.new(element["id"], element["id"])
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/select_box.rb

@@ -0,0 +1,11 @@
+module Swamp
+  class SelectBox < Element
+    def method_signature
+      "select_#{format(@name)}(option)"
+    end
+
+    def accessor
+      "select(option, :from => \"#{@selector}\")"
+    end
+  end
+end

data/lib/swamp/select_boxes.rb

@@ -0,0 +1,17 @@
+module Swamp
+  class SelectBoxes < Elements
+    def get
+      elements = []
+      page.all('select').map do | element |
+        if element.visible?
+          if has_id?(element)
+            elements << Swamp::SelectBox.new(element["id"], element["id"])
+          elsif has_name?(element)
+            elements << Swamp::SelectBox.new(element["name"], element["name"])
+          end
+        end
+      end
+      elements
+    end
+  end
+end

data/lib/swamp/version.rb

@@ -0,0 +1,3 @@
+module Swamp
+  VERSION = '0.0.1'
+end

data/lib/swamp/wrapper.rb

@@ -0,0 +1,25 @@
+module Swamp
+  class Wrapper < Base
+    def initialize(meta_collection)
+      @meta_collection = meta_collection
+      @page_visited = false
+    end
+
+    attr_reader :page_visited
+
+    def explore(url)
+      if !page_visited
+        visit url
+        @page_visited = true
+      end
+    end
+
+    def scan
+      found_snippets = []
+      @meta_collection.each do | element_collection |
+        found_snippets += element_collection.get.map { | element | Swamp::Builder.new(element).build_snippet }
+      end
+      found_snippets
+    end
+  end
+end

data/lib/swamp.rb

@@ -0,0 +1,26 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup(:default)
+
+require 'swamp/version'
+require 'swamp/interface'
+require 'swamp/evaluator'
+require 'swamp/base'
+require 'swamp/elements'
+require 'swamp/wrapper'
+require 'swamp/element'
+require 'swamp/fields'
+require 'swamp/field'
+require 'swamp/buttons'
+require 'swamp/button'
+require 'swamp/builder'
+require 'swamp/formatter'
+require 'swamp/input_buttons'
+require 'swamp/input_button'
+require 'swamp/select_boxes'
+require 'swamp/select_box'
+require 'swamp/links'
+require 'swamp/link'
+
+module Swamp
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+require 'swamp'
+
+RSpec.configure do |config|
+  # Use color in STDOUT
+  config.color_enabled = true
+
+  # Use color not only in STDOUT but also in pagers and files
+  #config.tty = true
+
+  # Use the specified formatter
+  #config.formatter = :documentation # :progress, :html, :textmate
+end

data/spec/swamp/builder_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+module Swamp
+  describe Builder do
+    describe "#build_method" do
+      context "when the type is field" do
+        let(:type) { :field }
+        context "when the name and the selector are present" do
+          it "returns the method's snippet" do
+            element = Swamp::Field.new("User-Name", "User-Name")
+            builder = Swamp::Builder.new(element)
+            builder.build_snippet.should == "def type_user_name(input)\n  source.fill_in(\"User-Name\", with: input)\nend"
+          end
+        end
+      end
+
+      context "when the type is button" do
+        let(:type) { :button }
+        context "when the name and the selector are present" do
+          it "returns the method's snippet" do
+            element = Swamp::Button.new("Log_in", "Log_in")
+            builder = Swamp::Builder.new(element)
+            builder.build_snippet.should == "def log_in\n  source.click_button(\"Log_in\")\nend"
+          end
+        end
+
+        context "when just the selector is present" do
+          it "returns just the selector snippet" do
+            element = Swamp::Button.new(nil, "$ 9.90 Buy")
+            builder = Swamp::Builder.new(element)
+            builder.build_snippet.should == "source.click_button(\"$ 9.90 Buy\")"
+          end
+        end
+      end
+    end
+  end
+end

data/spec/swamp/buttons_spec.rb

@@ -0,0 +1,93 @@
+require 'spec_helper'
+module Swamp
+  describe Buttons do
+    let(:buttons) { buttons = Swamp::Buttons.new }
+
+    it "delegates to capybara the responsibility to get the buttons" do
+      element = {'id' => "u_0_2"}
+      element.stub(:text).and_return("Sign Up")
+      element.stub(:visible?).and_return(true)
+      buttons.page.should_receive(:all).with('button').and_return([element])
+      buttons.get
+    end
+
+    context "when the element is visible" do
+      context "when the button element has text" do
+        let(:element) { {'id' => "u_0_2"} }
+
+        before(:each) do
+          element.stub(:visible?).and_return(true)
+          element.stub(:text).and_return("Sign Up")
+          buttons.page.stub(:all).with('button').and_return([element])
+        end
+
+        it "returns the element in the array using the text as both the name and the selector" do
+          buttons.get.should have(1).button
+          buttons.get.each.first.name.should == "Sign Up"
+          buttons.get.each.first.selector.should == "Sign Up"
+        end
+      end
+
+      context "when the button element has no text" do
+        context "when the button element has id" do
+          let(:element) { {'id' => "search-button"} }
+
+          before(:each) do
+            element.stub(:visible?).and_return(true)
+            element.stub(:text).and_return("")
+            buttons.page.stub(:all).with('button').and_return([element])
+          end
+
+          it "returns the element in the array using the id as both the name and the selector" do
+            buttons.get.should have(1).button
+            buttons.get.each.first.name.should == "search-button"
+            buttons.get.each.first.selector.should == "search-button"
+          end
+        end
+
+        context "when the button element has no id" do
+          context "when the button element has value" do
+            let(:element) { {'value' => "search-button", 'id' => ""} }
+
+            before(:each) do
+              element.stub(:visible?).and_return(true)
+              element.stub(:text).and_return("")
+              buttons.page.stub(:all).with('button').and_return([element])
+            end
+
+            it "returns the element in the array using the value as both the name and the selector" do
+              buttons.get.should have(1).button
+              buttons.get.each.first.name.should == "search-button"
+              buttons.get.each.first.selector.should == "search-button"
+            end
+          end
+
+          context "when the button element has no value" do
+            let(:element) { {'value' => "", 'id' => ""} }
+
+            before(:each) do
+              element.stub(:visible?).and_return(true)
+              element.stub(:text).and_return("")
+              buttons.page.stub(:all).with('button').and_return([element])
+            end
+
+            it "returns an empty array" do
+              buttons.stub(:all).with('button').and_return([element])
+              buttons.get.should == []
+            end
+          end
+        end
+      end
+    end
+
+    context "when the button element is not visible" do
+      it "returns an empty array" do
+        element = {'id' => "u_0_2"}
+        element.stub(:text).and_return("Sign Up")
+        element.stub(:visible?).and_return(false)
+        buttons.page.stub(:all).with('button').and_return([element])
+        buttons.get.should == []
+      end
+    end
+  end
+end

data/spec/swamp/evaluator_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+module Swamp
+  describe Evaluator do
+    let(:wrapper) { wrapper = double('wrapper').as_null_object }
+
+    describe "#valid_url?" do
+      context "when the url is valid" do
+        context "when it starts with 'http://'" do
+          it "returns true" do
+            input = "http://fakepage.com"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should be_valid_url
+          end
+        end
+
+        context "when it starts with 'https://'" do
+          it "returns true" do
+            input = "https://fakepage.com"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should be_valid_url
+          end
+        end
+
+        context "when it starts with 'file://'" do
+          it "returns true" do
+            input = "file://fakepage.html"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should be_valid_url
+          end
+        end
+      end
+
+      context "when the url is invalid" do
+        context "when the protocol prefix is missing" do
+          it "returns false" do
+            input = "www.fakepage.com"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should_not be_valid_url
+          end
+        end
+      end
+    end
+
+    describe "#refresh_command?" do
+      context "when the input is an enter keystroke" do
+        context "when a page was already visited" do
+          it "returns true" do
+            wrapper.stub(:page_visited).and_return(true)
+            input = "\n"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should be_refresh_command
+          end
+        end
+
+        context "when no page was yet visited" do
+          it "returns false" do
+            wrapper.stub(:page_visited).and_return(false)
+            input = "\n"
+            evaluator = Swamp::Evaluator.new(input, wrapper)
+            evaluator.should_not be_refresh_command
+          end
+        end
+      end
+
+      context "when the input is not an enter keystroke" do
+        it "returns false" do
+          wrapper.stub(:page_visited).and_return(true)
+          input = " "
+          evaluator = Swamp::Evaluator.new(input, wrapper)
+          evaluator.should_not be_refresh_command
+        end
+      end
+    end
+  end
+end

data/spec/swamp/fields_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+module Swamp
+  describe Fields do
+    let(:fields) { Swamp::Fields.new }
+
+    it "delegates to capybara the responsibility to get the fields" do
+      element = {'name' => "username", 'type' => "text"}
+      element.stub(:visible?).and_return(true)
+      fields.page.should_receive(:all).with('input').and_return([element])
+      fields.get
+    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"}
+            element.stub(:visible?).and_return(true)
+            fields.page.stub(:all).with('input').and_return([element])
+            fields.get.should have(1).field
+            fields.get.first.name.should == "username"
+            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"}
+            element.stub(:visible?).and_return(true)
+            fields.page.stub(:all).with('input').and_return([element])
+            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])
+            fields.get.should have(1).field
+            fields.get.first.name.should == "useremail"
+            fields.get.first.selector.should == "useremail"
+          end
+        end
+
+        context "when its type is password" do
+          it "returns the element in the array" do
+            element = {'name' => "password", 'type' => "password"}
+            element.stub(:visible?).and_return(true)
+            fields.page.stub(:all).with('input').and_return([element])
+            fields.get.should have(1).field
+            fields.get.first.name.should == "password"
+            fields.get.first.selector.should == "password"
+          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 == []
+          end
+        end
+      end
+
+      context "when the input element has no name attribute" do
+        it "returns an empty array" do
+          element = {'name' => "", 'type' => "text"}
+          element.stub(:visible?).and_return(true)
+          fields.page.stub(:all).with('input').and_return([element])
+          fields.get.should == []
+        end
+      end
+    end
+
+    context "when the input element is not visible" do
+      it "returns an empty array" do
+        element = {'name' => "username", 'type' => "text"}
+        element.stub(:visible?).and_return(false)
+        fields.page.stub(:all).with('input').and_return([element])
+        fields.get.should == []
+      end
+    end
+  end
+end

data/spec/swamp/formatter_spec.rb

@@ -0,0 +1,59 @@
+require 'spec_helper'
+module Swamp
+  describe Formatter do
+    let(:formatter) { formatter = Swamp::Formatter.new }
+
+    describe "#format" do
+      context "when the name has dashes" do
+        it "replaces the dashes with unsderscores" do
+          name = "user-name"
+          formatter.format(name).should == "user_name"
+        end
+      end
+
+      context "when the name has white spaces" do
+        it "replaces the white spaces with underscores" do
+          name = "user name"
+          formatter.format(name).should == "user_name"
+        end
+      end
+
+      context "when the name has underscore in the end" do
+        it "removes the underscores from the end" do
+          name = "user_name_"
+          formatter.format(name).should == "user_name"
+        end
+      end
+
+      context "when the name has uppercase characters" do
+        it "converts the characters to lowercase" do
+          name = "Sign up"
+          formatter.format(name).should == "sign_up"
+        end
+      end
+
+      context "when the name has parentheses" do
+        it "replace the parentheses with underscores" do
+          name = "user_name(title)"
+          formatter.format(name).should == "user_name_title"
+        end
+      end
+
+      context "when the name has brackets" do
+        it "replace the brackets with underscores" do
+          name = "user_name[title]"
+          formatter.format(name).should == "user_name_title"
+        end
+      end
+    end
+
+    describe "#format_class" do
+      context "when the class has white spaces" do
+        it "replaces the white spaces with dots" do
+          class_name = "button g-button g-button-submit"
+          formatter.format_class(class_name).should == "button.g-button.g-button-submit"
+        end
+      end
+    end
+  end
+end