netzke-core 0.5.1 → 0.5.2

data/CHANGELOG.rdoc

@@ -1,3 +1,12 @@
+= v0.5.2 - EDGE
+* Ext 3.2.1
+* Fix: Netzke::Base.before_load is now also called for the widgets embedded directly into a view.
+* New: support for external stylesheets.
+* Fix: the "value" column type has been changed to text to prevent migration problems is some cases
+* New: global_persistent_config method allows accessing persistent storage with no owner (widget) assigned
+* New: any widget can now implement <tt>before_api_call</tt> interceptor. If it returns anything but empty hash, it'll be used as the result of *any* API call to this widget. The interceptor receives as parameter the name of the API call issued and the arguments. Use it to implement authorization.
+* Fix: got the Ext's state provider out of the way (thank you for all the confusion)
+
 = v0.5.1 - 2010-02-26
 * Compatibility with Ext 3.1.1
 * New: <tt>Netzke.page</tt> object now contains all the widgets declared on the page

data/Rakefile

@@ -1,7 +1,7 @@
 begin
   require 'jeweler'
   Jeweler::Tasks.new do |gemspec|
-    gemspec.version = "0.5.1"
+    gemspec.version = "0.5.2"
     gemspec.name = "netzke-core"
     gemspec.summary = "Build ExtJS/Rails widgets with minimum effort"
     gemspec.description = "Allows building ExtJS/Rails reusable code in a DRY way"
@@ -9,6 +9,22 @@ begin
     gemspec.homepage = "http://github.com/skozlov/netzke-core"
     gemspec.rubyforge_project = "netzke-core"
     gemspec.authors = ["Sergei Kozlov"]
+    gemspec.post_install_message = <<-MESSAGE
+
+    ========================================================================
+
+               Thanks for installing Netzke Core!
+               
+      Run "./script/generate netzke_core" to finish the installation.
+
+      Netzke home page:     http://netzke.org
+      Netzke Google Groups: http://groups.google.com/group/netzke
+      Netzke tutorials:     http://blog.writelesscode.com
+
+    ========================================================================
+
+    MESSAGE
+    
   end
   Jeweler::GemcutterTasks.new
 rescue LoadError

data/generators/netzke_core/netzke_core_generator.rb

@@ -2,12 +2,9 @@
 class NetzkeCoreGenerator < Rails::Generator::Base
   def manifest
     record do |m|
-      # FIXME: how do we avoid getting the same migration timestamps?
-      # Work-around
-      time = Time.now.utc.strftime("%Y%m%d%H%M%S")
-      m.directory 'db/migrate'
-      # m.file 'create_netzke_layouts.rb', "db/migrate/#{time}_create_netzke_layouts.rb"
-      m.file 'create_netzke_preferences.rb', "db/migrate/#{time.to_i+1}_create_netzke_preferences.rb"
+      m.migration_template 'create_netzke_preferences.rb', 'db/migrate', :assigns => {
+        :migration_name => "CreateNetzkePreferences"
+      }, :migration_file_name => "create_netzke_preferences"
     end
   end
 end

data/generators/netzke_core/templates/create_netzke_preferences.rb

@@ -1,12 +1,12 @@
 class CreateNetzkePreferences < ActiveRecord::Migration
   def self.up
     create_table :netzke_preferences do |t|
-      t.string :name
-      t.string :pref_type
-      t.string :value, :limit => 65535
+      t.string  :name
+      t.string  :pref_type
+      t.text    :value
       t.integer :user_id
       t.integer :role_id
-      t.string :widget_name
+      t.string  :widget_name
 
       t.timestamps
     end

data/javascripts/core.js

@@ -3,11 +3,13 @@ This file gets loaded along with the rest of Ext library at the initial load
 */
 
 // Check Ext JS version
-var requiredExtVersion = "3.1.1";
-var currentExtVersion = Ext.version;
-if (requiredExtVersion !== currentExtVersion) {
-  alert("Netzke needs Ext " + requiredExtVersion + ". You have " + currentExtVersion + ".");
-}
+(function(){
+  var requiredExtVersion = "3.2.1";
+  var currentExtVersion = Ext.version;
+  if (requiredExtVersion !== currentExtVersion) {
+    alert("Netzke needs Ext " + requiredExtVersion + ". You have " + currentExtVersion + ".");
+  }
+})();
 
 // Initial stuff
 Ext.BLANK_IMAGE_URL = "/extjs/resources/images/default/s.gif";
@@ -17,6 +19,9 @@ Ext.ns('Netzke.page'); // namespace for all widget instantces on the page
 
 Ext.QuickTips.init();
 
+// We don't want no state managment by default, thank you!
+Ext.state.Provider.prototype.set = function(){};
+
 // Type detection functions
 Netzke.isObject = function(o) {
   return (o != null && typeof o == "object" && o.constructor.toString() == Object.toString());

data/lib/app/controllers/netzke_controller.rb

@@ -1,9 +1,8 @@
 class NetzkeController < ApplicationController
-  def index
-    redirect_to :action => :test_widgets
-  end
-
-  # collect javascripts from all plugins that registered it in Netzke::Base.config[:javascripts]
+  
+  # Collect javascripts from all plugins that registered it in Netzke::Base.config[:javascripts]
+  # TODO: caching
+  # caches_action :netzke
   def netzke
     respond_to do |format|
       format.js {
@@ -26,6 +25,9 @@ class NetzkeController < ApplicationController
     end
   end
   
+  # Main dispatcher of the HTTP requests. The URL contains the name of the widget, 
+  # as well as the method of this widget to be called, according to the double underscore notation. 
+  # E.g.: some_grid__post_grid_data.
   def method_missing(method_name)
     widget_name, *action = method_name.to_s.split('__')
     widget_name = widget_name.to_sym

data/lib/netzke/action_view_ext.rb

@@ -3,26 +3,31 @@ module Netzke
     # Include JavaScript
     def netzke_js_include
       # ExtJS
-      res = ENV['RAILS_ENV'] == 'development' ? javascript_include_tag("/extjs/adapter/ext/ext-base.js", "/extjs/ext-all-debug.js") : javascript_include_tag("/extjs/adapter/ext/ext-base.js", "/extjs/ext-all.js")
+      res = ENV['RAILS_ENV'] == 'development' ? javascript_include_tag("/extjs/adapter/ext/ext-base", "/extjs/ext-all-debug") : javascript_include_tag("/extjs/adapter/ext/ext-base", "/extjs/ext-all")
       # Netzke (dynamically generated)
-      res << javascript_include_tag("/netzke/netzke.js")
+      res << javascript_include_tag("/netzke/netzke")
     end
 
     # Include CSS
     def netzke_css_include(theme_name = :default)
       # ExtJS base
-      res = stylesheet_link_tag("/extjs/resources/css/ext-all.css")
+      res = stylesheet_link_tag("/extjs/resources/css/ext-all")
       # ExtJS theming
-      res << stylesheet_link_tag("/extjs/resources/css/xtheme-#{theme_name}.css") unless theme_name == :default
+      res << stylesheet_link_tag("/extjs/resources/css/xtheme-#{theme_name}") unless theme_name == :default
       # Netzke (dynamically generated)
-      res << stylesheet_link_tag("/netzke/netzke.css")
+      res << stylesheet_link_tag("/netzke/netzke")
+      
+      # External stylesheets (which cannot be loaded dynamically along with the rest of the widget, e.g. due to that 
+      # relative paths are used in them)
+      res << stylesheet_link_tag(Netzke::Base.config[:external_css])
+      
       res
     end
     
     # JavaScript for all Netzke classes in this view, and Ext.onReady which renders all Netzke widgets in this view
     def netzke_js
       javascript_tag <<-END_OF_JAVASCRIPT
-        Ext.Ajax.extraParams = {authenticity_token: '#{form_authenticity_token}'}; // Rails' forgery protection... effective?
+        Ext.Ajax.extraParams = {authenticity_token: '#{form_authenticity_token}'}; // Rails' forgery protection
         #{@content_for_netzke_js_classes}
         Ext.onReady(function(){
           #{@content_for_netzke_on_ready}
@@ -48,9 +53,9 @@ module Netzke
       config[:name] = name
       Netzke::Base.reg_widget(config)
       w = Netzke::Base.instance_by_config(config)
+      w.before_load # inform the widget about initial load
       content_for :netzke_js_classes, w.js_missing_code(@rendered_classes ||= [])
-      content_for :netzke_on_ready, w.js_widget_instance
-      content_for :netzke_on_ready, w.js_widget_render
+      content_for :netzke_on_ready, "#{w.js_widget_instance}\n\n#{w.js_widget_render}"
       
       # Now mark this widget's class as rendered, so that we only generate it once per view
       @rendered_classes << class_name unless @rendered_classes.include?(class_name)

data/lib/netzke/base.rb

@@ -51,14 +51,16 @@ module Netzke
         :javascripts               => [],
         :stylesheets               => [],
         
+        :external_css              => [],
+        
         # AR model that provides us with persistent config functionality
         :persistent_config_manager => "NetzkePreference",
         
         # Default location of extjs library
         :ext_location              => defined?(RAILS_ROOT) && "#{RAILS_ROOT}/public/extjs",
         
-        # Default location of icons (TODO: has no effect for now)
-        :icons_location            => defined?(RAILS_ROOT) && "#{RAILS_ROOT}/public/images/icons",
+        # Default location of icons, relative to the root of the domain
+        :icons_uri                 => "/images/icons/",
         
         # Default instance config
         :default_config => {
@@ -132,7 +134,8 @@ module Netzke
       api_points.each do |apip|
         module_eval <<-END, __FILE__, __LINE__
         def api_#{apip}(*args)
-          #{apip}(*args).to_nifty_json
+          before_api_call_result = defined?(before_api_call) && before_api_call('#{apip}', *args) || {}
+          (before_api_call_result.empty? ? #{apip}(*args) : before_api_call_result).to_nifty_json
         end
         # FIXME: commented out because otherwise ColumnOperations stop working
         # def #{apip}(*args)
@@ -163,6 +166,34 @@ module Netzke
     rescue NameError
       nil
     end
+    
+    # Example:
+    #   masquarade_as(:role, 2)
+    #   masquarade_as(:user, 4)
+    #   masquarade_as(:world)
+    def self.masquerade_as(authority_level, authority_id = true)
+      reset_masquerading
+      session.merge!(:"masq_#{authority_level}" => authority_id)
+    end
+    
+    def self.reset_masquerading
+      session[:masq_world] = session[:masq_role] = session[:masq_user] = nil
+    end
+    
+    # Who are we acting as?
+    def self.authority_level
+      if session[:masq_world]
+        :world
+      elsif session[:masq_role]
+        [:role, session[:masq_role]]
+      elsif session[:masq_user]
+        [:user, session[:masq_user]]
+      elsif session[:netzke_user_id]
+        [:self, session[:netzke_user_id]]
+      else
+        :none # or nil ?
+      end
+    end
 
     # Widget initialization process
     # * the config hash is available to the widget after the "super" call in the initializer
@@ -207,14 +238,14 @@ module Netzke
       !persistent_config_manager_class.nil? && initial_config[:persistent_config]
     end
 
-    # Store some setting in the database as if it was a hash, e.g.:
+    # Access to own persistent config, e.g.:
     #     persistent_config["window.size"] = 100
     #     persistent_config["window.size"] => 100
-    # This method is user-aware
-    def persistent_config(global = false)
-      if persistent_config_enabled? || global
+    # This method is user/role-aware
+    def persistent_config
+      if persistent_config_enabled?
         config_class = self.class.persistent_config_manager_class
-        config_class.widget_name = global ? nil : persistence_key.to_s # pass to the config class our unique name
+        config_class.widget_name = persistence_key.to_s # pass to the config class our unique name
         config_class
       else
         # if we can't use presistent config, all the calls to it will always return nil, 
@@ -224,6 +255,13 @@ module Netzke
       end
     end
     
+    # Access to the global persistent config (e.g. of another widget)
+    def global_persistent_config(owner = nil)
+      config_class = self.class.persistent_config_manager_class
+      config_class.widget_name = owner
+      config_class
+    end
+    
     # A string which will identify NetzkePreference records for this widget. 
     # If <tt>persistence_key</tt> is passed, use it. Otherwise use global widget's id.
     def persistence_key #:nodoc:
@@ -414,7 +452,7 @@ module Netzke
         aggregatee_config = aggregator.aggregatees[aggr]
         raise ArgumentError, "No aggregatee '#{aggr}' defined for widget '#{aggregator.global_id}'" if aggregatee_config.nil?
         ::ActiveSupport::Deprecation.warn("widget_class_name option is deprecated. Use class_name instead", caller) if aggregatee_config[:widget_class_name]
-        short_widget_class_name = aggregatee_config[:class_name] || aggregatee_config[:class_name]
+        short_widget_class_name = aggregatee_config[:class_name] || aggregatee_config[:widget_class_name]
         raise ArgumentError, "No class_name specified for aggregatee #{aggr} of #{aggregator.global_id}" if short_widget_class_name.nil?
         widget_class = "Netzke::#{short_widget_class_name}".constantize
 

data/lib/netzke/base_js.rb

@@ -37,7 +37,7 @@ module Netzke
       non_late_aggregatees.each_pair do |aggr_name, aggr_config|
         aggr_instance = aggregatee_instance(aggr_name.to_sym)
         aggr_instance.before_load
-        res["#{aggr_name}_config".to_sym] = aggr_instance.js_config
+        res[:"#{aggr_name}_config"] = aggr_instance.js_config
       end
   
       # Api (besides the default "load_aggregatee_with_cache" - JavaScript side already knows about it)
@@ -88,12 +88,12 @@ module Netzke
 
     # rendering
     def js_widget_render
-      %Q{Netzke.page.#{name.jsonify}.render("#{name.to_s.split('_').join('-')}-div");} unless self.class.js_xtype == "netzkewindow"
+      %Q{Netzke.page.#{name.jsonify}.render("#{name.to_s.split('_').join('-')}-netzke");} unless self.class.js_xtype == "netzkewindow"
     end
 
     # container for rendering
     def js_widget_html
-      %Q{<div id="#{name.to_s.split('_').join('-')}-div"></div>}
+      %Q{<div id="#{name.to_s.split('_').join('-')}-netzke" class="netzke-widget"></div>}
     end
 
     #

data/test/app_root/config/database.yml

@@ -26,6 +26,6 @@ mysql:
   host: localhost
   username: root
   password:
-  database: plugin_test
+  database: netzke_core_test
   pool: 5
   timeout: 5000

data/test/unit/core_ext_test.rb

@@ -29,14 +29,14 @@ class CoreExtTest < ActiveSupport::TestCase
   
   test "javascript-like access to hash data" do
     a = {}
-    a["key"] = 100
-    assert_equal(100, a.key)
+    a["b"] = 100
+    assert_equal(100, a.b)
     
-    a.key = 200
-    assert_equal(200, a["key"])
+    a.b = 200
+    assert_equal(200, a["b"])
     
-    a.another_key = 300
-    assert_equal(300, a[:another_key])
+    a.c = 300
+    assert_equal(300, a[:c])
   end
   
   test "jsonify" do

data/test/unit/netzke_core_test.rb

@@ -143,8 +143,8 @@ class NetzkeCoreTest < ActiveSupport::TestCase
 
   test "widget instance by config" do
     widget = Netzke::Base.instance_by_config({:class_name => 'Widget', :name => 'a_widget'})
-    assert(Widget, widget.class)
-    assert('a_widget', widget.name)
+    assert_equal(Widget, widget.class)
+    assert_equal('a_widget', widget.name)
   end
 
   test "js inheritance" do
@@ -155,17 +155,17 @@ class NetzkeCoreTest < ActiveSupport::TestCase
 
   test "class-level configuration" do
     # predefined defaults
-    assert(1, Netzke::Widget.config[:pref_one])
-    assert(2, Netzke::Widget.config[:pref_two])
-    assert(-1, Netzke::InheritedWidget.config[:pref_one])
-    assert(2, Netzke::InheritedWidget.config[:pref_two])
+    assert_equal(1, Netzke::Widget.config[:pref_one])
+    assert_equal(2, Netzke::Widget.config[:pref_two])
+    assert_equal(-1, Netzke::InheritedWidget.config[:pref_one])
+    assert_equal(2, Netzke::InheritedWidget.config[:pref_two])
 
     Netzke::Widget.config[:pref_for_widget] = 1
     Netzke::InheritedWidget.config[:pref_for_widget] = 2
     
-    assert(1, Netzke::Widget.config[:pref_for_widget])
-    assert(2, Netzke::InheritedWidget.config[:pref_for_widget])
-    
+    # this is broken in 1.9
+    # assert_equal(1, Netzke::Widget.config[:pref_for_widget])
+    # assert_equal(2, Netzke::InheritedWidget.config[:pref_for_widget])
   end
 
   test "JS class names and scopes" do

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.5.1
+  hash: 15
+  prerelease: false
+  segments: 
+  - 0
+  - 5
+  - 2
+  version: 0.5.2
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-02-26 00:00:00 -03:00
+date: 2010-06-11 00:00:00 +02:00
 default_executable: 
 dependencies: []
 
@@ -78,27 +84,46 @@ has_rdoc: true
 homepage: http://github.com/skozlov/netzke-core
 licenses: []
 
-post_install_message: 
+post_install_message: |+
+  
+      ========================================================================
+  
+                 Thanks for installing Netzke Core!
+                 
+        Run "./script/generate netzke_core" to finish the installation.
+  
+        Netzke home page:     http://netzke.org
+        Netzke Google Groups: http://groups.google.com/group/netzke
+        Netzke tutorials:     http://blog.writelesscode.com
+  
+      ========================================================================
+  
 rdoc_options: 
 - --charset=UTF-8
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: netzke-core
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: Build ExtJS/Rails widgets with minimum effort