transpec 1.13.1 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb62942d4b92b4b76ee2e2a74d1287ea3a54e8fb
-  data.tar.gz: 72298e837998e51fcb53877389d9d407f302c3dd
+  metadata.gz: c55138d0f6562f6e88f54a665a1606ff3b69f97d
+  data.tar.gz: ad436da74d347b87d8e5e96adebf45f2e8c9bc29
 SHA512:
-  metadata.gz: 8541244f475226a74a364370e379a1c188d173e0813553e04c96f419fd805247c30703abdba3dab20db9ba92f56f48e3720ff04f99c871a67bdb306b39883249
-  data.tar.gz: 9f906de970f67fd2638fb26103ac8ceea32fffeb940b2fcc271c51b7a1662e9920993c70e7c1c4b1f4efd671c78b6bf3b400f884cc0037b86f8871bd46601b8a
+  metadata.gz: d194a5757be5ebad5680322636fb28e4acb2179421d89b018a3e40965a5712c8395aa8a2130e6bb13e6e74a32d9da4785f458f5cc4c7a4b041a3b169c793040a
+  data.tar.gz: 82630e3bab603645603d56cf8d272e8a5ced283989ee1e59bfb3fba43cb78738d6563d11ac645d6d49dda62391da6f88b44b06afc8673335be7518cdadd145d8

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.1
+  - 2.1
   - ruby-head
   - jruby
 matrix:

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Development
 
+## v2.0.0
+
+* Support conversion of implicit spec types in rspec-rails. ([#57](https://github.com/yujinakayama/transpec/issues/57))
+* Enable conversion of `have(n).items` even if rspec-rails is loaded in the spec according to the removal of rspec-collection_matchers in rspec-rails 3.
+* Remove support for deprecated options `-m/--generate-commit-message` and `-t/--convert-stub-with-hash`.
+
 ## v1.13.1
 
 * Fix a bug where multiline expression `expect(obj).to receive(:message)\n.and_return { value }` was converted to `expect(obj).to.receive(:message)\n { value }` and the block was interpreted as a hash literal. ([#60](https://github.com/yujinakayama/transpec/issues/60))

data/README.md

@@ -133,7 +133,7 @@ Running dynamic analysis with command "bundle exec rspec"...
 Finished in 13.07 seconds
 100 examples, 0 failures
 
-Aggregating spec suite data...
+Gathering the spec suite data...
 
 Converting spec/spec_helper.rb
 Converting spec/support/cache_helper.rb
@@ -202,6 +202,9 @@ read this article by [Myron Marston](https://github.com/myronmarston), who is th
 
 ## Options
 
+Though Transpec ships with sensible defaults that essentially conform to the RSpec 3 defaults,
+you can customize the conversion behavior.
+
 ### `-f/--force`
 
 Force processing even if the current Git repository is not clean.
@@ -210,7 +213,7 @@ Force processing even if the current Git repository is not clean.
 $ git status --short
  M spec/spec_helper.rb
 $ transpec
-The current Git repository is not clean. Aborting.
+The current Git repository is not clean. Aborting. If you want to proceed forcibly, use -f/--force option.
 $ transpec --force
 Copying project for dynamic analysis...
 Running dynamic analysis with command "bundle exec rspec"...
@@ -479,6 +482,7 @@ The one-liner (implicit receiver) `should`:
 * [Pending examples](#pending-examples)
 * [Current example object](#current-example-object)
 * [Custom matcher DSL](#custom-matcher-dsl)
+* [Implicit spec types in rspec-rails](#implicit-spec-types-in-rspec-rails)
 * [Example groups](#example-groups)
 * [Hook scope aliases](#hook-scope-aliases)
 
@@ -594,8 +598,6 @@ expect(obj).to be false
 
 So, converting `be_true`/`be_false` to `be_truthy`/`be_falsey` never breaks your specs and this is Transpec's default. If you are willing to test boolean values strictly, you can convert them to `be true`/`be false` with `--boolean-matcher true,false` option. Note that this may break your specs if your application code don't return exact boolean values.
 
----
-
 * This conversion can be disabled by: `--keep deprecated`
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Consider renaming `be_true` and `be_false` to `be_truthy` and `be_falsey` · rspec/rspec-expectations](https://github.com/rspec/rspec-expectations/issues/283)
@@ -620,7 +622,7 @@ expect(1.0 / 3.0).to be_within(0.001).of(0.333)
 
 ### `have(n).items` matcher
 
-**This conversion will be disabled automatically if `rspec-collection_matchers` or `rspec-rails` is loaded in your spec.**
+**This conversion will be disabled automatically if `rspec-collection_matchers` is loaded in your spec.**
 
 Targets:
 
@@ -660,9 +662,7 @@ There's an option to continue using `have(n).items` matcher with [rspec-collecti
 If you choose to do so, disable this conversion by either:
 
 * Specify `--keep have_items` option manually.
-* Require `rspec-collection_matchers` or `rspec-rails` in your spec so that Transpec automatically disables this conversion.
-
-Note: `rspec-rails` 3.0 [still uses `have(n).items` matcher with `rspec-collection_matchers`](https://github.com/rspec/rspec-rails/blob/v3.0.0.beta1/rspec-rails.gemspec#L41).
+* Require `rspec-collection_matchers` in your spec so that Transpec automatically disables this conversion.
 
 ---
 
@@ -672,7 +672,7 @@ Note: `rspec-rails` 3.0 [still uses `have(n).items` matcher with `rspec-collecti
 
 ### One-liner expectations with `have(n).items` matcher
 
-**This conversion will be disabled automatically if `rspec-collection_matchers` or `rspec-rails` is loaded in your spec.**
+**This conversion will be disabled automatically if `rspec-collection_matchers` is loaded in your spec.**
 
 Targets:
 
@@ -909,7 +909,7 @@ So, if you're going to use Transpec in [the upgrade path to RSpec 3](http://myro
 3. Upgrade to RSpec 3.0
 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`.
+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
@@ -994,8 +994,6 @@ end
 
 describe 'example' do
   it 'is any_instance implementation block' do
-    Klass.any_instance.should_receive(:message) { |arg| puts arg }
-    Klass.any_instance.stub(:message) { |arg| puts arg }
     expect_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
     allow_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
   end
@@ -1015,8 +1013,6 @@ describe 'example' do
   it 'is any_instance implementation block' do
     expect_any_instance_of(Klass).to receive(:message) { |instance, arg| puts arg }
     allow_any_instance_of(Klass).to receive(:message) { |instance, arg| puts arg }
-    expect_any_instance_of(Klass).to receive(:message) { |instance, arg| puts arg }
-    allow_any_instance_of(Klass).to receive(:message) { |instance, arg| puts arg }
   end
 end
 
@@ -1031,8 +1027,6 @@ describe 'example' do
   it 'is any_instance implementation block' do
     expect_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
     allow_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
-    expect_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
-    allow_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
   end
 end
 ```
@@ -1202,8 +1196,6 @@ Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/7d
 > end
 > ```
 
----
-
 * This conversion can be disabled by: `--keep deprecated`
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Core: DSL methods will yield the example - The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#core_dsl_methods_will_yield_the_example)
@@ -1238,6 +1230,55 @@ end
 * Deprecation: deprecated since RSpec 3.0
 * See also: [Expectations: Matcher protocol and custom matcher API changes - The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#expectations_matcher_protocol_and_custom_matcher_api_changes)
 
+### 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 `2.99.0.rc1` or later.**
+
+Targets:
+
+```ruby
+# In spec/models/some_model_spec.rb
+RSpec.configure do |rspec|
+end
+
+describe SomeModel do
+end
+```
+
+Will be converted to:
+
+```ruby
+RSpec.configure do |rspec|
+end
+
+describe SomeModel, :type => :model do
+end
+
+# With `--no-explicit-spec-type`
+RSpec.configure do |rspec|
+  rspec.infer_spec_type_from_file_location!
+end
+
+describe SomeModel do
+end
+```
+
+Here's an excerpt from [the warning](https://github.com/rspec/rspec-rails/blob/ab6313b/lib/rspec/rails/infer_type_configuration.rb#L13-L22) in RSpec 2.99:
+
+> rspec-rails 3 will no longer automatically infer an example group's spec type from the file location. You can explicitly opt-in to this feature using this snippet:
+>
+> ```ruby
+> RSpec.configure do |config|
+>   config.infer_spec_type_from_file_location!
+> end
+> ```
+>
+> If you wish to manually label spec types via metadata you can safely ignore this warning and continue upgrading to RSpec 3 without addressing it.
+
+* This conversion can be disabled by: `--keep deprecated`
+* 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)
+
 ### Example groups
 
 **This conversion is disabled by default and available only if your project's RSpec is `3.0.0.beta2` or later.**
@@ -1290,8 +1331,8 @@ describe 'example' do
   before(:all) { do_something }
 end
 
-RSpec.configure do |config|
-  before(:suite) { do_something }
+RSpec.configure do |rspec|
+  rspec.before(:suite) { do_something }
 end
 ```
 
@@ -1304,8 +1345,8 @@ describe 'example' do
   before(:context) { do_something }
 end
 
-RSpec.configure do |config|
-  before(:suite) { do_something }
+RSpec.configure do |rspec|
+  rspec.before(:suite) { do_something }
 end
 ```
 

data/README.md.erb

@@ -107,7 +107,7 @@ Running dynamic analysis with command "bundle exec rspec"...
 Finished in 13.07 seconds
 100 examples, 0 failures
 
-Aggregating spec suite data...
+Gathering the spec suite data...
 
 Converting spec/spec_helper.rb
 Converting spec/support/cache_helper.rb
@@ -176,6 +176,9 @@ read this article by [Myron Marston](https://github.com/myronmarston), who is th
 
 ## Options
 
+Though Transpec ships with sensible defaults that essentially conform to the RSpec 3 defaults,
+you can customize the conversion behavior.
+
 ### `-f/--force`
 
 Force processing even if the current Git repository is not clean.
@@ -184,7 +187,7 @@ Force processing even if the current Git repository is not clean.
 $ git status --short
  M spec/spec_helper.rb
 $ transpec
-The current Git repository is not clean. Aborting.
+The current Git repository is not clean. Aborting. If you want to proceed forcibly, use -f/--force option.
 $ transpec --force
 Copying project for dynamic analysis...
 Running dynamic analysis with command "bundle exec rspec"...
@@ -576,8 +579,6 @@ Will be converted to:
 
 So, converting `be_true`/`be_false` to `be_truthy`/`be_falsey` never breaks your specs and this is Transpec's default. If you are willing to test boolean values strictly, you can convert them to `be true`/`be false` with `--boolean-matcher true,false` option. Note that this may break your specs if your application code don't return exact boolean values.
 
----
-
 * This conversion can be disabled by: `--keep deprecated`
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Consider renaming `be_true` and `be_false` to `be_truthy` and `be_falsey` · rspec/rspec-expectations](https://github.com/rspec/rspec-expectations/issues/283)
@@ -606,7 +607,7 @@ Will be converted to:
 
 ### `have(n).items` matcher
 
-**This conversion will be disabled automatically if `rspec-collection_matchers` or `rspec-rails` is loaded in your spec.**
+**This conversion will be disabled automatically if `rspec-collection_matchers` is loaded in your spec.**
 
 Targets:
 
@@ -685,9 +686,7 @@ There's an option to continue using `have(n).items` matcher with [rspec-collecti
 If you choose to do so, disable this conversion by either:
 
 * Specify `--keep have_items` option manually.
-* Require `rspec-collection_matchers` or `rspec-rails` in your spec so that Transpec automatically disables this conversion.
-
-Note: `rspec-rails` 3.0 [still uses `have(n).items` matcher with `rspec-collection_matchers`](https://github.com/rspec/rspec-rails/blob/v3.0.0.beta1/rspec-rails.gemspec#L41).
+* Require `rspec-collection_matchers` in your spec so that Transpec automatically disables this conversion.
 
 ---
 
@@ -697,7 +696,7 @@ Note: `rspec-rails` 3.0 [still uses `have(n).items` matcher with `rspec-collecti
 
 ### One-liner expectations with `have(n).items` matcher
 
-**This conversion will be disabled automatically if `rspec-collection_matchers` or `rspec-rails` is loaded in your spec.**
+**This conversion will be disabled automatically if `rspec-collection_matchers` is loaded in your spec.**
 
 Targets:
 
@@ -974,7 +973,7 @@ So, if you're going to use Transpec in [the upgrade path to RSpec 3](http://myro
 3. Upgrade to RSpec 3.0
 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`.
+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
@@ -1068,8 +1067,6 @@ end
 
 describe 'example' do
   it 'is any_instance implementation block' do
-    Klass.any_instance.should_receive(:message) { |arg| puts arg }
-    Klass.any_instance.stub(:message) { |arg| puts arg }
     expect_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
     allow_any_instance_of(Klass).to receive(:message) { |arg| puts arg }
   end
@@ -1238,8 +1235,6 @@ Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/7d
 > end
 > ```
 
----
-
 * This conversion can be disabled by: `--keep deprecated`
 * Deprecation: deprecated since RSpec 2.99, removed in RSpec 3.0
 * See also: [Core: DSL methods will yield the example - The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#core_dsl_methods_will_yield_the_example)
@@ -1273,6 +1268,50 @@ Will be converted to:
 * Deprecation: deprecated since RSpec 3.0
 * See also: [Expectations: Matcher protocol and custom matcher API changes - The Plan for RSpec 3](http://myronmars.to/n/dev-blog/2013/07/the-plan-for-rspec-3#expectations_matcher_protocol_and_custom_matcher_api_changes)
 
+### 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.**
+
+Targets:
+
+```ruby
+# In spec/models/some_model_spec.rb
+<%=
+example = <<END
+RSpec.configure do |rspec|
+end
+
+describe SomeModel do
+end
+END
+-%>
+```
+
+Will be converted to:
+
+```ruby
+<%= convert(example, rspec_version: rspec_version, path: 'spec/models/some_model_spec.rb') -%>
+
+# With `--no-explicit-spec-type`
+<%= convert(example, rspec_version: rspec_version, path: 'spec/models/some_model_spec.rb', cli: ['--no-explicit-spec-type']) -%>
+```
+
+Here's an excerpt from [the warning](https://github.com/rspec/rspec-rails/blob/ab6313b/lib/rspec/rails/infer_type_configuration.rb#L13-L22) in RSpec 2.99:
+
+> rspec-rails 3 will no longer automatically infer an example group's spec type from the file location. You can explicitly opt-in to this feature using this snippet:
+>
+> ```ruby
+> RSpec.configure do |config|
+>   config.infer_spec_type_from_file_location!
+> end
+> ```
+>
+> If you wish to manually label spec types via metadata you can safely ignore this warning and continue upgrading to RSpec 3 without addressing it.
+
+* This conversion can be disabled by: `--keep deprecated`
+* 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)
+
 ### 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.**
@@ -1321,8 +1360,8 @@ describe 'example' do
   before(:all) { do_something }
 end
 
-RSpec.configure do |config|
-  before(:suite) { do_something }
+RSpec.configure do |rspec|
+  rspec.before(:suite) { do_something }
 end
 END
 -%>

data/lib/transpec/cli.rb

@@ -1,7 +1,7 @@
 # coding: utf-8
 
 require 'transpec/commit_message'
-require 'transpec/configuration'
+require 'transpec/config'
 require 'transpec/converter'
 require 'transpec/dynamic_analyzer'
 require 'transpec/option_parser'
@@ -13,7 +13,7 @@ require 'rainbow/ext/string' unless String.method_defined?(:color)
 
 module Transpec
   class CLI
-    attr_reader :project, :configuration, :report
+    attr_reader :project, :config, :report
 
     def self.run(args = ARGV)
       new.run(args)
@@ -21,13 +21,13 @@ module Transpec
 
     def initialize
       @project = Project.new
-      @configuration = Configuration.new
+      @config = Config.new
       @report = Report.new
     end
 
     def run(args)
       begin
-        paths = OptionParser.new(configuration).parse(args)
+        paths = OptionParser.new(config).parse(args)
         fail_if_should_not_continue!
       rescue => error
         warn error.message
@@ -51,14 +51,14 @@ module Transpec
     def process(paths)
       runtime_data = nil
 
-      unless configuration.skip_dynamic_analysis?
+      unless config.skip_dynamic_analysis?
         runtime_data = run_dynamic_analysis(paths)
       end
 
       spec_suite = SpecSuite.new(paths, runtime_data)
       # Actually #analyze does not need to be invoked here, but doing this will avoid long freeze
       # while conversion of files.
-      puts 'Aggregating spec suite data...'
+      puts 'Gathering the spec suite data...'
       spec_suite.analyze
       puts
 
@@ -70,7 +70,7 @@ module Transpec
     def convert_spec(spec, spec_suite)
       puts "Converting #{spec.path}"
 
-      converter = Converter.new(spec_suite, configuration, project.rspec_version)
+      converter = Converter.new(spec_suite, config, project.rspec_version)
       converter.convert_file!(spec)
 
       warn_annotations(converter.report)
@@ -83,7 +83,7 @@ module Transpec
     private
 
     def fail_if_should_not_continue!
-      unless configuration.forced?
+      unless config.forced?
         if Git.command_available? && Git.inside_of_repository? && !Git.clean?
           fail 'The current Git repository is not clean. Aborting. ' \
                'If you want to proceed forcibly, use -f/--force option.'
@@ -101,7 +101,7 @@ module Transpec
 
       puts 'Copying the project for dynamic analysis...'
 
-      DynamicAnalyzer.new(rspec_command: configuration.rspec_command) do |analyzer|
+      DynamicAnalyzer.new(rspec_command: config.rspec_command) do |analyzer|
         puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
         runtime_data = analyzer.analyze(paths)
       end