cape 1.3.0 → 1.4.0

data/History.markdown

@@ -1,5 +1,9 @@
 # Version history for the _Cape_ project
 
+## <a name="v1.4.0"></a>v1.4.0, Mon 2/06/2012
+
+* Cache the Rake task list to improve Capistrano responsiveness
+
 ## <a name="v1.3.0"></a>v1.3.0, Fri 2/03/2012
 
 * Don’t allow `nil` environment variables to pass through to the remote command line

data/lib/cape.rb

@@ -40,10 +40,14 @@ end
 def Cape(&block)
   Cape.module_eval do
     @outer_self = block.binding.eval('self', __FILE__, __LINE__)
-    if 0 < block.arity
-      block.call self
-    else
-      module_eval(&block)
+    begin
+      if 0 < block.arity
+        block.call self
+      else
+        module_eval(&block)
+      end
+    ensure
+      rake.expire_cache!
     end
   end
   Cape

data/lib/cape/dsl.rb

@@ -215,6 +215,12 @@ module Cape
       rake.remote_executable = value
     end
 
+  protected
+
+    def rake
+      @rake ||= Rake.new
+    end
+
   private
 
     def deployment_library
@@ -230,10 +236,6 @@ module Cape
       end
     end
 
-    def rake
-      @rake ||= Rake.new
-    end
-
   end
 
 end

data/lib/cape/rake.rb

@@ -6,12 +6,6 @@ module Cape
     # The default command used to run Rake.
     DEFAULT_EXECUTABLE = '/usr/bin/env rake'.freeze
 
-    # Sets the command used to run Rake on the local computer.
-    #
-    # @param [String] value the command used to run Rake on the local computer
-    # @return [String] _value_
-    attr_writer :local_executable
-
     # Sets the command used to run Rake on remote computers.
     #
     # @param [String] value the command used to run Rake on remote computers
@@ -52,7 +46,7 @@ module Cape
                         ::Regexp.escape(task_expression.to_s) :
                         '.+?'
       regexp = /^rake (#{task_expression}(?::.+?)?)(?:\[(.+?)\])?\s+# (.+)/
-      `#{local_executable} --tasks 2> /dev/null`.each_line do |l|
+      each_output_line do |l|
         unless (matches = l.chomp.match(regexp))
           next
         end
@@ -74,6 +68,12 @@ module Cape
       self
     end
 
+    # Forces cached Rake task metadata (if any) to be discarded.
+    def expire_cache!
+      @output_lines = nil
+      self
+    end
+
     # The command used to run Rake on the local computer.
     #
     # @return [String] the command used to run Rake on the local computer
@@ -83,6 +83,21 @@ module Cape
       @local_executable ||= DEFAULT_EXECUTABLE
     end
 
+    # Sets the command used to run Rake on the local computer and discards any
+    # cached Rake task metadata.
+    #
+    # @param [String] value the command used to run Rake on the local computer
+    # @return [String] _value_
+    #
+    # @see #expire_cache!
+    def local_executable=(value)
+      unless @local_executable == value
+        @local_executable = value
+        expire_cache!
+      end
+      value
+    end
+
     # The command used to run Rake on remote computers.
     #
     # @return [String] the command used to run Rake on remote computers
@@ -92,6 +107,30 @@ module Cape
       @remote_executable ||= DEFAULT_EXECUTABLE
     end
 
+  private
+
+    def each_output_line(&block)
+      if @output_lines
+        @output_lines.each(&block)
+        return self
+      end
+
+      @output_lines = []
+      begin
+        fetch_output.each_line do |l|
+          @output_lines << l
+          block.call(l)
+        end
+      rescue
+        expire_cache!
+        raise
+      end
+      self
+    end
+
+    def fetch_output
+      `#{local_executable} --tasks 2> /dev/null`
+    end
   end
 
 end

data/lib/cape/version.rb

@@ -1,6 +1,6 @@
 module Cape
 
   # The version of Cape.
-  VERSION = '1.3.0'
+  VERSION = '1.4.0'
 
 end

data/spec/cape/rake_spec.rb

@@ -37,4 +37,79 @@ describe Cape::Rake do
 
     its(:remote_executable) { should == 'completely different' }
   end
+
+  describe 'caching: ' do
+    before :each do
+      subject.stub!(:fetch_output).and_return output
+    end
+
+    let(:output) {
+      <<-end_output
+rake foo # foo
+rake bar # bar
+rake baz # baz
+      end_output
+    }
+
+    describe '#each_task' do
+      it 'should build and use a cache' do
+        subject.should_receive(:fetch_output).once.and_return output
+        subject.each_task do |t|
+        end
+        subject.each_task do |t|
+        end
+      end
+
+      it 'should not expire the cache' do
+        subject.should_not_receive :expire_cache!
+        subject.each_task do |t|
+        end
+      end
+
+      it 'should expire the cache in the event of an error' do
+        subject.should_receive(:expire_cache!).once
+        begin
+          subject.each_task do |t|
+            raise 'pow!'
+          end
+        rescue
+        end
+      end
+
+      it 'should not swallow errors' do
+        lambda {
+          subject.each_task do |t|
+            raise ZeroDivisionError, 'pow!'
+          end
+        }.should raise_error(ZeroDivisionError, 'pow!')
+      end
+    end
+
+    describe '#expire_cache!' do
+      it 'should expire the cache' do
+        subject.should_receive(:fetch_output).twice.and_return output
+        subject.each_task do |t|
+        end
+        subject.expire_cache!
+        subject.each_task do |t|
+        end
+      end
+    end
+
+    describe '#local_executable=' do
+      describe 'with the same value' do
+        it 'should not expire the cache' do
+          subject.should_not_receive :expire_cache!
+          subject.local_executable = subject.local_executable
+        end
+      end
+
+      describe 'with a different value' do
+        it 'should expire the cache' do
+          subject.should_receive(:expire_cache!).once
+          subject.local_executable = subject.local_executable + ' foo'
+        end
+      end
+    end
+  end
 end

data/spec/cape_spec.rb

@@ -20,4 +20,10 @@ describe '#Cape' do
     Cape do
     end
   end
+
+  it 'should expire the Rake tasks cache when leaving the block' do
+    Cape do
+      rake.should_receive(:expire_cache!).once
+    end
+  end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cape
 version: !ruby/object:Gem::Version 
-  hash: 27
+  hash: 7
   prerelease: 
   segments: 
   - 1
-  - 3
+  - 4
   - 0
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors: 
 - Nils Jonsson
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-03 00:00:00 Z
+date: 2012-02-06 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: aruba