nacho 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55069f49f226b3b6b7e0e87f1a5494a23c269c7e
+  data.tar.gz: a27937c4b05b03b623534b4c5bf7bae828e05184
+SHA512:
+  metadata.gz: 4206322c9b667de5b569bc8971408cd198a41ab5888df6621fcff7e7918d7766decb27b2dfe6fbbab71b5f691dfed3e993e852ff93280af600206ca7ca2f5c4d
+  data.tar.gz: 3351c6fc05c495258243ab2872b178313467709f155d5583cf5101c11a0a4d1555a4f3dfb9c33ed42cb01f101f28825a134f80376047aa57016bbec207d444cf

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2016 Daniel Ray Ward
+
+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/Rakefile

@@ -0,0 +1,34 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'Nacho'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/javascripts/nacho.js

@@ -0,0 +1,197 @@
+(function ( $ ) {
+    $.nacho = function(element, options) {
+
+        const HTML5_OPTION_VALUE_KEY    = "data-nacho-option-value-key";
+        const HTML5_OPTION_TEXT_KEY     = "data-nacho-option-text-key";
+        const HTML5_NEW_ITEM_VALUE_KEY  = "data-nacho-new-value-key";
+        const HTML5_MODAL_ID_KEY        = "data-nacho-modal-id";
+        const HTML5_MODAL_HTML_KEY      = "data-nacho-modal";
+        const HTML5_ADD_NEW_VALUE_KEY   = "data-nacho-add-new-value";
+        const HTML5_PREVIOUS_VALUE_KEY  = "data-nacho-previous-value";
+
+        /*
+            These defautls will be overwritten if the HTML5 attributes are present
+         */
+        var defaults = {
+            optionValueKey: 'value',
+            optionTextKey:  'text',
+            newItemValueKey:  'id',
+            formElementsToRemove: ['input[type=submit]']
+        };
+
+        var plugin = this;
+
+        plugin.settings = {};
+
+        var $element = $(element);
+
+        var modalId, $modal;
+
+        /*
+            Initialize the plugin
+         */
+        plugin.init = function() {
+            plugin.settings = $.extend({}, defaults, options);
+
+            /*
+                Set the settings if the specified HTML5 attributes are present
+             */
+            if ($element.attr(HTML5_OPTION_VALUE_KEY)) {
+                plugin.settings.optionValueKey = $element.attr(HTML5_OPTION_VALUE_KEY);
+            }
+
+            if ($element.attr(HTML5_OPTION_TEXT_KEY)) {
+                plugin.settings.optionTextKey = $element.attr(HTML5_OPTION_TEXT_KEY);
+            }
+
+            if ($element.attr(HTML5_NEW_ITEM_VALUE_KEY)) {
+                plugin.settings.newItemValueKey = $element.attr(HTML5_NEW_ITEM_VALUE_KEY);
+            }
+
+            $element.attr(HTML5_PREVIOUS_VALUE_KEY, $element.val());
+
+            modalId = $element.attr(HTML5_MODAL_ID_KEY);
+            $modal = $($element.attr(HTML5_MODAL_HTML_KEY));
+
+            insertModal();
+            initListeners();
+        };
+
+        var initListeners = function() {
+            /*
+                When the add new item is selected, then show the modal
+             */
+            $element.on('change', function () {
+                if ($(this).attr(HTML5_ADD_NEW_VALUE_KEY) == $(this).val()) {
+                    $modal.modal('show');
+                }
+            });
+
+            /*
+                Store the currently selected value when the select is focused on
+             */
+            $element.on('focus', function(){
+                $(this).attr(HTML5_PREVIOUS_VALUE_KEY, $(this).val());
+            });
+
+            /*
+                 When the referenced dialog is closed, we need to see if the select
+                 box needs to be reset.
+             */
+            $modal.on('hidden.bs.modal', function (e) {
+                /*
+                     If the value of the box is still the the 'add new' option, then
+                     set to the first value.
+                 */
+                if ($element.attr(HTML5_ADD_NEW_VALUE_KEY) == $element.val()) {
+                    $element.val($element.attr(HTML5_PREVIOUS_VALUE_KEY));
+                }
+            });
+
+            /*
+                Add the listener for the modal submit button to create the new record
+             */
+            $modal.find('.modal-footer button').on('click', function () {
+                var form = $modal.find('form');
+
+                /*
+                    Create the ajax request with type JSON create the new record
+                 */
+                $.ajax({
+                    type: "POST",
+                    dataType: 'json',
+                    url: form.attr('action'),
+                    data: form.serializeJSON(),
+                    success: function (data) {
+
+                        var selected = $element.val() || [];
+
+                        /*
+                            When the select is a multiple selection, then we can add the new item id to the selected
+                            array and clear out all the current options.
+
+                            If the select is a single select, then we need to delete all the options
+                            except for the last one, which is the option to add a new record
+                         */
+                        if ($element.attr('multiple') == 'multiple') {
+                            selected.push('' + data[plugin.settings.newItemValueKey]);
+                            $element.find("option").remove()
+
+                        } else {
+                            $element.find("option:lt(-1)").remove();
+
+                        }
+
+                        /*
+                            Add the new options from the data set we recieved from the server
+                         */
+                        $.each(data.options, function (index, item) {
+                            $element.prepend($('<option />').attr('value', item[plugin.settings.optionValueKey]).text(item[plugin.settings.optionTextKey]));
+                        });
+
+                        /*
+                            When the select is set to multiple, then we set the val with the updated array.
+                            Taking a unique in case there is an issue with repeated values.
+
+                            For single select we need to add the blank option back to the top.
+                            Set the value to the returned key.
+                         */
+                        if ($element.attr('multiple') == 'multiple') {
+                            $element.val($.unique(selected));
+
+                        } else {
+                            $element.prepend($('<option />').attr('value', '').text(''));
+                            $element.val('' + data[plugin.settings.newItemValueKey]);
+
+                        }
+
+                        /*
+                            Hide the modal
+                         */
+                        $modal.modal('hide');
+
+                        // trigger the updated event.
+                        $element.trigger(jQuery.Event("nacho-select:updated"))
+                    },
+                    error: function (e) {
+                        alert(e);
+                    }
+                });
+            });
+        };
+
+        /*
+            Append the modal to the body, making it the last item in the DOM.
+            This is due to the HTML spec that prevents nested forms.
+         */
+        var insertModal = function() {
+            // configure the modal.
+            var selector = plugin.settings.formElementsToRemove;
+
+            if (plugin.settings.formElementsToRemove instanceof Array) {
+                selector = plugin.settings.formElementsToRemove.join(',');
+            }
+
+            $modal.find('form').find(selector).remove();
+            $modal.appendTo('body');
+        };
+
+        plugin.init();
+
+    };
+
+    /**
+     * Add the nacho function to the jQuery namespace
+     *
+     * @param options The options for the plugin
+     * @returns {*}
+     */
+    $.fn.nacho = function(options) {
+        return this.each(function() {
+            if (undefined == $(this).data('nacho') && $(this)[0].tagName.toLowerCase() == 'select') {
+                var plugin = new $.nacho(this, options);
+                $(this).data('nacho', plugin);
+            }
+        });
+    }
+}( jQuery ));

data/lib/nacho.rb

@@ -0,0 +1,13 @@
+require 'nacho/form_builder'
+require 'nacho/helper'
+
+
+module Nacho
+  module Rails
+    class Engine < ::Rails::Engine
+    end
+  end
+end
+
+
+ActionView::Base.send :include, Nacho::Helper

data/lib/nacho/common.rb

@@ -0,0 +1,90 @@
+# The common code module for the FormBuilder helper and the form tag helper.
+#
+# @author Daniel Ward
+module Nacho::Common
+  include ActionView::Context
+
+  HTML5_OPTION_VALUE_KEY    = "data-nacho-option-value-key"
+  HTML5_OPTION_TEXT_KEY     = "data-nacho-option-text-key"
+  HTML5_NEW_ITEM_VALUE_KEY  = "data-nacho-new-value-key"
+  HTML5_MODAL_ID_KEY        = "data-nacho-modal-id"
+  HTML5_MODAL_HTML_KEY      = "data-nacho-modal"
+  HTML5_ADD_NEW_VALUE_KEY   = "data-nacho-add-new-value"
+
+  private
+
+  # The helper to build the options for the form element, based on the given options.
+  #
+  # @param [Symbol] method See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+  # @param [Array] choices The list of choices for the select, shoudl be in [[val, display],...] format
+  # @param [Hash] options the options to create a message with.
+  # @option options [Boolean] :include_blank Include a blank option (Forced to <tt>true</tt> when <tt>choices.count</tt> == 0)
+  # @option options [String] :new_option_text Text to display as the <tt>option</tt> that will trigger the new modal (Default "-- Add new --", will be ignored if <tt>html_options[:multiple]</tt> is set to <tt>true</tt>)
+  # @option options [Symbol] :value_key The attribute of the model that will be used as the <tt>option</tt> value from the JSON return when a new record is created
+  # @option options [Symbol] :text_key The attribute of the model that will be used as the <tt>option</tt> display content from the JSON return when a new record is created
+  # @option options [Symbol] :new_key The JSON key that will contain the value of the record that was created with the modal
+  # @option options [String] :modal_title The title of the modal (Default to "Add new <model.class.name>")
+  # @option options [String] :partial The form partial for the modal body
+  # @param [Hash] html_options See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+  def build_options(method, choices = nil, options = {}, html_options = {})
+
+    new_option_value = Random.new.rand(-10000...-100)
+    modal_id_suffix = Random.new.rand(100...10000)
+
+    choices ||= []
+    choices << [(options[:new_option_text] || '-- Add new --'), new_option_value] unless html_options[:multiple]
+
+    options[:include_blank] = (choices.count == 1)
+    html_options[:include_blank] = options[:include_blank]
+
+    html_options[HTML5_ADD_NEW_VALUE_KEY]   = new_option_value
+    html_options[HTML5_MODAL_ID_KEY]        = "##{method.to_s}_nacho_modal_#{modal_id_suffix}"
+    html_options[HTML5_OPTION_VALUE_KEY]    = options[:value_key] if options[:value_key].present?
+    html_options[HTML5_OPTION_TEXT_KEY]     = options[:text_key]  if options[:text_key].present?
+    html_options[HTML5_NEW_ITEM_VALUE_KEY]  = options[:new_key]   if options[:new_key].present?
+
+    modal_options = {
+        id: html_options[HTML5_MODAL_ID_KEY].gsub(/^#/, ''),
+        title: options[:modal_title] || "Add new #{method.to_s.humanize}",
+        body: options[:partial].html_safe
+    }
+
+    html_options[HTML5_MODAL_HTML_KEY] = escape_once nacho_form_modal(modal_options)
+
+    {
+        choices: choices,
+        html_options: html_options,
+        options: options,
+        button: button_tag((options[:new_option_text] || 'Add new'), type: :button, data: { toggle: 'modal', target: html_options[HTML5_MODAL_ID_KEY] })
+    }
+  end
+
+  def nacho_form_modal(options = {})
+    content_tag :div, id: options[:id], class: "modal fade #{options[:class]}", role: 'dialog', tabindex: '-1' do
+      content_tag :div, class: 'modal-dialog' do
+        content_tag :div, class: 'modal-content' do
+
+          head = content_tag :div, class: 'modal-header' do
+            [
+                content_tag(:button, content_tag(:span, '&times;', aria: {hideen: true} ), class: 'close', type: :button, data: {dismiss: :modal}, aria: {label: 'Close'}),
+                content_tag(:h4, options[:title], class: 'modal-title')
+            ].join(' ')
+          end
+
+          body = content_tag :div, class: 'modal-body' do
+            options[:body]
+          end
+
+          footer = content_tag :div, class: 'modal-footer' do
+            [
+                content_tag(:button, 'Close', class: 'btn btn-default', type: :button, data: {dismiss: :modal}),
+                content_tag(:button, 'Save', class: 'btn btn-default', type: :button)
+            ].join(' ')
+          end
+
+          head + body + footer
+        end
+      end
+    end
+  end
+end

data/lib/nacho/form_builder.rb

@@ -0,0 +1,59 @@
+require_relative 'common'
+
+# module Nacho
+#   class FormBuilder < ActionView::Helpers::FormBuilder
+module ActionView
+  module Helpers
+    module FormHelper
+      include Nacho::Common
+
+      # The helper for a FormBuilder class. Will create the select and the needed modal that contains the given
+      # form for the target model to create.
+      #
+      # A multiple select will generate a button to trigger the modal.
+      #
+      # @param [Object] object_name The form object that the select helper is being called for
+      # @param [Symbol] method See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select
+      # @param [Array] choices The list of choices for the select, shoudl be in [[val, display],...] format
+      # @param [Hash] options the options to create a message with.
+      # @option options [Boolean] :include_blank Include a blank option (Forced to <tt>true</tt> when <tt>choices.count</tt> == 0)
+      # @option options [String] :new_option_text Text to display as the <tt>option</tt> that will trigger the new modal (Default "-- Add new --", will be ignored if <tt>html_options[:multiple]</tt> is set to <tt>true</tt>)
+      # @option options [Symbol] :value_key The attribute of the model that will be used as the <tt>option</tt> value from the JSON return when a new record is created
+      # @option options [Symbol] :text_key The attribute of the model that will be used as the <tt>option</tt> display content from the JSON return when a new record is created
+      # @option options [Symbol] :new_key The JSON key that will contain the value of the record that was created with the modal
+      # @option options [String] :modal_title The title of the modal (Default to "Add new <model.class.name>")
+      # @option options [String] :partial The form partial for the modal body
+      # @param [Hash] html_options See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select
+      def nacho_select(object_name, method, choices = nil, options = {}, html_options = {})
+        nacho_options = build_options(method, choices, options, html_options)
+        select_element = select(object_name, method, nacho_options[:choices], nacho_options[:options], nacho_options[:html_options])
+        select_element += nacho_options[:button] if nacho_options[:html_options][:multiple]
+
+        select_element
+      end
+    end
+  end
+end
+
+class ActionView::Helpers::FormBuilder
+
+  # The helper for a FormBuilder class. Will create the select and the needed modal that contains the given
+  # form for the target model to create.
+  #
+  # A multiple select will generate a button to trigger the modal.
+  #
+  # @param [Symbol] method See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+  # @param [Array] choices The list of choices for the select, shoudl be in [[val, display],...] format
+  # @param [Hash] options the options to create a message with.
+  # @option options [Boolean] :include_blank Include a blank option (Forced to <tt>true</tt> when <tt>choices.count</tt> == 0)
+  # @option options [String] :new_option_text Text to display as the <tt>option</tt> that will trigger the new modal (Default "-- Add new --", will be ignored if <tt>html_options[:multiple]</tt> is set to <tt>true</tt>)
+  # @option options [Symbol] :value_key The attribute of the model that will be used as the <tt>option</tt> value from the JSON return when a new record is created
+  # @option options [Symbol] :text_key The attribute of the model that will be used as the <tt>option</tt> display content from the JSON return when a new record is created
+  # @option options [Symbol] :new_key The JSON key that will contain the value of the record that was created with the modal
+  # @option options [String] :modal_title The title of the modal (Default to "Add new <model.class.name>")
+  # @option options [String] :partial The form partial for the modal body
+  # @param [Hash] html_options See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+  def nacho_select(method, choices = nil, options = {}, html_options = {})
+    @template.nacho_select(@object_name, method, choices, objectify_options(options), objectify_options(html_options))
+  end
+end

data/lib/nacho/helper.rb

@@ -0,0 +1,31 @@
+require_relative 'common'
+
+module Nacho
+  module Helper
+    include Common
+
+    # A tag helper version for a FormBuilder class. Will create the select and the needed modal that contains the given
+    # form for the target model to create.
+    #
+    # A multiple select will generate a button to trigger the modal.
+    #
+    # @param [Symbol] method See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+    # @param [Array] choices The list of choices for the select, shoudl be in [[val, display],...] format
+    # @param [Hash] options the options to create a message with.
+    # @option options [Boolean] :include_blank Include a blank option (Forced to <tt>true</tt> when <tt>choices.count</tt> == 0)
+    # @option options [String] :new_option_text Text to display as the <tt>option</tt> that will trigger the new modal (Default "-- Add new --", will be ignored if <tt>html_options[:multiple]</tt> is set to <tt>true</tt>)
+    # @option options [Symbol] :value_key The attribute of the model that will be used as the <tt>option</tt> value from the JSON return when a new record is created
+    # @option options [Symbol] :text_key The attribute of the model that will be used as the <tt>option</tt> display content from the JSON return when a new record is created
+    # @option options [Symbol] :new_key The JSON key that will contain the value of the record that was created with the modal
+    # @option options [String] :modal_title The title of the modal (Default to "Add new <model.class.name>")
+    # @option options [String] :partial The form partial for the modal body
+    # @param [Hash] html_options See http://api.rubyonrails.org/classes/ActionView/Helpers/FormOptionsHelper.html#method-i-select.
+    def nacho_select_tag(name, choices = nil, options = {}, html_options = {})
+        nacho_options = build_options(name, choices, options, html_options)
+        select_element = select_tag(name, options_for_select(nacho_options[:choices]), nacho_options[:options], nacho_options[:html_options])
+        select_element += nacho_options[:button] if nacho_options[:html_options][:multiple]
+
+        select_element
+    end
+  end
+end