extjs-mvc 0.1.23 → 0.1.24

data/README.rdoc

@@ -1,9 +1,103 @@
 = mvc
 
-Description goes here.
+A collection of helpers, MVC mixins and PORs (plain-old-ruby-object) to assist with auto-generating ExtJS javascript component definitions.
+
+
+===Installation
+
+    % gem sources -a http://gems.github.com (you only have to do this once)
+    % sudo gem install extjs-mvc
+
+In <tt>environment.rb</tt>
+
+    Rails::Initializer.run do |config|
+        .
+        .
+        .
+    end
+    require 'extjs-mvc'
+
+
+=== An ActiveRecord mixin:  ExtJS::Model
+
+include it in your model.  Use the class-method <tt>extjs_fields</tt> to specify those
+fields with will be used to render the <tt>Ext.data.Record.create</tt> field-def'n.
+    class User < ActiveRecord::Base
+      include ExtJS::Model
+
+      extjs_fields :exclude => [:password, :password_confirmation]
+    end
+
+In script/console
+    >> User.extjs_fields
+    >> User.extjs_record
+    => { "idProperty"=>"id", "fields"=>[
+         {:type=>:int, :allowBlank=>true, :name=>"id"},
+         {:type=>:string, :allowBlank=>false, :name=>"first"},
+         {:type=>:string, :allowBlank=>false, :name=>"last"},
+         {:type=>:string, :allowBlank=>false, :name=>"email"}
+       ]}
+
+=== An ActionController mixin:  ExtJS::Controller
+
+<b>usage:</b>
+
+    class UsersController < ActionController::Base
+        include ExtJS::Controller
+    end
+
+=== View Helper:  ExtJS::Helpers::Component
+
+<b>usage:</b>
+
+    class UserController < ActionController::Base
+      include ExtJS::Controller
+      helper ExtJS::Helpers::Component
+    end
+
+Now render Ext components using helper method <tt>extjs_component</tt>
+
+    @viewport = extjs_component(
+      "xtype" =&gt; "viewport",
+      "frame" =&gt; true,
+      "layout" =&gt; "border")
+    @viewport.add("xtype" =&gt; "panel", "contentEl" =&gt; "hd", "region" =&gt; "north", "height" =&gt; 30)
+    @viewport.add(:partial =&gt; "/users/grid", "itemId" =&gt; "users-grid", "region" =&gt; "west")
+    @viewport.add(:partial =&gt; "/tasks/grid", "itemId" =&gt; "tasks-grid", "region" =&gt; "center")
+    @viewport.add("xtype" =&gt; "panel", "contentEl" =&gt; "ft", "region" =&gt; "south", "height" =&gt; 20)
+
+Note how it can also render partials.  Partials will be invoked with a local-variable named "container", a reference to the
+parent Ext::Component instance which added the partial.  If no "container" is specified, it would be expected that your partial
+would provide its own "renderTo" or "contentEl" property, just as in Ext.Component from ExtJS javascript library.
+
+
+=== View Helper:  ExtJS::Helpers::Store
+
+Renders an  Ext.data.Store with helper method <tt>extjs_store</tt>
+
+    class UserController < ActionController::Base
+      include ExtJS::Controller
+      helper ExtJS::Helpers::Store
+    end
+
+
+    @store = extjs_store(
+      :controller => "users",
+      :proxy => "http"  # <-- default
+      :format => "json" # <-- default
+      :model => "user", # <-- default: controller_name.singularize.camelize.constantize
+      :writer => {:encode => false},
+      :config => {      # <-- standard Ext.data.Store config-params
+        "autoLoad" => true
+        "autoSave" => true
+      }
+    )
+
+    %= @store.render %
+
 
 == Note on Patches/Pull Requests
- 
+
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a

data/VERSION

@@ -1 +1 @@
-0.1.23
+0.1.24

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: extjs-mvc
 version: !ruby/object:Gem::Version 
-  version: 0.1.23
+  version: 0.1.24
 platform: ruby
 authors: 
 - Chris Scott
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-09-07 00:00:00 -07:00
+date: 2009-09-08 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency