edifice-forms 0.3.0

data/README.md

@@ -0,0 +1,4 @@
+Unobtrusive JS Form Extensions for rails 3.1
+======================================================
+
+Builds on jquery-ujs to extend form functionality.

data/Rakefile

@@ -0,0 +1,3 @@
+require 'rubygems'
+require 'bundler'
+Bundler::GemHelper.install_tasks

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

@@ -0,0 +1 @@
+//= require_tree ./edifice-forms

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

@@ -0,0 +1,120 @@
+/**
+ * A small jQuery plugin to add 'rails-aware' form functionality.
+ *
+ * Basically, this understands the 'standard' rails way of structuring forms
+ * and makes some functions available to manipulate that.
+ */
+(function($) {
+$.fn.rails_form = function(method) {
+  if (methods[method]) {
+    return methods[method].apply(this, Array.prototype.slice.call(arguments, 1));
+  } else {
+    $.error('Method ' +  method + ' does not exist on rails_form');
+  }
+};
+
+// in these 'this' is the $form
+var methods = {
+  fields: function() {
+    return this.find('input, textarea, select');
+  },
+  
+  error_fields: function() {
+    var $form = this;
+    return this.rails_form('fields').filter(function() {
+      return $form.rails_form('has_error', $(this));
+    });
+  },
+  
+  submits: function() {
+    return this.find('input[type=submit], button[type=submit]');
+  },
+  
+  label_for: function($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');
+  },
+  
+  has_error: function($field) {
+    return $field.parent('.field_with_errors').length > 0;
+  },
+  
+  clear_errors: function() {
+    var $form = this;
+    this.rails_form('fields').each(function() {
+      $form.rails_form('clear_error', $(this));
+    });
+    
+    // clear base errors too
+    this.find('.errors').html('');
+  },
+  
+  clear_error: function($field) {
+    var id = $field.attr('id');
+    if (this.rails_form('has_error', $field)) { $field.unwrap() }
+    
+    this.find('.field_with_errors label[for=' + id + ']')
+      .unwrap()
+      .next('.formError').remove();
+    
+    // remove from a .errors ul
+    this.find('.errors [data-for=' + id + ']').remove();
+    
+    return this;
+  },
+  
+  // display standard errors as returned by JSON
+  set_errors: function(errors) {
+    this.rails_form('clear_errors');
+    for (var name in errors) {
+      for (var i in errors[name]) {
+        this.rails_form('add_error', name, errors[name][i]);
+      }
+    }
+    return this;
+  },
+  
+  add_error: function(name, error) {
+    var $field = this.rails_form('fields').filter('[name*=' + name + ']');
+    $field.filter('.field_with_errors > *').unwrap();
+    $field.wrap('<div class="field_with_errors">');
+    
+    // if there is a field, and it has a label, show the error after it
+    if ($field.length) {
+      var id = $field.attr('id');
+      var $label = this.rails_form('label_for', $field);
+      var $error = $label.parent().next('.formError');
+      
+      if ($error.length) {
+        $error.text(function(i, text) {
+          return text + ', ' + error;
+        });
+      } else {
+        $label.after('<div class="formError">' + error + '</div>')
+          .wrap('<div class="field_with_errors">');
+      }
+    }
+    
+    // if there is an .errors list, show the error there
+    var $errors = this.find('ul.errors');
+    if ($errors.length) {
+      var message = name.charAt(0).toUpperCase() + name.substring(1).replace('_', ' ') + 
+        ' ' + error;
+      
+      var $li = $('<li>' + message + '</li>');
+      
+      if ($field.length) {
+        $li.attr('data-for', $field.attr('id'));
+      }
+      
+      $errors.append($li);
+    }
+    
+    return this;
+  }
+};
+
+}(jQuery));

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

@@ -0,0 +1,23 @@
+(function($) {
+  var showErrorSelector = 'form[data-show-errors]';
+  
+  $(showErrorSelector).live('ajax:error', function(event, request, status, error) {
+    // CLIENT ERROR -- server-side validation failed. -- FIXME -should this be 422 only?
+    if (request.status >= 400 && request.status < 500) { 
+      // if data is html, we replace this content of the form with the content
+      // of the form that we've just received back
+      var contentType = request.getResponseHeader('Content-Type');
+      if (/html/.test(contentType)) {
+        // wrap in a div incase there are a bunch of floating elements, pull the form out
+        var $new_form = $('<div>' + request.responseText + '</div>').find('#' + $(this).attr('id'));
+        $(this).html($new_form.html());
+        
+      } else if (/json/.test(contentType)) {
+        // we will be receiving an error object back, we can pass it straight into rails_form.js
+        $(this).rails_form('set_errors', $.parseJSON(request.responseText));
+      } else {
+        throw "edifice-forms/show-errors: Don't know how to handle dataType " + request.dataType;
+      }
+    }
+  });
+}(jQuery));

data/edifice-forms.gemspec

@@ -0,0 +1,18 @@
+$:.push File.expand_path("../lib", __FILE__)
+require "edifice-forms/version"
+
+Gem::Specification.new do |s|
+  s.name    = 'edifice-forms'
+  s.version = EdificeForms::VERSION
+  s.platform = Gem::Platform::RUBY
+  s.author  = 'Tom Coleman'
+  s.email   = 'tom@percolatestudio.com'
+  s.summary = 'Unobtrusive JS Form extensions'
+
+  s.add_dependency 'jquery-rails'
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/edifice-forms.rb

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

data/lib/edifice-forms/controller.rb

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

data/lib/edifice-forms/form_model.rb

@@ -0,0 +1,46 @@
+# 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
+    
+    # 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
+    
+    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?
+      end
+    end
+    
+    def save!
+      save || raise(RecordInvalid.new(self))
+    end
+    
+    def self.create(attributes = {})
+      form = new(attributes)
+      form.save
+      form
+    end
+    
+    def persisted?
+      false
+    end
+  end
+end

data/lib/edifice-forms/helper.rb

@@ -0,0 +1,22 @@
+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] }
+        end
+        output.html_safe
+      end
+    end
+  end
+end

data/lib/edifice-forms/responder.rb

@@ -0,0 +1,23 @@
+# 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
+      end
+    end
+    
+    # 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

@@ -0,0 +1,3 @@
+module EdificeForms
+  VERSION = "0.3.0"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification 
+name: edifice-forms
+version: !ruby/object:Gem::Version 
+  hash: 19
+  prerelease: 
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Tom Coleman
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: jquery-rails
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+description: 
+email: tom@percolatestudio.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- Rakefile
+- app/assets/javascripts/edifice-forms.js
+- app/assets/javascripts/edifice-forms/rails_form.js
+- app/assets/javascripts/edifice-forms/show-errors.js
+- edifice-forms.gemspec
+- lib/edifice-forms.rb
+- lib/edifice-forms/controller.rb
+- lib/edifice-forms/form_model.rb
+- lib/edifice-forms/helper.rb
+- lib/edifice-forms/responder.rb
+- lib/edifice-forms/version.rb
+homepage: 
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Unobtrusive JS Form extensions
+test_files: []
+
+has_rdoc: