formize 0.0.2

data/.document

@@ -0,0 +1,5 @@
+lib/**/*.rb
+bin/*
+- 
+features/**/*.feature
+LICENSE.txt

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Brice Texier
+
+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.rdoc

@@ -0,0 +1,74 @@
+= Formize
+
+Simple form DSL with dynamic interactions for Rails.
+
+== Installation
+
+Add it to your Gemfile:
+  gem "formize"
+
+It's not necessary, but I recommend to use HAML with it for cleaner views:
+  gem "haml"
+
+== Usage
+
+In controller:
+
+  class OrdersController < ApplicationController
+    # Generates default helpers method and a controller method :formize
+    # for a model Order.
+    formize
+
+    # Personnalized example
+    formize do
+      field :number
+      field :created_on
+      field :client
+      field_set :addresses, :depend_on=>:client do
+        field :default_contact, :choices=>:contacts, :source=>:client
+        field :delivery_contact, :choices=>:contacts, :source=>:client
+        field :invoice_contact, :choices=>:contacts, :source=>:client
+      end
+      field_set :track do
+        field :responsible
+        field :department
+      end
+    end
+
+    # Moreover, with a specified model
+    formize(:lines, :model=>:order_lines)
+
+  end
+
+In views:
+
+  # app/views/orders/_form.html.haml
+  =formize_form
+
+or:
+
+  # app/views/orders/_form.html.haml
+  =form_tag do
+    =formize_fields
+
+or:
+
+  # app/views/orders/_form.html.haml
+  =formize_form :lines
+
+
+== Contributing to Formize
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) 2011 Brice Texier. See LICENSE.txt for
+further details.
+

data/Rakefile

@@ -0,0 +1,63 @@
+# encoding: utf-8
+# Used for a bug with ruby 1.9.1 
+# http://rubyforge.org/tracker/index.php?func=detail&aid=28920&group_id=1513&atid=5921
+require 'psych'
+
+require 'rubygems'
+# require 'rake'
+gem 'rake', '0.8.7'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "formize"
+  gem.homepage = "http://github.com/burisu/formize"
+  gem.license = "MIT"
+  gem.summary = "Simple form DSL with dynamic interactions for Rails"
+  gem.description = "Like simple_form or formtastic, it aims to handle easily forms but taking in account AJAX and HTML5 on depending fields mainly."
+  gem.email = "brice.texier@ekylibre.org"
+  gem.authors = ["Brice Texier"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  # gem.add_development_dependency "bundler", "~> 1.0.0"
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "jeweler", "~> 1.6.4"
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.add_development_dependency "rcov", ">= 0"
+  gem.add_development_dependency "actionpack", ">= 0"
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+require 'rcov/rcovtask'
+Rcov::RcovTask.new do |test|
+  test.libs << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+  test.rcov_opts << '--exclude "gems/*"'
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "Formize #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.2

data/assets/javascripts/formize.js

@@ -0,0 +1,399 @@
+/*jslint devel: true, browser: true, sloppy: true, vars: true, white: true, maxerr: 50, indent: 4 */
+
+var Formize = {};
+
+Formize.Overlay = {
+    
+    count : 0,
+
+    add : function (body) {
+        body = body || document.body || document.getElementsByTagName("BODY")[0];
+        var dims   = document.viewport.getDimensions();
+        var height = dims.height, width = dims.width, overlay = $('overlay');
+        if (overlay === null) {
+            overlay = new Element('div', {id: 'overlay', style: 'position:fixed; top:0; left 0; width:'+width+'px; height: '+height+'px; opacity: 0.5'});
+            body.appendChild(overlay);
+	}
+        this.count += 1;
+	overlay.setStyle({'z-index': this.z_index()});
+        return overlay;
+    },
+    
+    remove: function() {
+        this.count -= 1;
+        var overlay = $('overlay');
+	if (overlay !== null) {
+            if (this.count <= 0) {
+		overlay.remove();
+	    } else {
+		overlay.setStyle({'z-index': this.z_index()});
+	    }
+        }
+        return this.count;
+    },
+    
+    // Computes a big z-index with interval in order to intercalate dialogs
+    z_index: function() {
+	return (10*this.count + 10000);
+    }
+};
+
+
+Formize.Dialog = {
+
+    /* Opens a div like a virtual popup*/
+    open: function (url, updated, ratio) {
+        var body   = document.body || document.getElementsByTagName("BODY")[0];
+        var dims   = document.viewport.getDimensions();
+        var height = dims.height; 
+        var width  = dims.width;
+        var dialog_id = 'dialog'+Formize.Overlay.count;
+        if (isNaN(ratio)) { ratio = 0.6; }
+        
+        Formize.Overlay.add();
+        
+        return new Ajax.Request(url, {
+            method: 'get',
+            parameters: {dialog: dialog_id},
+            evalScripts: true,
+            onSuccess: function(response) {
+                var dialog = new Element('div', {id: dialog_id, 'data-ratio': ratio, 'data-dialog-update': updated, flex: '1', 'class': 'dialog', style: 'z-index:'+(Formize.Overlay.z_index()+1)+'; position:fixed; opacity: 1'});
+                body.appendChild(dialog);
+                dialog.update(response.responseText);
+                var w = ratio*width;
+                var h = ratio*height;
+                if (ratio <= 0) {
+                    var dialogDims = dialog.getDimensions();
+                    w = dialogDims.width;
+                    h = dialogDims.height;
+                }
+                dialog.setStyle('left:'+((width-w)/2)+'px; top:'+((height-h)/2)+'px; width:'+w+'px; height: '+h+'px');
+                return dialog.resize(w, h);
+            },
+            onFailure: function(response) {
+                alert("FAILURE (Error "+response.status+"): "+response.reponseText);
+                Formize.Overlay.remove();
+            }
+        });
+    },
+
+    /* Close a virtual popup */
+    close: function (dialog) {
+        dialog = $(dialog);
+        dialog.remove();
+        Formize.Overlay.remove();
+        return true;
+    }
+
+
+};
+
+
+Formize.Partials = {
+
+    refresh: function (event, element) {
+        var dependents = element.readAttribute('data-dependents').split(',');
+        var params = new Hash();
+        if (element.value !== null && element.value !== undefined) {
+            params.set(element.id, element.value);
+            dependents.each(function(item_id) {
+                // Replaces element
+                var item = $(item_id);
+                if (item) {
+                    var url = item.readAttribute('data-refresh');
+                    if (url !== null) {
+                        new Ajax.Request(url, {
+                            method: 'get',
+                            asynchronous:true,
+                            evalScripts:true,
+                            parameters: params,
+                            onSuccess: function(response) {
+                                item.replace(response.responseText);
+				$(item_id).fire("dom:loaded");
+                            },
+                            onFailure: function(response) {
+                                alert("ERROR FAILURE\n"+response.status+" "+response.statusText);
+                            }
+                        });
+                    }
+                }
+            });
+            return true;
+        }
+    },
+
+    submitDialogForm: function(event, form) {
+        var dialog_id = form.readAttribute('data-dialog');
+        var dialog = $(dialog_id);
+
+        var field = new Element('input', { type: 'hidden', name: 'dialog', value: dialog_id });
+        form.insert(field);
+
+        new Ajax.Request(form.readAttribute('action'), {
+            method:      form.readAttribute('method') || 'post',
+            parameters:  Form.serialize(form),
+            asynchronous: true,
+            evalScripts: true,
+            onLoaded:  function(request){ form.fire("layout:change"); }, 
+            onSuccess: function(request){
+                if (request.responseJSON === null) {
+                    // No return => validation error
+                    dialog.update(request.responseText);
+		    dialog.fire("layout:change");
+                } else {
+                    // Refresh element with its refresh URL
+                    var updated =$(dialog.readAttribute('data-dialog-update'));
+                    if (updated !== null) {
+			var url = updated.readAttribute('data-refresh');
+			new Ajax.Request(url, {
+			    method: 'GET',
+                            asynchronous:true,
+                            evalScripts:true,
+			    parameters: {selected: request.responseJSON.id},
+			    onSuccess: function(request) { 
+				updated.replace(request.responseText); 
+				updated.fire("layout:change");
+			    }
+			});
+                    }
+                    // Close dialog
+                    Formize.Dialog.close(dialog);
+                }
+            }
+        });
+        event.stop();
+        return false;
+    },
+
+    uniqueID: function() {
+	var uid = 'u'+((new Date()).getTime() + "" + Math.floor(Math.random() * 1000000)).substr(0, 18);
+	return uid;
+    },
+
+    initializeUnroll: function(element) {
+	var choices, paramName;
+	if (element.valueField !== null && element.valueField !== undefined) { 
+	    return false;
+	}
+
+	choices = element.readAttribute('data-choices-container');
+	if (choices === null) {
+	    choices = new Element('div', {
+		'id': this.uniqueID(),
+		'class': "unroll-choices",
+		'style': "display: none"
+	    });
+	    element.insert({after: choices});
+	    element.writeAttribute('data-choices-container', choices.id);
+	}
+	
+	element.unrollCache = element.value;
+	element.valueField = $(element.readAttribute('data-value-container'));
+	if (element.valueField === null) {
+	    alert('An input '+element.id+' with a "data-unroll" attribute must contain a "data-value-container" attribute');
+	}
+	element.maxResize = parseInt(element.readAttribute('data-max-resize'));
+	if (isNaN(element.maxResize) || element.maxResize === 0) { element.maxResize = 64; }
+	element.size = (element.unrollCache.length > element.maxResize ? element.maxResize : element.unrollCache.length);
+	
+	new Ajax.Autocompleter(element, choices, element.readAttribute('data-unroll'), {
+	    method: 'GET',
+	    paramName: 'search',
+	    afterUpdateElement: function(element, selected) {
+		var model_id = /(\d+)$/.exec(selected.id)[1];
+		element.valueField.value = model_id;
+		element.valueField.fire("emulated:change");
+		element.unrollCache = element.value;
+		element.size = (element.unrollCache.length > element.maxResize ? element.maxResize : element.unrollCache.length);
+            }
+	});
+    }
+
+};
+
+
+(function() {
+    "use strict";
+
+    // Refreshes dependent elements
+    document.on("change", "*[data-dependents]", Formize.Partials.refresh);
+    document.on("emulated:change", "*[data-dependents]", Formize.Partials.refresh);
+
+    // Opens a dialog for a ressource creation
+    document.on("click", "a[data-add-item]", function(event, element) {
+        var list_id = element.readAttribute('data-add-item');
+        var url = element.readAttribute('href');
+        Formize.Dialog.open(url, list_id);
+        event.stop();
+    });
+
+    // Closes a dialog
+    document.on("click", "a[data-close-dialog]", function(event, element) {
+        var dialog_id = element.readAttribute('data-close-dialog');
+        Formize.Dialog.close(dialog_id);
+        event.stop();
+    });
+
+    // Submits dialog forms
+    document.on("submit", "form[data-dialog]", Formize.Partials.submitDialogForm);
+
+    // Manage unroll
+    // this is the only found way to work with dom:loaded
+
+    Event.observe(window, "dom:loaded", function(event) {
+	$$('input[data-unroll]').each(function(element) {
+	    Formize.Partials.initializeUnroll(element);
+	});
+    });
+
+    document.on("focusin", "input[data-unroll]", function(event, element) {
+	if (element.unrollCache === undefined) {
+	    element.unrollCache = element.value;
+	}
+    });
+
+
+    // if (1) {
+    // 	if (this.value != this.unrollCache) { 
+    // 	    this.valueField.value = ''; 
+    // 	}
+    // } else {
+    // 	this.value = this.unrollCache;
+    // }
+    document.on("change", "input[data-unroll]", function(event, element) {
+        window.setTimeout(function () {
+	    if (this.value != this.unrollCache) { 
+		this.valueField.value = ''; 
+		this.valueField.fire("emulated:change");
+	    }
+	}.bind(element), 200);
+    });
+
+    document.on("keypress", "input[data-unroll]", function(event, element) {
+	if (event.keyCode === Event.KEY_RETURN) {
+	    event.stop();
+	    return false;
+	} else { return true; }
+    });
+
+})();
+
+ 
+
+
+
+// function dyliChange(dyli, id) {
+//     var dyli_hf =$(dyli);
+//     var dyli_tf =$(dyli+'_tf');
+    
+//     return new Ajax.Request(dyli_hf.getAttribute('href'), {
+// 	method: 'get',
+// 	parameters: {id: id},
+// 	onSuccess: function(response) {
+// 	    var obj = response.responseJSON;
+// 	    if (obj!== null) {
+// 		dyli_hf.value = obj.hf_value;
+// 		dyli_tf.value = obj.tf_value;
+// 		dyli_tf.size = (dyli_tf.value.length > 64 ? 64 : dyli_tf.value.length);
+// 	    }
+// 	}
+//     });
+// }
+
+
+// function refreshList(select, request, source_url) {
+//     return new Ajax.Request(source_url, {
+// 	method: 'get',
+// 	parameters: {selected: request.responseJSON.id},
+// 	onSuccess: function(response) {
+// 	    var list = $(select);
+// 	    list.update(response.responseText);
+// 	}
+//     });
+// }
+
+// function refreshAutoList(dyli, request) {
+//     return dyliChange(dyli, request.responseJSON.id);
+// }
+
+
+// (function() {
+    
+//     document.on("click", "a[data-new-item]", function(event, element) {
+// 	var list_id = element.readAttribute('data-new-item');
+// 	var url = element.readAttribute('href');
+// 	openDialog(url, list_id);
+// 	event.stop();
+//     });
+
+
+//     document.on("click", "a[data-dialog-open]", function(event, element) {
+// 	var url = element.readAttribute('data-dialog-open');
+// 	if (url === 'true') {
+// 	    url = element.readAttribute('href');
+// 	}
+// 	openDialog(url, element.readAttribute('data-dialog-update'));
+// 	event.stop();
+//     });
+
+//     document.on("click", "a[data-dialog-close]", function(event, element) {
+// 	var dialog_id = element.readAttribute('data-dialog-close');
+// 	closeDialog(dialog_id);
+// 	event.stop();
+//     });
+
+//     document.on("submit", "form[data-dialog]", function(event, form) {
+// 	var dialog_id = form.readAttribute('data-dialog');
+// 	var dialog = $(dialog_id);
+
+// 	var field = new Element('input', { type: 'hidden', name: 'dialog', value: dialog_id });
+// 	form.insert(field);
+
+// 	new Ajax.Request(form.readAttribute('action'), {
+// 	    method:      form.readAttribute('method') || 'post',
+// 	    parameters:  Form.serialize(form),
+// 	    asynchronous: true,
+// 	    evalScripts: true,
+// 	    onLoaded:  function(request){ resizeDialog(dialog_id); }, 
+// 	    onSuccess: function(request){
+// 		if (request.responseJSON === null) {
+// 		    // No return => validation error
+// 		    dialog.update(request.responseText).resize();
+// 		} else {
+// 		    // Refresh list or execute call 
+// 		    var updated_id = dialog.readAttribute('data-dialog-update');
+// 		    var updated = $(updated_id);
+// 		    if (updated !== null) {
+// 			if (updated.readAttribute('text_field_id') === null) {
+// 			    var url = updated.readAttribute('data-refresh');
+// 			    var parameter = updated.readAttribute('data-id-parameter-name');
+// 			    if (parameter === null) {
+// 				parameter = 'selected';
+// 			    }
+// 			    var parameters = $H();
+// 			    parameters.set(parameter, request.responseJSON.id);
+// 			    if (url !== null) {
+// 				new Ajax.Updater(updated_id, url, {
+// 				    method: 'GET',
+// 				    asynchronous:true,
+// 				    evalScripts:true,
+// 				    parameters: parameters,
+// 				    onSuccess:  function(request) { form.fire("layout:resize",  request); }
+// 				});
+// 			    }
+// 			} else {
+// 			    dyliChange(updated_id, request.responseJSON.id);
+// 			}
+// 		    }
+// 		    // Close dialog
+// 		    closeDialog(dialog_id);
+// 		}
+// 	    }
+// 	});
+// 	event.stop();
+// 	return false;
+//     });
+
+
+
+// })();

data/formize.gemspec

@@ -0,0 +1,64 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{formize}
+  s.version = "0.0.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = [%q{Brice Texier}]
+  s.date = %q{2011-08-12}
+  s.description = %q{Like simple_form or formtastic, it aims to handle easily forms but taking in account AJAX and HTML5 on depending fields mainly.}
+  s.email = %q{brice.texier@ekylibre.org}
+  s.extra_rdoc_files = [
+    "LICENSE.txt",
+    "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+    "LICENSE.txt",
+    "README.rdoc",
+    "Rakefile",
+    "VERSION",
+    "assets/javascripts/formize.js",
+    "formize.gemspec",
+    "lib/formize.rb",
+    "lib/formize/action_pack.rb",
+    "lib/formize/definition.rb",
+    "lib/formize/definition/element.rb",
+    "lib/formize/definition/field.rb",
+    "lib/formize/definition/field_set.rb",
+    "lib/formize/definition/form.rb",
+    "lib/formize/definition/form_element.rb",
+    "lib/formize/form_helper.rb",
+    "lib/formize/generator.rb",
+    "test/helper.rb",
+    "test/test_formize.rb"
+  ]
+  s.homepage = %q{http://github.com/burisu/formize}
+  s.licenses = [%q{MIT}]
+  s.require_paths = [%q{lib}]
+  s.rubygems_version = %q{1.8.7}
+  s.summary = %q{Simple form DSL with dynamic interactions for Rails}
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_development_dependency(%q<rcov>, [">= 0"])
+      s.add_development_dependency(%q<actionpack>, [">= 0"])
+    else
+      s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+      s.add_dependency(%q<rcov>, [">= 0"])
+      s.add_dependency(%q<actionpack>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<jeweler>, ["~> 1.6.4"])
+    s.add_dependency(%q<rcov>, [">= 0"])
+    s.add_dependency(%q<actionpack>, [">= 0"])
+  end
+end
+

data/lib/formize/action_pack.rb

@@ -0,0 +1,63 @@
+module Formize
+
+  module ActionController
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+    
+    module ClassMethods
+
+      # Generates controller and view method working together
+      # This methods allows to develop dynamic forms without using partials
+      # and another action, only formize or formize_*.
+      def formize(*args, &block)
+        name, options = nil, {}
+        name = args[0] if args[0].is_a? Symbol
+        options = args[-1] if args[-1].is_a? Hash
+        name ||= self.controller_name.to_sym
+        model = (options[:model]||name).to_s.classify.constantize
+        options[:controller_method_name] = "formize#{'_'+name.to_s if name != self.controller_name.to_sym}"
+        options[:view_form_method_name]   = "_#{self.controller_name}_formize_form_#{name}_tag"
+        options[:view_fields_method_name] = "_#{self.controller_name}_formize_fields_#{name}_tag"
+        options[:method_name] = options[:view_fields_method_name]
+        form = Formize::Form.new(name, model, options)
+        if block_given?
+          yield form
+        else
+          formize_by_default(form)
+        end
+        generator = Formize::Generator.new(form, self)
+        class_eval(generator.controller_code, "#{__FILE__}:#{__LINE__}")
+        ActionView::Base.send(:class_eval, generator.view_code, "#{__FILE__}:#{__LINE__}")
+      end
+
+      private
+
+      # Generates list of usable field 
+      def formize_by_default(form)
+        form.field_set do |f|
+          for column in model.columns
+            next if column.name =~ /_count$/
+            if column.name =~ /_id$/
+              reflections = model.reflection.select{|x| x.primary_key_name.to_s == column.name.to_s }
+              if reflections.size == 1
+                f.field(column.name.gsub(/_id$/, ''))
+                # elsif reflections.size > 1 # AMBIGUITY
+                # elsif reflections.size < 1 # NOTHING
+              end
+            else
+              f.field(column.name)
+            end
+          end
+        end
+        return form
+      end
+
+    end
+
+  end
+
+end
+
+ActionController::Base.send(:include, Formize::ActionController)