berkshelf 0.1.5 → 0.2.0

data/README.md

@@ -0,0 +1,43 @@
+# Berkshelf
+
+Manage a Cookbook or an Application's Cookbook dependencies
+
+## Installation
+
+    $ gem install berkshelf
+
+## Usage
+
+See [berkshelf.com](http://berkshelf.com) for up-to-date usage instructions.
+
+# Contributing
+
+## Running tests
+
+### Install prerequisites
+
+Install the latest version of {Bundler}[http://gembundler.com]
+
+    $ gem install bundler
+
+Clone the project
+
+    $ git clone git://github.com/RiotGames/berkshelf.git
+
+and run:
+
+    $ cd berkshelf
+    $ bundle install
+
+Bundler will install all gems and their dependencies required for testing and developing. 
+
+### Running unit (RSpec) and acceptance (Cucumber) tests
+
+    $ bundle exec guard start
+
+# Authors and Contributors
+
+* Josiah Kiehl (<josiah@skirmisher.net>)
+* Jamie Winsor (<jamie@vialstudios.com>)
+* Erik Hollensbe (<erik@hollensbe.org>)
+* Michael Ivey (<ivey@gweezlebur.com>)

data/berkshelf.gemspec

@@ -21,6 +21,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'minitar'
   s.add_runtime_dependency 'thor',            '~> 0.15.2'
 
+  s.add_development_dependency 'redcarpet'
   s.add_development_dependency 'cucumber'
   s.add_development_dependency 'vcr'
   s.add_development_dependency 'webmock'

data/features/install.feature

@@ -53,3 +53,20 @@ Feature: install cookbooks from a Berksfile
       Cookbook 'doesntexist' not found at site: 'http://cookbooks.opscode.com/api/v1/cookbooks'
       """
     And the CLI should exit with the status code for error "DownloadFailure"
+
+  @wip
+  Scenario: running install command with the --shims flag to create a directory of shims
+    Given I write to "Berksfile" with:
+      """
+      cookbook "mysql", "1.2.4"
+      """
+    When I run the install command with flags:
+      | --shims |
+    Then the following directories should exist:
+      | cookbooks       |
+      | cookbooks/mysql |
+    And the output should contain:
+      """
+      Shims written to: 
+      """
+    And the exit status should be 0

data/features/step_definitions/cli_steps.rb

@@ -39,7 +39,11 @@ When /^I run the init command with no value for the target$/ do
 end
 
 When /^I run the install command$/ do
-  run_simple(unescape("knife berks install"), false)
+  run_simple(unescape("knife berks install"), true)
+end
+
+When /^I run the install command with flags:$/ do |flags|
+  run_simple(unescape("knife berks install #{flags.raw.join(" ")}"), true)
 end
 
 When /^I run the update command$/ do

data/lib/berkshelf/berksfile.rb

@@ -119,9 +119,16 @@ module Berkshelf
     # @option options [Symbol, Array] :without 
     #   Group(s) to exclude which will cause any sources marked as a member of the 
     #   group to not be installed
+    # @option options [String, Pathname] :shims
+    #   Path to a directory of shims each pointing to a Cookbook Version that is
+    #   part of the dependency solution. Each shim is a hard link on disk.
     def install(options = {})
       resolver = Resolver.new(Berkshelf.downloader, sources(exclude: options[:without]))
-      resolver.resolve
+      solution = resolver.resolve
+      if options[:shims]
+        write_shims(options[:shims], solution)
+        Berkshelf.ui.info "Shims written to: '#{options[:shims]}'"
+      end
       write_lockfile(resolver.sources) unless lockfile_present?
     end
 
@@ -152,6 +159,26 @@ module Berkshelf
       end
     end
 
+    # Write a collection of hard links to the given path representing the given
+    # CachedCookbooks. Useful for getting Cookbooks in a single location for 
+    # consumption by Vagrant, or another tool that expect this structure.
+    #
+    # @example 
+    #   Given the path: '/Users/reset/code/pvpnet/cookbooks'
+    #   And a CachedCookbook: 'nginx' verison '0.100.5' at '/Users/reset/.berkshelf/nginx-0.100.5'
+    #
+    #   A hardlink will be created at: '/Users/reset/code/pvpnet/cookbooks/nginx'
+    #
+    # @param [Pathname, String] path
+    # @param [Array<Berkshelf::CachedCookbook>] cached_cookbooks
+    def write_shims(path, cached_cookbooks)
+      FileUtils.mkdir_p(path)
+      cached_cookbooks.each do |cached_cookbook|
+        destination = File.join(path, cached_cookbook.cookbook_name)
+        FileUtils.ln_r(cached_cookbook.path, destination, force: true)
+      end
+    end
+
     private
 
       def lockfile_present?

data/lib/berkshelf/cookbook_source/git_location.rb

@@ -40,7 +40,7 @@ module Berkshelf
 
       def to_s
         s = "git: '#{uri}'"
-        s << " with branch '#{branch}" if branch
+        s << " with branch '#{branch}'" if branch
         s
       end
 

data/lib/berkshelf/core_ext/fileutils.rb

@@ -0,0 +1,80 @@
+module FileUtils
+  # @note taken from proposed FileUtils feature:
+  # @note {http://redmine.ruby-lang.org/issues/show/4189}
+  # @note {https://github.com/ruby/ruby/pull/4}
+  #
+  # Options: noop verbose dereference_root force
+  #
+  # Hard link +src+ to +dest+. If +src+ is a directory, this method links
+  # all its contents recursively. If +dest+ is a directory, links
+  # +src+ to +dest/src+.
+  #
+  # +src+ can be a list of files.
+  #
+  #   # Installing ruby library "mylib" under the site_ruby
+  #   FileUtils.rm_r site_ruby + '/mylib', :force
+  #   FileUtils.ln_r 'lib/', site_ruby + '/mylib'
+  #
+  #   # Examples of copying several files to target directory.
+  #   FileUtils.ln_r %w(mail.rb field.rb debug/), site_ruby + '/tmail'
+  #   FileUtils.ln_r Dir.glob('*.rb'), '/home/aamine/lib/ruby', :noop => true, :verbose => true
+  #
+  #   # If you want to copy all contents of a directory instead of the
+  #   # directory itself, c.f. src/x -> dest/x, src/y -> dest/y,
+  #   # use following code.
+  #   FileUtils.ln_r 'src/.', 'dest'     # cp_r('src', 'dest') makes src/dest,
+  #                                      # but this doesn't.
+  def ln_r(src, dest, options = {})
+    fu_check_options options, OPT_TABLE['ln_r']
+    fu_output_message "ln -r#{options[:force] ? ' --remove-destination' : ''} #{[src,dest].flatten.join ' '}" if options[:verbose]
+    return if options[:noop]
+    options = options.dup
+    options[:dereference_root] = true unless options.key?(:dereference_root)
+    fu_each_src_dest(src, dest) do |s, d|
+      link_entry s, d, options[:dereference_root], options[:force]
+    end
+  end
+  module_function :ln_r
+
+  OPT_TABLE['ln_r'] = [:noop, :verbose, :dereference_root, :force]
+
+  #
+  # Hard links a file system entry +src+ to +dest+.
+  # If +src+ is a directory, this method links its contents recursively.
+  #
+  # Both of +src+ and +dest+ must be a path name.
+  # +src+ must exist, +dest+ must not exist.
+  #
+  # If +dereference_root+ is true, this method dereference tree root.
+  #
+  # If +force+ is true, this method removes each destination file before copy.
+  #
+  def link_entry(src, dest, dereference_root = false, force = false)
+    Entry_.new(src, nil, dereference_root).traverse do |ent|
+      destent = Entry_.new(dest, ent.rel, false)
+      File.unlink destent.path if force && File.file?(destent.path)
+      ent.link destent.path
+    end
+  end
+  module_function :link_entry
+
+  private
+
+    class Entry_ #:nodoc:
+      def link(dest)
+        case
+        when directory?
+          if !File.exist?(dest) and descendant_diretory?(dest, path)
+            raise ArgumentError, "cannot link directory %s to itself %s" % [path, dest]
+          end
+          begin
+            Dir.mkdir dest
+          rescue
+            raise unless File.directory?(dest)
+          end
+        else
+          File.link path(), dest
+        end
+      end
+    end
+end

data/lib/berkshelf/thor.rb

@@ -22,7 +22,7 @@ module Berkshelf
       type: :boolean,
       desc: "Freeze the uploaded cookbooks so that they cannot be overwritten.",
       default: false
-    desc "upload", "shit"
+    desc "upload", "Upload the sources defined in your Berksfile and their dependencies to a Chef Server."
     def upload
       begin
         Chef::Config.from_file(File.expand_path(options[:config]))

data/lib/berkshelf/version.rb

@@ -1,3 +1,3 @@
 module Berkshelf
-  VERSION = "0.1.5"
+  VERSION = "0.2.0"
 end

data/lib/chef/knife/berks_install.rb

@@ -8,20 +8,35 @@ module Berkshelf
     
     banner "knife berks install (options)"
 
+    option :shims,
+      short: "-s",
+      long: "--shims",
+      description: "Create a directory of shims pointing to Cookbook Versions.",
+      boolean: true
     option :without,
-      :short => "-W WITHOUT",
-      :long => "--without WITHOUT",
-      :description => "Exclude cookbooks that are in these groups",
-      :proc => lambda { |w| w.split(",") },
-      :default => Array.new
-
+      short: "-W WITHOUT",
+      long: "--without WITHOUT",
+      description: "Exclude cookbooks that are in these groups",
+      proc: lambda { |w| w.split(",") },
+      default: Array.new
     def run
       ::Berkshelf.ui = ui
+      # JW TODO: replace knife with Thor bin. Opt parsing here isn't my favorite.
+      if config[:shims]
+        config[:shims] = shims_path
+      end
+
       cookbook_file = ::Berkshelf::Berksfile.from_file(File.join(Dir.pwd, Berkshelf::DEFAULT_FILENAME))
       cookbook_file.install(config)
     rescue BerkshelfError => e
       Berkshelf.ui.fatal e
       exit e.status_code
     end
+
+    private
+
+      def shims_path
+        File.join(Dir.pwd, "cookbooks")
+      end
   end
 end

data/spec/unit/berkshelf/{cookbookfile_spec.rb → berksfile_spec.rb}

@@ -155,6 +155,44 @@ EOF
           subject.install
         end
       end
+
+      context "when given a value for :shims pointing to a valid path"do
+        let(:cached_one) { double('cached_one', cookbook_name: 'nginx', path: fixtures_path.join("cookbooks", "nginx-0.100.5")) }
+        let(:cached_two) { double('cached_two', cookbook_name: 'example_cookbook', path: fixtures_path.join("cookbooks", "example_cookbook-0.5.0")) }
+        let(:shims_path) { tmp_path.join("cookbook_shims") }
+
+        before(:each) do
+          resolver.stub(:resolve).and_return([cached_one, cached_two])
+        end
+
+        it "sends a message to write_shims with the given directory and the resolver's solution" do
+          subject.should_receive(:write_shims).with(shims_path, [cached_one, cached_two])
+          subject.install(shims: shims_path)
+        end
+      end
+    end
+
+    describe "#write_shims" do
+      let(:cached_one) { double('cached_one', cookbook_name: 'nginx', path: fixtures_path.join("cookbooks", "nginx-0.100.5")) }
+      let(:cached_two) { double('cached_two', cookbook_name: 'example_cookbook', path: fixtures_path.join("cookbooks", "example_cookbook-0.5.0")) }
+      let(:shims_path) { tmp_path.join("cookbook_shims") }
+
+      before(:each) { subject.write_shims(shims_path, [cached_one, cached_two]) }
+
+      it "writes a directory at the given path" do
+        shims_path.should exist
+        shims_path.should be_directory
+      end
+
+      it "writes a symlink of the name of each source within the given directory" do
+        linked_path_one = shims_path.join(cached_one.cookbook_name)
+        linked_path_two = shims_path.join(cached_two.cookbook_name)
+        
+        linked_path_one.should exist
+        linked_path_one.should be_cookbook
+        linked_path_two.should exist
+        linked_path_two.should be_cookbook
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: berkshelf
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-23 00:00:00.000000000 Z
+date: 2012-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dep_selector
@@ -78,6 +78,22 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: 0.15.2
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: cucumber
   requirement: !ruby/object:Gem::Requirement
@@ -333,7 +349,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENSE
-- README.rdoc
+- README.md
 - Thorfile
 - berkshelf.gemspec
 - features/config.sample.yml
@@ -358,6 +374,7 @@ files:
 - lib/berkshelf/cookbook_store.rb
 - lib/berkshelf/core_ext.rb
 - lib/berkshelf/core_ext/file.rb
+- lib/berkshelf/core_ext/fileutils.rb
 - lib/berkshelf/core_ext/kernel.rb
 - lib/berkshelf/core_ext/pathname.rb
 - lib/berkshelf/downloader.rb
@@ -405,13 +422,13 @@ files:
 - spec/support/chef_api.rb
 - spec/support/matchers/file_system_matchers.rb
 - spec/support/matchers/filepath_matchers.rb
+- spec/unit/berkshelf/berksfile_spec.rb
 - spec/unit/berkshelf/cached_cookbook_spec.rb
 - spec/unit/berkshelf/cookbook_source/git_location_spec.rb
 - spec/unit/berkshelf/cookbook_source/path_location_spec.rb
 - spec/unit/berkshelf/cookbook_source/site_location_spec.rb
 - spec/unit/berkshelf/cookbook_source_spec.rb
 - spec/unit/berkshelf/cookbook_store_spec.rb
-- spec/unit/berkshelf/cookbookfile_spec.rb
 - spec/unit/berkshelf/downloader_spec.rb
 - spec/unit/berkshelf/dsl_spec.rb
 - spec/unit/berkshelf/git_spec.rb
@@ -442,7 +459,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4586386475461844469
+      hash: -3927630543327707547
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -489,13 +506,13 @@ test_files:
 - spec/support/chef_api.rb
 - spec/support/matchers/file_system_matchers.rb
 - spec/support/matchers/filepath_matchers.rb
+- spec/unit/berkshelf/berksfile_spec.rb
 - spec/unit/berkshelf/cached_cookbook_spec.rb
 - spec/unit/berkshelf/cookbook_source/git_location_spec.rb
 - spec/unit/berkshelf/cookbook_source/path_location_spec.rb
 - spec/unit/berkshelf/cookbook_source/site_location_spec.rb
 - spec/unit/berkshelf/cookbook_source_spec.rb
 - spec/unit/berkshelf/cookbook_store_spec.rb
-- spec/unit/berkshelf/cookbookfile_spec.rb
 - spec/unit/berkshelf/downloader_spec.rb
 - spec/unit/berkshelf/dsl_spec.rb
 - spec/unit/berkshelf/git_spec.rb

data/README.rdoc

@@ -1,102 +0,0 @@
-= Berkshelf
-
-Manages a Cookbook's, or an Application's, Cookbook dependencies
-
-== Getting Started
-
-=== Install
-
-    $ gem install berkshelf
-
-=== Use
-
-==== Berksfile
-
-Dependencies are managed via a `Berksfile` in the directory where you want the cookbooks to be installed.  The Berksfile, like Bundler's Gemfile, contains which cookbooks are needed and, optionally, where to find them:
-
-    cookbook 'memcached'
-    cookbook 'nginx'
-    cookbook 'my_app', path: '/path/to/cookbook'
-    cookbook 'mysql', git: 'git://github.com/opscode-cookbooks/mysql.git'
-
-==== CLI
-
-The CLI consists of 2 commands: install, update
-
-    $ knife berks (install|update) [(--without|-W) group_to_exclude]
-
-[install]  Installs the from the Berksfile.lock, or Berksfile if the the lockfile does not exist.
-
-[update] Skips the lockfile and installs fresh
-
-[init] Prepares a local path to have it's Cookbook dependencies managed by Berkshelf. If the target path is a Cookbook itself, additional Berkshelf support files will be generated to get you started.
-
-== The Berksfile
-
-Cookbooks are defined as dependencies by declaring them in the `Berksfile`
-
-    cookbook 'nginx'
-
-Cookbooks without additional options are assumed to come from the Opscode Community site at the latest available version: http://community.opscode.com/cookbooks
-
-Options available include:
-
-version constraint
-
-    cookbook "nginx", "= 0.101.2"    # precisely 0.101.2
-    cookbook "mysql", "< 1.2.4"      # less than and not including 1.2.4
-    cookbook "openssl", "~> 1.0.0"   # greater than 1.0.0, and up to but not including 1.1.0
-
-git
-
-    # ref can be a branch name, tag, or commit hash. If ref is not provided, HEAD is used.
-    cookbook "mysql", git: "https://github.com/opscode-cookbooks/mysql.git", ref: "<any git ref>" 
-
-path
-
-    # knife berks will look in /path/to/location/of/my_application for the cookbook
-    cookbook "my_application", path: "/path/to/location/of"
-
-=== Groups
-
-Groups can be defined via blocks or inline as an option:
-
-    group :solo do
-      cookbook 'base'
-    end
-    
-    cookbook 'base', :group => 'solo'
-
-When using install or update, groups can be excluded with the --without GROUP_NAME or -W GROUP_NAME flags.
-
-= Contributing
-
-== Running tests
-
-=== Install prerequisites
-
-Install the latest version of {Bundler}[http://gembundler.com]
-
-    $ gem install bundler
-
-Clone the project
-
-    $ git clone git://github.com/RiotGames/berkshelf.git
-
-and run:
-
-    $ cd berkshelf
-    $ bundle install
-
-Bundler will install all gems and their dependencies required for testing and developing. 
-
-=== Running unit (RSpec) and acceptance (Cucumber) tests
-
-    $ bundle exec guard start
-
-= Authors and Contributors
-
-* Josiah Kiehl (<josiah@skirmisher.net>)
-* Jamie Winsor (<jamie@vialstudios.com>)
-* Erik Hollensbe (<erik@hollensbe.org>)
-* Michael Ivey (<ivey@gweezlebur.com>)