edsl 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c9f097097fb3758a17ebdf2773fad9a81db56ae733288676e8e8ed04ea53cdd9
+  data.tar.gz: e385e0e3eb350e6bc4e5f61f8492408b92fdfd071196be2c667d2393e41a8f12
+SHA512:
+  metadata.gz: 326e347590d35861c9a2470a774bb0e24287578990907a9770d34c0e993f38461cfeee07249303e67a6894eb76a02a04e7af06249433eb6cb176c645e7f68d4e
+  data.tar.gz: a5ce2cc40b44e3d2a3fff8dcdff72b3737f41087056cf7d79b4ed484e07c69650f5a4c1959f82710e81cf0a39ff7e2b5fac2459583b60a14765237057efd768e

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/.idea/
+
+# rspec failure tracking
+.rspec_status
+Gemfile.lock

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,27 @@
+# Offense count: 1
+Lint/Debugger:
+  Exclude:
+    - 'bin/console'
+
+
+Style/FrozenStringLiteralComment:
+  Exclude:
+    - 'Gemfile'
+    - 'Rakefile'
+
+Metrics/LineLength:
+  Max: 140
+  IgnoredPatterns: ['(\A|\s)#','Nenv\.']
+
+Metrics/PerceivedComplexity:
+  Max: 8
+
+Layout/FirstParameterIndentation:
+  Enabled: false
+
+# Robocop misses when we have an out variable so don't let it 'fix' things.
+Lint/UnusedMethodArgument:
+  AutoCorrect: false
+
+Metrics/MethodLength:
+  Max: 25

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.2
+before_install: gem install bundler -v 1.16.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at donavan.stanley@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in edsl.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Donavan Stanley
+
+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.

data/README.md

@@ -0,0 +1,48 @@
+# EDSL
+
+This gem implements an extensible DSL for implementing the page object, pattern.
+It is very similar to PageObject and can almost be used as a drop-in replacement for it.
+However, this gem focuses the element DSL portion only.
+
+This gem was created to simplify the process of creating abstractions for web automation.
+Because EDSL is easy to extend, you can create custom DSL methods that are first class citizens
+
+This is still very much a work in progress.  Primary documentation can be found in code comments for now.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'edsl'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install edsl
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/edsl. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Edsl project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/edsl/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'edsl'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+browser = Watir::Browser.new :chrome
+browser.goto 'https://www.google.com'
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+require 'pry'
+Pry.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/edsl.gemspec

@@ -0,0 +1,38 @@
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'edsl/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'edsl'
+  spec.version       = EDSL::VERSION
+  spec.authors       = ['Donavan Stanley']
+  spec.email         = ['donavan.stanley@gmail.com']
+
+  spec.summary       = 'An easy to extend DSL for web elements'
+  spec.description   = 'Page object pattern without PageObject'
+  spec.homepage      = 'https://github.com/jdonavan'
+  spec.license       = 'MIT'
+
+  spec.metadata['homepage_uri'] = spec.homepage
+  spec.metadata['source_code_uri'] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rubocop'
+
+  spec.add_runtime_dependency 'watir'
+  spec.add_runtime_dependency 'cpt_hook'
+  spec.add_runtime_dependency 'facets'
+end

data/lib/edsl/dsl.rb

@@ -0,0 +1,111 @@
+# Root module for the gem
+require 'cpt_hook'
+
+module EDSL
+  # Ensure the DSL methods are applied when we're included
+  def self.included(cls)
+    cls.extend EDSL::DSL
+
+    cls.send(:define_method, :resolve_with) do |with_var|
+      return self if with_var == :page
+      return :self if with_var == :element
+      with_var
+    end
+
+    cls.send(:define_method, :apply_hooks) do |hook_defs, element|
+      return nil if element.nil?
+      return element if hook_defs.nil?
+      hd = hook_defs.dup
+      hd.hooks.each { |hook| hook.call_chain.each { |cc| cc.resolve_with { |c| resolve_with(c) } } }
+      hd.hooks.each { |hook| hook.call_chain.each { |cc| cc.resolve_contexts { |c| resolve_with(c) } } }
+      CptHook::Hookable.new(element, hd, self)
+    end
+  end
+
+  # Use a block to add new methods to the DSL.
+  def self.extend_dsl(&block)
+    EDSL::DSL.class_eval(&block)
+  end
+
+  # Define a new accessor using a name and options.
+  # See the DSL module for more info
+  def self.define_accessor(acc_name, default_opts)
+    DSL.define_accessor(acc_name, default_opts)
+  end
+
+  # These methods will be extended into any class which includes EDSL.
+  # They provide a mechanism for declaring HTML elements as properties of another object
+  module DSL
+    # This is the core accessor on which everything else is based.
+    # Given a name and some options this will generate the following methods:
+    #   name - Executes the method found in the :default_method option, or the element itself if none provided.
+    #   name= - Executes the method found in the :assign_method option, passing it the value. (optional).
+    #   name? - Executes the method found in the :presence_method option, or present?
+    #
+    # For example a text field would look like this:
+    #   element(:username, id: 'some_id', how: :text_field, default_method: :value, assign_method: :set)
+    #
+    # The :how option can either be something that is sendable. or a proc
+    #   If send is used, the options will be passed on to the method.
+    #   If a proc is used it will be called with the name and opts param as well as the container
+    #
+    # A text field could be declared like this:
+    #  element(:username, id: 'some_id', how: Proc.new { |name, container, opts| container.text_field(opts) }, default_method: :value, assign_method: :set)
+    #
+    def element(name, opts)
+      how = opts.delete(:how)
+      default_method = opts.delete(:default_method)
+      assign_method = opts.delete(:assign_method)
+      presence_method = opts.delete(:presence_method) || :present?
+      hooks = opts.delete(:hooks)
+      wrapper_fn = opts.delete(:wrapper_fn) || lambda { |_e, _p| return _e }
+
+      ele_meth = "#{name}_element"
+      define_method(ele_meth) do
+        ele = yield name, self, opts if block_given?
+        ele ||= how.call(name, self, opts) if how.is_a?(Proc)
+        ele ||= send(how, opts)
+        ele = wrapper_fn.call(ele, self)
+        hooks.nil? ? ele : send(:apply_hooks, hooks, ele)
+      end
+
+      define_method(name) do
+        return default_method.call(name, self) if default_method.is_a?(Proc)
+        default_method.nil? ? send(ele_meth) : send(ele_meth).send(default_method)
+      end
+
+      define_method("#{name}?") do
+        send(ele_meth).send(presence_method)
+      end
+
+      return unless assign_method
+
+      define_method("#{name}=") do |value|
+        send(ele_meth).send(assign_method, value)
+      end
+    end
+
+    # This vastly simplifies defining custom accessors.
+    # If we had to use the base element method for every field that would be tedious.
+    # This method allows us to extend the DSL to add a shorthand method for elements.
+    #
+    # If we extend the DSL like this:
+    #   EDSL.define_accessor(:text_field, how: :text_field, default_method: :value, assign_method: :set)
+    # Then we can use an easier syntax to declare a text field
+    #   text_field(:username, id: 'some_id')
+    #
+    def self.define_accessor(acc_name, default_opts)
+      self.class.send(:define_method, acc_name) do |name, opts = {}, &block|
+        element(name, default_opts.merge(opts), &block)
+      end
+    end
+
+    def self.alias_accessor(new_name, acc_name)
+      self.class.send(:alias_method, new_name, acc_name)
+    end
+
+    def self.define_accessors(accessor_array)
+      accessor_array.each { |acc| define_accessor(*acc) }
+    end
+  end
+end

data/lib/edsl/element_container.rb

@@ -0,0 +1,24 @@
+require 'delegate'
+module EDSL
+  # This serves as a handy base class for custom elements, page objects and page sections
+  # as this inherits from SimpleDelegator any call that would be valid on the root element
+  # or browser is valid on the container object.
+  #
+  # Using this base class is not a requirement, however code in some modules may assume that
+  # methods in this class are available.
+  #
+  # This allows your object to serve as a proxy for the Watir::Container and be have an API
+  # consistent with other elements
+  #
+  class ElementContainer < ::SimpleDelegator
+    include EDSL
+
+    attr_reader :parent_container
+    alias_method :root_element, :__getobj__
+
+    def initialize(element, parent = nil)
+      super(element)
+      @parent_container = parent
+    end
+  end
+end

data/lib/edsl/version.rb

@@ -0,0 +1,3 @@
+module EDSL
+  VERSION = '0.1.0'.freeze
+end

data/lib/edsl/watir_elements.rb

@@ -0,0 +1,19 @@
+module EDSL
+  # This module extends the DSL to include the various Watir elements
+  module WatirElements
+    SPECIAL_ELEMENTS = %i[button a radio_set input select textarea].freeze
+
+    Watir.tag_to_class.keys.reject { |k| SPECIAL_ELEMENTS.include?(k) }.each do |tag|
+      EDSL.define_accessor(tag, how: tag, default_method: :text)
+    end
+
+    CLICKABLE_ELEMENTS = %i[button a link].freeze
+    CLICKABLE_ELEMENTS.each { |tag| EDSL.define_accessor(tag, how: tag, default_method: :click) }
+
+    CONTENT_EDITABLE_ELEMENTS = %i[text_field textarea text_area].freeze
+    CONTENT_EDITABLE_ELEMENTS.each { |tag| EDSL.define_accessor(tag, how: tag, default_method: :value, assign_method: :set) }
+
+    SETABLE_ELEMENTS = %i[radio checkbox].freeze
+    SETABLE_ELEMENTS.each { |tag| EDSL.define_accessor(tag, how: tag, default_method: :set?, assign_method: :set) }
+  end
+end

data/lib/edsl.rb

@@ -0,0 +1,5 @@
+require 'edsl/version'
+require 'watir'
+require 'edsl/dsl'
+require 'edsl/element_container'
+require 'edsl/watir_elements'

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: edsl
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Donavan Stanley
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-10-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: watir
+  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'
+- !ruby/object:Gem::Dependency
+  name: cpt_hook
+  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'
+- !ruby/object:Gem::Dependency
+  name: facets
+  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: Page object pattern without PageObject
+email:
+- donavan.stanley@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- edsl.gemspec
+- lib/edsl.rb
+- lib/edsl/dsl.rb
+- lib/edsl/element_container.rb
+- lib/edsl/version.rb
+- lib/edsl/watir_elements.rb
+homepage: https://github.com/jdonavan
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/jdonavan
+  source_code_uri: https://github.com/jdonavan
+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.7.7
+signing_key: 
+specification_version: 4
+summary: An easy to extend DSL for web elements
+test_files: []