netzke-core 0.2.7 → 0.2.8

data/CHANGELOG

@@ -1,3 +1,6 @@
+v0.2.8
+Support for extra javascripts and stylesheets per widget.
+
 v0.2.7
 QuickTips get initialized now, as otherwise Ext 2.2.1 doesn't properly destroy() BoxComponents for me.
 

data/LICENSE

@@ -1,20 +1,3 @@
-Copyright (c) 2008 Sergei Kozlov
+Copyright (c) 2008-2009 Sergei Kozlov
 
-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.
+GNU GPL license v3

data/README.mdown

@@ -10,4 +10,4 @@ The tutorials: http://blog.writelesscode.com
 
 Also see the netzke-basepack project: http://github.com/skozlov/netzke-basepack/tree/master
 
-Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license
+Copyright (c) 2008-2009 Sergei Kozlov, released under GNU GPL license v3

data/javascripts/core.js

@@ -55,14 +55,20 @@ Ext.widgetMixIn = {
 
   widgetInit : function(config){
     this.app = Ext.getCmp('feedback_ghost');
+
     if (config.tools) Ext.each(config.tools, function(i){
       i.on.click = this[i.on.click].createDelegate(this);
     }, this);
+
     if (config.actions) Ext.each(config.actions, function(i){
       this.addEvents(i.handlerName + 'click');
       i.handler = this.actionHandler.createDelegate(this);
     }, this);
 
+    if (config.menu) Ext.each(config.menu, function(i){
+      this.addMenuItem(i)
+    }, this);
+
     // set events
     this.on('beforedestroy', function(){
       // clean-up menus
@@ -92,6 +98,16 @@ Ext.widgetMixIn = {
     };
   },
 
+  addMenuItem : function(item){
+    if (this.hostMenuItem) { 
+      this.hostMenuItem(item, this); 
+    } else {
+      if (this.ownerCt && this.ownerCt.ownerCt) {
+        this.ownerCt.ownerCt.addMenuItem(item)
+      }
+    }
+  },
+
   addMenus:function(menus){
     if (this.app && !!this.app.hostMenu) {
       Ext.each(menus, function(menu){this.app.hostMenu(menu, this)}, this)
@@ -130,10 +146,18 @@ Ext.override(Ext.Panel, {
           var responseObj = Ext.decode(response.responseText);
           if (responseObj.config) {
             // we got a normal response
+
+            // evaluate widget's stylesheets
+            if (responseObj.css){
+              var linkTag = document.createElement('style')
+              linkTag.type = 'text/css';
+              linkTag.innerHTML = responseObj.css;
+              document.body.appendChild(linkTag);
+            }
             
-            // evaluate widget's class if it was sent
-            if (responseObj.classDefinition) {
-              eval(responseObj.classDefinition);
+            // evaluate widget's javascript
+            if (responseObj.js) {
+              eval(responseObj.js);
             }
           
             responseObj.config.parent = this // we might want to know the parent panel in advance (e.g. to know its size)

data/lib/app/controllers/netzke_controller.rb

@@ -22,4 +22,16 @@ class NetzkeController < ActionController::Base
       }
     end
   end
+  
+  def method_missing(action)
+    respond_to do |format|
+      format.js {
+        render :text => "#{action}.js"
+      }
+      format.css {
+        render :text => "#{action}.css"
+      }
+    end
+  end
+  
 end

data/lib/netzke/base.rb

@@ -10,6 +10,18 @@ module Netzke
   class Base
     module ClassMethods
 
+      # Used to get access to the location of the source file of a Widget, e.g. to automatically include
+      # <widget_name>_extras/*.rb files
+      def widget_file=(file)
+        write_inheritable_attribute(:widget_file, file)
+      end
+      
+      def widget_file
+        read_inheritable_attribute(:widget_file) || __FILE__
+      end
+      #
+      #
+
       # Global Netzke::Base configuration
       def config
         set_default_config({
@@ -66,12 +78,39 @@ module Netzke
         read_inheritable_attribute(:interface_points)
       end
       
+      #
+      # Include extra code from Ext js library (e.g. examples)
+      #
+      def ext_js_include(*args)
+        included_ext_js = read_inheritable_attribute(:included_ext_js) || []
+        args.each {|f| included_ext_js << f}
+        write_inheritable_attribute(:included_ext_js, included_ext_js)
+      end
+      
+      # def js_include(*args)
+      #   included_js = read_inheritable_attribute(:included_js) || []
+      #   args.each {|f| included_js << f}
+      #   write_inheritable_attribute(:included_js, included_js)
+      # end
+      
+      # include eventual extra modules
+      def include_extras
+        extras_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras")
+        file_list = Dir.glob("#{extras_dir}/*.rb")
+        for file_name in file_list
+          require file_name
+          module_name = "#{self.name}Extras::#{File.basename(file_name, ".rb").classify}"
+          include module_name.constantize
+        end
+      end
+
       # returns an instance of a widget defined in the config
       def instance_by_config(config)
         widget_class = "Netzke::#{config[:widget_class_name]}".constantize
         widget_class.new(config)
       end
       
+      # persistent_config and layout manager classes
       def persistent_config_manager_class
         Netzke::Base.config[:persistent_config_manager].constantize
       rescue NameError
@@ -84,16 +123,6 @@ module Netzke
         nil
       end
       
-      # include eventual extra modules
-      def include_extras(file = __FILE__)
-        extras_dir = File.join(File.dirname(file), short_widget_class_name.underscore + "_extras")
-        file_list = Dir.glob("#{extras_dir}/*.rb")
-        for file_name in file_list
-          require file_name
-          module_name = "#{self.name}Extras::#{File.basename(file_name, ".rb").classify}"
-          include module_name.constantize
-        end
-      end
       
       private
       def set_default_config(default_config)

data/lib/netzke/base_extras/interface.rb

@@ -2,9 +2,18 @@ module Netzke
   module BaseExtras
     module Interface
       def get_widget(params = {})
-        # if browser does not have our component class cached (and all dependencies), send it to him
         components_cache = (JSON.parse(params[:components_cache]) if params[:components_cache]) || []
-        {:config => js_config, :class_definition => js_missing_code(components_cache)}
+
+        js = js_missing_code(components_cache)
+        css = css_missing_code(components_cache)
+
+        css = nil if css.blank?
+
+        # if browser does not have our widget's (and all its dependencies') class and styles, send it over
+        { :config => js_config, 
+          :js => js,
+          :css => css
+        }
       end
     end
   end

data/lib/netzke/base_extras/js_builder.rb

@@ -56,13 +56,11 @@ module Netzke
           cached_dependencies.include?(k) ? r : r + "Netzke::#{k}".constantize.js_code(cached_dependencies).strip_js_comments
         end
       end
-    
-      def dependency_classes
-        res = []
-        non_late_aggregatees.each_key do |aggr|
-          res << aggregatee_instance(aggr).short_widget_class_name
+      
+      def css_missing_code(cached_dependencies = [])
+        dependency_classes.inject("") do |r,k| 
+          cached_dependencies.include?(k) ? r : r + "Netzke::#{k}".constantize.css_code(cached_dependencies)
         end
-        res.uniq
       end
     
       #
@@ -176,18 +174,72 @@ JS
           end
         end
         
-        # all the JS code needed for this class
-        def js_code(cached_dependencies)
+        # returns all extra js-code (as string) required by this widget's class
+        def js_included
+          # from extjs - defined in the widget class with ext_js_include
+          extjs_dir = "#{RAILS_ROOT}/public/extjs" # TODO: make extjs location configurable
+          included_ext_js = read_inheritable_attribute(:included_ext_js) || []
+          res = included_ext_js.inject("") do |r, path|
+            f = File.new("#{extjs_dir}/#{path}")
+            r << f.read
+          end
+
+          res << "\n"
+          
+          # from <widget_name>_extras/javascripts - all *.js files found there
+          js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "javascripts") 
+          file_list = Dir.glob("#{js_dir}/*.js")
+
+          for file_name in file_list
+            f = File.new(file_name)
+            res << f.read
+          end
+          
+          res
+        end
+        
+        # all JS code needed for this class, including one from the ancestor widget
+        def js_code(cached_dependencies = [])
           res = ""
 
-          # include the dependency if doing JS
-          res << js_base_class.js_class if js_inheritance && !cached_dependencies.include?(js_base_class.short_widget_class_name)
+          # include the base-class javascript if doing JS inheritance
+          res << js_base_class.js_code << "\n" if js_inheritance && !cached_dependencies.include?(js_base_class.short_widget_class_name)
+
+          # include static javascripts
+          res << js_included << "\n"
 
           # our own JS class definition
           res << js_class
           res
         end
 
+        # returns all css code require by this widget's class
+        def css_included
+          res = ""
+          # from <widget_name>_extras/stylesheets - all *.css files found there
+          js_dir = File.join(File.dirname(widget_file), short_widget_class_name.underscore + "_extras", "stylesheets") 
+          file_list = Dir.glob("#{js_dir}/*.css")
+
+          for file_name in file_list
+            f = File.new(file_name)
+            res << f.read
+          end
+          
+          res
+        end
+
+        # all JS code needed for this class including the one from the ancestor widget
+        def css_code(cached_dependencies = [])
+          res = ""
+
+          # include the base-class javascript if doing JS inheritance
+          res << js_base_class.css_code << "\n" if js_inheritance && !cached_dependencies.include?(js_base_class.short_widget_class_name)
+          
+          res << css_included << "\n"
+          
+          res
+        end
+
         def this; "this".l; end
         def null; "null".l; end
       

data/lib/netzke/core_ext.rb

@@ -78,4 +78,12 @@ class Symbol
   def to_js
     self.to_s.camelize(:lower).to_sym
   end
+end
+
+module ActiveSupport
+  class TimeWithZone
+    def to_json
+      self.to_s(:db).to_json
+    end
+  end
 end

data/netzke-core.gemspec

@@ -2,11 +2,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.2.7"
+  s.version = "0.2.8"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2009-02-13}
+  s.date = %q{2009-03-03}
   s.description = %q{Build ExtJS/Rails widgets with minimum effort}
   s.email = %q{sergei@writelesscode.com}
   s.extra_rdoc_files = ["CHANGELOG", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_layout.rb", "lib/app/models/netzke_preference.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/base_extras/interface.rb", "lib/netzke/base_extras/js_builder.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "README.mdown", "tasks/netzke_core_tasks.rake"]

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.2.7
+  version: 0.2.8
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-02-13 00:00:00 +01:00
+date: 2009-03-03 00:00:00 +01:00
 default_executable: 
 dependencies: []