resourcy-rails 1.0.0 → 1.0.1

data/LICENSE

@@ -3,7 +3,7 @@ Resourcy is an unobtrusive RESTful adapter for jquery-ujs and Rails.
 Documentation and other useful information can be found at
 https://github.com/jejacks0n/resourcy
 
-Copyright (c) 2011 Jeremy Jackson
+Copyright (c) 2012 Jeremy Jackson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/resourcy/version.rb

@@ -1,3 +1,3 @@
 module Resourcy
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/dummy/app/assets/javascripts/jquery_ujs.js

@@ -0,0 +1,429 @@
+(function($, undefined) {
+
+  /**
+   * Unobtrusive scripting adapter for jQuery
+   *
+   * Requires jQuery 1.6.0 or later.
+   * https://github.com/rails/jquery-ujs
+
+   * Uploading file using rails.js
+   * =============================
+   *
+   * By default, browsers do not allow files to be uploaded via AJAX. As a result, if there are any non-blank file fields
+   * in the remote form, this adapter aborts the AJAX submission and allows the form to submit through standard means.
+   *
+   * The `ajax:aborted:file` event allows you to bind your own handler to process the form submission however you wish.
+   *
+   * Ex:
+   *     $('form').live('ajax:aborted:file', function(event, elements){
+   *       // Implement own remote file-transfer handler here for non-blank file inputs passed in `elements`.
+   *       // Returning false in this handler tells rails.js to disallow standard form submission
+   *       return false;
+   *     });
+   *
+   * The `ajax:aborted:file` event is fired when a file-type input is detected with a non-blank value.
+   *
+   * Third-party tools can use this hook to detect when an AJAX file upload is attempted, and then use
+   * techniques like the iframe method to upload the file instead.
+   *
+   * Required fields in rails.js
+   * ===========================
+   *
+   * If any blank required inputs (required="required") are detected in the remote form, the whole form submission
+   * is canceled. Note that this is unlike file inputs, which still allow standard (non-AJAX) form submission.
+   *
+   * The `ajax:aborted:required` event allows you to bind your own handler to inform the user of blank required inputs.
+   *
+   * !! Note that Opera does not fire the form's submit event if there are blank required inputs, so this event may never
+   *    get fired in Opera. This event is what causes other browsers to exhibit the same submit-aborting behavior.
+   *
+   * Ex:
+   *     $('form').live('ajax:aborted:required', function(event, elements){
+   *       // Returning false in this handler tells rails.js to submit the form anyway.
+   *       // The blank required inputs are passed to this function in `elements`.
+   *       return ! confirm("Would you like to submit the form with missing info?");
+   *     });
+   */
+
+  // Cut down on the number if issues from people inadvertently including jquery_ujs twice
+  // by detecting and raising an error when it happens.
+  var alreadyInitialized = function() {
+    var events = $._data(document, 'events');
+    return events && events.click && $.grep(events.click, function(e) { return e.namespace === 'rails'; }).length;
+  }
+
+  if ( alreadyInitialized() ) {
+    $.error('jquery-ujs has already been loaded!');
+  }
+
+  // Shorthand to make it a little easier to call public rails functions from within rails.js
+  var rails;
+
+  $.rails = rails = {
+    // Link elements bound by jquery-ujs
+    linkClickSelector: 'a[data-confirm], a[data-method], a[data-remote], a[data-disable-with]',
+
+    // Select elements bound by jquery-ujs
+    inputChangeSelector: 'select[data-remote], input[data-remote], textarea[data-remote]',
+
+    // Form elements bound by jquery-ujs
+    formSubmitSelector: 'form',
+
+    // Form input elements bound by jquery-ujs
+    formInputClickSelector: 'form input[type=submit], form input[type=image], form button[type=submit], form button:not([type])',
+
+    // Form input elements disabled during form submission
+    disableSelector: 'input[data-disable-with], button[data-disable-with], textarea[data-disable-with]',
+
+    // Form input elements re-enabled after form submission
+    enableSelector: 'input[data-disable-with]:disabled, button[data-disable-with]:disabled, textarea[data-disable-with]:disabled',
+
+    // Form required input elements
+    requiredInputSelector: 'input[name][required]:not([disabled]),textarea[name][required]:not([disabled])',
+
+    // Form file input elements
+    fileInputSelector: 'input:file',
+
+    // Link onClick disable selector with possible reenable after remote submission
+    linkDisableSelector: 'a[data-disable-with]',
+
+    // Make sure that every Ajax request sends the CSRF token
+    CSRFProtection: function(xhr) {
+      var token = $('meta[name="csrf-token"]').attr('content');
+      if (token) xhr.setRequestHeader('X-CSRF-Token', token);
+    },
+
+    // Triggers an event on an element and returns false if the event result is false
+    fire: function(obj, name, data) {
+      var event = $.Event(name);
+      obj.trigger(event, data);
+      return event.result !== false;
+    },
+
+    // Default confirm dialog, may be overridden with custom confirm dialog in $.rails.confirm
+    confirm: function(message) {
+      return confirm(message);
+    },
+
+    // Default ajax function, may be overridden with custom function in $.rails.ajax
+    ajax: function(options) {
+      return $.ajax(options);
+    },
+
+    // Default way to get an element's href. May be overridden at $.rails.href.
+    href: function(element) {
+      return element.attr('href');
+    },
+
+    // Submits "remote" forms and links with ajax
+    handleRemote: function(element) {
+      var method, url, data, elCrossDomain, crossDomain, withCredentials, dataType, options;
+
+      if (rails.fire(element, 'ajax:before')) {
+        elCrossDomain = element.data('cross-domain');
+        crossDomain = elCrossDomain === undefined ? null : elCrossDomain;
+        withCredentials = element.data('with-credentials') || null;
+        dataType = element.data('type') || ($.ajaxSettings && $.ajaxSettings.dataType);
+
+        if (element.is('form')) {
+          method = element.attr('method');
+          url = element.attr('action');
+          data = element.serializeArray();
+          // memoized value from clicked submit button
+          var button = element.data('ujs:submit-button');
+          if (button) {
+            data.push(button);
+            element.data('ujs:submit-button', null);
+          }
+        } else if (element.is(rails.inputChangeSelector)) {
+          method = element.data('method');
+          url = element.data('url');
+          data = element.serialize();
+          if (element.data('params')) data = data + "&" + element.data('params');
+        } else {
+          method = element.data('method');
+          url = rails.href(element);
+          data = element.data('params') || null;
+        }
+
+        options = {
+          type: method || 'GET', data: data, dataType: dataType,
+          // stopping the "ajax:beforeSend" event will cancel the ajax request
+          beforeSend: function(xhr, settings) {
+            if (settings.dataType === undefined) {
+              xhr.setRequestHeader('accept', '*/*;q=0.5, ' + settings.accepts.script);
+            }
+            return rails.fire(element, 'ajax:beforeSend', [xhr, settings]);
+          },
+          success: function(data, status, xhr) {
+            element.trigger('ajax:success', [data, status, xhr]);
+          },
+          complete: function(xhr, status) {
+            element.trigger('ajax:complete', [xhr, status]);
+          },
+          error: function(xhr, status, error) {
+            element.trigger('ajax:error', [xhr, status, error]);
+          },
+          xhrFields: {
+            withCredentials: withCredentials
+          },
+          crossDomain: crossDomain
+        };
+        // Only pass url to `ajax` options if not blank
+        if (url) { options.url = url; }
+
+        var jqxhr = rails.ajax(options);
+        element.trigger('ajax:send', jqxhr);
+        return jqxhr;
+      } else {
+        return false;
+      }
+    },
+
+    // Handles "data-method" on links such as:
+    // <a href="/users/5" data-method="delete" rel="nofollow" data-confirm="Are you sure?">Delete</a>
+    handleMethod: function(link) {
+      var href = rails.href(link),
+          method = link.data('method'),
+          target = link.attr('target'),
+          csrf_token = $('meta[name=csrf-token]').attr('content'),
+          csrf_param = $('meta[name=csrf-param]').attr('content'),
+          form = $('<form method="post" action="' + href + '"></form>'),
+          metadata_input = '<input name="_method" value="' + method + '" type="hidden" />';
+
+      if (csrf_param !== undefined && csrf_token !== undefined) {
+        metadata_input += '<input name="' + csrf_param + '" value="' + csrf_token + '" type="hidden" />';
+      }
+
+      if (target) { form.attr('target', target); }
+
+      form.hide().append(metadata_input).appendTo('body');
+      form.submit();
+    },
+
+    /* Disables form elements:
+     - Caches element value in 'ujs:enable-with' data store
+     - Replaces element text with value of 'data-disable-with' attribute
+     - Sets disabled property to true
+     */
+    disableFormElements: function(form) {
+      form.find(rails.disableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        element.data('ujs:enable-with', element[method]());
+        element[method](element.data('disable-with'));
+        element.prop('disabled', true);
+      });
+    },
+
+    /* Re-enables disabled form elements:
+     - Replaces element text with cached value from 'ujs:enable-with' data store (created in `disableFormElements`)
+     - Sets disabled property to false
+     */
+    enableFormElements: function(form) {
+      form.find(rails.enableSelector).each(function() {
+        var element = $(this), method = element.is('button') ? 'html' : 'val';
+        if (element.data('ujs:enable-with')) element[method](element.data('ujs:enable-with'));
+        element.prop('disabled', false);
+      });
+    },
+
+    /* For 'data-confirm' attribute:
+     - Fires `confirm` event
+     - Shows the confirmation dialog
+     - Fires the `confirm:complete` event
+
+     Returns `true` if no function stops the chain and user chose yes; `false` otherwise.
+     Attaching a handler to the element's `confirm` event that returns a `falsy` value cancels the confirmation dialog.
+     Attaching a handler to the element's `confirm:complete` event that returns a `falsy` value makes this function
+     return false. The `confirm:complete` event is fired whether or not the user answered true or false to the dialog.
+     */
+    allowAction: function(element) {
+      var message = element.data('confirm'),
+          answer = false, callback;
+      if (!message) { return true; }
+
+      if (rails.fire(element, 'confirm')) {
+        answer = rails.confirm(message);
+        callback = rails.fire(element, 'confirm:complete', [answer]);
+      }
+      return answer && callback;
+    },
+
+    // Helper function which checks for blank inputs in a form that match the specified CSS selector
+    blankInputs: function(form, specifiedSelector, nonBlank) {
+      var inputs = $(), input, valueToCheck,
+          selector = specifiedSelector || 'input,textarea',
+          allInputs = form.find(selector);
+
+      allInputs.each(function() {
+        input = $(this);
+        valueToCheck = input.is(':checkbox,:radio') ? input.is(':checked') : input.val();
+        // If nonBlank and valueToCheck are both truthy, or nonBlank and valueToCheck are both falsey
+        if (!valueToCheck === !nonBlank) {
+
+          // Don't count unchecked required radio if other radio with same name is checked
+          if (input.is(':radio') && allInputs.filter('input:radio:checked[name="' + input.attr('name') + '"]').length) {
+            return true; // Skip to next input
+          }
+
+          inputs = inputs.add(input);
+        }
+      });
+      return inputs.length ? inputs : false;
+    },
+
+    // Helper function which checks for non-blank inputs in a form that match the specified CSS selector
+    nonBlankInputs: function(form, specifiedSelector) {
+      return rails.blankInputs(form, specifiedSelector, true); // true specifies nonBlank
+    },
+
+    // Helper function, needed to provide consistent behavior in IE
+    stopEverything: function(e) {
+      $(e.target).trigger('ujs:everythingStopped');
+      e.stopImmediatePropagation();
+      return false;
+    },
+
+    // find all the submit events directly bound to the form and
+    // manually invoke them. If anyone returns false then stop the loop
+    callFormSubmitBindings: function(form, event) {
+      var events = form.data('events'), continuePropagation = true;
+      if (events !== undefined && events['submit'] !== undefined) {
+        $.each(events['submit'], function(i, obj){
+          if (typeof obj.handler === 'function') return continuePropagation = obj.handler(event);
+        });
+      }
+      return continuePropagation;
+    },
+
+    //  replace element's html with the 'data-disable-with' after storing original html
+    //  and prevent clicking on it
+    disableElement: function(element) {
+      element.data('ujs:enable-with', element.html()); // store enabled state
+      element.html(element.data('disable-with')); // set to disabled state
+      element.bind('click.railsDisable', function(e) { // prevent further clicking
+        return rails.stopEverything(e);
+      });
+    },
+
+    // restore element to its original state which was disabled by 'disableElement' above
+    enableElement: function(element) {
+      if (element.data('ujs:enable-with') !== undefined) {
+        element.html(element.data('ujs:enable-with')); // set to old enabled state
+        // this should be element.removeData('ujs:enable-with')
+        // but, there is currently a bug in jquery which makes hyphenated data attributes not get removed
+        element.data('ujs:enable-with', false); // clean up cache
+      }
+      element.unbind('click.railsDisable'); // enable element
+    }
+
+  };
+
+  if (rails.fire($(document), 'rails:attachBindings')) {
+
+    $.ajaxPrefilter(function(options, originalOptions, xhr){ if ( !options.crossDomain ) { rails.CSRFProtection(xhr); }});
+
+    $(document).delegate(rails.linkDisableSelector, 'ajax:complete', function() {
+      rails.enableElement($(this));
+    });
+
+    $(document).delegate(rails.linkClickSelector, 'click.rails', function(e) {
+      var link = $(this), method = link.data('method'), data = link.data('params');
+      if (!rails.allowAction(link)) return rails.stopEverything(e);
+
+      if (link.is(rails.linkDisableSelector)) rails.disableElement(link);
+
+      if (link.data('remote') !== undefined) {
+        if ( (e.metaKey || e.ctrlKey) && (!method || method === 'GET') && !data ) { return true; }
+
+        var handleRemote = rails.handleRemote(link);
+        // response from rails.handleRemote() will either be false or a deferred object promise.
+        if (handleRemote === false) {
+          rails.enableElement(link);
+        } else {
+          handleRemote.error( function() { rails.enableElement(link); } );
+        }
+        return false;
+
+      } else if (link.data('method')) {
+        rails.handleMethod(link);
+        return false;
+      }
+    });
+
+    $(document).delegate(rails.inputChangeSelector, 'change.rails', function(e) {
+      var link = $(this);
+      if (!rails.allowAction(link)) return rails.stopEverything(e);
+
+      rails.handleRemote(link);
+      return false;
+    });
+
+    $(document).delegate(rails.formSubmitSelector, 'submit.rails', function(e) {
+      var form = $(this),
+          remote = form.data('remote') !== undefined,
+          blankRequiredInputs = rails.blankInputs(form, rails.requiredInputSelector),
+          nonBlankFileInputs = rails.nonBlankInputs(form, rails.fileInputSelector);
+
+      if (!rails.allowAction(form)) return rails.stopEverything(e);
+
+      // skip other logic when required values are missing or file upload is present
+      if (blankRequiredInputs && form.attr("novalidate") == undefined && rails.fire(form, 'ajax:aborted:required', [blankRequiredInputs])) {
+        return rails.stopEverything(e);
+      }
+
+      if (remote) {
+        if (nonBlankFileInputs) {
+          // slight timeout so that the submit button gets properly serialized
+          // (make it easy for event handler to serialize form without disabled values)
+          setTimeout(function(){ rails.disableFormElements(form); }, 13);
+          var aborted = rails.fire(form, 'ajax:aborted:file', [nonBlankFileInputs]);
+
+          // re-enable form elements if event bindings return false (canceling normal form submission)
+          if (!aborted) { setTimeout(function(){ rails.enableFormElements(form); }, 13); }
+
+          return aborted;
+        }
+
+        // If browser does not support submit bubbling, then this live-binding will be called before direct
+        // bindings. Therefore, we should directly call any direct bindings before remotely submitting form.
+        if (!$.support.submitBubbles && $().jquery < '1.7' && rails.callFormSubmitBindings(form, e) === false) return rails.stopEverything(e);
+
+        rails.handleRemote(form);
+        return false;
+
+      } else {
+        // slight timeout so that the submit button gets properly serialized
+        setTimeout(function(){ rails.disableFormElements(form); }, 13);
+      }
+    });
+
+    $(document).delegate(rails.formInputClickSelector, 'click.rails', function(event) {
+      var button = $(this);
+
+      if (!rails.allowAction(button)) return rails.stopEverything(event);
+
+      // register the pressed submit button
+      var name = button.attr('name'),
+          data = name ? {name:name, value:button.val()} : null;
+
+      button.closest('form').data('ujs:submit-button', data);
+    });
+
+    $(document).delegate(rails.formSubmitSelector, 'ajax:beforeSend.rails', function(event) {
+      if (this == event.target) rails.disableFormElements($(this));
+    });
+
+    $(document).delegate(rails.formSubmitSelector, 'ajax:complete.rails', function(event) {
+      if (this == event.target) rails.enableFormElements($(this));
+    });
+
+    $(function(){
+      // making sure that all forms have actual up-to-date token(cached forms contain old one)
+      csrf_token = $('meta[name=csrf-token]').attr('content');
+      csrf_param = $('meta[name=csrf-param]').attr('content');
+      $('form input[name="' + csrf_param + '"]').val(csrf_token);
+    });
+  }
+
+})( jQuery );

data/spec/dummy/config/application.rb

@@ -46,7 +46,7 @@ module Dummy
     # Use SQL instead of Active Record's schema dumper when creating the database.
     # This is necessary if your schema can't be completely dumped by the schema dumper,
     # like if you have constraints or database-specific column types
-    config.active_record.schema_format = :sql
+    #config.active_record.schema_format = :sql
 
     # Enforce whitelist mode for mass assignment.
     # This will create an empty whitelist of attributes available for mass-assignment for all models

data/spec/dummy/config/database.yml

@@ -6,5 +6,5 @@ development:
 
 test:
   adapter: sqlite3
-  database: ":memory:"
+  database: db/test.sqlite3
   timeout: 500

data/spec/dummy/config/routes.rb

@@ -1,7 +1,7 @@
 Dummy::Application.routes.draw do
   resources :posts
 
-  match 'blogs/:id/posts' => 'posts#index'
+  match '/blogs/:id/posts' => 'posts#index'
 
 
   # The priority is based upon order of creation:

data/spec/dummy/db/schema.rb

@@ -0,0 +1,23 @@
+# encoding: UTF-8
+# This file is auto-generated from the current state of the database. Instead
+# of editing this file, please use the migrations feature of Active Record to
+# incrementally modify your database, and then regenerate this schema definition.
+#
+# Note that this schema.rb definition is the authoritative source for your
+# database schema. If you need to create the application database on another
+# system, you should be using db:schema:load, not running all the migrations
+# from scratch. The latter is a flawed and unsustainable approach (the more migrations
+# you'll amass, the slower it'll run and the greater likelihood for issues).
+#
+# It's strongly recommended to check this file into your version control system.
+
+ActiveRecord::Schema.define(:version => 20120825050219) do
+
+  create_table "posts", :force => true do |t|
+    t.string   "title"
+    t.text     "content"
+    t.datetime "created_at", :null => false
+    t.datetime "updated_at", :null => false
+  end
+
+end

data/spec/dummy/public/index.html

@@ -4,7 +4,7 @@
   <meta charset="utf-8" />
   <title>Resourcy Regression Testing</title>
   <script src="/assets/jquery-1.8.0.js" type="text/javascript"></script>
-  <script src="/assets/resourcy.jquery.js" type="text/javascript"></script>
+  <script src="/assets/jquery.resourcy.js" type="text/javascript"></script>
 </head>
 <body>
 

data/vendor/assets/javascripts/resourcy.js.coffee

@@ -94,7 +94,7 @@ determineCallback = (resource, action, method, matchAction, matchIdOrAction) ->
 @Resourcy =
   removeAll: -> resources = {}
   handleRequest: handleRequest
-  noConflict: Resourcy.noConflict or -> delete(Resourcy)
+  noConflict: @Resourcy?.noConflict or -> delete(Resourcy)
 
   resources: (path, actions = {}) -> return createResource(path).add(actions)
   resource: (path, actions = {}) -> return createResource(path, true).add(actions)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: resourcy-rails
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-11 00:00:00.000000000 Z
+date: 2012-09-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: railties
@@ -126,6 +126,7 @@ files:
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/jquery-1.7.1.js
 - spec/dummy/app/assets/javascripts/jquery-1.8.0.js
+- spec/dummy/app/assets/javascripts/jquery_ujs.js
 - spec/dummy/app/controllers/posts_controller.rb
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/views/posts/_form.html.erb
@@ -151,8 +152,10 @@ files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20120825050219_create_posts.rb
-- spec/dummy/db/structure.sql
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
 - spec/dummy/log/.gitkeep
+- spec/dummy/public/favicon.ico
 - spec/dummy/public/index.html
 - spec/dummy/script/rails
 - spec/javascripts/jquery.resourcy_spec.js.coffee
@@ -174,7 +177,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1331812618252069276
+      hash: 3260753811313159457
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -183,7 +186,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -1331812618252069276
+      hash: 3260753811313159457
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24
@@ -194,6 +197,7 @@ test_files:
 - spec/dummy/Rakefile
 - spec/dummy/app/assets/javascripts/jquery-1.7.1.js
 - spec/dummy/app/assets/javascripts/jquery-1.8.0.js
+- spec/dummy/app/assets/javascripts/jquery_ujs.js
 - spec/dummy/app/controllers/posts_controller.rb
 - spec/dummy/app/models/post.rb
 - spec/dummy/app/views/posts/_form.html.erb
@@ -219,8 +223,10 @@ test_files:
 - spec/dummy/config/routes.rb
 - spec/dummy/db/development.sqlite3
 - spec/dummy/db/migrate/20120825050219_create_posts.rb
-- spec/dummy/db/structure.sql
+- spec/dummy/db/schema.rb
+- spec/dummy/db/test.sqlite3
 - spec/dummy/log/.gitkeep
+- spec/dummy/public/favicon.ico
 - spec/dummy/public/index.html
 - spec/dummy/script/rails
 - spec/javascripts/jquery.resourcy_spec.js.coffee

data/spec/dummy/db/structure.sql

@@ -1,4 +0,0 @@
-CREATE TABLE "posts" ("id" INTEGER PRIMARY KEY AUTOINCREMENT NOT NULL, "title" varchar(255), "content" text, "created_at" datetime NOT NULL, "updated_at" datetime NOT NULL);
-CREATE TABLE "schema_migrations" ("version" varchar(255) NOT NULL);
-CREATE UNIQUE INDEX "unique_schema_migrations" ON "schema_migrations" ("version");
-INSERT INTO schema_migrations (version) VALUES ('20120825050219');