extjs-extjs-mvc 0.1.0

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,18 @@
+= mvc
+
+Description goes here.
+
+== 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 = "extjs-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.0

data/lib/action_controller/controller.rb

@@ -0,0 +1,58 @@
+module ExtJS::Controller
+
+  def self.included(controller)
+    controller.send(:extend, ClassMethods)
+    controller.class_eval do
+      helper ExtJS::Data
+    end
+  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/action_view/helpers/data/store.rb

@@ -0,0 +1,39 @@
+module ExtJS::Data
+  module Store
+    def extjs_store(params)
+      params[:format] = 'json' if params[:format].nil?
+      params[:proxy] = 'http' if params[:proxy].nil?
+
+      controller = "#{params[:controller].to_s.capitalize}Controller".constantize
+      model = ((params[:model]) ? params[:model] : params[:controller].singularize).capitalize.constantize
+
+      reader = controller.extjs_reader(model)
+      proxy = controller.extjs_proxy(params)
+
+      params[:config]["storeId"] = model.to_s.downcase
+      params[:config].merge!(reader)
+      params[:config].merge!(proxy)
+
+      type = (params[:proxy] === 'direct' ? params[:proxy] : params[:format]).capitalize
+
+      script = ''
+      # ugly hack for DirectProxy API.  Have to add an Ext.onReady() after the Store constructor to set API
+      if params[:proxy] === 'direct'
+        auto_load = params[:config].delete("autoLoad")
+        cname = params[:controller].capitalize
+        script = "Ext.onReady(function() { var s = Ext.StoreMgr.get('#{model.to_s.downcase}');"
+        if (params[:config]["directFn"])
+          script += "s.proxy.directFn = #{cname}.#{params[:config]["directFn"]};"
+        else
+          script += "s.proxy.setApi({create:#{cname}.#{params[:config]["api"]["create"]},read:#{cname}.#{params[:config]["api"]["read"]},update:#{cname}.#{params[:config]["api"]["update"]},destroy:#{cname}.#{params[:config]["api"]["destroy"]}});"
+        end
+        if auto_load
+          script += "s.load();"
+        end
+        script += "});"
+      end
+      "new Ext.data.#{type}Store(#{params[:config].to_json});#{script}"
+
+    end
+  end
+end

data/lib/active_record/model.rb

@@ -0,0 +1,63 @@
+module ExtJS
+  module Model
+    def self.included(model)
+      model.send(:extend, ClassMethods)
+      model.send(:include, InstanceMethods)
+    end
+
+    ##
+    # InstanceMethods
+    #
+    module InstanceMethods
+      def to_record
+        data = {self.class.primary_key => self.send(self.class.primary_key)}
+        self.class.extjs_fields.each do |f|
+          data[f] = self.send(f)
+        end
+        data
+      end
+    end
+    ##
+    # ClassMethods
+    #
+    module ClassMethods
+      @@fields = []
+      ##
+      # 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[:only]
+            @@fields = options[:only]
+          elsif options[:exclude]
+            @@fields = self.columns.reject {|c| options[:exclude].find {|ex| c.name.to_sym === ex}}.collect {|c| c.name.to_sym}
+          end
+        elsif !params.empty?
+          @@fields = params
+        else
+          @@fields
+        end
+      end
+
+      ##
+      # render AR columns to Ext.data.Record.create format
+      # eg: {name:'foo', type: 'string'}
+      #
+      def extjs_record
+        @@fields = self.columns.collect {|c| c.name.to_sym } if @@fields.empty?
+        {
+          "fields" => @@fields.collect {|f|
+            col = self.columns.find {|c| c.name.to_sym === f}
+            field = {:name => col.name, :allowBlank => col.null, :type => col.type}
+            field[:dateFormat] = "c" if col.type === :datetime || col.type === :date  # <-- ugly hack for date
+            field
+          },
+          "idProperty" => self.primary_key
+        }
+      end
+    end
+  end
+end
+

data/lib/extjs-mvc.rb

@@ -0,0 +1,18 @@
+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 'action_controller/controller'
+      require 'action_view/helpers/data/store'
+   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,75 @@
+--- !ruby/object:Gem::Specification 
+name: extjs-extjs-mvc
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Chris Scott
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-27 00:00:00 -07: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/action_view/helpers/data/store.rb
+- lib/active_record/model.rb
+- lib/dm/model.rb
+- lib/extjs-mvc.rb
+- test/mvc_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/extjs/mvc
+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.2.0
+signing_key: 
+specification_version: 2
+summary: Ruby tools for ExtJS development
+test_files: []
+