netzke-core 0.5.5 → 0.6.0

data/spec/component/composition_spec.rb

@@ -0,0 +1,132 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'netzke-core'
+
+module Netzke
+  describe Composition do
+    class SomeComponent < Base
+      endpoint :method_one
+      endpoint :method_two
+
+      def self.config
+        super.merge({
+          :pref_one => 1,
+          :pref_two => 2
+        })
+      end
+
+      def components
+        {
+          :nested_one => {:class_name => 'NestedComponentOne'},
+          :nested_two => {:class_name => 'NestedComponentTwo'}
+        }
+      end
+
+      def available_permissions
+        %w(read update)
+      end
+
+      def default_config
+        {
+          :config_uno => true,
+          :config_dos => false
+        }
+      end
+    end
+
+    class NestedComponentOne < Base
+    end
+
+    class NestedComponentTwo < Base
+      def components
+        {
+          :nested => {:class_name => 'DeepNestedComponent'}
+        }
+      end
+    end
+
+    class DeepNestedComponent < Base
+      def components
+        {
+          :nested => {:class_name => "VeryDeepNestedComponent"}
+        }
+      end
+    end
+
+    class VeryDeepNestedComponent < Base
+    end
+    
+    class ComponentOne < Base
+    end
+    
+    class ComponentTwo < Base
+    end
+    
+    class SomeComposite < Base
+      component :component_one do
+        {
+          :class_name => "ComponentOne",
+          :title => "My Cool Component"
+        }
+      end
+      
+      def config
+        {
+          :items => [
+            {:class_name => "ComponentTwo", :name => "my_component_two"}, 
+            {:class_name => "ComponentTwo"} # name omitted, will be "component_two1"
+          ]
+        }.deep_merge super
+      end
+    end
+
+    it "should be possible to create (nested) component instances" do
+      component = SomeComponent.new(:name => 'some_component')
+
+      # instantiate components
+      nested_component_one = component.component_instance(:nested_one)
+      nested_component_two = component.component_instance(:nested_two)
+      deep_nested_component = component.component_instance(:nested_two__nested)
+
+      nested_component_one.class.should == NestedComponentOne
+      nested_component_two.class.should == NestedComponentTwo
+      deep_nested_component.class.should == DeepNestedComponent
+
+      component.global_id.should == 'some_component'
+      nested_component_one.global_id.should == 'some_component__nested_one'
+      nested_component_two.global_id.should == 'some_component__nested_two'
+      deep_nested_component.global_id.should == 'some_component__nested_two__nested'
+    end
+    
+    it "should be possible to define nested components in different ways" do
+      composite = SomeComposite.new
+      components = composite.components
+      
+      components.keys.size.should == 3
+      components[:component_one][:class_name].should == "ComponentOne"
+      components[:my_component_two][:class_name].should == "ComponentTwo"
+      components[:component_two1][:class_name].should == "ComponentTwo"
+      
+    end
+
+    # DIDN'T WORK OUT till now
+    # it "should be possible to override the superclass's declaration of a component" do
+    #   composite = SomeComposite.new
+    #   composite.components[:component_one][:title].should == "My Cool Component"
+    #   
+    #   class ExtendedComposite < SomeComposite
+    #     component :component_one do |orig|
+    #       orig.merge(:title => orig[:title] + ", extended")
+    #     end
+    #     
+    #     component :component_two do
+    #       {:title => "Another Nested Component"}
+    #     end
+    #   end
+    #   
+    #   extended_composite = ExtendedComposite.new
+    #   extended_composite.components[:component_one][:title].should == "My Cool Component, extended"
+    #   extended_composite.components[:component_one][:class_name].should == "ComponentOne"
+    #   extended_composite.components[:component_two][:title].should == "Another Nested Component"
+    # end
+  end  
+end

data/spec/component/javascript_spec.rb

@@ -0,0 +1,15 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+require 'netzke-core'
+
+module Netzke
+  describe Javascript do
+    class SomeComponent < Base
+    end
+    class InheritedComponent < SomeComponent
+    end
+  
+    describe "extends_netzke_component?" do
+      InheritedComponent.extends_netzke_component?.should == true
+    end
+  end  
+end

data/spec/core_ext_spec.rb

@@ -0,0 +1,16 @@
+require File.dirname(__FILE__) + '/../lib/netzke/core_ext'
+
+describe "Core extensions" do
+  it "should properly do deep_each_pair" do
+    res = {}
+    {
+      :one => 1, 
+      :two => {:three => 3}, 
+      :nine => [
+        {:four => 4, :five => {:six => 6}}, 
+        {:seven => [{:eight => 8}]}
+      ]
+    }.deep_each_pair{ |k,v| res[k] = v }
+    res.should == {:one => 1, :three => 3, :four => 4, :six => 6, :eight => 8}
+  end
+end

data/spec/spec.opt

@@ -0,0 +1,2 @@
+--format progress
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,35 @@
+# This file is copied to spec/ when you run 'rails generate rspec:install'
+ENV["RAILS_ENV"] ||= 'test'
+require File.expand_path("../../test/rails_app/config/environment", __FILE__)
+require 'rspec/rails'
+
+# Each time recreate test database with migrations
+db_file = File.dirname(__FILE__) + "/../test/rails_app/db/test.sqlite3"
+File.delete(db_file) if File.exists?(db_file)
+ActiveRecord::Migrator.migrate(File.dirname(__FILE__) + "/../test/rails_app/db/migrate")
+
+# Load the factories for this plugin:
+# require File.dirname(__FILE__) + '/factories'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[Rails.root.join("spec/support/**/*.rb")].each {|f| require f}
+
+RSpec.configure do |config|
+  # == Mock Framework
+  #
+  # If you prefer to use mocha, flexmock or RR, uncomment the appropriate line:
+  #
+  # config.mock_with :mocha
+  # config.mock_with :flexmock
+  # config.mock_with :rr
+  config.mock_with :rspec
+
+  # Remove this line if you're not using ActiveRecord or ActiveRecord fixtures
+  config.fixture_path = "#{::Rails.root}/spec/fixtures"
+
+  # If you're not using ActiveRecord, or you'd prefer not to run each of your
+  # examples within a transaction, remove the following line or assign false
+  # instead of true.
+  config.use_transactional_fixtures = true
+end

data/{test/app_root/db/migrate/20081222035855_create_netzke_preferences.rb → templates/core/create_netzke_preferences.rb}

@@ -1,12 +1,12 @@
 class CreateNetzkePreferences < ActiveRecord::Migration
   def self.up
+    drop_table(:netzke_preferences) if table_exists?(:netzke_preferences)
+    
     create_table :netzke_preferences do |t|
-      t.string :name
-      t.string :pref_type
-      t.string :value
+      t.string  :key
+      t.text    :value
       t.integer :user_id
       t.integer :role_id
-      t.string :widget_name
 
       t.timestamps
     end

data/test/rails_app/.gitignore

@@ -0,0 +1,4 @@
+.bundle
+db/*.sqlite3
+log/*.log
+tmp/**/*

data/test/rails_app/Gemfile

@@ -0,0 +1,36 @@
+source 'http://rubygems.org'
+
+gem 'rails', '3.0.0'
+
+# Bundle edge Rails instead:
+# gem 'rails', :git => 'git://github.com/rails/rails.git'
+
+gem 'sqlite3-ruby', :require => 'sqlite3'
+
+# Use unicorn as the web server
+# gem 'unicorn'
+
+# Deploy with Capistrano
+# gem 'capistrano'
+
+# To use debugger
+# gem 'ruby-debug'
+
+# Bundle the extra gems:
+# gem 'bj'
+# gem 'nokogiri', '1.4.1'
+# gem 'sqlite3-ruby', :require => 'sqlite3'
+# gem 'aws-s3', :require => 'aws/s3'
+
+# Bundle gems for the local environment. Make sure to
+# put test-only gems in this group so their generators
+# and rake tasks are available in development mode:
+group :development, :test do
+  gem 'capybara'
+  gem 'database_cleaner'
+  gem 'cucumber-rails'
+  gem 'cucumber'
+  gem 'rspec-rails', "~>2.0.0"
+  gem 'spork'
+  gem 'launchy'    # So you can do Then show me the page
+end

data/test/rails_app/Gemfile.lock

@@ -0,0 +1,137 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.0)
+      actionpack (= 3.0.0)
+      mail (~> 2.2.5)
+    actionpack (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4.1)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.12)
+      rack-test (~> 0.5.4)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.0)
+      activesupport (= 3.0.0)
+      builder (~> 2.1.2)
+      i18n (~> 0.4.1)
+    activerecord (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+      arel (~> 1.0.0)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.0)
+      activemodel (= 3.0.0)
+      activesupport (= 3.0.0)
+    activesupport (3.0.0)
+    arel (1.0.1)
+      activesupport (~> 3.0.0)
+    builder (2.1.2)
+    capybara (0.4.0)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.2)
+    celerity (0.8.2)
+    childprocess (0.1.3)
+      ffi (~> 0.6.3)
+    configuration (1.1.0)
+    cucumber (0.9.2)
+      builder (~> 2.1.2)
+      diff-lcs (~> 1.1.2)
+      gherkin (~> 2.2.5)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    cucumber-rails (0.3.2)
+      cucumber (>= 0.8.0)
+    culerity (0.2.12)
+    database_cleaner (0.5.2)
+    diff-lcs (1.1.2)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    gherkin (2.2.9)
+      json (~> 1.4.6)
+      term-ansicolor (~> 1.0.5)
+    i18n (0.4.1)
+    json (1.4.6)
+    json_pure (1.4.6)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    mail (2.2.7)
+      activesupport (>= 2.3.6)
+      mime-types
+      treetop (>= 1.4.5)
+    mime-types (1.16)
+    nokogiri (1.4.3.1)
+    polyglot (0.3.1)
+    rack (1.2.1)
+    rack-mount (0.6.13)
+      rack (>= 1.0.0)
+    rack-test (0.5.6)
+      rack (>= 1.0)
+    rails (3.0.0)
+      actionmailer (= 3.0.0)
+      actionpack (= 3.0.0)
+      activerecord (= 3.0.0)
+      activeresource (= 3.0.0)
+      activesupport (= 3.0.0)
+      bundler (~> 1.0.0)
+      railties (= 3.0.0)
+    railties (3.0.0)
+      actionpack (= 3.0.0)
+      activesupport (= 3.0.0)
+      rake (>= 0.8.4)
+      thor (~> 0.14.0)
+    rake (0.8.7)
+    rspec (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+      rspec-mocks (~> 2.0.1)
+    rspec-core (2.0.1)
+    rspec-expectations (2.0.1)
+      diff-lcs (>= 1.1.2)
+    rspec-mocks (2.0.1)
+      rspec-core (~> 2.0.1)
+      rspec-expectations (~> 2.0.1)
+    rspec-rails (2.0.1)
+      rspec (~> 2.0.0)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.0.29)
+      childprocess (>= 0.0.7)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    spork (0.8.4)
+    sqlite3-ruby (1.3.1)
+    term-ansicolor (1.0.5)
+    thor (0.14.3)
+    treetop (1.4.8)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.23)
+    xpath (0.1.2)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  capybara
+  cucumber
+  cucumber-rails
+  database_cleaner
+  launchy
+  rails (= 3.0.0)
+  rspec-rails (~> 2.0.0)
+  spork
+  sqlite3-ruby

data/test/rails_app/README

@@ -0,0 +1,15 @@
+== Netzke-core testing application
+
+This application is used as a helper app by the Cucumber and RSpec tests run from the root of the plugin, but can also be run stand-alone (don't forget to link extjs into public, and run the migrations).
+
+After you start the server, you can access any component from lib/netzke using the following URL schema:
+
+http://localhost:3000/components/<full_component_class_name>, e.g.:
+
+http://localhost:3000/components/ServerCaller
+
+or
+
+http://localhost:3000/components/ScopedComponents::SomeScopedComponent
+
+etc

data/test/rails_app/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+RailsApp::Application.load_tasks

data/test/rails_app/app/components/border_layout_panel.rb

@@ -0,0 +1,4 @@
+# It's a primitive BorderLayoutPanel, but don't let it fool you - it's a fully functionaly Netzke component: it handles components, can be dynamically loaded, nested, etc.
+class BorderLayoutPanel < Netzke::Base
+  js_property :layout, 'border'
+end

data/test/rails_app/app/components/component_loader.rb

@@ -0,0 +1,59 @@
+class ComponentLoader < Netzke::Base
+  component :simple_component, :title => "Simple Component", :lazy_loading => true
+  
+  component :component_loaded_in_window, {
+    :class_name => "SimpleComponent",
+    :title => "Component loaded in window",
+    :lazy_loading => true
+  }
+  
+  component :window_with_simple_component, {
+    :class_name => "SimpleWindow",
+    :items => [{
+      :class_name => "SimpleComponent",
+      :title => "Simple Component Inside Window"
+    }],
+    :lazy_loading => true
+  }
+  
+  js_method :on_load_with_feedback, <<-JS
+    function(){
+      this.loadComponent({name: 'simple_component', callback: function(){
+        this.setTitle("Callback" + " invoked!");
+      }, scope: this});
+    }
+  JS
+
+  action :load_with_feedback
+  
+  action :load_window_with_simple_component
+
+  js_properties(
+    :title => "Component Loader",
+    :layout => "fit",
+    :bbar => [{:text => "Load component", :ref => "../button"}, {:text => "Load in window", :ref => "../loadInWindowButton"}, :load_with_feedback.action, :load_window_with_simple_component.action]
+  )
+  
+  js_method :on_load_window_with_simple_component, <<-JS
+    function(params){
+      this.loadComponent({name: "window_with_simple_component"});
+    }
+  JS
+  
+  js_method :init_component, <<-JS
+    function(){
+      #{js_full_class_name}.superclass.initComponent.call(this);
+    
+      this.button.on('click', function(){
+        this.loadComponent({name: 'simple_component', container: this.getId()});
+      }, this);
+    
+      this.loadInWindowButton.on('click', function(){
+        var w = new Ext.Window({width: 500, height: 400, modal: true, layout:'fit'});
+        w.show(null, function(){
+          this.loadComponent({name: 'component_loaded_in_window', container: w.getId()});
+        }, this);
+      }, this);
+    }
+  JS
+end

data/test/rails_app/app/components/component_with_actions.rb

@@ -0,0 +1,58 @@
+class ComponentWithActions < Netzke::Base
+  # Define actions as a hash
+  action :another_action, :disabled => true, :text => "Disabled action", :icon => :accept
+  
+  # ... or as a block returning hash
+  action :some_action do
+    {:text => "Some Cool Action", :icon => Netzke::Core.icons_uri + "/delete.png"}
+  end
+  
+  # ... or directly as a method
+  def _my_action_action
+    {:text => "Not used"}
+  end
+  
+  js_property :title, "Panel that has actions"
+  
+  js_property :bbar, [:some_action.action, :another_action.action]
+  
+  js_property :tbar, [{
+    :xtype =>  'buttongroup',
+    :columns => 3,
+    :title => 'A group',
+    :items => [{
+        :text => 'Paste',
+        :scale => 'large',
+        :rowspan => 3, :iconCls => 'add',
+        :iconAlign => 'top',
+        :cls => 'x-btn-as-arrow'
+    },{
+        :xtype => 'splitbutton',
+        :text => 'Menu Button',
+        :scale => 'large',
+        :rowspan => 3,
+        :iconCls => 'add',
+        :iconAlign => 'top',
+        :arrowAlign => 'bottom',
+        :menu => [:some_action.action]
+    },{
+        :xtype => 'splitbutton', :text => 'Cut', :menu => [:another_action.action]
+    }, :another_action.action, 
+    {
+        :menu => [:some_action.action], :text => 'Format'
+    }]
+  }]
+  
+  js_method :on_some_action, <<-JS
+    function(){
+      this.update("Some action was triggered");
+    }
+  JS
+      
+  js_method :on_another_action, <<-JS
+    function(){
+      this.update("Another action was triggered");
+    }
+  JS
+  
+end

data/test/rails_app/app/components/component_with_custom_css.rb

@@ -0,0 +1,8 @@
+# This component has the header hidden by custom CSS
+class ComponentWithCustomCss < Netzke::Base
+  js_property :title, "ComponentWithCustomCss"
+  
+  js_property :html, "A component with the header hidden by means of custom CSS"
+  
+  css_include "#{File.dirname(__FILE__)}/custom.css"
+end

data/test/rails_app/app/components/component_with_included_js.rb

@@ -0,0 +1,16 @@
+class ComponentWithIncludedJs < Netzke::Base
+  js_include "#{File.dirname(__FILE__)}/included.js"
+  
+  js_base_class "Netzke.ComponentWithIncludedJs"
+  
+  action :print_message
+  
+  js_property :bbar, [:print_message.action]
+  
+  js_method :on_print_message, <<-JS
+    function(){
+      this.updateBodyWithMessage("Some message " + "shown in the body");
+    }
+  JS
+  
+end

data/test/rails_app/app/components/component_with_session_persistence.rb

@@ -0,0 +1,25 @@
+class ComponentWithSessionPersistence < Netzke::Base
+  js_property :title, "No Title (yet!)"
+  js_property :bbar, [{:text => "Tell server to store new title", :ref => "../button"}]
+  
+  config :default, :session_persistence => true
+
+  js_method :bug_server, <<-JS
+    function(){
+      this.whatsUp();
+    }
+  JS
+
+  js_method :init_component, <<-JS
+    function(){
+      #{js_full_class_name}.superclass.initComponent.call(this);
+      this.button.on('click', this.bugServer, this);
+    }
+  JS
+  
+  endpoint :whats_up do |params|
+    update_session_options(:title => "New Title!")
+    {}
+  end
+  
+end

data/test/rails_app/app/components/custom.css

@@ -0,0 +1,3 @@
+.x-panel-body {
+  display: none;
+}

data/test/rails_app/app/components/deprecated/server_caller.rb

@@ -0,0 +1,20 @@
+module Deprecated
+  class ServerCaller < Netzke::Base
+    js_properties :title => "Server caller",
+                  :bbar => [:call_server.action]
+    
+    js_method :on_call_server, <<-JS
+      function(){
+        this.whatsUp();
+      }
+    JS
+
+    ActiveSupport::Deprecation.silence do
+      api :whats_up
+    end
+    
+    def whats_up(params)
+      {:set_title => "Hello from the server!"}
+    end
+  end
+end

data/test/rails_app/app/components/extended_component_with_actions.rb

@@ -0,0 +1,5 @@
+class ExtendedComponentWithActions < ComponentWithActions
+  js_property :bbar, [:another_action.action]
+  
+  action :some_action, :icon => :tick
+end

data/test/rails_app/app/components/extended_server_caller.rb

@@ -0,0 +1,18 @@
+class ExtendedServerCaller < ServerCaller
+  
+  js_properties :title => "Extended Server Caller"
+  
+  js_method :on_bug_server, <<-JS
+    function(){
+      #{js_full_class_name}.superclass.onBugServer.call(this);
+      this.getBottomToolbar().addButton({text: "Added" + " by extended Server Caller"});
+      this.getBottomToolbar().doLayout();
+    }
+  JS
+
+  def whats_up(params)
+    orig = super
+    orig.merge(:set_title => orig[:set_title] + ", shiny weather")
+  end
+  
+end

data/test/rails_app/app/components/included.js

@@ -0,0 +1,5 @@
+Netzke.ComponentWithIncludedJs = Ext.extend(Ext.Panel, {
+  updateBodyWithMessage: function(message) {
+    this.body.update(message);
+  }
+});