edifice-forms 0.3.0 → 0.4.0

data/README.md

@@ -1,4 +1,146 @@
-Unobtrusive JS Form Extensions for rails 3.1
-======================================================
+Unobtrusive Javascript Form Extensions for Rails 3
+==================================================
 
-Builds on jquery-ujs to extend form functionality.
+edifice-forms the part of the [edifice project](https://github.com/tmeasday/edifice) which improves your experience with forms inside rails.
+
+Note that it does not depend on edifice, although it complements it well.
+
+Extending remote forms to handle errors
+---------------------------------------
+
+Rails 3 includes the excellent Unobtrusive JS, which allows us to define remote forms unobtrusively:
+
+```html
+<form data-remote="true">
+```
+
+This will result in the form submitting via AJAX, however there is no support for errors in the form. This is surprising as the convention for rails form errors is clearly defined; return a HTML status 422 (`:unprocessible_entity`). In fact this is what the `responds_with` responder will do (for non-AJAX requests):
+
+```ruby
+# Super-lean Rails controllers do it for me
+class UsersController
+  def update
+    respond_with @user = User.update(params[:user])
+  end
+end
+```
+
+edifice-forms extends this convention to AJAX requests. Firstly, we augment rails to respond with a 422 on invalid AJAX updates. Secondly, we add a `data-form` attribute:
+
+```erb
+<%= form_for @user, :remote => true, :html => {:'data-form' => 'show_errors'} do |f| %>
+```
+
+Now, when your users controller returns an error + an updated form with the errors highlighted, we'll automatically replace the form with the 'errored' version. Not a single line of Javascript required for such a common behaviour!
+
+rails_form.js
+-------------
+
+What about if your form returns data in JSON? We've got you covered. In order for remote JSON forms to show errors, we've written a small jQuery plugin: `rails_form.js`. It is written to conform to the conventions laid down by actionpack. 
+
+For instance, if you have, in your view:
+
+```html
+<form>
+  <label for="user[name]"></label>
+  <input name="user[name]" value="Tom"></input>
+</form>
+```
+    
+You can call:
+
+```js
+$('form').rails_form('add_error', 'user[name]', 'needs a surname');
+```
+
+Which will result in:
+
+```html
+<form>
+  <div class="field_with_errors">
+    <label for="user[name]"></label>
+  </div>
+  <div class="formError">needs a surname</div>
+  <div class="field_with_errors">
+    <input name="user[name]" value="Tom"></input>
+  </div>
+</form>
+```
+
+The error can be removed with:
+    
+```js
+$('form').rails_form('clear_error', 'user[name]');
+```
+
+We've also added a convention that rails seemed to leave out, if you prefer your errors to be co-located:
+
+```erb
+<%= render_errors(f) >
+```
+    
+Which will output something like:
+
+```html
+<ul class="errors">
+  <li data-for="name">Name needs a surname</li>
+</ul>
+```
+
+Forms with `show_errors` set will detect such a structure and update it on AJAX errors.
+
+Use at your discretion.
+
+FormModel
+---------
+
+The final piece of the puzzle is perhaps the most useful. Suppose you have a form on your site which isn't backed by a model. A good example is a feedback form. The feedback 'model' doesn't need to persist, it simply needs to send an email when it successfully saves; but we would still like to have all the ActiveModel goodness (validations, callbacks, etc) of a real ActiveRecord model. Enter the FormModel:
+
+```ruby
+class Feedback < Edifice::Forms::FormModel
+  attr_accessor :message
+  attr_accessor :email
+
+  # some simple validators
+  validates :email, :presence => true, :format => {:with => /^.+@.+\..+$/}
+  validates :message, :presence => true
+  
+  # if validations pass and we successfully save, go ahead and deliver the 
+  # feedback email to us, so we can read it.
+  def save
+    SelfMailer.feedback(self).deliver
+  end
+end
+```
+
+Looks a lot like a ActiveRecord model, doesn't it? We get to write our controllers in the same super skinny way:
+
+```ruby
+class FeedbacksController < ApplicationController
+  def new
+    respond_with @feedback = Feedback.new
+  end
+  
+  def create
+    respond_with @feedback = Feedback.create params[:feedback]
+  end
+end
+```
+
+Don't worry, we can use the `@feedback` in our views just as we would with a real model:
+
+```erb
+<%= form_for @feedback, :remote => true, 
+      :html => {:'data-form' => 'show_errors'} do |f| %>
+  <%= f.label :message, 'Your Feedback' %>
+  <%= f.error_message_on :message %>
+  <%= f.text_area :message, :placeholder => 'How can we help?' %>
+<% end %>
+```
+
+Simple, huh?
+
+License
+-------
+
+Edifice is crafted by [Percolate Studio](http://percolatestudio.com) and released under the [MIT license](www.opensource.org/licenses/MIT)

data/app/assets/javascripts/edifice-forms/rails_form.js

@@ -19,6 +19,14 @@ var methods = {
     return this.find('input, textarea, select');
   },
   
+  field: function(name_or_field) {
+    if (name_or_field instanceof $) {
+      return name_or_field;
+    } else {
+      return this.rails_form('fields').filter('[name*=' + $.escape(name_or_field) + ']');
+    }
+  },
+  
   error_fields: function() {
     var $form = this;
     return this.rails_form('fields').filter(function() {
@@ -30,15 +38,17 @@ var methods = {
     return this.find('input[type=submit], button[type=submit]');
   },
   
-  label_for: function($field) {
+  label_for: function(name_or_field) {
+    var $field = this.rails_form('field', name_or_field);
     return this.find('label[for=' + $field.attr('id') + ']');
   },
   
-  error_on: function($field) {
-    return this.rails_form('label_for', $field).parents('.field_with_errors').next('.formError');
+  error_on: function(name_or_field) {
+    return this.rails_form('label_for', name_or_field).parents('.field_with_errors').next('.formError');
   },
   
-  has_error: function($field) {
+  has_error: function(name_or_field) {
+    var $field = this.rails_form('field', name_or_field);
     return $field.parent('.field_with_errors').length > 0;
   },
   
@@ -52,7 +62,8 @@ var methods = {
     this.find('.errors').html('');
   },
   
-  clear_error: function($field) {
+  clear_error: function(name_or_field) {
+    var $field = this.rails_form('field', name_or_field);
     var id = $field.attr('id');
     if (this.rails_form('has_error', $field)) { $field.unwrap() }
     
@@ -77,8 +88,8 @@ var methods = {
     return this;
   },
   
-  add_error: function(name, error) {
-    var $field = this.rails_form('fields').filter('[name*=' + name + ']');
+  add_error: function(name_or_field, error) {
+    var $field = this.rails_form('field', name_or_field);
     $field.filter('.field_with_errors > *').unwrap();
     $field.wrap('<div class="field_with_errors">');
     
@@ -101,6 +112,8 @@ var methods = {
     // if there is an .errors list, show the error there
     var $errors = this.find('ul.errors');
     if ($errors.length) {
+      // turns bindle[0][name] -> name etc
+      var name = $field.attr('name').replace(/^.*\[(.*)\]$/, '$1');
       var message = name.charAt(0).toUpperCase() + name.substring(1).replace('_', ' ') + 
         ' ' + error;
       

data/app/assets/javascripts/edifice-forms/show-errors.js

@@ -1,5 +1,5 @@
 (function($) {
-  var showErrorSelector = 'form[data-show-errors]';
+  var showErrorSelector = 'form[data-form*=show_errors]';
   
   $(showErrorSelector).live('ajax:error', function(event, request, status, error) {
     // CLIENT ERROR -- server-side validation failed. -- FIXME -should this be 422 only?

data/edifice-forms.gemspec

@@ -3,7 +3,7 @@ require "edifice-forms/version"
 
 Gem::Specification.new do |s|
   s.name    = 'edifice-forms'
-  s.version = EdificeForms::VERSION
+  s.version = Edifice::Forms::VERSION
   s.platform = Gem::Platform::RUBY
   s.author  = 'Tom Coleman'
   s.email   = 'tom@percolatestudio.com'

data/lib/edifice-forms.rb

@@ -3,10 +3,12 @@ require 'edifice-forms/controller'
 require 'edifice-forms/form_model'
 require 'edifice-forms/responder'
 
-module EdificeForms
-  class Engine < Rails::Engine
+module Edifice
+  module Forms
+    class Engine < Rails::Engine
+    end
   end
 end
 
-ActionView::Base.send :include, EdificeForms::Helper
-ActionController::Base.send :include, EdificeForms::Controller
+ActionView::Base.send :include, Edifice::Forms::Helper
+ActionController::Base.send :include, Edifice::Forms::Controller

data/lib/edifice-forms/controller.rb

@@ -1,9 +1,11 @@
-module EdificeForms
-  module Controller
-    def self.included(controller)
-      controller.class_eval do
-        def self.responder
-          EdificeForms::Responder
+module Edifice
+  module Forms
+    module Controller
+      def self.included(controller)
+        controller.class_eval do
+          def self.responder
+            Edifice::Forms::Responder
+          end
         end
       end
     end

data/lib/edifice-forms/form_model.rb

@@ -1,46 +1,48 @@
 # kind of the evolution of the FormStruct
 
-module EdificeForms
-  class FormModel
-    include ActiveModel::Validations
-    include ActiveModel::Conversion
-    extend  ActiveModel::Naming
-    extend ActiveModel::Callbacks
-    define_model_callbacks :save
+module Edifice
+  module Forms
+    class FormModel
+      include ActiveModel::Validations
+      include ActiveModel::Conversion
+      extend  ActiveModel::Naming
+      extend ActiveModel::Callbacks
+      define_model_callbacks :save
     
-    # more or less the same as activerecord's one
-    class RecordInvalid < Exception
-      attr_reader :record
-      def initialize(record)
-        @record = record
-        errors = @record.errors.full_messages.join(", ")
-        super(errors)
+      # more or less the same as activerecord's one
+      class RecordInvalid < Exception
+        attr_reader :record
+        def initialize(record)
+          @record = record
+          errors = @record.errors.full_messages.join(", ")
+          super(errors)
+        end
       end
-    end
     
-    def initialize(attributes = {})
-        attributes.each { |n, v| send("#{n}=", v) if respond_to?("#{n}=") }
-    end
+      def initialize(attributes = {})
+          attributes.each { |n, v| send("#{n}=", v) if respond_to?("#{n}=") }
+      end
     
-    # default implementation, override as necessary
-    def save
-      run_callbacks :save do
-        valid?
+      # default implementation, override as necessary
+      def save
+        run_callbacks :save do
+          valid?
+        end
       end
-    end
     
-    def save!
-      save || raise(RecordInvalid.new(self))
-    end
+      def save!
+        save || raise(RecordInvalid.new(self))
+      end
     
-    def self.create(attributes = {})
-      form = new(attributes)
-      form.save
-      form
-    end
+      def self.create(attributes = {})
+        form = new(attributes)
+        form.save
+        form
+      end
     
-    def persisted?
-      false
+      def persisted?
+        false
+      end
     end
   end
 end

data/lib/edifice-forms/helper.rb

@@ -1,21 +1,23 @@
-module EdificeForms
-  module Helper
-    # not sure why there isn't something like this in rails
-    #
-    # render the errors on an object in a fairly standard way:
-    #
-    # <ul class="errors">
-    #   <li data-for="name">Name cannot be blank</li>
-    # </ul>
-    def render_errors(builder)
-      errors = builder.object.errors
-      messages = errors.full_messages
-      content_tag :ul, :class => :errors do
-        output = ''
-        errors.each_with_index do |error, i|
-          output << content_tag(:li, :'data-for' => "#{builder.object_name}_#{error[0]}") { messages[i] }
+module Edifice
+  module Forms
+    module Helper
+      # not sure why there isn't something like this in rails
+      #
+      # render the errors on an object in a fairly standard way:
+      #
+      # <ul class="errors">
+      #   <li data-for="name">Name cannot be blank</li>
+      # </ul>
+      def render_errors(builder)
+        errors = builder.object.errors
+        messages = errors.full_messages
+        content_tag :ul, :class => :errors do
+          output = ''
+          errors.each_with_index do |error, i|
+            output << content_tag(:li, :'data-for' => "#{builder.object_name}_#{error[0]}") { messages[i] }
+          end
+          output.html_safe
         end
-        output.html_safe
       end
     end
   end

data/lib/edifice-forms/responder.rb

@@ -1,22 +1,24 @@
 # Basically a standard responder, but if 
-module EdificeForms
-  class Responder < ActionController::Responder
-  protected 
-    # add the :u_e header to xhr error requests
-    def to_html
-      if controller.request.xhr? && !get? and has_errors? && default_action
-        render :action => default_action, :status => :unprocessable_entity, :layout => nil
-      else
-        super
+module Edifice
+  module Forms
+    class Responder < ActionController::Responder
+    protected 
+      # add the :u_e header to xhr error requests
+      def to_html
+        if controller.request.xhr? && !get? and has_errors? && default_action
+          render :action => default_action, :status => :unprocessable_entity, :layout => nil
+        else
+          super
+        end
       end
-    end
     
-    # actually render something on successful updates
-    def to_format
-      unless get? or has_errors? or post?
-        display resource, :status => :ok
-      else
-        super
+      # actually render something on successful updates
+      def to_format
+        unless get? or has_errors? or post?
+          display resource, :status => :ok
+        else
+          super
+        end
       end
     end
   end

data/lib/edifice-forms/version.rb

@@ -1,3 +1,5 @@
-module EdificeForms
-  VERSION = "0.3.0"
+module Edifice
+  module Forms
+    VERSION = "0.4.0"
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: edifice-forms
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 15
   prerelease: 
   segments: 
   - 0
-  - 3
+  - 4
   - 0
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors: 
 - Tom Coleman
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-17 00:00:00 Z
+date: 2012-01-18 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: jquery-rails