cape 1.6.2 → 1.7.0

data/spec/cape/deprecation/base_sharedspec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+require 'cape/deprecation/base'
+
+shared_examples_for "a #{Cape::Deprecation::Base.name}" do
+  describe '-- without specified attributes --' do
+    its(:stream) { should == $stderr }
+  end
+
+  describe '-- with a different #stream --' do
+    before :each do
+      subject.stream = different_stream
+    end
+
+    let(:different_stream) { StringIO.new }
+
+    its(:stream) { should == different_stream }
+  end
+end

data/spec/cape/deprecation/capistrano_deprecated_define_rake_wrapper_spec.rb

@@ -0,0 +1,157 @@
+require 'spec_helper'
+require 'cape/deprecation/capistrano_deprecated_define_rake_wrapper'
+require 'cape/deprecation/base_sharedspec'
+require 'cape/xterm'
+
+describe Cape::Deprecation::CapistranoDeprecatedDefineRakeWrapper do
+  it_should_behave_like "a #{Cape::Deprecation::Base.name}"
+
+  let(:deprecation_preamble) {
+    Cape::XTerm.bold_and_foreground_red('*** DEPRECATED:') + ' '
+  }
+
+  describe '-- without specified attributes --' do
+    its(:formatted_message) {
+      should == deprecation_preamble                       +
+                Cape::XTerm.bold('`define_rake_wrapper`. ' +
+                                 'Use this instead: `define_rake_wrapper`')
+    }
+  end
+
+  describe '-- with #task' do
+    before :each do
+      subject.task = {:name => :foo}
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                                     +
+                Cape::XTerm.bold('`define_rake_wrapper {:name=>:foo}`. ' +
+                                 'Use this instead: '                    +
+                                 '`define_rake_wrapper {:name=>:foo}`')
+    }
+
+    describe 'and with #named_arguments' do
+      before :each do
+        subject.named_arguments = {:bar => :baz}
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                                +
+                  Cape::XTerm.bold('`'                                                +
+                                    'define_rake_wrapper {:name=>:foo}, '             +
+                                                         ':bar => :baz'               +
+                                   '`. '                                              +
+                                   'Use this instead: '                               +
+                                   '`'                                                +
+                                    'define_rake_wrapper({:name=>:foo}) { |recipes| ' +
+                                      'recipes.options[:bar] = :baz '                 +
+                                    '}'                                               +
+                                   '`')
+      }
+
+      describe 'and with #env --' do
+        before :each do
+          subject.env['QUX'] = 'quux'
+        end
+
+        its(:formatted_message) {
+          should == deprecation_preamble                                                +
+                    Cape::XTerm.bold('`'                                                +
+                                      'define_rake_wrapper({:name=>:foo}, '             +
+                                                          ':bar => :baz) { |env| '      +
+                                        'env["QUX"] = "quux" '                          +
+                                      '}'                                               +
+                                     '`. '                                              +
+                                     'Use this instead: '                               +
+                                     '`'                                                +
+                                      'define_rake_wrapper({:name=>:foo}) { |recipes| ' +
+                                        'recipes.options[:bar] = :baz; '                +
+                                        'recipes.env["QUX"] = "quux" '                  +
+                                      '}'                                               +
+                                     '`')
+        }
+      end
+    end
+
+    describe 'and with #env --' do
+      before :each do
+        subject.env['BAR'] = 'baz'
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                                +
+                  Cape::XTerm.bold('`'                                                +
+                                    'define_rake_wrapper({:name=>:foo}) { |env| '     +
+                                      'env["BAR"] = "baz" '                           +
+                                    '}'                                               +
+                                   '`. '                                              +
+                                   'Use this instead: '                               +
+                                   '`'                                                +
+                                    'define_rake_wrapper({:name=>:foo}) { |recipes| ' +
+                                      'recipes.env["BAR"] = "baz" '                   +
+                                    '}'                                               +
+                                   '`')
+      }
+    end
+  end
+
+  describe '-- with #named_arguments' do
+    before :each do
+      subject.named_arguments = {:foo => :bar}
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                                    +
+                Cape::XTerm.bold('`define_rake_wrapper :foo => :bar`. ' +
+                                 'Use this instead: '                   +
+                                 '`'                                    +
+                                  'define_rake_wrapper { |recipes| '    +
+                                    'recipes.options[:foo] = :bar '     +
+                                  '}'                                   +
+                                 '`')
+    }
+
+    describe 'and with #env --' do
+      before :each do
+        subject.env['BAZ'] = 'qux'
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                           +
+                  Cape::XTerm.bold('`'                                           +
+                                    'define_rake_wrapper(:foo => :bar) { |env| ' +
+                                      'env["BAZ"] = "qux" '                      +
+                                    '}'                                          +
+                                   '`. '                                         +
+                                   'Use this instead: '                          +
+                                   '`'                                           +
+                                    'define_rake_wrapper { |recipes| '           +
+                                      'recipes.options[:foo] = :bar; '           +
+                                      'recipes.env["BAZ"] = "qux" '              +
+                                    '}'                                          +
+                                   '`')
+      }
+    end
+  end
+
+  describe '-- with #env --' do
+    before :each do
+      subject.env['FOO'] = 'bar'
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                                 +
+                Cape::XTerm.bold('`'                                 +
+                                  'define_rake_wrapper { |env| '     +
+                                    'env["FOO"] = "bar" '            +
+                                  '}'                                +
+                                 '`. '                               +
+                                 'Use this instead: '                +
+                                 '`'                                 +
+                                  'define_rake_wrapper { |recipes| ' +
+                                    'recipes.env["FOO"] = "bar" '    +
+                                  '}'                                +
+                                 '`')
+    }
+  end
+end

data/spec/cape/deprecation/dsl_deprecated_mirror_rake_tasks_spec.rb

@@ -0,0 +1,153 @@
+require 'spec_helper'
+require 'cape/deprecation/dsl_deprecated_mirror_rake_tasks'
+require 'cape/deprecation/base_sharedspec'
+require 'cape/xterm'
+
+describe Cape::Deprecation::DSLDeprecatedMirrorRakeTasks do
+  it_should_behave_like "a #{Cape::Deprecation::Base.name}"
+
+  let(:deprecation_preamble) {
+    Cape::XTerm.bold_and_foreground_red('*** DEPRECATED:') + ' '
+  }
+
+  describe '-- without specified attributes --' do
+    its(:formatted_message) {
+      should == deprecation_preamble                     +
+                Cape::XTerm.bold('`mirror_rake_tasks`. ' +
+                                 'Use this instead: `mirror_rake_tasks`')
+    }
+  end
+
+  describe '-- with #task_expression' do
+    before :each do
+      subject.task_expression = :foo
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                          +
+                Cape::XTerm.bold('`mirror_rake_tasks :foo`. ' +
+                                 'Use this instead: `mirror_rake_tasks :foo`')
+    }
+
+    describe 'and with #options' do
+      before :each do
+        subject.options = {:bar => :baz}
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                        +
+                  Cape::XTerm.bold('`mirror_rake_tasks :foo, :bar => :baz`. ' +
+                                   'Use this instead: '                       +
+                                   '`'                                        +
+                                    'mirror_rake_tasks(:foo) { |recipes| '    +
+                                      'recipes.options[:bar] = :baz '         +
+                                    '}'                                       +
+                                   '`')
+      }
+
+      describe 'and with #env --' do
+        before :each do
+          subject.env['QUX'] = 'quux'
+        end
+
+        its(:formatted_message) {
+          should == deprecation_preamble                                         +
+                    Cape::XTerm.bold('`'                                         +
+                                      'mirror_rake_tasks(:foo, '                 +
+                                                        ':bar => :baz) { |env| ' +
+                                        'env["QUX"] = "quux" '                   +
+                                      '}'                                        +
+                                     '`. '                                       +
+                                     'Use this instead: '                        +
+                                     '`'                                         +
+                                      'mirror_rake_tasks(:foo) { |recipes| '     +
+                                        'recipes.options[:bar] = :baz; '         +
+                                        'recipes.env["QUX"] = "quux" '           +
+                                      '}'                                        +
+                                     '`')
+        }
+      end
+    end
+
+    describe 'and with #env --' do
+      before :each do
+        subject.env['BAR'] = 'baz'
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                     +
+                  Cape::XTerm.bold('`'                                     +
+                                    'mirror_rake_tasks(:foo) { |env| '     +
+                                      'env["BAR"] = "baz" '                +
+                                    '}'                                    +
+                                   '`. '                                   +
+                                   'Use this instead: '                    +
+                                   '`'                                     +
+                                    'mirror_rake_tasks(:foo) { |recipes| ' +
+                                      'recipes.env["BAR"] = "baz" '        +
+                                    '}'                                    +
+                                   '`')
+      }
+    end
+  end
+
+  describe '-- with #options' do
+    before :each do
+      subject.options = {:foo => :bar}
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                                  +
+                Cape::XTerm.bold('`mirror_rake_tasks :foo => :bar`. ' +
+                                 'Use this instead: '                 +
+                                 '`'                                  +
+                                  'mirror_rake_tasks { |recipes| '    +
+                                    'recipes.options[:foo] = :bar '   +
+                                  '}'                                 +
+                                 '`')
+    }
+
+    describe 'and with #env --' do
+      before :each do
+        subject.env['BAZ'] = 'qux'
+      end
+
+      its(:formatted_message) {
+        should == deprecation_preamble                                         +
+                  Cape::XTerm.bold('`'                                         +
+                                    'mirror_rake_tasks(:foo => :bar) { |env| ' +
+                                      'env["BAZ"] = "qux" '                    +
+                                    '}'                                        +
+                                   '`. '                                       +
+                                   'Use this instead: '                        +
+                                   '`'                                         +
+                                    'mirror_rake_tasks { |recipes| '           +
+                                      'recipes.options[:foo] = :bar; '         +
+                                      'recipes.env["BAZ"] = "qux" '            +
+                                    '}'                                        +
+                                   '`')
+      }
+    end
+  end
+
+  describe '-- with #env --' do
+    before :each do
+      subject.env['FOO'] = 'bar'
+    end
+
+    its(:formatted_message) {
+      should == deprecation_preamble                               +
+                Cape::XTerm.bold('`'                               +
+                                  'mirror_rake_tasks { |env| '     +
+                                    'env["FOO"] = "bar" '          +
+                                  '}'                              +
+                                 '`. '                             +
+                                 'Use this instead: '              +
+                                 '`'                               +
+                                  'mirror_rake_tasks { |recipes| ' +
+                                    'recipes.env["FOO"] = "bar" '  +
+                                  '}'                              +
+                                 '`')
+    }
+  end
+end

data/spec/cape/dsl_deprecated_spec.rb

@@ -0,0 +1,307 @@
+require 'spec_helper'
+require 'cape/dsl'
+require 'cape/dsl_deprecated'
+require 'cape/capistrano'
+require 'cape/core_ext/hash'
+require 'cape/core_ext/symbol'
+require 'cape/rake'
+require 'cape/xterm'
+
+describe Cape::DSLDeprecated do
+  subject do
+    Object.new.tap do |o|
+      o.extend Cape::DSL
+      o.extend described_class
+    end
+  end
+
+  let(:mock_capistrano) { mock(Cape::Capistrano).as_null_object }
+
+  let(:mock_rake) { mock(Cape::Rake).as_null_object }
+
+  let(:task_expression) { 'task:expression' }
+
+  before :each do
+    Cape::Capistrano.stub!(:new).and_return mock_capistrano
+    Cape::Rake.      stub!(:new).and_return mock_rake
+    subject.deprecation.stream = StringIO.new
+  end
+
+  describe '-- when sent #each_rake_task --' do
+    def do_each_rake_task(&block)
+      subject.each_rake_task(task_expression, &block)
+    end
+
+    it 'should delegate to Rake#each_task' do
+      mock_rake.should_receive(:each_task).
+                with(task_expression).
+                and_yield({:name => task_expression})
+      do_each_rake_task do |t|
+        t.should == {:name => task_expression}
+      end
+    end
+
+    it 'should return itself' do
+      do_each_rake_task.should == subject
+    end
+  end
+
+  describe '-- when sent #mirror_rake_tasks' do
+    before :each do
+      mock_rake.stub!(:each_task).and_yield({:name => task_expression})
+      subject.stub! :raise_unless_capistrano
+    end
+
+    def do_mirror_rake_tasks(*arguments, &block)
+      subject.mirror_rake_tasks(*arguments, &block)
+    end
+
+    let(:deprecation_preamble) {
+      Cape::XTerm.bold_and_foreground_red('*** DEPRECATED:') + ' '
+    }
+
+    describe 'with two scalar arguments --' do
+      specify do
+        lambda {
+          do_mirror_rake_tasks task_expression, task_expression
+        }.should raise_error(ArgumentError,
+                             'wrong number of arguments (2 for 0 or 1, plus ' +
+                             'an options hash)')
+      end
+    end
+
+    shared_examples_for "a successful call (#{Cape::DSLDeprecated.name})" do |task_expression_in_use,
+                                                                              options_in_use|
+      specify 'by collecting Rake#each_task' do
+        mock_rake.should_receive(:each_task).with task_expression_in_use
+        do_mirror_rake_tasks
+      end
+
+      specify 'by verifying that Capistrano is in use' do
+        subject.should_receive :raise_unless_capistrano
+        do_mirror_rake_tasks
+      end
+
+      describe 'by sending Capistrano#define_rake_wrapper for Rake#each_task' do
+        specify 'with the expected task' do
+          mock_capistrano.should_receive(:define_rake_wrapper).with do |task,
+                                                                        named_arguments|
+            task == {:name => task_expression}
+          end
+          do_mirror_rake_tasks
+        end
+
+        specify 'with the expected named options' do
+          mock_capistrano.should_receive(:define_rake_wrapper).with do |task,
+                                                                        named_arguments|
+            named_arguments.keys.sort == ([:binding] + options_in_use.keys).sort
+          end
+          do_mirror_rake_tasks
+        end
+
+        specify 'with a :binding option' do
+          mock_capistrano.should_receive(:define_rake_wrapper).with do |task,
+                                                                        named_arguments|
+            named_arguments[:binding].is_a? Binding
+          end
+          do_mirror_rake_tasks
+        end
+
+        specify 'with any provided extra options' do
+          mock_capistrano.should_receive(:define_rake_wrapper).with do |task,
+                                                                        named_arguments|
+            named_arguments.slice(*options_in_use.keys) == options_in_use
+          end
+          do_mirror_rake_tasks
+        end
+      end
+
+      specify 'by returning itself' do
+        do_mirror_rake_tasks.should == subject
+      end
+    end
+
+    describe 'with one scalar argument, an options hash, and a block --' do
+      def do_mirror_rake_tasks
+        super 'task:expression', :bar => :baz do |env|
+          env['AN_ENV_VAR'] = 'an environment variable'
+        end
+      end
+
+      should_behave_like "a successful call (#{Cape::DSLDeprecated.name})",
+                         'task:expression',
+                         :bar => :baz
+
+      it 'should print the expected deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should == deprecation_preamble                                                  +
+                                                    Cape::XTerm.bold('`'                                                  +
+                                                                      'mirror_rake_tasks "task:expression", '             +
+                                                                                        ':bar => :baz'                    +
+                                                                     '`. '                                                +
+                                                                     'Use this instead: '                                 +
+                                                                     '`'                                                  +
+                                                                      'mirror_rake_tasks("task:expression") { |recipes| ' +
+                                                                        'recipes.options[:bar] = :baz '                   +
+                                                                      '}'                                                 +
+                                                                     '`')                                                 +
+                                                    "\n"
+      end
+    end
+
+    describe 'with one scalar argument and an options hash --' do
+      def do_mirror_rake_tasks
+        super 'task:expression', :bar => :baz
+      end
+
+      should_behave_like "a successful call (#{Cape::DSLDeprecated.name})",
+                         'task:expression',
+                         :bar => :baz
+
+      it 'should print the expected deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should == deprecation_preamble                                                  +
+                                                    Cape::XTerm.bold('`'                                                  +
+                                                                      'mirror_rake_tasks "task:expression", '             +
+                                                                                        ':bar => :baz'                    +
+                                                                     '`. '                                                +
+                                                                     'Use this instead: '                                 +
+                                                                     '`'                                                  +
+                                                                      'mirror_rake_tasks("task:expression") { |recipes| ' +
+                                                                        'recipes.options[:bar] = :baz '                   +
+                                                                      '}'                                                 +
+                                                                     '`')                                                 +
+                                                    "\n"
+      end
+    end
+
+    describe 'with an options hash and a block --' do
+      def do_mirror_rake_tasks
+        super :bar => :baz do |env|
+          env['AN_ENV_VAR'] = 'an environment variable'
+        end
+      end
+
+      should_behave_like "a successful call (#{Cape::DSLDeprecated.name})",
+                         nil,
+                         :bar => :baz
+
+      it 'should print the expected deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should == deprecation_preamble                                +
+                                                    Cape::XTerm.bold('`'                                +
+                                                                      'mirror_rake_tasks :bar => :baz'  +
+                                                                     '`. '                              +
+                                                                     'Use this instead: '               +
+                                                                     '`'                                +
+                                                                      'mirror_rake_tasks { |recipes| '  +
+                                                                        'recipes.options[:bar] = :baz ' +
+                                                                      '}'                               +
+                                                                     '`')                               +
+                                                    "\n"
+      end
+    end
+
+    describe 'with an options hash --' do
+      def do_mirror_rake_tasks
+        super :bar => :baz
+      end
+
+      should_behave_like "a successful call (#{Cape::DSLDeprecated.name})",
+                         nil,
+                         :bar => :baz
+
+      it 'should print the expected deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should == deprecation_preamble                                +
+                                                    Cape::XTerm.bold('`'                                +
+                                                                      'mirror_rake_tasks :bar => :baz'  +
+                                                                     '`. '                              +
+                                                                     'Use this instead: '               +
+                                                                     '`'                                +
+                                                                      'mirror_rake_tasks { |recipes| '  +
+                                                                        'recipes.options[:bar] = :baz ' +
+                                                                      '}'                               +
+                                                                     '`')                               +
+                                                    "\n"
+      end
+    end
+
+    describe 'with one scalar argument and a block --' do
+      def do_mirror_rake_tasks
+        super 'task:expression' do |env|
+          env['AN_ENV_VAR'] = 'an environment variable'
+        end
+      end
+
+      should_behave_like("a successful call (#{Cape::DSLDeprecated.name})",
+                         'task:expression',
+                         {})
+
+      it 'should print no deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should be_empty
+      end
+    end
+
+    describe 'with one scalar argument --' do
+      def do_mirror_rake_tasks
+        super 'task:expression'
+      end
+
+      should_behave_like("a successful call (#{Cape::DSLDeprecated.name})",
+                         'task:expression',
+                         {})
+
+      it 'should print no deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should be_empty
+      end
+    end
+
+    describe 'without arguments --' do
+      def do_mirror_rake_tasks
+        super
+      end
+
+      should_behave_like("a successful call (#{Cape::DSLDeprecated.name})",
+                         nil,
+                         {})
+
+      it 'should print no deprecation messages to stderr' do
+        do_mirror_rake_tasks
+        subject.deprecation.stream.string.should be_empty
+      end
+    end
+  end
+
+  describe '-- when sent #local_rake_executable --' do
+    before :each do
+      mock_rake.stub!(:local_executable).and_return 'foo'
+    end
+
+    it 'should delegate to Rake#local_executable' do
+      mock_rake.should_receive :local_executable
+      subject.local_rake_executable
+    end
+
+    it 'should return the result of Rake#local_executable' do
+      subject.local_rake_executable.should == 'foo'
+    end
+  end
+
+  describe '-- when sent #remote_rake_executable --' do
+    before :each do
+      mock_rake.stub!(:remote_executable).and_return 'foo'
+    end
+
+    it 'should delegate to Rake#remote_executable' do
+      mock_rake.should_receive :remote_executable
+      subject.remote_rake_executable
+    end
+
+    it 'should return the result of Rake#remote_executable' do
+      subject.remote_rake_executable.should == 'foo'
+    end
+  end
+end