sproutcore 1.4.0-java

data/lib/sproutcore/builders/base.rb

@@ -0,0 +1,90 @@
+# ===========================================================================
+# 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 tasks
+      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|sc_target)\(\s*['"](.+)['"]\s*\)/) do | rsrc |
+          entry_name = $2
+          entry_name = "#{$2}:index.html" if $1 == 'sc_target'
+          static_entry = entry.manifest.find_entry($2)
+
+          if !static_entry
+            url = ''
+          elsif $1 == 'sc_target'
+            url = static_entry[:friendly_url] || static_entry.cacheable_url
+          else
+            url = static_entry.cacheable_url
+          end
+
+          static_url(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('"', '\"')}'"
+      end
+    end # class
+
+  end # module Builder
+end # module SC

data/lib/sproutcore/builders/bundle.rb

@@ -0,0 +1,63 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require "sproutcore/builders/base"
+
+module SC
+
+  # Builds a bundle_loaded.js file which MUST be the last JavaScript to load
+  # in a framework.
+  class Builder::BundleLoaded < Builder::Base
+
+    def build(dst_path)
+      writelines dst_path, ["; if ((typeof SC !== 'undefined') && SC && SC.bundleDidLoad) SC.bundleDidLoad('#{entry.target[:target_name].to_s.sub(/^\//,'')}');"]
+    end
+
+  end
+
+  # Builds a bundle_info.js file which MUST be run *before* the framework is
+  # loaded by the application or framework doing the loading.
+  class Builder::BundleInfo < Builder::Base
+
+    def build(dst_path)
+      begin
+        require 'erubis'
+      rescue
+        raise "Cannot render bundle_info.js because erubis is not installed. Try running 'sudo gem install erubis' and try again."
+      end
+
+      eruby = Erubis::Eruby.new <<-EOT
+        ;(function() {
+          var target_name = '<%= @target_name %>' ;
+          if (!SC.BUNDLE_INFO) throw "SC.BUNDLE_INFO is not defined!" ;
+          if (SC.BUNDLE_INFO[target_name]) return ; <%# not an error... %>
+
+          <%# first time, so add a Hash with this target's bundle_info %>
+          SC.BUNDLE_INFO[target_name] = {
+            requires: [<%= @requires.join(',') %>],
+            styles:   [<%= @styles.join(',') %>],
+            scripts:  [<%= @scripts.join(',') %>]
+          }
+        })();
+      EOT
+
+      output = ""
+      entry.targets.each do |t|
+        bundle_info = t.bundle_info({ :debug => entry[:debug], :test => entry[:test], :theme => entry[:theme], :variation => entry[:variation] })
+        output << eruby.evaluate({
+          :target_name => t[:target_name].to_s.sub(/^\//,''),
+          :requires => bundle_info[:requires].map{ |t| "'#{t[:target_name].to_s.sub(/^\//,'')}'" },
+          :styles   => bundle_info[:css_urls].map{ |url| "'#{url}'" },
+          :scripts  => bundle_info[:js_urls].map{  |url| "'#{url}'" }
+        })
+      end
+      writelines dst_path, [output]
+    end
+
+  end
+
+end

data/lib/sproutcore/builders/combine.rb

@@ -0,0 +1,60 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require "sproutcore/builders/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]
+
+      target_name = entry.target[:target_name].to_s.sub(/^\//,'')
+      if entry[:top_level_lazy_instantiation] && entry[:combined]
+        lines << ";
+if ((typeof SC !== 'undefined') && SC && !SC.LAZY_INSTANTIATION) {
+  SC.LAZY_INSTANTIATION = {};
+}
+if(!SC.LAZY_INSTANTIATION['#{target_name}']) {
+  SC.LAZY_INSTANTIATION['#{target_name}'] = [];
+}
+SC.LAZY_INSTANTIATION['#{target_name}'].push(
+  (
+    function() {
+"
+      end
+
+      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
+
+      if entry[:top_level_lazy_instantiation] && entry[:combined]
+        lines << "
+    }
+  )
+);
+"
+    end
+      writelines dst_path, lines
+    end
+
+  end
+
+end

data/lib/sproutcore/builders/html.rb

@@ -0,0 +1,211 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require "sproutcore/builders/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)
+      if CONFIG[:html5_manifest]
+        $to_html5_manifest << dst_path
+        $to_html5_manifest_networks = CONFIG[:html5_manifest_networks]
+        @content_for_html5_manifest = true
+      end
+      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), input_path )
+      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)
+      @content_for_designer = '<script type="text/javascript">SC.suppressMain = YES;</script>' if $design_mode
+      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, input_path="(compiled erb)")
+      self.instance_eval "def __render(); #{compiled_template}; end", input_path
+      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,101 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require "sproutcore/builders/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 readlines(src_path)
+      if File.exist?(src_path) && !File.directory?(src_path)
+        File.read(src_path)
+      else
+        ""
+      end
+    end
+
+    def writelines(dst_path, lines)
+      FileUtils.mkdir_p(File.dirname(dst_path))
+      File.open(dst_path, 'w') do |f|
+        f.write lines
+      end
+    end
+
+    def build(dst_path)
+      lines = ""
+      target_name = entry.target[:target_name].to_s.sub(/^\//,'')
+
+      if entry[:lazy_instantiation] && entry[:notify_onload]
+      lines << ";
+if ((typeof SC !== 'undefined') && SC && !SC.LAZY_INSTANTIATION) {
+  SC.LAZY_INSTANTIATION = {};
+}
+if(!SC.LAZY_INSTANTIATION['#{target_name}']) {
+  SC.LAZY_INSTANTIATION['#{target_name}'] = [];
+}
+SC.LAZY_INSTANTIATION['#{target_name}'].push(
+  (
+    function() {
+"
+      end
+
+      lines << rewrite_inline_code(readlines(entry[:source_path]))
+
+      # Try to load dependencies if we're not combining javascript.
+      if entry[:notify_onload]
+        lines << "; if ((typeof SC !== 'undefined') && SC && SC.scriptDidLoad) SC.scriptDidLoad('#{target_name}');"
+      end
+
+      if entry[:lazy_instantiation] && entry[:notify_onload]
+        lines << "
+    }
+  )
+);
+"
+      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(code)
+
+      # Fors strings file, remove server-side keys (i.e '@@foo' = 'bar')
+      if localized_strings?
+        code.gsub!(/["']@@.*["']\s*?:\s*?["'].*["']\s*,\s*$/,'')
+
+      # Otherwise process sc_super
+      else
+        code.gsub!(/sc_super\(\s*\)/, 'arguments.callee.base.apply(this,arguments)')
+        code.gsub!(/sc_super\((.+?)\)/) do
+          SC.logger.warn "\nWARNING: Calling sc_super() with arguments is DEPRECATED. Please use sc_super() only.\n\n"
+          "arguments.callee.base.apply(this, #{$1})"
+        end
+      end
+
+      # and finally rewrite static_url
+      replace_static_url(code)
+      code
+    end
+
+  end
+
+end