vendorificator 0.3.0 → 0.4.0

data/features/git.feature

@@ -11,6 +11,7 @@ Scenario: Vendorificating a git repo
     | Version   | 10e9ac58c77bc229d8c59a5b4eb7422916453148 |
     | With file | test/alias.c                             |
   And there's a git log message including "at revision 10e9ac58c77bc229d8c59a5b4eb7422916453148"
+  And there's a git commit note including "10e9ac" in "git_revision"
 
 Scenario: Vendorificating a subdirectory from a git repo
   Given a repository with following Vendorfile:
@@ -38,8 +39,8 @@ Scenario: Vendorificating a certain branch from a git repo
     | Version       | ecbfa229ba5f11c05b18bcc4f7c32b8f25d63f8c |
     | With file     | README.md                                |
   And there's a git log message including "at revision ecbfa229ba5f11c05b18bcc4f7c32b8f25d63f8c"
+  And there's a git commit note including "ecbfa2" in "git_revision"
 
-@wip
 Scenario: Vendorificating a certain tag from a git repo
   Given a repository with following Vendorfile:
     """ruby
@@ -51,8 +52,9 @@ Scenario: Vendorificating a certain tag from a git repo
     | Name         | testrepo     |
     | Version      | email-v0     |
     | Without file | README.md    |
-    | With file    | test/alias.c | 
+    | With file    | test/alias.c |
   And there's a git log message including "at revision f81247bde4ef7a1c7d280140cc0bcf0b8221a51f"
+  And there's a git commit note including "f81247" in "git_revision"
 
 Scenario: Vendorificating a certain revision from a git repo
   Given a repository with following Vendorfile:
@@ -67,3 +69,4 @@ Scenario: Vendorificating a certain revision from a git repo
     | With file     | alias.c                                  |
     | Without file  | test/alias.c                             |
   And there's a git log message including "at revision 6ff1be9c3819c93a2f41e0ddc09f252fcf154f34"
+  And there's a git commit note including "6ff1be" in "git_revision"

data/features/step_definitions/aruba_ext.rb

@@ -1,3 +1,4 @@
+
 Then /^the last output should match (#{PATTERN})$/ do |expected|
   assert { last_output =~ expected }
 end

data/features/step_definitions/basic.rb

@@ -30,6 +30,13 @@ Given /^a remote repository$/ do
   run_simple 'git remote add origin ../remote-repository'
 end
 
+When /(?:I have following Gemfile|I change Gemfile to|following Gemfile):$/ do |gemfile_contents|
+  write_file('Gemfile', gemfile_contents)
+  run_simple(without_bundler('bundle'))
+  run_simple 'git add Gemfile Gemfile.lock'
+  run_simple 'git commit -m bundle'
+end
+
 When /^I change Vendorfile to:$/ do |vendorfile_contents|
   write_file('Vendorfile', vendorfile_contents)
   run_simple 'git commit -m "Updated Vendorfile" Vendorfile'

data/features/step_definitions/git.rb

@@ -38,10 +38,19 @@ Then /^tag matching (#{PATTERN}) does not exist$/ do |pat|
   deny { git.tags.any? { |t| t =~ pat } }
 end
 
-Then(/^there's a git log message including "(.*?)"$/) do |message|
+Then /^there's a git log message including "(.*?)"$/ do |message|
   assert { git.log.lines.any? { |ln| ln.include?(message) } }
 end
 
+Then /^there's a git commit note including "(.*?)" in "(.*?)"$/ do |value, key|
+  # Not in the assert block, because it raises an exception on failure.
+  contains_note = git.notes({:ref => 'vendor'}, 'list').lines.any? do |line|
+    note = YAML.load git.show(line.split[0])
+    (note[key] || note[key.to_sym]).to_s.include? value
+  end
+  assert { contains_note == true }
+end
+
 Then /^branch "(.*?)" exists in the remote repo$/ do |branch_name|
   assert { remote_git.heads.include?(branch_name) }
 end
@@ -49,3 +58,7 @@ end
 Then /^tag "(.*?)" exists in the remote repo$/ do |tag_name|
   assert { remote_git.tags.include?(tag_name) }
 end
+
+Then /^notes ref "(.*?)" exists in the remote repo$/ do |ref_name|
+  assert { remote_git.note_refs.include?(ref_name) }
+end

data/features/step_definitions/vendorificator.rb

@@ -1,3 +1,7 @@
+def vendor_path_for(mod, path)
+  File.join('vendor', mod['Path'] || mod['Name'], path)
+end
+
 Then /^(?:the )?following has( not)? been conjured:$/ do |not_p, table|
   exists_p = not_p ? "does not exist" : "exists"
 
@@ -14,12 +18,12 @@ Then /^(?:the )?following has( not)? been conjured:$/ do |not_p, table|
 
     if mod['With file']
       check_file_presence(mod['With file'].lines.
-        map { |ln| File.join('vendor', mod['Name'], ln.strip) }, !not_p)
+        map { |ln| vendor_path_for(mod, ln.strip) }, !not_p)
     end
 
     if mod['Without file']
       check_file_presence(mod['Without file'].lines.
-          map { |ln| File.join('vendor', mod['Name'], ln.strip) }, !!not_p)
+          map { |ln| vendor_path_for(mod, ln.strip) }, !!not_p)
     end
   end
 end

data/features/support/aruba_ext.rb

@@ -1,3 +1,5 @@
+require 'shellwords'
+
 module Vendorificator
   module TestSupport
     module ArubaExt
@@ -16,6 +18,12 @@ module Vendorificator
       def last_output
         last_stdout + last_stderr
       end
+
+      def without_bundler(cmd)
+        cmd = %w[ RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE
+                ].map { |v| "unset #{v} ; " }.join << cmd
+        "sh -c #{Shellwords.escape(cmd)}"
+      end
     end
   end
 end

data/features/support/env.rb

@@ -5,6 +5,9 @@ require 'tmpdir'
 require 'aruba/cucumber'
 require 'wrong'
 
+ENV['GIT_AUTHOR_NAME'] = ENV['GIT_COMMITTER_NAME'] = 'Vendorificator Cucumber'
+ENV['GIT_AUTHOR_EMAIL'] = ENV['GIT_COMMITTER_EMAIL'] = 'nonexistent@example.com'
+
 World(Wrong)
 
 ENV['FIXTURES_DIR'] = Pathname.new(__FILE__).

data/features/support/minigit.rb

@@ -19,6 +19,12 @@ module Vendorificator
         def tags
           refs(:tags)
         end
+
+        def note_refs
+          show_ref.lines.
+            map { |ln| ln =~ /[0-9a-f]{40} refs\/notes\// and $'.strip }.
+            compact
+        end
       end
 
       def git

data/features/tarball.feature

@@ -36,6 +36,9 @@ Scenario: Version & checksum
     | Name      | testrepo     |
     | Version   | 0.1          |
     | With file | test/alias.c |
+  And there's a git commit note including "ea207a" in "archive_checksum"
+  And there's a git commit note including "20480" in "archive_filesize"
+  And there's a git commit note including "test-assets.3ofcoins" in "archive_url"
 
 Scenario: Wrong checksum
   Given a repository with following Vendorfile:

data/features/tool.feature

@@ -0,0 +1,67 @@
+Feature: use a tool to download stuff
+
+Background:
+  Given a repository with following Vendorfile:
+    """ruby
+    # Delete Bundler's variables
+    %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |var|
+      ENV.delete(var)
+    end
+
+    tool 'bundler',
+         :path => 'cache', # Hardcoded, meh
+         :specs => [ 'Gemfile', 'Gemfile.lock' ],
+         :command => 'bundle package --all'
+    """
+
+Scenario: Use Gem bundler to download rubygems, and Vendorificator to vendor them
+  Given I have following Gemfile:
+    """ruby
+    source "file://#{ENV['FIXTURES_DIR']}/rubygems"
+    gem "hello"
+    """
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | bundler         |
+    | Path         | cache           |
+    | With file    | hello-0.0.1.gem |
+    | Without file | first-0.gem     |
+
+Scenario: Bundler correctly downloads and caches dependencies
+  Given I have following Gemfile:
+    """ruby
+    source "file://#{ENV['FIXTURES_DIR']}/rubygems"
+    gem "first"
+    """
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | bundler         |
+    | Path         | cache           |
+    | Without file | hello-0.0.1.gem |
+    | With file    | first-0.gem     |
+    | With file    | second-0.gem    |
+
+Scenario: directory contents are completely replaced on re-vendoring
+  Given I have following Gemfile:
+    """ruby
+    source "file://#{ENV['FIXTURES_DIR']}/rubygems"
+    gem "hello"
+    """
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | bundler         |
+    | Path         | cache           |
+    | With file    | hello-0.0.1.gem |
+    | Without file | first-0.gem     |
+  When I change Gemfile to:
+    """ruby
+    source "file://#{ENV['FIXTURES_DIR']}/rubygems"
+    gem "first"
+    """
+  And I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | bundler         |
+    | Path         | cache           |
+    | Without file | hello-0.0.1.gem |
+    | With file    | first-0.gem     |
+    | With file    | second-0.gem    |

data/features/tool_shortcuts.feature

@@ -0,0 +1,42 @@
+Feature: `rubygems_bundler` and `chef_berkshelf` shortcuts for tools
+
+Scenario: rubygems_bundler
+  Given a repository with following Vendorfile:
+    """ruby
+    # Delete Bundler's variables
+    %w[RUBYOPT BUNDLE_PATH BUNDLE_BIN_PATH BUNDLE_GEMFILE].each do |var|
+      ENV.delete(var)
+    end
+    rubygems_bundler
+    """
+  And following Gemfile:
+    """ruby
+    source "file://#{ENV['FIXTURES_DIR']}/rubygems"
+    gem "hello"
+    """
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | rubygems        |
+    | Path         | cache           |
+    | With file    | hello-0.0.1.gem |
+    | Without file | first-0.gem     |
+
+@berkshelf
+Scenario: chef_berkshelf
+  Given a repository with following Vendorfile:
+    """ruby
+    chef_berkshelf
+    """
+  And a file named "Berksfile" with:
+    """ruby
+    site :opscode
+    cookbook 'build-essential'
+    """
+  And I successfully run `berks install`
+  And I successfully run `git add Berksfile Berksfile.lock`
+  And I successfully run `git commit -m Berksfile`
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | cookbooks                   |
+    | With file    | build-essential/metadata.rb  |
+

data/features/vendor.feature

@@ -3,7 +3,8 @@ Feature: bare 'vendor' clause
 Scenario:
   Given a repository with following Vendorfile:
     """ruby
-    vendor 'generated', :version => '0.23' do |v|
+    annotate 'foo', 'bar'
+    vendor 'generated', :version => '0.23', :annotate => 'by Przemo' do |v|
       File.open('README', 'w') { |f| f.puts "Hello, World!" }
       File.open('VERSION', 'w') { |f| f.puts v.version }
     end
@@ -14,3 +15,5 @@ Scenario:
     | Version   | 0.23      |
     | With file | README    |
   And the file "vendor/generated/VERSION" should contain "0.23"
+  And there's a git commit note including "bar" in "foo"
+  And there's a git commit note including "by Przemo" in "module_annotations"

data/lib/vendorificator/cli.rb

@@ -85,10 +85,15 @@ module Vendorificator
         end
 
         say_status( mod.status.to_s.gsub('_', ' '), status_line,
-                    ( mod.status==:up_to_date ? :green : :yellow ) )
+                    ( mod.status == :up_to_date ? :green : :yellow ) )
       end
     end
 
+    desc 'info MODULE', "Show module information"
+    def info(mod_name)
+      environment.info mod_name, options
+    end
+
     desc :pull, "Pull upstream branches from a remote repository"
     method_option :remote, :aliases => ['-r'], :default => nil
     method_option :dry_run, :aliases => ['-n'], :default => false, :type => :boolean
@@ -111,7 +116,7 @@ module Vendorificator
     long_desc <<EOF
   Run a git command for specified modules. Within GIT_ARGS arguments,
   you can use @MERGED@ and @PATH@ tags, which will be substituted with
-  mo#dule's most recently merged revision and full path of its work
+  module's most recently merged revision and full path of its work
   directory.
 
   The 'diff' and 'log' commands are simple aliases for 'git' command.

data/lib/vendorificator/commit.rb

@@ -0,0 +1,56 @@
+require 'yaml'
+
+module Vendorificator
+  class Commit
+    attr_reader :git, :rev
+
+    # Public: Initializes the object
+    #
+    # rev - The String containing revision expression for this commit.
+    # git - The MiniGit instance to use.
+    #
+    # Returns Commit object.
+    def initialize(rev, git)
+      @rev = rev
+      @git = git
+    end
+
+    # Public: Finds branches that contain this commit.
+    #
+    # Returns Array of branch names.
+    def branches
+      git.capturing.branch({:contains => true}, rev).split("\n").map do |name|
+        name.tr('*', '').strip
+      end
+    end
+
+    # Public: Checks if such a commit exists in the repository.
+    #
+    # Returns Boolean.
+    def exists?
+      git.capturing.rev_parse rev
+      true
+    rescue MiniGit::GitError
+      false
+    end
+
+    # Public: Returns vendorificator git notes for the commit.
+    #
+    # Returns the notes Hash.
+    def notes
+      YAML.load(git.capturing.notes({:ref => 'vendor'}, 'show', rev))
+    end
+
+    # Public: Returns vendorificator git notes for the commit if it exists.
+    #
+    # Returns the notes Hash or an empty one.
+    def notes?
+      if exists?
+        YAML.load(git.capturing.notes({:ref => 'vendor'}, 'show', rev))
+      else
+        {}
+      end
+    end
+
+  end
+end

data/lib/vendorificator/config.rb

@@ -3,6 +3,7 @@ require 'pathname'
 module Vendorificator
   class Config
     attr_accessor :environment
+    attr_reader :metadata
 
     @defaults = {}
     @modules = {}
@@ -34,6 +35,7 @@ module Vendorificator
 
     def initialize(params = {})
       @configuration = self.class.defaults.merge(params)
+      @metadata = {}
     end
 
     def read_file(filename)
@@ -66,6 +68,10 @@ module Vendorificator
       self.class.modules
     end
 
+    def annotate key, value
+      @metadata.merge!({key => value})
+    end
+
     def method_missing(method_symbol, *args, &block)
       if modules.keys.include? method_symbol
         modules[method_symbol].new(environment, args.delete_at(0).to_s, *args, &block)

data/lib/vendorificator/environment.rb

@@ -1,7 +1,6 @@
 require 'pathname'
-
 require 'minigit'
-
+require 'awesome_print'
 require 'vendorificator/config'
 
 module Vendorificator
@@ -9,12 +8,15 @@ module Vendorificator
     attr_reader :config
     attr_accessor :shell, :vendor_instances
 
-    def initialize(vendorfile=nil)
+    def initialize(vendorfile=nil, &block)
       @vendor_instances = []
 
       @config = Vendorificator::Config.new
       @config.environment = self
-      @config.read_file(find_vendorfile(vendorfile).to_s)
+      if vendorfile || !block_given?
+        @config.read_file(find_vendorfile(vendorfile).to_s)
+      end
+      @config.instance_eval(&block) if block_given?
 
       self.each_vendor_instance{ |mod| mod.compute_dependencies! }
     end
@@ -66,6 +68,7 @@ module Vendorificator
 
       git.fetch(remote)
       git.fetch({:tags => true}, remote)
+      git.fetch(remote, 'refs/notes/vendor:refs/notes/vendor')
 
       ref_rx = /^refs\/remotes\/#{Regexp.quote(remote)}\//
       remote_branches = Hash[ git.capturing.show_ref.
@@ -97,6 +100,26 @@ module Vendorificator
       end
     end
 
+    # Public: Displays info about the last merged version of module.
+    #
+    # mod - String with the module name
+    # options - Hash containing options
+    #
+    # Returns nothing.
+    def info(mod_name, options = {})
+      if vendor = find_vendor_instance_by_name(mod_name)
+        shell.say "Module name: #{vendor.name}\n"
+        shell.say "Module category: #{vendor.category}\n"
+        shell.say "Module merged version: #{vendor.merged_version}\n"
+        shell.say "Module merged notes: #{vendor.merged_notes.ai}\n"
+      elsif (commit = Commit.new(mod_name, git)).exists?
+        shell.say "Branches that contain this commit: #{commit.branches.join(', ')}\n"
+        shell.say "Vendorificator notes on this commit: #{commit.notes.ai}\n"
+      else
+        shell.say "Module or ref #{mod_name.inspect} not found."
+      end
+    end
+
     # Public: Push changes on module branches.
     #
     # options - The Hash containing options
@@ -109,9 +132,11 @@ module Vendorificator
       each_vendor_instance{ |mod| pushable += mod.pushable_refs }
 
       remotes = options[:remote] ? options[:remote].split(',') : config[:remotes]
-      remotes.each{ |remote| git.push remote, pushable }
-
-      git.push :tags => true
+      remotes.each do |remote|
+        git.push remote, pushable
+        git.push remote, :tags => true
+        git.push remote, 'refs/notes/vendor'
+      end
     end
 
     # Public: Runs all the vendor modules.
@@ -122,11 +147,12 @@ module Vendorificator
     def sync(options = {})
       ensure_clean!
       config[:use_upstream_version] = options[:update]
+      metadata = metadata_snapshot
 
       each_vendor_instance(*options[:modules]) do |mod|
         say_status :module, mod.name
         indent do
-          mod.run!
+          mod.run!(:metadata => metadata)
         end
       end
     end
@@ -166,8 +192,40 @@ module Vendorificator
       false
     end
 
+    def metadata_snapshot
+      {
+        :vendorificator_version => ::Vendorificator::VERSION,
+        :current_branch => git.capturing.rev_parse({:abbrev_ref => true}, 'HEAD').strip,
+        :current_sha => git.capturing.rev_parse('HEAD').strip,
+        :git_describe => (git.capturing.describe.strip rescue '')
+      }
+    end
+
+    # Public: returns `config[:root_dir]` relative to Git repository root
+    def relative_root_dir
+      @relative_root_dir ||= config[:root_dir].relative_path_from(
+        Pathname.new(git.git_work_tree))
+    end
+
+    # Public: Returns module with given name
+    def [](name)
+      vendor_instances.find { |v| v.name == name }
+    end
+
     private
 
+    # Private: Finds a vendor instance by module name.
+    #
+    # mod_name - The String containing the module name.
+    #
+    # Returns Vendor instance.
+    def find_vendor_instance_by_name(mod_name)
+      each_vendor_instance do |mod|
+        return mod if mod.name == mod_name
+      end
+      nil
+    end
+
     # Private: Finds the vendorfile to use.
     #
     # given - the optional String containing vendorfile path.
@@ -213,6 +271,5 @@ module Vendorificator
     ensure
       shell.padding -= 1 if shell
     end
-
   end
 end