transpec 1.7.0 → 1.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c46495e8ece5679b985320ebfd8f026bd089fa0f
-  data.tar.gz: 3096577bb24dfc010639d541e8f3471a5568cba1
+  metadata.gz: 1947cf230f025d55b5b315662b49e4a0c6807199
+  data.tar.gz: 674a547e1df20db31651518199adc63889ae78b8
 SHA512:
-  metadata.gz: 81b9a2e1fe74cb4125f8ea25790198f528200973073a253c3d8facb5e036f883cc5dd9d7b519ac59705580f395a79baaac854f2055f96c31032087bd233b0237
-  data.tar.gz: 7c34385af11c5d9eee744d334141820f47436c907d26e8d1f66a7bb8391e3835698f24bdddc2a60e22635933c242fa3dbeb0b6855170b8324a6ed6735ec7f4d5
+  metadata.gz: ff571e89b51badd2ad5ba7d26beef1651ec37686597653e4e647e4c6931aebf36090269f0e2eeea8081813f7d8fe3579523c817fdc260c0fa9b1b6af241eea7a
+  data.tar.gz: a5d24e1e775928e1e412d415faeaa62dd6fceb7c0a93589b49bf6c723c2a625d9f686d51d498d707e2d76c2b76f944430a261c05bda4fee6216f45ac8ddc1993

data/.rubocop.yml

@@ -54,4 +54,4 @@ BracesAroundHashParameters:
 
 # TODO: Shorten to 100.
 ClassLength:
-  Max: 154
+  Max: 160

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v1.8.0
+
+* Conversion of `obj.stub(:message => value)` to `allow(obj).to receive(:message).and_return(value)` is now opt-in with `-t/--convert-stub-with-hash` option when `receive_messages` is unavailable
+
 ## v1.7.0
 
 * Support conversion of `any_instance` block

data/README.md

@@ -43,7 +43,7 @@ describe Account do
   describe '#renew' do
     context 'when the account is renewable and not closed' do
       before do
-        account.stub(:renewable? => true, :closed? => false)
+        account.stub(:closed?).and_return(false)
       end
 
       it 'does not raise error' do
@@ -79,7 +79,6 @@ describe Account do
   describe '#renew' do
     context 'when the account is renewable and not closed' do
       before do
-        allow(account).to receive(:renewable?).and_return(true)
         allow(account).to receive(:closed?).and_return(false)
       end
 
@@ -145,7 +144,7 @@ After the conversion, run `rspec` again and check whether everything is green:
 $ bundle exec rspec
 ```
 
-If it's green, commit the changes with an auto-generated message which describes the conversion summary:
+If it's green, commit the changes with an auto-generated message that describes the conversion summary:
 
 ```bash
 $ git commit -aeF .git/COMMIT_EDITMSG
@@ -270,6 +269,14 @@ Note that this is not same as `--keep deprecated` since this configures `yield_r
 
 See [Supported Conversions - `any_instance` implementation blocks](#any_instance-implementation-blocks) for more details.
 
+### `-t/--convert-stub-with-hash`
+
+Enable conversion of `obj.stub(:message => value)` to `allow(obj).to receive(:message).and_return(value)` when `receive_messages(:message => value)` is unavailable (prior to RSpec 3.0).
+It will be converted to multiple statements if the hash includes multiple pairs.
+This conversion is disabled by default.
+
+See [Supported Conversions - Method stubs with a hash argument](#method-stubs-with-a-hash-argument) for more details.
+
 ### `-p/--no-parentheses-matcher-arg`
 
 Suppress parenthesizing arguments of matchers when converting
@@ -401,6 +408,27 @@ The one-liner (implicit receiver) `should`:
 
 ## Supported Conversions
 
+* [Standard expectations](#standard-expectations)
+* [One-liner expectations](#one-liner-expectations)
+* [Operator matchers](#operator-matchers)
+* [Boolean matchers](#boolean-matchers)
+* [`be_close` matcher](#be_close-matcher)
+* [`have(n).items` matcher](#havenitems-matcher)
+* [One-liner expectations with `have(n).items` matcher](#one-liner-expectations-with-havenitems-matcher)
+* [Expectations on block](#expectations-on-block)
+* [Negative error expectations with specific error](#negative-error-expectations-with-specific-error)
+* [Message expectations](#message-expectations)
+* [Message expectations that are actually method stubs](#message-expectations-that-are-actually-method-stubs)
+* [Method stubs](#method-stubs)
+* [Method stubs with a hash argument](#method-stubs-with-a-hash-argument)
+* [Deprecated method stub aliases](#deprecated-method-stub-aliases)
+* [Method stubs with deprecated specification of number of times](#method-stubs-with-deprecated-specification-of-number-of-times)
+* [`any_instance` implementation blocks](#any_instance-implementation-blocks)
+* [Deprecated test double aliases](#deprecated-test-double-aliases)
+* [Expectations on attribute of subject with `its`](#expectations-on-attribute-of-subject-with-its)
+* [Current example object](#current-example-object)
+* [Custom matcher DSL](#custom-matcher-dsl)
+
 ### Standard expectations
 
 Targets:
@@ -709,8 +737,6 @@ Targets:
 obj.stub(:foo)
 obj.stub!(:foo)
 
-obj.stub(:foo => 1, :bar => 2)
-
 obj.stub_chain(:foo, :bar, :baz)
 
 Klass.any_instance.stub(:foo)
@@ -721,13 +747,6 @@ Will be converted to:
 ```ruby
 allow(obj).to receive(:foo)
 
-# If the target project's RSpec is prior to 3.0.0.beta1
-allow(obj).to receive(:foo).and_return(1)
-allow(obj).to receive(:bar).and_return(2)
-
-# If the target project's RSpec is 3.0.0.beta1 or later
-allow(obj).to receive_messages(:foo => 1, :bar => 2)
-
 # Conversion from `stub_chain` to `receive_message_chain` is available
 # only if the target project's RSpec is 3.0.0.beta2 (not yet released) or later
 allow(obj).to receive_message_chain(:foo, :bar, :baz)
@@ -735,29 +754,51 @@ allow(obj).to receive_message_chain(:foo, :bar, :baz)
 allow_any_instance_of(Klass).to receive(:foo)
 ```
 
-#### No replacement for `unstub`
-
 There's no replacement for `unstub` in the `expect` syntax. See [this discussion](https://github.com/rspec/rspec-mocks/issues/153#issuecomment-12208638) for more details.
 
-#### Steps to upgrade `obj.stub(:foo => 1, :bar => 2)`
+* This conversion can be disabled by: `--keep stub`
+* Deprecation: deprecated since RSpec 3.0
+* See also:
+    * [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
+    * [Bring back stub_chain (receive_message_chain) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/464)
+
+### Method stubs with a hash argument
 
-`allow(obj).to receive_messages(:foo => 1, :bar => 2)` which is designed to be the replacement for `obj.stub(:foo => 1, :bar => 2)` is available from RSpec 3.0 (though [it's now being considered to be backported to RSpec 2.99](https://github.com/rspec/rspec-mocks/issues/454)). So, in [the upgrade path to RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#the_upgrade_path), if you want to convert them with keeping the syntax correspondence, you need to follow these steps:
+Targets:
+
+```ruby
+obj.stub(:foo => 1, :bar => 2)
+```
+
+Will be converted to:
+
+```ruby
+# If the target project's RSpec is 3.0.0.beta1 or later
+allow(obj).to receive_messages(:foo => 1, :bar => 2)
+
+# If the target project's RSpec is prior to 3.0.0.beta1
+obj.stub(:foo => 1, :bar => 2) # No conversion
+
+# If the target project's RSpec is prior to 3.0.0.beta1
+# and `--convert-stub-with-hash` is specified
+allow(obj).to receive(:foo).and_return(1)
+allow(obj).to receive(:bar).and_return(2)
+```
+
+`allow(obj).to receive_messages(:foo => 1, :bar => 2)` which is designed to be the replacement for `obj.stub(:foo => 1, :bar => 2)` is available from RSpec 3.0.
+
+So, if you're going to use Transpec in [the upgrade path to RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#the_upgrade_path), you may need to follow these steps:
 
 1. Upgrade to RSpec 2.99
-2. Run `transpec --keep stub`
+2. Run `transpec` (at this time `obj.stub(:message => value)` won't be converted)
 3. Upgrade to RSpec 3.0
-4. Run `transpec`
+4. Run `transpec` again to convert `obj.stub(:message => value)`
 
-Otherwise `obj.stub(:foo => 1, :bar => 2)` will be converted to two `allow(obj).to receive(...).and_return(...)` expressions on RSpec 2.99.
-
----
+Or if you're going to stay RSpec 2.14 for now but want to convert all `stub` to `allow` statements, run `transpec` with `--convert-stub-with-hash` option. Note that once the conversion is done, multiple statements cannot be merged into a `receive_messages`.
 
 * This conversion can be disabled by: `--keep stub`
 * Deprecation: deprecated since RSpec 3.0
-* See also:
-    * [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
-    * [allow receive with multiple methods · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/368)
-    * [Bring back stub_chain (receive_message_chain) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/464)
+* See also: [allow receive with multiple methods · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/368)
 
 ### Deprecated method stub aliases
 

data/README.md.erb

@@ -45,7 +45,7 @@ describe Account do
   describe '#renew' do
     context 'when the account is renewable and not closed' do
       before do
-        account.stub(:renewable? => true, :closed? => false)
+        account.stub(:closed?).and_return(false)
       end
 
       it 'does not raise error' do
@@ -118,7 +118,7 @@ After the conversion, run `rspec` again and check whether everything is green:
 $ bundle exec rspec
 ```
 
-If it's green, commit the changes with an auto-generated message which describes the conversion summary:
+If it's green, commit the changes with an auto-generated message that describes the conversion summary:
 
 ```bash
 $ git commit -aeF .git/COMMIT_EDITMSG
@@ -261,6 +261,14 @@ Note that this is not same as `--keep deprecated` since this configures `yield_r
 
 See [Supported Conversions - `any_instance` implementation blocks](#any_instance-implementation-blocks) for more details.
 
+### `-t/--convert-stub-with-hash`
+
+Enable conversion of `obj.stub(:message => value)` to `allow(obj).to receive(:message).and_return(value)` when `receive_messages(:message => value)` is unavailable (prior to RSpec 3.0).
+It will be converted to multiple statements if the hash includes multiple pairs.
+This conversion is disabled by default.
+
+See [Supported Conversions - Method stubs with a hash argument](#method-stubs-with-a-hash-argument) for more details.
+
 ### `-p/--no-parentheses-matcher-arg`
 
 Suppress parenthesizing arguments of matchers when converting
@@ -397,6 +405,26 @@ The one-liner (implicit receiver) `should`:
 
 ## Supported Conversions
 
+<%=
+
+sections = text.each_line.slice_before(/^## /)
+
+supported_conversion_section = sections.find do |section|
+  section.first.include?('Supported Conversions')
+end
+
+titles = supported_conversion_section.map do |line|
+  next unless line.start_with?('### ')
+  line.sub(/^[#\s]*/, '').chomp
+end.compact
+
+titles.map do |title|
+  anchor = '#' + title.gsub(/[^\w_\- ]/, '').downcase.gsub(' ', '-')
+  "* [#{title}](#{anchor})"
+end.join("\n")
+
+%>
+
 ### Standard expectations
 
 Targets:
@@ -705,8 +733,6 @@ Targets:
 obj.stub(:foo)
 obj.stub!(:foo)
 
-obj.stub(:foo => 1, :bar => 2)
-
 obj.stub_chain(:foo, :bar, :baz)
 
 Klass.any_instance.stub(:foo)
@@ -717,13 +743,6 @@ Will be converted to:
 ```ruby
 allow(obj).to receive(:foo)
 
-# If the target project's RSpec is prior to <%= Transpec::RSpecVersion.receive_messages_available_version %>
-allow(obj).to receive(:foo).and_return(1)
-allow(obj).to receive(:bar).and_return(2)
-
-# If the target project's RSpec is <%= Transpec::RSpecVersion.receive_messages_available_version %> or later
-allow(obj).to receive_messages(:foo => 1, :bar => 2)
-
 # Conversion from `stub_chain` to `receive_message_chain` is available
 # only if the target project's RSpec is <%= Transpec::RSpecVersion.receive_message_chain_available_version %> (not yet released) or later
 allow(obj).to receive_message_chain(:foo, :bar, :baz)
@@ -731,29 +750,51 @@ allow(obj).to receive_message_chain(:foo, :bar, :baz)
 allow_any_instance_of(Klass).to receive(:foo)
 ```
 
-#### No replacement for `unstub`
-
 There's no replacement for `unstub` in the `expect` syntax. See [this discussion](https://github.com/rspec/rspec-mocks/issues/153#issuecomment-12208638) for more details.
 
-#### Steps to upgrade `obj.stub(:foo => 1, :bar => 2)`
+* This conversion can be disabled by: `--keep stub`
+* Deprecation: deprecated since RSpec 3.0
+* See also:
+    * [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
+    * [Bring back stub_chain (receive_message_chain) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/464)
+
+### Method stubs with a hash argument
+
+Targets:
+
+```ruby
+obj.stub(:foo => 1, :bar => 2)
+```
+
+Will be converted to:
+
+```ruby
+# If the target project's RSpec is <%= Transpec::RSpecVersion.receive_messages_available_version %> or later
+allow(obj).to receive_messages(:foo => 1, :bar => 2)
+
+# If the target project's RSpec is prior to <%= Transpec::RSpecVersion.receive_messages_available_version %>
+obj.stub(:foo => 1, :bar => 2) # No conversion
+
+# If the target project's RSpec is prior to <%= Transpec::RSpecVersion.receive_messages_available_version %>
+# and `--convert-stub-with-hash` is specified
+allow(obj).to receive(:foo).and_return(1)
+allow(obj).to receive(:bar).and_return(2)
+```
 
-`allow(obj).to receive_messages(:foo => 1, :bar => 2)` which is designed to be the replacement for `obj.stub(:foo => 1, :bar => 2)` is available from RSpec 3.0 (though [it's now being considered to be backported to RSpec 2.99](https://github.com/rspec/rspec-mocks/issues/454)). So, in [the upgrade path to RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#the_upgrade_path), if you want to convert them with keeping the syntax correspondence, you need to follow these steps:
+`allow(obj).to receive_messages(:foo => 1, :bar => 2)` which is designed to be the replacement for `obj.stub(:foo => 1, :bar => 2)` is available from RSpec 3.0.
+
+So, if you're going to use Transpec in [the upgrade path to RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#the_upgrade_path), you may need to follow these steps:
 
 1. Upgrade to RSpec 2.99
-2. Run `transpec --keep stub`
+2. Run `transpec` (at this time `obj.stub(:message => value)` won't be converted)
 3. Upgrade to RSpec 3.0
-4. Run `transpec`
-
-Otherwise `obj.stub(:foo => 1, :bar => 2)` will be converted to two `allow(obj).to receive(...).and_return(...)` expressions on RSpec 2.99.
+4. Run `transpec` again to convert `obj.stub(:message => value)`
 
----
+Or if you're going to stay RSpec 2.14 for now but want to convert all `stub` to `allow` statements, run `transpec` with `--convert-stub-with-hash` option. Note that once the conversion is done, multiple statements cannot be merged into a `receive_messages`.
 
 * This conversion can be disabled by: `--keep stub`
 * Deprecation: deprecated since RSpec 3.0
-* See also:
-    * [RSpec's new message expectation syntax - Tea is awesome.](http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/)
-    * [allow receive with multiple methods · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/368)
-    * [Bring back stub_chain (receive_message_chain) · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/464)
+* See also: [allow receive with multiple methods · rspec/rspec-mocks](https://github.com/rspec/rspec-mocks/issues/368)
 
 ### Deprecated method stub aliases
 

data/lib/transpec/cli.rb

@@ -9,6 +9,7 @@ require 'transpec/option_parser'
 require 'transpec/project'
 require 'transpec/report'
 require 'rainbow'
+require 'rainbow/ext/string' unless String.method_defined?(:color)
 
 module Transpec
   class CLI
@@ -111,7 +112,7 @@ module Transpec
       Git.write_commit_message(commit_message.to_s)
 
       puts
-      puts 'A commit message which describes the conversion summary was generated to'.color(:cyan)
+      puts 'A commit message that describes the conversion summary was generated to'.color(:cyan)
       puts '.git/COMMIT_EDITMSG. To use the message, type the following command for'.color(:cyan)
       puts 'the next commit:'.color(:cyan)
       puts '    git commit -eF .git/COMMIT_EDITMSG'

data/lib/transpec/configuration.rb

@@ -16,6 +16,7 @@ module Transpec
       [:convert_deprecated_method,                             true],
       [:parenthesize_matcher_arg,                              true],
       [:add_receiver_arg_to_any_instance_implementation_block, true],
+      [:convert_stub_with_hash_to_stub_and_return,             false],
       [:forced,                                                false],
       [:skip_dynamic_analysis,                                 false]
     ].freeze

data/lib/transpec/converter.rb

@@ -111,7 +111,13 @@ module Transpec
 
     def process_method_stub(method_stub)
       if @configuration.convert_stub?
-        method_stub.allowize!(@rspec_version)
+        if !method_stub.hash_arg? ||
+           @rspec_version.receive_messages_available? ||
+           @configuration.convert_stub_with_hash_to_stub_and_return?
+          method_stub.allowize!(@rspec_version)
+        elsif @configuration.convert_deprecated_method?
+          method_stub.convert_deprecated_method!
+        end
       elsif @configuration.convert_deprecated_method?
         method_stub.convert_deprecated_method!
       end

data/lib/transpec/option_parser.rb

@@ -5,6 +5,7 @@ require 'transpec/git'
 require 'transpec/version'
 require 'optparse'
 require 'rainbow'
+require 'rainbow/ext/string' unless String.respond_to?(:color)
 
 # rubocop:disable ClassLength
 
@@ -86,6 +87,10 @@ module Transpec
         @configuration.add_receiver_arg_to_any_instance_implementation_block = false
       end
 
+      define_option('-t', '--convert-stub-with-hash') do
+        @configuration.convert_stub_with_hash_to_stub_and_return = true
+      end
+
       define_option('-p', '--no-parentheses-matcher-arg') do
         @configuration.parenthesize_matcher_arg = false
       end
@@ -162,6 +167,15 @@ module Transpec
           "#{'any_instance'.underline} implementation blocks as the",
           'first block argument.'
         ],
+        '-t' => [
+          "Enable conversion of #{'obj.stub(:msg => val)'.underline} to",
+          "#{'allow(obj).to receive(:msg).and_return(val)'.underline}",
+          "when #{'receive_messages(:msg => val)'.underline} is",
+          'unavailable (prior to RSpec 3.0). It will be',
+          'converted to multiple statements if the hash',
+          'includes multiple pairs. This conversion is',
+          'disabled by default.'
+        ],
         '-p' => [
           'Suppress parenthesizing arguments of matchers',
           "when converting #{'should'.underline} with operator matcher",
@@ -190,7 +204,7 @@ module Transpec
       args.reject do |arg|
         case arg
         when '-m', '--generate-commit-message'
-          warn 'DEPRECATION: -m/--generate-commit-message option is deprecated. ' +
+          warn 'DEPRECATION: -m/--generate-commit-message option is deprecated. ' \
                'A commit message will always be generated.'
           true
         else

data/lib/transpec/syntax/have.rb

@@ -2,11 +2,12 @@
 
 require 'transpec/syntax'
 require 'transpec/syntax/mixin/send'
+require 'transpec/syntax/mixin/owned_matcher'
 
 module Transpec
   class Syntax
     class Have < Syntax
-      include Mixin::Send
+      include Mixin::Send, Mixin::OwnedMatcher
 
       # String#count is not query method, and there's no way to determine
       # whether a method is query method.
@@ -19,10 +20,6 @@ module Transpec
 
       attr_reader :expectation
 
-      def self.standalone?
-        false
-      end
-
       def self.target_method?(have_node, items_method_name)
         return false unless have_node
         have_receiver_node, have_method_name, *_ = *have_node
@@ -30,14 +27,6 @@ module Transpec
         [:have, :have_exactly, :have_at_least, :have_at_most].include?(have_method_name)
       end
 
-      def initialize(node, expectation, source_rewriter = nil, runtime_data = nil, report = nil)
-        @node = node
-        @expectation = expectation
-        @source_rewriter = source_rewriter
-        @runtime_data = runtime_data
-        @report = report || Report.new
-      end
-
       add_dynamic_analysis_request do |rewriter|
         DynamicInspector.register_request(self, rewriter)
       end