skozlov-netzke-core 0.1.0.2 → 0.4.1

data/lib/netzke/feedback_ghost.rb

@@ -0,0 +1,43 @@
+module Netzke
+  #
+  # An invisible component that provides feedback service for all Netzke widgets
+  #
+  class FeedbackGhost < Base
+    def self.js_base_class
+      "Ext.Component" # yes, invisible
+    end
+
+    def self.js_extend_properties
+      {
+        :show_feedback => <<-END_OF_JAVASCRIPT.l,
+          function(msg){
+            var createBox = function(s, l){
+                return ['<div class="msg">',
+                        '<div class="x-box-tl"><div class="x-box-tr"><div class="x-box-tc"></div></div></div>',
+                        '<div class="x-box-ml"><div class="x-box-mr"><div class="x-box-mc">', s, '</div></div></div>',
+                        '<div class="x-box-bl"><div class="x-box-br"><div class="x-box-bc"></div></div></div>',
+                        '</div>'].join('');
+            }
+
+            var showBox = function(msg, lvl){
+              if (!lvl) {lvl = 'notice'};
+              var msgCt = Ext.DomHelper.insertFirst(document.body, {'class':'netzke-feedback'}, true);
+              var m = Ext.DomHelper.append(msgCt, {html:createBox(msg,lvl)}, true);
+              m.slideIn('t').pause(2).ghost("b", {remove:true});
+            }
+
+            if (typeof msg != 'string') {
+              var compoundMsg = "";
+              Ext.each(msg, function(m){
+                compoundMsg += m.msg + '<br>';
+              });
+              if (compoundMsg != "") showBox(compoundMsg, null); // the second parameter will be level
+            } else {
+              showBox(msg);
+            }
+        	}
+        END_OF_JAVASCRIPT
+      }
+    end
+  end
+end

data/lib/netzke/routing.rb

@@ -0,0 +1,9 @@
+module Netzke
+  module Routing
+    module MapperExtensions
+      def netzke
+        @set.add_route("/netzke/:action.:format", {:controller => "netzke"})
+      end
+    end
+  end
+end

data/netzke-core.gemspec

@@ -2,27 +2,26 @@
 
 Gem::Specification.new do |s|
   s.name = %q{netzke-core}
-  s.version = "0.1.0.2"
+  s.version = "0.4.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sergei Kozlov"]
-  s.date = %q{2008-12-28}
+  s.date = %q{2009-09-06}
   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/base.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/js_class_builder.rb", "lib/netzke-core.rb", "lib/vendor/facets/hash/recursive_merge.rb", "LICENSE", "README.mdown", "tasks/netzke_core_tasks.rake"]
-  s.files = ["CHANGELOG", "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/templates/netzke.html.erb", "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/base.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/js_class_builder.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.has_rdoc = true
-  s.homepage = %q{http://writelesscode.com}
-  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netzke-core", "--main", "README.mdown"]
+  s.email = %q{sergei@playcode.nl}
+  s.extra_rdoc_files = ["CHANGELOG", "LICENSE", "README.rdoc", "TODO", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_preference.rb", "lib/netzke-core.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/base_js.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/routing.rb", "tasks/netzke_core_tasks.rake"]
+  s.files = ["CHANGELOG", "LICENSE", "Manifest", "README.rdoc", "Rakefile", "TODO", "autotest/discover.rb", "generators/netzke_core/USAGE", "generators/netzke_core/netzke_core_generator.rb", "generators/netzke_core/templates/create_netzke_preferences.rb", "init.rb", "install.rb", "javascripts/core.js", "lib/app/controllers/netzke_controller.rb", "lib/app/models/netzke_preference.rb", "lib/netzke-core.rb", "lib/netzke/action_view_ext.rb", "lib/netzke/base.rb", "lib/netzke/base_js.rb", "lib/netzke/controller_extensions.rb", "lib/netzke/core_ext.rb", "lib/netzke/feedback_ghost.rb", "lib/netzke/routing.rb", "netzke-core.gemspec", "stylesheets/core.css", "tasks/netzke_core_tasks.rake", "test/app_root/app/controllers/application_controller.rb", "test/app_root/app/models/role.rb", "test/app_root/app/models/user.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/db/migrate/20090423214303_create_roles.rb", "test/app_root/db/migrate/20090423222114_create_users.rb", "test/app_root/lib/console_with_fixtures.rb", "test/app_root/script/console", "test/fixtures/roles.yml", "test/fixtures/users.yml", "test/test_helper.rb", "test/unit/core_ext_test.rb", "test/unit/netzke_core_test.rb", "test/unit/netzke_preference_test.rb", "uninstall.rb"]
+  s.homepage = %q{http://playcode.nl}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Netzke-core", "--main", "README.rdoc"]
   s.require_paths = ["lib"]
   s.rubyforge_project = %q{netzke-core}
-  s.rubygems_version = %q{1.3.1}
+  s.rubygems_version = %q{1.3.4}
   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/unit/core_ext_test.rb", "test/unit/netzke_core_test.rb", "test/unit/netzke_preference_test.rb"]
 
   if s.respond_to? :specification_version then
     current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 2
+    s.specification_version = 3
 
     if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
     else

data/stylesheets/core.css

@@ -0,0 +1,12 @@
+/*
+This file gets loaded along with the rest of Ext library at the initial load
+*/
+
+/* feedback */
+.netzke-feedback {
+    position:fixed;
+    left:25%;
+    top:0;
+    width:300px;
+    z-index:20000;
+}

data/test/app_root/app/models/role.rb

@@ -0,0 +1,3 @@
+class Role < ActiveRecord::Base
+  has_many :users
+end

data/test/app_root/app/models/user.rb

@@ -0,0 +1,3 @@
+class User < ActiveRecord::Base
+  belongs_to :role
+end

data/test/app_root/config/boot.rb

@@ -47,6 +47,7 @@ module Rails
     def load_initializer
       require "#{RAILS_FRAMEWORK_ROOT}/railties/lib/initializer"
       Rails::Initializer.run(:install_gem_spec_stubs)
+      Rails::GemDependency.add_frozen_gem_path
     end
   end
 
@@ -85,7 +86,7 @@ module Rails
 
       def load_rubygems
         require 'rubygems'
-        min_version = '1.1.1'
+        min_version = '1.3.1'
         unless rubygems_version >= min_version
           $stderr.puts %Q(Rails requires RubyGems >= #{min_version} (you have #{rubygems_version}). Please `gem update --system` and try again.)
           exit 1

data/test/app_root/config/database.yml

@@ -2,20 +2,30 @@ in_memory:
   adapter: sqlite3
   database: ":memory:"
   verbosity: quiet
+  pool: 5
+  timeout: 5000
 sqlite:
   adapter: sqlite
   dbfile: plugin_test.sqlite.db
+  pool: 5
+  timeout: 5000
 sqlite3:
   adapter: sqlite3
   dbfile: plugin_test.sqlite3.db
+  pool: 5
+  timeout: 5000
 postgresql:
   adapter: postgresql
   username: postgres
   password: postgres
   database: plugin_test
+  pool: 5
+  timeout: 5000
 mysql:
   adapter: mysql
   host: localhost
   username: root
   password:
   database: plugin_test
+  pool: 5
+  timeout: 5000

data/test/app_root/config/environment.rb

@@ -3,6 +3,7 @@ require File.join(File.dirname(__FILE__), 'boot')
 Rails::Initializer.run do |config|
   config.cache_classes = false
   config.whiny_nils = true
+  config.action_controller.session = {:key => 'rails_session', :secret => 'd229e4d22437432705ab3985d4d246'}
   config.plugin_locators.unshift(
     Class.new(Rails::Plugin::Locator) do
       def plugins

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/app_root/db/migrate/20090423214303_create_roles.rb

@@ -0,0 +1,11 @@
+class CreateRoles < ActiveRecord::Migration
+  def self.up
+    create_table :roles do |t|
+      t.string :name
+    end
+  end
+
+  def self.down
+    drop_table :roles
+  end
+end

data/test/app_root/db/migrate/20090423222114_create_users.rb

@@ -0,0 +1,12 @@
+class CreateUsers < ActiveRecord::Migration
+  def self.up
+    create_table :users do |t|
+      t.string :login
+      t.integer :role_id
+    end
+  end
+
+  def self.down
+    drop_table :users
+  end
+end

data/test/app_root/lib/console_with_fixtures.rb

@@ -0,0 +1,4 @@
+# Loads fixtures into the database when running the test app via the console
+(ENV['FIXTURES'] ? ENV['FIXTURES'].split(/,/) : Dir.glob(File.join(Rails.root, '../fixtures/*.{yml,csv}'))).each do |fixture_file|
+  Fixtures.create_fixtures(File.join(Rails.root, '../fixtures'), File.basename(fixture_file, '.*'))
+end

data/test/app_root/script/console

@@ -3,4 +3,5 @@ libs =  " -r irb/completion"
 libs << " -r test/test_helper"
 libs << " -r console_app"
 libs << " -r console_with_helpers"
+libs << " -r console_with_fixtures"
 exec "#{irb} #{libs} --simple-prompt"

data/test/fixtures/roles.yml

@@ -0,0 +1,7 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  name: MyString
+
+two:
+  name: MyString

data/test/fixtures/users.yml

@@ -0,0 +1,9 @@
+# Read about fixtures at http://ar.rubyonrails.org/classes/Fixtures.html
+
+one:
+  login: MyString
+  role_id: 1
+
+two:
+  login: MyString
+  role_id: 1

data/test/test_helper.rb

@@ -4,7 +4,6 @@ ENV['RAILS_ENV'] ||= 'in_memory'
 # Load the Rails environment and testing framework
 require "#{File.dirname(__FILE__)}/app_root/config/environment"
 require 'test_help'
-require 'action_view/test_case' # Load additional test classes not done automatically by < Rails 2.2.2
 
 # Undo changes to RAILS_ENV
 silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
@@ -13,8 +12,10 @@ silence_warnings {RAILS_ENV = ENV['RAILS_ENV']}
 ActiveRecord::Migrator.migrate("#{Rails.root}/db/migrate")
 
 # Set default fixture loading properties
-Test::Unit::TestCase.class_eval do
+ActiveSupport::TestCase.class_eval do
   self.use_transactional_fixtures = true
   self.use_instantiated_fixtures = false
   self.fixture_path = "#{File.dirname(__FILE__)}/fixtures"
+  
+  fixtures :all
 end

data/test/unit/core_ext_test.rb

@@ -0,0 +1,66 @@
+require 'test_helper'
+require 'netzke/core_ext'
+
+class CoreExtTest < ActiveSupport::TestCase
+  test "recursive delete if nil" do
+    assert_equal({:a => 1, :b => {:c => 4, :d => 5}}, {:a => 1, :aa => nil, :b => {:c => 4, :d => 5, :cc => nil}}.recursive_delete_if_nil)
+
+    assert_equal({:a => [{:e => 5}, {:f => 7}], :b => {:c => 4, :d => 5}}, {:a => [{:e => 5, :ee => nil},{:f => 7, :ff => nil}], :aa => nil, :b => {:c => 4, :d => 5, :cc => nil}}.recursive_delete_if_nil)
+
+    assert_equal([
+      {:a => [{:e => 5}]}, 
+      {}, 
+      {:b => {:c => 4, :d => 5}}
+    ], [
+      {:a => [{:e => 5, :ee => nil}]}, 
+      {:aa => nil}, 
+      {:b => {:c => 4, :d => 5, :cc => nil}}
+    ].recursive_delete_if_nil)
+  end
+  
+  test "convert keys" do
+    assert_equal([
+      {:aB => 1, :cDD => [{:lookMa => true},{:wowNow => true}]}
+    ],[:a_b => 1, :c_d_d => [{:look_ma => true},{:wow_now => true}]].convert_keys{|k| k.camelize(:lower)})
+  end
+  
+  test "javascript-like access to hash data" do
+    a = {}
+    a["key"] = 100
+    assert_equal(100, a.key)
+    
+    a.key = 200
+    assert_equal(200, a["key"])
+    
+    a.another_key = 300
+    assert_equal(300, a[:another_key])
+  end
+  
+  test "jsonify" do
+    assert_equal({:aB => 1, "cD" => [[1, {:eF => "stay_same"}], {"literal_symbol" => :should_not_change, "literal_string".l => "also_should_not"}]}, {:a_b => 1, "c_d" => [[1, {:e_f => "stay_same"}], {:literal_symbol.l => :should_not_change, "literal_string".l => "also_should_not"}]}.jsonify)
+  end
+  
+  # test "flatten" do
+  #   assert_equal([{
+  #     :name => :one, :value => 1 
+  #   },{
+  #     :name => :two, :value => 2 
+  #   },{
+  #     :name => :three__four, :value => 4 
+  #   },{
+  #     :name => :three__five__six, :value => 6
+  #   }], 
+  #   {
+  #     :one => 1,
+  #     :two => 2,
+  #     :three => {
+  #       :four => 4,
+  #       :five => {
+  #         :six => 6
+  #       }
+  #     }
+  #   }.flatten
+  #   )
+  # end
+  
+end

data/test/unit/netzke_core_test.rb

@@ -0,0 +1,167 @@
+require 'test_helper'
+require 'netzke-core'
+
+module Netzke
+  class Widget < Base
+    api :method_one, :method_two
+    
+    def self.config
+      super.merge({
+        :pref_one => 1,
+        :pref_two => 2
+      })
+    end
+    
+    def initial_aggregatees
+      {
+        :nested_one => {:widget_class_name => 'NestedWidgetOne'},
+        :nested_two => {:widget_class_name => 'NestedWidgetTwo'}
+      }
+    end
+  
+    def available_permissions
+      %w(read update)
+    end
+    
+    def default_config
+      {
+        :config_uno => true,
+        :config_dos => false
+      }
+    end
+  end
+
+  class NestedWidgetOne < Base
+  end
+
+  class NestedWidgetTwo < Base
+    def initial_aggregatees
+      {
+        :nested => {:widget_class_name => 'DeepNestedWidget'}
+      }
+    end
+  end
+
+  class DeepNestedWidget < Base
+  end
+
+  class JsInheritanceWidget < Widget
+  end
+  
+  class InheritedWidget < Widget
+    def self.config
+      super.merge({
+        :pref_one => -1
+      })
+    end
+  end
+end
+
+class NetzkeCoreTest < ActiveSupport::TestCase
+  include Netzke
+  
+  def setup
+  end
+  
+  test "base class loaded" do
+    assert_kind_of Netzke::Base, Netzke::Base.new
+  end
+  
+  test "short widget class name" do
+    assert_equal 'Widget', Widget.short_widget_class_name
+  end
+  
+  test "api" do
+    widget_class = Widget
+    assert_equal [:load_aggregatee_with_cache, :method_one, :method_two], widget_class.api_points
+  end
+
+  test "aggregatees" do
+    widget = Widget.new(:name => 'my_widget')
+    
+    # instantiate aggregatees
+    nested_widget_one = widget.aggregatee_instance(:nested_one)
+    nested_widget_two = widget.aggregatee_instance(:nested_two)
+    deep_nested_widget = widget.aggregatee_instance(:nested_two__nested)
+    
+    # check the classes of aggregation instances
+    assert_kind_of NestedWidgetOne, nested_widget_one
+    assert_kind_of NestedWidgetTwo, nested_widget_two
+    assert_kind_of DeepNestedWidget, deep_nested_widget
+    
+    # check the internal names of aggregation instances
+    assert_equal 'my_widget', widget.id_name
+    assert_equal 'my_widget__nested_one', nested_widget_one.id_name
+    assert_equal 'my_widget__nested_two', nested_widget_two.id_name
+    assert_equal 'my_widget__nested_two__nested', deep_nested_widget.id_name
+  end
+  
+  # test "permissions" do
+  #   widget = Widget.new
+  #   assert_equal({:read => true, :update => true}, widget.permissions)
+  # 
+  #   widget = Widget.new(:prohibit => :all)
+  #   assert_equal({:read => false, :update => false}, widget.permissions)
+  # 
+  #   widget = Widget.new(:prohibit => :read)
+  #   assert_equal({:read => false, :update => true}, widget.permissions)
+  # 
+  #   widget = Widget.new(:prohibit => [:read, :update])
+  #   assert_equal({:read => false, :update => false}, widget.permissions)
+  # 
+  #   widget = Widget.new(:prohibit => :all, :allow => :read)
+  #   assert_equal({:read => true, :update => false}, widget.permissions)
+  # 
+  #   widget = Widget.new(:prohibit => :all, :allow => [:read, :update])
+  #   assert_equal({:read => true, :update => true}, widget.permissions)
+  # end
+  
+  test "default config" do
+    widget = Widget.new
+    assert_equal({:config_uno => true, :config_dos => false}, widget.config)
+
+    widget = Widget.new(:name => 'widget', :config_uno => false)
+    assert_equal({:name => 'widget', :config_uno => false, :config_dos => false}, widget.config)
+  end
+
+  test "dependencies calculated based on aggregations" do
+    widget = Widget.new
+    assert(widget.dependencies.include?('NestedWidgetOne'))
+    assert(widget.dependencies.include?('NestedWidgetTwo'))
+    assert(!widget.dependencies.include?('DeepNestedWidget'))
+  end
+  
+  test "dependency classes" do
+    widget = Widget.new
+    # not testing the order
+    assert(%w{DeepNestedWidget NestedWidgetOne NestedWidgetTwo Widget}.inject(true){|r, k| r && widget.dependency_classes.include?(k)})
+  end
+
+  test "widget instance by config" do
+    widget = Netzke::Base.instance_by_config({:widget_class_name => 'Widget', :name => 'a_widget'})
+    assert(Widget, widget.class)
+    assert('a_widget', widget.name)
+  end
+
+  test "js inheritance" do
+    widget = JsInheritanceWidget.new
+    assert(widget.js_missing_code.index("Ext.netzke.cache.JsInheritanceWidget"))
+    assert(widget.js_missing_code.index("Ext.netzke.cache.Widget"))
+  end
+
+  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])
+
+    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])
+    
+  end
+
+end