capybara-select-2 0.4.4 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 290340769eff7f3d173f8fadd371ab6e187d1dee
-  data.tar.gz: 925f123e77286152ddeb507aa60a60705b13501a
+  metadata.gz: aaba1602e5f227889734248ce001fe00831ead8a
+  data.tar.gz: ddbe5b57d2cb74225f29c034c12a1466c7e55804
 SHA512:
-  metadata.gz: a19857778408a22ec1b639a5bbcd0f2f2c84e7b1c71e581be01d20332895d3a4073323dcbf5e340172b6dba63dd3c4e7e96feb3e37dca318287afc23a516bf70
-  data.tar.gz: 3ea9a7d7f4ba02493067037c13ae937ab3c88429ced79f9a702e4c78d218989aec0d2d9903b1035ddffc5ad07e33e912e1135168cec12beaebc3d241637c8a77
+  metadata.gz: e8c3a064c252b1d3fe56c3642e8e6920061ff866d34b5752f237f75c71172299af60201f2afd56518db482bfc08878cac08706e804dc24467e017244088618fa
+  data.tar.gz: 48253431a5c902523dfc031a615b160db8f5ed849b860a8ce8d7a8d2a1a83a33333f9936ffdf3f434995dd96befb66e25a4ce0cc00e624c269fb57e148739ad9

data/README.md

@@ -30,7 +30,8 @@ Or install it with `gem install` command:
 ```ruby
 # application_system_test_case.rb
 class ApplicationSystemTestCase < ActionDispatch::SystemTestCase
-  include CapybaraSelect2::Helpers
+  include CapybaraSelect2
+  include CapybaraSelect2::Helpers # if need specific helpers
 end
 ```
 
@@ -40,6 +41,7 @@ end
 # 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
@@ -49,6 +51,7 @@ end
 ```ruby
 # env.rb
 World CapybaraSelect2
+World CapybaraSelect2::Helpers # if need specific helpers
 ```
 
 ## Usage
@@ -62,6 +65,7 @@ select2 'Buy Milk', from: 'Things to do'
 select2 'Buy Milk', 'Go to gym', css: '#todo'
 
 select2 'Buy Milk', from: 'Things to do', search: true
+select2 'Buy Milk', from: 'Things to do', search: 'Buy'
 select2 'Millennials', from: 'Generation', tag: true
 ```
 
@@ -74,11 +78,33 @@ 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
+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
 
+### Helpers
+
+Specific select2 helpers that allow more refined access to select2 control
+
+```ruby
+select2_open label: 'Todo'
+select2_close
+select2_search 'Milk', css: '#todo'
+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)
+
+[!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
@@ -105,7 +131,7 @@ Visit http://localhost:9292/select2/v4.0.5/examples in your browser to see examp
 $ bundle exec rspec
 
 # run spec cases for a specific select2 version
-$ VERSION=4.0.5 bundle exec rspec spec/shared
+$ SELECT2_VERSION=4.0.5 bundle exec rspec spec/shared
 ```
 
 ## Contributing

data/lib/capybara_select2.rb

@@ -1,8 +1,31 @@
 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)
+    extended_options = options.merge({ container: container, version: version, page: page })
+
+    values.each do |value|
+      Helpers.select2_open(extended_options)
+
+      if options[:search] || options[:tag]
+        term = options[:search].is_a?(String) ? options[:search] : value
+        Helpers.select2_search(term, extended_options)
+      end
+
+      Helpers.select2_select(value, extended_options)
+    end
+  end
+
 end
 
 if defined?(RSpec)

data/lib/capybara_select2/helpers.rb

@@ -3,32 +3,63 @@ require 'capybara_select2/selectors'
 
 module CapybaraSelect2
   module Helpers
+    module_function
 
-    def select2(*args)
-      options = args.pop
-      values = args
+    def select2_open(options)
+      options = options.dup
+      options[:from] ||= options[:label]
+      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)
+      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 = options.dup
+      options[:from] ||= options[:label]
+      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)
+      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 = options[:page] || page
+      container = options[:container] || Utils.find_select2_container(options, _page)
+      version = options[:version] || Utils.detect_select2_version(container)
+      option_selector = Selectors.option_selector(version)
 
-      opener_selector = Selectors.opener_selector(select2_version)
-      option_selector = Selectors.option_selector(select2_version)
+      find_options = { text: value }
+      find_options[:match] = options[:match] if options[:match]
+      find_options[:exact_text] = options[:exact_text] if options[:exact_text]
 
-      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 = options.dup
+      options[:from] ||= options[:label]
+      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 = Utils.find_select2_container(options, page)
+      version = Utils.detect_select2_version(container)
+      remove_option_selector = Selectors.remove_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(: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

@@ -34,5 +34,15 @@ module CapybaraSelect2
       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/version.rb

@@ -1,3 +1,3 @@
 module CapybaraSelect2
-  VERSION = "0.4.4"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capybara-select-2
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.0
 platform: ruby
 authors:
 - Dzmitry Kavalionak
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-04 00:00:00.000000000 Z
+date: 2020-03-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler