vendorificator 0.2.0 → 0.3.0

data/lib/vendorificator/vendor.rb

@@ -10,17 +10,6 @@ module Vendorificator
     class << self
       attr_accessor :category, :method_name
 
-      # Define a method on Vendorificator::Config to add the
-      # vendor module to the module definition list.
-      def install!
-        @method_name ||= self.name.split('::').last.downcase.to_sym
-        _cls = self # for self is obscured in define_method block's body
-        ( class << Vendorificator::Config ; self ; end ).
-            send(:define_method, @method_name ) do |name, *args, &block|
-          _cls.new(self.environment, name.to_s, *args, &block)
-        end
-      end
-
       def arg_reader(*names)
         names.each do |name|
           define_method(name) do
@@ -28,44 +17,6 @@ module Vendorificator
           end
         end
       end
-
-      def [](*key)
-        return key.map { |k| self[k] }.flatten if key.length > 1
-
-        key = key.first
-
-        if key.is_a?(Fixnum)
-          self.instances[key]
-        else
-          instances.select { |i| i === key }
-        end
-      end
-
-      def each(*modules)
-        modpaths = modules.map { |m| File.expand_path(m) }
-
-        # We don't use instances.each here, because Vendor#run! is
-        # explicitly allowed to append to instantiate new
-        # dependencies, and #each fails to catch up on some Ruby
-        # implementations.
-        i = 0
-        while true
-          break if i >= instances.length
-          mod = instances[i]
-          yield mod if modules.empty? ||
-            modules.include?(mod.name) ||
-            modpaths.include?(mod.work_dir)
-          i += 1
-        end
-      end
-
-      def instances
-        Vendorificator::Vendor.instance_eval { @instances ||= [] }
-      end
-
-      def compute_dependencies!
-        self.instances.each(&:compute_dependencies!)
-      end
     end
 
     attr_reader :environment, :name, :args, :block
@@ -75,11 +26,18 @@ module Vendorificator
       @environment = environment
       @category = args.delete(:category) if args.key?(:category)
 
+      unless (hooks = Array(args.delete(:hooks))).empty?
+        hooks.each do |hook|
+          hook_module = hook.is_a?(Module) ? hook : ::Vendorificator::Hooks.const_get(hook)
+          klass = class << self; self; end;
+          klass.send :include, hook_module
+        end
+      end
       @name = name
       @args = args
       @block = block
 
-      self.class.instances << self
+      @environment.vendor_instances << self
     end
 
     def ===(other)
@@ -91,20 +49,15 @@ module Vendorificator
     end
 
     def shell
-      @shell ||=
-        environment.config[:shell] || Thor::Shell::Basic.new
+      @shell ||= config[:shell] || Thor::Shell::Basic.new
     end
 
     def category
-      if instance_variable_defined?(:@category)
-        @category
-      else
-        self.class.category
-      end
+      defined?(@category) ? @category : self.class.category
     end
 
     def branch_name
-      _join(environment.config[:branch_prefix], category, name)
+      _join(config[:branch_prefix], category, name)
     end
 
     def to_s
@@ -116,21 +69,15 @@ module Vendorificator
     end
 
     def work_subdir
-      _join(environment.config[:basedir], path)
+      _join(config[:basedir], path)
     end
 
     def work_dir
-      _join(environment.config[:root_dir], work_subdir)
+      _join(config[:root_dir], work_subdir)
     end
 
     def head
-      environment.git.capturing.rev_parse({:verify => true}, "refs/heads/#{branch_name}").strip
-    rescue MiniGit::GitError
-      nil
-    end
-
-    def tagged_sha1
-      @tagged_sha1 ||= environment.git.capturing.rev_parse({:verify => true}, "refs/tags/#{tag_name}^{commit}").strip
+      git.capturing.rev_parse({:verify => true, :quiet => true}, "refs/heads/#{branch_name}").strip
     rescue MiniGit::GitError
       nil
     end
@@ -138,7 +85,7 @@ module Vendorificator
     def merged
       unless @_has_merged
         if ( head = self.head )
-          merged = environment.git.capturing.merge_base(head, 'HEAD').strip
+          merged = git.capturing.merge_base(head, 'HEAD').strip
           @merged = merged unless merged.empty?
         end
         @_has_merged = true
@@ -149,7 +96,7 @@ module Vendorificator
     def merged_tag
       unless @_has_merged_tag
         if merged
-          tag = environment.git.capturing.describe( {
+          tag = git.capturing.describe( {
               :exact_match => true,
               :match => _join(tag_name_base, '*') },
             merged).strip
@@ -165,7 +112,7 @@ module Vendorificator
     end
 
     def version
-      @args[:version] || (!environment.config[:use_upstream_version] && merged_version) || upstream_version
+      @args[:version] || (!config[:use_upstream_version] && merged_version) || upstream_version
     end
 
     def upstream_version
@@ -176,7 +123,7 @@ module Vendorificator
       return nil if self.status == :up_to_date
       return false if !head
       return false if head && merged == head
-      environment.git.describe({:abbrev => 0, :always => true}, branch_name)
+      git.describe({:abbrev => 0, :always => true}, branch_name)
     end
 
     def status
@@ -205,25 +152,44 @@ module Vendorificator
 
     def in_branch(options={}, &block)
       orig_branch = environment.current_branch
+      stash_message = "vendorificator-#{git.capturing.rev_parse('HEAD').strip}-#{branch_name}-#{Time.now.to_i}"
 
       # We want to be in repository's root now, as we may need to
       # remove stuff and don't want to have removed directory as cwd.
-      Dir::chdir environment.git.git_work_tree do
-        # If our branch exists, check it out; otherwise, create a new
-        # orphaned branch.
-        if self.head
-          environment.git.checkout branch_name
-          environment.git.rm( { :r => true, :f => true, :q => true, :ignore_unmatch => true }, '.') if options[:clean]
-        else
-          environment.git.checkout( { :orphan => true }, branch_name )
-          environment.git.rm( { :r => true, :f => true, :q => true, :ignore_unmatch => true }, '.')
+      Dir::chdir git.git_work_tree do
+        begin
+          # Stash all local changes
+          git.stash :save, {:all => true, :quiet => true}, stash_message
+
+          # If our branch exists, check it out; otherwise, create a new
+          # orphaned branch.
+          if self.head
+            git.checkout branch_name
+            git.rm( { :r => true, :f => true, :q => true, :ignore_unmatch => true }, '.') if options[:clean]
+          else
+            git.checkout( { :orphan => true }, branch_name )
+            git.rm( { :r => true, :f => true, :q => true, :ignore_unmatch => true }, '.')
+          end
+
+          yield
+        ensure
+          # We should try to ensure we're back on original branch and
+          # local changes have been applied
+          begin
+            git.checkout orig_branch
+            stash = git.capturing.
+              stash(:list, {:grep => stash_message, :fixed_strings => true}).lines.map(&:strip)
+            if stash.length > 1
+              shell.say_status 'WARNING', "more than one stash matches #{stash_message}, it's weird", :yellow
+              stash.each { |ln| shell.say_status '-', ln, :yellow }
+            end
+            git.stash :pop, {:quiet => true}, stash.first.sub(/:.*/, '') unless stash.empty?
+          rescue => e
+            shell.say_status 'ERROR', "Cannot revert branch from #{self.head} back to #{orig_branch}: #{e}", :red
+            raise
+          end
         end
       end
-
-      yield
-    ensure
-      # We should try to ensure we're back on original branch
-      environment.git.checkout orig_branch if defined?(orig_branch) rescue nil
     end
 
     def run!
@@ -234,7 +200,7 @@ module Vendorificator
 
       when :unpulled, :unmerged
         shell.say_status 'merging', self.to_s, :yellow
-        environment.git.merge({:no_edit => true, :no_ff => true}, tagged_sha1)
+        git.merge({:no_edit => true, :no_ff => true}, tagged_sha1)
         compute_dependencies!
 
       when :outdated, :new
@@ -259,13 +225,13 @@ module Vendorificator
 
 
             # Commit and tag the conjured module
-            environment.git.add work_dir
-            environment.git.commit :m => conjure_commit_message
-            environment.git.tag( { :a => true, :m => tag_message }, tag_name )
+            git.add work_dir
+            git.commit :m => conjure_commit_message
+            git.tag( { :a => true, :m => tag_message }, tag_name )
             shell.say_status :tag, tag_name
           end
           # Merge back to the original branch
-          environment.git.merge( {}, branch_name )
+          git.merge( {:no_edit => true, :no_ff => true}, branch_name )
           compute_dependencies!
         ensure
           shell.padding -= 1
@@ -298,8 +264,33 @@ module Vendorificator
 
     def compute_dependencies! ; end
 
+    def pushable_refs
+      branch = "+refs/heads/#{branch_name}"
+      tags = created_tags.map{ |tag| '+' + tag }
+      [branch, tags].flatten
+    end
+
     private
 
+    def tagged_sha1
+      @tagged_sha1 ||= git.capturing.rev_parse({:verify => true, :quiet => true}, "refs/tags/#{tag_name}^{commit}").strip
+    rescue MiniGit::GitError
+      nil
+    end
+
+    def created_tags
+      git.capturing.show_ref.split("\n").map{ |line| line.split(' ')[1] }.
+        select{ |ref| ref =~ /\Arefs\/tags\/#{tag_name_base}/ }
+    end
+
+    def git
+      environment.git
+    end
+
+    def config
+      environment.config
+    end
+
     def _join(*parts)
       parts.compact.map(&:to_s).join('/')
     end
@@ -318,6 +309,7 @@ module Vendorificator
       Dir.chdir(curdir.to_s) if curdir.exist?
     end
 
-    install!
   end
+
+  Config.register_module :vendor, Vendor
 end

data/lib/vendorificator/version.rb

@@ -1,3 +1,3 @@
 module Vendorificator
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/vendorificator.rb

@@ -4,6 +4,7 @@ require "vendorificator/version"
 
 require 'vendorificator/config'
 require 'vendorificator/environment'
+require 'vendorificator/errors'
 
 require 'vendorificator/vendor'
 require 'vendorificator/vendor/download'

data/spec/spec_helper.rb

@@ -16,6 +16,16 @@ else
   MiniTest::ANSI.use! if STDOUT.tty?
 end
 
+if ENV['COVERAGE']
+  require 'simplecov'
+  SimpleCov.start do
+    add_filter '/spec/'
+    add_group 'Vendors', 'lib/vendorificator/vendor'
+    use_merging
+  end
+  SimpleCov.command_name 'rake spec'
+end
+
 require 'vendorificator'
 
 VCR.configure do |config|
@@ -24,34 +34,22 @@ VCR.configure do |config|
   config.hook_into :webmock
 end
 
-Vendorificator::Config[:root_dir] = Pathname.new(__FILE__).dirname
-
 class MiniTest::Spec
-  def conf
-    Vendorificator::Config
+  before do
+    Vendorificator::Environment.any_instance.stubs(:git).returns(stub)
   end
 
-  before :each do
-    @saved_configuration = Marshal.load(Marshal.dump(conf.configuration))
-    @saved_methods = conf.methods
+  def conf
+    @conf ||= Vendorificator::Config.new
   end
 
-  after :each do
-    # Remove all new methods defined on Configuration over the run
-    conf[:methods_to_remove!] = conf.methods - @saved_methods
-
-    class << conf
-      Vendorificator::Config[:methods_to_remove!].each do |method_to_remove|
-        remove_method method_to_remove
-      end
-    end
-    assert { conf.methods.sort == @saved_methods.sort }
-
-    # Restore saved configuration
-    conf.configuration = @saved_configuration
+  def basic_environment
+    @basic_environment ||= Vendorificator::Environment.new(
+      'spec/vendorificator/fixtures/vendorfiles/empty_vendor.rb'
+    )
   end
 
-  def vendorfile(&block)
-    Vendorificator::Config.instance_eval &block
+  def includes_method?(obj, method)
+    (obj.methods.include? method.to_sym) || (obj.methods.include? method.to_s)
   end
 end

data/spec/vendorificator/config_spec.rb

@@ -0,0 +1,64 @@
+require File.expand_path("../../spec_helper", __FILE__)
+
+module Vendorificator
+  describe Config do
+    let(:config){ Config.new }
+
+    describe '#initialize' do
+      it' creates a Config object' do
+        assert { config.is_a? Config }
+      end
+
+      it 'allows to overwrite the default configuration' do
+        config = Config.new(:basedir => 'different/basedir')
+        assert { config[:basedir] == 'different/basedir' }
+      end
+    end
+
+    it 'allows to set and get values' do
+      assert { config[:new_value] == nil }
+      config[:new_value] = 'new value'
+
+      assert { config[:new_value] == 'new value' }
+    end
+
+    describe 'extensions' do
+      before do
+        class Config
+          option :custom_option, :default_value
+        end
+      end
+
+      it 'allows to define custom options' do
+        assert { includes_method? Config.new, :custom_option }
+      end
+
+      it 'allows to get custom_option value via method' do
+        assert { Config.new.custom_option == :default_value }
+      end
+
+      it 'allows to set custom_option via method' do
+        config.custom_option :custom_value
+        assert { config[:custom_option] == :custom_value }
+      end
+
+      it 'sets a default value for custom option' do
+        assert { Config.new[:custom_option] == :default_value }
+      end
+    end
+
+    describe 'options' do
+      it 'have default values' do
+        assert { config[:basedir] == 'vendor' }
+        assert { config[:branch_prefix] == 'vendor' }
+        assert { config[:remotes] == %w(origin) }
+      end
+
+      it 'can be set' do
+        assert { includes_method? config, :basedir }
+        assert { includes_method? config, :branch_prefix }
+        assert { includes_method? config, :remotes }
+      end
+    end
+  end
+end

data/spec/vendorificator/environment_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+module Vendorificator
+  describe Environment do
+    before do
+      MiniGit.any_instance.stubs(:fetch)
+    end
+    let(:environment){ Environment.new 'spec/vendorificator/fixtures/vendorfiles/vendor.rb' }
+
+    describe '#clean' do
+      it 'returns false for dirty repo' do
+        git_error = MiniGit::GitError.new(['command'], 'status')
+        environment.git.expects(:update_index).raises(git_error)
+
+        assert { environment.clean? == false }
+      end
+
+      it 'returns true for a clean repo' do
+        environment.git.expects(:update_index)
+        environment.git.expects(:diff_files)
+        environment.git.expects(:diff_index)
+
+        assert { environment.clean? == true }
+      end
+    end
+
+    describe '#pull_all' do
+      it 'aborts on a dirty repo' do
+        environment.expects(:clean?).returns(false)
+
+        assert { rescuing { environment.pull_all }.is_a? DirtyRepoError }
+      end
+
+      it 'pulls multiple remotes if specified' do
+        environment.stubs(:clean?).returns(true)
+        environment.expects(:pull).with('origin_1', anything)
+        environment.expects(:pull).with('origin_2', anything)
+
+        environment.pull_all(:remote => 'origin_1,origin_2')
+      end
+    end
+
+    describe '#pull' do
+      it "creates a branch if it doesn't exist" do
+        Environment.any_instance.unstub(:git)
+        environment.git.capturing.stubs(:show_ref).
+          returns("602315 refs/remotes/origin/vendor/test")
+        environment.vendor_instances = [ stub(:branch_name => 'vendor/test', :head => nil)]
+
+        environment.git.expects(:branch).with({:track => true}, 'vendor/test', '602315')
+        environment.pull('origin')
+      end
+
+      it "handles fast forwardable branches" do
+        Environment.any_instance.unstub(:git)
+        environment.git.capturing.stubs(:show_ref).
+          returns("602315 refs/remotes/origin/vendor/test")
+        environment.vendor_instances = [stub(
+          :branch_name => 'vendor/test', :head => '123456', :in_branch => true, :name => 'test'
+        )]
+
+        environment.expects(:fast_forwardable?).returns(true)
+        environment.pull('origin')
+      end
+    end
+
+    describe '#vendor_instances' do
+      let(:environment){ Environment.new 'spec/vendorificator/fixtures/vendorfiles/empty_vendor.rb' }
+
+      it 'is initialized on a new environment' do
+        assert { environment.vendor_instances == [] }
+      end
+
+      it 'allows to add/read instances' do
+        environment.vendor_instances << :foo
+        assert { environment.vendor_instances == [:foo] }
+      end
+    end
+
+  end
+end

data/spec/vendorificator/fixtures/vendorfiles/empty_vendor.rb

@@ -0,0 +1 @@
+# Empty vendor file, just for stubbing purposes.

data/spec/vendorificator/fixtures/vendorfiles/vendor.rb

@@ -0,0 +1,15 @@
+# Just an example config
+
+vendor 'name', :option => 'value' do
+  # here in the block you code what needs to be done
+  # to get ("conjure") the module. You're already in
+  # the right directory, branch, etc, and what you add to the
+  # current directory will be committed and tagged.
+end
+
+vendor 'other_name', :option => 'other_value' do
+  # here in the block you code what needs to be done
+  # to get ("conjure") the module. You're already in
+  # the right directory, branch, etc, and what you add to the
+  # current directory will be committed and tagged.
+end

data/spec/vendorificator/vendor/chef_cookbook_spec.rb

@@ -0,0 +1,13 @@
+require File.expand_path("../../../spec_helper", __FILE__)
+
+module Vendorificator
+  describe Vendor::ChefCookbook do
+    describe 'config extensions' do
+      describe 'options' do
+        it 'registers chef_cookbook_ignore_dependencies' do
+          assert { includes_method? Config.new, :chef_cookbook_ignore_dependencies }
+        end
+      end
+    end
+  end
+end

data/spec/vendorificator/vendor_spec.rb

@@ -1,3 +1,5 @@
+# Note that due to git operations involved, most of the Vendor class is tested
+# with cucumber features instead.
 require 'spec_helper'
 
 module Vendorificator
@@ -20,50 +22,24 @@ module Vendorificator
       end
     end
 
-    describe '.install!' do
-      it "creates a method inside Vendorificator::Config" do
-        deny { conf.respond_to?(:categorized) }
-
-        Vendor::Categorized.install!
-        assert { conf.respond_to?(:categorized) }
-      end
-
-      it "uses @method_name for method's name if set" do
-        deny { conf.respond_to?(:custom) }
-        deny { conf.respond_to?(:whatever) }
-
-        Vendor::Custom.install!
-        deny   { conf.respond_to?(:custom) }
-        assert { conf.respond_to?(:whatever) }
-      end
-    end
-
     describe '#category' do
       it 'defaults to class attribute' do
-        assert { Vendor.new(nil, 'test').category == nil }
-        assert { Vendor::Categorized.new(nil, 'test').category == :test }
+        assert { Vendor.new(basic_environment, 'test').category == nil }
+        assert { Vendor::Categorized.new(basic_environment, 'test').category == :test }
       end
 
       it 'can be overriden by option' do
-        assert { Vendor.new(nil, 'test', :category => :foo).category == :foo }
-        assert { Vendor::Categorized.new(nil, 'test', :category => :foo).category == :foo }
+        assert { Vendor.new(basic_environment, 'test', :category => :foo).category == :foo }
+        assert { Vendor::Categorized.new(basic_environment, 'test', :category => :foo).category == :foo }
       end
 
       it 'can be reset to nil by option' do
-        assert { Vendor::Categorized.new(nil, 'test', :category => nil).category == nil }
+        assert { Vendor::Categorized.new(basic_environment, 'test', :category => nil).category == nil }
       end
 
       it 'is inserted into paths and other names' do
-        env = stub(
-          :git => stub(
-            :capturing => stub(
-              :rev_parse => 'cafe',
-              :merge_base => 'cafe',
-              :describe => '')),
-          :config => Vendorificator::Config)
-
-        uncategorized = Vendor.new(env, 'test')
-        categorized   = Vendor.new(env, 'test', :category => :cat)
+        uncategorized = Vendor.new(basic_environment, 'test')
+        categorized   = Vendor.new(basic_environment, 'test', :category => :cat)
 
         deny { uncategorized.branch_name.include? 'cat' }
         assert { categorized.branch_name.include? 'cat' }
@@ -71,9 +47,29 @@ module Vendorificator
         deny { uncategorized.path.include? 'cat' }
         assert { categorized.path.include? 'cat' }
 
+        uncategorized.stubs(:version).returns(:foo)
+        categorized.stubs(:version).returns(:foo)
         deny { uncategorized.tag_name.include? 'cat' }
         assert { categorized.tag_name.include? 'cat' }
       end
     end
+
+    describe '#initialize' do
+      it 'adds hooks when you pass a module option' do
+        vendor = Vendor.new(basic_environment, 'test', {:hooks => Hooks::FooHook})
+        assert { includes_method? vendor, :foo_hooked_method }
+      end
+
+      it 'adds hooks via the String option shortcut' do
+        vendor = Vendor.new(basic_environment, 'test', {:hooks => 'FooHook'})
+        assert { includes_method? vendor, :foo_hooked_method }
+      end
+    end
+  end
+
+  module Hooks
+    module FooHook
+      def foo_hooked_method; end
+    end
   end
 end

data/vendorificator.gemspec

@@ -16,11 +16,10 @@ Gem::Specification.new do |gem|
   gem.version       = Vendorificator::VERSION
 
   gem.add_dependency 'escape'
-  gem.add_dependency 'thor', '>= 0.17.0'
-  gem.add_dependency 'mixlib-config'
+  gem.add_dependency 'thor', '>= 0.18.1'
   gem.add_dependency 'minigit', '>= 0.0.3'
 
-  gem.add_development_dependency 'aruba'
+  gem.add_development_dependency 'aruba', '0.5.1'
   gem.add_development_dependency 'cucumber'
   gem.add_development_dependency 'mocha'
   gem.add_development_dependency 'chef', '>= 10.16.0' unless defined?(RUBY_ENGINE) && RUBY_ENGINE == 'jruby'
@@ -28,4 +27,5 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'webmock'
   gem.add_development_dependency 'wrong', '>= 0.7.0'
   gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'simplecov'
 end