netzke-basepack 0.12.9 → 1.0.0.0.pre

data/lib/netzke/basepack/query_builder/{javascripts → client}/query_builder.js

@@ -20,7 +20,7 @@
   },
 
   buildFormFromQuery: function(query) {
-    this.onClearAll();
+    this.netzkeOnClearAll();
 
     if (query.length !== 0) {
       Ext.each(query, function(f, i){
@@ -82,20 +82,22 @@
     }, this);
   },
 
-  onClearAll: function() {
+  netzkeOnClearAll: function() {
     this.removeAllTabs(true);
-    this.getActiveTab().items.first().onClearAll();
+    this.getActiveTab().items.first().netzkeOnClearAll();
   },
 
-  onReset: function() {
-    this.eachTab(function(t) { t.onReset(); });
+  netzkeOnReset: function() {
+    this.eachTab(function(t) {
+      t.items.first().onReset();
+    });
   },
 
   removeAllTabs: function(exceptLast) {
     this.eachTab(function(t) { if (this.items.getCount() > (exceptLast ? 2 : 1)) {this.remove(t);} }, this);
   },
 
-  onSavePreset: function(){
+  netzkeOnSavePreset: function(){
     var searchName = this.presetsCombo.getRawValue();
 
     if (searchName !== "") {
@@ -103,7 +105,7 @@
       var existingPresetIndex = presetsComboStore.find('text', searchName);
       if (existingPresetIndex !== -1) {
         // overwriting
-        Ext.Msg.confirm(this.i18n.overwriteConfirmTitle, this.i18n.overwriteConfirm, function(btn, text){
+        Ext.Msg.confirm(this.i18n.overwriteConfirmTitle, Ext.String.format(this.i18n.overwriteConfirm, searchName), function(btn, text){
           if (btn == 'yes') {
             var r = presetsComboStore.getAt(existingPresetIndex);
             r.set('value', this.getQuery(true));
@@ -119,19 +121,19 @@
   },
 
   doSavePreset: function(name){
-    this.savePreset({
+    this.server.savePreset({
       name: name,
       query: Ext.encode(this.getQuery(true))
     });
   },
 
-  onDeletePreset: function(){
+  netzkeOnDeletePreset: function(){
     var searchName = this.presetsCombo.getRawValue();
     if (searchName !== "") {
-      Ext.Msg.confirm(this.i18n.deleteConfirmTitle, this.i18n.overwriteConfirm, function(btn, text){
+      Ext.Msg.confirm(this.i18n.deleteConfirmTitle, Ext.String.format(this.i18n.deleteConfirm, searchName), function(btn, text){
         if (btn == 'yes') {
           this.removePresetFromList(searchName);
-          this.deletePreset({
+          this.server.deletePreset({
             name: searchName
           });
         }
@@ -139,7 +141,7 @@
     }
   },
 
-  onApply: function() {
+  netzkeOnApply: function() {
     this.fireEvent('conditionsupdate', this.getQuery());
   },
 

data/lib/netzke/basepack/record_form_window.rb

@@ -1,6 +1,6 @@
 module Netzke
   module Basepack
-    class RecordFormWindow < Netzke::Basepack::Window
+    class RecordFormWindow < Netzke::Window::Base
       def configure(c)
         super
         c.fbar = [:ok, :cancel]
@@ -15,12 +15,12 @@ module Netzke
         c.record_id = config.client_config[:record_id]
       end
 
-      component :multi_edit_form do |c|
+      component :multiedit_form do |c|
         preconfigure_form(c)
-        c.multi_edit = true
+        c.multiedit = true
       end
 
-      js_configure do |c|
+      client_class do |c|
         c.button_align = :right
         c.width = '80%'
         c.auto_height = true
@@ -32,13 +32,13 @@ module Netzke
           }
         JS
 
-        c.on_ok = <<-JS
+        c.netzke_on_ok = <<-JS
           function(params){
-            this.items.first().onApply();
+            this.items.first().netzkeOnApply();
           }
         JS
 
-        c.on_cancel = <<-JS
+        c.netzke_on_cancel = <<-JS
           function(params){
             this.close();
           }
@@ -56,7 +56,7 @@ module Netzke
       end
 
       def preconfigure_form(c)
-        c.klass = Form
+        c.klass = Netzke::Form::Base
         c.border = true
         c.bbar = false
         c.prevent_header = true

data/lib/netzke/basepack/search_panel.rb

@@ -39,16 +39,15 @@ module Netzke
       ATTRIBUTE_OPERATORS_MAP[:decimal] = ATTRIBUTE_OPERATORS_MAP[:integer]
       ATTRIBUTE_OPERATORS_MAP[:float] = ATTRIBUTE_OPERATORS_MAP[:integer]
 
-      js_configure do |c|
+      client_class do |c|
         c.extend = "Ext.form.FormPanel"
         c.padding = 5
         c.auto_scroll = true
         c.require :condition_field
-        c.mixin
         c.attribute_operators_map = ATTRIBUTE_OPERATORS_MAP
       end
 
-      def js_configure(c)
+      def configure_client(c)
         super
         c.attrs = config[:fields]
         c.preset_query = (config[:load_last_preset] ? last_preset.try(:fetch, "query") : config[:query]) || []
@@ -56,15 +55,14 @@ module Netzke
 
       def attributes
         config[:fields].map do |f|
-          f[:attr_type] ||= :string
-          {name: f[:name], field_label: f[:field_label], attr_type: f[:attr_type]}
+          f[:type] ||= :string
+          {name: f[:name], field_label: f[:field_label], type: f[:type]}
         end
       end
 
       def last_preset
         (state[:presets] || []).last
       end
-
     end
   end
 end

data/lib/netzke/basepack/search_panel/{javascripts → client}/condition_field.js

@@ -1,4 +1,4 @@
-Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
+Ext.define('Netzke.Basepack.SearchPanel.ConditionField', {
   extend:     'Ext.form.FieldContainer',
   alias:      'widget.netzkebasepacksearchpanelconditionfield',
 
@@ -22,12 +22,12 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
   },
 
   initComponent: function(){
-    if (!this.attrType || this.assoc) this.attrType = 'string';
+    if (!this.type || this.assoc) this.type = 'string';
 
-    this.attrTypeHash = {};
+    this.typeHash = {};
 
     var storeData = Ext.Array.map(this.ownerCt.attrs, function(attr) {
-      this.attrTypeHash[attr.name] = attr.attrType;
+      this.typeHash[attr.name] = attr.type;
       return [attr.name, attr.text];
     }, this);
 
@@ -44,7 +44,7 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
         triggerAction: 'all',
         value: this.attr ? this.attr.underscore() : "",
         listeners: {
-          select: this.onAttributeChange,
+          select: this.netzkeOnAttributeChange,
           scope: this
         }
       }
@@ -52,9 +52,9 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
 
     if (this.attr) {
 
-      var operators = this.ownerCt.attributeOperatorsMap[this.attrType] || [[]];
+      var operators = this.ownerCt.attributeOperatorsMap[this.type] || [[]];
 
-      if (this.attrType === 'boolean') {
+      if (this.type === 'boolean') {
         items.push({
           xtype     : 'tricheckbox',
           width: 100,
@@ -95,7 +95,7 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
             value: this.value,
             itemId: "valueField"
           },
-          this.valueFieldConfigs[this.attrType] // refining the config dependent on the attr type
+          this.valueFieldConfigs[this.type] // refining the config dependent on the attr type
         ));
       }
 
@@ -111,9 +111,6 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
 
     this.items = items;
 
-    // Why on Earth is this not working? Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField undefined???
-    // Netzke.classes.Basepack.SearchPanel.ConditionField.superclass.initComponent.call(this);
-    // Ext.form.CompositeField.prototype.initComponent.call(this); // workaround
     this.callParent();
 
     this.attrCombo = this.getComponent('attrCombo');
@@ -131,24 +128,24 @@ Ext.define('Netzke.classes.Netzke.Basepack.SearchPanel.ConditionField', {
     ownerCt.fireEvent('fieldsnumberchange');
   },
 
-  onAttributeChange: function(e){
+  netzkeOnAttributeChange: function(e){
     this.fireEvent('configured');
     this.changeAttribute(e.value);
   },
 
-  // Dynamically replace self with a field with different attrType
+  // Dynamically replace self with a field with different type
   changeAttribute: function(attr){
-    var attrType = this.attrTypeHash[attr];
+    var type = this.typeHash[attr];
     var idx = this.ownerCt.items.indexOf(this);
     var owner = this.ownerCt;
-    var newSelf = Ext.createByAlias('widget.netzkebasepacksearchpanelconditionfield', Ext.apply(this.initialConfig, {name: attr, attrType: attrType, attr: attr.underscore(), ownerCt: this.ownerCt, operator: null}));
+    var newSelf = Ext.createByAlias('widget.netzkebasepacksearchpanelconditionfield', Ext.apply(this.initialConfig, {name: attr, type: type, attr: attr.underscore(), ownerCt: this.ownerCt, operator: null}));
     owner.insert(idx, newSelf);
     setTimeout(function() { this.destroy(); }.bind(this), 1); // this gives time for pending events to get handled without errors
   },
 
   // Returns true if it should be in the query
   valueIsSet: function(){
-    return !!(this.attrCombo.getValue() && (this.attrType === 'boolean' || this.operatorCombo.getValue()) && !Ext.isEmpty(this.valueField.getValue()));
+    return !!(this.attrCombo.getValue() && (this.type === 'boolean' || this.operatorCombo.getValue()) && !Ext.isEmpty(this.valueField.getValue()));
   },
 
   // Returns the query object

data/lib/netzke/basepack/search_panel/{javascripts → client}/search_panel.js

@@ -3,13 +3,13 @@
     this.callParent();
     this.buildFormFromQuery(this.presetQuery);
 
-    this.onAddCondition();
+    this.netzkeOnAddCondition();
 
   },
 
   // Will probably need to be performance-optimized in the future, as recreating the fields is expensive
   buildFormFromQuery: function(query) {
-    this.onClearAll();
+    this.netzkeOnClearAll();
     Ext.each(query, function(f){
       f.ownerCt = this;
       this.insert(this.items.length - 1, Ext.createByAlias('widget.netzkebasepacksearchpanelconditionfield', f));
@@ -17,23 +17,23 @@
     this.doLayout();
   },
 
-  onAddCondition: function() {
+  netzkeOnAddCondition: function() {
     var condField = Ext.createByAlias('widget.netzkebasepacksearchpanelconditionfield', {ownerCt: this});
     condField.on('configured', function() {
-      this.onAddCondition();
+      this.netzkeOnAddCondition();
     }, this, {single: true});
     this.add(condField);
     this.doLayout();
     this.fireEvent('fieldsnumberchange');
   },
 
-  onReset: function() {
+  netzkeOnReset: function() {
     this.items.each(function(f){
       if (f.valueField) {f.clearValue();}
     });
   },
 
-  onClearAll: function() {
+  netzkeOnClearAll: function() {
     this.eachConfiguredField(function(f) {
       this.remove(f);
     }, this);
@@ -56,7 +56,7 @@
     this.eachConfiguredField(function(f){
       if (f.valueIsSet() || all) {
         var cond = f.buildValue();
-        if (all) {cond.attrType = f.attrType;}
+        if (all) {cond.type = f.type;}
         query.push(cond);
       }
     });

data/lib/netzke/basepack/search_window.rb

@@ -1,11 +1,11 @@
 module Netzke
   module Basepack
-    class SearchWindow < Netzke::Basepack::Window
+    class SearchWindow < Netzke::Window::Base
 
       action :search
       action :cancel
 
-      js_configure do |c|
+      client_class do |c|
         c.width = "50%"
         c.auto_height = true
         c.close_action = "hide"
@@ -26,14 +26,14 @@ module Netzke
           }
         JS
 
-        c.on_search = <<-JS
+        c.netzke_on_search = <<-JS
           function(){
             this.closeRes = 'search';
             this.hide();
           }
         JS
 
-        c.on_cancel = <<-JS
+        c.netzke_on_cancel = <<-JS
           function(){
             this.hide();
           }
@@ -42,14 +42,14 @@ module Netzke
 
       def configure(c)
         super
-        c.items = [:search_panel]
+        c.items = [:query_builder]
         c.title = I18n.t('netzke.basepack.search_window.title')
         c.persistence = false
         c.prevent_header = true
         c.buttons = [:search, :cancel]
       end
 
-      component :search_panel do |c|
+      component :query_builder do |c|
         c.klass = QueryBuilder
         c.model = config[:model]
         c.fields = config[:fields]

data/lib/netzke/basepack/version.rb

@@ -1,5 +1,5 @@
 module Netzke
   module Basepack
-    VERSION = "0.12.9"
+    VERSION = "1.0.0.0.pre"
   end
 end

data/lib/netzke/form/base.rb

@@ -0,0 +1,166 @@
+module Netzke
+  module Form
+    # Ext.form.Panel-based component with the following features
+    #
+    # * automatic default attribute configuration (overridable via config)
+    # * model validations
+    # * dynamic loading of form data
+    # * lockable mode
+    #
+    # Client-side methods are documented here: http://api.netzke.org/client/classes/Netzke.Form.Base.html.
+    #
+    # == Configuration
+    #
+    # [model]
+    #
+    #   Name of the ActiveRecord model that provides data to this Grid (e.g. "User") or the model's class (e.g. User).
+    #   Model is optional if you provide custom implementation of the endpoints.
+    #
+    # [record_id]
+    #
+    # Id of the record to be displayd in the form. Also see +:record+
+    #
+    # [record]
+    #
+    #   Record to be displayd in the form. Takes precedence over +:record_id+
+    #
+    # [items]
+    #
+    #   The layout of the fields as an array. See "Layout configuration".
+    #
+    # [mode]
+    #
+    #   Render mode, accepted options:
+    #
+    #   * +lockable+ - makes the form panel load initially in "display mode", then lets "unlock" it, change the values, and "lock" it again, while updating the values on the server
+    #
+    # == Configuring attributes
+    #
+    # === Overriding individual attributes
+    # Use the +attribute+ DSL method to override configuration for a specific attribute. See +Basepack::Attributes+.
+    #
+    # === Layout configuration
+    #
+    # The layout of the form is configured by supplying the +item+ config option, same way it would be configured in Ext (thus allowing for complex form layouts). Form will expand fields by looking at their names (unless +bind+ is set to +false+ for a specific field).
+    #
+    # == Endpoints
+    # Form implements the following endpoints:
+    #
+    # * +load+ - loads a record with a given id from the server, e.g.:
+    #
+    #     someForm.server.load({id: 100});
+    #
+    # * +submit+ - gets called when the form gets submitted (e.g. by pressing the Apply button, or by calling netzkeOnApply)
+    # * +get_combobox_options+ - gets called when a 'remote' combobox field gets expanded
+    class Base < Netzke::Base
+      include Netzke::Form::Endpoints
+      include Netzke::Form::Services
+      include Netzke::Basepack::Attributes
+      include Netzke::Basepack::Fields
+      include Netzke::Basepack::DataAccessor
+
+      client_class do |c|
+        c.extend = "Ext.form.Panel"
+        c.require :readonly_mode
+      end
+
+      def configure_client(c)
+        super
+
+        configure_locked(c)
+
+        if model_adapter
+          c.pri = model_adapter.primary_key
+        end
+
+        if !c.multiedit
+          c.record = js_record_data if record
+        else
+          c.record_id = c.record = nil if c.multiedit # never set record_id in multi-edit mode
+        end
+      end
+
+      action :apply do |a|
+        a.icon = :tick
+      end
+
+      action :edit do |a|
+        a.icon = :pencil
+      end
+
+      action :cancel do |a|
+        a.icon = :cancel
+      end
+
+      def configure_locked(c)
+        c[:locked] = c[:locked].nil? ? (c[:mode] == :lockable) : c[:locked]
+      end
+
+      # Extra JavaScripts and stylesheets
+      client_styles do |c|
+        c.require :readonly_mode
+      end
+
+      # A hash of record data including the meta field
+      def js_record_data
+        model_adapter.record_to_hash(record, fields.values).merge(:meta => meta_field).netzke_literalize_keys
+      end
+
+      def record
+        @record ||= config[:record] || config[:record_id] && model_adapter.find_record(config[:record_id])
+      end
+
+      def bbar
+        config.has_key?(:bbar) ? config[:bbar] : default_bbar
+      end
+
+      def default_bbar
+        [].tap do |bbar|
+          unless config.read_only
+            bbar << "->" << :apply
+          end
+        end
+      end
+
+      def multiedit?
+        !!config.multiedit
+      end
+
+      private
+
+      def validate_config(c)
+        c.bbar = bbar
+        super
+      end
+
+      def normalize_config
+        config.items = items
+        @fields_from_items = {} # will be built during execution of `super`
+        super
+      end
+
+      def self.server_side_config_options
+        super + [:scope]
+      end
+
+      def meta_field
+        {}.tap do |res|
+          assoc_values = get_association_values
+          res[:association_values] = assoc_values.netzke_literalize_keys if record && !assoc_values.empty?
+        end
+      end
+
+      def get_association_values
+        fields_that_need_associated_values = fields.select{ |k,v| k.to_s.index("__") && !fields[k][:nested_attribute] }
+        # Take care of Ruby 1.8.7
+        if fields_that_need_associated_values.is_a?(Array)
+          fields_that_need_associated_values = fields_that_need_associated_values.inject({}){|r,(k,v)| r.merge(k => v)}
+        end
+
+        fields_that_need_associated_values.each_pair.inject({}) do |r,(k,v)|
+          r.merge(k => model_adapter.record_value_for_attribute(record, fields_that_need_associated_values[k], true))
+        end
+      end
+    end
+  end
+end