berkshelf-hg 0.1.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NGE5NWU0NzFjODg5NjA0NjZmZjBkNzY2Nzc0OTY5ZWJmZjQxNDQ0Yw==
+  data.tar.gz: !binary |-
+    MWZjNGRkMTAyZTgxNTZiMmYyNmQwMGYyN2E4YTYyMmMyMzZiNzk4MQ==
+SHA512:
+  metadata.gz: !binary |-
+    NWI2MjViMmY2YjM2ZDNiYjE2MWU3NGFjODZiNTgxMTVkYmU2ZGUzZDc3Zjk2
+    NTY1OTNiNGYzNjQwODVmN2Y2ZWM0ZTNiMTU0OWNiNTQ5YWUzYTQ2N2E5YzYz
+    ZmY2MWFmMzFkNTZkMTYxMjI1NGZmNDNkZWZiMWVmMGNjYzhjMjc=
+  data.tar.gz: !binary |-
+    ZDZiNmMyOWFhNmQ5NzgyZTBlN2IyOTMwYzdhYjUyYmQ4Mjk3OTI1MWI5Nzgx
+    ODExM2RmZThmOTI0ODUxODc2MjdlYWZmN2JmN2RiNWVkYWFjZGRlOThmMzQ0
+    N2YzMzYwZmE0ZGIwODRlYTdhZDNjZjJjMWIyYjcwY2NlYWNhNjY=

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.rspec
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.travis.yml

@@ -0,0 +1,8 @@
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+
+bundler_args: --jobs 7
+
+script: bundle exec rake travis:ci

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                              Apache License
+                        Version 2.0, January 2004
+                     http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+   "License" shall mean the terms and conditions for use, reproduction,
+   and distribution as defined by Sections 1 through 9 of this document.
+
+   "Licensor" shall mean the copyright owner or entity authorized by
+   the copyright owner that is granting the License.
+
+   "Legal Entity" shall mean the union of the acting entity and all
+   other entities that control, are controlled by, or are under common
+   control with that entity. For the purposes of this definition,
+   "control" means (i) the power, direct or indirect, to cause the
+   direction or management of such entity, whether by contract or
+   otherwise, or (ii) ownership of fifty percent (50%) or more of the
+   outstanding shares, or (iii) beneficial ownership of such entity.
+
+   "You" (or "Your") shall mean an individual or Legal Entity
+   exercising permissions granted by this License.
+
+   "Source" form shall mean the preferred form for making modifications,
+   including but not limited to software source code, documentation
+   source, and configuration files.
+
+   "Object" form shall mean any form resulting from mechanical
+   transformation or translation of a Source form, including but
+   not limited to compiled object code, generated documentation,
+   and conversions to other media types.
+
+   "Work" shall mean the work of authorship, whether in Source or
+   Object form, made available under the License, as indicated by a
+   copyright notice that is included in or attached to the work
+   (an example is provided in the Appendix below).
+
+   "Derivative Works" shall mean any work, whether in Source or Object
+   form, that is based on (or derived from) the Work and for which the
+   editorial revisions, annotations, elaborations, or other modifications
+   represent, as a whole, an original work of authorship. For the purposes
+   of this License, Derivative Works shall not include works that remain
+   separable from, or merely link (or bind by name) to the interfaces of,
+   the Work and Derivative Works thereof.
+
+   "Contribution" shall mean any work of authorship, including
+   the original version of the Work and any modifications or additions
+   to that Work or Derivative Works thereof, that is intentionally
+   submitted to Licensor for inclusion in the Work by the copyright owner
+   or by an individual or Legal Entity authorized to submit on behalf of
+   the copyright owner. For the purposes of this definition, "submitted"
+   means any form of electronic, verbal, or written communication sent
+   to the Licensor or its representatives, including but not limited to
+   communication on electronic mailing lists, source code control systems,
+   and issue tracking systems that are managed by, or on behalf of, the
+   Licensor for the purpose of discussing and improving the Work, but
+   excluding communication that is conspicuously marked or otherwise
+   designated in writing by the copyright owner as "Not a Contribution."
+
+   "Contributor" shall mean Licensor and any individual or Legal Entity
+   on behalf of whom a Contribution has been received by Licensor and
+   subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   copyright license to reproduce, prepare Derivative Works of,
+   publicly display, publicly perform, sublicense, and distribute the
+   Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+   this License, each Contributor hereby grants to You a perpetual,
+   worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+   (except as stated in this section) patent license to make, have made,
+   use, offer to sell, sell, import, and otherwise transfer the Work,
+   where such license applies only to those patent claims licensable
+   by such Contributor that are necessarily infringed by their
+   Contribution(s) alone or by combination of their Contribution(s)
+   with the Work to which such Contribution(s) was submitted. If You
+   institute patent litigation against any entity (including a
+   cross-claim or counterclaim in a lawsuit) alleging that the Work
+   or a Contribution incorporated within the Work constitutes direct
+   or contributory patent infringement, then any patent licenses
+   granted to You under this License for that Work shall terminate
+   as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+   Work or Derivative Works thereof in any medium, with or without
+   modifications, and in Source or Object form, provided that You
+   meet the following conditions:
+
+   (a) You must give any other recipients of the Work or
+       Derivative Works a copy of this License; and
+
+   (b) You must cause any modified files to carry prominent notices
+       stating that You changed the files; and
+
+   (c) You must retain, in the Source form of any Derivative Works
+       that You distribute, all copyright, patent, trademark, and
+       attribution notices from the Source form of the Work,
+       excluding those notices that do not pertain to any part of
+       the Derivative Works; and
+
+   (d) If the Work includes a "NOTICE" text file as part of its
+       distribution, then any Derivative Works that You distribute must
+       include a readable copy of the attribution notices contained
+       within such NOTICE file, excluding those notices that do not
+       pertain to any part of the Derivative Works, in at least one
+       of the following places: within a NOTICE text file distributed
+       as part of the Derivative Works; within the Source form or
+       documentation, if provided along with the Derivative Works; or,
+       within a display generated by the Derivative Works, if and
+       wherever such third-party notices normally appear. The contents
+       of the NOTICE file are for informational purposes only and
+       do not modify the License. You may add Your own attribution
+       notices within Derivative Works that You distribute, alongside
+       or as an addendum to the NOTICE text from the Work, provided
+       that such additional attribution notices cannot be construed
+       as modifying the License.
+
+   You may add Your own copyright statement to Your modifications and
+   may provide additional or different license terms and conditions
+   for use, reproduction, or distribution of Your modifications, or
+   for any such Derivative Works as a whole, provided Your use,
+   reproduction, and distribution of the Work otherwise complies with
+   the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+   any Contribution intentionally submitted for inclusion in the Work
+   by You to the Licensor shall be under the terms and conditions of
+   this License, without any additional terms or conditions.
+   Notwithstanding the above, nothing herein shall supersede or modify
+   the terms of any separate license agreement you may have executed
+   with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+   names, trademarks, service marks, or product names of the Licensor,
+   except as required for reasonable and customary use in describing the
+   origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+   agreed to in writing, Licensor provides the Work (and each
+   Contributor provides its Contributions) on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+   implied, including, without limitation, any warranties or conditions
+   of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+   PARTICULAR PURPOSE. You are solely responsible for determining the
+   appropriateness of using or redistributing the Work and assume any
+   risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+   whether in tort (including negligence), contract, or otherwise,
+   unless required by applicable law (such as deliberate and grossly
+   negligent acts) or agreed to in writing, shall any Contributor be
+   liable to You for damages, including any direct, indirect, special,
+   incidental, or consequential damages of any character arising as a
+   result of this License or out of the use or inability to use the
+   Work (including but not limited to damages for loss of goodwill,
+   work stoppage, computer failure or malfunction, or any and all
+   other commercial damages or losses), even if such Contributor
+   has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+   the Work or Derivative Works thereof, You may choose to offer,
+   and charge a fee for, acceptance of support, warranty, indemnity,
+   or other liability obligations and/or rights consistent with this
+   License. However, in accepting such obligations, You may act only
+   on Your own behalf and on Your sole responsibility, not on behalf
+   of any other Contributor, and only if You agree to indemnify,
+   defend, and hold each Contributor harmless for any liability
+   incurred by, or claims asserted against, such Contributor by reason
+   of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+   To apply the Apache License to your work, attach the following
+   boilerplate notice, with the fields enclosed by brackets "[]"
+   replaced with your own identifying information. (Don't include
+   the brackets!)  The text should be enclosed in the appropriate
+   comment syntax for the file format. We also recommend that a
+   file or class name and description of purpose be included on the
+   same "printed page" as the copyright notice for easier
+   identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+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.

data/README.md

@@ -0,0 +1,63 @@
+Berkshelf Hg
+============
+[![Gem Version](https://badge.fury.io/rb/berkshelf-hg.png)](http://badge.fury.io/rb/berkshelf-hg)
+[![Build Status](https://travis-ci.org/berkshelf/berkshelf-hg.png?branch=master)](https://travis-ci.org/berkshelf/berkshelf-hg)
+
+Berkshelf Hg (or Berkshelf Mercurial) is a Berkshelf extension that adds support for downloading cookbooks from Mercurial locations.
+
+Installation
+------------
+Add this line to your application's Gemfile:
+
+    gem 'berkshelf-hg'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install berkshelf-hg
+
+Usage
+-----
+Activate the extension in your `Berksfile`:
+
+```ruby
+source 'https://api.berkshelf.com'
+extension 'hg'
+```
+
+Use the exposed `:hg` key to define your sources:
+
+```ruby
+cookbook 'bacon', hg: 'https://bitbucket.org/meats/bacon'
+```
+
+You may also specify a `branch` or `tag`:
+
+```ruby
+cookbook 'bacon', hg: 'https://bitbucket.org/meats/bacon', branch: 'crispy'
+```
+
+License & Authors
+-----------------
+- Author: Seth Vargo (sethvargo@gmail.com)
+- Author: Manuel Ryan (ryan@shamu.ch)
+
+```text
+Copyright 2014 Seth Vargo
+Copyright 2013-2014 Manual Ryan
+
+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.
+```

data/Rakefile

@@ -0,0 +1,12 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:unit)
+
+require 'cucumber/rake/task'
+Cucumber::Rake::Task.new(:integration)
+
+namespace :travis do
+  desc 'Run the tests on Travis'
+  task :ci => [:unit, :integration]
+end

data/berkshelf-hg.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'berkshelf/hg/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'berkshelf-hg'
+  spec.version       = Berkshelf::Hg::VERSION
+  spec.authors       = [
+    'Seth Vargo',
+    'Manuel Ryan',
+  ]
+  spec.email         = [
+    'sethvargo@gmail.com',
+    'ryan@shamu.ch',
+  ]
+  spec.summary       = 'Mercurial (hg) support for Berkshelf'
+  spec.description   = 'A Berkshelf plugin that adds support for downloading ' \
+                       'Chef cookbooks from Mercurial (hg) locations.'
+  spec.homepage      = 'https://github.com/berkshelf/berkshelf-hg'
+  spec.license       = 'Apache 2.0'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  # Runtime dependencies
+  spec.add_dependency 'berkshelf', '~> 3.1'
+
+  # Development dependencies
+  spec.add_development_dependency 'aruba', '~> 0.5'
+  spec.add_development_dependency 'rspec', '~> 2.14'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+end

data/features/hg.feature

@@ -0,0 +1,39 @@
+Feature: Installing from a mercurial location
+  Scenario: In the default scenario
+    * a remote mercurial cookbook named "fake"
+    * I write to "Berksfile" with:
+      """
+      source 'https://api.berkshelf.com'
+      extension 'hg'
+
+      cookbook 'fake', hg: "file://localhost#{Dir.pwd}/hg-cookbooks/fake"
+      """
+    * I successfully run `berks install`
+    * the output should contain "Using fake (1.0.0)"
+
+  Scenario: When a branch is given
+    * a remote mercurial cookbook named "fake" with a branch named "development"
+    * I write to "Berksfile" with:
+      """
+      source 'https://api.berkshelf.com'
+      extension 'hg'
+
+      cookbook 'fake', hg: "file://localhost#{Dir.pwd}/hg-cookbooks/fake", branch: 'development'
+      """
+    * I successfully run `berks install`
+    * the output should contain "Using fake (2.3.4)"
+
+  Scenario: When a relative path is given
+   * a remote mercurial repo with two cookbooks named "fakeA" and "fakeB"
+   * I write to "Berksfile" with:
+      """
+      source 'https://api.berkshelf.com'
+      extension 'hg'
+
+      cookbook 'fakeA', hg: "file://localhost#{Dir.pwd}/hg-cookbooks", rel: "site-cookbooks/fakeA"
+      cookbook 'fakeB', hg: "file://localhost#{Dir.pwd}/hg-cookbooks", rel: "site-cookbooks/fakeB"
+      """ 
+
+   * I successfully run `berks install`
+   * the output should contain "Using fakeA (1.0.1)"
+   * the output should contain "Using fakeB (1.0.1)"

data/features/step_definitions/remote_steps.rb

@@ -0,0 +1,58 @@
+Given /^a remote mercurial cookbook named "(\w+)"$/ do |name|
+  path = File.join(tmp_path, 'hg-cookbooks', name)
+  FileUtils.mkdir_p(path)
+
+  Dir.chdir(path) do
+    hg('init')
+    write_metadata(name, '1.0.0')
+    hg('add')
+    hg_commit('Initial commit')
+  end
+end
+
+
+
+Given /^a remote mercurial cookbook named "(\w+)" with a branch named "(\w+)"$/ do |name, branch|
+  path = File.join(tmp_path, 'hg-cookbooks', name)
+  steps %Q|Given a remote mercurial cookbook named "#{name}"|
+
+  Dir.chdir(path) do
+    hg("branch #{branch}")
+    write_metadata(name, '2.3.4')
+    hg('add')
+    hg_commit('More changes')
+  end
+end
+
+
+Given(/^a remote mercurial repo with two cookbooks named "(.*?)" and "(.*?)"$/) do |name1, name2|
+  project_path = File.join(tmp_path, 'hg-cookbooks')
+  [name1,name2].each do |name|
+    cookbook_path = File.join(project_path,'site-cookbooks',name)
+    FileUtils.mkdir_p(cookbook_path)
+    write_metadata(name, '1.0.1',cookbook_path)
+  end
+  Dir.chdir(project_path) do 
+    hg("init")
+    hg('add')
+    hg_commit('adding_cookbooks')
+  end
+
+end
+
+def write_metadata(name,version,path="./") 
+  File.open(File.join(path,"metadata.rb"), "w") do |f|
+      f.write <<-EOH
+        name '#{name}'
+        version '#{version}'
+      EOH
+  end
+end
+
+def hg(command)
+  %x|hg #{command}|
+end
+
+def hg_commit(message)
+  hg %|--config ui.username=Berkshelf commit --message "#{message}"|
+end

data/features/support/env.rb

@@ -0,0 +1,16 @@
+require 'aruba/cucumber'
+require 'aruba/in_process'
+require 'berkshelf'
+
+Before do
+  Aruba::InProcess.main_class = Berkshelf::Cli::Runner
+  Aruba.process = Aruba::InProcess
+
+  @aruba_timeout_seconds = 30
+
+  ENV['BERKSHELF_PATH'] = tmp_path
+end
+
+def tmp_path
+  File.expand_path('tmp/aruba')
+end

data/lib/berkshelf/hg.rb

@@ -0,0 +1,5 @@
+require 'berkshelf/hg/version'
+
+module Berkshelf
+  autoload :HgLocation, 'berkshelf/locations/hg'
+end

data/lib/berkshelf/hg/version.rb

@@ -0,0 +1,5 @@
+module Berkshelf
+  module Hg
+    VERSION = '0.1.0'
+  end
+end

data/lib/berkshelf/locations/hg.rb

@@ -0,0 +1,197 @@
+require 'buff/shell_out'
+require 'digest/sha1'
+require 'pathname'
+require 'berkshelf'
+
+module Berkshelf
+  class HgLocation < BaseLocation
+    class HgError < BerkshelfError; status_code(500); end
+
+    class HgNotInstalled < HgError
+      def initialize
+        super 'You need to install Mercurial before you can download ' \
+          'cookbooks from hg repositories. For more information, please ' \
+          'see the Mercurial docs: http://mercurial.selenic.com/wiki/Download.'
+      end
+    end
+
+    class HgCommandError < HgError
+      def initialize(command, response, path = nil)
+        super "Hg error: command `hg #{command}` failed. If this error " \
+          "persists, try removing the cache directory at `#{path}'." \
+          "\nstdout:#{response.stdout}\nstderr:#{response.stderr}"
+      end
+    end
+
+    attr_reader :uri
+    attr_reader :branch
+    attr_reader :tag
+    attr_reader :ref
+
+    attr_reader :rel
+    attr_reader :revision
+
+    def initialize(dependency, options = {})
+      super
+
+      @uri      = options[:hg]
+      @branch   = options[:branch]
+      @tag      = options[:tag]
+      @ref      = options[:ref] || options[:branch] || options[:tag] || 'default'
+      @revision = options[:revision]
+      @rel      = options[:rel]
+    end
+
+    def cached_cookbook
+      if installed?
+        @cached_cookbook ||= CachedCookbook.from_path(install_path)
+      else
+        nil
+      end
+    end
+    
+    # Download the cookbook from the remote hg repository
+    #
+    # @return void
+    def install
+      if cached?
+        # Update and checkout the correct ref
+        Dir.chdir(cache_path) do
+          hg %|pull|
+        end
+      else
+        # Ensure the cache directory is present before doing anything
+        FileUtils.mkdir_p(cache_path)
+
+        Dir.chdir(cache_path) do
+          hg %|clone #{uri} .|
+        end
+      end
+
+      Dir.chdir(cache_path) do
+        hg %|update --clean --rev #{revision || ref}|
+        @revision ||= hg %|id -i|
+      end
+
+      # Gab the path where we should copy from (since it might be relative to
+      # the root).
+      copy_path = rel ? cache_path.join(rel) : cache_path
+
+      begin 
+        # Validate the thing we are copying is a Chef cookbook
+        validate_cached!(copy_path)
+
+        # Remove the current cookbook at this location (this is required or else
+        # FileUtils will copy into a subdirectory in the next step)
+        FileUtils.rm_rf(install_path)
+
+        # Create the containing parent directory
+        FileUtils.mkdir_p(install_path.parent)
+
+        # Copy whatever is in the current cache over to the store
+        FileUtils.cp_r(copy_path, install_path)
+
+      ensure
+
+        # Remove the .hg directory to save storage space
+        # TODO this can have huge performance implications, 
+        # make it a config option?
+        if (hg_path = install_path.join('.hg')).exist?
+          FileUtils.rm_r(hg_path)
+        end
+
+       FileUtils.rm_rf (copy_path)
+      end
+    end
+
+    def scm_location?
+      true
+    end
+
+    def ==(other)
+      other.is_a?(HgLocation) &&
+      other.uri == uri &&
+      other.branch == branch &&
+      other.tag == tag &&
+      other.ref == ref &&
+      other.rel == rel
+    end
+
+    def to_s
+      info = tag || branch || ref[0...7]
+
+      if rel
+        "#{uri} (at #{info}/#{rel})"
+      else
+        "#{uri} (at #{info})"
+      end
+    end
+
+    def to_lock
+      out =  "    hg: #{uri}\n"
+      out << "    revision: #{revision}\n"
+      out << "    branch: #{branch}\n" if branch
+      out << "    tag: #{tag}\n"       if tag
+      out << "    rel: #{rel}\n"       if rel
+      out
+    end
+
+    # Determine if this revision is installed.
+    #
+    # @return [Boolean]
+    def installed?
+      revision && install_path.exist?
+    end
+
+    private
+
+    # Perform a mercurial command.
+    #
+    # @param [String] command
+    #   the command to run
+    # @param [Boolean] error
+    #   whether to raise error if the command fails
+    #
+    # @raise [String]
+    #   the +$stdout+ from the command
+    def hg(command, error = true)
+      unless Berkshelf.which('hg') || Berkshelf.which('hg.exe')
+        raise HgNotInstalled.new
+      end
+
+      Berkshelf.log.debug("Running:hg #{command}")
+      response = Buff::ShellOut.shell_out(%|hg #{command}|)
+      Berkshelf.log.debug("response:hg #{response.stdout}")
+
+      if error && !response.success?
+        raise HgCommandError.new(command, response, cache_path)
+      end
+
+      response.stdout.strip
+    end
+
+    # Determine if this hg repo has already been downloaded.
+    #
+    # @return [Boolean]
+    def cached?
+      cache_path.exist?
+    end
+
+    # The path where this cookbook would live in the store, if it were
+    # installed.
+    #
+    # @return [Pathname, nil]
+    def install_path
+      Berkshelf.cookbook_store.storage_path
+        .join("#{dependency.name}-#{revision}")
+    end
+
+    # The path where this hg repository is cached.
+    #
+    # @return [Pathname]
+    def cache_path
+      Pathname.new(Berkshelf.berkshelf_path)
+        .join('.cache', 'hg', Digest::SHA1.hexdigest(uri))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,13 @@
+require 'berkshelf/hg'
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = 'random'
+end

data/spec/unit/locations/hg_spec.rb

@@ -0,0 +1,204 @@
+require 'spec_helper'
+
+module Berkshelf
+  describe HgLocation do
+    let(:dependency) { double(name: 'bacon') }
+
+    subject do
+      described_class.new(dependency, hg: 'https://repo.com', branch: 'ham',
+        tag: 'v1.2.3', ref: 'abc123', revision: 'defjkl123456', rel: 'hi')
+    end
+
+    describe '.initialize' do
+      it 'sets the uri' do
+        instance = described_class.new(dependency, hg: 'https://repo.com')
+        expect(instance.uri).to eq('https://repo.com')
+      end
+
+      it 'sets the branch' do
+        instance = described_class.new(dependency,
+          hg: 'https://repo.com', branch: 'magic_new_feature')
+        expect(instance.branch).to eq('magic_new_feature')
+      end
+
+      it 'sets the tag' do
+        instance = described_class.new(dependency,
+          hg: 'https://repo.com', tag: 'v1.2.3')
+        expect(instance.tag).to eq('v1.2.3')
+      end
+
+      context 'ref' do
+        it 'uses the :ref option with priority' do
+          instance = described_class.new(dependency,
+            hg: 'https://repo.com', ref: 'abc123', branch: 'magic_new_feature')
+          expect(instance.ref).to eq('abc123')
+        end
+
+        it 'uses the :branch option with priority' do
+          instance = described_class.new(dependency,
+            hg: 'https://repo.com', branch: 'magic_new_feature', tag: 'v1.2.3')
+          expect(instance.ref).to eq('magic_new_feature')
+        end
+
+        it 'uses the :tag option' do
+          instance = described_class.new(dependency,
+            hg: 'https://repo.com', tag: 'v1.2.3')
+          expect(instance.ref).to eq('v1.2.3')
+        end
+
+        it 'uses "default" when none is given' do
+          instance = described_class.new(dependency, hg: 'https://repo.com')
+          expect(instance.ref).to eq('default')
+        end
+      end
+
+      it 'sets the revision' do
+        instance = described_class.new(dependency,
+          hg: 'https://repo.com', revision: 'abcde12345')
+        expect(instance.revision).to eq('abcde12345')
+      end
+
+      it 'sets the rel' do
+        instance = described_class.new(dependency,
+          hg: 'https://repo.com', rel: 'internal/path')
+        expect(instance.rel).to eq('internal/path')
+      end
+    end
+
+    describe '#install' do
+      before do
+        CachedCookbook.stub(:from_store_path)
+        FileUtils.stub(:cp_r)
+        subject.stub(:validate_cached!)
+        subject.stub(:validate_cookbook!)
+        subject.stub(:hg)
+      end
+
+      context 'when the repository is cached' do
+        it 'pulls a new version' do
+          Dir.stub(:chdir) { |args, &b| b.call } # Force eval the chdir block
+          subject.stub(:cached?).and_return(true)
+          expect(subject).to receive(:hg).with('pull')
+          subject.install
+        end
+      end
+
+      context 'when the revision is not cached' do
+        it 'clones the repository' do
+          subject.stub(:cached?).and_return(false)
+          expect(subject).to receive(:hg).with('update --clean --rev defjkl123456')
+          subject.install
+        end
+      end
+    end
+
+    describe '#scm_location?' do
+      it 'returns true' do
+        instance = described_class.new(dependency, hg: 'https://repo.com')
+        expect(instance).to be_scm_location
+      end
+    end
+
+    describe '#==' do
+      let(:other) { subject.dup }
+
+      it 'returns true when everything matches' do
+        expect(subject).to eq(other)
+      end
+
+      it 'returns false when the other location is not an HgLocation' do
+        other.stub(:is_a?).and_return(false)
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the uri is different' do
+        other.stub(:uri).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the branch is different' do
+        other.stub(:branch).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the tag is different' do
+        other.stub(:tag).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the ref is different' do
+        other.stub(:ref).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+
+      it 'returns false when the rel is different' do
+        other.stub(:rel).and_return('different')
+        expect(subject).to_not eq(other)
+      end
+    end
+
+    describe '#to_s' do
+      it 'prefers the tag' do
+        expect(subject.to_s).to eq('https://repo.com (at v1.2.3/hi)')
+      end
+
+      it 'prefers the branch' do
+        subject.stub(:tag).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at ham/hi)')
+      end
+
+      it 'falls back to the ref' do
+        subject.stub(:tag).and_return(nil)
+        subject.stub(:branch).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at abc123/hi)')
+      end
+
+      it 'does not use the rel if missing' do
+        subject.stub(:rel).and_return(nil)
+        expect(subject.to_s).to eq('https://repo.com (at v1.2.3)')
+      end
+    end
+
+    describe '#to_lock' do
+      it 'includes all the information' do
+        expect(subject.to_lock).to eq <<-EOH.gsub(/^ {8}/, '')
+            hg: https://repo.com
+            revision: defjkl123456
+            branch: ham
+            tag: v1.2.3
+            rel: hi
+        EOH
+      end
+
+      it 'does not include the branch if missing' do
+        subject.stub(:branch).and_return(nil)
+        expect(subject.to_lock).to_not include('branch')
+      end
+
+      it 'does not include the tag if missing' do
+        subject.stub(:tag).and_return(nil)
+        expect(subject.to_lock).to_not include('tag')
+      end
+
+      it 'does not include the rel if missing' do
+        subject.stub(:rel).and_return(nil)
+        expect(subject.to_lock).to_not include('rel')
+      end
+    end
+
+    describe '#hg' do
+      before { described_class.send(:public, :hg) }
+
+      it 'raises an error if Mercurial is not installed' do
+        Berkshelf.stub(:which).and_return(false)
+        expect { subject.hg('foo') }.to raise_error(HgLocation::HgNotInstalled)
+      end
+
+      it 'raises an error if the command fails' do
+        subject.stub(:`)
+        $?.stub(:success?).and_return(false)
+        expect { subject.hg('foo') }.to raise_error(HgLocation::HgCommandError)
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: berkshelf-hg
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Seth Vargo
+- Manuel Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-07-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: berkshelf
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: aruba
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.5'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Berkshelf plugin that adds support for downloading Chef cookbooks from
+  Mercurial (hg) locations.
+email:
+- sethvargo@gmail.com
+- ryan@shamu.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- berkshelf-hg.gemspec
+- features/hg.feature
+- features/step_definitions/remote_steps.rb
+- features/support/env.rb
+- lib/berkshelf/hg.rb
+- lib/berkshelf/hg/version.rb
+- lib/berkshelf/locations/hg.rb
+- spec/spec_helper.rb
+- spec/unit/locations/hg_spec.rb
+homepage: https://github.com/berkshelf/berkshelf-hg
+licenses:
+- Apache 2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Mercurial (hg) support for Berkshelf
+test_files:
+- features/hg.feature
+- features/step_definitions/remote_steps.rb
+- features/support/env.rb
+- spec/spec_helper.rb
+- spec/unit/locations/hg_spec.rb