sproutcore 0.9.23 → 1.0.1003

data/lib/sproutcore/builders/html.rb

@@ -0,0 +1,205 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+
+module SC
+
+  # Builds an HTML files.  This will setup an HtmlContext and then invokes
+  # the render engines for each source before finally rendering the layout.
+  class Builder::Html < Builder::Base
+    
+    include SC::Helpers::TagHelper
+    include SC::Helpers::TextHelper
+    include SC::Helpers::CaptureHelper
+    include SC::Helpers::StaticHelper
+    include SC::Helpers::DomIdHelper
+    include SC::ViewHelpers
+    
+    # the entry we are building
+    attr_reader :entry
+    
+    # bundle is an alias for target included for backwards compatibility
+    attr_reader :target, :bundle
+    
+    # the full set of entries we plan to build
+    attr_reader :entries
+    
+    # the final filename
+    attr_reader :filename
+    
+    # the current builder language
+    attr_reader :language
+    
+    # library is an alias for project for backwards compatibility
+    attr_reader :project, :library
+    
+    # the current render
+    attr_reader :renderer
+    
+    # manifest owning the current entry
+    attr_reader :manifest
+    
+    def target_name; target.target_name.to_s.sub(/^\//,''); end
+    alias_method :bundle_name, :target_name # backwards compat
+    
+    def config; target.config; end
+    
+    # The entry for the layout we want to build.  this will be used to 
+    # stage the layout if needed..
+    def layout_entry
+      @manifest.entry_for(@layout) || @manifest.entry_for(@layout, :hidden => true)
+    end
+    
+    # the path to the current layout for the resource.  this is computed 
+    # from the layout property, which is a relative pathname.
+    def layout_path
+      entry = layout_entry
+      entry.nil? ? nil : entry.staging_path
+    end
+    
+    def initialize(entry)
+      super(entry)
+      @target = @bundle = entry.manifest.target
+      @filename = entry.filename
+      @language = @entry.manifest.language
+      @project = @library = @target.project
+      @manifest = entry.manifest
+      @renderer = nil
+      
+      # set the current layout from the target's config.layout
+      @layout = @target.config.layout || 'lib/index.rhtml'
+      
+      # find all entries -- use source_Entries + required if needed
+      @entries = entry.source_entries.dup
+      if entry.include_required_targets?
+        @target.expand_required_targets.each do |target|
+          cur_manifest = target.manifest_for(@manifest.variation).build!
+          cur_entry = cur_manifest.entry_for(entry.filename, :combined => true) || cur_manifest.entry_for(entry.filename, :hidden => true, :combined => true)
+          next if cur_entry.nil?
+          @entries += cur_entry.source_entries
+        end
+      end
+    end
+
+    # Returns the expanded list of required targets for the passed target.
+    # This method can be overridden by subclasses to provide specific 
+    # config settings.
+    def expand_required_targets(target, opts = {})
+      opts[:debug] = target.config.load_debug
+      opts[:theme] = true
+      return target.expand_required_targets(opts)
+    end
+    
+    # Renders the html file, returning the resulting string which can be 
+    # written to a file.
+    def render
+      
+      # render each entry...
+      @entries.each { |entry| render_entry(entry) }
+      
+      # then finally compile the layout.
+      if self.layout_path.nil?
+        raise "html_builder could not find a layout file for #{@layout}" 
+      end
+      
+      compile(SC::RenderEngine::Erubis.new(self), self.layout_path, :_final_)
+      return @content_for__final_
+    end
+      
+    def build(dst_path)
+      writelines dst_path, [self.render]
+    end
+    
+    def default_content_for_key; :resources; end
+    
+    # Loads the passed input file and then hands it to the render_engine 
+    # instance to compile th file.  the results will be targeted at the
+    # @content_for_resources area by default unless you pass an optional
+    # content_for_key or otherwise override in your template.
+    #
+    # === Params
+    #  render_engine:: A render engine instance
+    #  input_path:: The file to load
+    #  content_for_key:: optional target for content
+    #
+    # === Returns
+    #  self
+    #
+    def compile(render_engine, input_path, content_for_key = nil)
+      
+      if content_for_key.nil?
+        if @in_partial
+          content_for_key = :_partial_ 
+        else
+          content_for_key = self.default_content_for_key 
+        end
+      end
+      
+      if !File.exist?(input_path)
+        raise "html_builder could compile file at #{input_path} because the file could not be found" 
+      end
+
+      old_renderer = @renderer
+      @renderer = render_engine  # save for capture...
+      
+      input = File.read(input_path)
+      
+      content_for content_for_key do
+        _render_compiled_template( render_engine.compile(input) )
+      end
+      
+      @render = old_renderer
+      return self
+    end
+
+    private
+    
+    # Renders an entry as a partial.  This will insert the results inline
+    # instead of into a content div.
+    def render_partial(entry) 
+
+      # save off
+      old_partial = @content_for__partial_
+      old_in_partial = @in_partial
+
+      @content_for__partial_ = ''
+      @in_partial = true
+      render_entry(entry)
+      ret = @content_for__partial_
+      @content_for__partial_ = old_partial
+      @in_partial = old_in_partial
+      
+      return ret
+      
+    end
+    
+    # Renders a single entry.  The entry will be staged and then its 
+    # render task will be executed.
+    def render_entry(entry)
+      entry.stage!
+      entry.target.buildfile.invoke entry.render_task,
+        :entry    => entry, 
+        :src_path => entry.staging_path,
+        :context  => self
+    end
+    
+    # Renders a compiled template within this context
+    def _render_compiled_template(compiled_template)
+      self.instance_eval "def __render(); #{compiled_template}; end"
+      begin
+        self.send(:__render) do |*names|
+          self.instance_variable_get("@content_for_#{names.first}")
+        end
+      ensure
+        class << self; self end.class_eval{ remove_method(:__render) } rescue nil
+      end
+    end
+    
+  end
+  
+end

data/lib/sproutcore/builders/javascript.rb

@@ -0,0 +1,62 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+require 'fileutils'
+
+module SC
+
+  # This build is used to process a single javascript file.  It will
+  # substitute any calls to sc_super and sc_static() (or static_url()).  It 
+  # does NOT product a combined JavaScript for production.  See the 
+  # Builder::CombinedJavaScript for more.
+  class Builder::JavaScript < Builder::Base
+    
+    def build(dst_path)
+      lines = readlines(entry.source_path).map { |l| rewrite_inline_code(l) }
+
+      # Try to load dependencies if we're not combining javascript.
+      if entry.notify_onload
+        lines << "; if ((typeof SC !== 'undefined') && SC && SC.scriptDidLoad) SC.scriptDidLoad('#{entry.target.target_name.to_s.sub(/^\//,'')}');"
+      end
+
+      writelines dst_path, lines
+    end
+
+    # Returns true if the current entry is a localized strings file.  These
+    # files receive some specialized processing to allow for server-side only
+    # strings.  -- You can name a string key beginning with "@@" and it will 
+    # be removed.
+    def localized_strings?
+      @lstrings ||= entry.localized? && entry.filename =~ /strings.js$/
+    end
+
+    # Rewrites inline content for a single line
+    def rewrite_inline_code(line)
+
+      # Fors strings file, remove server-side keys (i.e '@@foo' = 'bar')
+      if localized_strings?
+        line = line.gsub(/["']@@.*["']\s*?:\s*?["'].*["']\s*,\s*$/,'')
+
+      # Otherwise process sc_super 
+      else
+        return unless (line.valid_encoding?)
+        if line.match(/sc_super\(\s*\)/)
+          line = line.gsub(/sc_super\(\s*\)/, 'arguments.callee.base.apply(this,arguments)')
+        elsif line.match(/sc_super\(.+?\)/)
+          SC.logger.warn "\nWARNING: Calling sc_super() with arguments is DEPRECATED. Please use sc_super() only.\n\n"
+          line = line.gsub(/sc_super\((.+?)\)/, 'arguments.callee.base.apply(this, \1)')
+        end
+      end
+
+      # and finally rewrite static_url
+      return replace_static_url(line)
+    end
+    
+  end
+  
+end

data/lib/sproutcore/builders/minify.rb

@@ -0,0 +1,133 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+require 'fileutils'
+
+module SC
+
+  # This builder combines several javascript files into a single file.  It is
+  # used to prepare a single javascript file for production use.  This build
+  # tool expects the javascript files to have already been processed for any
+  # build directives such sc_static().
+  #
+  class Builder::Minify < Builder::Base
+    
+    # main entry called by build tasls
+    def self.build(entry, dst_path, kind)
+      new(entry, kind).build(dst_path)
+    end
+    
+    def initialize(entry=nil, kind=nil)
+      super(entry)
+      @kind = kind
+    end
+    
+    # override this method in subclasses to actually do build
+    def build(dst_path)
+      send("build_#{@kind}".to_sym, dst_path)
+    end
+    
+    def build_css(dst_path)
+      yui_root = File.expand_path(File.join(LIBPATH, '..', 'vendor', 'yui-compressor'))
+      jar_path = File.join(yui_root, 'yuicompressor-2.4.2.jar')
+      FileUtils.mkdir_p(File.dirname(dst_path)) # make sure loc exists...
+      filecompress = "java -jar " + jar_path + " --charset utf-8 --line-break 0 --nomunge --preserve-semi --disable-optimizations " + entry.source_path + " -o \"" + dst_path + "\" 2>&1"
+      SC.logger.info  'Compressing CSS with YUI .... '+ dst_path
+      SC.logger.debug `#{filecompress}`
+
+      if $?.exitstatus != 0
+        _report_error(output, entry.filename, entry.source_path)
+        SC.logger.fatal("!!!!YUI compressor failed, please check that your css code is valid.")
+        SC.logger.fatal("!!!!Failed compressing CSS... "+ dst_path)
+      end
+  	end
+    
+    # Minify some javascript by invoking the YUI compressor.
+    def build_javascript(dst_path)
+      yui_root = File.expand_path(File.join(LIBPATH, '..', 'vendor', 'yui-compressor'))
+      jar_path = File.join(yui_root, 'yuicompressor-2.4.2.jar')
+      FileUtils.mkdir_p(File.dirname(dst_path)) # make sure loc exists...
+      filecompress = "java -jar " + jar_path + " --charset utf-8 --line-break 80 " + entry.source_path + " -o \"" + dst_path + "\" 2>&1"
+      SC.logger.info  'Compressing with YUI:  '+ dst_path + "..."
+
+      output = `#{filecompress}`      # It'd be nice to just read STDERR, but
+                                      # I can't find a reasonable, commonly-
+                                      # installed, works-on-all-OSes solution.
+      if $?.exitstatus != 0
+        _report_error(output, entry.filename, entry.source_path)
+        SC.logger.fatal("!!!!YUI compressor failed, please check that your js code is valid")
+        SC.logger.fatal("!!!!Failed compressing ... "+ dst_path)
+      end
+      
+    end
+  
+  
+    def _report_error(output, input_filename, input_filepath)
+      # The output might have some clues to what exactly was wrong, and it'll
+      # be convenient for users if we include the subset.  So we'll read the
+      # line numbers from any output lines that start with "[ERROR]" those
+      # lines, too.
+      if output
+        parsed_a_line = false
+        output.each_line { |output_line|
+          output_line = output_line.chomp
+          if (output_line =~ /^\[ERROR\] (\d+):(\d+):.*/) != nil
+            line_number = $1
+            position    = $2
+            parsed_a_line = true
+            if ( position  &&  position.to_i > 0 )
+              # Read just that line and output it.
+              # (sed -n '3{;p;q;}' would probably be faster, but not
+              # universally available)
+              line_number  = line_number.to_i
+              line_counter = 1
+              begin
+                file = File.new(input_filepath, "r")
+                outputted_line = false
+                previous_line = nil
+                while (file_line = file.gets)
+
+                  if ( line_counter == line_number )
+                    message = "YUI compressor error:  #{output_line} on line #{line_number} of #{input_filename}:\n"
+                    if !previous_line.nil?
+                      message += "        [#{line_number - 1}]  #{previous_line}"
+                    end
+                    message   += "   -->  [#{line_number}]  #{file_line}"
+                  
+                    SC.logger.error message
+                    outputted_line = true
+                    break
+                  else
+                    previous_line = file_line
+                  end
+                  line_counter += 1
+                end
+                file.close
+              rescue => err
+                SC.logger.error "Could not read the actual line from the file:  #{err}"
+              end
+            
+              if !outputted_line
+                SC.logger.error "YUI compressor error:  #{output_line}, but couldn't read that line in the input file"
+              end
+            end
+          end
+        }
+      
+        # If we didn't handle at least one line of output specially, then
+        # just output it all.
+        if !parsed_a_line
+          SC.logger.error output
+        end
+      end
+    end
+  
+
+  end
+    
+end

data/lib/sproutcore/builders/sass.rb

@@ -0,0 +1,55 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+require 'fileutils'
+
+module SC
+
+  # This build can compile a Sass stylesheet.  At this point it does no
+  # further processing than simply executing the Sass.  It would be nice to 
+  # add support for sc_static and other directives at some point.
+  #
+  class Builder::Sass < Builder::Base
+    
+    def build(dst_path)
+      begin
+        require 'sass'
+      rescue
+        raise "Cannot compile #{entry.source_path} because sass is not installed.  Please try 'sudo gem install haml' and try again"
+      end
+
+      begin
+        content = readlines(entry.source_path)*''
+        content = ::Sass::Engine.new(content).render
+        writelines dst_path, [content]
+      rescue Exception => e
+        
+        # explain sass syntax error a bit more...
+        if e.is_a? Sass::SyntaxError
+          e_string = "#{e.class}: #{e.message}"
+          e_string << "\non line #{e.sass_line}"
+          e_string << " of #{@entry.source_path}"
+          if File.exists?(@entry.source_path)
+            e_string << "\n\n"
+            min = [e.sass_line - 5, 0].max
+            File.read(@entry.source_path).rstrip.split("\n")[
+              min .. e.sass_line + 5
+            ].each_with_index do |line, i|
+              e_string << "#{min + i + 1}: #{line}\n"
+            end # File.read
+          end # if File.exists?
+          raise e_string
+        else
+          raise e # reraise
+        end 
+      end # rescue
+    end # def
+    
+  end
+  
+end

data/lib/sproutcore/builders/strings.rb

@@ -0,0 +1,44 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+require 'fileutils'
+
+module SC
+
+  # This builder is used to generate a file containing all of the loc strings
+  # for a particular manifest.  The strings file is used when generating 
+  # HTML try to map localized strings
+  class Builder::Strings < Builder::Base
+    
+    def build(dst_path)
+      data = parse_strings_js(entry.source_path)
+      writelines dst_path, [data.to_yaml]
+    end
+    
+    def parse_strings_js(source_path)
+      return {} if !File.exists?(source_path)
+
+      # read the file in and strip out comments...
+      str = File.read(source_path)
+      str = str.gsub(/\/\/.*$/,'').gsub(/\/\*.*\*\//m,'')
+
+      # Now build the hash
+      ret = {}
+      str.scan(/['"](.+)['"]\s*:\s*['"](.+)['"],?\s*$/) do |x,y|
+        # x & y are JS strings that must be evaled as such..
+        #x = eval(%("#{x}"))
+        y = eval(%[<<__EOF__\n#{y}\n__EOF__]).chop
+        ret[x] = y
+      end
+      return ret 
+    end
+      
+    
+  end
+  
+end

data/lib/sproutcore/builders/stylesheet.rb

@@ -0,0 +1,40 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+require 'fileutils'
+
+module SC
+
+  # This builder is used to process a single CSS stylesheet.  Converts any
+  # build tool directives (such as sc_require() and sc_resource()) into 
+  # comments.  It will also substitute any calls to sc_static() (or 
+  # static_url())  This builder does NOT handle combining multiple stylesheets
+  # into one.  See the Builder::CombineStylesheets builder instead.
+  #
+  class Builder::Stylesheet < Builder::Base
+    
+    def build(dst_path)
+      lines = readlines(entry.source_path).map { |l| rewrite_inline_code(l) }
+      writelines dst_path, lines
+    end
+
+    # Rewrites any inline content such as static urls.  Subclasseses can
+    # override this to rewrite any other inline content.
+    #
+    # The default will rewrite calls to static_url().
+    def rewrite_inline_code(line)
+      # look for sc_require, require or sc_resource.  wrap in comment
+      line = line.gsub(/((sc_require|require|sc_resource)\(\s*['"].*["']\s*\)\s*\;)/, '/* \1 */')
+      line = replace_static_url(line)
+    end
+    
+    def static_url(url=''); "url('#{url}')" ; end
+    
+  end
+  
+end

data/lib/sproutcore/builders/test.rb

@@ -0,0 +1,59 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'html'))
+
+module SC
+
+  # Builds an HTML files.  This will setup an HtmlContext and then invokes
+  # the render engines for each source before finally rendering the layout.
+  class Builder::Test < Builder::Html
+    
+    def initialize(entry)
+      super(entry)
+      @layout = @target.config.test_layout || 'lib/test.rhtml'
+    end
+    
+    # Always include any required test targets as well when loading unit 
+    # tests.
+    def expand_required_targets(target, opts = {})
+      opts[:test] = true
+      super(target, opts)
+    end
+    
+    protected 
+    
+    def render_entry(entry)
+      entry.stage!
+
+      case entry.ext
+      when 'js'
+        render_jstest(entry)
+      when 'rhtml'
+        entry.target.buildfile.invoke 'render:erubis',
+          :entry    => entry, 
+          :src_path => entry.staging_path,
+          :context  => self
+      end
+    end
+    
+    def default_content_for_key; :body; end
+    
+    # Renders an individual test into a script tag.  Also places the test 
+    # into its own closure so that globals defined by one test will not 
+    # conflict with any others.
+    def render_jstest(entry)
+      lines = readlines(entry.staging_path)
+      pathname = entry.staging_path.gsub(/^.+\/staging\//,'').gsub(/"/, '\"')
+      lines.unshift %[<script type="text/javascript">\nif (typeof SC !== "undefined") {\n  SC.mode = "TEST_MODE";\n  SC.filename = "#{pathname}"; \n}\n(function() {\n]
+      lines.push    %[\n})();\n</script>\n]
+      @content_for_final = (@content_for_final || '') + lines.join("")
+    end
+    
+  end
+  
+end

data/lib/sproutcore/builders/test_index.rb

@@ -0,0 +1,26 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'base'))
+
+module SC
+
+  # Builds an HTML files.  This will setup an HtmlContext and then invokes
+  # the render engines for each source before finally rendering the layout.
+  class Builder::TestIndex < Builder::Base
+    
+    def build(dst_path)
+      require 'json'
+      items = entry.source_entries.map do |e|
+        { "filename" => e.filename.ext(''), "url" => e.url }
+      end
+      writelines dst_path, [items.to_json]
+    end
+    
+  end
+  
+end

data/lib/sproutcore/buildfile/build_task.rb

@@ -0,0 +1,33 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(File.dirname(__FILE__), 'task'))
+
+module SC
+
+  # Just like a normal task, but will not run if the destination path already
+  # exists and it is newer than the source.
+  class Buildfile::BuildTask < ::SC::Buildfile::Task
+
+    def needed?
+      return true if DST_PATH.nil? || SRC_PATHS.nil? # just try to build...
+      return true if !File.exist?(DST_PATH)
+      ret = false
+      dst_mtime = File.mtime(DST_PATH)
+      SRC_PATHS.each do |path|
+        next if path.nil? # skip incase of bad src paths...
+        
+        timestamp = File.exist?(path) ? File.mtime(path) : EARLY
+        ret = ret || (dst_mtime < timestamp)
+        break if ret
+      end
+      return ret 
+    end
+    
+  end
+end
+