sproutit-sproutcore 1.0.0.20090407205609

data/lib/sproutcore/tools/build.rb

@@ -0,0 +1,80 @@
+# ===========================================================================
+# 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__), 'manifest'))
+
+module SC
+  class Tools
+    
+    desc "build [TARGET..]", "Builds one or more targets"
+    method_options(
+      MANIFEST_OPTIONS.merge(:entries => :optional, :clean => false))
+      
+    def build(*targets)
+
+      # Copy some key props to the env
+      SC.env.build_prefix   = options.buildroot if options.buildroot
+      SC.env.stating_prefix = options.stageroot if options.stageroot
+      SC.env.use_symlink    = options.symlink 
+      SC.env.clean          = options.clean 
+      
+      # Get entries option
+      entry_filters = nil
+      if options[:entries]
+        entry_filters = options[:entries].split(',')
+      end
+      
+      # Get the manifests to build
+      manifests = build_manifests(targets)
+
+      # First clean all manifests
+      # Do this before building so we don't accidentally erase already build
+      # nested targets.
+      if SC.env.clean
+        manifests.each do |manifest|
+          build_root = manifest.target.build_root
+          info "Cleaning #{build_root}"
+          FileUtils.rm_r(build_root) if File.directory?(build_root)
+          
+          staging_root = manifest.target.staging_root
+          info "Cleaning #{staging_root}"
+          FileUtils.rm_r(staging_root) if File.directory?(staging_root)
+        end
+      end
+          
+      # Now build entries for each manifest...
+      manifests.each do |manifest|
+        
+        # get entries.  If "entries" option was specified, use to filter 
+        # filename.  Must match end of filename.
+        entries = manifest.entries
+        if entry_filters
+          entries = entries.select do |entry|
+            is_allowed = false
+            entry_filters.each do |filter|
+              is_allowed = entry.filename =~ /#{filter}$/
+              break if is_allowed
+            end
+            is_allowed
+          end
+        end
+        
+        # if there are entries to build, log and build
+        if entries.size > 0
+          info "Building entries for #{manifest.target.target_name}:#{manifest.language}..."
+          
+          entries.each do |entry|
+            info "  #{entry.filename} -> #{entry.build_path}"
+            entry.build!
+          end
+        end
+      end
+      
+    end    
+    
+  end
+end

data/lib/sproutcore/tools/build_number.rb

@@ -0,0 +1,23 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+
+module SC
+  class Tools
+    
+    ################################################
+    ## COMMAND LINE  
+    ##
+
+    desc "build-number TARGET", "Computes a build number for the target"
+    def build_number(*targets)
+      target = requires_target!(*targets)
+      $stdout << target.prepare!.build_number
+    end
+
+  end
+end

data/lib/sproutcore/tools/gen.rb

@@ -0,0 +1,99 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  
+  # Generates components for SproutCore. The generator allows the user
+  # to quickly set up a SproutCore framework using any of the built in 
+  # templates such as the project itself, apps, models, views, controllers 
+  # and more
+  # 
+  # The template files will be copied to their target location and also be 
+  # parsed through the Erubis templating system. Template file paths can 
+  # contain instance variables in the form of _class_name_ which in turn would 
+  # be the value of class_name once generated.
+  # 
+  # To develop a new generator, you can add it to the sproutcore/gen/ 
+  # directory with the following file structure:
+  #    gen/
+  #      <generator_name>/   - singular directory name of the generator
+  #         Buildfile        - contains all config options and build tasks
+  #         README           - prints when generator is done
+  #         templates/       - contains all the files you want to generate
+  #         USAGE            - prints when user gives uses --help option
+  # 
+  class Tools
+    
+    def show_help(generator_name=nil, generator=nil)
+      if generator_name
+        if generator.nil?
+          warn("There is no #{generator_name} generator") 
+        else
+          generator.log_usage
+        end
+      else
+        SC.logger << "Available generators:\n"
+        SC::Generator.installed_generators_for(project).each do |name|
+          SC.logger << "  #{name}\n"
+        end
+        SC.logger << "Type sc-gen GENERATOR --help for specific usage\n\n"
+      end
+      return 0
+    end
+    
+    desc "sc-gen generator Namespace[.ClassName] [--target=TARGET_NAME] [--filename=FILE_NAME]", 
+      "Generates SproutCore components"
+    
+    method_options(
+      MANIFEST_OPTIONS.merge(:help       => :optional,
+                             :filename   => :optional,
+                             :target     => :optional,
+                             '--dry-run' => false,
+                             :force      => false))
+      
+    def gen(*arguments)
+      return show_help if arguments.empty?
+      
+      # backwards compatibility case: client is a synonym for 'app'
+      name = arguments[0]=='client' ? 'app' : arguments[0]
+      
+      # Load generator
+      generator_project = self.project || SC.builtin_project
+      generator = generator_project.generator_for name,
+        :arguments   => arguments,
+        :filename    => options[:filename],
+        :target_name => options[:target],
+        :dry_run     => options['dry-run'],
+        :force       => options[:force]
+
+      # if no generator could be found, or if we just asked to show help,
+      # just return the help...
+      return show_help(name, generator) if generator.nil? || options[:help] 
+      
+      begin
+        # Prepare generator and then log some debug info
+        generator.prepare!
+        info "Loading generator Buildfile at: #{generator.buildfile.loaded_paths.last}"
+      
+        debug "\nSETTINGS"
+        generator.each { |k,v| debug("#{k}: #{v}") }
+        
+        # Now, run the generator
+        generator.build!
+        
+      rescue Exception => error_message
+        warn "For specific help on how to use this generator, type: sc-gen #{name} --help"
+        fatal! error_message.to_s
+      end
+
+      SC.logger << "\n"
+      generator.log_readme
+      return 0
+    end
+    
+  end
+end

data/lib/sproutcore/tools/init.rb

@@ -0,0 +1,40 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  class Tools
+    
+    desc "sc-init PROJECT [APP]", 
+      "Generates a SproutCore project with an initial application"
+    method_options('--dry-run' => false, :force => false)
+    def init(project_name, app_name=nil)
+      
+      # Generate the project
+      project_gen = SC.builtin_project.generator_for 'project',
+        :arguments => ['project', project_name],
+        :dry_run   => options['dry-run'],
+        :force     => options[:force]
+      project_gen.prepare!.build!
+      
+      # Next, get the project root & app name
+      project_root = project_gen.build_root / project_gen.filename
+      app_name = project_gen.filename if app_name.nil?
+      
+      # And get the app generator and run it
+      project = SC::Project.load project_root, :parent => SC.builtin_project
+      generator = project.generator_for 'app',
+        :arguments => ['app', app_name],
+        :dry_run   => options['dry-run'],
+        :force     => options[:force]
+      generator.prepare!.build!
+      
+      project_gen.log_file(project_gen.source_root / 'INIT')
+      return 0
+    end
+    
+  end
+end

data/lib/sproutcore/tools/manifest.rb

@@ -0,0 +1,84 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  class Tools
+    
+    # Standard manifest options.  Used by build tool as well.
+    MANIFEST_OPTIONS = { :languages     => :optional,
+                         :symlink       => false,
+                         :buildroot     => :optional,
+                         :stageroot     => :optional,
+                         :format        => :optional,
+                         :output        => :output,
+                         :all           => false,
+                         ['--include-required', '-r'] => false }
+                     
+    desc "manifest [TARGET..]", "Generates a manifest for the specified targets"
+    method_options(MANIFEST_OPTIONS.merge(
+      :format        => :optional,
+      :only          => :optional,
+      :except        => :optional,
+      :hidden        => false ))
+    def manifest(*targets)
+
+      # Copy some key props to the env
+      SC.env.build_prefix   = options.buildroot if options.buildroot
+      SC.env.staging_prefix = options.stageroot if options.stageroot
+      SC.env.use_symlink    = options.symlink 
+      
+      # Verify format
+      format = (options.format || 'yaml').to_s.downcase.to_sym
+      if ![:yaml, :json].include?(format)
+        raise "Format must be yaml or json"
+      end
+      
+      # Get allowed keys
+      only_keys = nil
+      if options[:only]
+        only_keys = (options[:only] || '').to_s.split(',')
+        only_keys.map! { |k| k.to_sym }
+        only_keys = nil if only_keys.size == 0
+      end
+
+      except_keys = nil
+      if options[:except]
+        except_keys = (options[:except] || '').to_s.split(',')
+        except_keys.map! { |k| k.to_sym }
+        except_keys = nil if except_keys.size == 0
+      end
+      
+      # call core method to actually build the manifests...
+      manifests = build_manifests(*targets)
+
+      # now convert them to hashes...
+      manifests.map! do |manifest| 
+        manifest.to_hash :hidden => options.hidden, 
+          :only => only_keys, :except => except_keys
+      end
+      
+      # Serialize'em
+      case format
+      when :yaml
+        output = ["# SproutCore Build Manifest v1.0", manifests.to_yaml].join("\n")
+      when :json
+        output = mainfests.to_json
+      end
+      
+      # output ...
+      if options.output
+        file = File.open(options.output, 'w')
+        file.write(output)
+        file.close
+      else
+        $stdout << output
+      end
+      
+    end    
+    
+  end
+end

data/lib/sproutcore/tools/server.rb

@@ -0,0 +1,45 @@
+# ===========================================================================
+# Project:   Abbot - SproutCore Build Tools
+# Copyright: ©2009 Apple, Inc.
+#            portions copyright @2006-2009 Sprout Systems, Inc.
+#            and contributors
+# ===========================================================================
+
+module SC
+  
+  class Tools
+    
+    desc "server", "Starts the development server"
+    method_options  :daemonize => false,
+                    :port      => :optional,
+                    :host      => :optional,
+                    :irb       => false
+    def server
+      prepare_mode!('debug') # set mode again, using debug as default
+      
+      SC.env.build_prefix   = options.buildroot if options.buildroot
+      SC.env.staging_prefix = options.stageroot if options.stageroot
+      
+      # get project and start service.
+      project = requires_project!
+      
+      # start shell if passed
+      if options.irb
+        require 'irb'
+        require 'irb/completion'
+        if File.exists? ".irbrc"
+          ENV['IRBRC'] = ".irbrc"
+        end
+        
+        SC.project = project
+        SC.logger << "SproutCore v#{SC::VERSION} Interactive Shell\n"
+        SC.logger << "SC.project = #{project.project_root}\n"
+        ARGV.clear # do not pass onto IRB
+        IRB.start
+      else
+        SC::Rack::Service.start(options.merge(:project => project))
+      end
+    end
+    
+  end
+end

data/spec/buildtasks/build/copy_spec.rb

@@ -0,0 +1,60 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "build:copy" do
+  
+  include SC::SpecHelpers
+  include SC::BuildSpecHelpers
+  
+  before do
+    std_before
+    @task_name = 'build:copy'
+
+    @entry = @manifest.entry_for('demo.html')
+    @src_path = @entry.source_path
+    @dst_path = @entry.build_path
+    
+    @entry.build_task.should == 'build:copy' # precondition
+  end
+
+  after do
+    std_after
+  end
+  
+  it "copies from source to dst_path if dst_path does not exist" do
+    File.exist?(@dst_path).should be_false # precondition
+    
+    run_task @entry, @dst_path
+    files_eql(@src_path, @dst_path).should be_true
+  end
+  
+  it "does not run if newer file exists at dst_path" do
+    write_dummy(@dst_path)
+    make_newer(@dst_path, @src_path)
+    
+    run_task
+    
+    is_dummy(@dst_path).should be_true # make sure task did not copy
+  end
+
+  it "replaces dst_path if older file exists at dst_path" do
+    write_dummy(@dst_path)
+    make_newer(@src_path, @dst_path)
+    
+    run_task
+    
+    is_dummy(@dst_path).should be_false # should overrwite older file
+    files_eql(@src_path, @dst_path).should be_true
+  end
+  
+  it "does not run if dst_path == src_path" do
+    task = @buildfile.lookup('build:copy')
+    expected_count = task.execute_count
+    
+    @dst_path = @src_path
+    run_task
+    
+    task.execute_count.should == expected_count # did not execute!
+  end
+  
+  
+end

data/spec/buildtasks/build/spec_helper.rb

@@ -0,0 +1,36 @@
+require File.join(File.dirname(__FILE__), %w[.. .. spec_helper])
+
+module SC::BuildSpecHelpers
+  
+  def std_before
+    @project = temp_project :real_world
+    @target = @project.target_for :sproutcore
+    @buildfile = @target.buildfile
+    @manifest = @target.manifest_for(:language => :fr)
+    
+    @target.prepare! # make sure its ready for the manifest...
+    @manifest.build! # get a basic manifest good to go...
+  end
+  
+  def std_after
+    @project.cleanup
+  end
+  
+  def run_task(entry=nil, dst_path=nil)
+    entry ||= @entry
+    @buildfile.invoke @task_name,
+      :entry => entry,
+      :manifest => @manifest,
+      :target => @target,
+      :config => @target.config,
+      :project => @project,
+      :src_path => @src_path || entry.source_path,
+      :src_paths => @src_path.nil? ? entry.source_paths : [@src_path],
+      :dst_path => dst_path || @dst_path || entry.build_path
+  end
+
+  def entry_for(filename)
+    @manifest.entry_for filename, :hidden => true
+  end
+
+end