erp_forms 2.0.0 → 2.0.1

data/README.rdoc

@@ -1,2 +1,86 @@
 = ErpForms
 
+ERP Forms adds dynamic forms to Compass using ExtJS. 
+
+
+== Models
+
+DynamicFormModel - Used for keeping track of what models have forms. Every model that uses the has_dynamic_forms "mixin", extends DynamicFormDocument or simply wants to use DynamicForm, needs to be given a record in the dynamic_form_models table.
+
+DynamicDatum - This is where dynamic attributes are stored. Any model that uses has_dynamic_data will store its data in the dynamic_data table.
+
+DynamicForm - Handles dynamic forms. Each model can have many forms which are looked up by model_name. Every model must have a default form but any form can be retrieved using an internal_identifier. Form definition is a JSON string which is equivalent to an ExtJS form definition which is an array of hashes.
+
+DynamicFormDocument - This model enables the creation of dynamic records using has_dynamic_forms and has_dynamic_data. DynamicFormDocument can explicitly be subclassed or a subclass can be declared on the fly using the "declare" class method.
+
+
+== Mixins
+
+has_dynamic_forms - Adds dynamic forms to any model.
+
+has_dynamic_data - Adds dynamic data to any model
+
+
+== Libraries
+
+DynamicGridColumn - Builds ExtJS dynamic grid columns. 
+
+DynamicFormField - Builds ExtJS dynamic form fields. This is done in text in order to support validation. Outputs JSON strings which can be parsed into JSON Ruby objects. See the instance method "definition_object" on DynamicForm.
+
+
+== Examples
+
+Creating a DynamicFormModel
+  DynamicFormModel.create({ :model_name => "MyDynamicModel" })
+
+Creating a DynamicForm
+  fields = []
+  fields << DynamicFormField.textfield({:fieldLabel => 'First Name', :name => 'first_name', :width => '200' })
+  fields << DynamicFormField.textfield({:fieldLabel => 'Last Name', :name => 'last_name', :width => '200' })
+  fields << DynamicFormField.email({:fieldLabel => 'Email', :name => 'email', :width => '200' })
+  fields << DynamicFormField.textarea({:fieldLabel => 'Message', :name => 'message', :width => '200' })    
+
+  d = DynamicForm.new
+  d.description = 'My Dynamic Form'
+  d.definition = DynamicForm.concat_fields_to_build_definition(fields)
+  d.model_name = 'MyDynamicModel'
+  d.internal_identifier = 'my_dyn_model'
+  d.default = true
+  d.dynamic_form_model_id = DynamicFormModel.find_by_model_name('MyDynamicModel').id
+  d.save
+
+Declaring a DynamicFormDocument on the fly
+  DynamicFormDocument.declare("MyDynamicModel")
+  @dyn_model = "MyDynamicModel".constantize.new
+  @dyn_model.data.created_with_form = @dyn_model.default_form
+
+  # create as many dynamic attributes as you need by prefixing them with "dyn_"
+  @dyn_model.data.dyn_my_dynamic_field = "hello world"
+  
+  @dyn_model.data.created_by = current_user.id
+  @dyn_model.save
+
+Subclassing DynamicFormDocument
+  class MyDynamicModel < DynamicFormDocument
+    # no need to declare mixins since they will be inherited from DynamicFormDocument
+    # so only reason to subclass is if you need custom methods
+  end
+
+Adding dynamic forms and data to an existing model
+  class Party
+    has_dynamic_forms
+    has_dynamic_data
+  end
+
+Using the Knitkit DynamicForms widget
+  Edit Section Layout, click Dynamic Forms widget icon and the following will be added to the layout:
+  <%= render_widget :dynamic_forms, :params => {:model_name => 'MyDynamicModel', :width => '350'} %>
+
+
+== TODO
+
+Dynamic Forms desktop application featuring a Dynamic Grid for every DynamicFormModel as well as a Dynamic Form Builder.
+
+
+============================================================
+Copyright (c) 2011 Adam Hull

data/app/controllers/erp_forms/erp_app/desktop/dynamic_forms/forms_controller.rb

@@ -52,8 +52,14 @@ class ErpForms::ErpApp::Desktop::DynamicForms::FormsController < ErpForms::ErpAp
   end
 
   # get a single form
-  def get    
-    form = DynamicForm.find(params[:id]).to_extjs_formpanel(
+  def get
+    if params[:id]
+      dform = DynamicForm.find(params[:id])
+    else
+      dform = DynamicForm.find_by_model_name_and_default(params[:model_name], true)
+    end      
+
+    form = dform.to_extjs_formpanel(
                 { :url => "/erp_forms/erp_app/desktop/dynamic_forms/data/#{params[:form_action]}",
                   :record_id => params[:id]
                 })

data/app/controllers/erp_forms/erp_app/desktop/dynamic_forms/models_controller.rb

@@ -29,7 +29,7 @@ class ErpForms::ErpApp::Desktop::DynamicForms::ModelsController < ErpForms::ErpA
   def delete
     DynamicFormModel.destroy(params[:id])
 	
-    render :json => {success => true}
+    render :json => {:success => true}
   end
   
   # create a dynamic form model
@@ -39,7 +39,7 @@ class ErpForms::ErpApp::Desktop::DynamicForms::ModelsController < ErpForms::ErpA
       :model_name => model_name
     })
 	
-    render :json => {success => true}
+    render :json => {:success => true}
   end
   
 end

data/app/models/dynamic_form_document.rb

@@ -12,7 +12,12 @@ class DynamicFormDocument < ActiveRecord::Base
   end
 
   def send_email
-    WebsiteInquiryMailer.deliver_inquiry(self)
+    begin
+      WebsiteInquiryMailer.inquiry(self).deliver
+    rescue Exception => e
+      system_user = Party.find_by_description('Compass AE')
+      AuditLog.custom_application_log_message(system_user, e)
+    end
   end
   
   def self.class_exists?(class_name)

data/app/widgets/dynamic_forms/base.rb

@@ -38,10 +38,6 @@ module Widgets
         def title
           "Dynamic Forms"
         end
-
-        def views_location
-          File.join(File.dirname(__FILE__),"/views")
-        end
     
         def widget_name
           File.basename(File.dirname(__FILE__))

data/lib/erp_forms/dynamic_form_field.rb

@@ -90,6 +90,7 @@ class DynamicFormField
         :labelWidth => options[:labelwidth]
     }
     
+    field[:mapping] = options[:mapping] unless options[:mapping].blank?
     field[:maxLength] = options[:maxlength] unless options[:maxlength].nil?
     
     if selections and selections != []

data/lib/erp_forms/engine.rb

@@ -13,7 +13,10 @@ module ErpForms
       include ErpForms::Extensions::ActiveRecord::HasDynamicForms
     end
 
+    engine = self
     config.to_prepare do
+      ErpBaseErpSvcs.register_compass_ae_engine(engine)
+
       #dynamic_attributes patch
       require "erp_forms/dynamic_attributes_patch"
   	end

data/lib/erp_forms/version.rb

@@ -1,3 +1,9 @@
 module ErpForms
-  VERSION = "2.0.0"
+  module VERSION #:nodoc:
+    MAJOR = 2
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].compact.join('.')
+  end
 end

data/lib/erp_forms.rb

@@ -1,6 +1,7 @@
 #compass libraries
 require 'erp_tech_svcs'
 
+require 'erp_forms/version'
 require 'erp_forms/dynamic_form_field'
 require 'erp_forms/dynamic_grid_column'
 require 'erp_forms/dynamic_form_field'

data/public/javascripts/erp_app/desktop/applications/dynamic_forms/dynamic_data_grid.js

@@ -5,8 +5,7 @@ Ext.define("Compass.ErpApp.Desktop.Applications.DynamicForms.DynamicDataGridPane
     editRecord : function(rec, model_name){
         var self = this;
         Ext.getCmp('westregionPanel').setWindowStatus('Getting update form...');
-        var conn = new Ext.data.Connection();
-        conn.request({
+        Ext.Ajax.request({
             url: '/erp_forms/erp_app/desktop/dynamic_forms/forms/get',
             method: 'POST',
             params:{
@@ -38,8 +37,7 @@ Ext.define("Compass.ErpApp.Desktop.Applications.DynamicForms.DynamicDataGridPane
     deleteRecord : function(rec, model_name){
         var self = this;
         Ext.getCmp('westregionPanel').setWindowStatus('Deleting record...');
-        var conn = new Ext.data.Connection();
-        conn.request({
+        Ext.Ajax.request({
             url: '/erp_forms/erp_app/desktop/dynamic_forms/data/delete',
             method: 'POST',
             params:{
@@ -67,7 +65,7 @@ Ext.define("Compass.ErpApp.Desktop.Applications.DynamicForms.DynamicDataGridPane
     constructor : function(config) {
         config = Ext.apply({
             id:'DynamicFormDataGridPanel',
-            title:'Dynamic Data',
+            //title:'Dynamic Data',
             editable:false,
             page:true,
             pageSize: 20,