rake_dependencies 0.16.1.pre1 → 0.16.1.pre2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5ecfde2a6c47258e2065ec06ff9dcd48c629ab912fe6f5c4d01edb3c755512c8
-  data.tar.gz: ea7f5da510d8d47f2120ec0418ae112edb08c741c41efb1810d0f2885c7ae76f
+  metadata.gz: b677ec56cc6b429fcb7bd61f37774b8c16b59518207ee9854077ca03f78155c1
+  data.tar.gz: 595cfaf1f921dd1aa59324ed36e7966978e26d550c158f90e6e7f8e6c7801232
 SHA512:
-  metadata.gz: a76853c9f507f848cb391d4fda341a2cb8d825ecdf82d37ef76a6475eaa6945386259fccb7767b339f987a3cfed4f283810b5e0b8164d0c9c5aa8c0696c5e5f4
-  data.tar.gz: c208cbfaec3b028d710239882b79756bc0552c795b45a040e1f30778f264a910a31a9738ebf00cd2f113e92ad8ee0279352c75002d7a07bd53134fc734877b62
+  metadata.gz: dc9c6ce97449ced353b879752bbbaf1ae805244123e4d5d6695dba031cdce785be80bd5624b24dbe8a9dc0e6eb6984c74740f9b83e1c0938d71a5bcb6820008e
+  data.tar.gz: 6fbbd0649e0fee2495911b1f4dea52728a039fb466d35be9cc02545abe14e5b65781e3ba3b6849a97b436964a926b37e759ca634418a19bf89e90301108f6215

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rake_dependencies (0.16.1.pre1)
+    rake_dependencies (0.16.1.pre2)
       hamster (~> 3.0)
       minitar (~> 0.6)
       rubyzip (~> 1.1)
@@ -56,7 +56,7 @@ PLATFORMS
 DEPENDENCIES
   activesupport (~> 4.2)
   bundler (~> 1.14)
-  fakefs (~> 0.10)
+  fakefs (~> 0.18)
   gem-release (~> 0.7)
   rake (~> 11.0)
   rake_dependencies!

data/README.md

@@ -81,19 +81,49 @@ task :provision_database => ['terraform:ensure'] do
 end
 ```
 
+If the `installation_directory` attribute is supplied, an additional `install` 
+task will be defined:
+
+```ruby
+ RakeDependencies::Tasks::All.new do |t|
+   t.namespace = :terraform
+   t.dependency = 'terraform'
+   
+   # ...
+   t.installation_directory = "#{ENV['HOME']}/bin"
+   # ...
+end
+```
+
+Then:
+
+```bash
+> rake -T
+rake terraform:clean     # Clean vendored terraform
+rake terraform:download  # Download terraform distribution
+rake terraform:ensure    # Ensure terraform present
+rake terraform:extract   # Extract terraform archive
+rake terraform:fetch     # Fetch terraform
+rake terraform:install   # Install terraform
+```
+
+The `<ns>:install` task copies the binary into the defined installation 
+directory which can be anywhere on the filesystem.
+
 The `RakeDependencies::Tasks::All` tasklib supports the following configuration
 parameters:
 
 | Name                          | Description                                                                                                           | Default                          | Required |
 |-------------------------------|-----------------------------------------------------------------------------------------------------------------------|----------------------------------|:--------:|
 | `namespace`                   | The namespace in which to define the tasks                                                                            | -                                | no       |
-| `dependency`                  | The name of the dependency, used in status reporting                                                                  | -                                | yes      |
+| `dependency`                  | The name of the dependency, used in status reporting and as the default binary name                                   | -                                | yes      |
 | `version`                     | The version of the dependency to manage, only required if used in templates or `needs_fetch`                          | -                                | no       |
 | `path`                        | The path in which to install the dependency                                                                           | -                                | yes      |
 | `type`                        | The archive type of the distribution, one of `:zip`, `:tar_gz`, `:tgz` or `:uncompressed`                             | `:zip`                           | yes      |
 | `os_ids`                      | A map of platforms to OS identifiers to use in templates, containing entries for `:mac` and `:linux`                  | `{:mac: 'mac', :linux: 'linux'}` | yes      |
 | `distribution_directory`      | The name of the directory under the supplied path into which to download the distribution                             | `'dist'`                         | yes      |
 | `binary_directory`            | The name of the directory under the supplied path into which to extract/copy the binaries                             | `'bin'`                          | yes      |
+| `installation_directory`      | The name of the directory into which to install the binaries, anywhere on the file system                             | -                                | no       |
 | `uri_template`                | A template for the URI of the distribution                                                                            | -                                | yes      |
 | `file_name_template`          | A template for the name of the downloaded file                                                                        | -                                | yes      |
 | `target_name_template`        | A template for the name of the binary after extraction/copying                                                        | -                                | no       |
@@ -102,6 +132,7 @@ parameters:
 | `clean_task_name`             | The name of the clean task, required if it should be different from the default                                       | `:clean`                         | yes      |
 | `download_task_name`          | The name of the download task, required if it should be different from the default                                    | `:download`                      | yes      |
 | `extract_task_name`           | The name of the extract task, required if it should be different from the default                                     | `:extract`                       | yes      |
+| `install_task_name`           | The name of the install task, required if it should be different from the default                                     | `:install`                       | no       |
 | `fetch_task_name`             | The name of the fetch task, required if it should be different from the default                                       | `:fetch`                         | yes      |
 | `ensure_task_name`            | The name of the ensure task, required if it should be different from the default                                      | `:ensure`                        | yes      |
 
@@ -125,6 +156,7 @@ in its definition:
 * `RakeDependencies::Tasks::Clean`
 * `RakeDependencies::Tasks::Download`
 * `RakeDependencies::Tasks::Extract`
+* `RakeDependencies::Tasks::Install`
 * `RakeDependencies::Tasks::Fetch`
 * `RakeDependencies::Tasks::Ensure`
 
@@ -192,6 +224,27 @@ Notes:
 * The extractor map can be overridden but should include entries for all of the
   above.
 
+### `RakeDependencies::Tasks::Install`
+
+The `RakeDependencies::Tasks::Install` tasklib supports the following 
+configuration parameters:
+
+| Name                     | Description                                                                                          | Default                            | Required |
+|--------------------------|------------------------------------------------------------------------------------------------------|------------------------------------|:--------:|
+| `name`                   | The name of the task, required if it should be different from the default                            | `:install`                         | yes      |
+| `dependency`             | The name of the dependency, used in status reporting                                                 | -                                  | yes      |
+| `version`                | The version of the dependency to manage, only required if used in templates                          | -                                  | no       |
+| `path`                   | The path in which to install the dependency                                                          | -                                  | yes      |
+| `type`                   | The archive type of the original distribution, one of `:zip`, `:tar_gz`, `:tgz` or `:uncompressed`   | `:zip`                             | yes      |
+| `os_ids`                 | A map of platforms to OS identifiers to use in templates, containing entries for `:mac` and `:linux` | `{:mac: 'mac', :linux: 'linux'}`   | yes      |
+| `binary_directory`       | The name of the directory under the supplied path into which to extract/copy the binaries            | `'bin'`                            | yes      |
+| `installation_directory` | The name of the directory into which the binary should be installed                                  | -                                  | yes      |
+| `binary_name_template`   | A template for the name of the binary                                                                | -                                  | yes      |
+
+Notes:
+* The templates have the same instance variables in scope when rendered as 
+  mentioned above.
+
 ### `RakeDependencies::Tasks::Fetch`
 
 The `RakeDependencies::Tasks::Fetch` tasklib supports the following 
@@ -220,6 +273,7 @@ configuration parameters:
 | `clean_task`       | The full name including namespaces of the clean task                                                                  | `<current-namespace>:clean`    | yes      |
 | `download_task`    | The full name including namespaces of the download task                                                               | `<current-namespace>:download` | yes      |
 | `extract_task`     | The full name including namespaces of the extract task                                                                | `<current-namespace>:extract`  | yes      |
+| `install_task`     | The full name including namespaces of the install task                                                                | `<current-namespace>:install`  | yes      |
 
 Notes:
 * The templates have the same instance variables in scope when rendered as 

data/lib/rake_dependencies/tasks/all.rb

@@ -19,6 +19,7 @@ module RakeDependencies
 
       parameter :distribution_directory, default: 'dist'
       parameter :binary_directory, default: 'bin'
+      parameter :installation_directory
 
       parameter :uri_template, :required => true
       parameter :file_name_template, :required => true
@@ -30,6 +31,7 @@ module RakeDependencies
       parameter :clean_task_name, :default => :clean
       parameter :download_task_name, :default => :download
       parameter :extract_task_name, :default => :extract
+      parameter :install_task_name, :default => :install
       parameter :fetch_task_name, :default => :fetch
       parameter :ensure_task_name, :default => :ensure
 
@@ -86,6 +88,21 @@ module RakeDependencies
           t.strip_path_template = strip_path_template
           t.target_name_template = target_name_template
         end
+        Install.new do |t|
+          t.name = install_task_name
+
+          t.dependency = dependency
+          t.version = version
+          t.path = path
+          t.type = type
+
+          t.os_ids = os_ids
+
+          t.binary_directory = binary_directory
+          t.binary_name_template = target_name_template || dependency
+
+          t.installation_directory = installation_directory
+        end if installation_directory
         Fetch.new do |t|
           t.name = fetch_task_name
 
@@ -108,8 +125,9 @@ module RakeDependencies
           t.clean_task = clean_task_name
           t.download_task = download_task_name
           t.extract_task = extract_task_name
+          t.install_task = install_task_name
         end
       end
     end
   end
-end
+end

data/lib/rake_dependencies/tasks/ensure.rb

@@ -16,6 +16,7 @@ module RakeDependencies
       parameter :clean_task, default: :clean
       parameter :download_task, default: :download
       parameter :extract_task, default: :extract
+      parameter :install_task, default: :install
 
       def process_arguments args
         super(args)
@@ -27,6 +28,15 @@ module RakeDependencies
         download = Rake::Task[scoped_task_name(download_task)]
         extract = Rake::Task[scoped_task_name(extract_task)]
 
+        resolved_install_task = scoped_task_name(install_task)
+        install = if Rake::Task.task_defined?(resolved_install_task)
+                    Rake::Task[scoped_task_name(install_task)]
+                  else
+                    no_op_task = Object.new
+                    def no_op_task.invoke; end
+                    no_op_task
+                  end
+
         desc "Ensure #{dependency} present"
         task name do
           parameters = {
@@ -35,7 +45,7 @@ module RakeDependencies
               binary_directory: binary_directory
           }
           if needs_fetch.call(parameters)
-            [clean, download, extract].map(&:invoke)
+            [clean, download, extract, install].map(&:invoke)
           end
         end
       end
@@ -47,4 +57,4 @@ module RakeDependencies
       end
     end
   end
-end
+end

data/lib/rake_dependencies/tasks/extract.rb

@@ -46,8 +46,8 @@ module RakeDependencies
           }
 
           distribution_file_name = Template.new(file_name_template)
-             .with_parameters(parameters)
-             .render
+                                       .with_parameters(parameters)
+                                       .render
           distribution_file_directory = File.join(path, distribution_directory)
           distribution_file_path = File.join(
               distribution_file_directory, distribution_file_name)
@@ -57,14 +57,14 @@ module RakeDependencies
           options = {}
           if strip_path_template
             options[:strip_path] = Template.new(strip_path_template)
-                .with_parameters(parameters)
-                .render
+                                       .with_parameters(parameters)
+                                       .render
           end
 
           if target_name_template
             options[:rename_to] = Template.new(target_name_template)
-                .with_parameters(parameters)
-                .render
+                                      .with_parameters(parameters)
+                                      .render
           end
 
           extractor = extractor_for_extension.new(
@@ -95,14 +95,18 @@ module RakeDependencies
 
       def ext
         case resolved_type
-          when :tar_gz then '.tar.gz'
-          when :tgz then '.tgz'
-          when :zip then '.zip'
-          when :uncompressed then ''
-          else
-            raise "Unknown type: #{type}"
+        when :tar_gz then
+          '.tar.gz'
+        when :tgz then
+          '.tgz'
+        when :zip then
+          '.zip'
+        when :uncompressed then
+          ''
+        else
+          raise "Unknown type: #{type}"
         end
       end
     end
   end
-end
+end

data/lib/rake_dependencies/tasks/install.rb

@@ -0,0 +1,78 @@
+require_relative '../tasklib'
+
+module RakeDependencies
+  module Tasks
+    class Install < TaskLib
+      parameter :name, default: :install
+
+      parameter :os_ids, default: {
+          mac: 'mac',
+          linux: 'linux'
+      }
+
+      parameter :dependency, required: true
+      parameter :version
+      parameter :path, required: true
+      parameter :type, default: :zip
+
+      parameter :binary_directory, default: 'bin'
+      parameter :binary_name_template, required: true
+
+      parameter :installation_directory, required: true
+
+      def process_arguments args
+        super(args)
+        self.name = args[0] if args[0]
+      end
+
+      def define
+        desc "Install #{dependency}"
+        task name do
+          parameters = {
+              version: version,
+              platform: platform,
+              os_id: os_id,
+              ext: ext
+          }
+
+          binary_file_name = Template.new(binary_name_template)
+                                       .with_parameters(parameters)
+                                       .render
+          binary_file_directory = File.join(path, binary_directory)
+          binary_file_path = File.join(
+              binary_file_directory, binary_file_name)
+
+          mkdir_p installation_directory
+          cp binary_file_path, installation_directory
+        end
+      end
+
+      def os_id
+        os_ids[platform]
+      end
+
+      def platform
+        RUBY_PLATFORM =~ /darwin/ ? :mac : :linux
+      end
+
+      def resolved_type
+        type.is_a?(Hash) ? type[platform].to_sym : type.to_sym
+      end
+
+      def ext
+        case resolved_type
+        when :tar_gz then
+          '.tar.gz'
+        when :tgz then
+          '.tgz'
+        when :zip then
+          '.zip'
+        when :uncompressed then
+          ''
+        else
+          raise "Unknown type: #{type}"
+        end
+      end
+    end
+  end
+end

data/lib/rake_dependencies/tasks.rb

@@ -1,6 +1,7 @@
 require_relative 'tasks/clean'
 require_relative 'tasks/download'
 require_relative 'tasks/extract'
+require_relative 'tasks/install'
 require_relative 'tasks/fetch'
 require_relative 'tasks/ensure'
-require_relative 'tasks/all'
+require_relative 'tasks/all'

data/lib/rake_dependencies/version.rb

@@ -1,3 +1,3 @@
 module RakeDependencies
-  VERSION = "0.16.1.pre1"
+  VERSION = "0.16.1.pre2"
 end

data/rake_dependencies.gemspec

@@ -33,6 +33,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'gem-release', '~> 0.7'
   spec.add_development_dependency 'activesupport', '~> 4.2'
-  spec.add_development_dependency 'fakefs', '~> 0.10'
+  spec.add_development_dependency 'fakefs', '~> 0.18'
   spec.add_development_dependency 'simplecov', '~> 0.13'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rake_dependencies
 version: !ruby/object:Gem::Version
-  version: 0.16.1.pre1
+  version: 0.16.1.pre2
 platform: ruby
 authors:
 - Toby Clemson
@@ -128,14 +128,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -196,6 +196,7 @@ files:
 - lib/rake_dependencies/tasks/ensure.rb
 - lib/rake_dependencies/tasks/extract.rb
 - lib/rake_dependencies/tasks/fetch.rb
+- lib/rake_dependencies/tasks/install.rb
 - lib/rake_dependencies/template.rb
 - lib/rake_dependencies/version.rb
 - rake_dependencies.gemspec