trln-chosen-rails 1.30.0.pre.beta2 → 1.30.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23826cc4c7f94087e884b174932078085d21c9a61287b6824fc9aea92e5137ce
-  data.tar.gz: 439977a37a3af72dbdc3fcefd80af1c108183d3a3ccab3256cf2b63dd5a71960
+  metadata.gz: 1768457fdcfb394e448a8a85b8fbcc4e0d56634fa7c94f8cb3e53d8c03e72b11
+  data.tar.gz: a8d92dc7ee82f68587e850afc0b14935da4f85339e802d66951c4d1c75c078e3
 SHA512:
-  metadata.gz: e50707c2e0747debf9b7061afc3e24ade8fe594e60d0c22e4590293f48ee93495830e0675296edfe12d7f6586559a97976b010f56b8778c8991958cd3d49dba3
-  data.tar.gz: 3955af4f2ef86168b4b686e7be1bd02ceb64ac6ffaca6d7709d16a012a27733220a8c30a308b9f9882c9f36a9fe805750b8fd831a00e46d123ce6536540c28be
+  metadata.gz: 95ad1b8d6333061fddfcd35aac6f38a8f8fcaa261d8f5df38b1529cfb04d968d11a2ffc1bfc118f008234a684599ad841968945e7c4630ba97c6bd35ffba60b8
+  data.tar.gz: 3c195e7157cff1a67ab3804f7ee4d996e064cce3474b1a566742e7a978bf839c37f9dcfe5eb326721f8491577d466310f2358a45ec6a99e0459bb8347d137d51

data/README.md

@@ -2,7 +2,15 @@
 
 [Chosen](https://github.com/harvesthq/chosen) is a library for making long, unwieldy select boxes more user friendly.
 
-The `trln-chosen-rails` gem integrates the `Chosen` with the Rails asset pipeline.  This project is a fork of the original `chosen-rails` which removes the dependency on the now deprecated `sass` gem.
+The `trln-chosen-rails` gem is a fork of the original `chosen-rails`
+gem and integrates the `Chosen` with the Rails asset pipeline. This fork removes dependencies on `coffee-rails` and on any particular Sass implementation (the original had a dependency on `sassc-rails`).
+
+One tradeoff is that the version of the `chosen` library is frozen at version 1.8.7.
+
+To make full use of this gem you will need to either add a Sass compilation
+step to your asset handling or compile the bundled
+`vendor/assets/stylesheets/chosen-base.scss` file you can find in this gem's
+directory and add that to your Rails application's `assets/stylesheets` directory.  Since the TRLN Blacklight implementations all employ the use of Sass, this should be unnecessary for members of the consortium.
 
 ## Usage
 
@@ -20,8 +28,6 @@ Then run `bundle install`
 
 You can get jquery via [jquery-rails](https://github.com/rails/jquery-rails).
 
-Please consider [jquery-turbolinks](https://github.com/kossnocorp/jquery.turbolinks) if you have turbolinks issues for Rails 4 +.
-
 ### Include chosen javascript assets
 
 Add to your `app/assets/javascripts/application.js` if use with jQuery
@@ -31,13 +37,6 @@ Add to your `app/assets/javascripts/application.js` if use with jQuery
 //= require chosen-jquery
 ```
 
-Or with Prototype
-
-```coffee
-//= require jquery
-//= require chosen-prototype
-```
-
 ### Include chosen stylesheet assets
 
 Add to your `app/assets/stylesheets/application.css`
@@ -54,27 +53,7 @@ For rails 6, remember to add `javascript_include_tag` in `app/views/layouts/appl
 <%= javascript_include_tag 'application' %>
 ```
 
-Add to one coffee script file, like `scaffold.js.coffee`
-
-```coffee
-$ ->
-  # enable chosen js
-  $('.chosen-select').chosen
-    allow_single_deselect: true
-    no_results_text: 'No results matched'
-    width: '200px'
-```
-
-Notice: `width` option is required since `Chosen 0.9.15`.
-
-And this file must be included in `application.js`
-
-```coffee
-//= require chosen-jquery
-//= require scaffold
-```
-
-Also add the class to your form field
+Add the class to your form field
 
 ```erb
 <%= f.select :author,
@@ -96,7 +75,7 @@ If you use simple form as form builder
 
 ### Deployment
 
-Since version 0.13.0, non-digested assets of `chosen-rails` will simply be copied from digested assets.
+Non-digested assets of `trln-chosen-rails` will simply be copied from digested assets.
 
 ## RSpec helpers
 `chosen-rails` provides RSpec feature helper methods that allow users to select or unselect options from both single and multiple chosen elements. Add the following to your `spec/rails_helper.rb` (or `spec/spec_helper.rb`):

data/lib/chosen-rails/version.rb

@@ -1,6 +1,6 @@
 module Chosen
   module Rails
-    VERSION = '1.30.0-beta2'
+    VERSION = '1.30.0'
     CHOSEN_VERSION = '1.8.7'
   end
 end

data/vendor/assets/javascripts/lib/abstract-chosen.js

@@ -0,0 +1,467 @@
+/*
+ * decaffeinate suggestions:
+ * DS101: Remove unnecessary use of Array.from
+ * DS102: Remove unnecessary code created because of implicit returns
+ * DS205: Consider reworking code to avoid use of IIFEs
+ * DS206: Consider reworking classes to avoid initClass
+ * DS207: Consider shorter variations of null checks
+ * Full docs: https://github.com/decaffeinate/decaffeinate/blob/main/docs/suggestions.md
+ */
+class AbstractChosen {
+  static initClass() {
+  
+    this.default_multiple_text = "Select Some Options";
+    this.default_single_text = "Select an Option";
+    this.default_no_result_text = "No results match";
+  }
+
+  constructor(form_field, options) {
+    this.label_click_handler = this.label_click_handler.bind(this);
+    this.form_field = form_field;
+    if (options == null) { options = {}; }
+    this.options = options;
+    if (!AbstractChosen.browser_is_supported()) { return; }
+    this.is_multiple = this.form_field.multiple;
+    this.set_default_text();
+    this.set_default_values();
+
+    this.setup();
+
+    this.set_up_html();
+    this.register_observers();
+    // instantiation done, fire ready
+    this.on_ready();
+  }
+
+  set_default_values() {
+    this.click_test_action = evt => this.test_active_click(evt);
+    this.activate_action = evt => this.activate_field(evt);
+    this.active_field = false;
+    this.mouse_on_container = false;
+    this.results_showing = false;
+    this.result_highlighted = null;
+    this.is_rtl = this.options.rtl || /\bchosen-rtl\b/.test(this.form_field.className);
+    this.allow_single_deselect = (this.options.allow_single_deselect != null) && (this.form_field.options[0] != null) && (this.form_field.options[0].text === "") ? this.options.allow_single_deselect : false;
+    this.disable_search_threshold = this.options.disable_search_threshold || 0;
+    this.disable_search = this.options.disable_search || false;
+    this.enable_split_word_search = (this.options.enable_split_word_search != null) ? this.options.enable_split_word_search : true;
+    this.group_search = (this.options.group_search != null) ? this.options.group_search : true;
+    this.search_contains = this.options.search_contains || false;
+    this.single_backstroke_delete = (this.options.single_backstroke_delete != null) ? this.options.single_backstroke_delete : true;
+    this.max_selected_options = this.options.max_selected_options || Infinity;
+    this.inherit_select_classes = this.options.inherit_select_classes || false;
+    this.display_selected_options = (this.options.display_selected_options != null) ? this.options.display_selected_options : true;
+    this.display_disabled_options = (this.options.display_disabled_options != null) ? this.options.display_disabled_options : true;
+    this.include_group_label_in_selected = this.options.include_group_label_in_selected || false;
+    this.max_shown_results = this.options.max_shown_results || Number.POSITIVE_INFINITY;
+    this.case_sensitive_search = this.options.case_sensitive_search || false;
+    return this.hide_results_on_select = (this.options.hide_results_on_select != null) ? this.options.hide_results_on_select : true;
+  }
+
+  set_default_text() {
+    if (this.form_field.getAttribute("data-placeholder")) {
+      this.default_text = this.form_field.getAttribute("data-placeholder");
+    } else if (this.is_multiple) {
+      this.default_text = this.options.placeholder_text_multiple || this.options.placeholder_text || AbstractChosen.default_multiple_text;
+    } else {
+      this.default_text = this.options.placeholder_text_single || this.options.placeholder_text || AbstractChosen.default_single_text;
+    }
+
+    this.default_text = this.escape_html(this.default_text);
+
+    return this.results_none_found = this.form_field.getAttribute("data-no_results_text") || this.options.no_results_text || AbstractChosen.default_no_result_text;
+  }
+
+  choice_label(item) {
+    if (this.include_group_label_in_selected && (item.group_label != null)) {
+      return `<b class='group-name'>${this.escape_html(item.group_label)}</b>${item.html}`;
+    } else {
+      return item.html;
+    }
+  }
+
+  mouse_enter() { return this.mouse_on_container = true; }
+  mouse_leave() { return this.mouse_on_container = false; }
+
+  input_focus(evt) {
+    if (this.is_multiple) {
+      if (!this.active_field) { return setTimeout((() => this.container_mousedown()), 50); }
+    } else {
+      if (!this.active_field) { return this.activate_field(); }
+    }
+  }
+
+  input_blur(evt) {
+    if (!this.mouse_on_container) {
+      this.active_field = false;
+      return setTimeout((() => this.blur_test()), 100);
+    }
+  }
+
+  label_click_handler(evt) {
+    if (this.is_multiple) {
+      return this.container_mousedown(evt);
+    } else {
+      return this.activate_field();
+    }
+  }
+
+  results_option_build(options) {
+    let content = '';
+    let shown_results = 0;
+    for (var data of Array.from(this.results_data)) {
+      var data_content = '';
+      if (data.group) {
+        data_content = this.result_add_group(data);
+      } else {
+        data_content = this.result_add_option(data);
+      }
+      if (data_content !== '') {
+        shown_results++;
+        content += data_content;
+      }
+
+      // this select logic pins on an awkward flag
+      // we can make it better
+      if (options != null ? options.first : undefined) {
+        if (data.selected && this.is_multiple) {
+          this.choice_build(data);
+        } else if (data.selected && !this.is_multiple) {
+          this.single_set_selected_text(this.choice_label(data));
+        }
+      }
+
+      if (shown_results >= this.max_shown_results) {
+        break;
+      }
+    }
+
+    return content;
+  }
+
+  result_add_option(option) {
+    if (!option.search_match) { return ''; }
+    if (!this.include_option_in_results(option)) { return ''; }
+
+    const classes = [];
+    if (!option.disabled && !(option.selected && this.is_multiple)) { classes.push("active-result"); }
+    if (option.disabled && !(option.selected && this.is_multiple)) { classes.push("disabled-result"); }
+    if (option.selected) { classes.push("result-selected"); }
+    if (option.group_array_index != null) { classes.push("group-option"); }
+    if (option.classes !== "") { classes.push(option.classes); }
+
+    const option_el = document.createElement("li");
+    option_el.className = classes.join(" ");
+    if (option.style) { option_el.style.cssText = option.style; }
+    option_el.setAttribute("data-option-array-index", option.array_index);
+    option_el.innerHTML = option.highlighted_html || option.html;
+    if (option.title) { option_el.title = option.title; }
+
+    return this.outerHTML(option_el);
+  }
+
+  result_add_group(group) {
+    if (!group.search_match && !group.group_match) { return ''; }
+    if (!(group.active_options > 0)) { return ''; }
+
+    const classes = [];
+    classes.push("group-result");
+    if (group.classes) { classes.push(group.classes); }
+
+    const group_el = document.createElement("li");
+    group_el.className = classes.join(" ");
+    group_el.innerHTML = group.highlighted_html || this.escape_html(group.label);
+    if (group.title) { group_el.title = group.title; }
+
+    return this.outerHTML(group_el);
+  }
+
+  results_update_field() {
+    this.set_default_text();
+    if (!this.is_multiple) { this.results_reset_cleanup(); }
+    this.result_clear_highlight();
+    this.results_build();
+    if (this.results_showing) { return this.winnow_results(); }
+  }
+
+  reset_single_select_options() {
+    return (() => {
+      const result1 = [];
+      for (var result of Array.from(this.results_data)) {
+        if (result.selected) { result1.push(result.selected = false); } else {
+          result1.push(undefined);
+        }
+      }
+      return result1;
+    })();
+  }
+
+  results_toggle() {
+    if (this.results_showing) {
+      return this.results_hide();
+    } else {
+      return this.results_show();
+    }
+  }
+
+  results_search(evt) {
+    if (this.results_showing) {
+      return this.winnow_results();
+    } else {
+      return this.results_show();
+    }
+  }
+
+  winnow_results(options) {
+    this.no_results_clear();
+
+    let results = 0;
+
+    const query = this.get_search_text();
+    const escapedQuery = query.replace(/[-[\]{}()*+?.,\\^$|#\s]/g, "\\$&");
+    const regex = this.get_search_regex(escapedQuery);
+
+    for (var option of Array.from(this.results_data)) {
+
+      option.search_match = false;
+      var results_group = null;
+      var search_match = null;
+      option.highlighted_html = '';
+
+      if (this.include_option_in_results(option)) {
+
+        if (option.group) {
+          option.group_match = false;
+          option.active_options = 0;
+        }
+
+        if ((option.group_array_index != null) && this.results_data[option.group_array_index]) {
+          results_group = this.results_data[option.group_array_index];
+          if ((results_group.active_options === 0) && results_group.search_match) { results += 1; }
+          results_group.active_options += 1;
+        }
+
+        var text = option.group ? option.label : option.text;
+
+        if (!option.group || !!this.group_search) {
+          search_match = this.search_string_match(text, regex);
+          option.search_match = (search_match != null);
+
+          if (option.search_match && !option.group) { results += 1; }
+
+          if (option.search_match) {
+            if (query.length) {
+              var startpos = search_match.index;
+              var prefix = text.slice(0, startpos);
+              var fix    = text.slice(startpos, startpos + query.length);
+              var suffix = text.slice(startpos + query.length);
+              option.highlighted_html = `${this.escape_html(prefix)}<em>${this.escape_html(fix)}</em>${this.escape_html(suffix)}`;
+            }
+
+            if (results_group != null) { results_group.group_match = true; }
+
+          } else if ((option.group_array_index != null) && this.results_data[option.group_array_index].search_match) {
+            option.search_match = true;
+          }
+        }
+      }
+    }
+
+    this.result_clear_highlight();
+
+    if ((results < 1) && query.length) {
+      this.update_results_content("");
+      return this.no_results(query);
+    } else {
+      this.update_results_content(this.results_option_build());
+      if (!(options != null ? options.skip_highlight : undefined)) { return this.winnow_results_set_highlight(); }
+    }
+  }
+
+  get_search_regex(escaped_search_string) {
+    let regex_string = this.search_contains ? escaped_search_string : `(^|\\s|\\b)${escaped_search_string}[^\\s]*`;
+    if (!this.enable_split_word_search && !this.search_contains) { regex_string = `^${regex_string}`; }
+    const regex_flag = this.case_sensitive_search ? "" : "i";
+    return new RegExp(regex_string, regex_flag);
+  }
+
+  search_string_match(search_string, regex) {
+    const match = regex.exec(search_string);
+    if (!this.search_contains && (match != null ? match[1] : undefined)) { match.index += 1; } // make up for lack of lookbehind operator in regex
+    return match;
+  }
+
+  choices_count() {
+    if (this.selected_option_count != null) { return this.selected_option_count; }
+
+    this.selected_option_count = 0;
+    for (var option of Array.from(this.form_field.options)) {
+      if (option.selected) { this.selected_option_count += 1; }
+    }
+
+    return this.selected_option_count;
+  }
+
+  choices_click(evt) {
+    evt.preventDefault();
+    this.activate_field();
+    if (!this.results_showing && !this.is_disabled) { return this.results_show(); }
+  }
+
+  keydown_checker(evt) {
+    const stroke = evt.which != null ? evt.which : evt.keyCode;
+    this.search_field_scale();
+
+    if ((stroke !== 8) && this.pending_backstroke) { this.clear_backstroke(); }
+
+    switch (stroke) {
+      case 8: // backspace
+        this.backstroke_length = this.get_search_field_value().length;
+        break;
+      case 9: // tab
+        if (this.results_showing && !this.is_multiple) { this.result_select(evt); }
+        this.mouse_on_container = false;
+        break;
+      case 13: // enter
+        if (this.results_showing) { evt.preventDefault(); }
+        break;
+      case 27: // escape
+        if (this.results_showing) { evt.preventDefault(); }
+        break;
+      case 32: // space
+        if (this.disable_search) { evt.preventDefault(); }
+        break;
+      case 38: // up arrow
+        evt.preventDefault();
+        this.keyup_arrow();
+        break;
+      case 40: // down arrow
+        evt.preventDefault();
+        this.keydown_arrow();
+        break;
+    }
+  }
+
+  keyup_checker(evt) {
+    const stroke = evt.which != null ? evt.which : evt.keyCode;
+    this.search_field_scale();
+
+    switch (stroke) {
+      case 8: // backspace
+        if (this.is_multiple && (this.backstroke_length < 1) && (this.choices_count() > 0)) {
+          this.keydown_backstroke();
+        } else if (!this.pending_backstroke) {
+          this.result_clear_highlight();
+          this.results_search();
+        }
+        break;
+      case 13: // enter
+        evt.preventDefault();
+        if (this.results_showing) { this.result_select(evt); }
+        break;
+      case 27: // escape
+        if (this.results_showing) { this.results_hide(); }
+        break;
+      case 9: case 16: case 17: case 18: case 38: case 40: case 91:
+        // don't do anything on these keys
+      default:
+        this.results_search();
+        break;
+    }
+  }
+
+  clipboard_event_checker(evt) {
+    if (this.is_disabled) { return; }
+    return setTimeout((() => this.results_search()), 50);
+  }
+
+  container_width() {
+    if (this.options.width != null) { return this.options.width; } else { return `${this.form_field.offsetWidth}px`; }
+  }
+
+  include_option_in_results(option) {
+    if (this.is_multiple && (!this.display_selected_options && option.selected)) { return false; }
+    if (!this.display_disabled_options && option.disabled) { return false; }
+    if (option.empty) { return false; }
+
+    return true;
+  }
+
+  search_results_touchstart(evt) {
+    this.touch_started = true;
+    return this.search_results_mouseover(evt);
+  }
+
+  search_results_touchmove(evt) {
+    this.touch_started = false;
+    return this.search_results_mouseout(evt);
+  }
+
+  search_results_touchend(evt) {
+    if (this.touch_started) { return this.search_results_mouseup(evt); }
+  }
+
+  outerHTML(element) {
+    if (element.outerHTML) { return element.outerHTML; }
+    const tmp = document.createElement("div");
+    tmp.appendChild(element);
+    return tmp.innerHTML;
+  }
+
+  get_single_html() {
+    return `\
+<a class="chosen-single chosen-default">
+  <span>${this.default_text}</span>
+  <div><b></b></div>
+</a>
+<div class="chosen-drop">
+  <div class="chosen-search">
+    <input class="chosen-search-input" type="text" autocomplete="off" />
+  </div>
+  <ul class="chosen-results"></ul>
+</div>\
+`;
+  }
+
+  get_multi_html() {
+    return `\
+<ul class="chosen-choices">
+  <li class="search-field">
+    <input class="chosen-search-input" type="text" autocomplete="off" value="${this.default_text}" />
+  </li>
+</ul>
+<div class="chosen-drop">
+  <ul class="chosen-results"></ul>
+</div>\
+`;
+  }
+
+  get_no_results_html(terms) {
+    return `\
+<li class="no-results">
+  ${this.results_none_found} <span>${this.escape_html(terms)}</span>
+</li>\
+`;
+  }
+
+  // class methods and variables ============================================================
+
+  static browser_is_supported() {
+    if ("Microsoft Internet Explorer" === window.navigator.appName) {
+      return document.documentMode >= 8;
+    }
+    if (/iP(od|hone)/i.test(window.navigator.userAgent) ||
+       /IEMobile/i.test(window.navigator.userAgent) ||
+       /Windows Phone/i.test(window.navigator.userAgent) ||
+       /BlackBerry/i.test(window.navigator.userAgent) ||
+       /BB10/i.test(window.navigator.userAgent) ||
+       /Android.*Mobile/i.test(window.navigator.userAgent)) {
+      return false;
+    }
+    return true;
+  }
+}
+AbstractChosen.initClass();
+
+
+window.AbstractChosen = AbstractChosen;

data/vendor/assets/javascripts/lib/select-parser.js

@@ -0,0 +1,76 @@
+/*
+ * decaffeinate suggestions:
+ * DS101: Remove unnecessary use of Array.from
+ * DS102: Remove unnecessary code created because of implicit returns
+ * DS207: Consider shorter variations of null checks
+ * Full docs: https://github.com/decaffeinate/decaffeinate/blob/main/docs/suggestions.md
+ */
+class SelectParser {
+
+  constructor() {
+    this.options_index = 0;
+    this.parsed = [];
+  }
+
+  add_node(child) {
+    if (child.nodeName.toUpperCase() === "OPTGROUP") {
+      return this.add_group(child);
+    } else {
+      return this.add_option(child);
+    }
+  }
+
+  add_group(group) {
+    const group_position = this.parsed.length;
+    this.parsed.push({
+      array_index: group_position,
+      group: true,
+      label: group.label,
+      title: (group.title ? group.title : undefined),
+      children: 0,
+      disabled: group.disabled,
+      classes: group.className
+    });
+    return Array.from(group.childNodes).map((option) => this.add_option( option, group_position, group.disabled ));
+  }
+
+  add_option(option, group_position, group_disabled) {
+    if (option.nodeName.toUpperCase() === "OPTION") {
+      if (option.text !== "") {
+        if (group_position != null) {
+          this.parsed[group_position].children += 1;
+        }
+        this.parsed.push({
+          array_index: this.parsed.length,
+          options_index: this.options_index,
+          value: option.value,
+          text: option.text,
+          html: option.innerHTML,
+          title: (option.title ? option.title : undefined),
+          selected: option.selected,
+          disabled: group_disabled === true ? group_disabled : option.disabled,
+          group_array_index: group_position,
+          group_label: (group_position != null) ? this.parsed[group_position].label : null,
+          classes: option.className,
+          style: option.style.cssText
+        });
+      } else {
+        this.parsed.push({
+          array_index: this.parsed.length,
+          options_index: this.options_index,
+          empty: true
+        });
+      }
+      return this.options_index += 1;
+    }
+  }
+}
+
+SelectParser.select_to_array = function(select) {
+  const parser = new SelectParser();
+  for (var child of Array.from(select.childNodes)) { parser.add_node( child ); }
+  return parser.parsed;
+};
+
+
+window.SelectParser = SelectParser;

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: trln-chosen-rails
 version: !ruby/object:Gem::Version
-  version: 1.30.0.pre.beta2
+  version: 1.30.0
 platform: ruby
 authors:
 - Tse-Ching Ho
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-08 00:00:00.000000000 Z
+date: 2024-11-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -120,6 +120,8 @@ files:
 - vendor/assets/javascripts/chosen-prototype.js
 - vendor/assets/javascripts/chosen.jquery.js
 - vendor/assets/javascripts/chosen.proto.js
+- vendor/assets/javascripts/lib/abstract-chosen.js
+- vendor/assets/javascripts/lib/select-parser.js
 - vendor/assets/stylesheets/chosen-base.css
 - vendor/assets/stylesheets/chosen-base.css.map
 - vendor/assets/stylesheets/chosen-base.scss