erp_forms 2.1.0 → 3.0.0

data/README.rdoc

@@ -2,90 +2,15 @@
 
 ERP Forms adds dynamic forms to Compass using ExtJS. 
 
+== For a quick HOWTO, read this document in the wiki
 
-== 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:
-  <%=raw render_widget :dynamic_forms, :params => {:model_name => 'MyDynamicModel', :width => '350'} %>
-
+https://github.com/portablemind/compass_agile_enterprise/wiki/Dynamic-Forms
 
 == TODO
-
-Dynamic Form Builder
-Search Dynamic Attributes via SOLR
 Code Mirror form field
-file attachments w/ has_file_assets and plupload
 concatenated field
 calculated field
-related field with search ahead for relations with huge datasets
 
 ============================================================
-Copyright (c) 2011 Adam Hull
+Developed by Adam Hull
+Copyright (c) 2011-2013 True North Technology Solutions

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

@@ -55,7 +55,7 @@ module ErpForms::ErpApp::Desktop::DynamicForms
 
         myDynamicObject = DynamicFormModel.get_constant(params[:model_name])
 
-        if $USE_SOLR_FOR_DYNAMIC_FORM_MODELS and myDynamicObject.is_searchable?
+        if ErpForms.use_solr? and myDynamicObject.is_searchable?
           solr_search_results = myDynamicObject.search do
             keywords query_filter unless params[:query_filter].blank?
             paginate(:page => page, :per_page => per_page)

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

@@ -141,10 +141,10 @@ class ErpForms::ErpApp::Desktop::DynamicForms::FormsController < ErpForms::ErpAp
     dform = assign_form_attributes(dform)
     dform.updated_by_id = current_user.id
 
-    # update solr config for model (doesn't work yet)
-    # DynamicFormModel.get_constant(dform.model_name).sunspot_setup if $USE_SOLR_FOR_DYNAMIC_FORM_MODELS
-
     if dform.save
+      # update solr config for model 
+      DynamicFormModel.get_constant(dform.model_name).sunspot_setup if ErpForms.use_solr?
+
       render :json => {:success => true}
     else
       render :json => {:success => false}
@@ -159,7 +159,11 @@ class ErpForms::ErpApp::Desktop::DynamicForms::FormsController < ErpForms::ErpAp
       dform.dynamic_form_model_id = DynamicFormModel.find_by_model_name(params[:model_name]).id
       dform.default = false
       dform.created_by_id = current_user.id
+
       if dform.save
+        # update solr config for model 
+        DynamicFormModel.get_constant(dform.model_name).sunspot_setup if ErpForms.use_solr?
+
         render :json => {:success => true, :id => dform.id}
       else
         render :json => {:success => false}

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

@@ -24,6 +24,9 @@ class ErpForms::ErpApp::Desktop::DynamicForms::ModelsController < ErpForms::ErpA
     myDynamicObject = DynamicFormModel.get_constant(params[:model_name])    
     myDynamicObject.set_default(params[:id])
 	
+    # update solr config for model
+    DynamicFormModel.get_constant(params[:model_name]).sunspot_setup if ErpForms.use_solr?
+
     render :json => {:success => true}
   end
 

data/app/models/dynamic_form.rb

@@ -5,6 +5,8 @@ class DynamicForm < ActiveRecord::Base
   belongs_to :created_by, :class_name => "User"
   belongs_to :updated_by, :class_name => "User"
 
+  after_create :default_form_check
+
   extend FriendlyId
   friendly_id :description, :use => [:slugged], :slug_column => :internal_identifier
   def should_generate_new_friendly_id?
@@ -12,7 +14,14 @@ class DynamicForm < ActiveRecord::Base
   end
 
   validates_uniqueness_of :internal_identifier, :scope => :model_name, :case_sensitive => false
-  
+
+  def default_form_check
+    # count how many forms this model has, if one, set as default
+    if dynamic_form_model.dynamic_forms.count == 1
+      DynamicFormModel.get_constant(self.model_name).set_default(self.id)
+    end
+  end
+
   def self.class_exists?(class_name)
   	result = nil
   	begin
@@ -175,9 +184,9 @@ class DynamicForm < ActiveRecord::Base
       :text => self.cancel_button_label,
       :listeners => NonEscapeJsonString.new("{
           \"click\":function(button){
-            var form = button.findParentByType('form');
-            if (form.close_selector){
-              form.up(form.close_selector).close();
+            var form = button.findParentByType('dynamic_form_panel');
+            if (form.up('tabpanel')){
+              form.up('tabpanel').remove(form.up('panel'));
             }else{
               form.up('window').close();
             }

data/lib/erp_forms/dynamic_form_field.rb

@@ -1,8 +1,5 @@
 class DynamicFormField
-=begin
-  Field Options TODO  
-  searchable
-
+=begin  
   Field Types TODO
   special:
   codemirror
@@ -11,7 +8,6 @@ class DynamicFormField
   complex (for future implementation):
   concatenated
   calculated
-  related with search ahead for relations with huge datasets
 =end
 
 #  options = {

data/lib/erp_forms/engine.rb

@@ -16,14 +16,10 @@ module ErpForms
     end
 
     ErpBaseErpSvcs.register_as_compass_ae_engine(config, self)
-    ::ErpApp::Widgets::Loader.load_compass_ae_widgets(config, self)
 
     config.to_prepare do
       #dynamic_attributes patch
       require "erp_forms/dynamic_attributes_patch"
-
-      # setup sunspot for all dynamic form models if we're using solr
-      DynamicFormModel.sunspot_setup_all if ($USE_SOLR_FOR_DYNAMIC_FORM_MODELS && ActiveRecord::Base.connection.table_exists?('dynamic_form_models'))
   	end
 	
   end

data/lib/erp_forms/extensions/active_record/has_dynamic_forms.rb

@@ -58,10 +58,10 @@ module ErpForms
       		    DynamicForm.find_all_by_model_name(self.class_name)
             end
 
-            def set_default(internal_identifier)
-              DynamicForm.update_all({:default => false}, "model_name=#{self.class.to_s}")
-              DynamicForm.update_all({:default => true}, "model_name=#{self.class.to_s} AND internal_identifier=#{internal_identifier}")
-            end
+            # def set_default(internal_identifier)
+            #   DynamicForm.update_all({:default => false}, "model_name=#{self.class.to_s}")
+            #   DynamicForm.update_all({:default => true}, "model_name=#{self.class.to_s} AND internal_identifier=#{internal_identifier}")
+            # end
 
       		end	
       end

data/lib/erp_forms/version.rb

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

data/lib/erp_forms.rb

@@ -13,4 +13,8 @@ require 'erp_forms/extensions/extensions'
 require "erp_forms/engine"
 
 module ErpForms
+
+  def self.use_solr?
+    Object.const_defined?('ErpSearch') and ErpSearch::Config.use_solr_for_dynamic_form_models
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: erp_forms
 version: !ruby/object:Gem::Version
-  version: 2.1.0
+  version: 3.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-11 00:00:00.000000000 Z
+date: 2013-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dynamic_attributes
@@ -109,11 +109,6 @@ files:
 - app/views/dynamic_form_mailer/widget_email_with_attachments.text.erb
 - app/views/layouts/application.html.erb
 - app/views/layouts/erp_forms/application.html.erb
-- app/widgets/dynamic_forms/base.rb
-- app/widgets/dynamic_forms/javascript/dynamic_forms.js
-- app/widgets/dynamic_forms/views/error.html.erb
-- app/widgets/dynamic_forms/views/index.html.erb
-- app/widgets/dynamic_forms/views/success.html.erb
 - config/routes.rb
 - db/data_migrations/20110608185830_create_default_dynamic_models_and_forms.rb
 - db/data_migrations/20110828190913_create_desktop_app_dynamic_forms.rb
@@ -220,18 +215,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1443867374414206625
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
-      segments:
-      - 0
-      hash: -1443867374414206625
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.24

data/app/widgets/dynamic_forms/base.rb

@@ -1,139 +0,0 @@
-module Widgets
-  module DynamicForms
-    class Base < ErpApp::Widgets::Base
-      def index
-	      render
-	    end
-
-  	  def new
-        begin
-          unless params[:file].nil?
-            # size check
-            if params[:file].tempfile.size > ErpTechSvcs::Config.max_file_size_in_mb.megabytes
-              raise "File cannot be larger than #{ErpTechSvcs::Config.max_file_size_in_mb}MB"
-            end
-          end
-          form_data = JSON.parse(params[:form_data_json])
-          form_data[:dynamic_form_id] = params[:dynamic_form_id]
-          form_data[:model_name] = params[:model_name]
-          form_data.symbolize_keys!
-          @website = Website.find_by_host(request.host_with_port)
-
-          if form_data[:email_subject].blank?
-            subject = "#{form_data[:model_name]} Submission from #{@website.title}"
-          else
-            subject = strip_tags(form_data[:email_subject])
-            form_data.delete(:email_subject)
-          end
-
-      		@myDynamicObject = DynamicFormModel.get_instance(form_data[:model_name])
-
-      		form_data[:created_by] = current_user unless current_user.nil?
-      		form_data[:created_with_form_id] = form_data[:dynamic_form_id] if form_data[:dynamic_form_id] and params[:is_html_form].blank?
-      		form_data[:website] = @website.title
-
-      		@myDynamicObject = @myDynamicObject.assign_all_attributes(form_data, ErpApp::Widgets::Base::IGNORED_PARAMS)
-  			
-          # get dynamic for from form_data[:created_with_form_id]
-          form = DynamicForm.find(form_data[:created_with_form_id])
-          
-          # check widget_action from dynamic form
-          if !form.nil? and ['email', 'both'].include?(form.widget_action)            
-            # email data
-            attachments = (params[:file].nil? ? [] : [params[:file]])
-            send_email(form, @myDynamicObject, subject, attachments)
-          end
-
-          if form.nil? or (!form.nil? and ['save', 'both'].include?(form.widget_action))
-            #save data
-            @myDynamicObject.save
-            save_file_asset(form_data) unless params[:file].nil?
-          end
-
-          output = render_to_string(:template => "success", :layout => false)
-          render :inline => {
-            :success => true,
-            :response => (file_upload_request? ? ERB::Util.html_escape(output) : output)
-          }.to_json
-        rescue Exception => e
-          Rails.logger.error e.message
-          Rails.logger.error e.backtrace.join("\n")
-          output = render_to_string(:template => "error", :layout => false, :locals => {:message => e.message})
-  			  render :inline => {
-  			    :success => false,
-            :response => (file_upload_request? ? ERB::Util.html_escape(output) : output)
-  			  }.to_json    			    
-        end
-  	  end
-
-      protected
-      def file_upload_request?
-        request.env['HTTP_X_REQUESTED_WITH'] != 'XMLHttpRequest'
-      end
-
-      def save_file_asset(form_data)
-        result = {}
-        name = params[:file].original_filename
-        data = params[:file].tempfile
-        set_file_support
-
-        begin
-          @root_node = File.join(ErpTechSvcs::Config.file_assets_location, form_data[:model_name], @myDynamicObject.id.to_s)
-          file = @myDynamicObject.add_file(data, File.join(@file_support.root, base_path, name))
-
-          roles = ['admin', @myDynamicObject.role_iid]
-          (@myDynamicObject.file_security_default == 'private') ? file.add_capability(:download, 'FileAsset', roles) : file.remove_all_capabilities
-          
-          return {:success => true}
-        rescue Exception => e
-          Rails.logger.error e.message
-          Rails.logger.error e.backtrace
-          raise "Error uploading file. #{e.message}"
-        end
-      end      
-
-      def base_path          
-        @base_path = (@root_node.nil? ? nil : File.join(@file_support.root, @root_node))
-      end
-
-      def set_file_support
-        @file_support = ErpTechSvcs::FileSupport::Base.new(:storage => ErpTechSvcs::Config.file_storage)
-      end
-
-      def send_email(form, dynamicObject, subject='', attachments=[])
-        begin
-          DynamicFormMailer.widget_email_with_attachments(form, dynamicObject, subject, attachments).deliver
-        rescue Exception => e
-          Rails.logger.error e.message
-          Rails.logger.error e.backtrace
-          raise "Error sending email. #{e.message}"
-        end
-      end
-
-      #should not be modified
-      #modify at your own risk
-      def locate
-        File.dirname(__FILE__)
-      end
-  
-      class << self
-        def title
-          "Dynamic Forms"
-        end
-    
-        def widget_name
-          File.basename(File.dirname(__FILE__))
-        end
-    
-        def base_layout
-          begin
-            file = File.join(File.dirname(__FILE__),"/views/layouts/base.html.erb")
-            IO.read(file)
-          rescue
-            return nil
-          end
-        end
-      end
-    end
-  end
-end

data/app/widgets/dynamic_forms/javascript/dynamic_forms.js

@@ -1,111 +0,0 @@
-Compass.ErpApp.Widgets.DynamicForms = {
-    addDynamicForm:function(){
-        var addDynamicFormWidgetWindow = Ext.create("Ext.window.Window",{
-            layout:'fit',
-            width:375,
-            title:'Add DynamicForm Widget',
-            plain: true,
-            buttonAlign:'center',
-            items: Ext.create("Ext.form.Panel",{
-                labelWidth: 100,
-                frame:false,
-                bodyStyle:'padding:5px 5px 0',
-                defaults: {
-                    width: 325
-                },
-                items: [
-                {
-                    xtype:'combo',
-                    value:'',
-                    loadingText:'Retrieving Dynamic Form Models ...',
-                    store:Ext.create('Ext.data.Store',{
-                        proxy:{
-                          type:'ajax',
-                          reader:{
-                              type:'json',
-                              root: 'dynamic_form_model'
-                          },
-                          url:'/erp_forms/erp_app/desktop/dynamic_forms/models/index'
-                        },
-                        fields:[
-                            {
-                                name:'id'
-                            },
-                            {
-                                name:'model_name'
-                            }
-                        ]
-                    }),
-                    forceSelection:true,
-                    editable:true,
-                    fieldLabel:'Model Name',
-                    autoSelect:true,
-                    mode: 'remote',
-                    name: 'model_name',
-                    displayField:'model_name',
-                    valueField:'model_name',
-                    triggerAction: 'all',
-                    allowBlank:false,
-                    plugins: [new helpQtip("Dynamic Form Model Name (Class)")]
-                },
-                {
-                    xtype:'textfield',
-                    fieldLabel:'Form Width',
-                    name: 'form_width',
-                    allowBlank:true,
-                    plugins: [new helpQtip("Form Width in Pixels. Leave blank for auto width.")]
-                }
-                ]
-            }),
-            buttons: [{
-                text:'Submit',
-                listeners:{
-                    'click':function(button){
-                        var tpl = null;
-                        var content = null;
-                        var formPanel = button.findParentByType('window').query('form').first();
-                        var basicForm = formPanel.getForm();
-                        var WidgetDynamicFormModelName = basicForm.findField('model_name');
-                        var WidgetDynamicFormWidth = basicForm.findField('form_width');
-                        if (basicForm.isValid()){
-                            var data = {
-                                WidgetDynamicFormModelName: WidgetDynamicFormModelName.getValue(),
-                                WidgetDynamicFormWidth: WidgetDynamicFormWidth.getValue()
-                            };
-
-                            tpl = new Ext.XTemplate(
-                                "<% # Optional Parameters:\n",
-                                "   # internal_identifier: Models can have multiple forms\n",
-                                "   #                      Leave blank if you want to use the default form\n",
-                                "   #                      Specify internal_identifier to choose a specific form %>\n",
-                                "<%= render_widget :dynamic_forms,\n",
-                                "   :params => {:model_name => '{WidgetDynamicFormModelName}',\n",
-                                "               :internal_identifier => ''",
-                                '<tpl if="WidgetDynamicFormWidth">',
-                                ",\n               :width => {WidgetDynamicFormWidth} ",
-                                '</tpl>',
-                                "} %>");
-                            content = tpl.apply(data);
-
-                            //add rendered template to center region editor
-                            Ext.getCmp('knitkitCenterRegion').addContentToActiveCodeMirror(content);
-                            addDynamicFormWidgetWindow.close();                            
-                        }
-                    }
-                }
-            },{
-                text: 'Close',
-                handler: function(){
-                    addDynamicFormWidgetWindow.close();
-                }
-            }]
-        });
-        addDynamicFormWidgetWindow.show();
-    }
-};
-
-Compass.ErpApp.Widgets.AvailableWidgets.push({
-    name:'Dynamic Forms',
-    iconUrl:'/images/icons/document_text/document_text_48x48.png',
-    onClick:Compass.ErpApp.Widgets.DynamicForms.addDynamicForm
-});

data/app/widgets/dynamic_forms/views/error.html.erb

@@ -1,5 +0,0 @@
-<div>
-  <h1>An Error Occurred</h1>
-  <%= message unless message.nil? %>
-
-</div>

data/app/widgets/dynamic_forms/views/index.html.erb

@@ -1,8 +0,0 @@
-<div id="<%=widget_result_id %>"></div>
-
-<%=raw render_dynamic_form(params[:model_name], {
-      :internal_identifier => params[:internal_identifier],
-      :width => (params[:width] ? params[:width].to_i : nil)
-    }) %>
-
-<div id="dynamic_form_target"></div>

data/app/widgets/dynamic_forms/views/success.html.erb

@@ -1,4 +0,0 @@
-<div>
-  <h1>Thank you.</h1>
-  <p>Your form has been processed successfully.</p>
-</div>