netzke-core 0.12.3 → 1.0.0.0.pre

data/Gemfile

@@ -2,7 +2,7 @@ source 'http://rubygems.org'
 
 gemspec
 
-gem 'rails', '4.2.0'
+gem 'rails', '~>4.2.0'
 gem 'sqlite3'
 gem 'yard'
 gem 'rake'

data/LICENSE

@@ -1,7 +1,3 @@
-Copyright (c) 2012 nomadcoder
+Copyright (c) 2009-2015 Good Bit Labs Limited
 
-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.
+GPLv3 License: http://www.gnu.org/licenses/gpl-3.0.en.html

data/README.md

@@ -1,116 +1,16 @@
-# Netzke Core [![Gem Version](https://fury-badge.herokuapp.com/rb/netzke-core.png)](http://badge.fury.io/rb/netzke-core) [![Build Status](https://travis-ci.org/netzke/netzke-core.png?branch=master)](https://travis-ci.org/netzke/netzke-core) [![Code Climate](https://codeclimate.com/github/netzke/netzke-core.png)](https://codeclimate.com/github/netzke/netzke-core)
+# Netzke Core [![Build Status](https://travis-ci.org/netzke/netzke-core.svg?branch=master)](https://travis-ci.org/netzke/netzke-core) [![Code Climate](https://codeclimate.com/github/netzke/netzke-core/badges/gpa.svg)](https://codeclimate.com/github/netzke/netzke-core)
 
-[RDocs](http://rdoc.info/projects/netzke/netzke-core)
+[RDocs](http://www.rubydoc.info/projects/netzke/netzke-core)
 
 Netzke Core is the bare bones of the [Netzke framework](http://netzke.org). For pre-built full-featured components (like grids, forms, tab/accordion panels, etc), see [netzke-basepack](http://github.com/netzke/netzke-basepack).
 
-Some knowledge of Sencha Ext JS will be needed in order to fully understand this overview.
+*Notes on versioning:*
 
-## Rationale
+* The latest *released* version is: [![Gem Version](https://badge.fury.io/rb/netzke-basepack.svg)](https://badge.fury.io/rb/netzke-basepack)
+* The version under development (master): [version.rb](https://github.com/netzke/netzke-core/blob/master/lib/netzke/core/version.rb)
+* For other versions check corresponding [branches](https://github.com/netzke/netzke-core/branches)
 
-[Sencha Ext JS]("http://www.sencha.com/products/extjs") is a powerful front-end framework, which is used for crafting web-apps that give the end user experience similar to that of a desktop application. It has an extensive set of widgets ('components'), and leverages a modular approach to its fullest: a developer can extend components (using Ext JS's own [class system]("http://docs.sencha.com/ext-js/4-1/#!/guide/class_system")), nest components using many powerful layouts, dynamically create and destroy them. The architecture of Ext JS is well thought out and very complete.
-
-However, with Ext JS being server-agnostic, it is not always a trivial task for a developer to bind Ext JS components to the server-side data *and* application business logic, especially in complex applications. Netzke as the solution that allows you to extend the modular approach to the server side.
-
-Netzke Core takes the burden of implementing the following key aspects of the framework:
-
-* Client-side (JavaScript) class generation
-* Client-server communication
-* Convenient declaration of Ext actions
-* Extendibility of components (class inheritance and mixins)
-* Unlimited nesting (composition)
-* Dynamic component loading
-* Client-side class caching
-* Inclusion of extra JavaScript and CSS files
-
-...and more.
-
-All this extremely facilitates building fast, low-traffic, robust, and highly maintainable applications. As a result, your code scales much better in the sense of complexity, compared to using conventional MVC, where developers are pretty much limited with the programming techniques that they can apply.
-
-## HelloWorld component
-
-*This component is distributed as a part of the test application, see `spec/rails_app/components/hello_world.rb`.*
-
-Ext JS files are not distributed with Netzke, so, make sure that they are located in (or sym-linked as) `YOUR_APP/public/extjs`.
-
-In `YOUR_APP/components/hello_world.rb`:
-
-```ruby
-class HelloWorld < Netzke::Base
-  # Configure client class
-  js_configure do |c|
-    c.title = "Hello World component"
-    c.mixin # mix in methods from hello_world/javascripts/hello_world.js
-  end
-
-  # Actions are used by Ext JS to share functionality and state b/w buttons and menu items
-  # The handler for this action should be called onPingServer by default
-  action :ping_server
-
-  # Self-configure with a bottom toolbar
-  def configure(c)
-    super
-    c.bbar = [:ping_server] # embed the action into bottom toolbar as a button
-  end
-
-  # Endpoint callable from client class
-  endpoint :greet_the_world do |params,this|
-    # call client class' method showGreeting
-    this.show_greeting("Hello World!")
-  end
-end
-```
-
-In `YOUR_APP/components/hello_world/javascripts/hello_world.js` put the client class (JavaScript) methods:
-
-```javascript
-{
-  // handler for the ping_server action
-  onPingServer: function(){
-    // calling greet_the_world endpoint
-    this.greetTheWorld();
-  },
-
-  // called by the server as the result of executing the endpoint
-  showGreeting: function(greeting){
-    this.update("Server says: " + greeting);
-  }
-}
-```
-
-To embed the component in Rails view:
-
-Add `netzke` routes:
-
-```ruby
-# in routes.rb
-RailsApp::Application.routes.draw do
-  netzke
-  ...
-end
-```
-
-Use `load_netzke` in the layout to include Ext JS and Netzke scripts and stylesheets:
-
-```erb
-<!DOCTYPE html>
-<html>
-<head>
-  <meta http-equiv="Content-type" content="text/html; charset=utf-8">
-  <%= csrf_meta_tag %>
-  <%= load_netzke %>
-</head>
-<body>
-  <%= yield %>
-</body>
-</html>
-```
-
-Embed the component in the Rails view:
-
-```erb
-<%= netzke :hello_world %>
-```
+For rationale and mini-tutorial, refer to the meta gem's [README](https://github.com/netzke/netzke). The README you're reading explains the Netzke architecture in detail. Some knowledge of Sencha Ext JS may be required to fully understand this overview.
 
 ## What is a Netzke component
 
@@ -129,17 +29,16 @@ your_web_app
       my_component.rb             <-- the Ruby class
       my_component
         some_module.rb            <-- optional extra Ruby code
-        javascripts
+        client
           some_dependency.js      <-- optional external JS library
-          init_component.js       <-- optional mixins to the client class
-          extra_functionality.js  <-- more mixins (mixin-in may depend on component class configuration)
-        stylesheets
+          init_component.js       <-- optional override ("include") to the client class
+          extra_functionality.js  <-- more override
           my_special_button.css    <-- optional custom CSS
 ```
 
 ## Client class
 
-The generated client class is *inherited* (as defined by the Ext JS [class system]("http://docs.sencha.com/ext-js/4-1/#!/guide/class_system")) from an Ext JS class, which by default is [Ext.panel.Panel]("http://docs.sencha.com/ext-js/4-1/#!/api/Ext.panel.Panel"). For example, a component defined like this:
+The generated client class is *inherited* (as defined by the Ext JS class system) from an Ext JS class, which by default is `Ext.panel.Panel`. For example, a component defined like this:
 
 ```ruby
 class HelloWorld < Netzke::Base
@@ -149,10 +48,10 @@ end
 will have the following client class generated by Netzke (simplified):
 
 ```javascript
-Ext.define('Netzke.classes.HelloWorld', {"extend":"Ext.panel.Panel", "mixins":["Netzke.classes.Core.Mixin"]});
+Ext.define('Netzke.classes.HelloWorld', {"extend":"Ext.panel.Panel", "mixins":["Netzke.Base"]});
 ```
 
-`Netzke.classes.Core.Mixin` contains a set of client class methods and properties common to every Netzke component.
+`Netzke.Base` contains a set of client class methods and properties common to every Netzke component.
 
 Extending `HelloWorld` will be automatically reflected on the client-class level:
 
@@ -167,18 +66,23 @@ will have the following client class generated (simplified):
 Ext.define('Netzke.classes.HelloNewWorld', {"extend":"Netzke.classes.HelloWorld"});
 ```
 
-The configuration of a client-class is done by using the `Netzke::Base.js_configure`. For example, in order to inherit from a different Ext JS component, and to mix in the methods defined in an external JavaScript class:
+Configuration of the client-class can be done by using the `Netzke::Base.client_class`. For example, in order to inherit from a different Ext JS component, and to mix in the methods defined in the `client` subfolder:
 
 ```ruby
 class MyTabPanel < Netzke::Base
-  js_configure do |c|
+  client_class do |c|
     c.extend = "Ext.tab.Panel"
-    c.mixin :extra_functionality
+    c.include :extra_functionality
   end
 end
 ```
 
-For more details on defining the client class, refer to [Netzke::Core::ClientClass](http://rdoc.info/github/netzke/netzke-core/Netzke/Core/ClientClass).
+The code above will set the `extend` property to "Ext.tab.Panel", and will mix in the following scripts:
+
+  * `app/components/my_tab_panel/client/my_tab_panel.js` (if that exists)
+  * `app/components/my_tab_panel/client/extra_functionality.js`
+
+For more details on defining the client class, refer to [Netzke::Core::ClientClassConfig](http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/ClientClassConfig).
 
 ## Composition
 
@@ -216,15 +120,15 @@ Next to being statically nested in the layout, a child component can also be dyn
 
     this.netzkeLoadComponent('users');
 
-this will load the "users" component and [add](http://docs.sencha.com/ext-js/4-1/#!/api/Ext.container.Container-method-add) it to the current container.
+this will load the "users" component and add it to the current container.
 
-For more details on dynamic component loading refer to inline docs of [javascript/ext.js](https://github.com/netzke/netzke-core/blob/master/javascripts/ext.js).
+For more details on dynamic component loading refer to [netzkeLoadComponent docs](http://api.netzke.org/client/classes/Netzke.Base.html#method_netzkeLoadComponent).
 
-For more details on composition refer to [Netzke::Core::Composition](http://rdoc.info/github/netzke/netzke-core/Netzke/Core/Composition).
+For more details on composition refer to [Netzke::Core::Composition](http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/Composition).
 
 ## Actions, toolbars, and menus
 
-Actions are [used by Ext JS]("http://docs.sencha.com/ext-js/4-1/#!/api/Ext.Action") to share functionality and state among multiple buttons and menu items. Define actions with the `action` class method:
+Actions are used by Ext JS to share functionality and state among multiple buttons and menu items. Define actions with the `action` class method:
 
 ```ruby
 action :show_report do |c|
@@ -250,11 +154,11 @@ Actions can also be referred to is submenus:
   c.tbar = [{text: 'Menu', menu: {items: [:show_report]}}]
 ```
 
-For more details on composition refer to [Netzke::Core::Actions](http://rdoc.info/github/netzke/netzke-core/Netzke/Core/Actions).
+For more details on composition refer to [Netzke::Core::Actions](http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/Actions).
 
 ## Client-server interaction
 
-Communication between the client class and the corresponding server class is done by means of defining *endpoints*. By defining an endpoint on the server, the client class automatically gets a method that is used to call the server.
+Communication between the client class and the corresponding server class is done by means of defining *endpoints*. By defining an endpoint on the server, the client class automatically gets access to an equally named method that calls the server.
 
 ### Calling an endpoint from client class
 
@@ -262,40 +166,54 @@ By defining an endpoint like this:
 
 ```ruby
 class SimpleComponent < Netzke::Base
-  endpoint :whats_up_server do |params, this|
+  endpoint :whats_up do |greeting|
   # ...
   end
 end
 ```
 
-...the client class will obtain a method called `whatsUpServer`:
+...the client class will obtain a method called `whatsUp`, that can be called on the `this.server` object like this:
 
 ```javascript
-this.whatsUpServer(params, callback, scope);
+this.server.whatsUp(greeting, callback, scope);
 ```
 
-Parameters:
+The last 2 params are optional:
+
+* `callback` - function to be called after the server successfully processes the endpoint call; the function will receive, as its only argument, the result of the `endpoint` block execution
+* `scope` - context in which the callback function will be called; defaults to the component's instance
+
+As of version 1.0, the endpoint may receive an arbitrary number of arguments, for example:
 
-* `params` will be passed to the endpoint block as the first parameter
-* `callback` (optional) receives a function to be called after the server successfully processes the endpoint call
-* `scope` (optional) is the scope in which the callback function will be called
+```javascript
+this.server.doSomething('value 1', true, callback, scope);
+```
+
+```ruby
+class SimpleComponent < Netzke::Base
+  endpoint :do_something do |arg_1, arg_2|
+    # arg_1 == 'value 1'
+    # arg_2 == true
+  end
+end
+```
 
 ### Calling client class methods from endpoint
 
-An endpoint can instruct the client class to execute a set of methods after its execution, passing those methods arbitrary parameters. For example:
+An endpoint can instruct the client instance of the component to execute a set of methods in response, passing those methods arbitrary parameters, by using the `client` method. For example:
 
 ```ruby
 class SimpleComponent < Netzke::Base
-  endpoint :whats_up_server do |params, this|
-    this.set_title("Response from server")
-    this.my_method
+  endpoint :whats_up_server do
+    client.set_title("Response from server")
+    client.my_method
   end
 end
 ```
 
-Here the client class will call its `setTitle` method (defined in `Ext.panel.Panel`) with parameter passed from the endpoint. Then a custom method `myMethod` will be called with no parameters.
+Here the client class will first call its `setTitle` method (defined in `Ext.panel.Panel`) with parameter passed from the endpoint. Then a custom method `myMethod` will be called with no parameters.
 
-For more details on client-server communication see [Netzke::Core::Services]("http://rdoc.info/github/netzke/netzke-core/Netzke/Core/Services").
+For more details on client-server communication see [Netzke::Core::Services]("http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/Services").
 
 ## Icons support
 
@@ -311,17 +229,33 @@ end
 
 The logout action will be configured with `public/assets/icons/door.png` as icon.
 
-For more details on using icons refer to [Netzke::Core::Actions]("http://rdoc.info/github/netzke/netzke-core/Netzke/Core/Actions").
+For more details on using icons refer to [Netzke::Core::Actions]("http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/Actions").
 
 ## I18n
 
 Netzke Core will automatically include Ext JS localization files based on current `I18n.locale`.
 
-Also, Netzke Core uses some conventions for localizing actions. Refer to [Netzke::Core::Actions](http://rdoc.info/github/netzke/netzke-core/Netzke/Core/Actions).
+Also, Netzke Core uses some conventions for localizing actions. Refer to [Netzke::Core::Actions](http://www.rubydoc.info/github/netzke/netzke-core/Netzke/Core/Actions).
+
+## Routing
+
+Any Netzke component can react on a specific hash-route in the URL, which can be achieved by specifying `netzkeRoutes`
+hash on the client class, similarly to how Ext JS handles routes in its controllers:
 
-## HAML support (experimental)
+    // e.g. in my_component/client/my_component.js
+    {
+      netzkeRoutes: {
+        'users': 'onUsers',
+        'users/:id': 'onUser'
+      },
 
-Netzke provides support for HAML templates in case you don't want to put HTML into Ruby files.
+      onUsers: function() {},
+
+      onUser: function(userId) {},
+    }
+
+If a component gets loaded dynamically and it figures out that one of its routes is currently active, it'll trigger the
+corresponding handler after being rendered.
 
 ## Requirements
 
@@ -374,10 +308,8 @@ If you feel particularily generous, you can support the author by donating a cou
 ## Useful links
 
 * [Project website](http://netzke.org)
-* [Live demo](http://netzke-demo.herokuapp.com) (features [Netzke Basepack](https://github.com/netzke/netzke-basepack), with sample code)
+* [Live demo](http://demo.netzke.org) (features [Netzke Basepack](https://github.com/netzke/netzke-basepack), with sample code)
 * [Twitter](http://twitter.com/netzke) - latest news about the framework
 
 ---
-© 2008-2015 [Max Gorin](https://twitter.com/mxgrn), released under the MIT license (see LICENSE).
-
-**Note** that Ext JS is licensed [differently](http://www.sencha.com/products/extjs/license/), and you may need to purchase a commercial license in order to use it in your projects!
+Copyright (c) 2009-2015 [Good Bit Labs](http://goodbitlabs.com/), released under the GPLv3 license