extjs-mvc 0.3.10 → 0.4.0.a

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2009 Chris Scott
+Copyright (c) 2009 Christocracy
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,185 +1,17 @@
-= 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
-
-<b>Rails Installation:</b>
-In <tt>environment.rb</tt>, 
-
-    Rails::Initializer.run do |config|
-        config.gem "extjs-mvc"
-    end
-
-<b>Merb installation:</b>
-In <tt>config/dependencies.rb</tt>, Add extjs-mvc as a new dependency
-	
-	dependency "extjs-mvc"
-
-=== An ORM Model mixin:  ExtJS::Model
-extjs-mvc contains Model mixin named <tt>ExtJS::Model</tt> which works for <b>three</b> popular ORM frameworks, ActiveRecord, DataMapper and MongoMapper.  The API for each framework is identical.
-
-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
-    extjs_fields :only => [:name, :description] # actually the same as above
-    
-    # OR
-    extjs_fields :additional => [:computed] # includes all database columns and an additional computed field
-    
-    # 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]
-    
-    def computed
-      name.blank? ? login : name
-    end
-  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"},
-         {:type=>'string', :allowBlank=>false, :name=>"first", :defaultValue => nil},
-         {:type=>'string', :allowBlank=>false, :name=>"last", :defaultValue => nil},
-         {:type=>'string', :allowBlank=>false, :name=>"email", :defaultValue => nil}
-       ]}
-
-An auto-generated <tt>Ext.data.JsonReader</tt> configuration!
-
-
-You can also define different sets of fields for different representations of your model.
-
-E.g. with the following definition:
-
-    class User < ActiveRecord::Base
-      include ExtJS::Model
-
-      extjs_fieldset :grid, fields => [:name, :description, :company => [:name, :description]]
-      extjs_fieldset :combo, [:full_name]
-  
-      def full_name
-        "#{first_name} #{name}"
-      end
-    end
-
-You can get store configs for both representations with
-    User.extjs_record(:grid)
-or
-    User.extjs_record(:combo)
-    
-And the corresponding data for the representations with
-    User.first.to_record(:grid)
-or
-    User.first.to_record(:combo)
-
-
-=== An ActionController mixin:  ExtJS::Controller
-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
-        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" => "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
-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
-
-Now render a store in an erb template:
-
-    @store = extjs_store(
-      :controller => "users",
-			:fieldset => :grid,	# <-- Specify a particular fieldset as defined in the Model (used to render DataReader)
-      :proxy => "http"  # <-- default
-      :format => "json" # <-- default
-      :model => "user", # <-- default: controller_name.singularize
-      :writer => {:encode => false},
-      :config => {      # <-- standard Ext.data.Store config-params
-        "autoLoad" => true
-        "autoSave" => true
-      }
-    )
-
-    %= @store.render %
-
-=== A Testing Mixin:  ExtJS::TestMacros
-The <tt>extjs-mvc</tt> Gem includes a small set of testing macros to help unit-test models.
-This requires the 'Shoulda' gem from thoughtbot.  Include this mixin inside the
-<tt>ActiveSupport::TestCase</tt> class in <tt>test/test_helper.rb</tt>
-
-==== Usage
-<tt>test/test_helper.rb</tt>
-    class ActiveSupport::TestCase
-      extend ExtJS::TestMacros
-      #...
-    end
-
-In individual model unit tests:
-    class ModelTest < ActiveSupport::TestCase
-      should_require_extjs_fields :name, :email, :city
-      #...
-      #other tests
-    end
+= extjs-mvc-gem
 
+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)
+  (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.
+Copyright (c) 2010 Christocracy. See LICENSE for details.

data/Rakefile

@@ -5,30 +5,32 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "extjs-mvc"
-    gem.summary = %Q{Ruby ORM tools to assist with rendering Ext.data.Store}
-    gem.description = %Q{MVC tools to assist with ExtJS development in Rails and Merb}
+    gem.summary = %Q{A Rails-like MVC for the Ext JS javascript framework}
+    gem.description = %Q{A full-stack, Rails-like MVC for the Ext JS javascript framework (originally known as extmvc/extmvc)}
     gem.email = "christocracy@gmail.com"
-    gem.homepage = "http://github.com/extjs/mvc"
-    gem.authors = ["Chris Scott"]
-    gem.add_development_dependency "shoulda"
-    gem.add_development_dependency "mocha"
-    gem.add_development_dependency "extlib"
+    gem.homepage = "http://github.com/christocracy/extjs-mvc-gem"
+    gem.authors = ["Ed Spencer and Chris Scott"]
+    gem.add_dependency "extlib"
+    gem.add_dependency "json"
+    gem.add_dependency "thor"
+    gem.add_dependency "jammit-core"
+    gem.add_dependency "hpricot"
+    
+    
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test,js}/**/*", 'lib/jeweler/templates/.gitignore']
     
-    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
   Jeweler::GemcutterTasks.new
 rescue LoadError
-  puts "Jeweler (or a dependency) not available. Install it with: sudo gem install jeweler"
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
 end
 
-
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
   test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
+  test.pattern = 'test/**/test_*.rb'
   test.verbose = true
 end
 
@@ -36,7 +38,7 @@ begin
   require 'rcov/rcovtask'
   Rcov::RcovTask.new do |test|
     test.libs << 'test'
-    test.pattern = 'test/**/*_test.rb'
+    test.pattern = 'test/**/test_*.rb'
     test.verbose = true
   end
 rescue LoadError
@@ -51,14 +53,10 @@ task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  if File.exist?('VERSION')
-    version = File.read('VERSION')
-  else
-    version = ""
-  end
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
 
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "mvc #{version}"
+  rdoc.title = "extjs-mvc-gem #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end

data/VERSION

@@ -1 +1 @@
-0.3.10
+0.4.0.a

data/bin/xmvc

@@ -0,0 +1,13 @@
+#!/usr/local/bin/ruby
+
+# Check if an older version of extjs-mvc is installed
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../lib')
+require 'extjs-mvc'
+require 'extjs-mvc/cli'
+
+begin
+  ExtJS::MVC::CLI.start
+rescue ExtJS::MVC::Error => e
+  ExtJS::MVC.ui.error(e.message)
+  exit e.status_code
+end

data/lib/extjs-mvc/README

@@ -0,0 +1,20 @@
+This directory contains a collection of Ruby scripts and classes which allow automation of common project tasks.
+You can remove this directory if you don't use any of these tasks.
+
+Usage:
+
+From within the MVC application base directory:
+
+ruby script/generate model MyModel field_1:string field_2:int field_3:boolean
+ruby script/generate view viewNamespace viewName
+ruby script/generate controller controllerName viewName1 viewName2 ...
+ruby script/generate scaffold MyModel field_1:string field_2:int field_3:boolean
+
+ruby script/plugin install git://github.com/extmvc/loadingmessage-plugin.git LoadingMessage (second arg optional)
+ruby script/plugin install MyPluginFolder (where MyPluginFolder is a folder within the vendor/plugins directory)
+ruby script/plugin uninstall MyPluginFolder
+
+ruby script/build all
+ruby script/build js
+ruby script/build css
+

data/lib/extjs-mvc/builder.rb

@@ -0,0 +1,83 @@
+#require 'builders/base'
+#require 'builders/all_builder'
+#require 'builders/app_builder'
+#require 'builders/css_builder'
+#require 'builders/docs_builder'
+#require 'builders/mvc_builder'
+#require 'builders/plugins_builders'
+
+module ExtJS
+  module MVC
+    class BuilderManager
+      class << self
+        
+        def dispatch(name, *params)
+          name = name.to_sym
+          options = params.shift || {}
+          case name
+          when :setup
+            setup(options)
+          else
+            begin
+              @jammit = jammit(options)
+              @jammit.invoke(:build, [name])
+            rescue Jammit::Error => e
+              raise ExtJS::MVC::BuilderError.new(e.message)
+            end
+          end
+        end
+        
+    private
+        
+        def setup(options)
+          begin
+            ##
+            # Invoke jammit init app-name so that Jammit creates it's config/assets.yml
+            # Note that we must pass-in the name of the newly created app @name so that
+            # Jammit appends that to its config_path, otherwise it would create its config file
+            # in the pwd.
+            
+            @asset_root = options[:asset_root] || File.expand_path('.')
+            
+            app_assets
+            
+            jammit = Jammit::CLI.new([], options)
+            jammit.invoke(:init)
+            jammit.invoke(:config, ["set", "javascripts", {
+              "mvc" => mvc_assets,
+              "app" => app_assets
+            }])
+            jammit.invoke(:build)
+
+          rescue Jammit::Error => e
+            raise ExtJS::MVC::BuilderError.new(e.message)
+          end
+        end
+        
+        def jammit(options={})
+          Jammit::CLI.new([], options)
+        end
+        
+        def mvc_assets
+          YAML.load(File.read(File.join(@asset_root, 'vendor', 'mvc', 'build'))).map {|f|
+            File.join('vendor', 'mvc', f)
+          }
+        end
+        
+        def app_assets
+          [
+            'app/App.js',
+            'config/application.js',
+            'config/routes.js',
+            'vendor/plugins/*/**.js',
+            'overrides/*.js',
+            'app/models/*.js',
+            'app/controllers/*.js',
+            'app/views/*/**.js'
+          ]
+        end
+        
+      end
+    end
+  end
+end

data/lib/extjs-mvc/builders/all_builder.rb

@@ -0,0 +1,15 @@
+module ExtJS
+  module MVC
+    class AllBuilder < Builder
+      def self.instances(args = [])
+        # set defaults
+        args = ['app', 'css', 'plugin', 'mvc'] if args.empty?      
+        instances = []
+
+        args.each {|builderName| instances.concat(ExtMVC::BuilderManager.instances_for(builderName, []))}
+    
+        return instances
+      end
+    end
+  end
+end

data/lib/extjs-mvc/builders/app_builder.rb

@@ -0,0 +1,36 @@
+module ExtJS
+  module MVC
+    class AppBuilder < Builder
+      def self.instances(args = [])
+        [ExtMVC::AppBuilder.new]
+      end
+  
+      def file_list
+        # build to production environment
+        environment = ExtMVC.mvc_production_environment
+    
+        return ExtMVC.application_files_for(environment)
+      end
+  
+      def name
+        "Ext MVC Application"
+      end
+  
+      def message
+        "Built #{name}"
+      end
+  
+      def description
+        "Your #{name}"
+      end
+  
+      def output_filename
+        "public/application-all.js"
+      end
+  
+      def should_minify
+        true
+      end  
+    end
+  end
+end

data/lib/extjs-mvc/builders/base.rb

@@ -0,0 +1,138 @@
+
+module ExtJS
+  module MVC
+    module Builder
+      class Base
+        
+        # Subclasses must implement this method to return the name of the file that concatenated output will be saved to
+        def output_filename
+          raise 
+        end
+  
+        # Does the actual building - just concatenates file_list and optionally minifies
+        def build
+          concatenate(file_list, output_filename)
+          system('growlnotify -m "Built ' + name + '"')
+    
+          if should_minify
+            minify output_filename
+            system('growlnotify -m "Minified ' + name + '"')
+          end
+    
+          puts message
+        end
+  
+        # Indicates whether the outputted filename should also be minified (defaults to false)
+        def should_minify
+          false
+        end
+  
+        def name
+          "Unknown Package"
+        end
+  
+        def message
+          "Build complete"
+        end
+  
+        def description
+          directory_name
+        end
+  
+        # Returns an array of all files to be concatenated, in the order they should be included
+        def file_list
+          has_build_file? ? order_from_build_file : guess_build_order
+        end
+  
+        def has_build_file?
+          File.exists?(build_file_name)
+        end
+  
+        def build_file_name
+          "#{directory_name}/build"
+        end
+  
+        # Subclasses can override this method to return the string name of the directory under while the file_list resides
+        def directory_name
+          "./"
+        end
+  
+        # Returns an array of all of the files listed in the build file
+        def order_from_build_file
+          build_files = []
+          file        = File.open(build_file_name, "r")
+    
+          while (line = file.gets)
+            line.gsub!(/\n/, '')
+            next if line =~ /^#/ || line.length.zero?
+      
+            filename = "#{directory_name}/#{line}"
+      
+            if File.exists?(filename)
+              build_files.push(filename) unless build_files.include?(filename)
+            else
+              js_files_in_glob(filename).each {|filename| build_files.push(filename) unless build_files.include?(filename)}
+            end
+          end
+    
+          build_files
+        end
+  
+        # Returns an array of all the .js files found in the plugin dir, in the order in which they are found
+        # (ignores the 'PluginName-all.js' file)
+        def guess_build_order
+          js_files_in_glob("#{directory_name}/**/*.js")
+        end    
+  
+        def js_files_in_glob(glob)
+          Dir[glob].select {|fileName| Regexp.new(output_filename).match(fileName).nil?}
+        end
+  
+        private
+  
+        # Concatenates an array of files together and saves
+        def concatenate(files, concatenated_filename, baseDir = './')
+          #remove old files, create blank ones again
+          if File.exists?(concatenated_filename)
+            File.delete(concatenated_filename) 
+            # puts "Deleted old #{concatenated_filename}"
+          end
+          FileUtils.touch(concatenated_filename)
+    
+          count = 0
+          file = File.open(concatenated_filename, 'w') do |f|
+            files.each do |i|
+              # remove the directory the app is in if add_dir is supplied
+              i = i.gsub(Regexp.new(ENV['app_dir']), '').gsub(/$(\/*)(.*)/, '\2') if ENV['app_dir']
+
+              f.puts(IO.read(File.join(baseDir, i)))
+              f.puts("\n")
+              count += 1
+            end
+          end
+    
+          # puts "Concatenated #{count} files into #{concatenated_filename}"
+          # puts
+        end
+  
+        # Minifies a file using YUI compressor
+        def minify(filename, minified_filename = nil)
+          if minified_filename.nil?
+            minified_filename = filename.gsub(/\.js$/, '-min.js')
+          end
+    
+          if File.exists?(minified_filename)
+            FileUtils.rm(minified_filename)
+            # puts "Deleted old #{minified_filename}"
+          end
+
+          system("java -jar vendor/yui-compressor/build/yuicompressor-2.4.jar #{filename} -o #{minified_filename}")
+
+          # puts "Created minified file #{minified_filename}"
+          # puts
+        end
+
+      end
+    end
+  end
+end

data/lib/extjs-mvc/builders/css_builder.rb

@@ -0,0 +1,36 @@
+module Ext
+  module MVC
+    class CssBuilder < Builder
+      def self.instances(args = [])
+        [ExtMVC::CssBuilder.new]
+      end
+    
+      def file_list
+        # build to production environment
+        environment = ExtMVC.mvc_development_environment
+      
+        return ExtJS::MVC.css_files_for(environment)
+      end
+    
+      def name
+        "Ext MVC Application Stylesheets"
+      end
+    
+      def message
+        "Built #{name}"
+      end
+    
+      def description
+        "Your #{name}"
+      end
+    
+      def output_filename
+        "public/stylesheets/application-all.css"
+      end
+    
+      def directory_name
+        "public/stylesheets/"
+      end
+    end
+  end
+end

data/lib/extjs-mvc/builders/docs_builder.rb

@@ -0,0 +1,20 @@
+module Ext
+  module MVC
+    class DocsBuilder < Builder
+      def self.instances(args = [])
+        [ExtMVC::DocsBuilder.new]
+      end
+    
+      def build
+        system("java -jar vendor/ext-doc/ext-doc.jar -p config/build.xml -o docs -t vendor/ext-doc/template/ext/template.xml -verbose")
+        app_name = ExtMVC.settings['docs']['title'] rescue ExtMVC.environment["namespace"] || "Ext MVC"
+        logo     = ExtMVC.settings['docs']['logo']  rescue "resources/extjs.gif"
+
+        {:app_name => app_name, :logo => logo}.each_pair do |key, value|
+          ExtMVC.gsub_file("docs/index.html", "<%= @#{key} %>", value)
+          ExtMVC.gsub_file("docs/welcome.html", "<%= @#{key} %>", value)
+        end
+      end
+    end
+  end
+end

data/lib/extjs-mvc/builders/mvc_builder.rb

@@ -0,0 +1,33 @@
+module Ext
+  module MVC
+    class MVCBuilder < Builder
+      def self.instances(args = [])
+        [ExtMVC::MVCBuilder.new]
+      end
+    
+      def output_filename
+        "#{directory_name}/ext-mvc-all.js"
+      end
+    
+      def directory_name
+        "vendor/mvc"
+      end
+    
+      def should_minify
+        true
+      end
+    
+      def name
+        "Ext MVC"
+      end
+    
+      def message
+        "Built #{name}"
+      end
+    
+      def description
+        "The #{name} framework (#{directory_name})"
+      end
+    end
+  end
+end