ittayd-buildr 1.3.4

data/lib/buildr/core/application.rb

@@ -0,0 +1,665 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements.  See the NOTICE file distributed with this
+# work for additional information regarding copyright ownership.  The ASF
+# licenses this file to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#    http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
+# License for the specific language governing permissions and limitations under
+# the License.
+
+
+# Portion of this file derived from Rake.
+# Copyright (c) 2003, 2004 Jim Weirich
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+
+require 'rake'
+require 'highline/import'
+require 'rubygems/source_info_cache'
+require 'buildr/core/util'
+Gem.autoload :SourceInfoCache, 'rubygems/source_info_cache'
+
+
+# Gem::user_home is nice, but ENV['HOME'] lets you override from the environment.
+ENV['HOME'] ||= File.expand_path(Gem::user_home)
+ENV['BUILDR_ENV'] ||= 'development'
+
+
+module Buildr
+
+  # Provide settings that come from three sources.
+  #
+  # User settings are placed in the .buildr/settings.yaml file located in the user's home directory.
+  # They should only be used for settings that are specific to the user and applied the same way
+  # across all builds.  Example for user settings are preferred repositories, path to local repository,
+  # user/name password for uploading to remote repository.
+  #
+  # Build settings are placed in the build.yaml file located in the build directory.  They help keep
+  # the buildfile and build.yaml file simple and readable, working to the advantages of each one.
+  # Example for build settings are gems, repositories and artifacts used by that build.
+  #
+  # Profile settings are placed in the profiles.yaml file located in the build directory.  They provide
+  # settings that differ in each environment the build runs in.  For example, URLs and database
+  # connections will be different when used in development, test and production environments.
+  # The settings for the current environment are obtained by calling #profile.
+  class Settings
+
+    def initialize(application) #:nodoc:
+      @application = application
+    end
+
+    # User settings loaded from setting.yaml file in user's home directory.
+    def user
+      @user ||= load_from('settings', @application.home_dir)
+    end
+
+    # Build settings loaded from build.yaml file in build directory.
+    def build
+      @build ||= load_from('build')
+    end
+
+    # Profiles loaded from profiles.yaml file in build directory.
+    def profiles
+      @profiles ||= load_from('profiles')
+    end
+
+    # :call-seq:
+    #    profile => hash
+    #
+    # Returns the profile for the current environment.
+    def profile
+      profiles[@application.environment] ||= {}
+    end
+
+  private
+
+    def load_from(name, path = nil)
+      unless path
+        fail "Internal error: attempting to access local setting before buildfile located" unless @application.rakefile
+        path = File.dirname(@application.rakefile)
+      end
+      file_name = ['yaml', 'yml'].map { |ext| File.join(path, "#{name}.#{ext}") }.find { |fn| File.exist?(fn) }
+      return {} unless file_name
+      yaml = YAML.load(File.read(file_name)) || {}
+      fail "Expecting #{file_name} to be a map (name: value)!" unless Hash === yaml
+      @application.buildfile.enhance [file_name]
+      yaml
+    end
+
+  end
+
+
+  class Application < Rake::Application #:nodoc:
+
+    # Deprecated: rakefile/Rakefile, removed in 1.5
+    DEFAULT_BUILDFILES = ['buildfile', 'Buildfile'] + DEFAULT_RAKEFILES
+
+    attr_reader :rakefiles, :requires
+    private :rakefiles, :requires
+
+    def initialize
+      super
+      @rakefiles = DEFAULT_BUILDFILES.dup
+      @top_level_tasks = []
+      @home_dir = File.expand_path('.buildr', ENV['HOME'])
+      mkpath @home_dir, :verbose=>false unless File.exist?(@home_dir)
+      @settings = Settings.new(self)
+      @on_completion = []
+      @on_failure = []
+    end
+
+    def run
+      standard_exception_handling do
+        init 'Buildr'
+        load_buildfile
+        top_level
+      end
+    end
+
+    # Not for external consumption.
+    def switch_to_namespace(names) #:nodoc:
+      current, @scope = @scope, names
+      begin
+        yield
+      ensure
+        @scope = current
+      end
+    end
+
+    # Returns list of Gems associated with this buildfile, as listed in build.yaml.
+    # Each entry is of type Gem::Specification.
+    attr_reader :gems
+
+    # Buildr home directory, .buildr under user's home directory.
+    attr_reader :home_dir
+
+    # Copied from BUILD_ENV.
+    def environment
+      ENV['BUILDR_ENV']
+    end
+
+    # Returns the Settings associated with this build.
+    attr_reader :settings
+
+    # :call-seq:
+    #   buildfile
+    # Returns the buildfile as a task that you can use as a dependency.
+    def buildfile
+      @buildfile_task ||= BuildfileTask.define_task(File.expand_path(rakefile))
+    end
+
+    # Files that complement the buildfile itself
+    def build_files #:nodoc:
+      deprecated 'Please call buildfile.prerequisites instead'
+      buildfile.prerequisites
+    end
+
+    # Yields to block on successful completion. Primarily used for notifications.
+    def on_completion(&block)
+      @on_completion << block
+    end
+
+    # Yields to block on failure with exception. Primarily used for notifications.
+    def on_failure(&block)
+      @on_failure << block
+    end
+
+    # :call-seq:
+    #   deprecated(message)
+    #
+    # Use with deprecated methods and classes. This method automatically adds the file name and line number,
+    # and the text 'Deprecated' before the message, and eliminated duplicate warnings. It only warns when
+    # running in verbose mode.
+    #
+    # For example:
+    #   deprecated 'Please use new_foo instead of foo.'
+    def deprecated(message) #:nodoc:
+      return unless verbose
+      "#{caller[1]}: Deprecated: #{message}".tap do |message|
+        @deprecated ||= {}
+        unless @deprecated[message]
+          @deprecated[message] = true
+          warn message
+        end
+      end
+    end
+
+  protected
+
+    def load_buildfile # replaces load_rakefile
+      standard_exception_handling do
+        find_buildfile
+        load_gems
+        load_artifact_ns
+        load_tasks
+        raw_load_buildfile
+      end
+    end
+
+    def top_level # adds on_completion hook
+      standard_exception_handling do
+        if options.show_tasks
+          display_tasks_and_comments
+        elsif options.show_prereqs
+          display_prerequisites
+        elsif options.execute
+          eval options.execute
+        else
+          @start = Time.now
+          top_level_tasks.each { |task_name| invoke_task(task_name) }
+          if verbose
+            elapsed = Time.now - @start
+            real = []
+            real << ('%ih' % (elapsed / 3600)) if elapsed >= 3600
+            real << ('%im' % ((elapsed / 60) % 60)) if elapsed >= 60
+            real << ('%.3fs' % (elapsed % 60))
+            puts $terminal.color("Completed in #{real.join}", :green)
+          end
+          # On OS X this will load Cocoa and Growl which takes half a second we
+          # don't want to measure, so put this after the console message.
+          title, message = "Your build has completed", "#{Dir.pwd}\nbuildr #{@top_level_tasks.join(' ')}"
+          @on_completion.each do |block|
+            block.call(title, message) rescue nil
+          end
+        end
+      end
+    end
+
+    def handle_options
+      options.rakelib = ['tasks']
+
+      opts = OptionParser.new
+      opts.banner = "buildr [-f rakefile] {options} targets..."
+      opts.separator ""
+      opts.separator "Options are ..."
+
+      argv = ARGV.dup
+      while idx = argv.index('--require-early')
+        raise "missing argument: --require-early" unless val = argv[idx+1]
+        argv[idx,2] = []
+        require val
+      end
+
+      opts.on_tail("-h", "--help", "-H", "Display this help message.") do
+        puts opts
+        exit
+      end
+      standard_buildr_options.each { |args| opts.on(*args) }
+      parsed_argv = opts.parse(argv)
+      parsed_argv
+    end
+
+    def standard_buildr_options # replaces standard_rake_options
+      [
+        ['--describe', '-D [PATTERN]', "Describe the tasks (matching optional PATTERN), then exit.",
+          lambda { |value|
+            options.show_tasks = true
+            options.full_description = true
+            options.show_task_pattern = Regexp.new(value || '')
+          }
+        ],
+        ['--execute',  '-E CODE',
+          "Execute some Ruby code after loading the buildfile",
+          lambda { |value| options.execute = value }
+        ],
+        ['--environment',  '-e ENV',
+          "Environment name (e.g. development, test, production).",
+          lambda { |value| ENV['BUILDR_ENV'] = value }
+        ],
+        ['--generate [PATH]',
+         "Generate buildfile from either pom.xml file or directory path.",
+          lambda { |value|
+            value ||= File.exist?('pom.xml') ? 'pom.xml' : Dir.pwd
+            raw_generate_buildfile value
+            exit
+          }
+        ],
+        ['--libdir', '-I LIBDIR', "Include LIBDIR in the search path for required modules.",
+          lambda { |value| $:.push(value) }
+        ],
+        ['--prereqs', '-P [PATTERN]', "Display the tasks and dependencies (matching optional PATTERN), then exit.",
+          lambda { |value|
+            options.show_prereqs = true
+            options.show_task_pattern = Regexp.new(value || '')
+          }
+        ],
+        ['--quiet', '-q', "Do not log messages to standard output.",
+          lambda { |value| verbose(false) }
+        ],
+        ['--buildfile', '-f FILE', "Use FILE as the buildfile.",
+          lambda { |value|
+            @rakefiles.clear
+            @rakefiles << value
+          }
+        ],
+        ['--rakelibdir', '--rakelib', '-R PATH',
+          "Auto-import any .rake files in PATH. (default is 'tasks')",
+          lambda { |value| options.rakelib = value.split(':') }
+        ],
+        ['--require', '-r MODULE', "Require MODULE before executing rakefile.",
+          lambda { |value|
+            begin
+              require value
+            rescue LoadError => ex
+              begin
+                rake_require value
+              rescue LoadError => ex2
+                raise ex
+              end
+            end
+          }
+        ],
+        ['--require-early MODULE', "Require module early"],
+        ['--rules', "Trace the rules resolution.",
+          lambda { |value| options.trace_rules = true }
+        ],
+        ['--no-search', '--nosearch', '-N', "Do not search parent directories for the Rakefile.",
+          lambda { |value| options.nosearch = true }
+        ],
+        ['--silent', '-s', "Like --quiet, but also suppresses the 'in directory' announcement.",
+          lambda { |value|
+            verbose(false)
+            options.silent = true
+          }
+        ],
+        ['--tasks', '-T [PATTERN]', "Display the tasks (matching optional PATTERN) with descriptions, then exit.",
+          lambda { |value|
+            options.show_tasks = true
+            options.show_task_pattern = Regexp.new(value || '')
+            options.full_description = false
+          }
+        ],
+        ['--trace', '-t', "Turn on invoke/execute tracing, enable full backtrace.",
+          lambda { |value|
+            options.trace = true
+            verbose(true)
+          }
+        ],
+        ['--verbose', '-v', "Log message to standard output (default).",
+          lambda { |value| verbose(true) }
+        ],
+        ['--version', '-V', "Display the program version.",
+          lambda { |value|
+            puts "Buildr #{Buildr::VERSION} #{RUBY_PLATFORM[/java/] && '(JRuby '+JRUBY_VERSION+')'}"
+            exit
+          }
+        ]
+      ]
+    end
+
+    def find_buildfile
+      buildfile, location = find_rakefile_location || (tty_output? && ask_generate_buildfile)
+      fail "No Buildfile found (looking for: #{@rakefiles.join(', ')})" if buildfile.nil?
+      @rakefile = buildfile
+      Dir.chdir(location)
+    end
+
+    def ask_generate_buildfile
+      source = choose do |menu|
+        menu.header = "To use Buildr you need a buildfile. Do you want me to create one?"
+        menu.choice("From Maven2 POM file") { 'pom.xml' } if File.exist?('pom.xml')
+        menu.choice("From directory structure") { Dir.pwd }
+        menu.choice("Cancel") { }
+      end
+      if source
+        buildfile = raw_generate_buildfile(source)
+        [buildfile, File.dirname(buildfile)]
+      end
+    end
+
+    def raw_generate_buildfile(source)
+      # We need rakefile to be known, for settings.build to be accessible.
+      @rakefile = File.expand_path(DEFAULT_BUILDFILES.first)
+      fail "Buildfile already exists" if File.exist?(@rakefile) && !(tty_output? && agree('Buildfile exists, overwrite?'))
+      script = File.directory?(source) ? Generate.from_directory(source) : Generate.from_maven2_pom(source)
+      File.open @rakefile, 'w' do |file|
+        file.puts script
+      end
+      puts "Created #{@rakefile}" if verbose
+      @rakefile
+    end
+
+    def raw_load_buildfile # replaces raw_load_rakefile
+      puts "(in #{Dir.pwd}, #{environment})" unless options.silent
+      load File.expand_path(@rakefile) if @rakefile && @rakefile != ''
+      options.rakelib.each do |rlib|
+        glob("#{rlib}/*.rake") do |name|
+          add_import name
+        end
+      end
+      load_imports
+      initialize_projects
+    end
+
+    def initialize_projects
+      top_level_tasks.each do |task_name|
+        projects =  task_name.split(':').inject([]) { |projects, part| projects << (projects.last.to_a + [part]) }.reverse
+        projects.each do |project|
+          name = project.join(':')
+          begin
+            break if Buildr.project(name)
+          rescue Project::NoSuchProject => detail
+            raise unless detail.name == name
+          end
+        end
+      end
+    end
+
+    # Load/install all Gems specified in build.yaml file.
+    def load_gems #:nodoc:
+      missing_deps, installed = listed_gems.partition { |gem| gem.is_a?(Gem::Dependency) }
+      unless missing_deps.empty?
+        newly_installed = Util::Gems.install(*missing_deps)
+        installed += newly_installed
+      end
+      installed.each do |spec|
+        if gem(spec.name, spec.version.to_s)
+          # TODO: is this intended to load rake tasks from the installed gems?
+          # We should use a convention like .. if the gem has a _buildr.rb file, load it.
+
+          #FileList[spec.require_paths.map { |path| File.expand_path("#{path}/*.rb", spec.full_gem_path) }].
+          #  map { |path| File.basename(path) }.each { |file| require file }
+          #FileList[File.expand_path('tasks/*.rake', spec.full_gem_path)].each do |file|
+          #  Buildr.application.add_import file
+          #end
+        end
+      end
+      @gems = installed
+    end
+
+    # Returns Gem::Specification for every listed and installed Gem, Gem::Dependency
+    # for listed and uninstalled Gem, which is the installed before loading the buildfile.
+    def listed_gems #:nodoc:
+      Array(settings.build['gems']).map do |dep|
+        name, trail = dep.scan(/^\s*(\S*)\s*(.*)\s*$/).first
+        versions = trail.scan(/[=><~!]{0,2}\s*[\d\.]+/)
+        versions = ['>= 0'] if versions.empty?
+        dep = Gem::Dependency.new(name, versions)
+        Gem::SourceIndex.from_installed_gems.search(dep).last || dep
+      end
+    end
+
+    # Load artifact specs from the build.yaml file, making them available
+    # by name ( ruby symbols ).
+    def load_artifact_ns #:nodoc:
+      hash = settings.build['artifacts']
+      return unless hash
+      raise "Expected 'artifacts' element to be a hash" unless Hash === hash
+      # Currently we only use one artifact namespace to rule them all. (the root NS)
+      Buildr::ArtifactNamespace.load(:root => hash)
+    end
+
+    # Loads buildr.rb files from users home directory and project directory.
+    # Loads custom tasks from .rake files in tasks directory.
+    def load_tasks #:nodoc:
+      # TODO: this might need to be split up, look for deprecated features, better method name.
+      files = [ File.expand_path('buildr.rb', ENV['HOME']), 'buildr.rb' ].select { |file| File.exist?(file) }
+      files += [ File.expand_path('buildr.rake', ENV['HOME']), File.expand_path('buildr.rake') ].
+        select { |file| File.exist?(file) }.each { |file| warn "Please use '#{file.ext('rb')}' instead of '#{file}'" }
+      #Load local tasks that can be used in the Buildfile.
+      files += Dir[File.expand_path('tasks/*.rake')]
+      files.each do |file|
+        unless $LOADED_FEATURES.include?(file)
+          load file
+          $LOADED_FEATURES << file
+        end
+      end
+      buildfile.enhance files
+      true
+    end
+
+    def display_tasks_and_comments
+      displayable_tasks = tasks.select { |t| t.comment && t.name =~ options.show_task_pattern }
+      if options.full_description
+        displayable_tasks.each do |t|
+          puts "buildr #{t.name_with_args}"
+          t.full_comment.split("\n").each do |line|
+            puts "    #{line}"
+          end
+          puts
+        end
+      else
+        width = displayable_tasks.collect { |t| t.name_with_args.length }.max || 10
+        max_column = truncate_output? ? terminal_width - name.size - width - 7 : nil
+        displayable_tasks.each do |t|
+          printf "#{name} %-#{width}s  # %s\n",
+            t.name_with_args, max_column ? truncate(t.comment, max_column) : t.comment
+        end
+      end
+    end
+
+    def display_prerequisites
+      displayable_tasks = tasks.select { |t| t.name =~ options.show_task_pattern }
+      displayable_tasks.each do |t|
+        puts "buildr #{t.name}"
+        t.prerequisites.each { |pre| puts "    #{pre}" }
+      end
+    end
+
+    def standard_exception_handling # adds on_failure hook
+      begin
+        yield
+      rescue SystemExit => ex
+        # Exit silently with current status
+        exit(ex.status)
+      rescue OptionParser::ParseError => ex
+        $stderr.puts $terminal.color(ex.message, :red)
+        exit(1)
+      rescue Exception => ex
+        title, message = "Your build failed with an error", "#{Dir.pwd}:\n#{ex.message}"
+        @on_failure.each do |block|
+          block.call(title, message, ex) rescue nil
+        end
+        # Exit with error message
+        $stderr.puts "Buildr aborted!"
+        $stderr.puts $terminal.color(ex.message, :red)
+        if options.trace
+          $stderr.puts ex.backtrace.join("\n")
+        else
+          $stderr.puts ex.backtrace.select { |str| str =~ /#{rakefile}/ }.map { |line| $terminal.color(line, :red) }.join("\n") if rakefile
+          $stderr.puts "(See full trace by running task with --trace)"
+        end
+        exit(1)
+      end
+    end
+
+  end
+
+
+  # This task stands for the buildfile and all its associated helper files (e.g., buildr.rb, build.yaml).
+  # By using this task as a prerequisite for other tasks, you can ensure these tasks will be needed
+  # whenever the buildfile changes.
+  class BuildfileTask < Rake::FileTask
+
+    def timestamp
+      ([name] + prerequisites).map { |f| File.stat(f).mtime }.max rescue Time.now
+    end
+  end
+
+
+  class << self
+
+    # Returns the Buildr::Application object.
+    def application
+      Rake.application
+    end
+
+    def application=(app) #:nodoc:
+      Rake.application = app
+    end
+
+    # Returns the Settings associated with this build.
+    def settings
+      Buildr.application.settings
+    end
+
+    # Copied from BUILD_ENV.
+    def environment
+      Buildr.application.environment
+    end
+
+  end
+
+  Buildr.application = Buildr::Application.new
+
+end
+
+
+# Add a touch of color when available and running in terminal.
+if $stdout.isatty
+  begin
+    require 'Win32/Console/ANSI' if Config::CONFIG['host_os'] =~ /mswin/
+    HighLine.use_color = true
+  rescue LoadError
+  end
+else
+  HighLine.use_color = false
+end
+
+
+alias :warn_without_color :warn
+
+# Show warning message.
+def warn(message)
+  warn_without_color $terminal.color(message.to_s, :blue) if verbose
+end
+
+# Show error message.  Use this when you need to show an error message and not throwing
+# an exception that will stop the build.
+def error(message)
+  puts $terminal.color(message.to_s, :red)
+end
+
+# Show optional information.  The message is printed only when running in verbose
+# mode (the default).
+def info(message)
+  puts message if verbose
+end
+
+# Show message.  The message is printed out only when running in trace mode.
+def trace(message)
+  puts message if Buildr.application.options.trace
+end
+
+
+module Rake #:nodoc
+  # Rake's circular dependency checks (InvocationChain) only applies to task prerequisites,
+  # all other cases result in the non too-descriptive thread sleeping error. This change can
+  # deal with circular dependencies that occur from direct task invocation, e.g:
+  #   task 'foo'=>'bar'
+  #   task 'bar' do
+  #     task('foo').invoke
+  #   end
+  class Task #:nodoc:
+    def invoke(*args)
+      task_args = TaskArguments.new(arg_names, args)
+      invoke_with_call_chain(task_args, Thread.current[:rake_chain] || InvocationChain::EMPTY)
+    end
+
+    def invoke_with_call_chain(task_args, invocation_chain)
+      new_chain = InvocationChain.append(self, invocation_chain)
+      @lock.synchronize do
+        if application.options.trace
+          puts "** Invoke #{name} #{format_trace_flags}"
+        end
+        return if @already_invoked
+        @already_invoked = true
+        begin
+          invoke_prerequisites(task_args, new_chain)
+        rescue
+          trace "Exception while invoking prerequisites of task #{self.inspect}"
+          raise
+        end
+        begin
+          old_chain, Thread.current[:rake_chain] = Thread.current[:rake_chain], new_chain
+          execute(task_args) if needed?
+        ensure
+          Thread.current[:rake_chain] = nil
+        end
+      end
+    end
+  end
+end