sproutit-sproutcore 1.0.0.20090407205609

data/lib/sproutcore/rack/dev.rb

@@ -0,0 +1,51 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require 'json'
+
+module SC
+  module Rack
+
+    # Hosts general dev environment-related JSON assets.
+    class Dev
+      
+      def initialize(project)
+        @project = project
+      end
+      
+      def call(env)
+        url = env['PATH_INFO']
+        case url
+        when '/sc/targets.json' # returns description of targets
+          return [200, {}, get_targets_json]
+        else
+          return [404, {}, "not found"]
+        end
+          
+        return [404, {}, "not found"]
+      end
+      
+      def get_targets_json
+        targets = @project.targets.values.map do |target|
+          target.prepare!
+          parent = target.parent_target
+          parent = parent.kind_of?(SC::Target) ? parent.target_name : ''
+          {
+            "name" => target.target_name,
+            "kind" => target.target_type,
+            "parent" => parent,
+            "link_tests" => [target.url_root, 'en', target.build_number, 'tests', '-index.json'].join('/'),
+            "link_docs"  => [target.url_root, 'en', target.build_number, 'docs', '-index.json'].join('/'),
+            "link_root" => target.url_root
+          }
+        end
+        targets.to_json
+      end
+      
+    end
+  end
+end

data/lib/sproutcore/rack/docs.rb

@@ -0,0 +1,24 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  module Rack
+
+    # Rewrites relevant requests to load the SproutCore docs tools for a 
+    # given project.
+    class Docs
+      
+      def initialize(project)
+        @project = project
+      end
+      
+      def call(env)
+        return [404, {}, "not found"]
+      end
+    end
+  end
+end

data/lib/sproutcore/rack/proxy.rb

@@ -0,0 +1,92 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require 'net/http'
+module SC
+  module Rack 
+     
+    # Rack application proxies requests as needed for the given project. 
+    class Proxy 
+       
+      def initialize(project) 
+        @project = project
+        @proxies = project.buildfile.proxies
+      end 
+       
+      def call(env)        
+        url = env['PATH_INFO']
+        
+        @proxies.each do |proxy, value|
+          if url.match(proxy.to_s)
+            return handle_proxy(value, proxy.to_s, env)
+          end
+        end
+        
+        return [404, {}, "not found"]
+      end
+      
+      def handle_proxy(proxy, proxy_url, env)  
+        origin_host = env['SERVER_NAME'] # capture the origin host for cookies
+        http_method = env['REQUEST_METHOD'].to_s.downcase
+        url = env['PATH_INFO']
+        params = env['QUERY_STRING']
+                
+        # collect headers...
+        headers = {}
+        env.each do |key, value|
+          next unless key =~ /^HTTP_/
+          key = key.gsub(/^HTTP_/,'')
+          headers[key] = value
+        end
+        
+        http_host, http_port = proxy[:to].split(':')
+        http_port = '80' if http_port.nil?
+        
+        if proxy[:url]
+          url = url.sub(/^#{Regexp.escape proxy_url}/, proxy[:url])
+        end
+        
+        http_path = [url]
+        http_path << params if params && params.size>0
+        http_path = http_path.join('?')
+         
+        response = nil
+        no_body_method = %w(delete get copy head move options trace) 
+        ::Net::HTTP.start(http_host, http_port) do |http|
+          if no_body_method.include?(http_method)
+            response = http.send(http_method, http_path, headers)
+          else
+          	http_body = env['rack.input'].gets || ''
+            response = http.send(http_method, http_path, http_body, headers)
+          end
+        end
+         
+        status = response.code # http status code
+        
+        SC.logger << "~ PROXY: #{http_method.upcase} #{status} #{url} -> http://#{http_host}:#{http_port}#{http_path}\n"
+        
+        # display and construct specific response headers
+        response_headers = {}
+        ignore_headers = ['transfer-encoding', 'keep-alive', 'connection'] 
+        response.each do |key, value|
+          next if ignore_headers.include?(key.downcase)
+          # If this is a cookie, strip out the domain.  This technically may
+          # break certain scenarios where services try to set cross-domain
+          # cookies, but those services should not be doing that anyway...
+          value.gsub!(/domain=[^\;]+\;? ?/,'') if key.downcase == 'set-cookie'
+          # Location headers should rewrite the hostname if it is included.
+          value.gsub!(/^http:\/\/#{http_host}(:[0-9]+)?\//, "http://#{request.host}/") if key.downcase == 'location'
+          
+          SC.logger << "   #{key}: #{value}\n"
+          response_headers[key] = value
+        end
+        
+        return [status, ::Rack::Utils::HeaderHash.new(response_headers), [response.body]]
+      end 
+    end 
+  end 
+end

data/lib/sproutcore/rack/service.rb

@@ -0,0 +1,141 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  module Rack
+
+    # Configures a standard set of Rack adaptors for serving SproutCore apps.
+    # Based on your config settings, this will configure appropriate 
+    # middlewear apps for each incoming project.  Requests are then cascaded
+    # through the projects to find one that can service the request.
+    #
+    class Service
+      
+      # Convenience method to start the rack service as a server.  You must
+      # pass at least a :project => foo, or :projects => [foo, bar] option
+      # to this method, but you may also pass a number of other config optios
+      # including:
+      #
+      # === Options
+      #  :host:: the hostname to listen on (default 0.0.0.0)
+      #  :port:: the portname to listen on (default 4020)
+      #  :daemonize:: if true, service will be run as daemon
+      #  :pid:: if daemonizing, this is the path of the file to write pid to
+      #
+      def self.start(opts = {})
+        
+        # load rack
+        begin
+          require 'rack'
+        rescue LoadError => e
+          gem 'rack'
+          require 'rack'
+        end
+        
+        # Guess.
+        if ENV.include?("PHP_FCGI_CHILDREN")
+          server = ::Rack::Handler::FastCGI
+
+          # We already speak FastCGI
+          options.delete :File
+          options.delete :Port
+        elsif ENV.include?("REQUEST_METHOD")
+          server = ::Rack::Handler::CGI
+        else
+          begin
+            server = ::Rack::Handler::Mongrel
+          rescue LoadError => e
+            server = ::Rack::Handler::WEBrick
+          end
+        end
+
+        projects = opts.delete(:projects) || [opts.delete(:project)].compact
+        app = self.new(*projects)
+        
+        opts[:Host] ||= opts[:host] # allow either case.
+        opts[:Port] ||= opts[:port] || '4020'
+        
+        # If daemonize is set, do it...
+        if opts[:daemonize]
+          SC.logger.info "Daemonizing..."
+          pid = opts[:pid]
+          
+          if RUBY_VERSION < "1.9"
+            return if fork
+            Process.setsid
+            return if fork
+            Dir.chdir "/"
+            File.umask 0000
+            STDIN.reopen "/dev/null"
+            STDOUT.reopen "/dev/null", "a"
+            STDERR.reopen "/dev/null", "a"
+          else
+            Process.daemon
+          end
+
+          if pid
+            File.open(pid, 'w'){ |f| f.write("#{Process.pid}") }
+            at_exit { File.delete(pid) if File.exist?(pid) }
+          end
+        end
+        
+        SC.logger << "Starting server at http://#{opts[:Host] || '0.0.0.0'}:#{opts[:Port]} in #{SC.build_mode} mode\n"
+        server.run app, opts
+      end
+        
+      def initialize(*projects)
+        @projects = projects.flatten
+
+        # Get apps for each project & cascade if needed
+        @apps = @projects.map { |project| middleware_for(project) }
+        @app = @apps.size == 1 ? @apps.first : ::Rack::Cascade.new(@apps)
+
+        # Now put it behind some useful general optimizers...
+        @app = ::Rack::Recursive.new(@app)
+        @app = ::Rack::ConditionalGet.new(@app)
+        #@app = ::Rack::Deflater.new(@app)
+        
+      end
+      
+      def call(env); @app.call(env); end
+      
+      # Construct new middleware for the named project
+      def middleware_for(project)
+        apps = []
+
+        # setup some conditional items...
+        config = project.config
+        #if config.serve_test_runner || config.serve_docs
+          apps << SC::Rack::Dev.new(project) 
+        #end
+        if project.buildfile.proxies.size > 0
+          apps << SC::Rack::Proxy.new(project) 
+        end
+
+        # Add builder for the project itself
+        apps  << SC::Rack::Builder.new(project)
+        
+        # serve files out of the public directory if serve_public is 
+        # configures && the public directory exists
+        if config.serve_public
+          pubdir = File.join(project.project_root, 'public')
+          apps  << ::Rack::File.new(pubdir) if File.directory?(pubdir)
+        end
+        
+        # Wrap'em in a cascade if needed.  This will return the first
+        # app that does not return nil
+        app = apps.size == 1 ? apps.first : ::Rack::Cascade.new(apps) 
+        
+        # Add show exceptions handler if enabled
+        app = ::Rack::ShowExceptions.new(app) if config.serve_exceptions
+        
+        return app # done!
+      end
+      
+    end
+  end
+end

data/lib/sproutcore/rack/test_runner.rb

@@ -0,0 +1,24 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  module Rack
+
+    # Rewrites relevant requests to load the SproutCore test runner for a 
+    # given project.
+    class TestRunner
+      
+      def initialize(project)
+        @project = project
+      end
+      
+      def call(env)
+        return [404, {}, "not found"]
+      end
+    end
+  end
+end

data/lib/sproutcore/render_engines/erubis.rb

@@ -0,0 +1,55 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  module RenderEngine
+
+    class Erubis
+      def initialize(html_context)
+        @html_context = html_context
+      end
+
+      def compile(input)
+        begin
+          require 'erubis'
+        rescue
+          raise "Cannot render ERB file because erubis is not installed. Try running 'sudo gem install erubis' and try again"
+        end
+        
+        ::Erubis::Eruby.new.convert(input)
+      end
+
+      def concat(string, binding)
+        eval('_buf', binding) << string
+      end
+
+      def capture(*args, &block)
+        begin
+          buffer = eval('_buf', block.binding)
+        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
+    end
+
+  end
+end

data/lib/sproutcore/render_engines/haml.rb

@@ -0,0 +1,39 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  module RenderEngine
+
+    class Haml
+      def initialize(html_context)
+        @html_context = html_context
+      end
+
+      def compile(input)
+        begin
+          require 'haml'
+        rescue
+          raise "Cannot render HAML file because haml is not installed. Try running 'sudo gem install haml' and try again"
+        end
+        ::Haml::Engine.new(input).send(:precompiled_with_ambles, [])
+      end
+      
+      def concat(string, binding)
+        eval("_hamlout", binding).push_text string
+      end
+      
+      def capture(*args, &block)
+        if @html_context.respond_to?(:is_haml?) && @html_context.is_haml?
+          @html_context.capture_haml(nil, &block)
+        else
+          block.call(*args).to_s
+        end
+      end
+    end
+
+  end
+end

data/lib/sproutcore/tools.rb

@@ -0,0 +1,311 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+require File.expand_path(File.join(SC::LIBPATH, 'thor', 'lib', 'thor'))
+
+module SC
+
+  # The tools module contain the classes that make up the command line tools
+  # available from SproutCore. In general, each command line tool has a peer
+  # class hosted in this module that implements the primary user interface.
+  #
+  # Internally SproutCore tools that chain together subtools (such as 
+  # sc-build) will actually call these classes directly instead of taking the
+  # time to instantiate a whole new process. 
+  #
+  # Each Tool class is implemented as a Thor subclass.  You can override 
+  # methods in these classes in your own ruby code if you want to make a 
+  # change to how these tools execute.  Any ruby you place in your Buildfile
+  # to modify one of these classes will actually be picked up by the 
+  # tool itself when it runs.
+  #
+  class Tools < ::Thor
+
+    ################################################
+    ## EXCEPTIONS
+    ##
+    
+    # Raise this type of exception when a fatal error occurs because the
+    # user did not pass the correct options.  This will be caught and 
+    # displayed at the top level before exiting.  Note that if you raise 
+    # an exception of some other type, then a backtrace may be displayed as 
+    # well (Which is not preferred)
+    class FatalException < Exception
+    end
+    
+    # Helper method.  Call this when an acception occurs that is fatal due to
+    # a problem with the user.
+    def fatal!(description)
+      raise FatalException, description
+    end
+    
+    # Helper method.  Call this when you want to log an info message.  Logs to
+    # the standard logger.
+    def info(description)
+      SC.logger.info(description)
+    end
+    
+    # Helper method.  Call this when you want to log a debug message.
+    def debug(description)
+      SC.logger.debug(description)
+    end
+    
+    # Log this when you need to issue a warning.
+    def warn(description)
+      SC.logger.warn(description)
+    end
+     
+    
+    ################################################
+    ## GLOBAL OPTIONS 
+    ##
+    
+    # All sproutcore tools can take some standard options.  These are 
+    # processed automatically when the tool is loaded
+    method_options({ '--project'        => :optional,
+                     '--library'        => :optional, # deprecated
+                     '--mode'           => :optional,
+                     '--environment'    => :optional, # deprecated
+                     '--logfile'        => :optional,
+                     '--build'          => :optional,
+                     ['--verbose', '-v']      => false,
+                     ['--very-verbose', '-V'] => false })
+    def initialize(options, *args)
+      super
+    end
+    
+    # This is the core entry method used to run every tool.  Extend this
+    # method with any standard preprocessing you want all tools to do before
+    # they do their specific thing.
+    def invoke(*args)
+      prepare_logger!
+      prepare_mode!
+      prepare_build_numbers!
+      super
+    end
+      
+    # Make the options hash a HashStruct so that we can access each variable
+    # as a method
+    def options; @tool_options ||= HashStruct.new(super); end
+    
+    # Configure the expected log level and log target.  Handles the --verbose,
+    # --very-verbose and --logfile options
+    def prepare_logger!
+      SC.env.log_level = options['very-verbose'] ? :debug : (options.verbose ? :info : :warn)
+      SC.env.logfile = File.expand_path(options.logfile) if options.logfile
+    end
+
+    # Configure the current build mode.  Handles the --mode and --environment
+    # options.  (--environment is provided for backwards compatibility)
+    def prepare_mode!(preferred_mode = 'production')
+      build_mode = (options.mode || options.environment || preferred_mode).to_s.downcase.to_sym
+      SC.build_mode = build_mode
+    end
+
+    # Configure the current build numbers.  Handles the --build option.
+    def prepare_build_numbers!
+      return if (numbers = options.build).nil?
+      numbers = numbers.split(',').map { |n| n.split(':') }
+      if numbers.size==1 && numbers.first.size==1
+        SC.env.build_number = numbers.first.first
+      else
+        hash = {}
+        numbers.each do |pair|
+          key = pair[0]
+          key = "/#{key}" if !(key =~ /^\//)
+          hash[key.to_sym] = pair[1]
+        end
+      end
+    end
+
+    ################################################
+    ## HELPER METHODS 
+    ##
+    
+    # Set the current project.  This is used mostly for unit testing.
+    def project=(a_project)
+      @project = a_project
+    end
+    
+    # The current project.  This is discovered based on the passed --project
+    # option or based on the current working directory.  If no project can be
+    # found, this method will always return null.
+    def project
+      return @project if @discovered_project # cache - @project may be nil
+      @discovered_project = true
+
+      ret = nil
+      project_path = options.project || options.library
+
+      # if no project_path is named explicitly, attempt to autodiscover from
+      # working dir.  If none is found, just set project to nil
+      if project_path.nil?
+        debug "No project path specified.  Searching for projects in #{Dir.pwd}"
+        ret = SC::Project.load_nearest_project Dir.pwd, :parent => SC.builtin_project
+        
+      # if project path is specified, look there.  If no project is found 
+      # die with a fatal exception.
+      else
+        debug "Project path specified at #{project_path}"
+        ret = SC::Project.load File.expand_path(project_path), :parent => SC.builtin_project
+        if ret.nil?
+          fatal! "Could not load project at #{project_path}"
+        end
+      end
+      
+      info "Loaded project at: #{ret.project_root}" unless ret.nil?
+      @project = ret
+    end
+       
+    # Attempts to discover the current project.  If no project can be found
+    # throws a fatal exception.  Use this method at the top of your tool 
+    # method if you require a project to run.
+    def requires_project!
+      ret = project
+      if ret.nil?
+        fatal!("You do not appear to be inside of a project.  Try changing to your project directory or make sure your project as a Buildfile or sc-config")
+      end
+      return ret 
+    end
+      
+    # Find one or more targets with the passed target names in the current 
+    # project.  Requires a project to function.
+    def find_targets(*targets)
+      
+      debug "finding targets with names: '#{targets * "','"}'"
+      requires_project!
+      
+      # If targets are specified, find the targets project or parents...
+      if targets.size > 0
+        targets = targets.map do |target_name|
+          ret = project.target_for(target_name)
+          if ret.nil?
+            fatal! "No target named #{target_name} could be found in project"
+          else
+            debug "Found target '#{target_name}' at PROJECT:#{ret.source_root.sub(/^#{project.project_root}\//,'')}"
+          end
+          ret
+        end
+        
+      # IF no targets are specified, then just get all targets in project.
+      # If --all option was specified, include those that do not autobuild
+      else
+        targets = project.targets.values
+        unless options.all?
+          targets.reject! { |t| !t.config.autobuild? }
+        end
+      end 
+
+      # If include required was specified, merge in all required bundles as 
+      # well.
+      if options['include-required']
+        targets.each do |target| 
+          targets += target.expand_required_targets :theme => true,
+           :debug => target.config.load_debug,
+           :tests => target.config.load_tests
+        end
+        
+        targets = targets.flatten.uniq.compact
+      end
+      
+      return targets
+    end
+
+    # Wraps around find_targets but raises an exception if no target is 
+    # specified.
+    def requires_targets!(*target_names)
+      if target_names.size == 0
+        fatal! "You must specify a target with this command" 
+      end
+
+      targets = find_targets(*target_names)
+      if targets.size == 0
+        fatal! "No targets matching #{target_names * ","} were found."
+      end
+      
+      targets
+    end
+    
+    # Requires exactly one target.
+    def requires_target!(*targets)
+      requires_targets!(*targets).first
+    end
+    
+    # Discovers the languages requested by the user for a build.  Uses the
+    # --languages command line option or disovers in targets.
+    def find_languages(*targets)
+      # Use passed languages.  If none are specified, merge installed 
+      # languages for all app targets.
+      if (languages = options.languages).nil?
+        languages = targets.map { |t| t.installed_languages }
+      else
+        languages = languages.split(':').map { |l| l.to_sym }
+      end
+      languages.flatten.uniq.compact
+    end
+    
+    # Core method to process command line options and then build a manifest.
+    # Shared by sc-manifest and sc-build commands.
+    def build_manifests(*targets)
+      
+      requires_project! # get project
+      targets = find_targets(*targets) # get targets
+      languages = find_languages(*targets) # get languages
+
+      # log output
+      SC.logger.info "Building targets: #{targets.map { |t| t.target_name } * ","}"
+      SC.logger.info "Building languages: #{ languages * "," }"
+      
+      # Now fetch the manifests to build.  One per target/language
+      manifests = targets.map do |target|
+        languages.map { |l| target.manifest_for :language => l }
+      end
+      manifests.flatten!
+      
+      # Build'em
+      manifests.each do |manifest| 
+        SC.logger.info "Building manifest for: #{manifest.target.target_name}:#{manifest.language}"
+        manifest.build!
+      end
+      
+      return manifests
+    end
+    
+    # Logs the contents of the passed file path to the logger
+    def log_file(path)
+      if !File.exists?(path) 
+        warn "Could not display #{File.basename(path)} at #{File.dirname(path)} because it does not exist."
+      end
+      file_text = File.read(path)
+      SC.logger << file_text
+      SC.logger << "\n"
+    end
+      
+    ################################################
+    ## MAIN ENTRYPOINT
+    ##
+    
+    # Fix start so that it treats command-name like command_name
+    def self.start(args = ARGV)
+      # manually check for verbose in case we don't get far enough in regular
+      # processing to actually set the verbose mode.
+      is_verbose = %w(-v -V --verbose --very-verbose).any? { |x| args.include?(x) }
+      begin
+        super(args)
+      rescue Exception => e
+        SC.logger.fatal(e)
+        if is_verbose && !e.kind_of?(FatalException)
+          SC.logger.fatal("BACKTRACE:\n#{e.backtrace.join("\n")}\n")
+        end
+      end
+    end
+    
+  end
+  
+end
+
+SC.require_all_libs_relative_to(__FILE__)