buildpack-support 1.0.0

data/lib/buildpack_support/rake/check_api_doc_task.rb

@@ -0,0 +1,70 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed 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.
+
+require 'buildpack_support/rake'
+require 'rake'
+require 'rake/tasklib'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for the +check_api_doc+ task
+    class CheckAPIDocTask < ::Rake::TaskLib
+
+      # @!attribute [rw] name
+      # @return [String] the name of the task.  Defaults to +:check_api_doc+.
+      attr_accessor :name
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task.  Defaults to +true+.
+      attr_accessor :verbose
+
+      # Creates a new instance of the +check_api_doc+ task
+      def initialize(*args, &task_block)
+        setup_ivars args
+
+        desc 'Check that all APIs have been documented' unless ::Rake.application.last_comment
+        task(name, *args) do |_, task_args|
+          task_block.call(*[self, task_args].slice(0, task_block.arity)) if task_block
+          run_task verbose
+        end
+      end
+
+      # Run the main task functionality
+      #
+      # @param [Boolean] verbose whether to print the detailed output of the failure
+      # @return [void]
+      def run_task(verbose)
+        output = `yard stats --list-undoc`
+        abort message(output, verbose) if output !~ /100.00% documented/
+      end
+
+      private
+
+      def message(output, verbose)
+        message = "\nFailed due to undocumented public API"
+        message += ":\n\n#{output}" if verbose
+        message
+      end
+
+      def setup_ivars(args)
+        @name    = args.shift || :check_api_doc
+        @verbose = true
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/dependency_cache_task.rb

@@ -0,0 +1,87 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed 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.
+
+require 'buildpack_support/cache/download_cache'
+require 'buildpack_support/logging/logger_factory'
+require 'buildpack_support/rake'
+require 'buildpack_support/rake/cached_artifact_finder'
+require 'buildpack_support/rake/repository_configuration_finder'
+require 'rake'
+require 'rake/tasklib'
+require 'pathname'
+# require 'yaml'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for tasks that download and cache buildpack dependencies
+    class DependencyCacheTask < ::Rake::TaskLib
+
+      # @!attribute [rw] build_dir
+      # @return [String] the directory to caching log file into
+      attr_accessor :build_dir
+
+      # @!attribute [rw] package_name
+      # @return [String] the name of the package
+      attr_accessor :package_name
+
+      # @!attribute [rw] staging_dir
+      # @return [String] the directory to zip the contents of
+      attr_accessor :staging_dir
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task.  Defaults to +false+.
+      attr_accessor :verbose
+
+      def initialize(&task_block)
+        @verbose = true
+
+        task_block.call(*[self].slice(0, task_block.arity)) if task_block
+        abort 'build_dir must be configured' unless build_dir
+        abort 'package_name must be configured' unless package_name
+        abort 'staging_dir must be configured' unless staging_dir
+
+        BuildpackSupport::Logging::LoggerFactory.instance.setup "#{build_dir}/"
+        @cache = BuildpackSupport::Cache::DownloadCache.new(Pathname.new("#{staging_dir}/resources/cache"))
+
+        create_cache_tasks package_name, verbose
+      end
+
+      # Runs the task
+      #
+      # @param [String] target the URI to cache
+      # @param [Boolean] verbose whether to print messages to the console
+      # @return [void]
+      def run_task(target, verbose)
+        rake_output_message "Caching #{target}" if verbose
+        @cache.get(target) {}
+      end
+
+      private
+
+      def create_cache_tasks(package_name, verbose)
+        configurations = RepositoryConfigurationFinder.new.find
+        uris           = CachedArtifactFinder.new.find configurations
+
+        uris.each do |target|
+          task package_name => target
+          task(target) { |t| run_task t.name, verbose }
+        end
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/disable_remote_downloads_task.rb

@@ -0,0 +1,80 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed 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.
+
+require 'buildpack_support/rake'
+require 'rake'
+require 'rake/tasklib'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for the task that disables remote downloads
+    class DisableRemoteDownloadsTask < ::Rake::TaskLib
+
+      # @!attribute [rw] package_name
+      # @return [String] the name of the package
+      attr_accessor :package_name
+
+      # @!attribute [rw] staging_dir
+      # @return [String] the directory to zip the contents of
+      attr_accessor :staging_dir
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task.  Defaults to +true+.
+      attr_accessor :verbose
+
+      def initialize(&task_block)
+        @verbose = false
+
+        task_block.call(*[self].slice(0, task_block.arity)) if task_block
+        abort 'package_name must be configured' unless package_name
+        abort 'staging_dir must be configured' unless staging_dir
+
+        create_task package_name, staging_dir, verbose
+      end
+
+      # Runs the task
+      #
+      # @param [String] source the name of the file to read from
+      # @param [String] target the name of the file to write to
+      # @param [Boolean] verbose whether to print messages to the console
+      # @return [void]
+      def run_task(source, target, verbose)
+        RakeFileUtils.verbose(verbose) do
+          mkdir_p File.dirname target
+
+          content = File.open(source, 'r') { |f| f.read.gsub(/enabled/, 'disabled') }
+          File.open(target, 'w') { |f| f.write content }
+          rake_output_message "Disabled remote downloads in #{target}" if verbose
+        end
+      end
+
+      private
+
+      def create_task(package_name, staging_dir, verbose)
+        target = target(staging_dir)
+
+        task package_name => target
+        file(target) { |t| run_task t.source, t.name, verbose }
+      end
+
+      def target(staging_dir)
+        "#{staging_dir}/config/cache.yml"
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/package_task.rb

@@ -0,0 +1,133 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed 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.
+
+require 'buildpack_support/buildpack_version'
+require 'buildpack_support/rake'
+require 'buildpack_support/rake/buildpack_stage_task'
+require 'buildpack_support/rake/dependency_cache_task'
+require 'buildpack_support/rake/disable_remote_downloads_task'
+require 'buildpack_support/rake/package_zip_task'
+require 'buildpack_support/rake/write_version_file_task'
+require 'rake'
+require 'rake/clean'
+require 'rake/tasklib'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for the +package+ task.  Responsible for creating the +package+ task and all of the sub-tasks
+    # that are required to do the work of creating the package
+    class PackageTask < ::Rake::TaskLib
+
+      # @!attribute [rw] build_dir
+      # @return [String] the directory to place the created package in.  Defaults to +build+.
+      attr_accessor :build_dir
+
+      # @!attribute [rw] files
+      # @return [Array<String>] the files to copy to the +staging_dir+
+      attr_accessor :files
+
+      # @!attribute [rw] name
+      # @return [String] the name of the task.  Defaults to +:package+.
+      attr_accessor :name
+
+      # @!attribute [rw] prefix
+      # @return [String] the prefix of the package that is created
+      attr_accessor :prefix
+
+      # @!attribute [rw] staging_dir
+      # @return [String] the directory to zip the contents of.  Defaults to +build/staging+.
+      attr_accessor :staging_dir
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task
+      attr_accessor :verbose
+
+      def initialize(*args, &task_block)
+        setup_ivars args
+
+        task_block.call(*[self].slice(0, task_block.arity)) if task_block
+        abort 'package prefix must be configured' unless prefix
+
+        CLEAN.include build_dir, staging_dir
+
+        desc 'Create packaged buildpack' unless ::Rake.application.last_comment
+        task(name, *args)
+        task name => package_name
+
+        add_universal_tasks
+        add_offline_tasks if @buildpack_version.offline
+      end
+
+      private
+
+      def add_offline_tasks
+        DependencyCacheTask.new do |t|
+          t.build_dir    = build_dir
+          t.package_name = package_name
+          t.staging_dir  = staging_dir
+          t.verbose      = verbose unless verbose.nil?
+        end
+
+        DisableRemoteDownloadsTask.new do |t|
+          t.package_name = package_name
+          t.staging_dir  = staging_dir
+          t.verbose      = verbose unless verbose.nil?
+        end
+      end
+
+      def add_universal_tasks
+        PackageZipTask.new do |t|
+          t.package_name = package_name
+          t.staging_dir  = staging_dir
+          t.verbose      = verbose unless verbose.nil?
+        end
+
+        BuildpackStageTask.new do |t|
+          t.files        = files
+          t.package_name = package_name
+          t.staging_dir  = staging_dir
+          t.verbose      = verbose unless verbose.nil?
+        end
+
+        WriteVersionFileTask.new do |t|
+          t.buildpack_version = @buildpack_version
+          t.package_name      = package_name
+          t.staging_dir       = staging_dir
+          t.verbose           = verbose unless verbose.nil?
+        end
+      end
+
+      def package_name
+        package_name = "#{build_dir}/#{prefix}"
+        package_name += '-offline' if @buildpack_version.offline
+        package_name + "-#{version}.zip"
+      end
+
+      def setup_ivars(args)
+        @name              = args.shift || :package
+        @build_dir         = 'build'
+        @buildpack_version = BuildpackSupport::BuildpackVersion.new(false)
+        @staging_dir       = 'build/staging'
+      end
+
+      def version
+        @buildpack_version.version || 'unknown'
+      end
+
+    end
+
+  end
+end

data/lib/buildpack_support/rake/package_zip_task.rb

@@ -0,0 +1,80 @@
+# Encoding: utf-8
+# # Copyright 2013-2014 the original author or authors.
+#
+# Licensed 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.
+
+require 'buildpack_support/rake'
+require 'rake'
+require 'rake/tasklib'
+require 'zip'
+
+module BuildpackSupport
+  module Rake
+
+    # A task generator for the task that creates the package zip file.
+    class PackageZipTask < ::Rake::TaskLib
+
+      # @!attribute [rw] package_name
+      # @return [String] the name of the package
+      attr_accessor :package_name
+
+      # @!attribute [rw] staging_dir
+      # @return [String] the directory to zip the contents of
+      attr_accessor :staging_dir
+
+      # @!attribute [rw] verbose
+      # @return [Boolean] the verbosity of the task.  Defaults to +true+.
+      attr_accessor :verbose
+
+      def initialize(&task_block)
+        @verbose = false
+
+        task_block.call(*[self].slice(0, task_block.arity)) if task_block
+        abort 'package_name must be configured' unless package_name
+        abort 'staging_dir must be configured' unless staging_dir
+
+        task(package_name) { |t| run_task t.name, staging_dir, verbose }
+      end
+
+      # Runs the task
+      #
+      # @param [String] name the name of the ZIP file to create
+      # @param [String] staging_dir the directory to ZIP up
+      # @param [Boolean] verbose whether to print messages to the console
+      # @return [void]
+      def run_task(name, staging_dir, verbose)
+        RakeFileUtils.verbose(verbose) do
+          mkdir_p File.dirname(name)
+
+          Zip::File.open(name, Zip::File::CREATE) do |zipfile|
+            Dir[File.join(staging_dir, '**', '**')].each do |file|
+              relative_path = relative_path(file, staging_dir)
+              rake_output_message "a #{relative_path}" if verbose
+              zipfile.add(relative_path, file)
+            end
+          end
+        end
+
+        rake_output_message "Created package #{name}"
+      end
+
+      private
+
+      def relative_path(file, staging_dir)
+        file.sub("#{staging_dir}/", '')
+      end
+
+    end
+
+  end
+end