0
-# Licensed to the Apache Software Foundation (ASF) under one or more
0
-# contributor license agreements. See the NOTICE file distributed with this
0
-# work for additional information regarding copyright ownership. The ASF
0
-# licenses this file to you under the Apache License, Version 2.0 (the
0
-# "License"); you may not use this file except in compliance with the License.
0
-# You may obtain a copy of the License at
0
-# http://www.apache.org/licenses/LICENSE-2.0
0
-# Unless required by applicable law or agreed to in writing, software
0
-# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
0
-# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
0
-# License for the specific language governing permissions and limitations under
0
-require 'buildr/core/project'
0
-require 'buildr/core/compile'
0
-require 'buildr/java/artifact'
0
- # Methods added to Project to support packaging and tasks for packaging,
0
- # installing and uploading packages.
0
- desc 'Create packages'
0
- Project.local_task('package'=>'build') { |name| "Packaging #{name}" }
0
- desc 'Install packages created by the project'
0
- Project.local_task('install'=>'package') { |name| "Installing packages from #{name}" }
0
- desc 'Remove previously installed packages'
0
- Project.local_task('uninstall') { |name| "Uninstalling packages from #{name}" }
0
- desc 'Upload packages created by the project'
0
- Project.local_task('upload'=>'package') { |name| "Deploying packages from #{name}" }
0
- # Anything that comes after local packaging (install, deploy) executes the integration tests,
0
- # which do not conflict with integration invoking the project's own packaging (package=>
0
- # integration=>foo:package is not circular, just confusing to debug.)
0
- task('integration').invoke if Buildr.options.test && Buildr.application.original_dir == Dir.pwd
0
- before_define do |project|
0
- [ :package, :install, :uninstall, :upload ].each { |name| project.recursive_task name }
0
- # Need to run build before package, since package is often used as a dependency by tasks that
0
- # expect build to happen.
0
- project.task('package'=>project.task('build'))
0
- project.group ||= project.parent && project.parent.group || project.name
0
- project.version ||= project.parent && project.parent.version
0
- # The project's identifier. Same as the project name, with colons replaced by dashes.
0
- # The ID for project foo:bar is foo-bar.
0
- # Group used for packaging. Inherited from parent project. Defaults to the top-level project name.
0
- # Version used for packaging. Inherited from parent project.
0
- attr_accessor :version
0
- # package(type, spec?) => task
0
- # Defines and returns a package created by this project.
0
- # The first argument declares the package type. For example, :jar to create a JAR file.
0
- # The package is an artifact that takes its artifact specification from the project.
0
- # You can override the artifact specification by passing various options in the second
0
- # argument, for example:
0
- # package(:zip, :classifier=>'sources')
0
- # Packages that are ZIP files provides various ways to include additional files, directories,
0
- # and even merge ZIPs together. Have a look at ZipTask for more information. In case you're
0
- # wondering, JAR and WAR packages are ZIP files.
0
- # You can also enhance a JAR package using the ZipTask#with method that accepts the following options:
0
- # * :manifest -- Specifies how to create the MANIFEST.MF. By default, uses the project's
0
- # * :meta_inf -- Specifies files to be included in the META-INF directory. By default,
0
- # uses the project's #meta-inf property.
0
- # The WAR package supports the same options and adds a few more:
0
- # * :classes -- Directories of class files to include in WEB-INF/classes. Includes the compile
0
- # target directory by default.
0
- # * :libs -- Artifacts and files to include in WEB-INF/libs. Includes the compile classpath
0
- # dependencies by default.
0
- # compile.with project('beans')
0
- # package(:war).with :libs=>MYSQL_JDBC
0
- # package(:zip, :classifier=>'sources').include path_to('.')
0
- # Two other packaging types are:
0
- # * package :sources -- Creates a ZIP file with the source code and classifier 'sources', for use by IDEs.
0
- # * package :javadoc -- Creates a ZIP file with the Javadocs and classifier 'javadoc'. You can use the
0
- # javadoc method to further customize it.
0
- # A package is also an artifact. The following tasks operate on packages created by the project:
0
- # buildr upload # Upload packages created by the project
0
- # buildr install # Install packages created by the project
0
- # buildr package # Create packages
0
- # buildr uninstall # Remove previously installed packages
0
- # If you want to add additional packaging types, implement a method with the name package_as_[type]
0
- # that accepts a file name and returns an appropriate Rake task. For example:
0
- # def package_as_zip(file_name) #:nodoc:
0
- # ZipTask.define_task(file_name)
0
- # The file name is determined from the specification passed to the package method, however, some
0
- # packagers need to override this. For example, package(:sources) produces a file with the extension
0
- # 'zip' and the classifier 'sources'. If you need to overwrite the default implementation, you should
0
- # also include a method named package_as_[type]_respec. For example:
0
- # def package_as_sources_spec(spec) #:nodoc:
0
- # { :type=>:zip, :classifier=>'sources' }.merge(spec)
0
- spec = Hash === args.last ? args.pop.dup : {}
0
- rake_check_options spec, :file, :type
0
- spec[:type] = args.shift || spec[:type] || spec[:file].split('.').last
0
- file_name = spec[:file]
0
- rake_check_options spec, *ActsAsArtifact::ARTIFACT_ATTRIBUTES
0
- spec[:group] ||= self.group
0
- spec[:version] ||= self.version
0
- spec[:type] = args.shift || spec[:type] || compile.packaging || :zip
0
- packager = method("package_as_#{spec[:type]}") rescue fail("Don't know how to create a package of type #{spec[:type]}")
0
- if packager.arity == 1
0
- spec = send("package_as_#{spec[:type]}_spec", spec) if respond_to?("package_as_#{spec[:type]}_spec")
0
- file_name = path_to(:target, Artifact.hash_to_file_name(spec))
0
- package = packages.find { |pkg| pkg.name == file_name } || packager.call(file_name)
0
- Buildr.application.deprecated "We changed the way package_as methods are implemented. See the package method documentation for more details."
0
- file_name ||= path_to(:target, Artifact.hash_to_file_name(spec))
0
- package = packager.call(file_name, spec)
0
- # First time: prepare package for install, uninstall and upload tasks.
0
- unless packages.include?(package)
0
- # We already run build before package, but we also need to do so if the package itself is
0
- # used as a dependency, before we get to run the package task.
0
- task 'package'=>package
0
- package.enhance [task('build')]
0
- class << package ; self ; end.send(:define_method, :type) { spec[:type] }
0
- elsif !package.respond_to?(:install)
0
- # Make it an artifact using the specifications, and tell it how to create a POM.
0
- package.extend ActsAsArtifact
0
- package.send :apply_spec, spec.only(*Artifact::ARTIFACT_ATTRIBUTES)
0
- # Another task to create the POM file.
0
- mkpath File.dirname(pom.name), :verbose=>false
0
- File.open(pom.name, 'w') { |file| file.write pom.pom_xml }
0
- file(Buildr.repositories.locate(package)=>package) { package.install }
0
- # Add the package to the list of packages created by this project, and
0
- # register it as an artifact. The later is required so if we look up the spec
0
- # we find the package in the project's target directory, instead of finding it
0
- # in the local repository and attempting to install it.
0
- Artifact.register package, pom
0
- task('install') { package.install if package.respond_to?(:install) }
0
- task('uninstall') { package.uninstall if package.respond_to?(:uninstall) }
0
- task('upload') { package.upload if package.respond_to?(:upload) }
0
- # Returns all packages created by this project. A project may create any number of packages.
0
- # This method is used whenever you pass a project to Buildr#artifact or any other method
0
- # that accepts artifact specifications and projects. You can use it to list all packages
0
- # created by the project. If you want to return a specific package, it is often more
0
- # convenient to call #package with the type.
0
- def package_as_zip(file_name) #:nodoc:
0
- ZipTask.define_task(file_name)
0
- def package_as_tar(file_name) #:nodoc:
0
- TarTask.define_task(file_name)
0
- alias :package_as_tgz :package_as_tar
0
- def package_as_sources_spec(spec) #:nodoc:
0
- spec.merge(:type=>:zip, :classifier=>'sources')
0
- def package_as_sources(file_name) #:nodoc:
0
- ZipTask.define_task(file_name).tap do |zip|
0
- zip.include :from=>compile.sources
0
- include Buildr::Package
) is private.
