transpec 2.3.0 → 2.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3cc32f4f45ab036ddecaefb46245014a4713fdee
-  data.tar.gz: 2b7feec59ef424cb3df9d47145683fcc6c496b9e
+  metadata.gz: c90c3e229024fe5588256af42c0ac3fdc30f146a
+  data.tar.gz: 3d786286cac9c9298c9aaa073288ad2bb1e83a50
 SHA512:
-  metadata.gz: b53e41a17861208c396e6955152123dca5a623041265987c8f03caf3f3bb14fb28ddaabcd1f46dad918a477ad499e155e801e042ab3b6464ccc46d0ebdb7f361
-  data.tar.gz: 3b3cf2d94a9a6adfd671235d639ae65a2cf8c8887acccb28b6b4eee9c9dabd266a84d195f680b425410685f466a3e726f07610e9045750b6e3377427044d3002
+  metadata.gz: 28e8ac6dacd5834196381b9510bd3b4d8394f084eedfb584407a7a6234d68cd3fe6da89957a7b7be2f7481c0f3ab0aa43e25655554885bd3258a626faf59f793
+  data.tar.gz: ee3405cacf7e33bcfe378ebc55af52e9b69d4e2041bc78cdbb8e363706ae0b9011f65db64c6a8b94ea69a5291b0aa9e74c0827fb50254baa974a6d3d19d47c7f

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Development
 
+## v2.3.1
+
+* Remove conversion support for non-existent configuration option `backtrace_cleaner=`.
+* Add missing way to disable conversion of deprecated configuration options with `--keep deprecated`.
+
 ## v2.3.0
 
 * Report configuration modifications of `RSpec.configure` in the final summary.

data/README.md

@@ -479,6 +479,7 @@ The one-liner (implicit receiver) `should`:
 * [Current example object](#current-example-object)
 * [Custom matcher DSL](#custom-matcher-dsl)
 * [Implicit spec types in rspec-rails](#implicit-spec-types-in-rspec-rails)
+* [Deprecated configuration options](#deprecated-configuration-options)
 * [Monkey-patched example groups](#monkey-patched-example-groups)
 * [Hook scope aliases](#hook-scope-aliases)
 
@@ -1300,6 +1301,54 @@ end
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Consider making example group mixins more explicit · rspec/rspec-rails](https://github.com/rspec/rspec-rails/issues/662)
 
+### Deprecated configuration options
+
+Targets:
+
+```ruby
+RSpec.configure do |c|
+  c.backtrace_clean_patterns
+  c.backtrace_clean_patterns = [/lib\/something/]
+  c.color_enabled = true
+
+  c.out
+  c.out = File.open('output.txt', 'w')
+  c.output
+  c.output = File.open('output.txt', 'w')
+
+  c.backtrace_cleaner
+  c.color?(output)
+  c.filename_pattern
+  c.filename_pattern = '**/*_test.rb'
+  c.warnings
+end
+```
+
+Will be converted to:
+
+```ruby
+RSpec.configure do |c|
+  c.backtrace_exclusion_patterns
+  c.backtrace_exclusion_patterns = [/lib\/something/]
+  c.color = true
+
+  # RSpec 2.99.0.beta1 or later
+  c.output_stream
+  c.output_stream = File.open('output.txt', 'w')
+  c.output_stream
+  c.output_stream = File.open('output.txt', 'w')
+
+  # RSpec 2.99.0.rc1 or later
+  c.backtrace_formatter
+  c.color_enabled?(output)
+  c.pattern
+  c.pattern = '**/*_test.rb'
+  c.warnings?
+end
+```
+
+* This conversion can be disabled by: `--keep deprecated`
+
 ### Monkey-patched example groups
 
 This conversion is **disabled by default** and available only if your project's RSpec is **3.0.0.beta2 or later**.

data/README.md.erb

@@ -234,7 +234,7 @@ conversion_type_table = <<END
 `deprecated`     | All other deprecated syntaxes  | Latest syntaxes
 END
 
-validate_syntax_type_table(conversion_type_table, Transpec::OptionParser::CONFIG_ATTRS_FOR_KEEP_TYPES.keys)
+validate_syntax_type_table(conversion_type_table, OptionParser::CONFIG_ATTRS_FOR_KEEP_TYPES.keys)
 conversion_type_table
 -%>
 
@@ -263,7 +263,7 @@ conversion_type_table = <<END
 `stub_with_hash` | `obj.stub(:message => value)`  | `allow(obj).to receive(:message).and_return(value)`
 END
 
-validate_syntax_type_table(conversion_type_table, Transpec::OptionParser::CONFIG_ATTRS_FOR_CONVERT_TYPES.keys)
+validate_syntax_type_table(conversion_type_table, OptionParser::CONFIG_ATTRS_FOR_CONVERT_TYPES.keys)
 conversion_type_table
 -%>
 
@@ -339,16 +339,15 @@ END
 <%= convert(example).gsub('original spec', 'converted spec') -%>
 
 <%=
-convert(example, cli: ['-p'])
-  .gsub(
-    'original spec',
-    'converted spec with -p/--no-parens-matcher-arg option'
-  )
-  .gsub(/^.+\{ key: value \}/) do |match|
-    "    # With non-operator method, the parentheses are always required\n" +
-    "    # to prevent the hash from being interpreted as a block.\n" +
-    match
-  end
+converted = convert(example, cli: ['-p'])
+converted.gsub!(
+  'original spec',
+  'converted spec with -p/--no-parens-matcher-arg option'
+)
+insert_comment_above(converted, '{ key: value }', [
+  'With non-operator method, the parentheses are always required',
+  'to prevent the hash from being interpreted as a block.'
+])
 -%>
 ```
 
@@ -477,7 +476,7 @@ Will be converted to:
 
 ### One-liner expectations
 
-This conversion is available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.oneliner_is_expected_available_version %> or later**.
+This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.oneliner_is_expected_available_version %> or later**.
 
 Targets:
 
@@ -542,7 +541,7 @@ This conversion is combined with the conversion of [standard expectations](#stan
 
 ### Boolean matchers
 
-This conversion is available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.be_truthy_available_version %> or later**.
+This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.be_truthy_available_version %> or later**.
 
 Targets:
 
@@ -978,7 +977,7 @@ Will be converted to:
 <%= convert(example, wrap_with: :example).lines.to_a.uniq.join("\n") -%>
 
 # Conversion from `stub_chain` to `receive_message_chain` is available
-# only if the target project's RSpec is <%= rspec_version = Transpec::RSpecVersion.receive_message_chain_available_version %> or later
+# only if the target project's RSpec is <%= rspec_version = RSpecVersion.receive_message_chain_available_version %> or later
 <%= convert(stub_chain_example, wrap_with: :example, rspec_version: rspec_version) -%>
 
 <%= convert(any_instance_example, wrap_with: :example) -%>
@@ -1007,13 +1006,13 @@ END
 Will be converted to:
 
 ```ruby
-# If the target project's RSpec is <%= rspec_version = Transpec::RSpecVersion.receive_messages_available_version %> or later
+# If the target project's RSpec is <%= rspec_version = RSpecVersion.receive_messages_available_version %> or later
 <%= convert(example, wrap_with: :example, rspec_version: rspec_version) -%>
 
-# If the target project's RSpec is prior to <%= Transpec::RSpecVersion.receive_messages_available_version %>
+# If the target project's RSpec is prior to <%= RSpecVersion.receive_messages_available_version %>
 <%= convert(example, wrap_with: :example, rspec_version: Transpec.required_rspec_version).chomp -%> # No conversion
 
-# If the target project's RSpec is prior to <%= Transpec::RSpecVersion.receive_messages_available_version %>
+# If the target project's RSpec is prior to <%= RSpecVersion.receive_messages_available_version %>
 # and `--convert stub-with-hash` is specified
 <%= convert(example, wrap_with: :example, rspec_version: Transpec.required_rspec_version, cli: ['--convert', 'stub_with_hash']) -%>
 ```
@@ -1109,7 +1108,7 @@ Will be converted to:
 
 ### `any_instance` implementation blocks
 
-This conversion is available only if your project's RSpec is **`>= <%= Transpec::RSpecVersion::RSPEC_2_99 %>` and `< <%= Transpec::RSpecVersion::RSPEC_3_0 %>`**.
+This conversion is available only if your project's RSpec is **`>= <%= RSpecVersion::RSPEC_2_99 %>` and `< <%= RSpecVersion::RSPEC_3_0 %>`**.
 
 Targets:
 
@@ -1132,7 +1131,7 @@ END
 Will be converted to:
 
 ```ruby
-<% rspec_version = Transpec::RSpecVersion.yielding_receiver_to_any_instance_implementation_block_available_version -%>
+<% rspec_version = RSpecVersion.yielding_receiver_to_any_instance_implementation_block_available_version -%>
 <%= convert(example, rspec_version: rspec_version) -%>
 ```
 
@@ -1171,7 +1170,7 @@ Will be converted to:
 
 ### Pending examples
 
-This conversion is available only if your project's RSpec is **`>= <%= Transpec::RSpecVersion::RSPEC_2_99 %>` and `< <%= Transpec::RSpecVersion::RSPEC_3_0 %>`**.
+This conversion is available only if your project's RSpec is **`>= <%= RSpecVersion::RSPEC_2_99 %>` and `< <%= RSpecVersion::RSPEC_3_0 %>`**.
 
 Targets:
 
@@ -1206,7 +1205,7 @@ Will be converted to:
 
 ```ruby
 <%=
-convert(example, rspec_version: Transpec::RSpecVersion.skip_available_version)
+convert(example, rspec_version: RSpecVersion.skip_available_version)
   .gsub('pending', 'pending # #pending with block is no longer supported')
 -%>
 ```
@@ -1229,7 +1228,7 @@ Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/v2
 
 ### Current example object
 
-This conversion is available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.yielded_example_available_version %> or later**.
+This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.yielded_example_available_version %> or later**.
 
 Targets:
 
@@ -1279,7 +1278,7 @@ Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/7d
 
 ### Custom matcher DSL
 
-This conversion is available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.non_should_matcher_protocol_available_version %> or later**.
+This conversion is available only if your project's RSpec is **<%= rspec_version = RSpecVersion.non_should_matcher_protocol_available_version %> or later**.
 
 Targets:
 
@@ -1308,7 +1307,7 @@ Will be converted to:
 
 ### Implicit spec types in rspec-rails
 
-This conversion is **available only if `rspec-rails` is loaded** in your spec and your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.implicit_spec_type_disablement_available_version %> or later**.
+This conversion is **available only if `rspec-rails` is loaded** in your spec and your project's RSpec is **<%= rspec_version = RSpecVersion.implicit_spec_type_disablement_available_version %> or later**.
 
 Targets:
 
@@ -1341,9 +1340,56 @@ Or with `--no-explicit-spec-type` option they will be converted to:
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Consider making example group mixins more explicit · rspec/rspec-rails](https://github.com/rspec/rspec-rails/issues/662)
 
+### Deprecated configuration options
+
+Targets:
+
+```ruby
+<%=
+example = <<END
+RSpec.configure do |c|
+  c.backtrace_clean_patterns
+  c.backtrace_clean_patterns = [/lib\\/something/]
+  c.color_enabled = true
+
+  c.out
+  c.out = File.open('output.txt', 'w')
+  c.output
+  c.output = File.open('output.txt', 'w')
+
+  c.backtrace_cleaner
+  c.color?(output)
+  c.filename_pattern
+  c.filename_pattern = '**/*_test.rb'
+  c.warnings
+end
+END
+-%>
+```
+
+Will be converted to:
+
+```ruby
+<%=
+converted = convert(example, rspec_version: RSpecVersion.new('3.0.0'))
+
+[
+  ['c.output_stream',       :config_output_stream],
+  ['c.backtrace_formatter', :config_backtrace_formatter],
+].each do |pattern, feature|
+  rspec_version = RSpecVersion.send("#{feature}_available_version")
+  converted = insert_comment_above(converted, pattern, "RSpec #{rspec_version} or later")
+end
+
+converted
+-%>
+```
+
+* This conversion can be disabled by: `--keep deprecated`
+
 ### Monkey-patched example groups
 
-This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.non_monkey_patch_example_group_available_version %> or later**.
+This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = RSpecVersion.non_monkey_patch_example_group_available_version %> or later**.
 
 Targets:
 
@@ -1376,7 +1422,7 @@ Will be converted to:
 
 ### Hook scope aliases
 
-This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = Transpec::RSpecVersion.hook_scope_alias_available_version %> or later**.
+This conversion is **disabled by default** and available only if your project's RSpec is **<%= rspec_version = RSpecVersion.hook_scope_alias_available_version %> or later**.
 
 Targets:
 

data/lib/transpec/converter.rb

@@ -165,7 +165,9 @@ module Transpec
     end
 
     def process_rspec_configure(rspec_configure)
-      rspec_configure.convert_deprecated_options!(rspec_version)
+      if config.convert_deprecated_method?
+        rspec_configure.convert_deprecated_options!(rspec_version)
+      end
 
       if spec_suite.main_rspec_configure_node?(rspec_configure.node)
         if rspec_version.non_monkey_patch_example_group_available? &&

data/lib/transpec/syntax/rspec_configure.rb

@@ -88,7 +88,6 @@ module Transpec
 
         if rspec_version.config_backtrace_formatter_available?
           replace_config!(:backtrace_cleaner,  :backtrace_formatter)
-          replace_config!(:backtrace_cleaner=, :backtrace_formatter=)
         end
 
         if rspec_version.config_predicate_color_enabled_available?

data/lib/transpec/version.rb

@@ -5,7 +5,7 @@ module Transpec
   module Version
     MAJOR = 2
     MINOR = 3
-    PATCH = 0
+    PATCH = 1
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/spec/transpec/converter_spec.rb

@@ -1140,6 +1140,24 @@ module Transpec
         ).as_null_object
       end
 
+      context 'when Config#convert_deprecated_method? returns true' do
+        before { config.convert_deprecated_method = true }
+
+        it 'invokes RSpecConfigure#convert_deprecated_options! with RSpecVersion' do
+          rspec_configure.should_receive(:convert_deprecated_options!).with(rspec_version)
+          converter.process_rspec_configure(rspec_configure)
+        end
+      end
+
+      context 'when Config#convert_deprecated_method? returns false' do
+        before { config.convert_deprecated_method = false }
+
+        it 'does not invoke RSpecConfigure#convert_deprecated_options!' do
+          rspec_configure.should_not_receive(:convert_deprecated_options!)
+          converter.process_rspec_configure(rspec_configure)
+        end
+      end
+
       context 'when RSpecVersion#rspec_2_99? returns true' do
         before do
           rspec_version.stub(:rspec_2_99?).and_return(true)

data/tasks/readme.rake

@@ -1,5 +1,7 @@
 # coding: utf-8
 
+require 'transpec'
+
 desc 'Generate README.md'
 task :readme do
   puts 'Generating README.md...'
@@ -33,11 +35,12 @@ def generate_readme
 end
 
 class READMEContext
+  include Transpec
+
   attr_reader :readme
 
   def initialize(readme)
     @readme = readme
-    require 'transpec'
     require 'transpec/cli'
     require 'stringio'
     require 'tmpdir'
@@ -159,4 +162,18 @@ class READMEContext
       fail "No descriptions for syntax types #{types_missing_description}"
     end
   end
+
+  def insert_comment_above(code, pattern, comments)
+    regexp = Regexp.new('^([ \t]*).*' + Regexp.escape(pattern))
+
+    code.sub(regexp) do |match|
+      indentation = Regexp.last_match(1)
+      replacement = ''
+      Array(comments).each do |comment|
+        comment = comment.to_s.chomp
+        replacement << "#{indentation}# #{comment}\n"
+      end
+      replacement << match
+    end
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transpec
 version: !ruby/object:Gem::Version
-  version: 2.3.0
+  version: 2.3.1
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-15 00:00:00.000000000 Z
+date: 2014-06-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser