citronella 0.0.3 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66f8d6b39216fe199746a210493b62325bf34f0e02747978a7fe43481cd0441e
-  data.tar.gz: 321d811f98c49faabc0b9d168d6ecb793a284d6dd794ba99cdcfe22c41d919c4
+  metadata.gz: c7ef1f78d05ad8a27657474af4a584e56c30921d217f863cd85fb06e163f358a
+  data.tar.gz: 3e8992f2bdec5de5479ed4b62ca2b42feabacfce598c736fb117a9f41ef79967
 SHA512:
-  metadata.gz: 34e52701c765f24d210bc22b84cad46bf49821852c1c61815a3885da22190bb3b3fb221f371486a8c8e0ee428e7aaaba33c1c5de1735d3a7003b4de2e3e457b6
-  data.tar.gz: 10fd8a98f877d3a1bbb71fa1de30c2292c58422feeec31cfb6a426e9f96294cff11966df5284f47b0bb839e107e7d0dff95ffea2f932c3a19bc6ae5b47e49ae2
+  metadata.gz: 9db842a70045cd3cd25592c9a18e27690aa3d22759b99abe7bc9823e16f49fe0cc1a5d45a3ab0c33381a41cb8728c3d844352ff8e9e520cdec64ea7b9f297889
+  data.tar.gz: c06316aef0e0343f3d3ee04598b481e047d5b0ef2c808750425e7cf3f76f766747247b00f2acbd11814f01c680228d48fa87b6551a549e197bd23b584d970b0e

data/Gemfile

@@ -4,4 +4,5 @@ source "https://rubygems.org"
 
 git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
 
-gem "selenium-webdriver"
+gem 'selenium-webdriver'
+gem 'test-unit'

data/README.md

@@ -1,6 +1,221 @@
 # Citronella
 
-Webdriver extension with a page object wrapper.
+[![Gem Version](https://badge.fury.io/rb/citronella.svg)](http://badge.fury.io/rb/citronella)
+
+webdriver extension with a page object wrapper.
+
+## Example Tests
+```ruby
+require 'test/unit'
+require "selenium-webdriver"
+require 'citronella'
+require_relative '../pages/contents_page'
+
+
+class NavigationTest < Test::Unit::TestCase
+  def setup
+    options = Selenium::WebDriver::Chrome::Options.new
+    driver = Selenium::WebDriver.for :chrome, options: options
+    @web = Citronella::Web::WebPage.new(driver)
+    @web.page = ContentsPage
+    @web.driver.navigate.to('https://rubygems.org')
+  end
+
+  def teardown
+    @web.driver.quit
+  end
+
+  def test_navigation
+    @web.page.home_page.releases_button.click
+    assert_includes(@web.driver.title, 'Releases')
+
+    @web.page.release_page.gems_button.click
+    assert_includes(@web.driver.title, 'Gem')
+    
+    @web.page.gems_page.sign_in_button.click
+    assert_includes(@web.driver.title, 'Sign in')
+    
+    @web.page.sign_in_page.sign_up_button.click
+    assert_includes(@web.driver.title, 'Sign up')
+    
+    @web.page.sign_up_page.guides_button.click
+    assert_includes(@web.driver.title, 'Guides')
+    
+    @web.page.guides_page.blog_button.click
+    assert_includes(@web.driver.title, 'Blog')
+  end
+end
+```
+Even though this module is mainly designed for the page object model, it can also be used without it for quick prototyping or mockups, etc.
+```ruby
+require 'test/unit'
+require "selenium-webdriver"
+require 'citronella'
+
+
+class PackageSearchTest < Test::Unit::TestCase
+  def setup
+    options = Selenium::WebDriver::Chrome::Options.new
+    driver = Selenium::WebDriver.for :chrome, options: options
+    @web = Citronella::Web::WebPage.new(driver)
+  end
+
+  def teardown
+    @web.driver.quit
+  end
+
+  def test_search_package
+    @web.driver.navigate.to "https://rubygems.org/"
+    @web.locate(id: 'home_query').get_element.send_keys('citronella')
+    @web.locate(class: 'home__search__icon').get_element.click
+    assert(@web.locate(class: 'gems__gem__name').get_element.text, 'citronella')
+  end
+end
+```
+___
+## Install Package
+
+```bash
+gem install citronella
+```
+
+___
+## Documentation
+
+There are only two modules imported in this package:
+
+* The first module is for the tests.
+
+```ruby
+require 'test/unit'
+require "selenium-webdriver"
+require 'citronella'
+
+class NavigationTest < Test::Unit::TestCase
+  def setup
+    options = Selenium::WebDriver::Chrome::Options.new
+    driver = Selenium::WebDriver.for :chrome, options: options
+    @web = Citronella::Web::WebPage.new(driver)
+  end
+
+  def teardown
+    @web.driver.quit
+  end
+end
+```
+
+* The last module is for the page object model.
+
+```ruby
+require 'citronella'
+require_relative '../components/header_menu'
+
+class HomePage
+  include HeaderMenu
+
+  def search_button
+    ui(class: 'home__search__icon')
+  end
+
+  def code_link_button
+    ui(css: 'div.nav--v > a:nth-child(3)')
+  end
+end
+```
+
+___
+## Page Object Design / Strategy
+see full [Page object](https://github.com/heyclore/citronella/tree/main/ruby/examples/page_object/pages) example
+```ruby
+require "selenium-webdriver"
+require 'citronella'
+
+module HeaderMenu
+  def home_logo
+    ui(class: 'header__logo')
+  end
+
+  def search_input
+    ui(id: 'home_query')
+  end
+  
+  def gems_button
+    ui(css: 'a[href="/gems"]')
+  end
+end
+
+class HomePage
+  include HeaderMenu
+
+  def search_button
+    ui(class: 'home__search__icon')
+  end
+
+  def code_link_button
+    ui(css: 'div.nav--v > a:nth-child(3)')
+  end
+end
+
+class SearchPage
+  include HeaderMenu
+
+  def search_lists
+    ui(class: 'gems__gem__name')
+  end
+end
+
+class ContentsPage
+  def home_page
+    HomePage
+  end
+
+  def search_page
+    SearchPage
+  end
+end
+
+options = Selenium::WebDriver::Chrome::Options.new
+driver = Selenium::WebDriver.for :chrome, options: options
+web = Citronella::Web::WebPage.new(driver)
+web.page = ContentsPage
+web.driver.navigate.to('https://rubygems.org')
+web.page.home_page.search_input.send_keys('citronella', return_key=true)
+puts web.page.search_page.search_list.get_element.text
+```
+___
+## Usage
+
+### citronella.WebPage
+
+###### Args:
+- driver / webdriver
+
+###### Kwargs (optional):
+- webdriver_wait `number(seconds)`, default value is `10`
+- logger `bool`, default value is `true`
+
+###### Method Lists:
+| Method Name        | Args*       | Kwargs**         | Note |
+| ------------------ |:-----------:|:----------------:|:----:|
+| driver             | -           | -                | return selenium `webdriver` object |
+| locate             | -           | how: what        | similar as`driver.get_element` as input & return [citronella.WebUi](https://github.com/heyclore/citronella/tree/main/ruby#citronellaui--citronellawebui)|
+| page               | Page Object | -                | setter |
+| page               | -           | -                | getter |
+| webdriver_wait     | number(sec) | -                |      |
+| ready_state        | number(sec) | -                | execute javascript `document.readyState` manually |
+
+### citronella.ui / citronella.WebUi
+
+###### Kwargs:
+- how: what
+
+###### Method Lists:
+| Method Name   | Args*  | Kwargs**           | Note |
+| ------------- |:------:|:------------------:|:----:|
+| send_keys     | text   | clear `bool`, return_key `bool` |      |
+| click         | -      | -                  |      |
+| get_element   | -      | -                  |      |
+| get_elements  | -      | -                  |      |
 
 
 ## Testing powered by

data/citronella.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'citronella'
-  s.version = '0.0.3'
+  s.version = '1.0.0'
 
   s.authors = ['heyclore']
   s.email = 'cloore@gmail.com'
@@ -10,9 +10,9 @@ Gem::Specification.new do |s|
     Webdriver extension with a page object wrapper
   DESCRIPTION
 
-  s.licenses = 'GPL-2.0'
+  s.licenses = 'MIT'
   s.required_ruby_version = '>= 2.7.0'
-  s.homepage = 'https://github.com/heyclore/citronella#readme'
+  s.homepage = 'https://github.com/heyclore/citronella/tree/main/ruby#readme'
   s.metadata = {
     'source_code_uri' => 'https://github.com/heyclore/citronella/tree/main/ruby',
     'github_repo' => 'https://github.com/heyclore/citronella',

data/lib/citronella.rb

@@ -1,2 +1,25 @@
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
 require_relative 'web_page'
 require_relative 'ui'

data/lib/logger.rb

@@ -0,0 +1,41 @@
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
+require 'logger'
+
+module Citronella
+  module Log
+    # A wrapper for UI methods.
+    #
+    # @param [Boolean] logger Flag indicating whether to log actions.
+    # @param [String] class_name The name of the class.
+    # @param [String] function_name The name of the function.
+    # @param [String] name The name of the action.
+    #
+    def self.logger(logger, class_name, function_name, name)
+      if logger
+        Logger.new(STDOUT, level: Logger::INFO).info("#{class_name} => #{function_name} => #{name}")
+      end
+    end
+  end
+end

data/lib/page_decorator.rb

@@ -0,0 +1,58 @@
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
+require_relative 'web_ui.rb'
+
+module Citronella
+  module Wrapper
+    class PageDecorator
+      # A wrapper for page object class.
+      #
+      # @param [Webdriver] driver The web driver object.
+      # @param [Integer] webdriver_wait The timeout for webdriver wait.
+      # @param [PageObject] page The page object class.
+      # @param [Boolean] logger A flag indicating whether to log actions.
+      #
+      def initialize(driver, webdriver_wait, page, logger)
+        @driver = driver
+        @webdriver_wait = webdriver_wait
+        @page = page
+        @logger = logger
+      end
+
+      # Looks up the attribute/method name inside the page object.
+      #
+      # @return [PageDecorator, WebUi]
+      #
+      def method_missing(attr)
+        original_method = @page.new.method(attr)
+        args = original_method.call
+        if args.instance_of?(Class)
+          return PageDecorator.new(@driver, @webdriver_wait, args, @logger)
+        end
+        Citronella::Ui::WebUi.new(@driver, @webdriver_wait, @logger,
+                                  args, attr, @page.name)
+      end
+    end
+  end
+end

data/lib/ui.rb

@@ -1,4 +1,33 @@
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
+# A wrapper for driver.find_element or driver.find_elements.
+#
+# @overload ui(args)
+#   @param locator [Symbol] The locator type.
+#   @param value [String] The locator value.
+#   @return [Citronella::Ui::WebUi] The web element object.
+#
 def ui(args)
-  baz = Struct.new(:page, :exception, :locator)
-  baz.new(args.delete(:page), args.delete(:exception), args)
+  args
 end

data/lib/web_page.rb

@@ -1,24 +1,112 @@
-require_relative 'page_store'
-require_relative 'page_wrapper'
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
+require_relative 'page_decorator'
+require_relative 'web_ui'
 
 module Citronella
-  class WebPage
-    def initialize(driver, webdriver_wait=10)
-      @driver = driver
-      @webdriver_wait = webdriver_wait
-      @pages = Citronella::PagesStore::PagesList.new
-    end
+  module Web
+    # An object class that is used across the tests.
+    # `webdriver_wait` is set to '10' seconds by default.
+    # `logger` is set to 'true' by default.
+    #
+    # @param [Webdriver] driver The web driver object.
+    # @param [Integer] webdriver_wait The timeout for webdriver wait.
+    # @param [Boolean] logger A flag indicating whether to log actions.
+    #
+    # Usage:
+    #   driver = Selenium::WebDriver.for :chrome
+    #   web = WebPage.new(driver)
+    #
+    class WebPage
+      def initialize(driver, webdriver_wait:10, logger:true)
+        @driver = driver
+        @webdriver_wait = webdriver_wait
+        @page = nil
+        @logger = logger
+      end
 
-    def driver
-      @driver
-    end
+      # Returns the original Selenium driver.
+      #
+      # @return [Webdriver] The web driver object.
+      #
+      def driver
+        @driver
+      end
 
-    def page_object(x)
-      @pages.get << x
-    end
+      # Returns the wrapped page object model.
+      #
+      # @return [Citronella::Wrapper::PageDecorator] The page object model.
+      #
+      def page
+        Citronella::Wrapper::PageDecorator.new(@driver, @webdriver_wait, @page,
+                                               @logger)
+      end
+
+      # Sets the page object model.
+      #
+      # @param [PageObject] page The page object model.
+      #
+      def page=(page)
+        @page = page
+      end
+
+      # An alternative way for testing without using page objects.
+      # It returns a WebUi class, but can't use `page` and may cause an error.
+      # It's good for quick prototypes or writing tests.
+      #
+      # @param [Hash] args The locator details.
+      # @return [Citronella::Ui::WebUi] The web element.
+      #
+      # Usage:
+      #   web.ui(name: 'q').get_element.text
+      #   web.ui(name: 'q').get_element.click
+      #
+      def locate(args)
+        Citronella::Ui::WebUi.new(@driver, @webdriver_wait, @logger, args,
+                                  __method__.to_s,
+                                  self.class.name.split('::').last.to_s)
+      end
+
+      # Executes JavaScript to wait for the page to fully load.
+      #
+      # @param [Integer] wait The number of times to check the page's ready state.
+      #
+      def ready_state(wait)
+        wait.times do |i|
+          return if driver.execute_script(
+            "return document.readyState") == "complete"
+          sleep(1)
+        end
+      end
 
-    def page
-      Citronella::PageWrapper.ui_decorator(@driver, @webdriver_wait, @pages)
+      # Overrides the `webdriver_wait` value.
+      #
+      # @param [Integer] wait The new value for `webdriver_wait`.
+      #
+      def webdriver_wait(wait)
+        @webdriver_wait = wait
+      end
     end
   end
 end

data/lib/web_ui.rb

@@ -0,0 +1,109 @@
+#MIT License
+#
+#Copyright (c) 2023 Eko Purnomo
+#
+#Permission is hereby granted, free of charge, to any person obtaining a copy
+#of this software and associated documentation files (the "Software"), to deal
+#in the Software without restriction, including without limitation the rights
+#to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+#copies of the Software, and to permit persons to whom the Software is
+#furnished to do so, subject to the following conditions:
+#
+#The above copyright notice and this permission notice shall be included in all
+#copies or substantial portions of the Software.
+#
+#THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+#IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+#FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+#AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+#LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+#OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+#SOFTWARE.
+
+
+require_relative 'logger'
+
+module Citronella
+  module Ui
+    class WebUi
+      #
+      # @param [Webdriver] driver The web driver object.
+      # @param [Integer] webdriver_wait The timeout for webdriver wait.
+      # @param [Boolean] logger A flag indicating whether to log actions.
+      # @param [Hash] locator The locator for the web element.
+      # @param [String] function_name The name of the function.
+      # @param [String] class_name The name of the class.
+      #
+      def initialize(driver, webdriver_wait, logger, locator, function_name,
+                     class_name)
+        @driver = driver
+        @wait = webdriver_wait
+        @logger = logger
+        @locator = locator
+        @function_name = function_name
+        @class_name = class_name
+      end
+
+      # Waits for a web element to be available and returns it.
+      #
+      # @param [Webdriver] ele The web driver object.
+      # @param [Boolean] displayed Flag indicating whether to wait for the element to be displayed.
+      # @return [Webdriver::Element] The web element.
+      #
+      private def webdriver_wait(ele, displayed=false)
+        el = Selenium::WebDriver::Wait.new(timeout: @wait).until { ele }
+        if displayed
+          @wait.times do
+            break if el.displayed?
+            sleep(1)
+          end
+        end
+        el
+      end
+
+      # Sends keys to the web element.
+      #
+      # @param [String] text The text to be sent.
+      # @param [Boolean] clear Flag indicating whether to clear the field before sending keys.
+      # @param [Boolean] return_key Flag indicating whether to send a return key.
+      #
+      def send_keys(text, clear=false, return_key=false)
+        Citronella::Log.logger(@logger, @class_name, @function_name, __method__)
+        el = webdriver_wait(@driver.find_element(@locator), displayed=true)
+        el.send_keys text
+
+        if return_key
+          el.send_keys :return
+        end
+      end
+
+      # Clicks on the web element.
+      #
+      def click
+        Citronella::Log.logger(@logger, @class_name, @function_name, __method__)
+        el = webdriver_wait(@driver.find_element(@locator), displayed=true)
+        el.click
+      end
+
+      # Returns a web element using find_element method.
+      #
+      # @return [Webdriver::Element] The web element.
+      #
+      def get_element
+        Citronella::Log.logger(@logger, @class_name, @function_name,
+                               __method__.to_s)
+        webdriver_wait(@driver.find_element(@locator))
+      end
+
+      # Returns a list of web elements using find_elements method.
+      #
+      # @return [Array<Webdriver::Element>] The list of web elements.
+      #
+      def get_elements
+        Citronella::Log.logger(@logger, @class_name, @function_name,
+                               __method__.to_s)
+        webdriver_wait(@driver.find_elements(@locator))
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: citronella
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 1.0.0
 platform: ruby
 authors:
 - heyclore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-06-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -34,14 +34,14 @@ files:
 - README.md
 - citronella.gemspec
 - lib/citronella.rb
-- lib/page_store.rb
-- lib/page_wrapper.rb
+- lib/logger.rb
+- lib/page_decorator.rb
 - lib/ui.rb
-- lib/ui_object.rb
 - lib/web_page.rb
-homepage: https://github.com/heyclore/citronella#readme
+- lib/web_ui.rb
+homepage: https://github.com/heyclore/citronella/tree/main/ruby#readme
 licenses:
-- GPL-2.0
+- MIT
 metadata:
   source_code_uri: https://github.com/heyclore/citronella/tree/main/ruby
   github_repo: https://github.com/heyclore/citronella

data/lib/page_store.rb

@@ -1,17 +0,0 @@
-module Citronella
-  module PagesStore
-    class PagesList
-      def initialize
-        @page_lists = []
-      end
-
-      def get
-        if @page_lists.length > 5
-          @page_lists.shift
-        end
-        @page_lists
-      end
-    end
-  end
-end
-

data/lib/page_wrapper.rb

@@ -1,30 +0,0 @@
-require_relative 'ui_object.rb'
-
-module Citronella
-  module PageWrapper
-    def self.method_wrapper(klass, method_name, driver, webdriver_wait, pages)
-      original_method = klass.instance_method(method_name)
-      klass.define_method(method_name) do
-        puts method_name
-        args = original_method.bind(self).call
-        Citronella::UiObject::Ui.new(driver, webdriver_wait, pages,
-                                      args.locator, args.page, args.exception)
-      end
-    end
-
-    def self.class_decorator(klass, driver, webdriver_wait, pages)
-      return if klass.instance_variable_defined?(:@decorated)
-      klass.instance_variable_set(:@decorated, true)
-      return if klass.name == "Object"
-      lists = klass.instance_methods(false)
-      lists.each { |method| method_wrapper(klass, method, driver, webdriver_wait, pages) }
-      class_decorator(klass.superclass, driver, webdriver_wait, pages)
-    end
-
-    def self.ui_decorator(driver, webdriver_wait, pages)
-      klass = pages.get.last
-      class_decorator(klass, driver, webdriver_wait, pages)
-      klass.new
-    end
-  end
-end

data/lib/ui_object.rb

@@ -1,43 +0,0 @@
-module Citronella
-  module UiObject
-    class Ui
-      def initialize(driver, webdriver_wait, pages, locator, page, exception)
-        @driver = driver
-        @webdriver_wait = Selenium::WebDriver::Wait.new(timeout: webdriver_wait)
-        @pages = pages
-        @locator = locator
-        @page = page
-        @exception = exception
-      end
-
-      def send_keys(text, enter: false)
-        @webdriver_wait.until { @driver.find_element(@locator).displayed? }
-        el = @driver.find_element(@locator)
-        el.send_keys text
-
-        if enter
-          el.send_keys :return
-
-          if @page
-            @pages.get << @page
-          end
-        end
-      end
-
-      def click
-        @webdriver_wait.until { @driver.find_element(@locator).displayed? }
-        @driver.find_element(@locator).click
-
-        if @page
-          @pages.get << @page
-        end
-      end
-
-      def get_elements
-        @webdriver_wait.until { @driver.find_element(@locator).displayed? }
-        @driver.find_elements(@locator)
-      end
-    end
-  end
-end
-