capybara-select-2 0.4.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 01f1574cc4400755884d066349b52d23174b5b61634c9baff7e5332e83687654
-  data.tar.gz: 5614b845dc929345d9463b7e9de2fdebe483071b5423ff5b0a376add3ac08e5d
+SHA1:
+  metadata.gz: 35a699d3e0d5eec84d768a123c94ba5480793e43
+  data.tar.gz: da4ddebbf20ea31461c6fb5be32b3ef3d7a3e6b1
 SHA512:
-  metadata.gz: 7ebe35a60da59411376f3e473d479fde65b05bd1186caef104b8745564fc5afbe21815bd1f0504a83cb1ba3bd15ae4ead119d4182af5978be9341f5b1591cc61
-  data.tar.gz: 0cd9d2747b433bbdefd1ad926dbddb35f0790ae10a48206666dc43441a3ab3fd3d7afb03ca2816062972c1c3a6e37dcf1a4ed6858dab95ddefa56f045153f235
+  metadata.gz: cc85290a29be0951fa40e6a763ce2f526c59cb6d4c7e438f1e82c7a1a1ed25826464d783774b9b8142f108d8615b6f56e7ca5c5584f42ba594bc9d6683c80040
+  data.tar.gz: 7c8324a51abda2745c5d1ce3f9ba0c88407801805f959b6890b41898fe8fa0eedd941ec44ce1685ccc08c971c3042ca156e67d8dcb512224c015181649ff6c20

data/.rspec

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

data/.travis.yml

@@ -1,8 +1,9 @@
 sudo: required
-dist: trusty
+dist: xenial
 language: ruby
 rvm:
   - 2.4.1
+  - 2.7.1
 before_install: gem install bundler -v 2.0.1
 env:
   global:

data/README.md

@@ -19,73 +19,157 @@ And then execute:
 
     $ bundle
 
-Or install it yourself as:
+Or install it with `gem install` command:
 
     $ gem install capybara-select-2
 
-[Note] In the projects which use RSpec or Cucumber `select2` helper is available out of the box
+## Configuration
 
-### Manual installation with Rspec
+### Minitest
 
-In your spec_helper.rb
+```ruby
+# application_system_test_case.rb
+class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
+  include CapybaraSelect2
+  include CapybaraSelect2::Helpers # if need specific helpers
+end
+```
+
+### Rspec
 
 ```ruby
+# spec_helper.rb
 RSpec.configure do |config|
   config.include CapybaraSelect2
+  config.include CapybaraSelect2::Helpers # if need specific helpers
 end
 ```
+[Note] In RSpec tests `select2` helper is available out of the box
 
-### Manual installation with Cucumber
-
-In your env.rb
+### Cucumber
 
 ```ruby
+# env.rb
 World CapybaraSelect2
+World CapybaraSelect2::Helpers # if need specific helpers
 ```
 
 ## Usage
 
-### Select from a node containing select2 control
+### Examples
 
-* Identified by CSS selector
 ```ruby
+select2 'Buy Milk', from: 'Todo'
 select2 'Buy Milk', css: '#todo'
+select2 'Buy Milk', xpath: '//div[@id="todo"]'
 ```
 
-* Identified by XPath selector
+#### Selecting two or more options
+
 ```ruby
-select2 'Buy Milk', xpath: '//div[@id="todo"]'
+select2 'Buy Milk', 'Go to gym', from: 'Todo'
 ```
 
-### Select from select2 control identified by label
+#### Searching
+
 ```ruby
-select2 'Buy Milk', from: 'Things to do'
+select2 'Buy Milk', from: 'Todo', search: true
 ```
 
-If you want to search for an option (via Ajax for example)
+#### Searching by text different than an option text
+
+```
+select2 'Buy Milk', from: 'Todo', search: 'Buy'
+```
+
+#### Tagging
+
 ```ruby
-select2 'Buy Milk', from: 'Things to do', search: true
+select2 'Go to gym', from: 'Todo', tag: true
 ```
 
-### Dynamically create an option from search input 
+#### Resolving ambiguous match
+
 ```ruby
-select2 'Millennials', from: 'Generations', tag: true
+# Select the first matching option if there are two or more options with text 'Buy'
+select2 'Buy', from: 'Todo', match: :first
 ```
 
-### Select several options at once
+#### Selecting an option by exact text
+
 ```ruby
-select2 'Buy Milk', 'Go to gym', css: '#todo'
+# Select 'Eat' if there are two or more options with text 'Eat' ('Eat', 'Eat salad')
+select2 'Eat', from: 'Todo', exact_text: true
 ```
 
-### Add match strategy in case of ambiguous results
+[Note] CSS and XPath selectors must identify an HTML node that wraps select2 element or a select2 element itself (an HTML element with the `.select2-container` class)
+
+### Options
+
+Option | Purpose
+:------|:-------
+`css` | Identify select2 element by a CSS selector
+`xpath` | Identify select2 element by an XPath selector
+`from` | Identify select2 element by a label
+`label` | Identify select2 element by a label
+`search` | Search for an option by the passed string. Search by an option text if `true` is passed
+`tag` | Create an option
+`match` | Specifies Capybara's [matching strategy](https://github.com/teamcapybara/capybara#strategy) when selecting an option
+`exact_text` | Whether an option text must match exactly
+
+### Helpers
+
+Specific select2 helpers that allow more refined access to a select2 control
+
 ```ruby
-select2 'Buy Milk', from: 'Things to do', search: true, match: :first
+select2_open label: 'Todo'
+select2_close
+select2_search 'Milk', css: '#todo'
+select2_select 'Buy Milk', from: 'Todo'
+select2_clear xpath: "//div[@id='todo']"
 ```
 
-### Check for select2 option on the page
+Helper | Purpose | Options
+:------|:--------|:-------
+`select2_open(options)` | Open select2 control | `label`, `css`, `xpath`
+`select2_close` | Close select2 control | -
+`select2_search(term, options)` | Type into a select2 search field | `label`, `from`, `css`, `xpath`
+`select2_select(value, options)` | Select an option from an opened select2 control | `label`, `from`, `css`, `xpath`, `match`, `exact_text`
+`select2_clear(options)` | Remove selected options (for multi select only) | `label`, `from`, `css`, `xpath`
+
+See description for each option in the [Options](https://github.com/Hirurg103/capybara_select2#options) section
+
+[Note] Helpers above are not available in tests by default. To use them include `CapybaraSelect2::Helpers` in your test invironment (see [Configuration section](https://github.com/Hirurg103/capybara_select2#configuration))
+
+### RSpec matchers
+
 ```ruby
-expect(page).to have_select2_option('Buy Milk')
+# Check that a select2 option with specified text is present on the page
+expect(page).to have_select2_option 'Buy Milk'
+```
+
+## Testing
+
+### See test examples
+
+To see test examples for a specific select2 version, start Sinatra app first:
+
+```bash
+$ rackup spec/support/select2_examples/config.ru
 ```
+
+Visit http://localhost:9292/select2/v4.0.5/examples in your browser to see examples for select2 version `4.0.5`
+
+### Running tests
+
+```bash
+# run spec cases for all select2 versions
+$ bundle exec rspec
+
+# run spec cases for a specific select2 version
+$ SELECT2_VERSION=4.0.5 bundle exec rspec spec/shared
+```
+
 ## Contributing
 
 1. Add a test case which covers the bug

data/capybara_select2.gemspec

@@ -27,13 +27,14 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "capybara", "~> 3.12"
-  spec.add_development_dependency "chromedriver-helper", "~> 2.1"
-  spec.add_development_dependency "selenium-webdriver", "~> 3.141.0"
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "rspec", "~> 3.9"
+  spec.add_development_dependency "capybara", "~> 3.31"
+  spec.add_development_dependency "selenium-webdriver", "~> 3.142"
+  spec.add_development_dependency "webdrivers", "~> 4.2"
   spec.add_development_dependency "capybara-screenshot" , "~> 1.0"
-  spec.add_development_dependency "puma", "~> 3.12"
-  spec.add_development_dependency "pry", "~> 0.11.0"
-  spec.add_development_dependency "simplecov", "~> 0.16"
+  spec.add_development_dependency "puma", "~> 4.3"
+  spec.add_development_dependency "pry", "~> 0.12"
+  spec.add_development_dependency "simplecov", "~> 0.18"
+  spec.add_development_dependency "sinatra", "~> 2.0"
 end

data/lib/capybara_select2.rb

@@ -1,8 +1,32 @@
 require "capybara_select2/version"
+require 'capybara_select2/utils'
 require 'capybara_select2/helpers'
 
 module CapybaraSelect2
-  include Helpers
+
+  def select2(*args)
+    options = args.pop
+    values = args
+
+    Utils.validate_options!(options)
+
+    container = Utils.find_select2_container(options, page)
+    version = Utils.detect_select2_version(container)
+    options_with_select2_details =
+      options.merge({ container: container, version: version, page: page })
+
+    values.each do |value|
+      Helpers.select2_open(options_with_select2_details)
+
+      if options[:search] || options[:tag]
+        term = options[:search].is_a?(String) ? options[:search] : value
+        Helpers.select2_search(term, options_with_select2_details)
+      end
+
+      Helpers.select2_select(value, options_with_select2_details)
+    end
+  end
+
 end
 
 if defined?(RSpec)

data/lib/capybara_select2/helpers.rb

@@ -1,32 +1,54 @@
 require 'capybara_select2/utils'
+require 'capybara_select2/selectors'
 
 module CapybaraSelect2
   module Helpers
+    module_function
 
-    def select2(*args)
-      options = args.pop
-      values = args
+    def select2_open(options)
+      options = Utils.set_option_aliases(options)
+      Utils.validate_options!(options)
+
+      _, container, version = Utils.get_page_container_and_version(options, self)
+      opener_selector = Selectors.opener_selector(version)
+
+      container.find(:css, opener_selector).click
+    end
+
+    def select2_close(options = {})
+      page.find(:css, 'body').click
+    end
+
+    def select2_search(text, options)
+      options = Utils.set_option_aliases(options)
+      Utils.validate_options!(options)
+
+      page, _, version = Utils.get_page_container_and_version(options, self)
+      search_input_selector = Selectors.search_input_selector(version)
+
+      page.find(:xpath, '//body').find(:css, search_input_selector).set text
+    end
 
+    def select2_select(value, options)
       Utils.validate_options!(options)
 
-      select2_container = Utils.find_select2_container(options, page)
-      select2_version = Utils.detect_select2_version(select2_container)
+      page, _, version = Utils.get_page_container_and_version(options, self)
+      option_selector = Selectors.option_selector(version)
 
-      opener_selector = Selectors.opener_selector(select2_version)
-      option_selector = Selectors.option_selector(select2_version)
+      find_options = options.select { |k, _| [:match, :exact_text].include?(k) }
+      find_options = find_options.merge(text: value)
 
-      values.each do |value|
-        select2_container.find(:css, opener_selector).click
+      page.find(:xpath, '//body').find(:css, option_selector, **find_options).click
+    end
+
+    def select2_clear(options)
+      options = Utils.set_option_aliases(options)
+      Utils.validate_options!(options)
 
-        if options[:search] || options[:tag]
-          search_input_selector = Selectors.search_input_selector(select2_version)
-          find(:xpath, '//body').find(:css, search_input_selector).set value
-        end
+      _, container, version = Utils.get_page_container_and_version(options, self)
+      remove_option_selector = Selectors.remove_option_selector(version)
 
-        find_options = { text: value }
-        find_options[:match] = options[:match] if options[:match]
-        find(:xpath, '//body').find(:css, option_selector, find_options).click
-      end
+      container.all(remove_option_selector).map(&:click)
     end
 
   end

data/lib/capybara_select2/selectors.rb

@@ -26,13 +26,23 @@ module CapybaraSelect2
 
     OptionSelectors = {
       '2' => ".select2-container-active .select2-result",
-      '3' => ".select2-drop-active .select2-result",
-      '4' => ".select2-results .select2-results__option[role='treeitem']"
+      '3' => ".select2-drop-active .select2-result-label",
+      '4' => ".select2-results .select2-results__option:not([role='group'])"
     }.freeze
 
     def option_selector(select2_version)
       OptionSelectors.fetch(select2_version)
     end
 
+    RemoveOptionSelectors = {
+      '2' => '.select2-search-choice-close',
+      '3' => '.select2-search-choice-close',
+      '4' => '.select2-selection__choice__remove'
+    }.freeze
+
+    def remove_option_selector(select2_version)
+      RemoveOptionSelectors.fetch(select2_version)
+    end
+
   end
 end

data/lib/capybara_select2/utils.rb

@@ -1,6 +1,10 @@
 module CapybaraSelect2
   module Utils
 
+    def self.set_option_aliases(options)
+      options.dup.tap { |o| o[:from] ||= o[:label] }
+    end
+
     def self.detect_select2_version(container)
       if container['class'] =~ /^select2\s/
         '4'
@@ -35,5 +39,13 @@ module CapybaraSelect2
       end
     end
 
+    def self.get_page_container_and_version(options, context)
+      page = options[:page] || context.page
+      container = options[:container] || find_select2_container(options, page)
+      version = options[:version] || detect_select2_version(container)
+
+      [page, container, version]
+    end
+
   end
 end

data/lib/capybara_select2/version.rb

@@ -1,3 +1,3 @@
 module CapybaraSelect2
-  VERSION = "0.4.0"
+  VERSION = "0.5.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-select-2
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Dzmitry Kavalionak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-10 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -30,70 +30,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
   name: capybara
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.31'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '3.31'
 - !ruby/object:Gem::Dependency
-  name: chromedriver-helper
+  name: selenium-webdriver
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.142'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.1'
+        version: '3.142'
 - !ruby/object:Gem::Dependency
-  name: selenium-webdriver
+  name: webdrivers
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.141.0
+        version: '4.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.141.0
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: capybara-screenshot
   requirement: !ruby/object:Gem::Requirement
@@ -114,42 +114,56 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.12'
+        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.12'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.11.0
+        version: '0.12'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 description: 
 email:
 - dzm.kov@gmail.com
@@ -170,8 +184,6 @@ files:
 - bin/console
 - bin/setup
 - capybara_select2.gemspec
-- ci/install-chrome
-- ci/install-chromedriver
 - lib/capybara-select-2.rb
 - lib/capybara_select2.rb
 - lib/capybara_select2/helpers.rb
@@ -199,7 +211,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.2
+rubyforge_project: 
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Capybara helpers for https://select2.org select box (supports Select2 versions

data/ci/install-chrome

@@ -1,11 +0,0 @@
-#!/bin/bash
-
-set -xe
-wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add -
-echo "deb http://dl.google.com/linux/chrome/deb/ stable main" > /etc/apt/sources.list.d/google.list
-
-# Update packages
-apt-get update -yqqq
-
-# Install Chrome browser
-apt-get install -y google-chrome-stable

data/ci/install-chromedriver

@@ -1,23 +0,0 @@
-#!/bin/bash
-
-set -xe
-
-# Update packages
-apt-get update -yqqq
-
-# Install Chrome browser
-apt-get install -y unzip
-
-# Install/use specific version of chrome if an installed version is lower
-install_chromedriver() {
-  wget -O $TMPDIR/chromedriver.zip https://chromedriver.storage.googleapis.com/${MIN_CHROMEDRIVER_VER}/chromedriver_linux64.zip
-  mkdir -p $HOME/.chromedriver
-  (cd $HOME/.chromedriver && unzip $TMPDIR/chromedriver.zip && chmod +x chromedriver)
-  rm -f $TMPDIR/chromedriver.zip
-  ln -s $HOME/.chromedriver/chromedriver /usr/local/bin/chromedriver
-}
-if ! which chromedriver; then
-  install_chromedriver
-elif dpkg --compare-versions `chromedriver --version | cut -d " " -f2` lt $MIN_CHROMEDRIVER_VER; then
-  install_chromedriver
-fi