selenium_to_capybara 0.1.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ce0be055d93c2e620d876d89dfabc5cccdbcf688bc5ac95e3b98f98d8b907f1c
+  data.tar.gz: '0836aa609f702a67c5d96fdcd7555decab993e1398e1edfd57d88ba7796bf58b'
+SHA512:
+  metadata.gz: 51c0bb577207d6e1f352e178594d28eb0baf972dfd909d5842f96d6b4cc0efbe5890e83c9f3d924c8c5ea600192536508e65d3510240e8039aa8afebf0f48ea3
+  data.tar.gz: 55ea073c84ec06e178c420c30d52f2676e316a9d8b05d76b56bc9b95de49a1059aa4c8a7413f328668bd06815c3453c887b3d2512bb929b4d42af3cebd3bc8dc

data/.gitignore

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

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 benny@digitalbehr.de. 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 selenium_to_capybara.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Benjamin Behr
+
+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,90 @@
+# SeleniumToCapybara
+
+selenium2capybara translates a Selenium `.side` file into executable capybara tests. It is by no way meant to write the final system tests for you but take it as a good starting point.
+
+If you do this:
+
+`selenium2capybara path/to/saved/*.side`
+
+you may get that:
+
+```ruby
+test 'checkout' do
+  visit('/')
+
+  # css: .tile:nth-child(4)
+  # xpath: //a[contains(@href, '/products/P23A-S_FW1819')]
+  # xpath: //a[4]
+  find('.tile:nth-child(4)').click
+
+  # linkText: Buy now
+  # css: .buy
+  # xpath: //a[contains(text(),'Buy now')]
+  # xpath: //form[@id='new_product_item']/div/a
+  # xpath: //a[contains(@href, '#')]
+  # xpath: //form/div/a
+  click_on('Buy now')
+
+  # css: tr:nth-child(11) > td:nth-child(3)
+  # xpath: //form[@id='new_order']/div/div[3]/div/table/tbody/tr[11]/td[3]
+  # xpath: //tr[11]/td[3]
+  assert_selector('tr:nth-child(11) > td:nth-child(3)', text: '123.45 €')
+end
+```
+
+## Installation
+
+### ... as executable
+
+To run `selenium2capybara` install:
+
+    $ gem install selenium_to_capybara
+
+
+### ... as a library
+
+Add this line to your Gemfile:
+
+```ruby
+gem 'selenium_to_capybara'
+```
+
+And then execute:
+
+    $ bundle
+
+
+### Required Additional Installation
+
+In order to create the needed .side files the Selenium IDE plugin must be installed in your webbrowser.
+
+- [Chrome](https://chrome.google.com/webstore/detail/selenium-ide/mooikfkahbdckldjjndioackbalphokd)
+- [Firefox](https://addons.mozilla.org/en-US/firefox/addon/selenium-ide/)
+
+## Usage
+
+1. Create a test with the Selenium IDE plugin
+2. Save the test to the disk
+3. run `selenium2capybara path/to/saved/*.side`
+
+## Translation contribution
+
+The translations for minitest are currently placed in `lib/selenium_to_capybara/minitest.rb`. Feel free to add more or update the existing translations. To add a new translation open the `.side` file in your favourite text editor. It's a JSON file. Search for the command you want to add and define a new method with the name of the command in `minitest.rb`. For a more detailed description of how to add a new command translation please look at the `minitest.rb` file.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/DarkSwoop/selenium_to_capybara. 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 SeleniumToCapybara project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/DarkSwoop/selenium_to_capybara/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "selenium_to_capybara"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

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/exe/selenium2capybara

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+require 'json'
+require 'pathname'
+
+require 'selenium_to_capybara'
+
+file_path = ARGV[0]
+
+raise "must be a .side file" unless file_path.end_with?('.side')
+
+side_file = if file_path.start_with?('~')
+  Pathname.new(Dir.home).join(file_path.sub('^~/', ''))
+elsif file_path.start_with?('/')
+  Pathname.new(file_path)
+else
+  Pathname.getwd.join(file_path)
+end
+
+json = JSON.parse(side_file.read)
+
+json['tests'].each do |test_instance|
+  puts SeleniumToCapybara.to_minitest(test_instance['name'], test_instance['commands'])
+end

data/lib/selenium_to_capybara.rb

@@ -0,0 +1,24 @@
+require "selenium_to_capybara/version"
+require 'selenium_to_capybara/base'
+require 'selenium_to_capybara/minitest'
+
+module SeleniumToCapybara
+
+  def self.to_minitest(name, commands)
+    test_commands = commands.map do |command|
+      Minitest.new(command).translate
+    end
+
+    warning_present = test_commands.any? {|translation| translation.start_with?('# WARNING:')}
+
+    output = []
+    output << <<~EOS
+      test '#{name}' do
+      #{test_commands.map {|x| "  #{x.gsub(/\n/, "\n  ")}"}.join("\n\n")}
+      end
+    EOS
+    output << "\n# WARNING: Some commands are unhandled. Please contribute here: https://github.com/DarkSwoop/selenium_to_capybara" if warning_present
+    output.join("\n")
+  end
+
+end

data/lib/selenium_to_capybara/base.rb

@@ -0,0 +1,80 @@
+module SeleniumToCapybara
+    
+  class Base
+    attr_reader :side_command
+    def initialize(side_command)
+      @side_command = side_command
+    end
+
+    def target
+      @side_command['target']
+    end
+
+    def targets
+      @side_command['targets']
+    end
+
+    def value
+      @side_command['value']
+    end
+
+    def command
+      @side_command['command']
+    end
+
+    def comment
+      @side_command['comment']
+    end
+
+    def id
+      @side_command['id']
+    end
+
+    def selector_type
+      _selector_type(target)
+    end
+
+    def selector
+      _selector(target)
+    end
+
+    # returns the translation of the command or a warning if the command can't be translated
+    def translate
+      method_id = command.gsub(/([a-z])([A-Z])/, '\1_\2').downcase
+      if self.class.public_method_defined?(method_id)
+        # the translation itself
+        translation = public_send(method_id)
+        return "# WARNING: '#{command}' found but the selector_type '#{selector_type}' is unhandled." if translation.nil?
+
+        # add the alternative selectors as comments if present
+        if targets.size > 1
+          "#{commented_targets.join("\n")}\n#{translation}"
+        else
+          translation
+        end
+      else
+        "# WARNING: Conversion for '#{command}' not found."
+      end
+    end
+
+    private
+
+    def split_target(target)
+      /^(\w+)=(.*)$/.match(target)[1..2]
+    end
+
+    def _selector(target)
+      split_target(target).last
+    end
+
+    def _selector_type(target)
+      split_target(target).first
+    end
+
+    def commented_targets
+      targets.map { |target| "# #{_selector_type(target.first)}: #{_selector(target.first)}" }.uniq
+    end
+
+  end
+
+end

data/lib/selenium_to_capybara/minitest.rb

@@ -0,0 +1,58 @@
+module SeleniumToCapybara
+
+  # This class holds the translations for minitest.
+  #
+  # To add a translation you need to do the following steps:
+  # 1. Open the .side file and find the command you want to add
+  # 2. Define a method in the Minitest class with the command as name.
+  #    The command name must be translated to the ruby version of the name. `assertText` => `assert_text`
+  # 3. Define the translation
+  #
+  # The properties of the whole .side command object are accessible through ruby methods.
+  # - `target` is the preferred target selector of Selenium IDE
+  # - `targets` holds all possible target selectors identified by Selenium IDE
+  # - `selector_type` identifies the type of the preferred target selector (e.g css, xpath)
+  # - `selector` is the selector of the preferred target selector itself. (e.g 'body .header .title')
+  # - `value` e.g. the value that a text field should get
+  # - `command` the command name itself like `assertText` or `click`
+  # - `comment` a optional comment for that command
+  # - `id` the internal id generated by Selenium IDE
+  class Minitest < Base
+    def open
+      "visit('#{target}')"
+    end
+
+    def double_click
+      case selector_type
+      when 'css'
+        "find('#{selector}').double_click"
+      when 'id'
+        "find('##{selector}').double_click"
+      when 'xpath'
+        "find('#{selector}').double_click"
+      when 'name'
+        "find('[name=\"#{selector}\"]').double_click"
+      end
+    end
+
+    def click
+      case selector_type
+      when 'css'
+        "find('#{selector}').click"
+      when 'id'
+        "find('##{selector}').click"
+      when 'xpath'
+        "find('#{selector}').click"
+      when 'name'
+        "find('[name=\"#{selector}\"]').click"
+      when 'linkText'
+        "click_link_or_button('#{selector}')"
+      end
+    end
+
+    def assert_text
+      "assert_selector('#{selector}', text: '#{value}')"
+    end
+  end
+
+end

data/lib/selenium_to_capybara/version.rb

@@ -0,0 +1,3 @@
+module SeleniumToCapybara
+  VERSION = "0.1.4"
+end

data/selenium_to_capybara.gemspec

@@ -0,0 +1,24 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "selenium_to_capybara/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "selenium_to_capybara"
+  spec.version       = SeleniumToCapybara::VERSION
+  spec.authors       = ["Benjamin Behr"]
+  spec.email         = ["benny@digitalbehr.de"]
+
+  spec.summary       = %q{Translates selenium tests to capybara.}
+  spec.homepage      = "https://github.com/DarkSwoop/selenium_to_capybara"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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 "rake", "~> 10.0"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: selenium_to_capybara
+version: !ruby/object:Gem::Version
+  version: 0.1.4
+platform: ruby
+authors:
+- Benjamin Behr
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-12-15 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: 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'
+description: 
+email:
+- benny@digitalbehr.de
+executables:
+- selenium2capybara
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/selenium2capybara
+- lib/selenium_to_capybara.rb
+- lib/selenium_to_capybara/base.rb
+- lib/selenium_to_capybara/minitest.rb
+- lib/selenium_to_capybara/version.rb
+- selenium_to_capybara.gemspec
+homepage: https://github.com/DarkSwoop/selenium_to_capybara
+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.7.6
+signing_key: 
+specification_version: 4
+summary: Translates selenium tests to capybara.
+test_files: []