mvc 0.1.29

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Chris Scott
+
+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.

data/README.rdoc

@@ -0,0 +1,112 @@
+= mvc
+
+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
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but
+   bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2009 Chris Scott. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,60 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "mvc"
+    gem.summary = %Q{Ruby tools for ExtJS development}
+    gem.description = %Q{MVC tools to assist with ExtJS development in Rails and Merb}
+    gem.email = "christocracy@gmail.com"
+    gem.homepage = "http://github.com/extjs/mvc"
+    gem.authors = ["Chris Scott"]
+    gem.add_development_dependency "thoughtbot-shoulda"
+    gem.test_files = []
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*", 'lib/jeweler/templates/.gitignore']
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+end
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION')
+    version = File.read('VERSION')
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "mvc #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.29

data/lib/action_controller/controller.rb

@@ -0,0 +1,55 @@
+module ExtJS::Controller
+
+  def self.included(controller)
+    controller.send(:extend, ClassMethods)
+  end
+
+  ##
+  # Controller class methods
+  #
+  module ClassMethods
+
+    def extjs_reader(model)
+      {
+        "successProperty" => extjs_success_property,
+        "root" => extjs_root,
+        "messageProperty" => extjs_message_property
+      }.merge(model.extjs_record)
+    end
+
+    def extjs_proxy(params)
+      proxy = {}
+      if params[:proxy] === 'direct'
+        actions = ['create', 'read', 'update', 'destroy']
+        proxy["api"] = {}
+        direct_actions.each_index do |n|
+          proxy["api"][actions[n]] = direct_actions[n][:name]
+        end
+      else
+        if params[:config]["api"]
+          proxy["api"] = {}
+          params[:config]["api"].each {|k,v| proxy["api"][k] = "/#{params[:controller]}/#{v}" }
+        else
+          proxy["url"] = "/#{params[:controller]}.#{params[:format].to_s}"
+        end
+      end
+      proxy
+    end
+
+    def extjs_root(value=nil)
+      ExtJS::MVC.root = value unless value.nil?
+      ExtJS::MVC.root
+    end
+
+    def extjs_success_property(value=nil)
+      ExtJS::MVC.success_property = value unless value.nil?
+      ExtJS::MVC.success_property
+    end
+
+    def extjs_message_property(value=nil)
+      ExtJS::MVC.message_property = value unless value.nil?
+      ExtJS::MVC.message_property
+    end
+
+  end
+end

data/lib/active_record/model.rb

@@ -0,0 +1,89 @@
+module ExtJS
+  module Model
+    def self.included(model)
+      model.send(:extend, ClassMethods)
+      model.send(:include, InstanceMethods)
+      model.class_eval do
+        cattr_accessor :extjs_record_fields
+      end
+      model.extjs_record_fields = []
+    end
+
+    ##
+    # InstanceMethods
+    #
+    module InstanceMethods
+      def to_record
+        data = {self.class.primary_key => self.send(self.class.primary_key)}
+        self.class.extjs_record_fields.each do |f|
+          if refl = self.class.reflections[f]
+            if refl.macro === :belongs_to
+              data[f] = self.send(f).to_record
+            elsif refl.macro === :has_many
+              data[f] = self.send(f).collect {|r| r.to_record}
+            end
+          else
+            data[f] = self.send(f)
+          end
+        end
+        data
+      end
+    end
+    ##
+    # ClassMethods
+    #
+    module ClassMethods
+      ##
+      # Defines the subset of AR columns used to create Ext.data.Record def'n.
+      # @param {Array/Hash} list-of-fields to include, :only, or :exclude
+      #
+      def extjs_fields(*params)
+        options = params.extract_options!
+        if !options.keys.empty?
+          if options[:exclude]
+            self.extjs_record_fields = self.columns.reject {|c| options[:exclude].find {|ex| c.name.to_sym === ex}}.collect {|c| c.name.to_sym}
+          end
+        elsif !params.empty?
+          self.extjs_record_fields = params
+        else
+          self.extjs_record_fields
+        end
+      end
+
+      ##
+      # render AR columns to Ext.data.Record.create format
+      # eg: {name:'foo', type: 'string'}
+      #
+      def extjs_record
+        if self.extjs_record_fields.empty?
+          self.extjs_record_fields = self.columns.collect {|c| c.name.to_sym }
+          self.extjs_record_fields.concat(self.reflect_on_all_associations.collect {|assn| assn.name})
+        end
+
+        return {
+          "fields" => self.extjs_record_fields.collect {|f|
+            if col = self.columns_hash[f.to_s]
+              type = col.type
+              case col.type
+                when :datetime || :date || :time || :timestamp
+                  type = :date
+                when :text
+                  type = :string
+                when :integer
+                  type = :int
+              end
+              field = {:name => col.name, :allowBlank => (col.primary) ? true : col.null, :type => type}
+              field[:dateFormat] = "c" if col.type === :datetime || col.type === :date  # <-- ugly hack for date
+              field
+            elsif self.reflections[f]
+              assn = self.reflections[f]
+              field = {:name => assn.name, :allowBlank => true, :type => 'auto'}
+            end
+          },
+          "idProperty" => self.primary_key
+        }
+      end
+    end
+  end
+end
+

data/lib/extjs-mvc.rb

@@ -0,0 +1,19 @@
+module ExtJS
+    class MVC
+      cattr_accessor :success_property
+      cattr_accessor :message_property
+      cattr_accessor :root
+
+      if defined?(ActiveRecord)
+        require 'active_record/model'
+      end
+      require 'extjs/component'
+      require 'extjs/data/store'
+
+      require 'helpers/component'
+      require 'helpers/store'
+
+      require 'action_controller/controller'
+
+   end
+end

data/lib/extjs/component.rb

@@ -0,0 +1,62 @@
+##
+# @class ExtJS::Component
+#
+class ExtJS::Component
+  attr_accessor :config
+  def initialize(params)
+    @config = params#params.extract_options!
+    @controller = @config.delete(:controller) unless @config[:controller].nil?
+
+    @config[:items] = [] if config[:items].nil?
+
+    if container = @config.delete(:container)
+      container.add(self)
+    end
+    @partial_config = nil
+  end
+
+  def apply(params)
+    @config.merge!(params)
+  end
+
+  ##
+  # Adds a config {} or ExtJS::Component instance to this component's items collection.
+  # NOTE:  When :partial option is used a String will of course be returned.  Otherwise an ExtJS::Component
+  # instance will be returned.
+  # @return {String/ExtJS::Component}
+  def add(*config)
+    options = config.extract_options!
+    if !options.keys.empty?
+      if url = options.delete(:partial)
+        # rendering a partial, cache the config until partial calls #add method.  @see else.
+        @partial_config = options
+        return @controller.render(:partial => url, :locals => {:container => self})
+      else
+        options.merge!(@partial_config) unless @partial_config.nil?
+        options[:controller] = @controller unless @controller.nil?
+        cmp = ExtJS::Component.new(options)
+        @partial_config = nil
+        @config[:items] << cmp
+        return cmp
+      end
+    elsif !config.empty? && config.first.kind_of?(ExtJS::Component)
+      cmp = config.first
+      cmp.apply(@partial_config) unless @partial_config.nil?
+      @partial_config = nil
+      @config[:items] << cmp.config
+      return cmp
+    end
+  end
+
+  def to_json
+    config.to_json
+  end
+
+  def render
+    # If there are any listeners attached in json, we have to get rid of double-quotes in order to expose
+    # the javascript object.
+    # eg:  "listeners":"SomeController.listeners.grid" -> {"listeners":SomeController.listeners.grid, ...}
+    json = @config.to_json.gsub(/\"(listeners|handler|scope)\":\s?\"([a-zA-Z\.\[\]\(\)]+)\"/, '"\1":\2')
+    "Ext.ComponentMgr.create(#{json});"
+  end
+end

data/lib/extjs/data/store.rb

@@ -0,0 +1,67 @@
+##
+# ExtJS::Data::Store
+#
+module ExtJS::Data
+  class Store
+    attr_accessor :id, :format, :type, :controller, :model
+
+    def initialize(*params)
+      options = params.extract_options!
+      options[:format] = 'json' if options[:format].nil?
+
+      @config = options[:config]
+
+      @format     = options[:format]
+      @proxy      = options[:proxy] || 'http'
+      @writer     = options[:writer]
+      @type       = (@proxy === 'direct' ? @proxy : @format).capitalize
+      @controller = "#{options[:controller].to_s.camelize}Controller".constantize
+      @model      = ((options[:model]) ? options[:model] : @controller.controller_name.singularize).camelize.constantize
+
+      # Merge Reader/Proxy config
+      @config.merge!(@controller.extjs_reader(@model))
+      @config.merge!(@controller.extjs_proxy(options))
+
+      # Set storeId implicitly based upon Model name if not set explicitly
+      @id = @config["storeId"] = @model.to_s.downcase unless @config["storeId"]
+    end
+
+    ##
+    # pre-load a store with data.  Not yet tested.  In theory, this *should* work.
+    #
+    def load(*params)
+      #@config["loadData"] = @model.all(params).collect {|rec| rec.to_record }
+    end
+
+    ##
+    # renders the configured store
+    # @param {Boolean} script_tag [true] Not yet implemented.  Always renders <script></script> tags.
+    def render(script_tag = true)
+      script = ''
+      # ugly hack for DirectProxy API.  Have to add an Ext.onReady() after the Store constructor to set API
+      if @proxy === 'direct'
+        auto_load = @config.delete("autoLoad")
+        cname = @controller.controller_name.capitalize
+        script = "Ext.onReady(function() { var s = Ext.StoreMgr.get('#{@config["storeId"]}');"
+        if (@config["directFn"])
+          script += "s.proxy.directFn = #{cname}.#{@config["directFn"]};"
+        else
+          script += "s.proxy.setApi({create:#{cname}.#{@config["api"]["create"]},read:#{cname}.#{@config["api"]["read"]},update:#{cname}.#{@config["api"]["update"]},destroy:#{cname}.#{@config["api"]["destroy"]}});"
+        end
+        if auto_load
+          script += "s.load();"
+        end
+        script += "});"
+      end
+
+      if @writer  # <-- ugly hack because 3.0.1 can't deal with Writer as config-param
+        json = @config.to_json
+        json[json.length-1] = ','
+        json += "writer:new Ext.data.#{@format.capitalize}Writer(#{@writer.to_json})}"
+        "<script>new Ext.data.#{@type}Store(#{json});#{script}</script>"
+      else
+        "<script>new Ext.data.#{@type}Store(#{@config.to_json});#{script}</script>"
+      end
+    end
+  end
+end

data/lib/helpers/component.rb

@@ -0,0 +1,38 @@
+##
+# ExtJS::Helpers::Component
+#
+module ExtJS::Helpers
+  module Component
+    ##
+    # add class-var @@extjs_on_ready
+    def self.included(helper)
+    
+    end
+
+    def extjs_component(*params)
+      options = params.extract_options!
+      options[:controller] = self
+      ExtJS::Component.new(options)
+    end
+
+    ##
+    # Adds a script or ExtJS::Component instance to on_ready queue.  The queue is emptied and rendered to
+    # <script></script> via #extjs_render
+    #
+    def extjs_onready(*params)
+      @onready_queue = [] if @onready_queue.nil?
+
+      params.each do |cmp|
+	@onready_queue << cmp
+      end
+    end
+
+    ##
+    # Empties the on_ready queue.  Renders within <script></script> tags
+    #
+    def extjs_render
+      @onready_queue = [] if @onready_queue.nil? # <--- ugly, ugh...having trouble with initializing my instance vars.
+      "<script>\nExt.onReady(function() {\n\t#{@onready_queue.collect {|cmp| (cmp.kind_of?(ExtJS::Component)) ? cmp.render : cmp}.join("\n\t")}\n });\n</script>"
+    end
+  end
+end

data/lib/helpers/store.rb

@@ -0,0 +1,7 @@
+module ExtJS::Helpers
+  module Store
+    def extjs_store(*params)
+       ExtJS::Data::Store.new(*params)
+    end
+  end
+end

data/lib/mvc.rb

@@ -0,0 +1,22 @@
+module ExtJS
+    class MVC
+      @@success_property = :success
+      @@message_property = :message
+      @@root = :data
+      cattr_accessor :success_property
+      cattr_accessor :message_property
+      cattr_accessor :root
+
+      if defined?(ActiveRecord)
+        require 'active_record/model'
+      end
+      require 'extjs/component'
+      require 'extjs/data/store'
+
+      require 'helpers/component'
+      require 'helpers/store'
+
+      require 'action_controller/controller'
+
+   end
+end

data/test/mvc_test.rb

@@ -0,0 +1,7 @@
+require 'test_helper'
+
+class MvcTest < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'mvc'
+
+class Test::Unit::TestCase
+end

metadata

@@ -0,0 +1,81 @@
+--- !ruby/object:Gem::Specification 
+name: mvc
+version: !ruby/object:Gem::Version 
+  version: 0.1.29
+platform: ruby
+authors: 
+- Chris Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-09-29 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: MVC tools to assist with ExtJS development in Rails and Merb
+email: christocracy@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README
+- README.rdoc
+files: 
+- LICENSE
+- README
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/action_controller/controller.rb
+- lib/active_record/model.rb
+- lib/dm/model.rb
+- lib/extjs-mvc.rb
+- lib/extjs/component.rb
+- lib/extjs/data/store.rb
+- lib/helpers/component.rb
+- lib/helpers/store.rb
+- lib/mvc.rb
+- test/mvc_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/extjs/mvc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Ruby tools for ExtJS development
+test_files: []
+