vendorificator 0.2.0 → 0.3.0

data/.gitignore

@@ -17,4 +17,7 @@ test/tmp
 test/version_tmp
 tmp
 /.rbx
+/.ruby-version
+/.ruby-gemset
 /log
+.DS_Store

data/CHANGELOG.md

@@ -0,0 +1,40 @@
+# Changes
+
+## 0.3.0
+
+ - New command `vendor push` for pushing managed branches and tags to
+   remote repository
+ - Nicer syntax for mixin hooks
+ - Add `:tag` option for `git` submodule
+ - Better stashing of local changes when syncing
+ - Verbosity tweaks
+ - Refactor implementation of configuration, other internal refactors
+ - Improved test coverage
+
+## 0.2.0
+
+ - New vendor type `download` for downloading a single file
+ - Support `--version` and `-h` / `--help` switches
+ - New `:subdirectory` option for vendor modules
+ - Support JRuby
+ - Fix error when cleaning empty repository
+ - Misc verbosity tweaks
+ - Use MiniGit instead of Grit as Git library; other internal refactors
+ - Run Cucumber tests with Aruba
+
+## 0.1.1
+
+ - Add `--update` option to `vendor sync` and `vendor status` to check
+   whether upstream version has changed
+ - It is now possible to explicitly set module's category to `nil`
+ - Ruby 1.8.7 compatibility fix
+ - Gem runtime/development dependency fixes
+ - Initial minitest specs
+ - Make Cucumber tests use Webmock
+
+## 0.1.0
+
+Initial release.
+
+
+

data/Gemfile

@@ -4,8 +4,8 @@ source 'https://rubygems.org'
 gemspec
 
 group :development do
-  git "git://github.com/mpasternacki/wrong.git",
-      :ref => 'ad025241e5772373264d1bf62168e2bf3780ccf9' do
+  git "git://github.com/sconover/wrong.git",
+      :ref => '0cbc35a07cb63f6f409bb85da6ad7d107bdab021' do
     gem 'wrong'
   end
   gem 'minitest-ansi'

data/README.md

@@ -50,8 +50,10 @@ detail.
 
  * `vendor sync` will update all vendor modules that need updating
  * `vendor status` will list all the modules and their status
- * `vendor pull` will pull all vendor branches, tags, and notes from a
-   Git remote
+ * `vendor pull` will pull all vendor branches, tags, and notes from
+   a Git remote
+ * `vendor push` will push all vendor branches, tags, and notes to
+   a Git remote
  * `vendor diff` will show the differences between vendor module's
    pristine branch and curent work tree
  * `vendor log` will show a `git log` of all changes made to a particular
@@ -123,9 +125,9 @@ block).
 Example:
 
 ```ruby
-vendor 'generated', :version => '0.23' do |mod|
-  File.open('README') { |f| f.puts "Hello, World!" }
-  File.open('VERSION') { |f| f.puts mod.version }
+vendor 'generated', :version => '0.23' do |v|
+  File.open('README', 'w') { |f| f.puts "Hello, World!" }
+  File.open('VERSION', 'w') { |f| f.puts v.version }
 end
 ```
 
@@ -160,7 +162,7 @@ unpacks it as contents of the module. It takes same options as
    disables this behaviour.
  * `:checksum` -- if set to SHA256 checksum of the file, it will be
    checked on download.
-   
+
 Archive's `:version` defaults to file name.
 
 Example:
@@ -181,10 +183,11 @@ Downloads snapshot of a Git repository. Takes the same options as
    sets name to its basename then), just like `:url` for `archive`
    (e.g. `git "git://github.com/github/testrepo.git"` will be cloned
    from that repository, and named `testrepo`).
- * `:branch`, `:revision` -- what to check out when repository is
-   cloned.
+ * `:branch`, `:revision`, `:tag` -- what to check out when repository
+   is cloned.
 
-Git module's `:version` defaults to the conjured revision.
+Git module's `:version` defaults to the `:tag` if given, or the
+conjured revision otherwise.
 
 Example:
 
@@ -208,7 +211,7 @@ always enough), plus:
    completely. If an array, don't download dependencies that are in
    the array. Default for that is `chef_cookbook_ignore_dependencies`
    setting.
-   
+
 Examples:
 
 ```ruby
@@ -227,18 +230,16 @@ chef_cookbook 'memcached', ignore_dependencies => ['runit']
 ```
 
 If you get Chef cookbooks from Git or anywhere else than Opscode's
-community website, you can still use dependency resolution by mixing
-in the hook class:
+community website, you can still use dependency resolution by using a :hooks
+option to add it:
 
 ```ruby
-class <<  git 'git://github.com/user/cookbook.git', :category => :cookbooks
-  include Vendorificator::Hooks::ChefCookbookDependencies
+git 'git://github.com/user/cookbook.git',
+  :category => :cookbooks,
+  :hooks => 'ChefCookbookDependencies'
 end
 ```
 
-This is a bit convoluted, but there will soon be an argument to do
-that in a nicer way.
-
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -13,6 +13,11 @@ namespace :relish do
   end
 end
 
+task :info do
+  sh 'which git'
+  sh 'git --version'
+end
+
 begin
   require 'cucumber'
   require 'cucumber/rake/task'
@@ -38,4 +43,13 @@ end
 mkdir_p 'tmp'
 ENV['TMPDIR'] ||= File.join(Dir.pwd, 'tmp')
 
-task :default => [:spec, :features]
+task :default => [:info, :spec, :features]
+
+if ENV['COVERAGE']
+  task :clean_coverage do
+    rm_rf 'coverage'
+  end
+
+  task :spec => :clean_coverage
+  task :features => :clean_coverage
+end

data/features/edgecases.feature

@@ -0,0 +1,34 @@
+Feature: weird edge cases
+
+Scenario: module with a .gitignore file
+  Given a repository with following Vendorfile:
+    """ruby
+    vendor 'ignore', :version => 1 do
+      File.open('.gitignore', 'w') { |f| f.puts 'ignored.txt' }
+    end
+    """
+  When I successfully run `vendor sync`
+  Then the following has been conjured:
+    | Name      | ignore     |
+    | With file | .gitignore |
+
+  When I write to "vendor/ignore/ignored.txt" with:
+    """
+    whatever
+    """
+  Then git repository is clean
+
+  When I change Vendorfile to:
+    """ruby
+    vendor 'ignore', :version => 2 do
+      File.open('files.txt', 'w')  { |f| f.puts Dir.entries('.').join("\n") }
+      File.open('.gitignore', 'w') { |f| f.puts 'ignored.txt' }
+    end
+    """
+  And I successfully run `vendor sync`
+  Then the file "vendor/ignore/files.txt" should not contain "ignored.txt"
+  And the file "vendor/ignore/ignored.txt" should contain exactly:
+    """
+    whatever
+    """
+  And git repository is clean

data/features/environment.feature

@@ -0,0 +1,17 @@
+Feature: Environment management.
+
+Scenario:
+  Given a repository with following Vendorfile:
+    """ruby
+    vendor 'generated', :version => '0.23' do |v|
+      File.open('README', 'w') { |f| f.puts "Hello, World!" }
+    end
+    """
+  And a remote repository
+  When I successfully run `vendor sync`
+  And I successfully run `vendor push`
+  Then branch "vendor/generated" exists in the remote repo
+  And tag "vendor/generated/0.23" exists in the remote repo
+
+
+

data/features/fixtures/git/testrepo/objects/53/ac1a96882e666cee31504179abc21eac522f8d

@@ -0,0 +1,2 @@
+x
E�A
+�0@Q�9��E�IӦ���B2��TӖ:��ڍ��OCT�n���Bj�:;q�| ��m�2c䄱��BM��g੔�FWCJ�������Y����2~d8��]��;�������S��	јM�U���1l

data/features/fixtures/git/testrepo/refs/tags/email-v0

@@ -0,0 +1 @@
+53ac1a96882e666cee31504179abc21eac522f8d

data/features/git.feature

@@ -10,6 +10,7 @@ Scenario: Vendorificating a git repo
     | Name      | testrepo                                 |
     | Version   | 10e9ac58c77bc229d8c59a5b4eb7422916453148 |
     | With file | test/alias.c                             |
+  And there's a git log message including "at revision 10e9ac58c77bc229d8c59a5b4eb7422916453148"
 
 Scenario: Vendorificating a subdirectory from a git repo
   Given a repository with following Vendorfile:
@@ -23,6 +24,7 @@ Scenario: Vendorificating a subdirectory from a git repo
     | Version       | 10e9ac58c77bc229d8c59a5b4eb7422916453148 |
     | With file     | alias.c                                  |
     | Without file  | test/alias.c                             |
+  And there's a git log message including "at revision 10e9ac58c77bc229d8c59a5b4eb7422916453148"
 
 Scenario: Vendorificating a certain branch from a git repo
   Given a repository with following Vendorfile:
@@ -35,6 +37,22 @@ Scenario: Vendorificating a certain branch from a git repo
     | Name          | testrepo                                 |
     | Version       | ecbfa229ba5f11c05b18bcc4f7c32b8f25d63f8c |
     | With file     | README.md                                |
+  And there's a git log message including "at revision ecbfa229ba5f11c05b18bcc4f7c32b8f25d63f8c"
+
+@wip
+Scenario: Vendorificating a certain tag from a git repo
+  Given a repository with following Vendorfile:
+    """ruby
+    git "file://#{ENV['FIXTURES_DIR']}/git/testrepo",
+        :tag => 'email-v0'
+    """
+  When I successfully run `vendor sync`
+  Then following has been conjured:
+    | Name         | testrepo     |
+    | Version      | email-v0     |
+    | Without file | README.md    |
+    | With file    | test/alias.c | 
+  And there's a git log message including "at revision f81247bde4ef7a1c7d280140cc0bcf0b8221a51f"
 
 Scenario: Vendorificating a certain revision from a git repo
   Given a repository with following Vendorfile:
@@ -48,4 +66,4 @@ Scenario: Vendorificating a certain revision from a git repo
     | Version       | 6ff1be9c3819c93a2f41e0ddc09f252fcf154f34 |
     | With file     | alias.c                                  |
     | Without file  | test/alias.c                             |
-
+  And there's a git log message including "at revision 6ff1be9c3819c93a2f41e0ddc09f252fcf154f34"

data/features/status.feature

@@ -1,6 +1,6 @@
 Feature: Module status
 
-The `status` subcommand statuss all known modules and their status.
+The `status` subcommand displays all known modules and their status.
 
 Background:
   Given a repository with following Vendorfile:

data/features/step_definitions/basic.rb

@@ -19,6 +19,17 @@ Given /^a repository with following Vendorfile:$/ do |vendorfile_contents|
   run_simple 'git commit -m "New repo"'
 end
 
+Given /^a remote repository$/ do
+  create_dir '../remote-repository'
+  cd '../remote-repository'
+  run_simple 'git init --bare'
+  # Configure Git username & email to unclutter console output
+  run_simple 'git config user.name Cucumber'
+  run_simple 'git config user.email cucumber@`hostname --fqdn`'
+  cd '../working-repository'
+  run_simple 'git remote add origin ../remote-repository'
+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

@@ -37,3 +37,15 @@ end
 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|
+  assert { git.log.lines.any? { |ln| ln.include?(message) } }
+end
+
+Then /^branch "(.*?)" exists in the remote repo$/ do |branch_name|
+  assert { remote_git.heads.include?(branch_name) }
+end
+
+Then /^tag "(.*?)" exists in the remote repo$/ do |tag_name|
+  assert { remote_git.tags.include?(tag_name) }
+end

data/features/support/env.rb

@@ -17,9 +17,8 @@ end
 
 Before do
   @aruba_timeout_seconds = case defined?(RUBY_ENGINE) && RUBY_ENGINE
-                           when 'ruby', nil then 3
-                           when 'jruby' then 20
-                           when 'rbx' then 10
-                           else 5
+                           when 'jruby' then 45
+                           when 'rbx' then 30
+                           else 30
                            end
 end

data/features/support/minigit.rb

@@ -24,6 +24,10 @@ module Vendorificator
       def git
         @git ||= ::MiniGit::Capturing.new(current_dir)
       end
+
+      def remote_git
+        @remote_git ||= ::MiniGit::Capturing.new(current_dir + '/../remote-repository')
+      end
     end
   end
 end

data/lib/vendorificator/cli.rb

@@ -1,5 +1,15 @@
-require 'thor'
+if ENV['COVERAGE']
+  require 'pathname'
+  require 'simplecov'
+  SimpleCov.start do
+    add_group 'Vendors', 'lib/vendorificator/vendor'
+    root Pathname.new(__FILE__).dirname.dirname.dirname.realpath.to_s
+    use_merging
+  end
+  SimpleCov.command_name "vendor##{$$}@#{DateTime.now.to_s}"
+end
 
+require 'thor'
 require 'vendorificator'
 
 module Vendorificator
@@ -24,6 +34,10 @@ module Vendorificator
     def initialize(args=[], options={}, config={})
       super
 
+      if self.options[:debug]
+        MiniGit.debug = true
+      end
+
       if self.options[:version]
         say "Vendorificator #{Vendorificator::VERSION}"
         exit
@@ -48,17 +62,9 @@ module Vendorificator
     desc :sync, "Download new or updated vendor files"
     method_option :update, :type => :boolean, :default => false
     def sync
-      ensure_clean!
-      environment.config[:use_upstream_version] = options[:update]
-      Vendorificator::Vendor.each(*modules) do |mod|
-        say_status :module, mod.name
-        begin
-          shell.padding += 1
-          mod.run!
-        ensure
-          shell.padding -= 1
-        end
-      end
+      environment.sync options.merge(:modules => modules)
+    rescue DirtyRepoError
+      fail! 'Repository is not clean.'
     end
 
     desc "status", "List known vendor modules and their status"
@@ -66,7 +72,7 @@ module Vendorificator
     def status
       say_status 'WARNING', 'Git repository is not clean', :red unless environment.clean?
       environment.config[:use_upstream_version] = options[:update]
-      Vendorificator::Vendor.each(*modules) do |mod|
+      environment.each_vendor_instance(*modules) do |mod|
         status_line = mod.to_s
 
         updatable = mod.updatable?
@@ -87,14 +93,19 @@ module Vendorificator
     method_option :remote, :aliases => ['-r'], :default => nil
     method_option :dry_run, :aliases => ['-n'], :default => false, :type => :boolean
     def pull
-      ensure_clean!
-      remotes = options[:remote] ? options[:remote].split(',') : environment.config[:remotes]
-      remotes.each do |remote|
-        indent 'remote', remote do
-          environment.pull(remote, options)
-        end
-      end
+      environment.pull_all options
+    rescue DirtyRepoError
+      fail! 'Repository is not clean.'
     end
+
+    desc :push, "Push local changes back to the remote repository"
+    method_option :remote, :aliases => ['-r'], :default => nil
+    def push
+      environment.push options
+    rescue DirtyRepoError
+      fail! 'Repository is not clean.'
+    end
+
     desc "git GIT_COMMAND [GIT_ARGS [...]]",
          "Run a git command for specified modules"
     long_desc <<EOF
@@ -110,7 +121,7 @@ module Vendorificator
     vendor git diff --stat @MERGED@ -- @PATH@  # 'vendor diff', as diffstat
 EOF
     def git(command, *args)
-      Vendorificator::Vendor.each(*modules) do |mod|
+      environment.each_vendor_instance(*modules) do |mod|
         unless mod.merged
           say_status 'unmerged', mod.to_s, :red unless options[:only_changed]
           next
@@ -185,28 +196,5 @@ EOF
       raise Thor::Error, 'I give up.'
     end
 
-    def indent(*args, &block)
-      say_status *args unless args.empty?
-      shell.padding += 1
-      yield
-    ensure
-      shell.padding -= 1
-    end
-
-    def ensure_clean!
-      unless environment.clean?
-        fail!('Repository is not clean.')
-      end
-    end
-  end
-end
-
-# Monkey patch over https://github.com/wycats/thor/pull/298
-class Thor::Options
-  alias_method :_orig_current_is_switch?, :current_is_switch?
-  def current_is_switch?
-    rv = _orig_current_is_switch?
-    @parsing_options = false if !rv[0] && @stop_on_unknown && @parsing_options
-    rv
   end
 end

data/lib/vendorificator/config.rb

@@ -1,33 +1,81 @@
 require 'pathname'
 
-require 'mixlib/config'
-
 module Vendorificator
   class Config
-    extend Mixlib::Config
-
     attr_accessor :environment
 
-    configure do |c|
-      c[:basedir] = 'vendor'
-      c[:branch_prefix] = 'vendor'
-      c[:remotes] = %w(origin)
+    @defaults = {}
+    @modules = {}
+
+    def self.defaults
+      @defaults
+    end
+
+    def self.modules
+      @modules
+    end
+
+    def self.option(name, default = nil, &block)
+      define_method name do |*args|
+        if args.size == 0
+          @configuration[name.to_sym]
+        elsif args.size == 1
+          @configuration[name.to_sym] = args.first
+        else
+          raise 'Unsupported number of arguments (expected 0 or 1).'
+        end
+      end
+      @defaults[name.to_sym] = default if default
+    end
+
+    def self.register_module(name, klass)
+      @modules[name.to_sym] = klass
+    end
+
+    def initialize(params = {})
+      @configuration = self.class.defaults.merge(params)
     end
 
-    def self.from_file(filename)
+    def read_file(filename)
       pathname = Pathname.new(filename).cleanpath.expand_path
 
-      self[:vendorfile_path] = pathname
-      self[:root_dir] =
-        if ( pathname.basename.to_s == 'vendor.rb' &&
-               pathname.dirname.basename.to_s == 'config' )
-          # Correctly recognize root dir if main config is 'config/vendor.rb'
+      @configuration[:vendorfile_path] = pathname
+      @configuration[:root_dir] = if pathname.basename.to_s == 'vendor.rb' &&
+                          pathname.dirname.basename.to_s == 'config'
           pathname.dirname.dirname
         else
           pathname.dirname
         end
 
-      super(pathname.to_s)
+      instance_eval(IO.read(filename), filename, 1)
+    end
+
+    def configure(&block)
+      block.call @configuration
+    end
+
+    def [](key)
+      @configuration[key]
+    end
+
+    def []=(key, value)
+      @configuration[key] = value
+    end
+
+    def modules
+      self.class.modules
     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)
+      else
+        super
+      end
+    end
+
+    option :basedir, 'vendor'
+    option :branch_prefix, 'vendor'
+    option :remotes, %w(origin)
   end
 end