ice_cube-select 4.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7307194cfd205d851b5fa951ee356597da543c67fffe1b62ea4ba609f1fc9a24
+  data.tar.gz: db53be2302254f4b4016c7d004063265fdfc331f5ff055bf294bf0ee4be15ff9
+SHA512:
+  metadata.gz: e10a7e0c9b65df2aa92f954903c23202ade9a834c6033fe26f6e65faacbbc02ed23c6cd0835a77c3f94d3b19457203ff962b1a26e2abe702a2621d43be35c4d1
+  data.tar.gz: c7d32aa185693e9577e46254b92a4d094fe10712a11f89c560c979bda0f91edbf0ece478af7942ef07b59861aa760d8787399e392b1d8716635fcad0cd9002c4

data/MIT-LICENSE

@@ -0,0 +1,21 @@
+Copyright 2022 Saturn Flyer
+Copyright 2013 Jobber (OctopusApp Inc)
+
+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,134 @@
+# Ice Cube Select
+
+[![Code Climate](https://codeclimate.com/github/saturnflyer/ice_cube_select.png)](https://codeclimate.com/github/saturnflyer/ice_cube_select)
+
+This gem adds selectors and helpers for working with recurring schedules in a Rails app. It uses [ice_cube](https://github.com/seejohnrun/ice_cube) recurring scheduling gem.
+
+Check out the [live demo](http://ice-cube-select-demo.herokuapp.com/) (code in [spec/dummy](https://github.com/saturnflyer/ice_cube_select/tree/master/spec/dummy) folder)
+
+## Requirements
+
+- Ruby 3.3+
+- Rails 8.0+
+- [ice_cube](https://github.com/seejohnrun/ice_cube) 0.16+
+
+No jQuery or other JavaScript framework dependencies. Uses vanilla JavaScript.
+
+## Usage
+
+Add the gem to your Gemfile:
+
+```ruby
+gem 'ice_cube-select'
+```
+
+### Assets
+
+Include the stylesheet and JavaScript in your layout:
+
+```erb
+<%= stylesheet_link_tag "ice_cube_select" %>
+<%= javascript_include_tag "ice_cube_select" %>
+<%= javascript_include_tag "ice_cube_select_dialog" %>
+```
+
+Works with Propshaft (Rails 8 default) out of the box.
+
+### Form Helper
+
+In the form view call the helper:
+
+```erb
+<%= f.select_recurring :recurring_rule_column %>
+```
+
+#### Options
+
+```ruby
+f.select_recurring :current_existing_rule, [
+  IceCube::Rule.weekly.day(:monday, :wednesday, :friday),
+  IceCube::Rule.monthly.day_of_month(-1)
+]
+```
+
+Use :allow_blank for a "not recurring" option:
+
+```ruby
+  f.select_recurring :current_existing_rule, nil, :allow_blank => true
+```
+
+
+### Additional Helpers
+
+Ice Cube Select also comes with helpers for parsing the
+parameters when they hit your application.
+
+You can send the column into the `is_valid_rule?` method to check the
+validity of the input.
+
+```ruby
+IceCubeSelect.is_valid_rule?(possible_rule)
+```
+
+There is also a `dirty_hash_to_rule` method for sanitizing the inputs
+for IceCube. This is sometimes needed if you're receiving strings, fixed
+numbers, strings vs symbols, etc.
+
+```ruby
+IceCubeSelect.dirty_hash_to_rule(params)
+```
+
+### I18n
+
+Ice Cube Select is I18n aware.
+
+You can create a locale file like this:
+
+```yaml
+en:
+  ice_cube_select:
+    not_recurring: "- not recurring -"
+    change_schedule: "Change schedule..."
+    set_schedule: "Set schedule..."
+    new_custom_schedule: "New custom schedule..."
+    custom_schedule: "Custom schedule..."
+    or: or
+```
+
+For JavaScript translations, include the locale file after the main scripts. French and English are supported:
+
+```erb
+<%= javascript_include_tag "ice_cube_select/fr" %>
+```
+
+## Testing and Development
+
+Start the dummy server for clicking around the interface:
+
+```console
+cd spec/dummy
+rails s
+```
+
+Run specs with:
+
+```console
+bundle exec rspec
+```
+
+Feel free to open issues or send pull requests.
+
+This project is managed with [Reissue](https://github.com/SOFware/reissue).
+
+To release a new version, make your changes and be sure to update the CHANGELOG.md.
+
+To release a new version:
+
+    bundle exec rake build:checksum
+    bundle exec rake release
+
+## Licensing
+
+This project rocks and uses MIT-LICENSE.
+
+Based on https://github.com/GetJobber/recurring_select

data/Rakefile

@@ -0,0 +1,29 @@
+#!/usr/bin/env rake
+require 'rubygems'
+require 'bundler/setup'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec
+
+require 'rubygems/package_task'
+Bundler::GemHelper.install_tasks
+
+require 'rdoc/task'
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'IceCubeSelect'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../spec/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+require "reissue/gem"
+
+Reissue::Task.create :reissue do |task|
+  task.version_file = "lib/ice_cube_select/version.rb"
+  task.fragment = :git
+end

data/app/assets/javascripts/ice_cube_select/fr.js

@@ -0,0 +1,29 @@
+// French translations for IceCubeSelect
+(function() {
+  'use strict';
+
+  IceCubeSelect.texts = {
+    locale_iso_code: 'fr',
+    repeat: 'Récurrence',
+    last_day: 'Dernier jour',
+    frequency: 'Fréquence',
+    daily: 'Tous les jours',
+    weekly: 'Toutes les semaines',
+    monthly: 'Tous les mois',
+    yearly: 'Tous les ans',
+    every: 'Tous les',
+    days: 'jour(s)',
+    weeks_on: 'semaine(s) le',
+    months: 'mois',
+    years: 'année(s)',
+    cancel: 'Annuler',
+    day_of_month: 'Jour du mois',
+    day_of_week: 'Jour de la semaine',
+    ok: 'OK',
+    summary: 'Résumé',
+    first_day_of_week: 1,
+    days_first_letter: ['D', 'L', 'M', 'M', 'J', 'V', 'S'],
+    order: ['1er', '2ème', '3ème', '4ème', '5ème', 'Dernier'],
+    show_week: [true, true, true, true, false, false]
+  };
+})();

data/app/assets/javascripts/ice_cube_select.js

@@ -0,0 +1,182 @@
+// IceCubeSelect - Vanilla JS implementation
+// Replaces the jQuery plugin version
+
+(function() {
+  'use strict';
+
+  class IceCubeSelect {
+    constructor(element) {
+      this.element = element;
+      this.bindEvents();
+    }
+
+    bindEvents() {
+      this.element.addEventListener('focus', () => this.setInitialValues());
+      this.element.addEventListener('change', () => this.changed());
+    }
+
+    setInitialValues() {
+      this.element.dataset.initialValueHash = this.element.value;
+      const selectedOption = this.element.options[this.element.selectedIndex];
+      this.element.dataset.initialValueStr = selectedOption ? selectedOption.text : '';
+    }
+
+    changed() {
+      if (this.element.value === 'custom') {
+        this.openCustom();
+        IceCubeSelect.setModalTabbing();
+      } else {
+        this.setInitialValues();
+      }
+    }
+
+    openCustom() {
+      this.element.dataset.recurringSelectActive = 'true';
+      new IceCubeSelectDialog(this.element);
+      this.element.blur();
+    }
+
+    save(newRule) {
+      // Remove existing custom options
+      const customOptions = this.element.querySelectorAll('option[data-custom]');
+      customOptions.forEach(opt => opt.remove());
+
+      const newJsonVal = JSON.stringify(newRule.hash);
+
+      // Check if this value already exists
+      const existingValues = Array.from(this.element.options).map(opt => opt.value);
+      if (!existingValues.includes(newJsonVal)) {
+        this.insertOption(newRule.str, newJsonVal);
+      }
+
+      this.element.value = newJsonVal;
+      this.setInitialValues();
+      this.element.dispatchEvent(new CustomEvent('ice_cube_select:save'));
+    }
+
+    currentRule() {
+      const hashValue = this.element.dataset.initialValueHash;
+      return {
+        str: this.element.dataset.initialValueStr,
+        hash: hashValue ? JSON.parse(hashValue) : null
+      };
+    }
+
+    cancel() {
+      this.element.value = this.element.dataset.initialValueHash;
+      this.element.dataset.recurringSelectActive = 'false';
+      this.element.dispatchEvent(new CustomEvent('ice_cube_select:cancel'));
+    }
+
+    insertOption(newRuleStr, newRuleJson) {
+      // Find the separator (last disabled option, or last option)
+      let separator = this.element.querySelector('option:disabled:last-of-type');
+      if (!separator) {
+        const options = this.element.querySelectorAll('option');
+        separator = options[options.length - 1];
+      }
+
+      const newOption = document.createElement('option');
+      newOption.dataset.custom = 'true';
+
+      if (!newRuleStr.endsWith('*')) {
+        newRuleStr += '*';
+      }
+      newOption.textContent = newRuleStr;
+      newOption.value = newRuleJson;
+
+      separator.parentNode.insertBefore(newOption, separator);
+    }
+
+    static setModalTabbing() {
+      const modal = document.getElementById('ice_cube_select_modal');
+      if (!modal) return;
+
+      const tabbables = modal.querySelectorAll(
+        'a[href], button, textarea, input, select, [tabindex]:not([tabindex="-1"])'
+      );
+      if (tabbables.length === 0) return;
+
+      const firstTabbable = tabbables[0];
+      const lastTabbable = tabbables[tabbables.length - 1];
+
+      modal.addEventListener('keydown', function(e) {
+        if (e.key !== 'Tab') return;
+
+        if (e.shiftKey && document.activeElement === firstTabbable) {
+          e.preventDefault();
+          lastTabbable.focus();
+        } else if (!e.shiftKey && document.activeElement === lastTabbable) {
+          e.preventDefault();
+          firstTabbable.focus();
+        }
+      });
+    }
+
+    // Get instance from element
+    static getInstance(element) {
+      return element._iceCubeSelect;
+    }
+
+    // Initialize or get instance
+    static getOrCreate(element) {
+      if (!element._iceCubeSelect) {
+        element._iceCubeSelect = new IceCubeSelect(element);
+      }
+      return element._iceCubeSelect;
+    }
+  }
+
+  // Static configuration
+  IceCubeSelect.options = {
+    monthly: {
+      show_week: [true, true, true, true, false, false]
+    }
+  };
+
+  IceCubeSelect.texts = {
+    locale_iso_code: 'en',
+    repeat: 'Repeat',
+    last_day: 'Last Day',
+    frequency: 'Frequency',
+    daily: 'Daily',
+    weekly: 'Weekly',
+    monthly: 'Monthly',
+    yearly: 'Yearly',
+    every: 'Every',
+    days: 'day(s)',
+    weeks_on: 'week(s) on',
+    months: 'month(s)',
+    years: 'year(s)',
+    day_of_month: 'Day of month',
+    day_of_week: 'Day of week',
+    cancel: 'Cancel',
+    ok: 'OK',
+    summary: 'Summary',
+    first_day_of_week: 0,
+    days_first_letter: ['S', 'M', 'T', 'W', 'T', 'F', 'S'],
+    order: ['1st', '2nd', '3rd', '4th', '5th', 'Last'],
+    show_week: [true, true, true, true, false, false]
+  };
+
+  // Auto-initialize on DOM ready and handle dynamically added elements
+  function initializeAll() {
+    document.querySelectorAll('.ice_cube_select').forEach(el => {
+      IceCubeSelect.getOrCreate(el);
+    });
+  }
+
+  // Initialize on DOMContentLoaded
+  if (document.readyState === 'loading') {
+    document.addEventListener('DOMContentLoaded', initializeAll);
+  } else {
+    initializeAll();
+  }
+
+  // Also handle Turbo/Turbolinks page changes
+  document.addEventListener('turbo:load', initializeAll);
+  document.addEventListener('turbolinks:load', initializeAll);
+
+  // Expose globally
+  window.IceCubeSelect = IceCubeSelect;
+})();