sproutcore 0.9.11 → 0.9.12

data/lib/sproutcore/bundle_manifest.rb

@@ -1,21 +1,21 @@
 require 'yaml'
 
 module SproutCore
-  
-  # A Bundle Manifest describes all of the resources in a bundle, including 
+
+  # A Bundle Manifest describes all of the resources in a bundle, including
   # mapping their source paths, destination paths, and urls.
   #
-  # A Bundle will create a manifest for every language you request from it.  
-  # If you invoke reload! on the bundle, it will dispose of its manifests and 
+  # A Bundle will create a manifest for every language you request from it.
+  # If you invoke reload! on the bundle, it will dispose of its manifests and
   # rebuild them.
   #
   class BundleManifest
-    
+
     CACHED_TYPES = [:javascript, :stylesheet, :fixture, :test]
     SYMLINKED_TYPES = [:resource]
-    
+
     attr_reader :bundle, :language, :build_mode
-    
+
     def initialize(bundle, language, build_mode)
       @bundle = bundle
       @language = language
@@ -48,95 +48,122 @@ module SproutCore
     def to_hash; @entries_by_type; end
     def to_s; @entries_by_filename.to_yaml; end
 
-    protected
+    # ==== Returns
+    # true if javascripts should be combined
+    def combine_javascript?
+      bundle.library.combine_javascript_build_modes.include?(build_mode)
+    end
+
+    # ==== Returns
+    # true if stylesheets should be combined
+    def combine_stylesheets?
+      bundle.library.combine_stylesheets_build_modes.include?(build_mode)
+    end
+
+    # ==== Returns
+    # true if stylesheets should be combined
+    def include_fixtures?
+      bundle.library.include_fixtures_build_modes.include?(build_mode)
+    end
     
+    protected
+
     # Builds a manifest for the bundle and the specified language
     def build!
-      
-      # STEP 1: Catalog all of the files in the project, including the target 
-      # language and the default language.  This will filter out resources not 
+
+      # STEP 1: Catalog all of the files in the project, including the target
+      # language and the default language.  This will filter out resources not
       # used in this language.
       entries = catalog_entries
-      
-      # STEP 2: Combine the HTML file paths into a single entry, unless this 
+
+      # STEP 2: Combine the HTML file paths into a single entry, unless this
       # is a framework
       working = entries[:html] ||= []
-        
+
       if bundle.can_have_html?
         working << build_entry_for('index.html', :html, working)
       else
         working.each { |x| x.hidden = true }
       end
-      
-      # STEP 3: If in development build mode:
-      if self.build_mode == :development
-        
+
+      # STEP 5: Add entry for javascript.js & stylesheet.js.  If in production 
+      # mode, set these to visible and hide the composite.  If in dev mode, do 
+      # the opposite.
+
+      # STEP 3: Handle special build modes...
+
         #  a. Merge fixture types into JS types & tests
-        unless entries[:fixture].nil?
-          entries[:javascript] = (entries[:javascript] || []) + entries[:fixture]  
+        if self.include_fixtures? && !entries[:fixture].nil?
+          entries[:javascript] = (entries[:javascript] || []) + entries[:fixture]
+        else
+          entries.delete(:fixture)
         end
-      
-        #  b. Rewrite all of the JS & CSS file paths and URLs to point to 
-        # cached versions 
+
+        #  b. Rewrite all of the JS & CSS file paths and URLs to point to
+        # cached versions
         # (Cached versions are written to _cache/filename-ctime.ext)
-        (entries[:javascript] ||= []).each do | entry |
-          setup_timestamp_token(entry)
+        if self.build_mode == :development
+          (entries[:javascript] ||= []).each do | entry |
+            setup_timestamp_token(entry)
+          end
+
+          (entries[:stylesheet] ||= []).each do | entry |
+            setup_timestamp_token(entry)
+          end
+
+        #  c. Rewrite the URLs for all other resources to go through the _src 
+        #     symlink 
+        ## -----> Already done build_entry_for()
+        #  a. Combine the JS file paths into a single entry for the 
+        #  javascript.js
+        hide_composite = self.combine_javascript?
+        if (working = entries[:javascript]) && working.size>0
+          entry = build_entry_for('javascript.js', :javascript, working, hide_composite)
+          setup_timestamp_token(entry) if self.build_mode == :development
+          entry.hidden = true unless hide_composite
+          working << entry
         end
-      
-        (entries[:stylesheet] ||= []).each do | entry |
-          setup_timestamp_token(entry)
+
+        #  b. Combine the CSS file paths into a single entry for the 
+        #  stylesheet.css
+        hide_composite = self.combine_stylesheets?
+        if (working = entries[:stylesheet]) && working.size>0
+          entry = build_entry_for('stylesheet.css', :stylesheet, working, hide_composite)
+          setup_timestamp_token(entry) if self.build_mode == :development
+          entry.hidden = true unless hide_composite
+          working << entry
         end
-        
-        #  c. Rewrite the URLs for all other resources to go through the _src symlink
-        ##-----> Already done build_entry_for()
 
 
-      # STEP 4: If in production mode, remove extra assets that should never be built 
+
+      #  c. Remove the entries for anything that is not JS, CSS, HTML or 
+      #     Resource
       else
-        
-        #  c. Remove the entries for anything that is not JS, CSS, HTML or Resource
-        entries.delete(:fixture)
         entries.delete(:test)
       end
-      
-      # STEP 5: Add entry for javascript.js & stylesheet.js.  If in production mode, set
-      # these to visible and hide the composite.  If in dev mode, do the opposite.
-      
-      hide_composite = (self.build_mode != :development)
-  
-      #  a. Combine the JS file paths into a single entry for the javascript.js
-      if (working = entries[:javascript]) && working.size>0
-        entry = build_entry_for('javascript.js', :javascript, working, hide_composite)
-        entry.hidden = true unless hide_composite
-        working << entry
-      end
-    
-      #  b. Combine the CSS file paths into a single entry for the stylesheet.css
-      if (working = entries[:stylesheet]) && working.size>0
-        entry = build_entry_for('stylesheet.css', :stylesheet, working, hide_composite)
-        entry.hidden = true unless hide_composite
-        working << entry
-      end
-      
-      # Save entries into hashes 
+
+
+      # Save entries into hashes
       @entries_by_type = entries
       @entries_by_filenames = {}
-      entries.values.flatten.each { |entry| @entries_by_filename[entry.filename] = entry }
+      entries.values.flatten.each do |entry| 
+        @entries_by_filename[entry.filename] = entry
+      end
     end
-    
-    # Build a catalog of entries for this manifest.  This will simply filter out the files
-    # that don't actually belong in the current language
+
+    # Build a catalog of entries for this manifest.  This will simply filter 
+    # out the files that don't actually belong in the current language
     def catalog_entries
 
       # Entries arranged by resource filename
       entries = {}
       default_lproj_entries = {}
       target_lproj_entries = {}
-      
+
       # Get the name of the lproj dirs for the default and current languages
       default_lproj = bundle.lproj_for(bundle.preferred_language)
       target_lproj = bundle.lproj_for(language)
-      
+
       # Any files living in the two lproj dirs will be shunted off into these arrays
       # and processed later to make sure we process them in the right order
       default_lproj_files = []
@@ -145,15 +172,15 @@ module SproutCore
       # Now, glob all the files and sort through them
       old_wd = Dir.getwd; Dir.chdir(bundle.source_root)
       Dir.glob(File.join('**','*')).each do | src_path |
-        
+
         # Get source type.  Skip any without a useful type
         next if (src_type = type_of(src_path)) == :skip
-        
+
         # Get current lproj (if there is one).  Skip if not default or current
         if current_lproj = src_path.match(/^([^\/]+\.lproj)\//).to_a[1]
           next if (current_lproj != default_lproj) && (current_lproj != target_lproj)
         end
- 
+
         # OK, pass all of our validations.  Go ahead and build an entry for this
         # Add entry to list of entries for appropriate lproj if localized
         entry = build_entry_for(src_path, src_type)
@@ -163,8 +190,8 @@ module SproutCore
         when target_lproj
           target_lproj_entries[entry.filename] = entry
         else
-          
-          # Be sure to mark any 
+
+          # Be sure to mark any
           entries[entry.filename] = entry
         end
       end
@@ -178,9 +205,9 @@ module SproutCore
       # Finally, entries will need to be grouped by type to allow further processing.
       ret = {}
       entries.values.each { |entry| (ret[entry.type] ||= []) << entry }
-      return ret 
+      return ret
     end
-    
+
     # Determines the type for this manifest entry.  Should be one of:
     #
     # stylesheet::   a CSS file
@@ -188,16 +215,16 @@ module SproutCore
     # html::         an HTML file
     #
     # test::         a test file (inside of /tests)
-    # fixture::      a fixture file (inside of /fixtures)      
-    # 
+    # fixture::      a fixture file (inside of /fixtures)
+    #
     # resource::     any other file inside an lproj dir
     # skip::      any other file outside of an lproj dir directories
-    # 
+    #
     # If you need to handle additional types of resources in the future, this is the place to
     # put it.
     #
     # ==== Params
-    # 
+    #
     # src_path:: The source path, relative to source_root.
     #
     def type_of(src_path)
@@ -221,10 +248,10 @@ module SproutCore
         :skip
       end
     end
-    
-    # Build an entry for the resource at the named src_path (relative to the 
-    # source_root) This should assume we are in going to simply build each 
-    # resource into the build root without combining files, but not using our 
+
+    # Build an entry for the resource at the named src_path (relative to the
+    # source_root) This should assume we are in going to simply build each
+    # resource into the build root without combining files, but not using our
     # _src symlink magic.
     def build_entry_for(src_path, src_type, composite=nil, hide_composite = true)
       ret = ManifestEntry.new
@@ -233,32 +260,32 @@ module SproutCore
       ret.original_path = src_path
       ret.hidden = false
       ret.language = language
-      
+
       # the filename is the src_path less any lproj in the front
       ret.filename = src_path.gsub(/^[^\/]+.lproj\//,'')
-      
+
       # the source path is just the combine source root + the path
       ret.source_path = (composite.nil?) ? File.join(bundle.source_root, src_path) : nil
-      
-      # set the composite property.  The passed in array should contain other 
-      # entries if hide_composite is true, then hide the composite items as 
+
+      # set the composite property.  The passed in array should contain other
+      # entries if hide_composite is true, then hide the composite items as
       # well
       unless composite.nil?
         composite.each { |x| x.hidden = true } if hide_composite
-        ret.composite = composite.map { |x| x.filename }
+        ret.composite = composite
       end
-      
+
       # The build path is the build_root + the filename
       # The URL is the url root + the language code + filename
-      # also add in _cache or _sym in certain cases.  This is just more 
+      # also add in _cache or _sym in certain cases.  This is just more
       # efficient than doing it later.
       url_root = (src_path == 'index.html') ? bundle.index_root : bundle.url_root
       cache_link = nil
       use_source_directly =false
-      
-      # Note: you can only access real resources via the cache.  If the entry 
+
+      # Note: you can only access real resources via the cache.  If the entry
       # is a composite then do not go through cache.
-      if (self.build_mode == :development) && composite.nil?
+      if (self.build_mode == :development) #&& composite.nil?
         cache_link = '_cache' if CACHED_TYPES.include?(src_type)
         use_source_directly = true if SYMLINKED_TYPES.include?(src_type)
       end
@@ -271,11 +298,11 @@ module SproutCore
         ret.build_path = File.join(*[bundle.build_root, language.to_s, cache_link, ret.filename].compact)
         ret.url = [url_root, language.to_s, cache_link, ret.filename].compact.join('/')
       end
-      
+
       # Done.
       return ret
     end
-    
+
     # Lookup the timestamp on the source path and interpolate that into the filename URL.
     # also insert the _cache element.
     def setup_timestamp_token(entry)
@@ -285,8 +312,6 @@ module SproutCore
 
       extname = File.extname(entry.build_path)
       entry.build_path = entry.build_path.gsub(/#{extname}$/,"-#{timestamp}#{extname}") # add timestamp
-      
-      puts "\n\n*setup_timestamp_token(#{entry.url} - #{entry.timestamp})" if /docs-/ =~ entry.url
     end
   end
 
@@ -296,38 +321,55 @@ module SproutCore
   # ext::          the file extension
   # source_path:: absolute paths into source that will comprise this resource
   # url::          the url that should be used to reference this resource in the current mode.
-  # build_url::    the url that will be used to referene this resource in production.  
+  # build_url::    the url that will be used to referene this resource in production.
   # build_path::   absolute path to the compiled resource
   # type::         the top-level category
   # original_path:: save the original path used to build this entry
   # hidden::       if true, this entry is needed internally, but otherwise should not be used
-  # use_source_directly::  if true, then this entry should be handled via the build symlink 
+  # use_source_directly::  if true, then this entry should be handled via the build symlink
   # language::     the language in use when this entry was created
-  # composite::    If set, this will contain the filenames of other resources that should be combined to form this resource.  
+  # composite::    If set, this will contain the filenames of other resources that should be combined to form this resource.
   #
-  class ManifestEntry < Struct.new(:filename, :ext, :source_path, :url, :build_path, :type, :original_path, :hidden, :use_source_directly, :language, :composite)
+  class ManifestEntry < Struct.new(:filename, :ext, :source_path, :url, :build_path, :type, :original_path, :hidden, :use_source_directly, :language)
     def to_hash
       ret = {}
       self.members.zip(self.values).each { |p| ret[p[0]] = p[1] }
       ret.symbolize_keys
     end
+
+    def composite; @composite; end
+    def composite=(ary); @composite=ary; end
     
     def hidden?; !!hidden; end
     def use_source_directly?; !!use_source_directly; end
     def composite?; !!composite; end
-    
+
     def localized?; !!source_path.match(/\.lproj/); end
-      
-      # Returns true if this entry can be cached even in development mode.  Composite resources
-    # and tests need to be regenerated whenever you get this.
+
+    # Returns true if this entry can be cached even in development mode.  
+    # Composite resources and tests need to be regenerated whenever you get 
+    # this.
     def cacheable?
       !composite? && (type != :test)
     end
+
+    def composite_filenames
+      @composite_filenames ||= (composite || []).map { |x| x.filename }
+    end
     
-    # Returns the mtime of the source_path.  If this entry is a composite or if the source
-    # file does not exist, returns nil
+    # Returns the mtime of the source_path.  If this entry is a composite 
+    # return the latest mtime of the items or if the source file does not 
+    # exist, returns nil
     def source_path_mtime
-      (composite? || !File.exists?(source_path)) ? nil : File.mtime(source_path)
+      return @source_path_mtime unless @source_path_mtime.nil?
+      
+      if composite?
+        mtimes = (composite || []).map { |x| x.source_path_mtime }
+        ret = mtimes.compact.sort.last
+      else
+        ret = (!File.exists?(source_path)) ? nil : File.mtime(source_path)
+      end
+      return @source_path_mtime = ret 
     end
 
     # Returns a timestamp based on the source_path_mtime.  If source_path_mtime is nil, always
@@ -335,12 +377,17 @@ module SproutCore
     def timestamp
       (source_path_mtime || Time.now).to_i.to_s
     end
-    
+
     # Returns the content type for this entry.  Based on a set of MIME_TYPES borrowed from Rack
     def content_type
       MIME_TYPES[File.extname(build_path)[1..-1]] || 'text/plain'
     end
 
+    # Returns a URL that takes into account caching requirements.
+    def cacheable_url
+      [url, timestamp].compact.join('?')
+    end
+
     # :stopdoc:
     # From WEBrick.
     MIME_TYPES = {
@@ -400,7 +447,7 @@ module SproutCore
       "zip"   => "application/zip",
     }
     # :startdoc:
-        
+
   end
-  
-end
+
+end

data/lib/sproutcore/generator_helper.rb

@@ -1,17 +1,17 @@
 
 module SproutCore
-  
+
   # You can use these methods basically copy the contents of your templates
   # directory into a target location.
   module GeneratorHelper
-    
+
     def apply_template(m, root_dir)
       m.directory root_dir
-    
+
       template_directories.each do |d|
         m.directory File.join(root_dir,d)
       end
-    
+
       template_files.each do |f|
         f_out = File.join(root_dir,f)
         if f =~ /\.rhtml$/
@@ -21,9 +21,9 @@ module SproutCore
         end
       end
     end
-    
+
     def template_directories
-      template_files(true) 
+      template_files(true)
     end
 
     def template_files(directories=false, cur_dir=nil,cur_base=nil)
@@ -48,7 +48,7 @@ module SproutCore
 
       return ret
     end
-    
+
     def build_client_directories(m, path)
       parts = File.dirname(path).split('/')
       cpath = []
@@ -57,7 +57,7 @@ module SproutCore
         m.directory File.join(cpath)
       end
     end
-      
+
     # Convert the Ruby version of the class name to a JavaScript version.
     def client_class_name
       class_name.gsub('::','.')
@@ -68,56 +68,56 @@ module SproutCore
       parts.pop
       return parts * '.'
     end
-    
+
     def controller_class_name
       ret = client_class_name
       ret += 'Controller' unless ret =~ /Controller$/
       ret
     end
-    
+
     def controller_instance_name
       ret = controller_class_name.split('.')
       ret[ret.size-1] = ret.last.underscore.camelize(:lower)
       return ret * "."
     end
-    
+
     def view_class_name
       ret = client_class_name
       ret += 'View' unless ret =~ /View$/
       ret
     end
-    
+
     # This will convert the file_name provided by Rails to one suitable for
     # the client.  i.e. calendar/event => calendar/sub_dir/event
     def client_file_path(sub_dir, ext=nil, to_strip = nil, fp = nil)
       parts = (fp.nil? ? file_path : fp).split('/')
-      
+
       # Determine the root dir.  Search clients then frameworks.
       loc = @client_location
-      
+
       # check for clients
       if loc.nil?
         client_path = File.join(destination_root, "clients")
         app_name = parts.first
-        loc = "clients" if File.exists?(client_path) && Dir.new(client_path).include?(app_name) 
+        loc = "clients" if File.exists?(client_path) && Dir.new(client_path).include?(app_name)
       end
 
       # check for frameworks
       if loc.nil?
         client_path = File.join(destination_root, "frameworks")
         app_name = parts.first
-        loc = "frameworks" if File.exists?(client_path) && Dir.new(client_path).include?(app_name) 
+        loc = "frameworks" if File.exists?(client_path) && Dir.new(client_path).include?(app_name)
       end
-      
+
       loc = "clients" if loc.nil? # fallback
-      
+
       path = parts.insert(parts.size-1,sub_dir).unshift(loc) * '/'
-      
+
       # We want to stop the final part of the name for controllers and views.
       if to_strip && (path =~ /_#{to_strip}$/)
         path = path.slice(0,path.size - (to_strip.size + 1))
       end
-      
+
       [path,ext].compact * '.'
     end
 
@@ -125,10 +125,10 @@ module SproutCore
     def base_class_name(default_base_class_name = 'SC.Object')
       @args.first || default_base_class_name
     end
-    
+
     ###################
     # Borrowed from Rails NamedBase
-    
+
     attr_reader   :name, :class_name, :singular_name, :plural_name
     attr_reader   :class_path, :file_path, :class_nesting, :class_nesting_depth
     alias_method  :file_name,  :singular_name
@@ -163,7 +163,7 @@ module SproutCore
       plural = under.pluralize
       [camel, under, plural]
     end
-    
+
   end
 end
 

data/lib/sproutcore/helpers/capture_helper.rb

@@ -1,7 +1,7 @@
 module SproutCore
-  
+
   module Helpers
-    
+
     module CaptureHelper
 
       # Captures the resulting value of the block and returns it
@@ -11,32 +11,32 @@ module SproutCore
         rescue
           buffer = nil
         end
-        
+
         if buffer.nil?
           block.call(*args).to_s
         else
           pos = buffer.length
           block.call(*args)
-          
+
           # get emitted data
           data = buffer[pos..-1]
-          
+
           # remove from buffer
           buffer[pos..-1] = ''
-          
+
           data
         end
       end
-      
+
       # executes the passed block, placing the resulting content into a variable called
       # @content_for_area_name.  You can insert this content later by including this
       # variable or by calling yield(:area_name)
       #
-      def content_for(name, &block)  
+      def content_for(name, &block)
         eval "@content_for_#{name} = (@content_for_#{name} || '') + capture(&block)"
       end
-            
+
     end
-    
+
   end
 end