legoTech_gem 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 184a880c5427d20c2ea97ede00f70711c75d815f736513ee2ccd5d3b4b53a66a
-  data.tar.gz: db8910637b4d0c09556ef05257bf181644eb80e088cd7ec8365bcf68c6bcbc96
+  metadata.gz: e8dcdf8b4ace38d60ede6edb10f3b3022e5b7891b4cea351a305764a55b66562
+  data.tar.gz: e78be33f3e91b37cb8b88c25c2150d50fe68f1a821fe58fa7e7bfa02367ec5a6
 SHA512:
-  metadata.gz: 2eb81f3c6efea456435f2265b113d2794311dcfc095bde67de725506168d50cc544f22b97dcbf9326482481c438ce70dce3970b0a09d08f0fdc9e81a6ffc1d92
-  data.tar.gz: b4a3db5b4d84581796e6e66f30c4cf43a52d5066b652e339e982ddf601aecd9fa25fc72781c666457329e1d096dc8c5c2192792ea4367fbf5c93897b946478d0
+  metadata.gz: 861a511b1372060f3fd766b02584c8b99968ae740bbdad1044f5e7f4d653d3cf2f0567b8bb6fe0570c5db91fcf6524b94fddcf24d6dab78bdea0e4b679c695e0
+  data.tar.gz: 02ff6ea3d4c1356f2961b7fdc8b4677425c872d30bf87c60ab81028ced7e306817f2e8f22f6db0953e6162e992dc8ea45f45bc0a846adcd83b95a9cf5c822dbc

data/legoTech.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name = "legoTech_gem"
-  spec.version = "0.0.3"
+  spec.version = "0.0.4"
   spec.authors = ["Patrique Legault"]
   spec.email = ["patrique.legault@gmail.com"]
   spec.summary = %q{A Ruby library used to test forms using browser automation}

data/lib/legoTech_gem.rb

@@ -1,3 +1,6 @@
+# @author Patrique Legault
+
+# Module => LegoTechSelenium
 require_relative "ui/actions/Action"
 
 require_relative "ui/driver/Driver"
@@ -9,5 +12,4 @@ require_relative "ui/test-suites/TestSuite"
 require_relative "ui/enums/Field"
 require_relative "ui/enums/Identifier"
 
-module LegoTechSelenium
-end
+# End Module => LegoTechSelenium

data/lib/ui/actions/Action.rb

@@ -1,18 +1,20 @@
 # @author Patrique Legault
-class Actions
+module LegoTechSelenium
+  class Actions
 
-  # A function that performs the given action against the webpage given the driver and the action
-  #
-  # @param driver [Driver] The driver object that represents the instance that is connected to the browser
-  # @param action [Hash] A ruby object that has the following layout
-  #   {
-  #        :field => Fields::...
-  #        :identifier => Identifier::...
-  #        :value => String
-  #   }
-  # @return void
-  # @raise Selenium Exceptions
-  def test(driver, action)
-    raise "Test function in the Actions.rb file has not been overriden"
+    # A function that performs the given action against the webpage given the driver and the action
+    #
+    # @param driver [Driver] The driver object that represents the instance that is connected to the browser
+    # @param action [Hash] A ruby object that has the following layout
+    #   {
+    #        :field => Fields::...
+    #        :identifier => Identifier::...
+    #        :value => String
+    #   }
+    # @return void
+    # @raise Selenium Exceptions
+    def test(driver, action)
+      raise "Test function in the Actions.rb file has not been overriden"
+    end
   end
 end

data/lib/ui/driver/Driver.rb

@@ -1,31 +1,34 @@
 require "selenium-webdriver"
 
-class Driver
-  @driver
+# @author Patrique Legault
+module LegoTechSelenium
+  class LegoTechSelenium::Driver
+    @driver
 
-  # Pass in an instance of the driver
-  # @param The driver from Selenium Webdriver class
-  def initialize(driver)
-    @driver = driver
-  end
+    # Pass in an instance of the driver
+    # @param The driver from Selenium Webdriver class
+    def initialize(driver)
+      @driver = driver
+    end
 
-  # Set the amount of time the driver should wait when searching for elements.
-  # @param implicit_wait seconds for implicit wait
-  def set_implicit_wait(implicit_wait)
-  end
+    # Set the amount of time the driver should wait when searching for elements.
+    # @param implicit_wait seconds for implicit wait
+    def set_implicit_wait(implicit_wait)
+    end
 
-  # Sets the amount of time to wait for a page load to complete before throwing an error.
-  # @param page_load seconds to wait for page to load
-  def set_page_load(page_load)
-  end
+    # Sets the amount of time to wait for a page load to complete before throwing an error.
+    # @param page_load seconds to wait for page to load
+    def set_page_load(page_load)
+    end
 
-  # Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
-  # @param script_time seconds to wait for script to complete
-  def set_script_tiemout(script_tiemout)
-  end
+    # Sets the amount of time to wait for an asynchronous script to finish execution before throwing an error.
+    # @param script_time seconds to wait for script to complete
+    def set_script_tiemout(script_tiemout)
+    end
 
-  # The URL to navigate to
-  # @param navigate_to location for the browser to navigate to
-  def set_navigate_to(navigate_to)
+    # The URL to navigate to
+    # @param navigate_to location for the browser to navigate to
+    def set_navigate_to(navigate_to)
+    end
   end
 end

data/lib/ui/enums/Field.rb

@@ -1,6 +1,9 @@
-module Fields
-    RADIO_BUTTON      = 1
-    CHECK_BOX         = 2
-    INPUT             = 3
-    DROPDOWN_LIST     = 4
-end
+# @author Patrique Legault
+module LegoTechSelenium
+  module Fields
+    RADIO_BUTTON = 1
+    CHECK_BOX = 2
+    INPUT = 3
+    DROPDOWN_LIST = 4
+  end
+end

data/lib/ui/enums/Identifier.rb

@@ -1,5 +1,8 @@
-module Identifier
-    CSS    = 1
-    NAME   = 2
-    ID     = 3
-end
+# @author Patrique Legault
+module LegoTechSelenium
+  module Identifier
+    CSS = 1
+    NAME = 2
+    ID = 3
+  end
+end

data/lib/ui/test-cases/TestCase.rb

@@ -1,9 +1,12 @@
-class TestCase
-  def initialize(name)
-    if name.nil? or name.empty?
-      raise "All TestCasses must have a name associated to them"
-    end
+# @author Patrique Legault
+module LegoTechSelenium
+  class TestCase
+    def initialize(name)
+      if name.nil? or name.empty?
+        raise "All TestCasses must have a name associated to them"
+      end
 
-    @name = name
+      @name = name
+    end
   end
 end

data/lib/ui/test-suites/TestSuite.rb

@@ -1,62 +1,65 @@
-class TestSuite
-  # @param name [String] is the name of the TestSuite
-  # @param driver [Driver] is the driver variable
-  def initialize(name, driver)
-    if name.nil? or name.empty?
-      raise "All TestSuites must have a name associated to them"
-    end
+# @author Patrique Legault
+module LegoTechSelenium
+  class TestSuite
+    # @param name [String] is the name of the TestSuite
+    # @param driver [Driver] is the driver variable
+    def initialize(name, driver)
+      if name.nil? or name.empty?
+        raise "All TestSuites must have a name associated to them"
+      end
 
-    if driver.nil?
-      raise "Driver must be non nil"
+      if driver.nil?
+        raise "Driver must be non nil"
+      end
+      @name = name
+      @driver = driver
+      @entries = []
     end
-    @name = name
-    @driver = driver
-    @entries = []
-  end
-
-  # Function used to add a TestCase to thee TestSuite
-  # @param testCase [TestCase] A test case to be executed
-  def addTestCase(testCase)
-    @entries.push(testCase)
-  end
-
-  # Retrieve the name of the TestSuite
-  # @return [String] The name of the TestSuite
-  def getName()
-    return @name
-  end
 
-  # Retrieve the number of TestCases within the TestSuite
-  # @return [Number] Number of TestCases
-  def getNumberOfTestCases
-    return @entries.size
-  end
+    # Function used to add a TestCase to thee TestSuite
+    # @param testCase [TestCase] A test case to be executed
+    def addTestCase(testCase)
+      @entries.push(testCase)
+    end
 
-  # Function that will invoke all test cases
-  def run()
-    raise "Not yet built"
-  end
+    # Retrieve the name of the TestSuite
+    # @return [String] The name of the TestSuite
+    def getName()
+      return @name
+    end
 
-  class Builder
-    # Constructor for internal builder
-    # @param name [String] The name of the class
-    # @param driver [Driver] The driver of the class
-    def initialize(name, driver)
-      @testSuites = TestSuite.new(name, driver)
+    # Retrieve the number of TestCases within the TestSuite
+    # @return [Number] Number of TestCases
+    def getNumberOfTestCases
+      return @entries.size
     end
 
-    # Add a test case to the test suite
-    # @param TestsCase [TestCase] to be added to the list
-    # @return self
-    def addTestCase(testCase)
-      @testSuites.addTestCase(testCase)
-      self
+    # Function that will invoke all test cases
+    def run()
+      raise "Not yet built"
     end
 
-    # Returns an instance of TestSuite
-    # @return TestSuite instance
-    def build
-      @testSuites
+    class Builder
+      # Constructor for internal builder
+      # @param name [String] The name of the class
+      # @param driver [Driver] The driver of the class
+      def initialize(name, driver)
+        @testSuites = TestSuite.new(name, driver)
+      end
+
+      # Add a test case to the test suite
+      # @param TestsCase [TestCase] to be added to the list
+      # @return self
+      def addTestCase(testCase)
+        @testSuites.addTestCase(testCase)
+        self
+      end
+
+      # Returns an instance of TestSuite
+      # @return TestSuite instance
+      def build
+        @testSuites
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: legoTech_gem
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Patrique Legault