watir_css 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b6f07dd5e75eeda87032565d7a935dd18dd81f20
+  data.tar.gz: b430308783605df302565a8184735645b7250f28
+SHA512:
+  metadata.gz: ea6d64b1471d18104fd43ff246f6244c0439b8ecadf419b1c64b24c37ddc45417ec2f0128a78d0a0ec49f86fe437d7c8fbd51c365824c9cc0d8fd49c178f3fad
+  data.tar.gz: bcadc60e3fc40afb296fe3db22d1aa212fd18883c0f53c6a6f30ea23b00da3f06bf370b4dd7ae554fe9b85b0e0167092bbec59336aa9e3180a33c9c662c91c39

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "spec/watirspec"]
+	path = spec/watirspec
+	url = https://github.com/watir/watirspec

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in watir_css.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Titus Fortner
+
+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,80 @@
+# WatirCss
+
+CSS-based locator engine for [watir-webdriver](https://github.com/watir/watir-webdriver).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'watir_css'
+```
+
+And then execute:
+
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+
+```bash
+$ gem install watir_css
+```
+
+## Usage
+
+Require after watir-webdriver, the rest should just work.
+
+```ruby
+require 'watir-webdriver'
+require 'watir_css'
+```
+
+## Comparison with default watir-webdriver locator
+
+By default Watir converts calls into XPath; this gem will replace XPath calls
+with CSS calls where possible.
+
+This functionality used to be present directly in watir-webdriver. During
+the transition to Watir 6.0, a hook was included in the repository to 
+allow for alternate locator strategies.
+
+This gem replaces:
+
+```ruby
+Watir.prefer_css
+```
+
+## Limitations
+
+Some watir-webdriver locators cannot be reimplemented with watir_css. In such cases,
+it fall backs to watir-webdriver, so you should be able to migrate pretty easily.
+
+## Development
+
+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).
+
+## Specs
+
+Watir_css uses [watirspec](https://github.com/watir/watirspec) for testing, so
+you should first fetch it:
+
+```bash
+$ git submodule init && git submodule update
+```
+
+Now, you can run all specs:
+
+```bash
+$ bundle exec rake spec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/watir/watir_css.
+This project is intended to be a safe, welcoming space for collaboration,
+and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.

data/Rakefile

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

data/lib/watir_css/locators/element/locator.rb

@@ -0,0 +1,9 @@
+module WatirCss
+  module Locators
+    class Element
+      class Locator < Watir::Locators::Element::Locator
+
+      end
+    end
+  end
+end

data/lib/watir_css/locators/element/selector_builder/css.rb

@@ -0,0 +1,65 @@
+module WatirCss
+  module Locators
+    class Element
+      class SelectorBuilder
+        class CSS
+
+          def build(selectors)
+            return unless use_css?(selectors)
+
+            if selectors.empty?
+              css = '*'
+            else
+              css = ''
+              css << (selectors.delete(:tag_name) || '')
+
+              klass = selectors.delete(:class)
+              if klass
+                if klass.include? ' '
+                  css << %([class="#{css_escape klass}"])
+                else
+                  css << ".#{klass}"
+                end
+              end
+
+              href = selectors.delete(:href)
+              if href
+                css << %([href~="#{css_escape href}"])
+              end
+
+              selectors.each do |key, value|
+                key = key.to_s.tr("_", "-")
+                css << %([#{key}="#{css_escape value}"]) # TODO: proper escaping
+              end
+            end
+
+            [:css, css]
+          end
+
+          private
+
+          def use_css?(selectors)
+            if selectors.key?(:text) || selectors.key?(:label) || selectors.key?(:index)
+              return false
+            end
+
+            if selectors[:tag_name] == 'input' && selectors.key?(:type)
+              return false
+            end
+
+            if selectors.key?(:class) && selectors[:class] !~ /^[\w-]+$/ui
+              return false
+            end
+
+            true
+          end
+
+          def css_escape(str)
+            str.gsub('"', '\\"')
+          end
+
+        end
+      end
+    end
+  end
+end

data/lib/watir_css/locators/element/selector_builder.rb

@@ -0,0 +1,25 @@
+module WatirCss
+  module Locators
+    class Element
+      class SelectorBuilder < Watir::Locators::Element::SelectorBuilder
+
+        def css_builder
+          @css_builder ||= CSS.new
+        end
+
+        private
+
+        def build_wd_selector(selectors)
+          unless selectors.values.any? { |e| e.is_a? Regexp }
+            build_css(selectors) || build_xpath(selectors)
+          end
+        end
+
+        def build_css(selectors)
+          css_builder.build(selectors)
+        end
+
+      end
+    end
+  end
+end

data/lib/watir_css/locators/element/validator.rb

@@ -0,0 +1,8 @@
+module WatirCss
+  module Locators
+    class Element
+      class Validator < Watir::Locators::Element::Validator
+      end
+    end
+  end
+end

data/lib/watir_css/version.rb

@@ -0,0 +1,3 @@
+module WatirCss
+  VERSION = "0.1.0"
+end

data/lib/watir_css.rb

@@ -0,0 +1,15 @@
+require 'watir'
+
+require 'watir_css/locators/element/locator'
+require 'watir_css/locators/element/selector_builder'
+require 'watir_css/locators/element/selector_builder/css'
+require 'watir_css/locators/element/validator'
+require 'watir_css/version'
+
+Watir.locator_namespace = WatirCss::Locators
+
+WatirCss::Locators::Button = Watir::Locators::Button
+WatirCss::Locators::Cell      = Watir::Locators::Cell
+WatirCss::Locators::Row       = Watir::Locators::Row
+WatirCss::Locators::TextArea  = Watir::Locators::TextArea
+WatirCss::Locators::TextField = Watir::Locators::TextField

data/watir_css.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'watir_css/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "watir_css"
+  spec.version       = WatirCss::VERSION
+  spec.authors       = ["Titus Fortner"]
+  spec.email         = ["titusfortner@gmail.com"]
+
+  spec.summary       = %q{CSS locator engine for Watir}
+  spec.description = <<-DESCRIPTION_MESSAGE
+By default Watir converts calls into XPath; this gem will replace XPath calls
+with CSS calls where possible.
+DESCRIPTION_MESSAGE
+
+  spec.homepage      = "https://github.com/watir/watir_css"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'watir', '>= 6.0.0.beta2'
+  spec.add_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'sinatra' # watirspec
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: watir_css
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Titus Fortner
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: watir
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.0.0.beta2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: sinatra
+  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'
+description: |
+  By default Watir converts calls into XPath; this gem will replace XPath calls
+  with CSS calls where possible.
+email:
+- titusfortner@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/watir_css.rb
+- lib/watir_css/locators/element/locator.rb
+- lib/watir_css/locators/element/selector_builder.rb
+- lib/watir_css/locators/element/selector_builder/css.rb
+- lib/watir_css/locators/element/validator.rb
+- lib/watir_css/version.rb
+- watir_css.gemspec
+homepage: https://github.com/watir/watir_css
+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: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: CSS locator engine for Watir
+test_files: []