netzke-core 0.2.1 → 0.2.2

data/CHANGELOG

@@ -1,3 +1,9 @@
+v0.2.2
+js_ext_config instance method added for overwriting
+Multiuser support
+Using Rails.logger for logging
+"config"-class method for every class inheriting Netzke::Base - for class-level configurations
+
 v0.2.1
 Fixed the path to ext-base-min.js for production mode.
 Also works in Safari now.

data/Manifest

@@ -35,8 +35,10 @@ test/app_root/config/environments/postgresql.rb
 test/app_root/config/environments/sqlite.rb
 test/app_root/config/environments/sqlite3.rb
 test/app_root/config/routes.rb
+test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb
 test/app_root/script/console
 test/core_ext_test.rb
 test/netzke_core_test.rb
+test/netzke_preference_test.rb
 test/test_helper.rb
 uninstall.rb

data/README.mdown

@@ -1,11 +1,12 @@
-netzke-core
-==========
+# netzke-core
+Create Ext JS + Rails reusable components (widgets) with minimum effort.
 
-Create ExtJS/Rails reusable components (widgets) with minimum effort.
+Note that if you would like to modify this code or experiment with it, you may be better off cloning this project into your app's vendor/plugin directory - it will then behave as a Rails plugin.
 
-Example
-=======
+# Example
 
 See the tutorials on http://blog.writelesscode.com
 
-Copyright (c) 2008 Sergei Kozlov, released under the MIT license
+Also see the netzke-basepack project.
+
+Copyright (c) 2008-2009 Sergei Kozlov, released under the MIT license

data/lib/app/models/netzke_layout.rb

@@ -1,8 +1,22 @@
 class NetzkeLayout < ActiveRecord::Base
   UNRELATED_ATTRS = %w(created_at updated_at position layout_id)
 
+  # Multi user support
+  def self.user
+    @@user ||= nil
+  end
+  
+  def self.user=(user)
+    @@user = user
+  end
+  
   def self.user_id
-    @@user_id ||= nil
+    user && user.id
+  end
+  
+  # normal create, but with a user_id merged-in
+  def self.create_with_user(config)
+    create(config.merge(:user_id => user_id))
   end
   
   def layout_items
@@ -10,7 +24,7 @@ class NetzkeLayout < ActiveRecord::Base
   end
   
   def self.by_widget(widget_name)
-    self.find(:first, :conditions => {:widget_name => widget_name, :user_id => self.user_id})
+    self.find(:first, :conditions => {:widget_name => widget_name, :user_id => user_id})
   end
 
   def move_item(old_index, new_index)

data/lib/app/models/netzke_preference.rb

@@ -1,12 +1,23 @@
+# TODO: would be great to support somethnig like:
+# NetzkePreference["name"].merge!({:a => 1, :b => 2}) # if NetzkePreference["name"] returns a hash
+# or
+# NetzkePreference["name"] << 2 # if NetzkePreference["name"] returns an array
+# etc
+#
 class NetzkePreference < ActiveRecord::Base
-  CONVERTION_METHODS= {'Fixnum' => 'to_i', 'String' => 'to_s', 'Float' => 'to_f', 'Symbol' => 'to_sym'}
-
+  ELEMENTARY_CONVERTION_METHODS= {'Fixnum' => 'to_i', 'String' => 'to_s', 'Float' => 'to_f', 'Symbol' => 'to_sym'}
+  
+  # Multi user support
+  def self.user
+    @@user ||= nil
+  end
+  
   def self.user=(user)
     @@user = user
   end
   
-  def self.user
-    @@user ||= nil
+  def self.user_id
+    user && user.id
   end
   
   def self.widget_name=(value)
@@ -27,19 +38,21 @@ class NetzkePreference < ActiveRecord::Base
       r = norm_value == 'false' ? false : (norm_value == 'true' || norm_value)
     elsif klass == 'NilClass'
       r = nil
-    elsif klass == 'Array'
+    elsif klass == 'Array' || klass == 'Hash'
       r = JSON.parse(norm_value)
     else
-      r = norm_value.send(CONVERTION_METHODS[klass])
+      r = norm_value.send(ELEMENTARY_CONVERTION_METHODS[klass])
     end
     r
   end
   
   def normalized_value=(new_value)
     # norm_value = (new_value.to_s if new_value == true or new_value == false) || new_value
-    case new_value.class.to_s
+    case new_value.class.name
     when "Array"
       write_attribute(:value, new_value.to_json)
+    when "Hash"
+      write_attribute(:value, new_value.to_json)
     else
       write_attribute(:value, new_value.to_s)
     end
@@ -48,7 +61,7 @@ class NetzkePreference < ActiveRecord::Base
   
   def self.[](pref_name)
     pref_name = pref_name.to_s
-    conditions = {:name => pref_name, :user_id => self.user, :widget_name => self.widget_name}
+    conditions = {:name => pref_name, :user_id => user_id, :widget_name => self.widget_name}
     pref = self.find(:first, :conditions => conditions)
     # pref = @@user.nil? ? self.find_by_name(pref_name) : self.find_by_name_and_user_id(pref_name, @@user.id)
     pref && pref.normalized_value
@@ -56,11 +69,17 @@ class NetzkePreference < ActiveRecord::Base
   
   def self.[]=(pref_name, new_value)
     pref_name = pref_name.to_s
-    conditions = {:name => pref_name, :user_id => self.user, :widget_name => self.widget_name}
-    pref = self.find(:first, :conditions => conditions) || self.create(conditions)
-    # pref = self.user.nil? ? self.find_or_create_by_name(pref_name) : self.find_or_create_by_name_and_user_id(pref_name, self.user.id)
-    pref.normalized_value = new_value
-    pref.save!
+    conditions = {:name => pref_name, :user_id => user_id, :widget_name => self.widget_name}
+    pref = self.find(:first, :conditions => conditions)
+    
+    # if assigning nil, simply delete the eventually found preference
+    if new_value.nil?
+      pref && pref.destroy
+    else
+      pref ||= self.new(conditions)
+      pref.normalized_value = new_value
+      pref.save!
+    end
   end
   
 end

data/lib/netzke/base.rb

@@ -4,43 +4,41 @@ module Netzke
   # 
   # Configuration:
   # * Define NETZKE_BOOT_CONFIG in environment.rb to specify which Netzke functionality should be disabled 
-  # to reduce the size of /netzke/netzke.[js|css]. Those Netzke gems that use additional JS-code 
+  # to reduce the size of /netzke/netzke.[js|css]. Those Netzke gems that use additional JS/CSS-code 
   # should be aware of this constant.
   #
   class Base
-    # Helper class to read/write from/to widget's persistent preferences. TODO: rework it.
-    class Config
-      def initialize(widget_name)
-        @widget_name = widget_name
-      end
-      def []=(k,v)
-        NetzkePreference.widget_name = @widget_name
-        NetzkePreference[k] = v
-      end
-      def [](k)
-        NetzkePreference.widget_name = @widget_name
-        NetzkePreference[k]
-      end
-    end
-
     # Client-side code (generates JS-class of the widget)
     include Netzke::JsClassBuilder
 
-    # Class methods
-    class << self
-      # Global Netzke configuration
+    module ClassMethods
+
+      # Global Netzke::Base configuration
       def config
-        @@config ||= {
-          # locations of javascript and css files (which will be automatically collected into one file and sent as /netzke/netzke.js and /netzke/netzke.css respectively)
+        set_default_config({
           :javascripts => [],
-          :css => []
-        }
+          :css => [],
+          :layout_manager => "NetzkeLayout",
+          :persistent_config_manager => "NetzkePreference"
+        })
       end
-      
+
       def short_widget_class_name
         name.split("::").last
       end
 
+      def user
+        @@user ||= nil
+      end
+
+      def user=(user)
+        @@user = user
+
+        # also set up the managers
+        persistent_config_manager_class && persistent_config_manager_class.user = user
+        layout_manager_class && layout_manager_class.user = user
+      end
+
       #
       # Use this class method to declare connection points between client side of a widget and its server side. A method in a widget class with the same name will be (magically) called by the client side of the widget. See Grid widget for an example
       #
@@ -72,24 +70,58 @@ module Netzke
         widget_class = "Netzke::#{config[:widget_class_name]}".constantize
         widget_class.new(config)
       end
+      
+      def persistent_config_manager_class
+        config[:persistent_config_manager].constantize
+      rescue NameError
+        nil
+      end
+
+      def layout_manager_class
+        Netzke::Base.config[:layout_manager].constantize
+      rescue NameError
+        nil
+      end
+      
+      private
+      def set_default_config(default_config)
+        @@config ||= {}
+        @@config[self.name] ||= default_config
+        @@config[self.name]
+      end
+      
     end
-  
+    extend ClassMethods
+    
     attr_accessor :config, :server_confg, :parent, :logger, :id_name, :permissions
     attr_reader :pref
 
     def initialize(config = {}, parent = nil)
-      @logger = Logger.new("debug.log")
       @config = initial_config.recursive_merge(config)
       @parent = parent
       @id_name = parent.nil? ? config[:name].to_s : "#{parent.id_name}__#{config[:name]}"
       
       @flash = []
-      @pref = Config.new(@id_name)
       
       @config[:ext_config] ||= {} # configuration used to instantiate JS class
-      
+
       process_permissions_config
     end
+
+    # Rails' logger
+    def logger
+      Rails.logger
+    end
+    
+    # Store some setting in the database as if it was a hash, e.g.:
+    #     persistent_config["window.size"] = 100
+    #     persistent_config["window.size"] => 100
+    # This method is current_user-aware
+    def persistent_config
+      config_klass = self.class.persistent_config_manager_class
+      config_klass && config_klass.widget_name = id_name # pass to the config class our unique name
+      config_klass || {} # if we don't have the presistent config manager, all the calls to it will always return nil, and the "="-operation will be ignored
+    end
     
     def initial_config
       {}
@@ -185,9 +217,10 @@ module Netzke
         config[:allow] = [config[:allow]] if config[:allow].is_a?(Symbol) # so that config[:allow] => :write works
         config[:allow] && config[:allow].each{|p| @permissions.merge!(p.to_sym => true)} # allow
         
-        # ... and then merge it with NetzkePreferences (if not instantiated to only generate JS-class code)
+        # ... and then merge it with NetzkePreferences
         available_permissions.each do |p|
-          @permissions[p.to_sym] = @pref["permissions.#{p}"] if !@pref["permissions.#{p}"].nil?
+          persistent_permisson = persistent_config["permissions.#{p}"]
+          @permissions[p.to_sym] = persistent_permisson unless persistent_permisson.nil?
         end
       end
     end

data/lib/netzke/controller_extensions.rb

@@ -2,6 +2,12 @@ module Netzke
   module ControllerExtensions
     def self.included(base)
       base.extend ControllerClassMethods
+      base.send(:before_filter, :set_user)
+    end
+    
+    # pickup 
+    def set_user
+      Netzke::Base.user = current_user if defined?(current_user)
     end
     
     def method_missing(method_name)

data/lib/netzke/js_class_builder.rb

@@ -29,7 +29,7 @@ module Netzke
     
       res.merge!(:widget_class_name => short_widget_class_name)
 
-      res.merge!(config[:ext_config])
+      res.merge!(js_ext_config)
       res.merge!(:id => @id_name)
     
       # include tools and actions
@@ -41,11 +41,13 @@ module Netzke
       # include permissions
       res.merge!(:permissions => permissions) unless available_permissions.empty?
       
-      # include eventual region_config
-      res.merge!(:region_config => config[:region_config])
       res
     end
    
+    def js_ext_config
+      config[:ext_config] || {}
+    end
+    
     # Generate instantiating - used when a widget is generated stand-alone (as a part of a HTML page)
     def js_widget_instance
       %Q(var #{config[:name].to_js} = new Ext.componentCache['#{short_widget_class_name}'](#{js_config.to_js});)

data/lib/netzke-core.rb

@@ -19,25 +19,21 @@ require 'vendor/facets/hash/recursive_merge'
 end
 
 if defined? ActionController
-  # Provide controllers with netzke class method
   ActionController::Base.class_eval do
     include Netzke::ControllerExtensions
   end
 
-  # Include the route to netzke controller
+  # Include the route to the Netzke controller
   ActionController::Routing::RouteSet::Mapper.send :include, Netzke::Routing::MapperExtensions
 end
 
 if defined? ActionView
-  # Helpers to be put into layouts
   ActionView::Base.send :include, Netzke::ActionViewExt
 end  
 
-# Make this plugin auto-reloaded for easier development
+# Make this plugin auto-reloadable for easier development
 ActiveSupport::Dependencies.load_once_paths.delete(File.join(File.dirname(__FILE__)))
 
-# Include the javascript
+# Include javascript & styles
 Netzke::Base.config[:javascripts] << "#{File.dirname(__FILE__)}/../javascripts/core.js"
-
-# Include CSS
 Netzke::Base.config[:css] << "#{File.dirname(__FILE__)}/../css/core.css"

data/netzke-core.gemspec

@@ -2,15 +2,15 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.2.1"
+  s.version = "0.2.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2009-01-07}
+  s.date = %q{2009-01-23}
   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/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/js_class_builder.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "README.mdown", "tasks/netzke_core_tasks.rake"]
-  s.files = ["CHANGELOG", "css/core.css", "generators/netzke_core/netzke_core_generator.rb", "generators/netzke_core/templates/create_netzke_layouts.rb", "generators/netzke_core/templates/create_netzke_preferences.rb", "generators/netzke_core/USAGE", "init.rb", "install.rb", "javascripts/core.js", "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/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/js_class_builder.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "Manifest", "netzke-core.gemspec", "Rakefile", "README.mdown", "tasks/netzke_core_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/script/console", "test/core_ext_test.rb", "test/netzke_core_test.rb", "test/test_helper.rb", "uninstall.rb"]
+  s.files = ["CHANGELOG", "css/core.css", "generators/netzke_core/netzke_core_generator.rb", "generators/netzke_core/templates/create_netzke_layouts.rb", "generators/netzke_core/templates/create_netzke_preferences.rb", "generators/netzke_core/USAGE", "init.rb", "install.rb", "javascripts/core.js", "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/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/js_class_builder.rb", "lib/netzke/routing.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "Manifest", "netzke-core.gemspec", "Rakefile", "README.mdown", "tasks/netzke_core_tasks.rake", "test/app_root/app/controllers/application.rb", "test/app_root/config/boot.rb", "test/app_root/config/database.yml", "test/app_root/config/environment.rb", "test/app_root/config/environments/in_memory.rb", "test/app_root/config/environments/mysql.rb", "test/app_root/config/environments/postgresql.rb", "test/app_root/config/environments/sqlite.rb", "test/app_root/config/environments/sqlite3.rb", "test/app_root/config/routes.rb", "test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb", "test/app_root/script/console", "test/core_ext_test.rb", "test/netzke_core_test.rb", "test/netzke_preference_test.rb", "test/test_helper.rb", "uninstall.rb"]
   s.has_rdoc = true
   s.homepage = %q{http://writelesscode.com}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netzke-core", "--main", "README.mdown"]
@@ -18,7 +18,7 @@ Gem::Specification.new do |s|
   s.rubyforge_project = %q{netzke-core}
   s.rubygems_version = %q{1.3.1}
   s.summary = %q{Build ExtJS/Rails widgets with minimum effort}
-  s.test_files = ["test/core_ext_test.rb", "test/netzke_core_test.rb"]
+  s.test_files = ["test/core_ext_test.rb", "test/netzke_core_test.rb", "test/netzke_preference_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION

data/test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb

@@ -0,0 +1,18 @@
+class CreateNetzkePreferences < ActiveRecord::Migration
+  def self.up
+    create_table :netzke_preferences do |t|
+      t.string :name
+      t.string :pref_type
+      t.string :value
+      t.integer :user_id
+      t.integer :role_id
+      t.string :widget_name
+
+      t.timestamps
+    end
+  end
+
+  def self.down
+    drop_table :netzke_preferences
+  end
+end

data/test/netzke_core_test.rb

@@ -40,15 +40,24 @@ module Netzke
   end
 end
 
+# mocking the User class
+class User
+  attr_accessor :id
+  def initialize(id)
+    @id = id
+  end
+end
+
 class NetzkeCoreTest < ActiveSupport::TestCase
   include Netzke
   
   def setup
-    object = mock()
-    object.stubs(:normalized_value)
-    object.stubs(:normalized_value=)
-    # object.stubs(:save!)
-    NetzkePreference.stubs(:find).returns(object)
+    # object = mock()
+    # object.stubs(:normalized_value)
+    # object.stubs(:normalized_value=)
+    # # object.stubs(:save!)
+    # NetzkePreference.stubs(:find).returns(object)
+    
   end
   
   test "base class loaded" do
@@ -131,4 +140,25 @@ class NetzkeCoreTest < ActiveSupport::TestCase
     assert(Widget, widget.class)
     assert('a_widget', widget.config[:name])
   end
+
+  test "class configuration" do
+    assert_equal(NetzkeLayout, Netzke::Base.layout_manager_class)
+  end
+  
+  # test "multiuser" do
+  #   Netzke::Base.current_user = User.new(1)
+  #   Widget.new(:prohibit => :all, :name => 'widget')
+  #   
+  #   Netzke::Base.current_user = User.new(2)
+  #   Widget.new(:prohibit => :read, :name => 'widget')
+  #   
+  #   Netzke::Base.current_user = User.new(1)
+  #   widget = Widget.new(:name => 'widget')
+  #   assert_equal({:read => false, :update => false}, widget.permissions)
+  # 
+  #   Netzke::Base.current_user = User.new(2)
+  #   widget = Widget.new(:name => 'widget')
+  #   assert_equal({:read => false, :update => true}, widget.permissions)
+  #   
+  # end
 end

data/test/netzke_preference_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+require 'netzke-core'
+class NetzkePreferenceTest < ActiveSupport::TestCase
+  test "basic values" do
+    an_integer = 1976
+    a_float = 1976.1345
+    a_symbol = :a_symbol
+    a_true = true
+    a_false = false
+    a_nil = nil
+    a_hash = {"a" => an_integer, "b" => a_true, "c" => nil, "d" => a_float}
+    an_array = [1, "a", a_hash, [1,3,4], a_true, a_false, a_nil, a_float]
+    
+
+    p = NetzkePreference
+    p[:a_hash] = a_hash
+    p["an_integer"] = an_integer
+    p[:a_true] = a_true
+    p[:a_false] = a_false
+    p[:a_nil] = a_nil
+    p[:an_array] = an_array
+    p[:a_symbol] = a_symbol
+    p[:a_float] = a_float
+    
+    assert_equal(a_hash, p[:a_hash])
+    assert_equal(an_integer, p[:an_integer])
+    assert_equal(a_true, p[:a_true])
+    assert_equal(a_false, p[:a_false])
+    assert_equal(an_array, p[:an_array])
+    assert_equal(a_nil, p[:a_nil])
+    assert_equal(a_symbol, p[:a_symbol])
+    assert_equal(a_float, p[:a_float])
+    
+    assert_equal(nil, p[:non_existing])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: netzke-core
 version: !ruby/object:Gem::Version 
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors: 
 - Sergei Kozlov
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-01-07 00:00:00 -06:00
+date: 2009-01-23 00:00:00 -06:00
 default_executable: 
 dependencies: []
 
@@ -74,9 +74,11 @@ files:
 - test/app_root/config/environments/sqlite.rb
 - test/app_root/config/environments/sqlite3.rb
 - test/app_root/config/routes.rb
+- test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb
 - test/app_root/script/console
 - test/core_ext_test.rb
 - test/netzke_core_test.rb
+- test/netzke_preference_test.rb
 - test/test_helper.rb
 - uninstall.rb
 has_rdoc: true
@@ -113,3 +115,4 @@ summary: Build ExtJS/Rails widgets with minimum effort
 test_files: 
 - test/core_ext_test.rb
 - test/netzke_core_test.rb
+- test/netzke_preference_test.rb