emphatic_invalids 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: be0c11a04ab5a8f6858261623ad4de8f87688df6
+  data.tar.gz: 0b58370c0947581c63ec0a7344ed4419071f0eda
+SHA512:
+  metadata.gz: d42196fcb78a400476ee9c4ab6aca85aa17026c694695d956d298bedc422e515974f15849416f171ac49d9de5233e3f738558731f94ba0b8064eeaedafde2341
+  data.tar.gz: 25f0aca44b3f376bf41538b6a7c9218da6ddaac8f6b0996b66ace38eb48c6dd3c74a24b6daa0a6895a8996c951f47e851dfe08ec3b262c6da49fccceef2c871f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 John OMalley
+
+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,36 @@
+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    = 'EmphaticInvalids'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+APP_RAKEFILE = File.expand_path("../test/dummy/Rakefile", __FILE__)
+load 'rails/tasks/engine.rake'
+
+
+load 'rails/tasks/statistics.rake'
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/app/assets/config/emphatic_invalids_manifest.js

@@ -0,0 +1,2 @@
+//= link_directory ../javascripts/emphatic_invalids .js
+//= link_directory ../stylesheets/emphatic_invalids .css

data/app/assets/javascripts/emphatic_invalids/application.js

@@ -0,0 +1,2 @@
+
+//= require_tree .

data/app/assets/javascripts/emphatic_invalids/script.js.coffee

@@ -0,0 +1,86 @@
+#= require jquery
+#= require jquery-ui/tooltip
+#= require jquery_ujs
+
+parentOrSelf = (input, selector) ->
+  if $(input).closest(selector).length then $(input).closest(selector) else input
+
+mostTargetedElement = (input, attr) ->
+  selector = $(input).attr(attr) ? $(input.closest("form")).attr(attr)
+  element = parentOrSelf(input, selector)
+
+showPosException = true
+tooltipPosition = (element, attr="data-ei-tooltip-position") ->
+  posStr = $(element).attr(attr) ? $(element.closest("form")).attr(attr) ? '{"my": "left+15 center", "at": "right center"}'
+  try
+    $.parseJSON(posStr)
+  catch exception
+    if showPosException
+      console.error "EmphaticInvalids gem: Check the format of the value of any ei-tooltip-position attributes you may be using. They need to be valid JSON strings."
+      console.error exception
+      showPosException = false
+    posStr = $.parseJSON('{"my": "left+15 center", "at": "right center"}')
+
+class InvalidField
+  constructor: (@input, @value) ->
+    @input.addClass("invalid-field")
+    highlightElement = mostTargetedElement(@input, "data-ei-highlight-element")
+    highlightElement.addClass("highlight-error")
+    tooltipElement = mostTargetedElement(@input, "data-ei-tooltip-element")
+    $(tooltipElement).tooltip(
+      tooltipClass: "error-tooltips"
+      position: tooltipPosition(tooltipElement)
+    )
+    $(tooltipElement).attr("title", @value) #set title so tooltip displays it
+
+resetTabIndex = (form) ->
+  # clear all (including valid fields) tab indexes
+  $(form).find(":input").removeAttr( "tabindex" )
+
+highlightInvalidFields = (form, data) ->
+  resetTabIndex(form)
+  errorStr = data.error().responseText
+  console.log("EmphaticInvalids: "+errorStr) if !!$(form).find("#log-invalids").length > 0
+  try
+    errors = $.parseJSON(errorStr)
+  catch exception
+    console.error exception
+    alert("Make sure all required fields have been filled in and the values are in the proper format. For more details view your browser's console log.")
+    errors = {}
+
+  i = 1
+
+  for own fieldName, value of errors
+    
+    # name and/or id attribute equals exactly "fieldName"
+    # name attribute ends in "[fieldName]" or "[fieldName][]"
+    # data-ei-field-alias attribute equals fieldName
+    
+    naFieldName = fieldName
+    fieldName = fieldName.replace(/\./g, "_attributes][") #This takes care of attributes
+    naFieldName = naFieldName.replace(/\./g, "_attributes][0][") #This takes care of accepts_nested_attributes_for has_many attributes
+    input = $(form).find("[name='"+fieldName+"'], [id='"+fieldName+"'], [name$='["+fieldName+"]'], [name$='["+naFieldName+"]'], [name$='["+fieldName+"][]'], [data-ei-field-alias='"+fieldName+"']").not(":hidden")
+
+    $(input).attr("tabindex", i++) #set tab order for just invalid fields
+    
+    invalidField = new InvalidField input, value
+
+    $(input).on('change', ->
+      highlightedElement = mostTargetedElement(this, "data-ei-highlight-element")
+      tooltipElement = mostTargetedElement(this, "data-ei-tooltip-element")
+      $(highlightedElement).removeClass("highlight-error")
+      $(tooltipElement).tooltip("destroy") if !!$(tooltipElement).data("ui-tooltip")
+      $(tooltipElement).removeAttr("title")
+      $(this).removeClass("invalid-field")
+    )
+
+  $(form).find(".invalid-field").first().focus() #set focus to the first highlighted field
+  
+  btn = $(form).find("input[type='submit'], button[type='submit'], input[type='image']").first()
+  btn.attr("tabindex", i++) #submit button gets next tab order after all invalid fields
+
+window.EmphaticInvalids = {}
+window.EmphaticInvalids.registerForms = (selector="form[data-remote=true]") ->
+  $("body").on("ajax:error", selector, (event, data, status, xhr) ->
+    highlightInvalidFields(this, data)
+  )

data/app/assets/stylesheets/emphatic_invalids/application.css

@@ -0,0 +1,4 @@
+/*
+ *= require_tree .
+ *= require_self
+ */

data/app/assets/stylesheets/emphatic_invalids/style.css

@@ -0,0 +1,16 @@
+/*
+ *= require jquery-ui/tooltip
+*/
+
+.highlight-error {
+	border: solid 2px #a94442;
+  background-color: #fcf8e3;
+}
+
+.error-tooltips {
+	font-size: 12px !important;
+	color: white !important;
+	border-color: red !important;
+	background: #a94442 !important;
+	opacity:0.95;
+}

data/app/controllers/concerns/emphatic_invalids/renderer.rb

@@ -0,0 +1,14 @@
+module EmphaticInvalids::Renderer
+	
+	def emphasize_invalids(resource, format)
+		# flash[:error] = error_message(resource) #TODO may want to make this an option
+		format.js { render json: resource.errors, status: :unprocessable_entity }
+  end
+
+  private
+
+  def error_message(resource)
+    "Unable to #{action_name} #{resource.class.to_s.humanize}: #{ resource.errors.full_messages.join(', ') }"
+  end
+
+end

data/lib/emphatic_invalids/engine.rb

@@ -0,0 +1,10 @@
+module EmphaticInvalids
+  class Engine < ::Rails::Engine
+    isolate_namespace EmphaticInvalids
+    require 'jquery-rails'
+    require 'jquery-ui-rails'
+    initializer "emphatic_invalids.load_render_helper" do |app|
+	    ActionController::Base.send :include, EmphaticInvalids::Renderer
+	  end
+  end
+end

data/lib/emphatic_invalids/version.rb

@@ -0,0 +1,3 @@
+module EmphaticInvalids
+  VERSION = '0.0.1'
+end

data/lib/emphatic_invalids.rb

@@ -0,0 +1 @@
+require "emphatic_invalids/engine"

data/test/dummy/Rakefile

@@ -0,0 +1,6 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require_relative 'config/application'
+
+Rails.application.load_tasks

data/test/dummy/app/assets/config/manifest.js

@@ -0,0 +1,5 @@
+
+//= link_tree ../images
+//= link_directory ../javascripts .js
+//= link_directory ../stylesheets .css
+//= link emphatic_invalids_manifest.js

data/test/dummy/app/assets/javascripts/application.js.coffee

@@ -0,0 +1,6 @@
+#= require_tree .
+#= require emphatic_invalids/script.coffee
+
+$(document).ready( ->
+  window.EmphaticInvalids.registerForms()
+)

data/test/dummy/app/assets/stylesheets/application.css

@@ -0,0 +1,5 @@
+/*
+ *= require emphatic_invalids/style.css
+ *= require_tree .
+ *= require_self
+ */

data/test/dummy/app/assets/stylesheets/registrations.css

@@ -0,0 +1,21 @@
+.rb-group {
+	border: solid 1px gray; 
+	border-radius: 7px; 
+	width: 200px; 
+	padding: 5px; 
+	margin: 5px;
+}
+
+.highlight-error {
+	border: solid 2px #a94442;
+  /*background-color: inherit;*/
+}
+
+.error-tooltips {
+	font-size: 16px !important;
+	font-style: italic;
+	/*color: white !important;
+	border-color: red !important;
+	background: #a94442 !important;
+	opacity:0.95;*/
+}

data/test/dummy/app/assets/stylesheets/scaffold.css

@@ -0,0 +1,80 @@
+body {
+  background-color: #fff;
+  color: #333;
+  margin: 33px;
+}
+
+body, p, ol, ul, td {
+  font-family: verdana, arial, helvetica, sans-serif;
+  font-size: 13px;
+  line-height: 18px;
+}
+
+pre {
+  background-color: #eee;
+  padding: 10px;
+  font-size: 11px;
+}
+
+a {
+  color: #000;
+}
+
+a:visited {
+  color: #666;
+}
+
+a:hover {
+  color: #fff;
+  background-color: #000;
+}
+
+th {
+  padding-bottom: 5px;
+}
+
+td {
+  padding: 0 5px 7px;
+}
+
+div.field,
+div.actions {
+  margin-bottom: 10px;
+}
+
+#notice {
+  color: green;
+}
+
+.field_with_errors {
+  padding: 2px;
+  background-color: red;
+  display: table;
+}
+
+#error_explanation {
+  width: 450px;
+  border: 2px solid red;
+  padding: 7px 7px 0;
+  margin-bottom: 20px;
+  background-color: #f0f0f0;
+}
+
+#error_explanation h2 {
+  text-align: left;
+  font-weight: bold;
+  padding: 5px 5px 5px 15px;
+  font-size: 12px;
+  margin: -7px -7px 0;
+  background-color: #c00;
+  color: #fff;
+}
+
+#error_explanation ul li {
+  font-size: 12px;
+  list-style: square;
+}
+
+label {
+  display: block;
+}

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery with: :exception
+end

data/test/dummy/app/controllers/registrations_controller.rb

@@ -0,0 +1,71 @@
+class RegistrationsController < ApplicationController
+  before_action :set_registration, only: [:show, :edit, :update, :destroy]
+
+  # GET /registrations
+  def index
+    @registrations = Registration.all
+  end
+
+  # GET /registrations/1
+  def show
+  end
+
+  # GET /registrations/new
+  def new
+    @registration = Registration.new
+    @address = @registration.build_address
+    @county = @address.build_county
+  end
+
+  # GET /registrations/1/edit
+  def edit
+    @address = @registration.address || @registration.build_address
+    @county = @address.county || @address.build_county
+  end
+
+  # POST /registrations
+  def create
+    @registration = Registration.new(registration_params)
+    respond_to do |format|
+      if @registration.save
+        format.html { redirect_to @registration, notice: 'Registration was successfully created.' }
+        flash.now[:notice] = 'Registration was successfully created.'
+        format.js { render :success }
+      else
+        # format.html { render :new }
+        emphasize_invalids(@registration, format)
+      end
+    end
+  end
+
+  # PATCH/PUT /registrations/1
+  def update
+    respond_to do |format|
+      if @registration.update(registration_params)
+        format.html { redirect_to @registration, notice: 'Registration was successfully updated.' }
+        flash.now[:notice] = 'Registration was successfully updated.'
+        format.js { render :success }
+      else
+        # render :edit
+        emphasize_invalids(@registration, format)
+      end
+    end
+  end
+
+  # DELETE /registrations/1
+  def destroy
+    @registration.destroy
+    redirect_to registrations_url, notice: 'Registration was successfully destroyed.'
+  end
+
+  private
+    # Use callbacks to share common setup or constraints between actions.
+    def set_registration
+      @registration = Registration.find(params[:id])
+    end
+
+    # Only allow a trusted parameter "white list" through.
+    def registration_params
+      params.require(:registration).permit(:first_name, :middle_initial, :last_name, :email, :age, :date_of_birth, :accept_terms, :sex, :favorite_color, { prog_language_ids: [] }, address_attributes: [ :id, :street, :city, :state, :zip, county_attributes: [:id, :name] ])
+    end
+end

data/test/dummy/app/models/address.rb

@@ -0,0 +1,7 @@
+class Address < ApplicationRecord
+	belongs_to :registration
+	validates :street, :city, :state, :zip, presence: true
+	has_one :county
+	accepts_nested_attributes_for :county
+
+end

data/test/dummy/app/models/application_record.rb

@@ -0,0 +1,3 @@
+class ApplicationRecord < ActiveRecord::Base
+  self.abstract_class = true
+end

data/test/dummy/app/models/county.rb

@@ -0,0 +1,5 @@
+class County < ApplicationRecord
+	belongs_to :address
+
+	validates :name, presence: true
+end

data/test/dummy/app/models/known_prog_language.rb

@@ -0,0 +1,4 @@
+class KnownProgLanguage < ApplicationRecord
+	belongs_to :registration
+	belongs_to :prog_language
+end

data/test/dummy/app/models/prog_language.rb

@@ -0,0 +1,6 @@
+class ProgLanguage < ApplicationRecord
+	has_many :known_prog_languages
+	has_many :registrations, -> { distinct }, through: :known_prog_languages
+
+	validates :name, presence: true
+end

data/test/dummy/app/models/registration.rb

@@ -0,0 +1,25 @@
+class Registration < ApplicationRecord
+	has_many :known_prog_languages
+	has_many :prog_languages, -> { distinct }, through: :known_prog_languages
+	
+	
+
+	validates :first_name, :last_name, :email, presence: true
+	validates :age, numericality: { greater_than_or_equal_to: 21 }
+	validate  :dob_in_past
+	validates :sex, presence: true
+	has_one :address
+	accepts_nested_attributes_for :address
+	validates :favorite_color, format: { without: /\A#(000000|FFFFFF)\z/i }
+	validates :prog_language_ids, presence: true
+	validates :accept_terms, acceptance: { accept: true }
+
+	def kpl_selections
+		known_prog_languages.pluck(:prog_language_id)
+	end
+
+	private
+	def dob_in_past
+		errors.add(:date_of_birth, "must be in the past")	unless date_of_birth < Time.now
+	end
+end

data/test/dummy/app/views/layouts/application.html.haml

@@ -0,0 +1,10 @@
+%html
+	%head
+		%title EmphaticInvalids Test site
+		= csrf_meta_tags 
+
+		= stylesheet_link_tag    'application', media: 'all' 
+		= javascript_include_tag 'application' 
+	%body
+		%div#content-wrapper
+			= yield

data/test/dummy/app/views/registrations/_form.html.haml

@@ -0,0 +1,64 @@
+= form_with(model: registration, html: {style: "width: 700px;"}, local: false, data: { "highlight-errors" => true, "ei-tooltip-position" => '{"my": "left+2 center", "at": "right center"}' }) do |form|
+  = form.hidden_field "log-invalids", id: "log-invalids"
+  %div.field
+    = form.label :first_name
+    = form.text_field :first_name, id: :registration_first_name
+  %div.field
+    = form.label :middle_initial
+    = form.text_field :middle_initial, id: :registration_middle_initial
+  %div.field
+    = form.label :last_name
+    = form.text_field :last_name, id: :registration_last_name
+  %div.field
+    = form.label :email
+    = form.text_field :email, id: :registration_email
+  %div.field
+    = form.label :age
+    = form.number_field :age, id: :registration_age
+  %div.field{style: "width: 250px;" , "data-ei-field-alias" => "date_of_birth"}
+    = form.label :date_of_birth
+    = form.date_select :date_of_birth, id: :registration_date_of_birth
+    
+  %fieldset.rb-group
+    %span
+      = form.label :sex do
+        %b Sex
+      = form.radio_button :sex, "Male", style: "display: inline;", data: { "ei-tooltip-element" => "fieldset.rb-group", "ei-highlight-element" => "fieldset.rb-group" }
+      = form.label :sex, "Male", value: "M", style: "display: inline;"
+      = form.radio_button :sex, "Female", style: "display: inline;", data: { "ei-tooltip-element" => "fieldset.rb-group", "ei-highlight-element" => "fieldset.rb-group" }
+      = form.label :sex, "Female", value: "F", style: "display: inline;"
+
+  %div{style: "width: 300px;"}
+    %b Address
+    = form.fields_for :address, @address do |address|
+      %div.field
+        = address.label :street
+        = address.text_field :street
+      %div.field
+        = address.label :city
+        = address.text_field :city
+      %div.field
+        = address.label :state
+        = address.text_field :state
+      %div.field
+        = address.label :zip
+        = address.text_field :zip
+        %div{style: "padding-left: 30px"}
+          %b County
+          = address.fields_for :county, @county do |county|
+            %div.field
+              = county.label :name
+              = county.text_field :name
+
+  %div.field{ style: "width: 150px;", "data-ei-tooltip-position" => '{"my": "left+50 center", "at": "right center"}' }
+    = form.label :favorite_color
+    = form.color_field :favorite_color, data: { "ei-highlight-element" => ".field", "ei-tooltip-element" => ".field" }
+  %div.field
+    = form.label :prog_language_ids
+    = form.select :prog_language_ids, options_from_collection_for_select(ProgLanguage.all.order(:name), "id", "name", registration.kpl_selections), {}, { multiple: true, size: 3, id: "known_prog_language_ids" }
+  %div.field{ style: "width: 150px;" }
+    = form.check_box :accept_terms, {id: :accept_terms, data: { "ei-tooltip-element" => ".field", "ei-highlight-element" => ".field" } }, true, false
+    = form.label :accept_terms, "I accept the terms", style: "display: inline;"
+
+  %div.actions
+    = form.submit

data/test/dummy/app/views/registrations/_registration.html.haml

@@ -0,0 +1,24 @@
+%p#notice= notice
+
+%p
+  %strong First name:
+  = registration.first_name
+%p
+  %strong Middle initial:
+  = registration.middle_initial
+%p
+  %strong Last name:
+  = registration.last_name
+%p
+  %strong Email:
+  = registration.email
+%p
+  %strong Age:
+  = registration.age
+%p
+  %strong Date of birth:
+  = registration.date_of_birth
+
+= link_to 'Edit', edit_registration_path(registration)
+|
+= link_to 'Back', registrations_path

data/test/dummy/app/views/registrations/edit.html.haml

@@ -0,0 +1,7 @@
+<h1>Editing Registration</h1>
+
+= render 'form', registration: @registration
+
+= link_to 'Show', @registration
+|
+= link_to 'Back', registrations_path

data/test/dummy/app/views/registrations/index.html.haml

@@ -0,0 +1,28 @@
+%p#notice= notice
+%h1 Registrations
+
+%table
+  %thead
+    %tr
+      %th First name
+      %th Middle initial
+      %th Last name
+      %th Email
+      %th Age
+      %th Date of birth
+      %th{ colspan: "3" }
+  %tbody
+    - @registrations.each do |registration|
+      %tr
+        %td= registration.first_name
+        %td= registration.middle_initial
+        %td= registration.last_name
+        %td= registration.email
+        %td= registration.age
+        %td= registration.date_of_birth
+        %td= link_to 'Show', registration
+        %td= link_to 'Edit', edit_registration_path(registration)
+        %td= link_to 'Destroy', registration, method: :delete, data: { confirm: 'Are you sure?' }
+%br/
+
+= link_to 'New Registration', new_registration_path

data/test/dummy/app/views/registrations/new.html.haml

@@ -0,0 +1,5 @@
+%h1 Register
+
+= render 'form', registration: @registration
+
+= link_to 'Back', registrations_path

data/test/dummy/app/views/registrations/show.html.haml

@@ -0,0 +1 @@
+= render 'registration', registration: @registration

data/test/dummy/app/views/registrations/success.js.erb

@@ -0,0 +1,2 @@
+$("body").html("<%= j render(@registration) %>")
+$("p#notice").html("<%= j flash.map{ |k,v| v }.join(', ') %>")

data/test/dummy/bin/bundle

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path('../../Gemfile', __FILE__)
+load Gem.bin_path('bundler', 'bundle')

data/test/dummy/bin/rails

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+APP_PATH = File.expand_path('../config/application', __dir__)
+require_relative '../config/boot'
+require 'rails/commands'

data/test/dummy/bin/rake

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require_relative '../config/boot'
+require 'rake'
+Rake.application.run