extjs-mvc 0.2.7 → 0.2.8

data/README.rdoc

@@ -1,22 +1,22 @@
 = mvc
 
-
 A collection of helpers, MVC mixins and PORs (plain-old-ruby-object) to assist with auto-generating ExtJS Stores (Ext.data.Store) including its associated DataReader (Ext.data.JsonReader, Ext.data.XmlReader) and DataWriter (Ext.data.JsonWriter, Ext.data.XmlWriter).  Also contains a helper for rendering javascript component definitions via partials.
 
+See tutorial http://www.extjs.com/blog/2009/09/30/ext-js-on-rails-a-comprehensivetutorial/
 
 ===Installation
 	% sudo gem install gemcutter
 	% gem tumble   (only have to do this once, adds gemcutter as primary gem-source)
-    % sudo gem install extjs-mvc
+	% sudo gem install extjs-mvc
 
-<p><b>Rails Installation:</b></p>
+<b>Rails Installation:</b>
 In <tt>environment.rb</tt>, 
 
     Rails::Initializer.run do |config|
         config.gem "extjs-mvc"
     end
 
-<p><b>Merb installation:</b></p>
+<b>Merb installation:</b>
 In <tt>config/dependencies.rb</tt>, Add extjs-mvc as a new dependency
 	
 	dependency "extjs-mvc"
@@ -27,22 +27,23 @@ extjs-mvc contains Model mixin named <tt>ExtJS::Model</tt> which works for <b>th
 Simply include the mixin into 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]
-      # OR 
-      extjs_fields :name, :description
-      # OR define a column as a Hash
-	  extjs_fields :description, :name => {"sortDir" => "ASC"}, :created_at => {"dateFormat" => "c"}
-	  #
-      extjs_fields :name, :description, :parent => [:name, :date]
-      # this would configure associated columns with names like:
- 		[...{name: "parent_name", mapping: "parent.name"}, {name: "parent_date", mapping: "parent.date"}...]
-    end
+  class User < ActiveRecord::Base
+    include ExtJS::Model
 
-In <tt>irb</tt> console:
-    >> User.extjs_fields
+    extjs_fields :exclude => [:password, :password_confirmation]
+    
+    # OR 
+    extjs_fields :name, :description
+    
+    # OR define a column as a Hash
+    extjs_fields :description, :name => {"sortDir" => "ASC"}, :created_at => {"dateFormat" => "c"}
+	
+    # OR render associations, association-fields will have their "mapping" property set automatically
+    extjs_fields :name, :description, :company => [:name, :description]
+    
+  end
+
+After including the model mixin <tt>ExtJS::Model</tt>, try typing the following in <tt>irb</tt> console:
     >> User.extjs_record
     => { "idProperty"=>"id", "fields"=>[
          {:type=>:int, :allowBlank=>true, :name=>"id"},
@@ -51,8 +52,10 @@ In <tt>irb</tt> console:
          {:type=>:string, :allowBlank=>false, :name=>"email"}
        ]}
 
+An auto-generated <tt>Ext.data.JsonReader</tt> configuration!
+
 === An ActionController mixin:  ExtJS::Controller
-The <tt>extjs-mvc</tt> Gem includes a framework agnostic Controller mixin which works with both Rails and Merb.
+The <tt>extjs-mvc</tt> Gem includes a framework agnostic Controller mixin which works with both Rails and Merb.  Include this mixin into any controller which will need to generate an <tt>Ext.data.Store</tt>.
 <b>usage:</b>
 
     class UsersController < ActionController::Base
@@ -71,13 +74,13 @@ The <tt>extjs-mvc</tt> Gem includes a framework agnostic Controller mixin which
 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)
+      "xtype" => "viewport",
+      "frame" => true,
+      "layout" => "border")
+    @viewport.add("xtype" => "panel", "contentEl" => "hd", "region" => "north", "height" => 30)
+    @viewport.add(:partial => "/users/grid", "itemId" => "users-grid", "region" => "west")
+    @viewport.add(:partial => "/tasks/grid", "itemId" => "tasks-grid", "region" => "center")
+    @viewport.add("xtype" => "panel", "contentEl" => "ft", "region" => "south", "height" => 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
@@ -93,12 +96,13 @@ Renders an  Ext.data.Store with helper method <tt>extjs_store</tt>
       helper ExtJS::Helpers::Store
     end
 
+Now render a store in an erb template:
 
     @store = extjs_store(
       :controller => "users",
       :proxy => "http"  # <-- default
       :format => "json" # <-- default
-      :model => "user", # <-- default: controller_name.singularize.camelize.constantize
+      :model => "user", # <-- default: controller_name.singularize
       :writer => {:encode => false},
       :config => {      # <-- standard Ext.data.Store config-params
         "autoLoad" => true

data/VERSION

@@ -1 +1 @@
-0.2.7
+0.2.8

data/lib/extjs-mvc.rb

@@ -36,3 +36,9 @@ module ExtJS
 
    end
 end
+
+#require 'test/macros'
+
+#class ActiveSupport::TestCase < Test::Unit::TestCase
+#  extend ExtJS::TestMacros
+#end

data/lib/model/active_record.rb

@@ -34,7 +34,7 @@ module ExtJS
       def extjs_type(col)
         type = col.type
         case type
-          when :datetime || :date || :time || :timestamp
+          when :datetime, :date, :time, :timestamp
             type = :date
           when :text
             type = :string
@@ -55,7 +55,7 @@ module ExtJS
           @extjs_associations = {}
           self.reflections.keys.each do |key|
             assn = self.reflections[key]
-            type = (assn.macro === :has_many) ? :many : assn.macro
+            type = (assn.macro === :has_many || assn.macro === :has_and_belongs_to_many) ? :many : assn.macro
             @extjs_associations[key.to_sym] = {
               :name => key, 
               :type => type, 

data/lib/model/base.rb

@@ -30,20 +30,24 @@ module ExtJS
       # @params {Mixed} params A list of fields to use instead of this Class's extjs_record_fields
       #
       def to_record(*params)
+        if self.class.extjs_record_fields.empty?
+          self.class.extjs_fields(*self.class.extjs_column_names)
+        end
         
         fields  = (params.empty?) ? self.class.extjs_record_fields : self.class.process_fields(*params)
         assns   = self.class.extjs_associations
         pk      = self.class.extjs_primary_key
         
         # build the initial field data-hash
-        data    = {pk => self.send(pk)}
+        data    = {pk.to_s => self.send(pk)}
          
         fields.each do |field|
           if refl = assns[field[:name]] || assns[field[:name].to_sym]
             if refl[:type] === :belongs_to
               assn = self.send(field[:name])
+              
               if assn.respond_to?(:to_record)
-                data[field[:name]] = assn.send(:to_record, *[field[:fields]])
+                data[field[:name]] = assn.to_record field[:fields]
               elsif (field[:fields])
                 data[field[:name]] = {}
                 field[:fields].each do |property|
@@ -52,6 +56,8 @@ module ExtJS
               else
                 data[field[:name]] = {} # belongs_to assn that doesn't respond to to_record and no fields list
               end
+              # Append associations foreign_key to data
+              data[refl[:foreign_key].to_s] = self.send(refl[:foreign_key])
             elsif refl[:type] === :many
               data[field[:name]] = self.send(field[:name]).collect {|r| r.to_record}  #CAREFUL!!!!!!!!!!!!1
             end
@@ -91,13 +97,13 @@ module ExtJS
           elsif assn = associations[field[:name]] || associations[field[:name].to_sym]
             assn_fields = field.delete(:fields) || nil
             if assn[:class].respond_to?(:extjs_record)  # <-- exec extjs_record on assn Model.
-              record = assn[:class].send(:extjs_record, *[assn_fields])
+              record = assn[:class].extjs_record(assn_fields)
               rs.concat(record["fields"].collect {|assn_field| 
-                extjs_field(assn_field, :mapping => field[:name])
+                extjs_field(assn_field, :mapping => field[:name], "allowBlank" => true) # <-- allowBlank on associated data?
               })
             elsif assn_fields  # <-- :parent => [:id, :name]
               rs.concat(assn_fields.collect {|assn_field| 
-                extjs_field(assn_field, :mapping => field[:name])
+                extjs_field(assn_field, :mapping => field[:name], "allowBlank" => true)
               })
             else  
               rs << extjs_field(field)
@@ -144,9 +150,9 @@ module ExtJS
         # This is to handle the case where extjs_record and to_record are called recursively, in which case
         # these fields have already been processed.
         #
-        if params.length === 1 && params.first.kind_of?(Array) && !params.first.empty?
-          return params.first
-        end
+        #if params.length === 1 && params.first.kind_of?(Array) && !params.first.empty?
+        #  return params.first
+        #end
         
         fields = []
         if !options.keys.empty?
@@ -172,9 +178,14 @@ module ExtJS
         end
         
         unless params.empty?
-          fields.concat(params.collect {|f|
-            {:name => f.to_s}
-          })
+          params = params.first if params.length == 1 && params.first.kind_of?(Array) && !params.first.empty?
+          params.each do |f|
+            if f.kind_of?(Hash)
+              fields << f
+            else
+              fields << {:name => f.to_s}
+            end
+          end
         end
         fields
       end

data/lib/model/mongo_mapper.rb

@@ -7,25 +7,25 @@ module ExtJS
     # ClassMethods
     #
     module ClassMethods
-      
+
       def extjs_primary_key
         :_id
       end
-      
+
       def extjs_column_names
         self.column_names
       end
-      
+
       def extjs_columns_hash
         self.keys
       end
-      
+
       def extjs_associations
         if @extjs_associations.nil?
           @extjs_associations = {}
           self.associations.keys.each do |key|
             @extjs_associations[key.to_sym] = {
-              :name => key, 
+              :name => key,
               :type => self.associations[key].type,
               :class => self.associations[key].class_name.constantize,
               :foreign_key => self.associations[key].foreign_key
@@ -34,7 +34,7 @@ module ExtJS
         end
         @extjs_associations
       end
-      
+
       def extjs_type(col)
         type = col.type.to_s
         case type
@@ -50,9 +50,9 @@ module ExtJS
             type = "auto"
         end
       end
-      
+
       def extjs_allow_blank(col)
-        (col.name === '_id') ? true : (col.options[:required] === true) ? false : true
+        (col.name == '_id') || (col.options[:required] != true)
       end
     end
   end

data/lib/test/macros.rb

@@ -0,0 +1,20 @@
+module ExtJS
+  module TestMacros
+    ##
+    # Asserts that the passed list of fields are specified in the extjs_fields call
+    # in the model class.
+    # @fields {Symbols} fields A list of fields
+    #
+    def should_have_extjs_fields *fields
+      klass = model_class
+      should "have the correct extjs_fields" do
+        fields.each do |field|
+          found_record = klass.extjs_record_fields.find do|record_field|
+            record_field[:name] == field.to_s
+          end
+          assert_not_nil found_record, "extjs field #{field} isn't listed in the #{klass.name} model"
+        end
+      end
+    end
+  end
+end

data/test/database.yml

@@ -0,0 +1,3 @@
+test:
+  adapter: sqlite3
+  database: ":memory:"