email_list_field 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa1ee5984c8e2c9c1f39aa7fcef50df89d5ac91c
+  data.tar.gz: 4adfebbaf27ebdbe9c4d4b9a238167ffa8b28478
+SHA512:
+  metadata.gz: 7511f8e37fcd9e2fd727446db0529977370c1779baf0d74e08f52a7feb844bfbe9e9232b0c8c0db80cb64b22cd8872a3263ec8faed136c82b78d82df54e0fb9a
+  data.tar.gz: 60427fea02ee47cf27ce49e48c881cc4f64f989a805ee95b5de7502cf0a2f3355ad6d2ad483c69f935853c97899c89d6734ce905b7ede0bc9f633624e1070ab9

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+email_list_field

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.3.1

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.12.4

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in email_list_field.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Henrique Gubert
+
+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,89 @@
+# EmailListField
+
+Creates editable form field for email lists using jquery and jquery-ui.
+
+This gem is a wrapper of the [jquery-email_list_field.js](https://github.com/hsgubert/jquery-email_list_field) project, that allows you to include jquery-email_list_field.js in your Rails app, using the asset pipeline. The gem currently includes v1.1.0 of jquery-email_list_field.js.
+
+![](https://github.com/hsgubert/email_list_field/raw/master/preview.gif)
+```html
+<div id="mailing_list_container"></div>
+<script>
+  $('#mailing_list_container').emailListField();
+</script>
+```
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'email_list_field'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install email_list_field
+
+## Usage
+
+Include the jquery-email_list_field.js javascript in your `app/assets/javascripts/application.js` or `app/assets/javascripts/vendor.js`:
+```
+//= require email_list_field
+```
+And include stylesheets in your `app/assets/stylesheets/application.js` or `app/assets/stylesheets/vendor.js`::
+```
+*= require email_list_field
+```
+
+In your view, create an empty div and call the `emailListField()` JQuery method:
+```html
+<div id="mailing_list_container"></div>
+<script>
+  $('#mailing_list_container').emailListField();
+</script>
+```
+
+For a full reference on all the options available, see the [jquery-email_list_field.js page](https://github.com/hsgubert/jquery-email_list_field)
+
+## Params Handling Method
+When the user submits the form containing the email list field, an array of strings will be submitted to your controller (by default at `params[:emails]`). The problem is that these string might be either an email or a string in the format "Name <email>". There is a helper to help you treat these parameters:
+```ruby
+params[:emails] = [
+  'Name <email1@address.com>',
+  'email2@address.com.br',
+  'Compound Name <EMAIL3@Address.com.de>'
+]
+
+EmailListField.parse_email_list_params(params[:emails])
+# =>  [
+#   ['Name', 'email1@address.com'],
+#   [nil, 'email2@address.com.br'],
+#   ['Compound Name', 'email3@address.com.de']
+# ]
+```
+
+This helper will identify the name and the email part of the string. It will also downcase all the emails. If you don't want the emails to be downcased you can pass the `lower_email_address_case: false` option as a second parameter.
+
+## Feature/Integration Tests
+For you to be able to test the email list field behavior, you will need an integration test with javascripts enabled. We recommend the RSpec + Capybara + PhantomJS tools. To make those tests easier, the gem packages helpers to be used during testing.
+
+To include these helpers add to your `spec/spec_helper.rb` or to you `spec/rails_helper.rb`:
+```ruby
+RSpec.configure do |config|
+  config.include EmailListField::TestHelpers, type: :feature
+end
+```
+
+Then you can use these helpers:
+```ruby
+fill_in_email_list_field 'mailing_list_container', with: 'some@email.com'
+remove_from_email_list_field 'mailing_list_container', 'some@email.com'
+```
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/app/assets/javascripts/email_list_field.js

@@ -0,0 +1,14 @@
+// This is a manifest file that'll be compiled into vendor.js, which will include all the files
+// listed below.
+//
+// Any JavaScript/Coffee file within this directory, lib/assets/javascripts, vendor/assets/javascripts,
+// or vendor/assets/javascripts of plugins, if any, can be referenced here using a relative path.
+//
+// It's not advisable to add code directly here, but if you do, it'll appear at the bottom of the
+// the compiled file.
+//
+// WARNING: THE FIRST BLANK LINE MARKS THE END OF WHAT'S TO BE PROCESSED, ANY BLANK LINE SHOULD
+// GO AFTER THE REQUIRES BELOW.
+//
+//= require taggle-full
+//= require_tree ./jquery-email_list_field

data/app/assets/javascripts/jquery-email_list_field/email_list_field.js

@@ -0,0 +1,374 @@
+////////////////////////////////////////////////////////////////////////////////
+// jquery-email_list_field.js
+// Author: @hsgubert - Henrique Gubert
+////////////////////////////////////////////////////////////////////////////////
+
+// JQuery plugin. Examples:
+// $('#email-list-field').emailListField();
+// $('#email-list-field').emailListField({ lowerEmailAddressCase: false });
+//
+// For reference of available options see DEFAULT_OPTIONS definition
+//
+$.fn.emailListField = function(options) {
+  var containerId = this.attr('id');
+
+  if (!containerId) {
+    containerId = 'email-list-field-container';
+    this.attr('id', containerId);
+  }
+
+  return new EmailListField(containerId, options);
+};
+
+
+// Class definition
+var EmailListField = function() {
+  //////////////////////////////////////////////////////////////////////////////
+  // Static constants
+  //////////////////////////////////////////////////////////////////////////////
+
+  var DEFAULT_OPTIONS = {
+
+    /**
+     * List of known emails for autocomplete purposes. Emails can be provided
+     * as is or in the "Name Lastname <email>" format
+     * @type {Array[String]}
+     */
+    knownFormattedEmails: [],
+
+    /**
+     * List of emails that are initialized in the field. Emails can be provided
+     * as is or in the "Name Lastname <email>" format
+     * @type {Array[String]}
+     */
+    initialEmails: [],
+
+    /**
+     * Name of the input fields. One hidden input is generated for each email in list
+     * @type {String}
+     */
+    inputName: 'emails[]',
+
+    /**
+     * If true email addresses will be downcased when added. This does not affect
+     * name when email is added in the "Name <email>" format.
+     * @type {Boolean}
+     */
+    lowerEmailAddressCase: true,
+
+    /**
+     * If false emails already in list will not be added
+     * @type {Boolean}
+     */
+    allowDuplicateEmails: false,
+
+    /**
+     * If defined, a message tooltip appears when user tries to add duplicate emails
+     * The message is in the format "%{email} %{duplicatedEmailMessage}"
+     * @type {Boolean}
+     */
+    duplicatedEmailMessage: 'is already on this email list',
+
+    /**
+     * If defined, a message tooltip appears when user tries to add invalid emails
+     * The message is in the format "%{email} %{duplicatedEmailMessage}"
+     * @type {String}
+     */
+    invalidEmailMessage: 'is not a valid email address',
+
+    /**
+    * The message shown as placeholder in the field when there are no emails
+    * @type {String}
+    */
+    placeholderMessage: 'Insert email list here',
+
+    /**
+     * Function that receives both the complete tag text and only the email and
+     * optionally returns a string with css classes to be added to the specific
+     * tag. If the option lowerEmailAddressCase is set, the function will receive
+     * the email already downcased.
+     * @type {function returning String}
+     */
+    extraTagClassFunction: function(text, email) {},
+
+    /**
+     * Function called after each adition or removal of email. It is passed an
+     * array of emails (strings) exactly as shown to the user. This callback is
+     * designed to do actions that depend on the current state os the email list field
+     * @type {function}
+     */
+    afterChangeCallback: function(formatted_emails) {}
+  };
+
+  // Email validation and extraction
+  // Email validation regexp: not the most restrictive regexp, but it does the trick
+  // Obs: it allows up case characters on email because we downcase them later, depending on option lowerEmailAddressCase
+  var emailRegexpString = "[-a-z0-9~!$%^&*_=+}{\\'?]+(\\.[-a-z0-9~!$%^&*_=+}{\\'?]+)*@([a-z0-9_][-a-z0-9_]*(\\.[-a-z0-9_]+)*\\.([a-z][a-z]+)|([0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}))(:[0-9]{1,5})?";
+  var EMAIL_REGEXP = new RegExp('^' + emailRegexpString + '$', 'i');
+  var NAME_AND_EMAIL_REGEXP = new RegExp('^[^<>]*<' + emailRegexpString + '>$', 'i');
+  var EMAIL_EXTRACTION_REGEXP = new RegExp('^([^<>]*)<(.+)>$');
+
+  //////////////////////////////////////////////////////////////////////////////
+  // Constructor
+  //////////////////////////////////////////////////////////////////////////////
+
+  var emailListFieldConstructor = function(containerId, options) {
+    this.containerId = containerId;
+    this.options = $.extend(DEFAULT_OPTIONS, options);
+    this._initAttributes();
+
+    // Taggle is the ui lib used to implement the "tagging effect" when you
+    // finish writting an email
+    this._initTaggle();
+
+    this._prepopulateTaggle();
+  }
+
+  //////////////////////////////////////////////////////////////////////////////
+  // Object public functions
+  //////////////////////////////////////////////////////////////////////////////
+
+  emailListFieldConstructor.prototype.addEmail = function(email_or_emails) {
+    this.taggleObject.add(email_or_emails);
+  }
+
+  emailListFieldConstructor.prototype.removeEmail = function(email) {
+    this.taggleObject.remove(email, true);
+  }
+
+  emailListFieldConstructor.prototype.clear = function() {
+    this.taggleObject.removeAll();
+  }
+
+  emailListFieldConstructor.prototype.getEmails = function() {
+    return this.taggleObject.getTags().values;
+  }
+
+  //////////////////////////////////////////////////////////////////////////////
+  // Object private functions
+  //////////////////////////////////////////////////////////////////////////////
+
+
+  // Initialization of necessary attributes
+  emailListFieldConstructor.prototype._initAttributes = function() {
+    // Creates array to keep track of current emails on taggle, for purposes of detecting duplicates
+    // We create this list to keep track of just the emails (without names)
+    this.emailsOnTaggle = [];
+  };
+
+  // Runs when user tries to add email with invalid format
+  // It will show a message tooltip if invalidEmailMessage is defined, otherwise does nothing
+  // Needs to receive taggle so it can show tooltip anchored to it
+  emailListFieldConstructor.prototype._onInvalidEmailCallback = function(invalidEmail) {
+    if (this.options.invalidEmailMessage) {
+      var input = this.taggleObject.getInput();
+
+      // shows tooltip for 3 seconds
+      $(input).
+        attr("title", "\"" + invalidEmail + "\" " + this.options.invalidEmailMessage).
+        tooltip("open");
+
+      setTimeout(function() {
+        $(input).
+          tooltip("close").
+          attr( "title", "" );
+      }, 3000);
+    }
+  }
+
+  // Runs when user tries to add duplicated email to list, and allowDuplicateEmails is false
+  // It will show a message tooltip if duplicatedEmailMessage is defined, otherwise does nothing
+  emailListFieldConstructor.prototype._onDuplicatedEmailsCallback = function(email) {
+    if (this.options.duplicatedEmailMessage) {
+      var input = this.taggleObject.getInput();
+
+      // shows tooltip for 3 seconds
+      $(input).
+        attr("title", "\"" + email + "\" " + this.options.duplicatedEmailMessage).
+        tooltip("open");
+
+      setTimeout(function() {
+        $(input).
+          tooltip("close").
+          attr( "title", "" );
+      }, 3000);
+    }
+  };
+
+  // Extracts email from either a string with an email or a string with a name
+  // and an email, like: Compound Name <email@domain.com>
+  // Returns null if format is invalid
+  emailListFieldConstructor.prototype._extractEmail = function(text) {
+    var trimmedText = text.trim();
+    if (EMAIL_REGEXP.test(trimmedText)) {
+      var email = trimmedText;
+    } else if (NAME_AND_EMAIL_REGEXP.test(text)) {
+      var email = trimmedText.match(EMAIL_EXTRACTION_REGEXP)[2];
+    } else {
+      return null;
+    }
+
+    return (this.options.lowerEmailAddressCase ? email.toLowerCase(): email);
+  };
+
+  // Pre-processes email or name + email, downcasing email address if necessary
+  emailListFieldConstructor.prototype._normalizeEmail = function(text) {
+    var newText = text.trim();
+
+    if (this.options.lowerEmailAddressCase) {
+      if (EMAIL_REGEXP.test(newText)) {
+        newText = newText.toLowerCase();
+      }
+      else {
+        var matchdata = newText.match(EMAIL_EXTRACTION_REGEXP);
+        var name = matchdata[1].trim();
+        var email = matchdata[2].toLowerCase().trim();
+        newText = name + ' <' + email + '>'
+      }
+    }
+
+    return newText;
+  };
+
+  // Checks if email is authorized to be added. It checks if email is valid and if not duplicated
+  emailListFieldConstructor.prototype._isEmailValidAndUnique = function(text) {
+    var email = this._extractEmail(text);
+
+    // prevents invalid email format
+    if (email == null) {
+      this._onInvalidEmailCallback(text);
+      return false;
+    }
+
+    // prevents duplicated email
+    if (this.options.allowDuplicateEmails || !this._includesEmail(email)) {
+      return true;
+    }
+    else {
+      this._onDuplicatedEmailsCallback(email);
+      return false;
+    };
+  }
+
+  // Checks wether email is currently in the list
+  emailListFieldConstructor.prototype._includesEmail = function(email) {
+    return this.emailsOnTaggle.indexOf(email) > -1
+  }
+
+  // Adds email to the list used to detect duplicates. It accepts text in the format "Name <email>" too
+  emailListFieldConstructor.prototype._recordEmailAdded = function(text) {
+    var email = this._extractEmail(text);
+    this.emailsOnTaggle.push(email);
+  }
+
+  // Removes email from the list used to detect duplicates. It accepts text in the format "Name <email>" too
+  emailListFieldConstructor.prototype._recordEmailRemoved = function(text) {
+    var email = this._extractEmail(text);
+    var emailIndex = this.emailsOnTaggle.indexOf(email);
+    if (emailIndex > -1) {
+      this.emailsOnTaggle.splice(emailIndex, 1);
+    }
+  }
+
+  // if add extra classes to tags, depending on the return of the options.extraTagClassFunction
+  emailListFieldConstructor.prototype._addExtraTagClassIfNecessary = function(text, li) {
+    var email = this._extractEmail(text);
+    var extraClasses = this.options.extraTagClassFunction(text, email);
+    if (extraClasses && extraClasses.length > 0) {
+      $(li).addClass(extraClasses);
+    }
+  }
+
+  // Checks wether email is known
+  emailListFieldConstructor.prototype._knowsEmail = function(email) {
+    return this.knownEmails.indexOf(email) > -1
+  }
+
+  // Initializes taggle, the lib that implements the tagging effect on the email
+  // list field.
+  emailListFieldConstructor.prototype._initTaggle = function() {
+    // creates scoped variable so we can acccess emailListField inside the taggle callbacks
+    var emailListField = this;
+
+    // adds taggle class to container
+    $('#' + this.containerId).addClass('taggle');
+
+    this.taggleObject = new Taggle(this.containerId, {
+      delimeter: new RegExp('[,;]'),    // splits emails on commas and semicolons (passing regexps here is not documented on taggle, but works)
+      submitKeys: [44, 9, 13, 27, 186], // keycodes: 9 (tab), 13 (enter), 27 (esc), 35 (end), 186 (semicolon). Ons: cannot use 188 (comma) because it is also de key of '<', which is a necessary character for emails with name
+      saveOnBlur: true,                 // tries to save the tag when user clicks away
+      hiddenInputName: this.options.inputName, // how the parameters are going to be submitted
+      placeholder: this.options.placeholderMessage, // message to show when there are no emails on list
+      allowDuplicates: true, // we implement our own duplicate detection, based on the email address only
+      preserveCase: true, // we deal with the case separately
+      tabIndex: 0, // makes tab select field in form
+
+      // prepares input element to show tooltip (for validation or duplicate messages)
+      inputFormatter: function(input) {
+        $(input).tooltip({position: {my:'left top', at: 'left bottom'}});
+      },
+
+      // prevents invalid or duplicated emails from being added to the list
+      onBeforeTagAdd: function(event, tag) {
+        return emailListField._isEmailValidAndUnique(tag);
+      },
+
+      // Formats the tag, normalizing email address and adding extra classes
+      tagFormatter: function(li) {
+        var text = $(li).find('.taggle_text').text();
+
+        // trims and downcases email (even when in format Name <email>)
+        text = emailListField._normalizeEmail(text);
+
+        // changes li and hidden input with new text
+        $(li).find('.taggle_text').text(text);
+        $(li).find('input[type="hidden"]').val(text);
+
+        emailListField._addExtraTagClassIfNecessary(text, li);
+
+        return li;
+      },
+
+      // records tags that are added, so to know if new candidate tags are duplicate
+      onTagAdd: function(event, tag) {
+        emailListField._recordEmailAdded(tag);
+        emailListField.options.afterChangeCallback(emailListField.getEmails());
+      },
+
+      // remove emails from list, so we don't think it is a duplicate if added again
+      onTagRemove: function(event, tag) {
+        emailListField._recordEmailRemoved(tag);
+        emailListField.options.afterChangeCallback(emailListField.getEmails());
+      }
+    });
+
+    // If knownFormattedEmails has elements, activate JQueryUI autocomplete
+    if (this.options.knownFormattedEmails.length > 0) {
+      var taggle = this.taggleObject;
+      $(this.taggleObject.getInput()).autocomplete({
+        source: this.options.knownFormattedEmails,
+        appendTo: this.taggleObject.getContainer(),
+        position: { at: "left bottom", of: this.taggleObject.getContainer() },
+        select: function(event, data) {
+          event.preventDefault();
+
+          // Add the tag only when the user clicks on autocomplete. If user selects
+          // another way (E.g.: down + enter/tab) the text will already be added as it
+          // is autocompleted on the input and added by taggle automatically
+          if (data && data.item && event.which == 1) {
+            taggle.add(data.item.value);
+          }
+        }
+      });
+    }
+  }
+
+  emailListFieldConstructor.prototype._prepopulateTaggle = function() {
+    for (var i=0; i<this.options.initialEmails.length; i++) {
+      this.addEmail(this.options.initialEmails[i]);
+    }
+  }
+
+  // returns contructor and calls the function so EmailListField is defined immediately
+  return emailListFieldConstructor;
+}();

data/app/assets/stylesheets/email_list_field.scss

@@ -0,0 +1,12 @@
+/*
+ * This is a manifest file that'll be compiled into application.css, which will include all the files
+ * listed below.
+ *
+ * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
+ * or vendor/assets/stylesheets of plugins, if any, can be referenced here using a relative path.
+ *
+ * You're free to add application-wide styles to this file and they'll appear at the top of the
+ * compiled file, but it's generally better to create a new file per style scope.
+ *
+ *= require taggle
+ */

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "email_list_field"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/email_list_field.gemspec

@@ -0,0 +1,39 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'email_list_field/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "email_list_field"
+  spec.version       = EmailListField::VERSION
+  spec.date          = '2016-09-29'
+  spec.authors       = ["Henrique Gubert"]
+  spec.email         = ["guberthenrique@hotmail.com"]
+
+  spec.summary       = %q{Produces email list fields for rails forms}
+  spec.description   = %q{This gem provides helper functions that allows you to add email list fields to your forms in a rails app. It also provides helper functions to process the submitted data on the controllers.}
+  spec.homepage      = "https://github.com/hsgubert/email_list_field"
+  spec.license       = "MIT"
+
+  # # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # # to allow pushing to a single host or delete this section to allow pushing to any host.
+  # if spec.respond_to?(:metadata)
+  #   spec.metadata['allowed_push_host'] = "TODO: Set to 'http://mygemserver.com'"
+  # else
+  #   raise "RubyGems 2.0 or newer is required to protect against public gem pushes."
+  # end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'rails', '>= 3.2', '< 5.0'
+  spec.add_runtime_dependency 'taggle', '0.1.2'
+  spec.add_runtime_dependency 'jquery-rails', '~>4'
+  spec.add_runtime_dependency 'jquery-ui-rails', '~>5.0'
+
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/email_list_field.rb

@@ -0,0 +1,8 @@
+require "email_list_field/version"
+require "email_list_field/engine"
+require "email_list_field/static_helpers"
+require "email_list_field/test_helpers"
+
+module EmailListField
+  extend EmailListField::StaticHelpers
+end

data/lib/email_list_field/engine.rb

@@ -0,0 +1,6 @@
+require 'taggle'
+
+module EmailListField
+  class Engine < Rails::Engine
+  end
+end

data/lib/email_list_field/static_helpers.rb

@@ -0,0 +1,34 @@
+module EmailListField::StaticHelpers
+  EMAIL_EXTRACTION_REGEXP = /^([^<>]*)<(.+)>$/
+
+  # Inputs
+  # => emails: an array of strings, where each string may be either an email or a "Name <email>" string
+  # => options:
+  #     :lower_email_address_case [true|false] default=true
+  #
+  # Output:
+  # => an array of pairs [name, email], where name might be nil
+  #
+  def parse_email_list_params(emails, options={})
+    return [] unless emails
+
+    lower_email_address_case = (!options[:lower_email_address_case].nil? ? options[:lower_email_address_case] : true)
+
+    emails.map do |formatted_email|
+      stripped_formatted_email = formatted_email.strip
+
+      if matchdata = stripped_formatted_email.match(EmailListField::StaticHelpers::EMAIL_EXTRACTION_REGEXP)
+        parsed_email = [matchdata[1].strip, matchdata[2].strip]
+      else
+        parsed_email = [nil, stripped_formatted_email]
+      end
+
+      if lower_email_address_case
+        parsed_email[1].downcase!
+      end
+
+      parsed_email
+    end
+  end
+
+end

data/lib/email_list_field/test_helpers.rb

@@ -0,0 +1,23 @@
+# Defines helpers to be used in feature/integration tests in the target app.
+# These helpers work for a RSpec + Capybara + PhantomJS test suite (javascript
+# must be enabled)
+#
+# To include these helpers add to your spec/spec_helper.rb or to you spec/rails_helper.rb:
+#
+#   RSpec.configure do |config|
+#     config.include EmailListField::TestHelpers, type: :feature
+#   end
+#
+module EmailListField::TestHelpers
+
+  def fill_in_email_list_field(wrapper_id, options={})
+    with = options.delete(:with)
+    fill_options = options.delete(:fill_options)
+    find('#' + wrapper_id + ' input.taggle_input').set(with, fill_options)
+  end
+
+  def remove_from_email_list_field(wrapper_id, formatted_email)
+    find('#' + wrapper_id + ' li', text: formatted_email).find('button', visible: false).trigger('click')
+  end
+
+end

data/lib/email_list_field/version.rb

@@ -0,0 +1,3 @@
+module EmailListField
+  VERSION = "1.1.0"
+end

metadata

@@ -0,0 +1,171 @@
+--- !ruby/object:Gem::Specification
+name: email_list_field
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Henrique Gubert
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-09-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: taggle
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.1.2
+- !ruby/object:Gem::Dependency
+  name: jquery-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: jquery-ui-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: This gem provides helper functions that allows you to add email list
+  fields to your forms in a rails app. It also provides helper functions to process
+  the submitted data on the controllers.
+email:
+- guberthenrique@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- app/assets/javascripts/email_list_field.js
+- app/assets/javascripts/jquery-email_list_field/email_list_field.js
+- app/assets/stylesheets/email_list_field.scss
+- bin/console
+- bin/setup
+- email_list_field.gemspec
+- lib/email_list_field.rb
+- lib/email_list_field/engine.rb
+- lib/email_list_field/static_helpers.rb
+- lib/email_list_field/test_helpers.rb
+- lib/email_list_field/version.rb
+- preview.gif
+homepage: https://github.com/hsgubert/email_list_field
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Produces email list fields for rails forms
+test_files: []