watir-customize_elements 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 1c983aeb021cf78608707cf4dda2908a783646d8
+  data.tar.gz: 28f31d487bd25e37c10fc2cf41ae3ddb6449f308
+SHA512:
+  metadata.gz: 345f1f7bd82a8728ebd08131020ca831e735f86e2dc98ac45923fab25c248a3029d9491120c0e2a98ab3a7e9202cfd11bf5e005e5a6c87d5f0b798e8046b7477
+  data.tar.gz: 8aaabd4cd1793763c84bcd1075d5461b296c5c54f732b3f893ce4dc2bea7c1f47c5e277b22d5d7325f41ef0d28864739f50db7efde1d6a9c0006b2016bafaf4d

data/LICENSE.txt

@@ -0,0 +1,13 @@
+   Copyright 2016 MyHeritage, Ltd.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+     http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,63 @@
+# watir-customize_elements
+The purpose of this gem is to enable Watir-Webdriver and page-object gem to work with custom, non-standard HTML element tag names.
+
+While Watir-Webdriver and the page-object gem do not support non-standard HTML tags, we encountered many cases in our testing when we needed to use such elements.
+Although it's possible to register custom elements with PageObject via [widgets](https://github.com/cheezy/page-object/wiki/Widgets-%28registering-custom-elements-with-PageObject%29), and to add support for it in Watir, the process of doing so for each custom element got tedious.
+That's why we created this gem. It automatically instantiates custom HTML tag names into watir-webdriver and/or page-object gem from a few lines in a simple yml file.
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir-customize_elements'
+```
+
+And then execute:
+```shell
+$ bundle
+```
+
+Or install it yourself as:
+
+```shell
+$ gem install watir-customize_elements
+```
+
+## Usage 
+- Create a yml file (call it whatever you like), and include the name and path as an env argument named `CUSTOM_ELEMENTS_CONFIG_PATH`. See explanation at the end of this section
+- Require watir-customize_elements **after** requiring watir-webdriver and/or page-object.
+- If you don't want to pass `ENV[CUSTOM_ELEMENTS_CONFIG_PATH]` from the command line, set it **before** requiring watir-customize_elements
+```ruby
+require 'watir-webdriver'
+require 'page-object'
+ENV['CUSTOM_ELEMENTS_CONFIG_PATH'] = 'path\to\custom_elements_file.yml'
+require 'watir-customize_elements'
+```
+## yml file
+The yml file should include two parts: modules and elements
+
+```
+modules:
+  watir: true
+  page_object: true
+elements:
+  element_name:
+    element_collection: element_names
+    element_class: ElementName
+    element_type: CheckBox
+  mh_button:
+    element_collection: mh_buttons
+    element_class: MHButton
+    element_type: Button
+```	
+##### Modules
+Determines which gem to interact with. Configure according to your setup.
+##### Elements section explained:
+- element_name - This is the exact name of the tag type, with underscores instead of dashes
+- element_collection - This is the name of the element name, but pluralized. element-name would be element_name
+- element_class - This is the element name in class form. mh-checkbox would be MHCheckBox.
+- element_type- This is the PageObject element type (found here: http://bit.ly/1TNEtal). This will give your custom
+      element the same type of attribute as its native HTML element type (ex: mh-checkbox with a type of CheckBox is
+      treated by PageObject as a true HTML checkbox). If there isn't a matching type, choose Element.
+
+You can find an example of a complete yml file [here](http://github.com/myheritage/watir-customize_elements/blob/master/example_custom_elements.yml)

data/example_custom_elements.yml

@@ -0,0 +1,16 @@
+modules:
+  watir: true
+  page_object: true
+elements:
+  mh_checkbox:
+    element_collection: mh_checkboxes
+    element_class: MHCheckBox
+    element_type: CheckBox
+  mh_button:
+    element_collection: mh_buttons
+    element_class: MHButton
+    element_type: Button
+  source_with_matches:
+    element_collection: sources_with_matches
+    element_class: SourceWithMatches
+    element_type: Element

data/lib/watir-customize_elements.rb

@@ -0,0 +1,92 @@
+require 'watir-webdriver'
+require 'page-object'
+require 'yaml'
+
+=begin
+Copyright 2016 MyHeritage, Ltd.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and limitations under the License.
+=end
+
+module WatirCustomizeElements
+
+  config_file = ENV['CUSTOM_ELEMENTS_CONFIG_PATH']
+  @config = YAML::load_file(config_file) unless config_file.nil?
+
+  def self.custom_elements
+    custom_elements = @config['elements'] unless @config.nil?
+  end
+
+  def self.modules
+    modules = @config['modules'] unless @config.nil?
+  end
+
+end
+
+
+unless WatirCustomizeElements.custom_elements.nil?
+  if WatirCustomizeElements.modules['watir']
+    # Extending Watir module
+    module Watir
+      # Extending Container module
+      module Container
+        # Do the following for each custom element to add
+        WatirCustomizeElements.custom_elements.each do |key, values|
+          # Defines the element in Watir as a method
+          define_method(key.to_sym) { |*args| eval(values['element_class']).new(self, extract_selector(args).merge(:tag_name => key.gsub('_', '-'))) }
+
+          # Defines a collection of elements in Watir as a method
+          define_method(values['element_collection']) { |*args| eval("#{values['element_class']}Collection").new(self, extract_selector(args).merge(:tag_name => key.gsub('_', '-'))) }
+
+          # Instantiate the classes for a single element and the collection of elements
+          Container.const_set(values['element_class'], Class.new(Element))
+          Container.const_set("#{values['element_class']}Collection", Class.new(ElementCollection) do
+            define_method('element_class') { eval(values['element_class']) }
+          end)
+        end
+      end
+    end
+
+    module Watir
+      # Expanding the case statement in the normalize_selector method to include custom attributes,
+      # since the custom element does not recognize all attributes by default.
+      class ElementLocator
+        alias :old_normalize_selector :normalize_selector
+
+        def normalize_selector(how, what)
+          case how
+            # supporting "name" attribute
+            when :name
+              [how, what]
+            else
+              old_normalize_selector(how, what)
+          end
+        end
+      end
+    end
+
+  end
+
+  if WatirCustomizeElements.modules['page_object']
+    # Adding each custom element to PageObject gem
+    WatirCustomizeElements.custom_elements.each do |key, values|
+      # Interacting with the element
+      Object.const_set(values['element_class'], Class.new(eval("PageObject::Elements::#{values['element_type']}")))
+
+      # Registering the class with the PageObject gem.
+      # register_widget accepts a tag which is used as the accessor (ex: mh_button), the class which is added to
+      # the Elements module (ex: MHButton), and a html element tag which is used as the html element (ex: mh_button).
+      PageObject.register_widget key.to_sym, eval(values['element_class']), key.to_sym
+    end
+  end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: watir-customize_elements
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Yehuda Miller, Shani Raby, Matan Goren, Ronnie Harpaz
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir-webdriver
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.11
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.6.11
+- !ruby/object:Gem::Dependency
+  name: page-object
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Automatically instantiates custom HTML tag names into watir-webdriver
+  and\or page-object gem.
+email:
+- matan.goren@myheritage.com
+- yehuda.miller@myheritage.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- example_custom_elements.yml
+- lib/watir-customize_elements.rb
+homepage: https://github.com/myheritage/watir-customize_elements
+licenses:
+- Apache-2.0
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: Gem for adding custom elements to Watir-webdriver and page-object gem
+test_files: []