netzke-core 0.7.7 → 0.8.0

data/test/core_test_app/app/components/loader_of_component_with_custom_css.rb

@@ -1,14 +1,23 @@
 # Loads a component with custom CSS, to make sure that also dynamically loaded components get the correct CSS applied
 class LoaderOfComponentWithCustomCss < Netzke::Base
-  component :component_with_custom_css, :class_name => "ComponentWithCustomCss", :lazy_loading => true
+  component :component_with_custom_css do |c|
+    c.klass = ComponentWithCustomCss
+  end
 
   action :load_component_with_custom_css
 
-  js_properties :title => "LoaderOfComponentWithCustomCss", :layout => 'fit', :bbar => [:load_component_with_custom_css.action]
+  def configure(c)
+    super
+    c.title = "LoaderOfComponentWithCustomCss"
+    c.layout = :fit
+    c.bbar = [:load_component_with_custom_css]
+  end
 
-  js_method :on_load_component_with_custom_css, <<-JS
+  js_configure do |c|
+    c.on_load_component_with_custom_css = <<-JS
     function(params){
-      this.loadComponent({name: 'component_with_custom_css'});
+      this.netzkeLoadComponent({name: 'component_with_custom_css', container: this});
     }
-  JS
+    JS
+  end
 end

data/test/core_test_app/app/components/localized_panel.rb

@@ -1,37 +1,35 @@
 class LocalizedPanel < Netzke::Base
-  # This action will be translated per-class basis if the translation is available, and fall back to the default when it's not.
+  # This action will be translated per-class basis if the translation is available, falling back to the default
   action :action_one
 
-  # If you want action's text to be inheritable, this is what you shold do:
-  action :action_two do
-    {:text => I18n.t('localized_panel.action_two')}
+  action :action_two do |a|
+    a.text = I18n.t('localized_panel.action_two')
   end
 
   action :action_three
 
-  js_translate :property_one, :property_two
+  js_configure do |c|
+    c.translate :property_one, :property_two
 
-  js_property :bbar, [:action_one.action, :action_two.action, :action_three.action]
+    c.on_render = <<-JS
+      function(ct){
+        Netzke.classes.LocalizedPanel.superclass.onRender.call(this, ct);
 
-  def configuration
-    super.tap do |c|
-      c[:title] = I18n.t('localized_panel.title')
-    end
-  end
-
-  js_method :on_render, <<-JS
-    function(ct){
-      Netzke.classes.LocalizedPanel.superclass.onRender.call(this, ct);
-
-      this.body.update(this.i18n.propertyOne + ", " + this.i18n.propertyTwo);
-    }
-  JS
+        this.body.update(this.i18n.propertyOne + ", " + this.i18n.propertyTwo);
+      }
+    JS
 
-  js_method :on_action_three, <<-JS
-    function(){
-      var mask = new Ext.LoadMask(this.body);
-      mask.show();
-    }
-  JS
+    c.on_action_three = <<-JS
+      function(){
+        var mask = new Ext.LoadMask(this.body);
+        mask.show();
+      }
+    JS
+  end
 
+  def configure(c)
+    super
+    c.title = I18n.t('localized_panel.title')
+    c.bbar = [:action_one, :action_two, :action_three]
+  end
 end

data/test/core_test_app/app/components/multipane_component_loader.rb

@@ -5,24 +5,23 @@ class MultipaneComponentLoader < Netzke::Base
   action :load_server_caller, :handler => :load_handler
   action :load_component_loader, :handler => :load_handler
 
-  def default_config
-    super.tap do |c|
-      c[:items] = [{
-        :title => "Container One",
-        :xtype => :panel,
-        :height => 200,
-        :flex => 1,
-        :border => true,
-        :bbar => [:load_server_caller.action, :load_component_loader.action],
-        :layout => :fit
-      },{
-        :title => "Container Two",
-        :xtype => :panel,
-        :height => 200,
-        :flex => 1,
-        :layout => :fit
-      }]
-    end
+  def configure(c)
+    super
+    c.items = [{
+      :title => "Container One",
+      :xtype => :panel,
+      :height => 200,
+      :flex => 1,
+      :border => true,
+      :bbar => [:load_server_caller, :load_component_loader],
+      :layout => :fit
+    },{
+      :title => "Container Two",
+      :xtype => :panel,
+      :height => 200,
+      :flex => 1,
+      :layout => :fit
+    }]
   end
 
   component :server_caller
@@ -30,7 +29,7 @@ class MultipaneComponentLoader < Netzke::Base
   js_method :load_handler, <<-JS
     function(button){
       var container = button.ownerCt.ownerCt;
-      this.loadNetzkeComponent({name: 'server_caller', container: container});
+      this.netzkeLoadComponent({name: 'server_caller', container: container});
     }
   JS
 
@@ -39,4 +38,4 @@ class MultipaneComponentLoader < Netzke::Base
     super
   end
 
-end
+end

data/test/core_test_app/app/components/nested_component.rb

@@ -1,10 +1,9 @@
+# FIXME
 class NestedComponent < Netzke::Base
   js_property :layout, :fit
 
-  def configuration
-    super.tap do |c|
-      c[:items] = [:child.component]
-    end
+  def configure(c)
+    c.items = [:child.component]
   end
 
   component :child,
@@ -15,4 +14,4 @@ class NestedComponent < Netzke::Base
       :grand_child_one => {:class_name => "SimpleComponent", :title => "Grand Child One"},
       :grand_child_two => {:class_name => "NestedComponent", :title => "Grand Child Two", :lazy_loading => true}
     }
-end
+end

data/test/core_test_app/app/components/panel_with_plugin.rb

@@ -1,4 +1,9 @@
 class PanelWithPlugin < Netzke::Base
-  plugin :some_plugin
-  plugin :plugin_with_components
-end
+  plugin :some_plugin do |c|
+    c.klass = SomePlugin
+  end
+
+  plugin :plugin_with_components do |c|
+    c.klass = PluginWithComponents
+  end
+end

data/test/core_test_app/app/components/panel_with_tools.rb

@@ -1,19 +1,20 @@
 class PanelWithTools < Netzke::Base
-  def configuration
-    super.tap do |c|
-      c[:tools] = [:refresh, :gear]
-    end
+  def configure(c)
+    super
+    c.tools = [:refresh, :gear]
   end
 
-  js_method :on_refresh, <<-JS
-    function(){
-      this.setTitle("Refresh" + " clicked");
-    }
-  JS
+  js_configure do |c|
+    c.on_refresh = <<-JS
+      function(){
+        this.setTitle("Refresh" + " clicked");
+      }
+    JS
 
-  js_method :on_gear, <<-JS
-    function(){
-      this.setTitle("Gear" + " clicked")
-    }
-  JS
+    c.on_gear = <<-JS
+      function(){
+        this.setTitle("Gear" + " clicked")
+      }
+    JS
+  end
 end

data/test/core_test_app/app/components/plugin_with_components.rb

@@ -1,14 +1,22 @@
 class PluginWithComponents < Netzke::Plugin
-  js_method :init, <<-JS
-    function(cmp){
-      this.cmp = cmp;
-      this.cmp.tools = this.cmp.tools || [];
-      this.cmp.tools.push({type: 'help', handler: function(){
-        var w = this.instantiateChildNetzkeComponent('simple_window');
-        w.show();
-      }, scope: this});
-    }
-  JS
+  js_configure do |c|
+    c.init = <<-JS
+      function(cmp){
+        this.cmp = cmp;
+        this.cmp.tools = this.cmp.tools || [];
+        this.cmp.tools.push({type: 'help', handler: function(){
+          // we can instantiate this because it was eagerly loaded
+          var w = this.netzkeInstantiateComponent('simple_window');
+          w.show();
+        }, scope: this});
+      }
+    JS
+  end
 
-  component :simple_window, :width => 300, :height => 200, :title => "Window created by PluginWithComponents"
-end
+  component :simple_window do |c|
+    c.width = 300
+    c.height = 200
+    c.title = "Window created by PluginWithComponents"
+    c.eager_loading = true
+  end
+end

data/test/core_test_app/app/components/scoped_components/deep_scoped_components/some_deep_scoped_component.rb

@@ -1,7 +1,10 @@
 module ScopedComponents
   module DeepScopedComponents
     class SomeDeepScopedComponent < ScopedComponents::SomeScopedComponent
-      js_properties :title => "Some Deep Scoped Component Title", :html => "Some Deep Scoped Component HTML"
+      js_configure do |c|
+        c.title = "Some Deep Scoped Component Title"
+        c.html = "Some Deep Scoped Component HTML"
+      end
     end
   end
-end
+end

data/test/core_test_app/app/components/scoped_components/extended_scoped_component.rb

@@ -1,5 +1,8 @@
 module ScopedComponents
   class ExtendedScopedComponent < SomeScopedComponent
-    js_properties :title => "Extended Scoped Component Title", :html => "Extended Scoped Component HTML"
+    js_configure do |c|
+      c.title = "Extended Scoped Component Title"
+      c.html = "Extended Scoped Component HTML"
+    end
   end
-end
+end

data/test/core_test_app/app/components/scoped_components/some_scoped_component.rb

@@ -1,5 +1,8 @@
 module ScopedComponents
   class SomeScopedComponent < Netzke::Base
-    js_properties :title => "Some Scoped Component Title", :html => "Some Scoped Component HTML"
+    js_configure do |c|
+      c.title = "Some Scoped Component Title"
+      c.html = "Some Scoped Component HTML"
+    end
   end
-end
+end

data/test/core_test_app/app/components/server_caller.rb

@@ -1,23 +1,45 @@
 class ServerCaller < Netzke::Base
-  title "Server Caller!"
-
   action :bug_server # Actual action's text is set in en.yml
+  action :no_response
+  action :multiple_arguments
+  action :array_as_argument
+
+  # this action is using generic endpoint callback with scope
+  action :call_with_generic_callback_and_scope
+
+  js_configure do |c|
+    c.title = "Server Caller"
+    c.html = "Wow"
+    c.mixin
+  end
+
+  def configure(c)
+    super
+    c.bbar = [:bug_server, :no_response, :multiple_arguments, :array_as_argument, :call_with_generic_callback_and_scope]
+
+    # Alternative way of defining bbar:
+    # c.docked_items = [{
+    #   xtype: :toolbar,
+    #   dock: :right,
+    #   items: [:bug_server, :no_response, :multiple_arguments, :array_as_argument]
+    # }]
+  end
 
-  js_properties(
-    :title => "Server Caller",
-    :html => "Wow",
-    :tbar => [:bug_server.action] # NOTE: used to be bbar, but Ext >= 4.0.2 has problems with rendering it!
-  )
-
-  js_method :on_bug_server, <<-JS
-    function(){
-      this.whatsUp();
-      this.update('You should see the response from the server in the title bar the very next moment');
-    }
-  JS
-
-  endpoint :whats_up do |params|
-    {:set_title => "All quiet here on the server"}
+  endpoint :whats_up do |params, this|
+    this.set_title("All quiet here on the server")
   end
 
+  endpoint :no_response do |params, this|
+  end
+
+  endpoint :multiple_arguments do |params, this|
+    this.take_two_arguments("First argument", "Second argument")
+  end
+
+  endpoint :array_as_argument do |params, this|
+    this.take_array_as_argument(['Element 1', 'Element 2'])
+  end
+
+  endpoint :do_nothing do |params,this|
+  end
 end

data/test/core_test_app/app/components/server_caller/javascripts/server_caller.js

@@ -0,0 +1,42 @@
+{
+  onBugServer: function(){
+    this.whatsUp();
+    this.update('You should see the response from the server in the title bar the very next moment');
+  },
+
+  onNoResponse: function(){
+    this.noResponse({}, function(){
+      this.update('Successfully called endpoint with no response (this is a callback)');
+    }, this);
+  },
+
+  onMultipleArguments: function(){
+    this.multipleArguments();
+  },
+
+  takeTwoArguments: function(first, second){
+    this.update("Called a function with two arguments: " + first + ", " + second);
+  },
+
+  onArrayAsArgument: function() {
+    this.arrayAsArgument();
+  },
+
+  takeArrayAsArgument: function(arry) {
+    var arryAsString = "['"+ arry.join("', '") + "']";
+    this.update("Called a function with array as arguments: " + arryAsString);
+  },
+
+  onCallWithGenericCallbackAndScope: function(){
+    var that=this;
+    var fancyScope={
+      setFancyTitle: function () {
+        that.setTitle("Fancy title" + " set!");
+      }
+    };
+    this.doNothing({}, function () {
+      this.setFancyTitle();
+    }, fancyScope);
+  },
+
+}

data/test/core_test_app/app/components/server_counter.rb

@@ -6,107 +6,43 @@ class ServerCounter < Netzke::Base
   action :do_ordered # used for test if call order is preserved
   action :fail_two_out_of_five # sends 5 requests, 2 will fail, but the request should be processed in order
 
-  js_properties(
-    :title => "Server Counter",
-    :bbar => [:count_one_time.action, :count_seven_times.action, :count_eight_times_special.action, :fail_in_the_middle.action, :do_ordered.action, :fail_two_out_of_five.action]
-  )
-
-  js_method :on_count_one_time, <<-JS
-    function(){
-      this.count({how_many: 1});
-    }
-  JS
-
-  js_method :init_component, <<-JS
-    function () {
-      #{js_full_class_name}.superclass.initComponent.call(this);
-      Ext.Ajax.on('beforerequest',function (conn, options ) {
-        Netzke.connectionCount = Netzke.connectionCount || 0;
-        Netzke.connectionCount++;
-        Netzke.lastOptions=options;
-      });
-    }
-  JS
-
-  js_method :on_count_seven_times, <<-JS
-    function(){
-      for(var i=0; i<7; i++)
-        this.count({how_many: 1});
-    }
-  JS
-
-  js_method :on_count_eight_times_special, <<-JS
-    function(){
-      for(var i=0;i<8;i++)
-        this.count({how_many: 1, special: true});
-    }
-  JS
-
-  # TODO: is it actually meant to succeed and display "Something succeeded"?..
-  js_method :on_fail_in_the_middle, <<-JS
-    function() {
-      this.successingEndpoint();
-      this.failingEndpoint();
-      this.successingEndpoint();
-    }
-  JS
-
-  js_method :on_do_ordered, <<-JS
-    function () {
-      this.firstEp();
-      this.secondEp();
-    }
-  JS
-
-  js_method :update_appending, <<-JS
-    function(html){
-      if (!this.panelText) { this.panelText = ""; }
-      this.panelText += html + ",";
-      this.body.update(this.panelText);
-    }
-  JS
-
-  js_method :on_fail_two_out_of_five, <<-JS
-    function(){
-      for(var i=1; i<=5; i++) {
-        this.failTwoOutOfFive(i);
-      }
-    }
-  JS
+  js_configure do |c|
+    c.mixin
+  end
 
-  def before_load
-    component_session[:is_retry] = false
-    component_session[:count] = 0
+  def configure(c)
+    super
+    c.bbar = [:count_one_time, :count_seven_times, :count_eight_times_special, :fail_in_the_middle, :do_ordered, :fail_two_out_of_five]
+    c.title "Server Counter"
   end
 
-  endpoint :count do |params|
+  endpoint :count do |params, this|
     component_session[:count] ||= 0
     component_session[:count] += params[:how_many]
-    {:update => "I am at " + component_session[:count].to_s + (params[:special] ? ' and i was invoked specially' : '')}
+    this.update_content("I am at " + component_session[:count].to_s + (params[:special] ? ' and i was invoked specially' : ''))
   end
 
-  endpoint :successing_endpoint do |params|
-    {:update  => "Something successed "}
+  endpoint :successing_endpoint do |params, this|
+    this.update_content("Something successed ")
   end
 
-  endpoint :failing_endpoint do |params|
+  endpoint :failing_endpoint do |params, this|
     throw "something happened"
-    {:update => "This will never get returned"}
   end
 
-  endpoint :first_ep do |params|
+  endpoint :first_ep do |params, this|
     component_session[:count]||=0
     component_session[:count]+=1
-    {:update => "First. "+ component_session[:count].to_s}
+    this.update_content("First. "+ component_session[:count].to_s)
   end
 
-  endpoint :second_ep do |params|
+  endpoint :second_ep do |params, this|
     component_session[:count]||=0
     component_session[:count]+=1
-    {:update => "Second. "+ component_session[:count].to_s}
+    this.update_content("Second. "+ component_session[:count].to_s)
   end
 
-  endpoint :fail_two_out_of_five do |count|
+  endpoint :fail_two_out_of_five do |count, this|
     component_session[:count] ||= 0
     component_session[:count] += 1
 
@@ -117,7 +53,7 @@ class ServerCounter < Netzke::Base
     end
 
     component_session[:is_retry] = false
-    {:update_appending => count}
+    this.update_appending(count)
   end
 
 end