legoTech_gem 0.0.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 184a880c5427d20c2ea97ede00f70711c75d815f736513ee2ccd5d3b4b53a66a
+  data.tar.gz: db8910637b4d0c09556ef05257bf181644eb80e088cd7ec8365bcf68c6bcbc96
+SHA512:
+  metadata.gz: 2eb81f3c6efea456435f2265b113d2794311dcfc095bde67de725506168d50cc544f22b97dcbf9326482481c438ce70dce3970b0a09d08f0fdc9e81a6ffc1d92
+  data.tar.gz: b4a3db5b4d84581796e6e66f30c4cf43a52d5066b652e339e982ddf601aecd9fa25fc72781c666457329e1d096dc8c5c2192792ea4367fbf5c93897b946478d0

data/Gemfile

@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+# A sample Gemfile
+source "https://rubygems.org"
+    gem "selenium-webdriver", "~> 3.142.7" # which is same as gem "rails", ">= 3.142.7", "< 3.143.0" 

data/README.md

@@ -0,0 +1,27 @@
+# Ruby-Selenium
+A Ruby gem to help developers write test cases for the UI
+
+Please respect the naming definition as taken from here: https://github.com/airbnb/ruby#naming
+Comments and tags must respect the naming from: https://rubydoc.info/gems/yard/file/docs/Tags.md
+Ruby Types are defined here: https://www.geeksforgeeks.org/ruby-data-types/
+
+**Note**: https://stackoverflow.com/questions/28506769/failed-to-require-a-local-gem/28507368#28507368
+
+# How to install dependencies
+
+1. Make sure Ruby is installed `ruby -v` should return the current version of the language on your computer
+2. Install bundler using `gem install bundler` to allow you to build the project
+3. Make sure all of your new dependencies are within the Gemfile
+4. Run `bundle install --path vendor/bundle`
+
+# How to build a release
+
+1. Make sure Ruby is installed `ruby -v` should return the current version of the language on your computer
+2. Install bundler using `gem install bundler` to allow you to build the project
+3. Building is as simple as `gem build ruby-selenium.gemspec` 
+
+# How to publish
+
+1. Make sure Ruby is installed `ruby -v` should return the current version of the language on your computer
+2. Make sure you have a built gem
+3. Using the gem command run the following `gem push [YOUR_GEM_NAME].gem`

data/legoTech.gemspec

@@ -0,0 +1,17 @@
+Gem::Specification.new do |spec|
+  spec.name = "legoTech_gem"
+  spec.version = "0.0.3"
+  spec.authors = ["Patrique Legault"]
+  spec.email = ["patrique.legault@gmail.com"]
+  spec.summary = %q{A Ruby library used to test forms using browser automation}
+  spec.description = %q{A lightweight testing framework that utilizes selenium to allow developers to write test cases}
+  spec.homepage = "https://www.pat-lego.io"
+  spec.license = "MIT"
+  spec.files = Dir.glob("{lib}/**/*.rb") + %w(README.md legoTech.gemspec Gemfile)
+  spec.require_paths = ["lib"]
+  #   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  #   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "selenium-webdriver", "~> 3.142.7"
+end

data/lib/legoTech_gem.rb

@@ -0,0 +1,13 @@
+require_relative "ui/actions/Action"
+
+require_relative "ui/driver/Driver"
+
+require_relative "ui/test-cases/TestCase"
+
+require_relative "ui/test-suites/TestSuite"
+
+require_relative "ui/enums/Field"
+require_relative "ui/enums/Identifier"
+
+module LegoTechSelenium
+end

data/lib/ui/actions/Action.rb

@@ -0,0 +1,18 @@
+# @author Patrique Legault
+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"
+  end
+end

data/lib/ui/driver/Driver.rb

@@ -0,0 +1,31 @@
+require "selenium-webdriver"
+
+class Driver
+  @driver
+
+  # 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
+
+  # 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
+
+  # The URL to navigate to
+  # @param navigate_to location for the browser to navigate to
+  def set_navigate_to(navigate_to)
+  end
+end

data/lib/ui/enums/Field.rb

@@ -0,0 +1,6 @@
+module Fields
+    RADIO_BUTTON      = 1
+    CHECK_BOX         = 2
+    INPUT             = 3
+    DROPDOWN_LIST     = 4
+end

data/lib/ui/enums/Identifier.rb

@@ -0,0 +1,5 @@
+module Identifier
+    CSS    = 1
+    NAME   = 2
+    ID     = 3
+end

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

@@ -0,0 +1,9 @@
+class TestCase
+  def initialize(name)
+    if name.nil? or name.empty?
+      raise "All TestCasses must have a name associated to them"
+    end
+
+    @name = name
+  end
+end

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

@@ -0,0 +1,62 @@
+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"
+    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 that will invoke all test cases
+  def run()
+    raise "Not yet built"
+  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)
+    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

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification
+name: legoTech_gem
+version: !ruby/object:Gem::Version
+  version: 0.0.3
+platform: ruby
+authors:
+- Patrique Legault
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-02-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: selenium-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.142.7
+description: A lightweight testing framework that utilizes selenium to allow developers
+  to write test cases
+email:
+- patrique.legault@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- legoTech.gemspec
+- lib/legoTech_gem.rb
+- lib/ui/actions/Action.rb
+- lib/ui/driver/Driver.rb
+- lib/ui/enums/Field.rb
+- lib/ui/enums/Identifier.rb
+- lib/ui/test-cases/TestCase.rb
+- lib/ui/test-suites/TestSuite.rb
+homepage: https://www.pat-lego.io
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: A Ruby library used to test forms using browser automation
+test_files: []