netzke-basepack 0.6.2 → 0.6.3

data/lib/netzke/basepack/accordion_panel.rb

@@ -18,14 +18,16 @@ module Netzke
       include WrapLazyLoaded
 
       js_property :layout, 'accordion'
+      js_property :component_load_mask, {:msg => null} # due to a probable bug in Ext's Accordion Layout (mask message is mis-layed-out), disabling mask message
 
       js_method :init_component, <<-JS
         function(params){
           #{js_full_class_name}.superclass.initComponent.call(this);
           this.items.each(function(item){
             item.on('expand', function(i){
-              if (i && i.wrappedComponent && !i.items.first()) {
-                this.loadComponent({name: i.wrappedComponent, container: i.id});
+              if (i && i.wrappedComponent && !i.items.first() && !i.beingLoaded) {
+                i.beingLoaded = true; // prevent more than one request per panel in case of fast clicking
+                this.loadComponent({name: i.wrappedComponent, container: i.id}, function(){i.beingLoaded = false});
               }
             }, this);
           }, this);

data/lib/netzke/basepack/auth_app.rb

@@ -0,0 +1,152 @@
+module Netzke
+  module Basepack
+    # Extension to SimpleApp that brings in support for authentication and masquerading
+    # ** NOTE: it's WIP **
+    class AuthApp < SimpleApp
+
+      class_attribute :login_url
+      self.login_url = "/login"
+
+      class_attribute :logout_url
+      self.logout_url = "/logout"
+
+      js_method :on_login, <<-JS
+        function(){
+          window.location = "#{login_url}"
+        }
+      JS
+
+      js_method :on_logout, <<-JS
+        function(){
+          window.location = "#{logout_url}"
+        }
+      JS
+
+      js_method :on_toggle_config_mode, <<-JS
+        function(params){
+          this.toggleConfigMode();
+        }
+      JS
+
+      js_method :show_masquerade_selector, <<-JS
+        function(){
+          var w = new Ext.Window({
+            title: 'Masquerade as',
+            modal: true,
+            width: Ext.lib.Dom.getViewWidth() * 0.6,
+            height: Ext.lib.Dom.getViewHeight() * 0.6,
+            layout: 'fit',
+            closeAction :'destroy',
+            buttons: [{
+              text: 'Select',
+              handler : function(){
+                if (role = w.getNetzkeComponent().masquerade.role) {
+                  Ext.Msg.confirm("Masquerading as a role", "Individual preferences for all users with this role will get overwritten as you make changes. Continue?", function(btn){
+                    if (btn === 'yes') {
+                      w.close();
+                    }
+                  });
+                } else {
+                  w.close();
+                }
+              },
+              scope:this
+            },{
+              text:'As World',
+              handler:function(){
+                Ext.Msg.confirm("Masquerading as World", "Caution! All settings that you will modify will be overwritten for all roles and all users. Are you sure you know what you're doing?", function(btn){
+                  if (btn === "yes") {
+                    this.masquerade = {world:true};
+                    w.close();
+                  }
+                }, this);
+              },
+              scope:this
+            },{
+              text:'No masquerading',
+              handler:function(){
+                this.masquerade = {};
+                w.close();
+              },
+              scope:this
+            },{
+              text:'Cancel',
+              handler:function(){
+                w.hide();
+              },
+              scope:this
+            }],
+            listeners : {close: {fn: function(){
+              this.masqueradeAs(this.masquerade || w.getNetzkeComponent().masquerade || {});
+            }, scope: this}}
+          });
+
+          w.show(null, function(){
+            this.loadComponent({id:"masqueradeSelector", container:w.id})
+          }, this);
+
+        }
+      JS
+
+      # Set the Logout button if Netzke::Base.user is set
+      def menu
+        res = []
+        user = User.find_by_id(session[:netzke_user_id])
+        if !user.nil?
+          user_name = user.respond_to?(:name) ? user.name : user.login # try to display user's name, fallback to login
+          res << "->" <<
+          {
+            :text => "#{user_name}",
+            :menu => user_menu
+          }
+        else
+          res << "->" << :login.action
+        end
+        res
+      end
+
+      def user_menu
+        [:logout.action]
+      end
+
+      def initialize(*args)
+        super
+
+        if session[:netzke_just_logged_in] || session[:netzke_just_logged_out]
+          session[:config_mode] = false
+          session[:masq_world] = session[:masq_user] = session[:masq_roles] = nil
+        end
+
+        strong_children_config.deep_merge!(:mode => :config) if session[:config_mode]
+      end
+
+      action :masquerade_selector, :text => "Masquerade as ...", :handler => :show_masquerade_selector
+
+      action :toggle_config_mode do
+        {:text => "#{session[:config_mode] ? "Leave" : "Enter"} config mode"}
+      end
+
+      action :login, :icon => :door_in
+
+      action :logout, :icon => :door_out
+
+      #
+      # Interface section
+      #
+      endpoint :toggle_config_mode do |params|
+        session = Netzke::Base.session
+        session[:config_mode] = !session[:config_mode]
+        {:js => "window.location.reload();"}
+      end
+
+      endpoint :masquerade_as do |params|
+        session = Netzke::Base.session
+        session[:masq_world] = params[:world] == "true"
+        session[:masq_role] = params[:role].try(:to_i)
+        session[:masq_user] = params[:user].try(:to_i)
+        {:js => "window.location.reload();"}
+      end
+
+    end
+  end
+end

data/lib/netzke/basepack/basic_app.rb

@@ -1,267 +1,7 @@
 module Netzke
   module Basepack
-    # == BasicApp
-    # Basis for a Ext.Viewport-based application
-    #
-    # Features:
-    # * dynamic loading of components
-    # * browser history support (press the "Back"-button to go to the previously loaded component)
-    # * AJAX activity indicator
-    # * (TODO) authentification support
-    # * (TODO) masquerade support
-    class BasicApp < Base
-
-      js_base_class "Ext.Viewport"
-
-      js_property :layout, :border
-
-      def self.include_js
-        res = []
-        ext_examples = Netzke::Core.ext_location.join("examples")
-        res << ext_examples.join("ux/statusbar/StatusBar.js")
-        res << "#{File.dirname(__FILE__)}/basic_app/statusbar_ext.js"
-      end
-
-      class_attribute :logout_url
-      self.logout_url = "/logout"
-
-      config do
-        # In status bar we want to show what we are masquerading as
-        if session[:masq_user]
-          user = User.find(session[:masq_user])
-          masq = %Q{user "#{user.login}"}
-        elsif session[:masq_role]
-          role = Role.find(session[:masq_role])
-          masq = %Q{role "#{role.name}"}
-        elsif session[:masq_world]
-          masq = %Q{World}
-        end
-
-        {
-          :items => [{
-            :id => 'main-panel',
-            :region => 'center',
-            :layout => 'fit'
-          },{
-            :id => 'main-toolbar',
-            :xtype => 'toolbar',
-            :region => 'north',
-            :height => 25,
-            :items => menu
-          },{
-            :id => 'main-statusbar',
-            :xtype => 'statusbar',
-            :region => 'south',
-            :height => 22,
-            :statusAlign => 'right',
-            :busyText => 'Busy...',
-            :default_text => masq.nil? ? "Ready #{"(config mode)" if session[:config_mode]}" : "Masquerading as #{masq}",
-            :default_icon_cls => ""
-          }]
-        }
-      end
-
-      js_method :init_component, <<-JS
-        function(){
-          #{js_full_class_name}.superclass.initComponent.call(this);
-
-          // If we are given a token, load the corresponding component, otherwise load the last loaded component
-          var currentToken = Ext.History.getToken();
-          if (currentToken != "") {
-            this.processHistory(currentToken);
-          } else {
-            var lastLoaded = this.initialConfig.componentToLoad; // passed from the server
-            if (lastLoaded) Ext.History.add(lastLoaded);
-          }
-
-          Ext.History.on('change', this.processHistory, this);
-
-          // Setting the "busy" indicator for Ajax requests
-          Ext.Ajax.on('beforerequest', function(){this.findById('main-statusbar').showBusy()}, this);
-          Ext.Ajax.on('requestcomplete', function(){this.findById('main-statusbar').hideBusy()}, this);
-          Ext.Ajax.on('requestexception', function(){this.findById('main-statusbar').hideBusy()}, this);
-
-          // Initialize history
-          Ext.History.init();
-        }
-      JS
-
-      js_method :on_login, <<-JS
-        function(){
-          window.location = "/login"
-        }
-      JS
-
-      js_method :on_logout, <<-JS
-        function(){
-          window.location = "#{logout_url}"
-        }
-      JS
-
-      js_method :process_history, <<-JS
-        function(token){
-          if (token){
-            this.loadComponent({name:token, container:'main-panel'});
-          } else {
-            Ext.getCmp('main-panel').removeChild();
-          }
-        }
-      JS
-
-      js_method :instantiate_component, <<-JS
-        function(config){
-          this.findById('main-panel').instantiateChild(config);
-        }
-      JS
-
-      js_method :app_load_component, <<-JS
-        function(name){
-          Ext.History.add(name);
-        }
-      JS
-
-      js_method :load_component_by_action, <<-JS
-        function(action){
-          this.appLoadComponent(action.component || action.name);
-        }
-      JS
-
-      js_method :on_toggle_config_mode, <<-JS
-        function(params){
-          this.toggleConfigMode();
-        }
-      JS
-
-      js_method :show_masquerade_selector, <<-JS
-        function(){
-          var w = new Ext.Window({
-    				title: 'Masquerade as',
-    				modal: true,
-    				width: Ext.lib.Dom.getViewWidth() * 0.6,
-            height: Ext.lib.Dom.getViewHeight() * 0.6,
-            layout: 'fit',
-    	      closeAction :'destroy',
-            buttons: [{
-              text: 'Select',
-              handler : function(){
-                if (role = w.getNetzkeComponent().masquerade.role) {
-                  Ext.Msg.confirm("Masquerading as a role", "Individual preferences for all users with this role will get overwritten as you make changes. Continue?", function(btn){
-                    if (btn === 'yes') {
-                      w.close();
-                    }
-                  });
-                } else {
-                  w.close();
-                }
-              },
-              scope:this
-            },{
-              text:'As World',
-              handler:function(){
-                Ext.Msg.confirm("Masquerading as World", "Caution! All settings that you will modify will be overwritten for all roles and all users. Are you sure you know what you're doing?", function(btn){
-                  if (btn === "yes") {
-                    this.masquerade = {world:true};
-                    w.close();
-                  }
-                }, this);
-              },
-              scope:this
-            },{
-              text:'No masquerading',
-              handler:function(){
-                this.masquerade = {};
-                w.close();
-              },
-              scope:this
-            },{
-              text:'Cancel',
-              handler:function(){
-                w.hide();
-              },
-              scope:this
-            }],
-            listeners : {close: {fn: function(){
-              this.masqueradeAs(this.masquerade || w.getNetzkeComponent().masquerade || {});
-            }, scope: this}}
-    			});
-
-    			w.show(null, function(){
-    			  this.loadComponent({id:"masqueradeSelector", container:w.id})
-    			}, this);
-
-        }
-      JS
-
-      # Set the Logout button if Netzke::Base.user is set
-      def menu
-        res = []
-        user = User.find_by_id(session[:netzke_user_id])
-        if !user.nil?
-          user_name = user.respond_to?(:name) ? user.name : user.login # try to display user's name, fallback to login
-          res << "->" <<
-          {
-            :text => "#{user_name}",
-            :menu => user_menu
-          }
-        else
-          res << "->" << :login.action
-        end
-        res
-      end
-
-      def user_menu
-        [:logout.action]
-      end
-
-      def initialize(*args)
-        super
-
-        if session[:netzke_just_logged_in] || session[:netzke_just_logged_out]
-          session[:config_mode] = false
-          session[:masq_world] = session[:masq_user] = session[:masq_roles] = nil
-        end
-
-        strong_children_config.deep_merge!(:mode => :config) if session[:config_mode]
-      end
-
-
-      action :masquerade_selector, :text => "Masquerade as ...", :handler => :show_masquerade_selector
-
-      action :toggle_config_mode do
-        {:text => "#{session[:config_mode] ? "Leave" : "Enter"} config mode"}
-      end
-
-      action :login, :icon => :door_in
-
-      action :logout, :icon => :door_out
-
-      # Html required for Ext.History to work
-      def js_component_html
-        super << %Q{
-  <form id="history-form" class="x-hidden">
-      <input type="hidden" id="x-history-field" />
-      <iframe id="x-history-frame"></iframe>
-  </form>
-        }
-      end
-
-      #
-      # Interface section
-      #
-      endpoint :toggle_config_mode do |params|
-        session = Netzke::Base.session
-        session[:config_mode] = !session[:config_mode]
-        {:js => "window.location.reload();"}
-      end
-
-      endpoint :masquerade_as do |params|
-        session = Netzke::Base.session
-        session[:masq_world] = params[:world] == "true"
-        session[:masq_role] = params[:role].try(:to_i)
-        session[:masq_user] = params[:user].try(:to_i)
-        {:js => "window.location.reload();"}
-      end
-
+    # For backward compatibility only. Use AuthApp instead.
+    class BasicApp < AuthApp
     end
   end
 end

data/lib/netzke/basepack/form_panel.rb

@@ -1,19 +1,25 @@
 require "netzke/basepack/form_panel/fields"
 require "netzke/basepack/form_panel/services"
+require "netzke/data_accessor"
 # require "netzke/plugins/configuration_tool"
-# require "netzke/data_accessor"
 
 module Netzke
   module Basepack
-    # = FormPanel
-    #
-    # Represents Ext.form.FormPanel
+    # Ext.form.FormPanel-based component with different goodies
     #
     # == Configuration
-    # * <tt>:model</tt> - name of the ActiveRecord model that provides data to this GridPanel.
-    # * <tt>:record</tt> - record to be displayd in the form. Takes precedence over <tt>:record_id</tt>
-    # * <tt>:record_id</tt> - id of the record to be displayd in the form. Also see <tt>:record</tt>
+    # Besides all the standard +Ext.form.FormPanel+ config options, accepts:
+    # * +model+ - name of the ActiveRecord model that provides data to this GridPanel.
+    # * +record+ - record to be displayd in the form. Takes precedence over +:record_id+
+    # * +record_id+ - id of the record to be displayd in the form. Also see +:record+
+    # * +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
+    # * +updateMask+ - +Ext.LoadMask+ config options for the mask shown while the form is submitting its values
+    #
+    # === 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). FormPanel will expand fields by looking at their names (unless +no_binding+ set to +true+ is specified for a specific field).
     class FormPanel < Netzke::Base
+
       # Class-level configuration
       class_attribute :config_tool_available
       self.config_tool_available = true
@@ -23,32 +29,36 @@ module Netzke
 
       include self::Services
       include self::Fields
-
       include Netzke::DataAccessor
 
-      js_base_class "Netzke.pre.FormPanel"
+      js_base_class "Ext.form.FormPanel"
+
+      def bbar(config)
+        config[:mode] == :lockable ? nil : [:apply.action]
+      end
 
-      js_property :bbar, [:apply.action]
+      action :apply, :text => I18n.t('netzke.basepack.form_panel.apply', :default => "Apply"), :icon => :tick
+      action :edit, :text => I18n.t('netzke.basepack.form_panel.edit', :default => "Edit"), :icon => :pencil
+      action :cancel, :text => I18n.t('netzke.basepack.form_panel.cancel', :default => "Cancel"), :icon => :cancel
 
-      # def initial_config
-      #   res = super
-      #   res[:bbar] = default_bbar if res[:bbar].nil?
-      #   res
-      # end
-      #
-      # def default_bbar
-      #   [:apply.action]
-      # end
+      def configuration
+        sup = super
+
+        sup.merge(
+          :bbar => sup[:bbar] || bbar(sup),
+          :locked => sup[:locked].nil? ? (sup[:mode] == :lockable) : sup[:locked]
+        )
+      end
 
       # Extra javascripts
-      js_include "#{File.dirname(__FILE__)}/form_panel/javascripts/pre.js",
-                  "#{File.dirname(__FILE__)}/form_panel/javascripts/xcheckbox.js"
-          # Netzke::Base.config[:ext_location] + "/examples/ux/fileuploadfield/FileUploadField.js",
-          # "#{File.dirname(__FILE__)}/form_panel/javascripts/netzkefileupload.js"
+      js_mixin :main
+      js_include :comma_list_cbg
+      js_include :n_radio_group, :display_mode
+      # Netzke::Base.config[:ext_location] + "/examples/ux/fileuploadfield/FileUploadField.js",
+      # "#{File.dirname(__FILE__)}/form_panel/javascripts/netzkefileupload.js"
 
       def js_config
         super.merge(
-          # :fields => fields,
           :pri    => data_class && data_class.primary_key
         )
       end
@@ -78,8 +88,6 @@ module Netzke
           res
         end
 
-        action :apply, :text => 'Apply', :icon => :tick
-
         def self.property_fields
           res = [
             # {:name => "ext_config__title",               :attr_type => :string},
@@ -99,4 +107,4 @@ module Netzke
       # include ::Netzke::Plugins::ConfigurationTool if config_tool_available # it will load ConfigurationPanel into a modal window
     end
   end
-end
+end