capybara-select-2 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: aaba1602e5f227889734248ce001fe00831ead8a
-  data.tar.gz: ddbe5b57d2cb74225f29c034c12a1466c7e55804
+  metadata.gz: 35a699d3e0d5eec84d768a123c94ba5480793e43
+  data.tar.gz: da4ddebbf20ea31461c6fb5be32b3ef3d7a3e6b1
 SHA512:
-  metadata.gz: e8c3a064c252b1d3fe56c3642e8e6920061ff866d34b5752f237f75c71172299af60201f2afd56518db482bfc08878cac08706e804dc24467e017244088618fa
-  data.tar.gz: 48253431a5c902523dfc031a615b160db8f5ed849b860a8ce8d7a8d2a1a83a33333f9936ffdf3f434995dd96befb66e25a4ce0cc00e624c269fb57e148739ad9
+  metadata.gz: cc85290a29be0951fa40e6a763ce2f526c59cb6d4c7e438f1e82c7a1a1ed25826464d783774b9b8142f108d8615b6f56e7ca5c5584f42ba594bc9d6683c80040
+  data.tar.gz: 7c8324a51abda2745c5d1ce3f9ba0c88407801805f959b6890b41898fe8fa0eedd941ec44ce1685ccc08c971c3042ca156e67d8dcb512224c015181649ff6c20

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

@@ -59,14 +59,47 @@ World CapybaraSelect2::Helpers # if need specific helpers
 ### Examples
 
 ```ruby
+select2 'Buy Milk', from: 'Todo'
 select2 'Buy Milk', css: '#todo'
 select2 'Buy Milk', xpath: '//div[@id="todo"]'
-select2 'Buy Milk', from: 'Things to do'
-select2 'Buy Milk', 'Go to gym', css: '#todo'
+```
+
+#### Selecting two or more options
 
-select2 'Buy Milk', from: 'Things to do', search: true
-select2 'Buy Milk', from: 'Things to do', search: 'Buy'
-select2 'Millennials', from: 'Generation', tag: true
+```ruby
+select2 'Buy Milk', 'Go to gym', from: 'Todo'
+```
+
+#### Searching
+
+```ruby
+select2 'Buy Milk', from: 'Todo', search: true
+```
+
+#### Searching by text different than an option text
+
+```
+select2 'Buy Milk', from: 'Todo', search: 'Buy'
+```
+
+#### Tagging
+
+```ruby
+select2 'Go to gym', from: 'Todo', tag: true
+```
+
+#### Resolving ambiguous match
+
+```ruby
+# Select the first matching option if there are two or more options with text 'Buy'
+select2 'Buy', from: 'Todo', match: :first
+```
+
+#### Selecting an option by exact text
+
+```ruby
+# Select 'Eat' if there are two or more options with text 'Eat' ('Eat', 'Eat salad')
+select2 'Eat', from: 'Todo', exact_text: true
 ```
 
 [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)
@@ -75,17 +108,18 @@ select2 'Millennials', from: 'Generation', tag: true
 
 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
-search | Search for an option by the passed string. Search by an option text if `true` 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
+`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 select2 control
+Specific select2 helpers that allow more refined access to a select2 control
 
 ```ruby
 select2_open label: 'Todo'
@@ -95,15 +129,17 @@ select2_select 'Buy Milk', from: 'Todo'
 select2_clear xpath: "//div[@id='todo']"
 ```
 
-Helper | Purpose
-:------|:-------
-select2_open | Open select2 control
-select2_close | Close select2 control
-select2_search | Type into a select2 search field
-select2_select | Select an option from an opened select2 control
-select2_clear | Remove selected options (for multi select only)
+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))
+[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
 

data/lib/capybara_select2.rb

@@ -12,17 +12,18 @@ module CapybaraSelect2
 
     container = Utils.find_select2_container(options, page)
     version = Utils.detect_select2_version(container)
-    extended_options = options.merge({ container: container, version: version, page: page })
+    options_with_select2_details =
+      options.merge({ container: container, version: version, page: page })
 
     values.each do |value|
-      Helpers.select2_open(extended_options)
+      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, extended_options)
+        Helpers.select2_search(term, options_with_select2_details)
       end
 
-      Helpers.select2_select(value, extended_options)
+      Helpers.select2_select(value, options_with_select2_details)
     end
   end
 

data/lib/capybara_select2/helpers.rb

@@ -6,13 +6,10 @@ module CapybaraSelect2
     module_function
 
     def select2_open(options)
-      options = options.dup
-      options[:from] ||= options[:label]
+      options = Utils.set_option_aliases(options)
       Utils.validate_options!(options)
 
-      _page = options[:page] || page
-      container = options[:container] || Utils.find_select2_container(options, _page)
-      version = options[:version] || Utils.detect_select2_version(container)
+      _, container, version = Utils.get_page_container_and_version(options, self)
       opener_selector = Selectors.opener_selector(version)
 
       container.find(:css, opener_selector).click
@@ -23,40 +20,32 @@ module CapybaraSelect2
     end
 
     def select2_search(text, options)
-      options = options.dup
-      options[:from] ||= options[:label]
+      options = Utils.set_option_aliases(options)
       Utils.validate_options!(options)
 
-      _page = options[:page] || page
-      container = options[:container] || Utils.find_select2_container(options, _page)
-      version = options[:version] || Utils.detect_select2_version(container)
+      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
+      page.find(:xpath, '//body').find(:css, search_input_selector).set text
     end
 
     def select2_select(value, options)
       Utils.validate_options!(options)
 
-      _page = options[:page] || page
-      container = options[:container] || Utils.find_select2_container(options, _page)
-      version = options[:version] || Utils.detect_select2_version(container)
+      page, _, version = Utils.get_page_container_and_version(options, self)
       option_selector = Selectors.option_selector(version)
 
-      find_options = { text: value }
-      find_options[:match] = options[:match] if options[:match]
-      find_options[:exact_text] = options[:exact_text] if options[:exact_text]
+      find_options = options.select { |k, _| [:match, :exact_text].include?(k) }
+      find_options = find_options.merge(text: value)
 
-      _page.find(:xpath, '//body').find(:css, option_selector, find_options).click
+      page.find(:xpath, '//body').find(:css, option_selector, **find_options).click
     end
 
     def select2_clear(options)
-      options = options.dup
-      options[:from] ||= options[:label]
+      options = Utils.set_option_aliases(options)
       Utils.validate_options!(options)
 
-      container = Utils.find_select2_container(options, page)
-      version = Utils.detect_select2_version(container)
+      _, container, version = Utils.get_page_container_and_version(options, self)
       remove_option_selector = Selectors.remove_option_selector(version)
 
       container.all(remove_option_selector).map(&:click)

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.5.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.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Dzmitry Kavalionak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-12 00:00:00.000000000 Z
+date: 2020-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler