citronella 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 66f8d6b39216fe199746a210493b62325bf34f0e02747978a7fe43481cd0441e
-  data.tar.gz: 321d811f98c49faabc0b9d168d6ecb793a284d6dd794ba99cdcfe22c41d919c4
+  metadata.gz: 9020c7d6488bbbd5e67e35a1c939a2af5296736bbe99c45a6d8194ff347676aa
+  data.tar.gz: 1fb3f63ea173a9c6ca720bfa945037bb8f6a595922929ee91972751e82d0239d
 SHA512:
-  metadata.gz: 34e52701c765f24d210bc22b84cad46bf49821852c1c61815a3885da22190bb3b3fb221f371486a8c8e0ee428e7aaaba33c1c5de1735d3a7003b4de2e3e457b6
-  data.tar.gz: 10fd8a98f877d3a1bbb71fa1de30c2292c58422feeec31cfb6a426e9f96294cff11966df5284f47b0bb839e107e7d0dff95ffea2f932c3a19bc6ae5b47e49ae2
+  metadata.gz: 9c52cdaeca3173c7d224f2d5f390b83d8b5e9835937bf1af3fa2e8a9ad05c03a1f16f02357b7a85f8052f36c598763a8b9a1551a8606964b78f53dee4bbd1194
+  data.tar.gz: cfd8f9876408c022b04eab006ac24793473ee5a946bba6963446e2d7a66736e917def508b0528718ae7f6003b40da63dd43be16653d60128798a81aea3068165

data/README.md

@@ -1,6 +1,163 @@
 # Citronella
 
-Webdriver extension with a page object wrapper.
+[![Gem Version](https://badge.fury.io/rb/citronella.png)](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)
+  end
+
+  def teardown
+    @web.driver.quit
+  end
+
+  def test_navigation
+    @web.page_object(ContentsPage.new.home_page, url=true)
+    @web.page.releases_button.click
+    assert_includes(@web.driver.title, 'Releases')
+
+    @web.page.gems_button.click
+    assert_includes(@web.driver.title, 'Gem')
+    
+    @web.page.sign_in_button.click
+    assert_includes(@web.driver.title, 'Sign in')
+    
+    @web.page.sign_up_button.click
+    assert_includes(@web.driver.title, 'Sign up')
+    
+    @web.page.guides_button.click
+    assert_includes(@web.driver.title, 'Guides')
+    
+    @web.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 three 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 second and third modules are for the page object model.
+
+```python
+require 'citronella'
+require_relative '../contents_page'
+
+class HomePage < ContentsPage.new.header_menu
+  @url = "https://rubygems.org/"
+
+  def search_button
+    ui(class: 'home__search__icon', page: ContentsPage.new.search_page)
+  end
+
+  def code_link_button
+    ui(css: 'div.nav--v > a:nth-child(3)', page: Citronella::Dummy::PlaceholderPage)
+  end
+end
+```
+
+___
+## 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             | None        | None             | return selenium `webdriver` object |
+| locate             | None        | how: what        | similar as`driver.get_element` args |
+| page_object        | Page Object | url `bool`       | Page Object must contain `@url` variable with if using Kwargs** | 
+| page               | None        | None             |      |
+| back               | None        | None             |      |
+| webdriver_wait     | number(sec) | None             |      |
+| ready_state        | number(sec) | None             | execute javascript `document.readyState` manually |
+
+### citronella.ui / citronella.WebUi
+
+###### Kwargs:
+- how: what
+- page_object (optional)
+
+###### Method Lists:
+| Method Name   | Args*  | Kwargs**           | Note |
+| ------------- |:------:|:------------------:|:----:|
+| send_keys     | text   | clear `bool`, return_key `bool`, switch_page `bool` |    |
+| click         | None   | switch_page `bool` |      |
+| get_element   | None   | None               |      |
+| get_elements  | None   | None               |      |
 
 
 ## 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 = '0.0.4'
 
   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,26 @@
+#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'
+require_relative 'placeholder_page'

data/lib/logger.rb

@@ -0,0 +1,35 @@
+#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
+    def self.logger(logger, class_name, function_name, name)
+      """This is a logger method."""
+      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,46 @@
+#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
+      """This is a page decorator class."""
+      def initialize(driver, webdriver_wait, pages, logger)
+        @driver = driver
+        @webdriver_wait = webdriver_wait
+        @pages = pages
+        @logger = logger
+      end
+
+      def method_missing(attr)
+        """look up the attr / method name inside page object."""
+        original_method = @pages.current_page.new.method(attr)
+        args = original_method.call
+        Citronella::Ui::WebUi.new(@driver, @webdriver_wait, @pages, @logger,
+                                  args.last, args.first, attr, @pages.current_page.name)
+      end
+    end
+  end
+end

data/lib/page_tab.rb

@@ -0,0 +1,51 @@
+#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.
+
+
+module Citronella
+  class PagesList
+    """This is a page page tab class."""
+    def initialize
+      @pages = []
+    end
+
+    def current_page
+      """return the last page object stored."""
+      @pages.last
+    end
+
+    def append(new_page)
+      """store the page object in _pages."""
+      @pages << new_page
+      if @pages.length > 5
+        @pages.shift
+      end
+    end
+
+    def pop
+      """delete the last item of the _pages lists."""
+      return if @pages.empty?
+      @pages.delete_at(-1)
+    end
+  end
+end
+

data/lib/placeholder_page.rb

@@ -0,0 +1,29 @@
+#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.
+
+
+module Citronella
+  module Dummy
+    class PlaceholderPage
+    end
+  end
+end

data/lib/ui.rb

@@ -1,4 +1,42 @@
+#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.
+
+
 def ui(args)
-  baz = Struct.new(:page, :exception, :locator)
-  baz.new(args.delete(:page), args.delete(:exception), args)
+  """
+  forward the data to page decorator and wrap into WebUi class.
+
+  Args:
+      by
+
+  Kwarg:
+      page(optional)
+
+  Usage:
+      without reference / page object. ui(name:  'q')
+      with reference / page object.    ui(id: 'submit', UserMenuPage)
+
+  page are reference for the next page object if the element redirect to
+  another page with WebUi click and send_keys(enter key) from input form.
+  """
+  return args.delete(:page), args
 end

data/lib/web_page.rb

@@ -1,24 +1,129 @@
-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_tab'
+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
+    class WebPage
+      """
+      an object class that use across the tests.
+      webdriver_wait is set '10' seconds by default
+      logger is set 'True' by default
 
-    def driver
-      @driver
-    end
+      Args:
+          driver
+      Kwargs (optional):
+          webdriver_wait
+          logger
 
-    def page_object(x)
-      @pages.get << x
-    end
+      Usage:
+          driver = Selenium::WebDriver.for :chrome
+          web = WebPage(driver)
+      """
+      def initialize(driver, webdriver_wait:10, logger:true)
+        @driver = driver
+        @webdriver_wait = webdriver_wait
+        @pages = Citronella::PagesList.new
+        @logger = logger
+      end
+
+      def driver
+        """return the original selenium / appium driver."""
+        @driver
+      end
+
+      def page_object(new_page, url=false)
+        """
+        initialize page object module object, url kwargs is optional and
+        it set to FALSE by default, it can be use if the page object have
+        an @url variable.
+        in selenium:
+        it's equal as self.driver.navigate.to(url)
+
+        Args:
+            page_object_model
+
+        Kwargs:
+            url=true
+
+        Usage:
+            self.browser.page_object(Homepage)
+            or
+            self.browser.page_object(Homepage, url=true)
+        """
+        @pages.append(new_page)
+        if url
+          if not new_page.instance_variable_get(:@url)
+            raise "Error: '@url' variable does not exist in #{new_page}"
+          end
+          @driver.navigate.to(new_page.instance_variable_get(:@url))
+        end
+      end
+
+      def page
+        """return last page object model."""
+        Citronella::Wrapper::PageDecorator.new(@driver, @webdriver_wait, @pages, @logger)
+      end
+
+      def locate(args)
+        """
+        an alternative way for testing without page object and return WebUi
+        class, but can't use page and back method and causing an error.
+        good for quick prototype / write a tests.
+
+        Args:
+            by
+            value
+
+        Usage:
+            web.ui(name: 'q').get_element.text
+            web.ui(name: 'q').get_element.click
+        """
+        Citronella::Ui::WebUi.new(@driver, @webdriver_wait, @pages, @logger, args, nil,
+                                  __method__.to_s, self.class.name.split('::').last.to_s)
+      end
+
+      def back
+        """return to previous page and delete the last page object."""
+        @driver.navigate.back
+        @pages.pop
+      end
+
+      def ready_state(wait)
+        """execute javascript for page to fully load"""
+        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)
+      def webdriver_wait(wait)
+        """override webdriver wait."""
+        @webdriver_wait = wait
+      end
     end
   end
 end

data/lib/web_ui.rb

@@ -0,0 +1,93 @@
+#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
+      """a wrapped object of a web element."""
+      def initialize(driver, webdriver_wait, pages, logger, locator, new_page,
+                     function_name, class_name)
+        @driver = driver
+        @wait = webdriver_wait
+        @pages = pages
+        @logger = logger
+        @locator = locator
+        @new_page = new_page
+        @function_name = function_name
+        @class_name = class_name
+      end
+
+      private def webdriver_wait(ele, displayed=false)
+        """return a web element or elements."""
+        el = Selenium::WebDriver::Wait.new(timeout: @wait).until { ele }
+        if displayed
+          @wait.times do
+            break if el.displayed?
+            sleep(1)
+          end
+        end
+        el
+      end
+
+      def send_keys(text, clear=false, return_key=false, switch_page=true)
+        """custom webdriver send_keys with optional clear field."""
+        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
+
+          if @new_page and switch_page
+            @pages.append(@new_page)
+          end
+        end
+      end
+
+      def click(switch_page=true)
+        """click to web element."""
+        Citronella::Log.logger(@logger, @class_name, @function_name, __method__)
+        el = webdriver_wait(@driver.find_element(@locator), displayed=true)
+        el.click
+
+        if @new_page and switch_page
+          @pages.append(@new_page)
+        end
+      end
+
+      def get_element
+        """return web element, equal as find_element."""
+        Citronella::Log.logger(@logger, @class_name, @function_name, __method__.to_s)
+        webdriver_wait(@driver.find_element(@locator))
+      end
+
+      def get_elements
+        """return list of web element, equal as find_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: 0.0.4
 platform: ruby
 authors:
 - heyclore
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-07 00:00:00.000000000 Z
+date: 2023-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: selenium-webdriver
@@ -34,14 +34,16 @@ files:
 - README.md
 - citronella.gemspec
 - lib/citronella.rb
-- lib/page_store.rb
-- lib/page_wrapper.rb
+- lib/logger.rb
+- lib/page_decorator.rb
+- lib/page_tab.rb
+- lib/placeholder_page.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
-