xmvc 0.1.8 → 0.1.9

data/Rakefile

@@ -16,8 +16,9 @@ begin
     gem.add_dependency "whorm", ">= 0.1.0"
     gem.add_dependency "hpricot", ">= 0.8.2"
     gem.add_dependency "sprockets"
+    gem.add_development_dependency "shoulda", ">= 0"
+    gem.add_development_dependency "cucumber", ">= 0"
     
-    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
     gem.files =  FileList["[A-Z]*", "{bin,generators,lib,test}/**/*"]
     
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
@@ -47,9 +48,17 @@ rescue LoadError
   end
 end
 
-task :test => :check_dependencies
+begin
+  require 'cucumber/rake/task'
+  Cucumber::Rake::Task.new(:features)
+  task :features
+rescue LoadError
+  task :features do
+    abort "Cucumber is not available. In order to run features, you must: sudo gem install cucumber"
+  end
+end
 
-task :default => :test
+task :default => :features
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|

data/VERSION

@@ -1 +1 @@
-0.1.8
+0.1.9

data/lib/xmvc/api.rb

@@ -2,12 +2,25 @@ require 'thor'
 require 'thor/group'
   
 module Xmvc
-  class API < Thor
-    ARGV = ::ARGV.dup
+  class API < Vendor
     
-    class_option :environment, :default => :development
+    vendor_name :app
     
-    desc "build", "Build stuff"
+    class << self
+      protected
+          
+      def prepare_vendor(options)
+        vendor = new([], options)
+        vendor.inside(File.expand_path(options[:root])) do |root|
+          vendor.destination_root = root
+          yield vendor if block_given?
+          configure(vendor)
+        end
+        vendor
+      end
+    end
+    
+    class_option :environment, :default => :development
     
     desc "stats", "View code statistics"
     def stats
@@ -16,36 +29,14 @@ module Xmvc
     end
     
     desc "secretary", "Return Sprockets::Secretary for app javascripts"
-    def secretary
-      say_status "Xmvc::API", "secretary #{config[:root]}, #{FileUtils.pwd}"
+    def secretary(type = :js)
+      say_status "secretary", self.class.to_s  
       Sprockets::Secretary.new({
-        :source_files => Xmvc::Config["javascripts"]
+        :root => destination_root,
+        :source_files => config["javascripts"]
       })
     end
-    
-    def initialize(args=ARGV, options={}, config={})
-    
-      unless File.expand_path("../#{options[:root]}") == FileUtils.pwd
-        FileUtils.chdir(options[:root])
-      end
-      
-      Xmvc::Config.setup(options)
-            
-      #host = options.delete(:host)
-      #unless host
-      #  raise Xmvc::NoFramework.new("Xmvc is meant to be supplied with a framework extension, eg extjs-mvc, via Xmvc::CLI.start(ARGV, {:framework => Your::Framework})")
-      #end
-      
-      # Set the framework.
-      #Xmvc.host = host
-      #options.delete(:shell)
-      
-      #Xmvc::Config.setup(options)
-      
-      #Xmvc.environment = Xmvc::Config[:environment]
-            
-      super
-    end
   
   end
+  
 end

data/lib/xmvc/builder.rb

@@ -1,32 +1,15 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
 module Xmvc
   class Builder < Thor
-    
-    autoload :Vendor,   'builders/vendor'
-    
+  
     include Thor::Actions
     
     desc "all", "Build all assets"
     def all(*params)
-      Xmvc.ui.warn('build all assets with sprcokets')
-      sec = Sprockets::Secretary.new({
-        :source_files => Xmvc::Config["javascripts"]
-      })
+      #Xmvc.ui.warn('build all assets with sprcokets')
+      #sec = Sprockets::Secretary.new({
+      #  :source_files => Xmvc::Config["javascripts"]
+      #})
       #create_file("public/javascripts/app/app-all-debug.js", sec.concatenation)
     end
-    
-    desc "setup", "Initialize config file"
-    def setup      
-      Xmvc.secretary = Sprockets::Secretary.new({})
-      Xmvc.public_path = File.expand_path("public")
-      host = Vendor.new([], {
-        :environment => Xmvc.environment
-      })
-      host.invoke("app")
-    end
-    
-  private
-    
-   
   end
 end

data/lib/xmvc/generator.rb

@@ -22,9 +22,7 @@ module Xmvc
       case generator
         when "app"
           options = options.dup
-          
           App.start(params, options)
-          
         when "model"
           model = Model.new([], options.dup)
           model.invoke("generate", [params.shift, *params])

data/lib/xmvc/generators/app.rb

@@ -60,20 +60,13 @@ module Xmvc
       
       def create_vendor
         directory("vendor", "vendor")
-        inside("vendor", {}) do |pwd|
+        inside("vendor", {}) do |vendor_dir|
           empty_directory("plugins")
-          
-          #host = Xmvc.host::API.new([], {})
-          #host.invoke(:install, [dir])
-          
+          # install vendors
           Xmvc.vendors.each do |vendor|
-            say_status("install", vendor)
-            api = vendor::API.new([], {
-              :root => pwd,
-              :format => :js,
-              :asset_root => "public"
+            vendor::API.install({
+              :root => vendor_dir
             })
-            api.invoke(:install)
           end    
         end
       end
@@ -93,24 +86,34 @@ module Xmvc
         # We want to get rid of Xmvc::Builder in favour of each vendor providing its own secretary
         #
         @vendors = []
-        asset_root = File.join(self.destination_root, "public")
+        # bundle all vendor assets
         inside "vendor" do |dir|
           Xmvc.vendors.each do |vendor|
-            @vendors << vendor::API.new([], {
+            api = vendor::API.load({
               :root => dir,
               :format => :js,
-              :asset_root => asset_root
+              :asset_root => Xmvc::PUBLIC_PATH
             })
+            api.invoke(:bundle)
+            @vendors << api
           end
         end
-          
+        
+        # Bundle application code last
+        app = Xmvc::API.load({
+          :root => ".",
+          :format => :js,
+          :asset_root => Xmvc::PUBLIC_PATH
+        })
+        app.invoke(:bundle)
+        @vendors << app
+        
+        # Create a boot-generator
         boot = Xmvc::Generator::Boot.new([], {
           :root => self.destination_root,
           :vendors => @vendors
         })
-        Xmvc.ui.warn("Disabled default bundling")  
-        #boot.invoke(:default)
-        
+        boot.invoke(:default)
         boot.invoke(:sprockets)
       end
     end

data/lib/xmvc/generators/boot.rb

@@ -11,44 +11,28 @@ module Xmvc
       
       desc "default", "Generate the default index.html with config/boot.js"
       def default
-        puts "Boot default is disabled"
-        return false
         
-        #builder = Xmvc::Builder.new([], {})    
-        #packages = builder.invoke(:setup, [])
+        ext = options[:type] || :js
         
-        host = Xmvc.host.config["name"]
+        #host = Xmvc.host.config["name"]
         @development = []
         @production = []
         @test = []
         
-        packages.each do |pkg|
-          if pkg[:vendor] == :host
-            pkg[:source_files].each do |file|
-              #@development << url_for_path(file.pathname.to_s)
-            end
-            @production << Xmvc.public_build_url(:js, "app")
-          else
-            spec = pkg[:vendor]
-            # No source-files generated but host defined?  cachefly resources (ie: ext)?
-            if pkg[:source_files].empty? and spec["host"] 
-              package = spec["name"].to_s
-              version = spec["version"].to_s
-              package += "-#{version}" unless version.empty?
-              spec["javascripts"].each do |file|
-                debug = file.gsub(/(\.js)/, "-debug.js")
-                #TODO Fix this hard-coded "-debug" hack for Ext cachefly resources.
-                @development << File.join(spec["host"], package, debug)
-                @production << File.join(spec["host"], package, file)
-              end
-            elsif pkg[:source_files].length
-              @development << Xmvc.public_build_url(:js, spec["name"], spec["version"], "debug")
-              @production << Xmvc.public_build_url(:js, spec["name"], spec["version"])
-            end
-          end  
-        end  
-        @test = @development
+        # Don't render app assets, those will be auto-loaded by javascript asset-mgr
+        options[:vendors].reject{|v|v.class.vendor_name == :app}.each do |vendor|
+          @development.concat(vendor.class.asset_urls(vendor, :development, :js))
+          @development.concat(vendor.class.asset_urls(vendor, :production, :css))
+          
+          @production.concat(vendor.class.asset_urls(vendor, :production, :js))
+          @production.concat(vendor.class.asset_urls(vendor, :production, :css))
+        end
+        @test = @development  # <-- TODO Think about test-resources
+        
+        @boot_filename = "/config/boot.js"
+        @stylesheets = []
         
+        template("index.html", "#{Xmvc::PUBLIC_PATH}/index.html", {:force => true})
         template("boot.js", "config/boot.js")
       end
       
@@ -57,45 +41,18 @@ module Xmvc
         @javascripts = []
         @stylesheets = []
         options[:vendors].each do |vendor|
-          config = vendor.invoke(:config)
-          if config["host"] # <-- Host as in http://extjs.cachefly.net/...
-            config["javascripts"].each do |script|
-              @javascripts << File.join(config["host"], script)
-            end
-            config["stylesheets"].each do |url|
-              @stylesheets << File.join(config["host"], url)
-            end
-          else
-            @javascripts << File.join("/sprockets", "#{config['name']}.js")
-            if config["stylesheets"]  # <-- We wanna' use Sass!
-              config["stylesheets"].each do |url|
-                @stylesheets << File.join("/public", "stylesheets", config["name"], url)
-              end
-            end
-          end  
+          @javascripts.concat(vendor.class.asset_urls(vendor, :development, :js, "sprockets"))
+          @stylesheets.concat(vendor.class.asset_urls(vendor, :production, :css))
         end
         
-        # Finallly, add the xmvc assets (ie: controllers, models, views, plugins, etc)
-        @javascripts << File.join("/sprockets", "app.js")
-        
         # Application sass / css??
-        
         template("index.html.sprockets", "public/index.html.sprockets")
       end
       
       private
       
-      def url_for_path(path)
-        @re ||= Regexp.new("^#{FileUtils.pwd}(.*)$")
-        begin
-          path.match(@re)[1]
-        rescue StandardError
-          raise PathError.new("Xmvc::Generator::Boot failed to determine the relative filename for the path #{path}")
-        end
-      end
-      
-      def url_for(name, ext, suffix)
-        File.join("/", Xmvc::PUBLIC_PATH, name, Jammit.filename(name, ext, suffix))
+      def hosted_asset(vendor, type)
+        
       end
       
     end

data/lib/xmvc/generators/templates/app/public/config/application.js

@@ -1,5 +1,3 @@
-ExtMVC.model.modelNamespace = MyApp.models;
-
 /**
  * @class MyApp.App
  * @extends ExtMVC.App
@@ -63,4 +61,6 @@ ExtMVC.App.define({
   }
 });
 
+ExtMVC.model.modelNamespace = MyApp.models;
+
 

data/lib/xmvc/generators/templates/index.html

@@ -0,0 +1,22 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
+  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html>
+  <head>
+    <meta content='text/html; charset=UTF-8' http-equiv='Content-Type' />
+		<% @stylesheets.each do |url| %>
+			<link href="<%= url %>" rel="stylesheet" type="text/css" />
+		<% end %>
+		
+    <title>Ext MVC Application</title>
+  </head>
+  
+	<body>
+		<script type="text/javascript" src="<%= @boot_filename %>">></script>
+    <div id="loading-mask"></div>
+    <div id="loading">
+      <div class="loading-indicator">
+        Loading...
+      </div>
+    </div>	
+  </body>
+</html>

data/lib/xmvc/helpers/sprockets.rb

@@ -23,8 +23,12 @@ module Xmvc
         # xmvc_vendors :extjs => ExtJS::API, :"extjs-mvc" => ExtJS::MVC::API
         #
         def xmvc_vendors(vendors)
-          @vendors = vendors
-
+          #hashify the incoming array of vendors.
+          @vendors = {}
+          vendors.each do |vendor|
+            @vendors[vendor.vendor_name.to_sym] = vendor
+          end
+          
           # Add the Xmvc API
           @vendors[:app] = Xmvc::API
         end
@@ -41,7 +45,7 @@ module Xmvc
         # Defines teh Sprockets asset_root param where concatenation files will be created.
         #
         def xmvc_asset_root(asset_root)
-          @xmvc_asset_root = asset_root
+          @xmvc_asset_root = File.expand_path(asset_root)
         end
         
         ##
@@ -51,11 +55,18 @@ module Xmvc
         #
         def xmvc_asset(vid, format)
           sec = secretary(vid.to_sym, format)
-          filename = File.join(@xmvc_root, @xmvc_asset_root, "javascripts", vid.to_s, "#{vid}-all.#{format.to_s}")
+          vendor = @vendors[vid.to_sym]
+          
+          #asset_root = File.join(@xmvc_root, @xmvc_asset_root, "javascripts", vendor.class.vendor_name.to_s)
+          
+          #FileUtils.mkdir(dir) unless File.exists?(asset_root)
+          #filename = File.join(dir, "#{@vendors[vid].build_name}.#{format.to_s}")
+          @paths ||= {}
           unless source_is_unchanged?(sec)
-            sec.concatenation.save_to(filename)
+            #sec.concatenation.save_to(filename)
+            @paths[vid] = vendor.class.bundle_js(vendor, sec, File.join(@xmvc_root, Xmvc::PUBLIC_PATH))
           end
-          filename
+          @paths[vid] || ''
         end
 
       private
@@ -66,6 +77,13 @@ module Xmvc
           @vendors[vid]
         end
         
+        def load_vendor(vid)
+          @vendors[vid.to_sym] = @vendors[vid.to_sym].load({
+            :format => :js,
+            :root => (vid.to_sym == :app) ? @xmvc_root : File.join(@xmvc_root, "vendor")
+          })
+        end
+        
         ##
         # return last modified time of Secretary concatenation
         # @param {Sprockets::Secretary}
@@ -92,10 +110,7 @@ module Xmvc
           @secretary ||= {}      
           unless @secretary[vid]
             begin
-              @secretary[vid] = vendor(vid).new([], {
-                :format => :js,
-                :root => (vid == :app) ? @xmvc_root : File.join(@xmvc_root, "vendor"),
-              }).invoke(:secretary, [])
+              @secretary[vid] = load_vendor(vid).invoke(:secretary, [:js])
             rescue Xmvc::Error => e
               halt e.message
             end

data/lib/xmvc/vendor.rb

@@ -1,21 +1,184 @@
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-
 module Xmvc
-    
+  
+  ##
+  # A base thor-extension for which to build vendors/plugins for the Xmvc framework
+  # Extensions must impmlement several methods including :install and :secretary.
+  # Vendors are run in a root-dir named after themselves through the Xmvc::Vendor class-method
+  # #vendor_name.  A Vendor must at least provide a file named 'vendor.yml' in the root of its
+  # template namespace
+  # this file is used to define asset and meta-data
+  # 
+  #   name: some-vendor
+  #   javascripts:
+  #   - App.js
+  #   - app/view/**/*.js
+  #   - app/model/*.js
+  #   - app/controller/*.js
+  #
+  
   class Vendor < Thor
-    autoload :Plugin,   'vendor/plugin'
+    include Thor::Actions
+    
+    class Error < StandardError
+    end
+
+    class SpecNotFound < Error
+    end
     
-    #CONFIG_PATH = File.join(ROOT, "vendor.yml")
-    #ROOT            = File.dirname(__FILE__)
-    #class << self
-    #  def config(root)
-    #    @config ||= YAML.load(File.read(File.join(root, "vendor.yml", ))).to_mash
-    #  end
-    #end
+    ##
+    # all vendors must implement vendor.yml in the same directory their extension lives
+    #
+    CONFIG_FILENAME = "vendor.yml"
+    
+    attr_accessor :config
+    attr_accessor :js
+    attr_accessor :css
+    
+    class << self
+      
+      ##
+      # get / set the vendor name
+      #
+      def vendor_name(name=nil)
+        @name ||= name
+      end
+      
+      ##
+      # Install a vendor
+      # @return {Xmvc::Vendor}
+      #
+      def install(options)
+        unless vendor_name
+          raise Vendor::Error.new("Vendors must specify a name using the class-method vendor_name")
+        end
+        
+        prepare_vendor(options) do |vendor|
+          vendor.say_status("install", vendor.class.to_s)
+          vendor.invoke(:install)
+          begin
+            vendor.copy_file(CONFIG_FILENAME, CONFIG_FILENAME) unless File.exists? CONFIG_FILENAME
+          rescue StandardError => e
+            raise SpecNotFound.new("Vendors must have available in their source-directory, a file named 'vendor.yml' or the class-method #source_root defined, which provides the base-path to the location of vendor.yml.  Xmvc::Vendor attempted to automatically copy this file into the installation directory.")
+          end
+        end  
+      end
+    
+      ##
+      # Loads and configures an Xmvc::Vendor instance
+      # @return {Xmvc::Vendor}
+      #
+      def load(options)
+        prepare_vendor(options)
+      end
+      
+      ##
+      # @param {Xmvc::Vendor} vendor
+      # @param {Symbol} environment
+      # @param {Symbol} ext File-extension of requested resource, :js, :css, etc
+      # @param {String} host
+      #
+      def asset_urls(vendor, environment = :development, ext = :js, host=nil)
+        config = vendor.config
+        host = config['host'] unless host
+        type = Xmvc.asset_dir(ext)
+        rs = []
+        # Note, we check config['host'] here, not host as defined above, since cachefly urls
+        # override host requested as function param.  Host as in http://extjs.cachefly.net/...
+        if config['host'].include?("http://") 
+          config[type].each do |file|
+            rs << cachefly_url(environment, config['host'], config['name'], file, config['version'], ext)
+          end
+        elsif host != Xmvc::PUBLIC_PATH
+          rs << File.join("/#{host}", "#{config['name']}.#{ext.to_s}")
+        else
+          rs << Xmvc.build_path(environment, host, config['name'], config['version'], ext)
+        end
+        rs
+      end
+      
+      def bundle_js(vendor, sec, root=Xmvc::PUBLIC_PATH)
+        config = vendor.config
+        vendor.destination_root = root
+        path = ""
+        vendor.inside "javascripts" do  
+          vendor.empty_directory(config['name']) unless File.exists? config['name']
+          vendor.inside config['name'] do |dir|
+            path = File.expand_path(File.join(dir, Xmvc.build_name(vendor.options[:environment]||:development, config['name'], config['version'], :js)))
+            sec.concatenation.save_to(path)
+          end
+        end
+        path
+      end
+      
+      def bundle_css(vendor)
+        vendor.destination_root = Xmvc::PUBLIC_PATH
+        vendor.inside "stylesheets" do
+          Xmvc.ui.warn(' - bundle css -- no implementation')
+        end
+      end
+      
+    protected
+      
+      def cachefly_url(environment, host, name, file, version, ext)
+        version = (version.nil? or version.empty?) ? "" : "-#{version}"
+        File.join(host, "#{name}#{version}", "#{file}.#{ext.to_s}")
+      end
+        
+      def prepare_vendor(options)
+        vendor = new([], options)
+        vendor.inside(File.expand_path(options[:root])) do
+          vendor.inside vendor_name do |root|
+            vendor.destination_root = root
+            yield vendor if block_given?
+            configure(vendor)
+          end
+        end
+        vendor
+      end
+      
+      def defaults
+        @defaults ||= {
+          "name" => "",
+          "host" => "public",  # <-- http://foo.cachefly.net, /sprockets, /public, (defaults to /public)
+          "version" => "",
+          "javascripts" => [],
+          "stylesheets" => []
+        }
+      end
+      
+      def configure(vendor)
+        begin
+          vendor.config = defaults.merge(YAML.load_file(File.join(vendor.destination_root, CONFIG_FILENAME)))
+          
+          # Enforce config name to that defined in the class, ignoring that
+          # defined in YAML, which can't be trusted.  #vendor_name in the class-extension is the only
+          # way to ID a vendor.
+          vendor.config.update("name" => vendor_name)
+        rescue StandardError => e
+          raise SpecNotFound.new("Tried to load vendor #{vendor_name} but found no #{CONFIG_FILENAME} in the directory #{vendor.destination_root}")
+        end
+        vendor
+      end
+    end # end Vendor class
+    
+    desc "secretary", "Return this vendor's Sprockets::Secretary"
+    def secretary(type = :js)
+      say_status "secretary", self.class.to_s
+      case type
+        when :js then @secretary ||= Sprockets::Secretary.new({
+          :root => destination_root,
+          :source_files => config["javascripts"]
+        })
+      end
+    end
     
-    def initialize(args, options, config)
-      puts "options: #{options}, config: #{config}"
-      say_status("Xmvc::Vendor initialized, load teh config file")
+    desc "bundle", "Bundle a vendor's assets"
+    def bundle(sec = secretary(:js))
+      # ugly hack for root in order to satisfy both Sprockts helper and CLI.
+      root = (self.class.vendor_name == :app) ? Xmvc::PUBLIC_PATH : "../#{Xmvc::PUBLIC_PATH}"
+      
+      self.class.bundle_js(self, sec, root) unless config['host'].include?('http://')
+      self.class.bundle_css(self) unless config['host'].include?('http://')
     end
   end
-end
+end