slugbuilder 1.3.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06dc50b7ddf97d49f958e3a06e4129a6b049caed
-  data.tar.gz: c3a927ef28e60b0fa83d9d897478519b4806362b
+  metadata.gz: dc40a6d4591cdf1c3d38112e9d1bc4bde1012687
+  data.tar.gz: '0102491f9b95b694905db3e7876d588a2e067f62'
 SHA512:
-  metadata.gz: f86f5ad1ce6ad981cc2a8dd0b8f9d0911501e162ff7ad18915c6723bef994a62aee344cc7ca1e705981adff23ce9a6d79c1e04565c784072ed39ed30e71266ab
-  data.tar.gz: 01a9a03760f92205a8a372dd99f6317476b47574c720fc71bc902068b358319aebac5b164d30d73c37fdd3b012cd40520cb720fa5b455d8891db3a293f3ef8eb
+  metadata.gz: f64bcd5db7366dadd1f09d63a2a61a441ace5de3020a3827d5b60a0e39ce09e577eb6c600db871434038c21de73901794dde097b34b2185eac601719bf723659
+  data.tar.gz: f41a21fd11a8196aa2b2fd46f6f2197a7641ba11e6afb18092c5902a691d78b8054d2b721a86814604cc14015e85d6884a3b79a762b5410c5b6932f8ee316d34

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 2.0.0 (2017-5-3)
+
+Changed:
+
+- Prebuild and postbuild hooks now take `git_url` as a keyword argument
+
+Added:
+
+- The `protocol` configuration option allows specifying the protocol to use when downloading git repositories
+- Buildpack  and repository urls now accept more formats (`<organization>/<repository_name>`, `git@<git_service>:<organization>/<repository_name>.git`, and `https://<git_service>/<organization>/<repository_name>.git`
+
 ## 1.3.0 (2017-3-7)
 
 Added:

data/README.md

@@ -61,11 +61,11 @@ sb.build(clear_cache: true)
 # using a Proc or Proc-like object (responds to `call` method)
 sb = Slugbuilder::Builder.new(repo: 'heroku/node-js-sample', git_ref: 'master')
 class PostBuildInterface
-  def self.call(repo:, git_ref:, stats:, slug:)
+  def self.call(repo:, git_ref:, git_url:, stats:, slug:)
     # postbuild logic
   end
 end
-sb.build(prebuild: ->(repo: repo, git_ref: git_ref) { p "prebuild logic" }, postbuild: PostBuildInterface)
+sb.build(prebuild: ->(repo: repo, git_ref: git_ref, git_url: git_url) { p "prebuild logic" }, postbuild: PostBuildInterface)
 
 # prebuild/postbuild with optional blocks
 sb = Slugbuilder::Builder.new(repo: 'heroku/node-js-sample', git_ref: 'master') do |args|
@@ -84,12 +84,13 @@ You can optionally define a `pre-compile` or `post-compile` script in your appli
 
 ### Builder#initialize(repo:, git_ref:, &block)
 
-- `repo` String (required): the github repo in the form `<organization>/<repository>`
+- `repo` String (required): the github repo in the form `<organization>/<repository_name>`, `https://<git_service>/<organization>/<repository_name>.git`, or `git@<git_service>:<organization>/<repository_name>.git`
 - `git_ref` String (required): the SHA or branch to build
 - `stdout` IO (optional): the IO stream to write build output to. This defaults to `$stdout`
 - `block` Block (optional): an optional block that runs pre-build. It receives a Hash with the structure:
-  - `repo` String: The git repo identifier
+  - `repo` String: The git repo identifier in the form `<organization>/<repository_name>`
   - `git_ref` String: The git branchname or SHA
+  - `git_url` String: The git URL (this will be in the form specified by the `Slugbuilder.config.protocol`)
 
 Alternatively, a Proc can be passed to `build` method's keyword argument `prebuild` to achieve the same effect.
 
@@ -104,11 +105,13 @@ Alternatively, a Proc can be passed to `build` method's keyword argument `prebui
 - `prebuild` Proc (optional): an optional Proc (or anything that conforms to the `call` API of a Proc) that will be run before the build. The Proc will receive a Hash with the structure:
   - `repo` String: The git repo identifier
   - `git_ref` String: The git branchname or SHA
+  - `git_url` String: The git URL (this will be in the form specified by the `Slugbuilder.config.protocol`)
 Alternatively, a block can be passed to the `initialize` method to the same effect.
 - `postbuild` Proc (optional): an optional Proc (or anything that conforms to the `call` API of a Proc) that will run post-build. The Proc will receive a Hash with the structure:
   - `slug` String: Location of the built slug file
   - `repo` String: The git repo identifier
   - `git_ref` String: The git branchname or SHA
+  - `git_url` String: The git URL (this will be in the form specified by the `Slugbuilder.config.protocol`)
   - `git_sha` String: The git SHA (even if the git ref was a branch name)
   - `request_id` String: The unique id of the build request
   - `stats` Hash:
@@ -143,8 +146,9 @@ Slugbuilder.config.output_dir = './slugs'
 @cache_dir = '/tmp/slugbuilder-cache'
 @output_dir = './slugs'
 @git_service = 'github.com'
+@protocol = 'https'
 @buildpacks = [
-  'https://github.com/heroku/heroku-buildpack-nodejs.git',
+  'git@github.com:heroku/heroku-buildpack-nodejs.git',
   'https://github.com/heroku/heroku-buildpack-ruby.git#37ed188'
 ]
 ```
@@ -173,6 +177,12 @@ This is where the git repositories live (github.com, gitlab.com, bitbucket.org,
 
 > Defaults to `github.com`
 
+**protocol**
+
+The protocol that should be used to pull down git repositories (including buildbpacks). This can be either `https` or `ssh`
+
+> Defaults to `https` (also uses `https` if `protocol` is not valid)
+
 **buildpacks**
 
 Buildpacks is an array of valid git clone-able [buildpack](https://devcenter.heroku.com/articles/buildpacks) URLs.

data/lib/slugbuilder/builder.rb

@@ -12,15 +12,17 @@ module Slugbuilder
       @output_dir = Slugbuilder.config.output_dir
       @buildpacks_dir = File.join(@cache_dir, 'buildpacks')
       @env_dir = File.join(@base_dir, 'environment')
-      @repo = repo
+      repo_matches = parse_git_url(repo)
+      @repo = "#{repo_matches[:org]}/#{repo_matches[:name]}"
+      @git_url = normalize_git_url(repo)
       @git_ref = git_ref
-      @git_dir = Shellwords.escape(File.join(@base_dir, 'git', repo))
-      @build_dir = Shellwords.escape(File.join(@base_dir, repo, git_ref))
+      @git_dir = Shellwords.escape(File.join(@base_dir, 'git', @repo))
+      @build_dir = Shellwords.escape(File.join(@base_dir, @repo, git_ref))
 
       setup
 
       if block_given?
-        yield(repo: repo, git_ref: git_ref)
+        yield(repo: @repo, git_ref: git_ref, git_url: @git_url)
       end
     end
 
@@ -35,7 +37,7 @@ module Slugbuilder
       @slug_file = slug_name ? "#{slug_name}.tgz" : Shellwords.escape("#{@repo.gsub('/', '.')}.#{@git_ref}.#{@git_sha}.tgz")
       wipe_cache if clear_cache
 
-      prebuild.call(repo: @repo, git_ref: @git_ref) if prebuild
+      prebuild.call(repo: @repo, git_ref: @git_ref, git_url: @git_url) if prebuild
 
       with_clean_env do
         build_and_release
@@ -53,9 +55,9 @@ module Slugbuilder
         output: build_output.join('')
       }
 
-      postbuild.call(repo: @repo, git_ref: @git_ref, git_sha: @git_sha, request_id: @request_id, stats: stats, slug: File.join(@output_dir, @slug_file)) if postbuild
+      postbuild.call(repo: @repo, git_ref: @git_ref, git_sha: @git_sha, git_url: @git_url, request_id: @request_id, stats: stats, slug: File.join(@output_dir, @slug_file)) if postbuild
       if block_given?
-        yield(repo: @repo, git_ref: @git_ref, git_sha: @git_sha, request_id: @request_id, stats: stats, slug: File.join(@output_dir, @slug_file))
+        yield(repo: @repo, git_ref: @git_ref, git_sha: @git_sha, git_url: @git_url, request_id: @request_id, stats: stats, slug: File.join(@output_dir, @slug_file))
       end
       return true
     rescue => e
@@ -154,7 +156,7 @@ module Slugbuilder
 
     def download_repo
       stitle("Fetching #{@repo}")
-      rc = run("git clone --quiet git@#{Slugbuilder.config.git_service}:#{@repo}.git #{@git_dir}")
+      rc = run("git clone --quiet #{@git_url} #{@git_dir}")
       fail "Failed to download repo: #{@repo}" if rc != 0
     end
 
@@ -165,7 +167,8 @@ module Slugbuilder
     end
 
     def get_buildpack_name(url)
-      url.match(/.+\/(.+?)\.git$/)[1]
+      matches = parse_git_url(url)
+      "#{matches[:org]}__#{matches[:name]}#{matches[:hash]}"
     end
 
     def fetch_buildpacks
@@ -174,11 +177,12 @@ module Slugbuilder
 
       existing_buildpacks = Dir.entries(@buildpacks_dir)
       @buildpacks.each do |buildpack_url|
+        buildpack_matches = parse_git_url(buildpack_url)
         buildpack_name = get_buildpack_name(buildpack_url)
         if !existing_buildpacks.include?(buildpack_name)
           # download buildpack
           stitle("Fetching buildpack: #{buildpack_name}")
-          rc = run("git clone --quiet --depth=1 #{buildpack_url} #{@buildpacks_dir}/#{buildpack_name}")
+          rc = run("git clone --quiet #{normalize_git_url(buildpack_url)} #{@buildpacks_dir}/#{buildpack_name}")
           fail "Failed to download buildpack: #{buildpack_name}" if rc != 0
         else
           # fetch latest
@@ -188,6 +192,14 @@ module Slugbuilder
             fail "Failed to update: #{buildpack_name}" if rc != 0
           end
         end
+
+        # checkout hash
+        if buildpack_matches[:hash]
+          Dir.chdir("#{@buildpacks_dir}/#{buildpack_name}") do
+            rc = run("git fetch --quiet --all && git checkout --quiet #{buildpack_matches[:hash]}")
+            fail "Failed to fetch and checkout: #{buildpack_matches[:hash]}" if rc != 0
+          end
+        end
       end
 
       @buildpacks
@@ -251,6 +263,29 @@ module Slugbuilder
       stitle("Slug size is #{@slug_size} Megabytes.")
     end
 
+    def parse_git_url(url)
+      regex = %r{
+        ^
+        .*?
+        (?:(?<host>[^\/@]+)(\/|:))?
+        (?<org>[^\/:]+)
+        \/
+        (?<name>[^\/#\.]+)
+        (?:\.git(?:\#(?<hash>.+))?)?
+        $
+      }x
+      url.match(regex)
+    end
+
+    def normalize_git_url(url)
+      matches = parse_git_url(url)
+      if Slugbuilder.config.protocol == 'ssh'
+        "git@#{matches[:host] || Slugbuilder.config.git_service}:#{matches[:org]}/#{matches[:name]}.git"
+      else
+        "https://#{matches[:host] || Slugbuilder.config.git_service}/#{matches[:org]}/#{matches[:name]}.git"
+      end
+    end
+
     def print_workers
       workers = {}
       if File.exists?("#{@build_dir}/Procfile")

data/lib/slugbuilder/configuration.rb

@@ -17,13 +17,14 @@ module Slugbuilder
 
   class Configuration
     attr_accessor :base_dir, :cache_dir, :output_dir,
-      :git_service, :buildpacks
+      :git_service, :buildpacks, :protocol
 
     def initialize
       @base_dir = '/tmp/slugbuilder'
       @cache_dir = '/tmp/slugbuilder-cache'
       @output_dir = '.'
       @git_service = 'github.com'
+      @protocol = 'https'
       @buildpacks = []
     end
   end

data/lib/slugbuilder/version.rb

@@ -1,3 +1,3 @@
 module Slugbuilder
-  VERSION = '1.3.0'
+  VERSION = '2.0.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: slugbuilder
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Panoply Dev
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-07 00:00:00.000000000 Z
+date: 2017-05-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler