netzke-communitypack 0.1.3 → 0.7.0

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 YOURNAME
+
+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

@@ -1,6 +1,3 @@
-= Netzke components submitted by the community
+= Netzke Communitypack
 
-Includes the following components:
-
-* LiveSearchGridPanel - GridPanel extension with a configurable live-search textfield
-* GoogleMapPanel - Panel showing a Google map
+A bunch of community-written Netzke components.

data/Rakefile

@@ -1,2 +1,37 @@
-require 'bundler'
+#!/usr/bin/env rake
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+begin
+  require 'rdoc/task'
+rescue LoadError
+  require 'rdoc/rdoc'
+  require 'rake/rdoctask'
+  RDoc::Task = Rake::RDocTask
+end
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'NetzkeCommunitypack'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.rdoc')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
 Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'lib'
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task :default => :test

data/lib/netzke-communitypack.rb

@@ -1,5 +1,10 @@
-module Netzke
-  module Communitypack
-    # Your code goes here...
-  end
+# External dependencies
+require 'netzke-core'
+require 'active_support/dependencies'
+
+# Make components auto-loadable
+ActiveSupport::Dependencies.autoload_paths << File.dirname(__FILE__)
+
+module NetzkeCommunitypack
+  
 end

data/lib/netzke-communitypack/version.rb

@@ -1,10 +1,3 @@
-module Netzke
-  module Communitypack
-    MAJOR = 0
-    MINOR = 1
-    PATCH = 3
-
-    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
-	VERSION = STRING
-  end
+module NetzkeCommunitypack
+  VERSION = "0.7.0" # Keep the major and minor versions synced with those of Netzke Core gem.
 end

data/lib/netzke/communitypack/google_map_panel.rb

@@ -1,30 +1,30 @@
 # Creates a google map panel. The panel additionaly has the options of google maps, i.e.:
 # * +zoom_level+ - The initial zoom level
-# * +gmap_type+ - 
-# * +map_conf_opts+ - 
+# * +gmap_type+ -
+# * +map_conf_opts+ -
 # * +map_controlls+ -
 # * +set_center+ - The initial map position
 # * +markers+ - Initial markers on the page
 # ...
 class Netzke::Communitypack::GoogleMapPanel < ::Netzke::Base
-	js_include "#{File.dirname(__FILE__)}/google_map_panel/javascript/GMapPanel.js"
-	
-	# default configuration
-	config do
-			{
-				:zoom_level => 14,
-				:gmap_type => 'map',
-				:layout => :fit,
-				:map_conf_opts => ['enableScrollWheelZoom','enableDoubleClickZoom','enableDragging'],
-				:map_controls => ['GSmallMapControl','GMapTypeControl','NonExistantControl'],
-				:set_center => {
-					:geo_code_addr => 'Flottwellstr. 4-5, 10785 Berlin, Germany',
-					:marker => {
-						:title => 'pme Familienservice GmbH'
-					}
-				}
-			}
-		end
-	
-	js_base_class 'Ext.ux.GMapPanel'
+  js_base_class 'Ext.ux.GMapPanel'
+
+  js_include "#{File.dirname(__FILE__)}/google_map_panel/javascript/GMapPanel.js"
+
+  # default configuration
+  def configuration
+    super.merge({
+      :zoom_level => 14,
+      :gmap_type => 'map',
+      :layout => :fit,
+      :map_conf_opts => ['enableScrollWheelZoom','enableDoubleClickZoom','enableDragging'],
+      :map_controls => ['GSmallMapControl','GMapTypeControl','NonExistantControl'],
+      :set_center => {
+        :geo_code_addr => 'Flottwellstr. 4-5, 10785 Berlin, Germany',
+        :marker => {
+          :title => 'pme Familienservice GmbH'
+        }
+      }
+    })
+  end
 end

data/lib/netzke/communitypack/google_map_panel/javascript/GMapPanel.js

@@ -72,6 +72,7 @@ Ext.ux.GMapPanel = Ext.extend(Ext.Panel, {
         this.addMarkers(this.markers);
         this.addMapControls();
         this.addOptions();  
+        this.gmap.checkResize();
     },
     onResize : function(w, h){
 
@@ -212,4 +213,4 @@ Ext.ux.GMapPanel = Ext.extend(Ext.Panel, {
  
 });
 
-Ext.reg('gmappanel', Ext.ux.GMapPanel);
+Ext.reg('gmappanel', Ext.ux.GMapPanel);

data/lib/netzke/communitypack/live_search_grid_panel.rb

@@ -7,40 +7,43 @@
 # * +live_search_scope+ - The scope name for filtering the results by the live search (default: :live_search)
 #
 class Netzke::Communitypack::LiveSearchGridPanel < ::Netzke::Basepack::GridPanel
-	config :tbar => ['->', {
-		:xtype => 'textfield',
-		:id => 'live_search_field',
-		:enable_key_events => true,
-		:ref => '../live_search_field',
-		:empty_text => 'Search'
-	}]
-	
-	js_method :init_component, <<-JS
-		function() {
-			#{js_full_class_name}.superclass.initComponent.call(this);
-			
-			this.liveSearchBuffer = '';
-			this.live_search_field.on('keydown', function() { this.onLiveSearch(); }, this, { buffer: 500 });
-			this.live_search_field.on('blur', function() { this.onLiveSearch(); }, this, { buffer: 500 });
-		}
-	JS
-	
-	js_method :on_live_search, <<-JS
-		function() {
-			var search_text = this.getTopToolbar().get('live_search_field').getValue();
-			if (search_text == this.liveSearchBuffer) return;
-			this.liveSearchBuffer = search_text;
-			this.getStore().setBaseParam('live_search', search_text);
-			this.getStore().load();
-		}
-	JS
-	
-	def get_data(*args)
-		params = args.first
-		search_scope = config[:live_search_scope] || :live_search
-		data_class.send(search_scope, params && params[:live_search] || '').scoping do
-			super
-		end
-	end
-	
+  def configuration
+    super.merge({
+      :tbar => ['->', {
+        :xtype => 'textfield',
+        :enable_key_events => true,
+        :ref => '../live_search_field',
+        :empty_text => 'Search'
+      }]
+    })
+  end
+
+  js_method :init_component, <<-JS
+    function() {
+      #{js_full_class_name}.superclass.initComponent.call(this);
+
+      this.liveSearchBuffer = '';
+      this.live_search_field.on('keydown', function() { this.onLiveSearch(); }, this, { buffer: 500 });
+      this.live_search_field.on('blur', function() { this.onLiveSearch(); }, this, { buffer: 500 });
+    }
+  JS
+
+  js_method :on_live_search, <<-JS
+    function() {
+      var search_text = this.live_search_field.getValue();
+      if (search_text == this.liveSearchBuffer) return;
+      this.liveSearchBuffer = search_text;
+      this.getStore().setBaseParam('live_search', search_text);
+      this.getStore().load();
+    }
+  JS
+
+  def get_data(*args)
+    params = args.first
+    search_scope = config[:live_search_scope] || :live_search
+    data_class.send(search_scope, params && params[:live_search] || '').scoping do
+      super
+    end
+  end
+
 end

data/lib/netzke/communitypack/model_explorer.rb

@@ -0,0 +1,68 @@
+module Netzke
+  module Communitypack
+    # 2 regions - "grid" and "form", form displaying the details of the record selected in the grid.
+    #
+    # Accepts the following config options:
+    # * :model - name of the model, e.g. "User"
+    # * :grid_config (optional) - a config hash passed to the grid
+    # * :form_config (optional) - a config hash passed to the form
+    class ModelExplorer < Netzke::Basepack::BorderLayoutPanel
+
+      delegates_to_dsl :model, :grid_config, :form_config
+
+      js_properties(
+        :prevent_header => true,
+        :border => true
+      )
+
+      def configuration
+        super.tap do |c|
+
+          # merge default container and collection config with the one provided by the user
+          c[:grid_config] = {
+            :region => :west,
+            :class_name => "Netzke::Basepack::GridPanel",
+            :model => c[:model],
+            :item_id => 'grid'
+          }.merge(c[:grid_config] || {})
+
+          c[:form_config] = {
+            :class_name => "Netzke::Basepack::FormPanel",
+            :model => c[:model],
+            :region => :center,
+            :item_id => 'form'
+          }.merge(c[:form_config] || {})
+
+          # set default width/height for regions
+          c[:grid_config][:width] ||= 300 if [:west, :east].include?(c[:grid_config][:region].to_sym)
+          c[:grid_config][:height] ||= 150 if [:north, :south].include?(c[:grid_config][:region].to_sym)
+
+          c[:items] = [c[:grid_config], c[:form_config]]
+        end
+      end
+
+      endpoint :select_record do |params|
+        # store selected container record id in the session for this component's instance
+        component_session[:selected_record_id] = params[:id]
+
+        # {:form => {:set_title => "Blah"}}
+      end
+
+      js_method :init_component, <<-JS
+        function(){
+          // calling superclass's initComponent
+          this.callParent();
+
+          this.grid = this.getComponent('grid');
+          this.form = this.getComponent('form');
+
+          // setting the 'rowclick' event
+          this.grid.getView().on('itemclick', function(view, record){
+            this.selectRecord({id: record.getId()});
+            this.form.netzkeLoad({id: record.getId()});
+          }, this);
+        }
+      JS
+    end
+  end
+end

data/lib/netzke/communitypack/one_to_many_explorer.rb

@@ -0,0 +1,78 @@
+module Netzke
+  module Communitypack
+    # 2 grids - "container" and "collection" - bound with a one-to-many relationship.
+    # The collection model should implement belongs_to in respect to the container model.
+    #
+    # Accepts the following config options:
+    # * :container_model - name of the container model, e.g. "User"
+    # * :collection_model - name of the collection model, e.g. "Issue" (belongs_to :user)
+    # * :container_config (optional) - a config hash passed to the container grid
+    # * :collection_config (optional) - a config hash passod to the collection grid
+    # * :association (optional) - the name of the association used in belongs_to macro. Defaults to the underscored name of the container model.
+    class OneToManyExplorer < Netzke::Basepack::BorderLayoutPanel
+      js_mixin
+
+      delegates_to_dsl :container_model, :collection_model, :container_config, :collection_config, :association
+
+      js_properties(
+        :prevent_header => true,
+        :border => true
+      )
+
+      def configuration
+        super.tap do |c|
+
+          # merge default container and collection config with the one provided by the user
+          c[:container_config] = {
+            :region => :west,
+            :class_name => "Netzke::Basepack::GridPanel"
+          }.merge(c[:container_config] || {})
+
+          c[:collection_config] = {
+            :class_name => "Netzke::Basepack::GridPanel"
+          }.merge(c[:collection_config] || {})
+
+          # set default width/height for regions
+          c[:container_config][:width] ||= 300 if [:west, :east].include?(c[:container_config][:region].to_sym)
+          c[:container_config][:height] ||= 200 if [:north, :south].include?(c[:container_config][:region].to_sym)
+
+          # figure out collection_class from config or from the passed component
+          container_class = c[:container_config][:model].try(:constantize) || c[:container_config][:class_name].constantize.new.data_class
+          collection_class = c[:collection_config][:model].try(:constantize) || c[:collection_config][:class_name].constantize.new.data_class
+
+          # use the shortcuts for models
+          c[:container_config][:model] ||= c[:container_model] || container_class.name
+          c[:collection_config][:model] ||= c[:collection_model] || collection_class.name
+
+          # we need to get the association reflection in order to properly set the collection grid scope
+          c[:association] ||= c[:container_config][:model].underscore.to_sym # the belongs_to association, e.g. "user"
+
+          association = collection_class.reflect_on_association(c[:association])
+
+          # if we have extra scopes received in the config, take them into account!
+          passed_scope = c[:collection_config][:scope] || {}
+          passed_strong_default_attrs = c[:collection_config][:strong_default_attrs] || {}
+
+          c[:items] = [
+            c[:container_config].merge(:item_id => 'container'),
+
+
+            c[:collection_config].merge(
+              :region => :center,
+              :item_id => 'collection',
+              :scope => {association.foreign_key.to_sym => component_session[:selected_container_record_id]}.merge(passed_scope),
+              :strong_default_attrs => {association.foreign_key.to_sym => component_session[:selected_container_record_id]}.merge(passed_strong_default_attrs),
+              :load_inline_data => false
+            )
+          ]
+        end
+      end
+
+      endpoint :select_container_record do |params|
+        # store selected container record id in the session for this component's instance
+        component_session[:selected_container_record_id] = params[:id]
+      end
+
+    end
+  end
+end

data/lib/netzke/communitypack/one_to_many_explorer/javascripts/one_to_many_explorer.js

@@ -0,0 +1,14 @@
+{
+  initComponent: function() {
+    // calling superclass's initComponent
+    this.callParent();
+
+    // setting the 'rowclick' event
+    var view = this.getComponent('container').getView();
+    view.on('itemclick', function(view, record){
+      // The beauty of using Ext.Direct: calling 3 endpoints in a row, which results in a single call to the server!
+      this.selectContainerRecord({id: record.get('id')});
+      this.getComponent('collection').getStore().load();
+    }, this);
+  }
+}

data/lib/netzke/communitypack/workspace.rb

@@ -0,0 +1,94 @@
+module Netzke
+  module Communitypack
+    # A component that allows for dynamical loading/unloading of other Netzke components in tabs.
+    # It can be manipulated by calling the <js>loadChild</js> method, e.g.:
+    #
+    #   workspace.loadChild("UserGrid", {newTab: true})
+    #
+    # - will load a UserGrid component from the server in a new tab.
+    class Workspace < Netzke::Base
+      js_base_class "Ext.tab.Panel"
+      js_property :prevent_header, true
+
+      js_mixin
+
+      action :remove_all
+
+      def default_config
+        super.tap do |c|
+          c[:items] = ([dashboard_config] + stored_tabs).each_with_index.map do |tab,i|
+            {
+              :layout => 'fit',
+              :title => tab[:title],
+              :closable => i > 0, # all closable except first
+              :netzke_component_id => tab[:name],
+              :items => !components[tab[:name].to_sym][:lazy_loading] && [tab[:name].to_sym.component]
+            }
+          end
+        end
+      end
+
+      def dashboard_config
+        {
+          :title => "Dashboard",
+          :class_name => "Netzke::Basepack::Panel"
+        }.merge!(@passed_config[:dashboard_config] || {}).merge(:name => 'cmp0', :lazy_loading => false)
+      end
+
+      # Overriding this to allow for dynamically declared components
+      def components
+        stored_tabs.inject({}){ |r,tab| r.merge(tab[:name].to_sym => tab.reverse_merge(:prevent_header => true, :lazy_loading => true, :border => false)) }.merge(:cmp0 => dashboard_config)
+      end
+
+      # Overriding the deliver_component endpoint, to dynamically add tabs and replace components in existing tabs
+      def deliver_component_endpoint(params)
+        cmp_name = params[:name]
+        cmp_index = cmp_name.sub("cmp", "").to_i
+
+        if params[:component].present?
+          current_tabs = stored_tabs
+
+          # we need to instantiate the newly added child to get access to its title
+          cmp_class = constantize_class_name(params[:component])
+          raise RuntimeError, "Could not find class #{params[:component]}" if cmp_class.nil?
+
+          cmp_config = {:name => params[:name], :class_name => cmp_class.name}.merge(params[:config] || {}).symbolize_keys
+          cmp_instance = cmp_class.new(cmp_config, self)
+          new_tab_short_config = cmp_config.merge(:title => cmp_instance.js_config[:title] || cmp_instance.class.js_properties[:title]) # here we set the title
+
+          if stored_tabs.empty? || cmp_index > stored_tabs.last[:name].sub("cmp", "").to_i
+            # add new tab to persistent storage
+            current_tabs << new_tab_short_config
+          else
+            # replace existing tab in the storage
+            current_tabs[current_tabs.index(current_tabs.detect{ |tab| tab[:name] == cmp_name })] = new_tab_short_config
+          end
+
+          component_session[:items] = current_tabs
+          @stored_tabs = nil # reset cache
+        end
+
+        super(params)
+      end
+
+      # Clean the session on request. More clean-up may be needed later, as we start using persistent configuration.
+      endpoint :server_remove_all do |params|
+        component_session[:items] = []
+      end
+
+      # Removes a closed tab's component from the storage.
+      endpoint :server_remove_tab do |params|
+        component_session[:items].delete_if{ |item| item[:name] == params[:name] }
+        {}
+      end
+
+      private
+
+        # We store these in component_session atm. May as well be in persistent storage, depending on the requirements
+        def stored_tabs
+          @stored_tabs ||= component_session[:items] || []
+        end
+
+    end
+  end
+end