sproutit-sproutcore 1.0.0.20090407205609

data/lib/sproutcore/builders/base.rb

@@ -0,0 +1,79 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  
+  # Builder classes implement the more complex algorithms for building 
+  # resources in SproutCore such as building HTML, JavaScript or CSS.  
+  # Builders are usually invoked from within build tasks which are, in-turn,
+  # selected by the manifest.
+  #
+  module Builder    
+  
+    # The base class extended by most builder classes.  This contains some
+    # default functionality for handling loading and writing files.  Usually
+    # you will want to consult the specific classes instead for more info.
+    #
+    class Base
+      # entry the current builder is working on
+      attr_accessor :entry 
+
+      def initialize(entry=nil)
+        @entry =entry
+      end
+
+      # override this method in subclasses to actually do build
+      def build(dst_path)
+      end
+
+      # main entry called by build tasls
+      def self.build(entry, dst_path)
+        new(entry).build(dst_path)
+      end
+
+      # Reads the lines from the source file.  If the source file does not 
+      # exist, returns empty array.
+      def readlines(src_path)
+        if File.exist?(src_path) && !File.directory?(src_path) 
+          File.readlines(src_path)
+        else
+          []
+        end
+      end
+
+      # joins the array of lines.  this is where you can also do any final
+      # post-processing on the build
+      def joinlines(lines)
+        lines * ""
+      end
+
+      # writes the passed lines to the named file
+      def writelines(dst_path, lines)
+        FileUtils.mkdir_p(File.dirname(dst_path))
+        f = File.open(dst_path, 'w')
+        f.write joinlines(lines)
+        f.close
+      end
+
+      # Handles occurances of sc_static() or static_url()
+      def replace_static_url(line)
+        line.gsub(/(sc_static|static_url)\(\s*['"](.+)['"]\s*\)/) do | rsrc |
+          static_entry = entry.manifest.find_entry($2)
+          static_url(static_entry.nil? ? '' : static_entry.cacheable_url)
+        end
+      end
+
+      # Generates the proper output for a given static url and a given target
+      # this is often overridden by subclasses.  the default just wraps in 
+      # quotes.
+      def static_url(url='')
+        ["'", url.gsub('"','\"'),"'"].join('')
+      end
+    end # class
+    
+  end # module Builder
+end # module SC

data/lib/sproutcore/builders/combine.rb

@@ -0,0 +1,37 @@
+# ===========================================================================
+# 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::Combine < Builder::Base
+    
+    def build(dst_path)
+      lines = []
+      entries = entry.ordered_entries || entry.source_entries
+      
+      entries.each do |entry|
+        src_path = entry.stage!.staging_path
+        next unless File.exist?(src_path)
+        
+        lines << "/* >>>>>>>>>> BEGIN #{entry.filename} */\n"
+        lines += readlines(src_path)
+        lines << "\n"
+      end
+      writelines dst_path, lines
+    end
+    
+  end
+  
+end

data/lib/sproutcore/builders/html.rb

@@ -0,0 +1,177 @@
+# ===========================================================================
+# 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)
+      content_for_key = self.default_content_for_key if content_for_key.nil?
+      
+      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 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,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 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) }
+      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
+        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,67 @@
+# ===========================================================================
+# 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 " + entry.source_path + " -o " + dst_path
+	    SC.logger.info  'Compressing CSS with YUI .... '+ dst_path
+	    SC.logger.debug `#{filecompress}`
+
+	    if $?.exitstatus != 0
+	      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 " + entry.source_path + " -o " + dst_path
+      SC.logger.info  'Compressing with YUI .... '+ dst_path
+      SC.logger.debug `#{filecompress}`
+      
+      if $?.exitstatus != 0
+        SC.logger.fatal("!!!!YUI compressor failed, please check that your js code is valid and doesn't contain reserved statements like debugger;")
+        SC.logger.fatal("!!!!Failed compressing ... "+ dst_path)
+      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