transpec 1.9.3 → 1.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 65c3e2a67d42f7fc8b2ca50e0853242a6057bfcb
-  data.tar.gz: facb20a69acc7f105f48b47524e2b6486b68c1f1
+  metadata.gz: 6746cd9c37b13d9dcf9c77b423146988dc76fc05
+  data.tar.gz: 9741bc313663316ea54b25eff57abce0aa3b8440
 SHA512:
-  metadata.gz: 7dc1164f70806bad460e845710010a9365751e02ccc106034f71d25a0d979efe8e283b0837be635385558317a988f5c71ab72c78216a3fae1ddfc6b0d93d18f2
-  data.tar.gz: 05d9de7fa3d15cb62da0e91cfa85c71f6ad615c70452c7ddee00aa0c9cb3925a3dfe87f2b383d210adb26661ffb8134190821ddbc3e6706ae5686a8997a6c586
+  metadata.gz: 8794a9d4a01800a80b7a7ab09c29418d2b27a55978263d655ea7f81ac8c2e7babbdacb306caef3a1086dba283c67bb7ec81b8a48267de1b3f3758eff7be57eeb
+  data.tar.gz: 531aca6df23e26d22e048231c6393c044e13137d753924b568a25ee7e11a81d57271ac652c93e403001fd65cc23f79cb3de2f4710f7496fed39521b6277d10e1

data/.rubocop.yml

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

data/.travis.yml

@@ -2,7 +2,7 @@ language: ruby
 rvm:
   - 1.9.3
   - 2.0.0
-  - 2.1.0
+  - 2.1.1
   - jruby
 before_install: gem update --remote bundler
 script: bundle exec rake travis

data/CHANGELOG.md

@@ -2,6 +2,11 @@
 
 ## Development
 
+## v1.10.0
+
+* Support conversion of pending examples
+* Display cautions for less-accurate conversions caused by a lack of runtime information ([#42](https://github.com/yujinakayama/transpec/issues/42))
+
 ## v1.9.3
 
 * Handle `variable.any_instance` ([#46](https://github.com/yujinakayama/transpec/issues/46))

data/CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# Contributing
+
+If you're going to report an issue or submit a pull requrest, please follow these guidelines.
+
+## Reporting an Issue
+
+* Provide the problematic code or the project's URL.
+* Include the version of Ruby you're using (`ruby --version`).
+* Include the version of Transpec you're using (`transpec --version`).
+* Include complete command-line options you passed to `transpec`.
+
+## Pull Requests
+
+* Add tests for your change unless it's a refactoring.
+* Run `bundle exec rake`. If any failing test or code style issue is reported, fix it.
+* If you're going to modify the content of `README.md`:
+    * Edit `README.md.erb` instead.
+    * Run `bundle exec rake readme`. This will generate `README.md` from `README.md.erb`.
+    * Commit both files.

data/README.md

@@ -197,7 +197,7 @@ Running dynamic analysis with command "bundle exec rspec"...
 
 ### `-s/--skip-dynamic-analysis`
 
-Skip dynamic analysis and convert with only static analysis. Note that specifying this option decreases the conversion accuracy.
+Skip dynamic analysis and convert with only static analysis. Note that specifying this option decreases the conversion accuracy especially in the conversion of [`have(n).items` matcher](#havenitems-matcher).
 
 ### `-c/--rspec-command`
 
@@ -207,6 +207,12 @@ Transpec needs to run your specs in a copied project directory for dynamic analy
 If your project requires some special setup or commands to run specs, use this option.
 `bundle exec rspec` is used by default.
 
+Note that the command to run dynamic analysis does _not_ affect to the files or specs to be converted.
+This means that even if you specify a command that only runs a subset of the files in your spec suite or a subset of the specs in a file, every spec will be converted.
+For this reason, it's recommended to provide a command that runs full spec suite to `-c/--rspec-command`.
+If you want to convert only a subset of the files in a spec suite, pass the paths to `transpec`.
+See [Advanced Usage](#advanced-usage) for more details.
+
 ```bash
 $ transpec --rspec-command "./special_setup.sh && bundle exec rspec"
 ```
@@ -232,6 +238,7 @@ Type             | Target Syntax                  | Converted Syntax
 `stub`           | `obj.stub(:message)`           | `allow(obj).to receive(:message)`
 `have_items`     | `expect(obj).to have(n).items` | `expect(obj.size).to eq(n)`
 `its`            | `its(:attr) { }`               | `describe '#attr' { subject { }; it { } }`
+`pending`        | `pending 'is an example' { }`  | `skip 'is an example' { }`
 `deprecated`     | All other deprecated syntaxes  | Latest syntaxes
 
 See [Supported Conversions](#supported-conversions) for more details.
@@ -427,6 +434,7 @@ The one-liner (implicit receiver) `should`:
 * [Useless `and_return`](#useless-and_return)
 * [`any_instance` implementation blocks](#any_instance-implementation-blocks)
 * [Deprecated test double aliases](#deprecated-test-double-aliases)
+* [Pending examples](#pending-examples)
 * [Current example object](#current-example-object)
 * [Custom matcher DSL](#custom-matcher-dsl)
 
@@ -1017,6 +1025,75 @@ double('something')
 * Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
 * See also: [myronmarston / why_double.md - Gist](https://gist.github.com/myronmarston/6576665)
 
+### Pending examples
+
+**This conversion is available only if your project's RSpec is `>= 2.99.0.beta1` and `< 3.0.0.beta1`.**
+
+Targets:
+
+```ruby
+describe 'example' do
+  it 'is skipped', :pending => true do
+    do_something_possibly_fail # This won't be run
+  end
+
+  pending 'is skipped' do
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is skipped' do
+    pending
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is run and expected to fail' do
+    pending do
+      do_something_surely_fail # This will be run and expected to fail
+    end
+  end
+end
+```
+
+Will be converted to:
+
+```ruby
+describe 'example' do
+  it 'is skipped', :skip => true do
+    do_something_possibly_fail # This won't be run
+  end
+
+  skip 'is skipped' do
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is skipped' do
+    skip
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is run and expected to fail' do
+    pending # #pending with block is no longer supported
+    do_something_surely_fail # This will be run and expected to fail
+  end
+end
+```
+
+Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/v2.99.0.beta2/lib/rspec/core/example_group.rb#L67-L75) for pending examples in RSpec 2.99:
+
+> The semantics of `RSpec::Core::ExampleGroup#pending` are changing in RSpec 3.
+> In RSpec 2.x, it caused the example to be skipped. In RSpec 3, the example will
+> still be run but is expected to fail, and will be marked as a failure (rather
+> than as pending) if the example passes, just like how `pending` with a block
+> from within an example already works.
+>
+> To keep the same skip semantics, change `pending` to `skip`.  Otherwise, if you
+> want the new RSpec 3 behavior, you can safely ignore this warning and continue
+> to upgrade to RSpec 3 without addressing it.
+
+* This conversion can be disabled by: `--keep pending`
+* Deprecation: not deprecated but the behavior changes in RSpec 3.0
+* See also: [Feature request: shortcut for pending-block within it · rspec/rspec-core](https://github.com/rspec/rspec-core/issues/1208)
+
 ### Current example object
 
 **This conversion is available only if your project's RSpec is `2.99.0.beta1` or later.**
@@ -1111,14 +1188,6 @@ end
 
 Tested on MRI 1.9, 2.0, 2.1 and JRuby in 1.9 mode.
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
 ## License
 
 Copyright (c) 2013 Yuji Nakayama

data/README.md.erb

@@ -171,7 +171,7 @@ Running dynamic analysis with command "bundle exec rspec"...
 
 ### `-s/--skip-dynamic-analysis`
 
-Skip dynamic analysis and convert with only static analysis. Note that specifying this option decreases the conversion accuracy.
+Skip dynamic analysis and convert with only static analysis. Note that specifying this option decreases the conversion accuracy especially in the conversion of [`have(n).items` matcher](#havenitems-matcher).
 
 ### `-c/--rspec-command`
 
@@ -181,6 +181,12 @@ Transpec needs to run your specs in a copied project directory for dynamic analy
 If your project requires some special setup or commands to run specs, use this option.
 `bundle exec rspec` is used by default.
 
+Note that the command to run dynamic analysis does _not_ affect to the files or specs to be converted.
+This means that even if you specify a command that only runs a subset of the files in your spec suite or a subset of the specs in a file, every spec will be converted.
+For this reason, it's recommended to provide a command that runs full spec suite to `-c/--rspec-command`.
+If you want to convert only a subset of the files in a spec suite, pass the paths to `transpec`.
+See [Advanced Usage](#advanced-usage) for more details.
+
 ```bash
 $ transpec --rspec-command "./special_setup.sh && bundle exec rspec"
 ```
@@ -208,6 +214,7 @@ conversion_type_table = <<END
 `stub`           | `obj.stub(:message)`           | `allow(obj).to receive(:message)`
 `have_items`     | `expect(obj).to have(n).items` | `expect(obj.size).to eq(n)`
 `its`            | `its(:attr) { }`               | `describe '#attr' { subject { }; it { } }`
+`pending`        | `pending 'is an example' { }`  | `skip 'is an example' { }`
 `deprecated`     | All other deprecated syntaxes  | Latest syntaxes
 END
 
@@ -886,7 +893,7 @@ Will be converted to:
 
 ### `any_instance` implementation blocks
 
-**This conversion is available only if your project's RSpec is `>= <%= Transpec::RSpecVersion::ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_BEGIN %>` and `< <%= Transpec::RSpecVersion::ANY_INSTANCE_IMPLEMENTATION_BLOCK_MIGRATION_EXCLUSIVE_END %>`.**
+**This conversion is available only if your project's RSpec is `>= <%= Transpec::RSpecVersion::RSPEC_2_99 %>` and `< <%= Transpec::RSpecVersion::RSPEC_3_0 %>`.**
 
 Targets:
 
@@ -967,6 +974,65 @@ double('something')
 * Deprecation: deprecated since RSpec 2.14, removed in RSpec 3.0
 * See also: [myronmarston / why_double.md - Gist](https://gist.github.com/myronmarston/6576665)
 
+### Pending examples
+
+**This conversion is available only if your project's RSpec is `>= <%= Transpec::RSpecVersion::RSPEC_2_99 %>` and `< <%= Transpec::RSpecVersion::RSPEC_3_0 %>`.**
+
+Targets:
+
+```ruby
+<%=
+pending_example_target = <<END
+describe 'example' do
+  it 'is skipped', :pending => true do
+    do_something_possibly_fail # This won't be run
+  end
+
+  pending 'is skipped' do
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is skipped' do
+    pending
+    do_something_possibly_fail # This won't be run
+  end
+
+  it 'is run and expected to fail' do
+    pending do
+      do_something_surely_fail # This will be run and expected to fail
+    end
+  end
+end
+END
+-%>
+```
+
+Will be converted to:
+
+```ruby
+<%=
+rspec_version = Transpec::RSpecVersion.skip_available_version
+Transpec::Converter.new(nil, rspec_version).convert(pending_example_target)
+  .gsub('pending', 'pending # #pending with block is no longer supported')
+-%>
+```
+
+Here's an excerpt from [the warning](https://github.com/rspec/rspec-core/blob/v2.99.0.beta2/lib/rspec/core/example_group.rb#L67-L75) for pending examples in RSpec 2.99:
+
+> The semantics of `RSpec::Core::ExampleGroup#pending` are changing in RSpec 3.
+> In RSpec 2.x, it caused the example to be skipped. In RSpec 3, the example will
+> still be run but is expected to fail, and will be marked as a failure (rather
+> than as pending) if the example passes, just like how `pending` with a block
+> from within an example already works.
+>
+> To keep the same skip semantics, change `pending` to `skip`.  Otherwise, if you
+> want the new RSpec 3 behavior, you can safely ignore this warning and continue
+> to upgrade to RSpec 3 without addressing it.
+
+* This conversion can be disabled by: `--keep pending`
+* Deprecation: not deprecated but the behavior changes in RSpec 3.0
+* See also: [Feature request: shortcut for pending-block within it · rspec/rspec-core](https://github.com/rspec/rspec-core/issues/1208)
+
 ### Current example object
 
 **This conversion is available only if your project's RSpec is `<%= Transpec::RSpecVersion.yielded_example_available_version %>` or later.**
@@ -1058,14 +1124,6 @@ Transpec::Converter.new(nil, rspec_version).convert(custom_matcher_dsl_target)
 
 Tested on MRI 1.9, 2.0, 2.1 and JRuby in 1.9 mode.
 
-## Contributing
-
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
-
 ## License
 
 Copyright (c) 2013 Yuji Nakayama

data/lib/transpec/annotatable.rb

@@ -0,0 +1,16 @@
+# coding: utf-8
+
+module Transpec
+  module Annotatable
+    attr_reader :message, :source_range
+
+    def initialize(message, source_range)
+      @message = message
+      @source_range = source_range
+    end
+
+    def source_buffer
+      source_range.source_buffer
+    end
+  end
+end

data/lib/transpec/cli.rb

@@ -27,7 +27,7 @@ module Transpec
 
     def run(args)
       begin
-        paths = OptionParser.new(@configuration).parse(args)
+        paths = OptionParser.new(configuration).parse(args)
         fail_if_should_not_continue!
       rescue => error
         warn error.message
@@ -46,9 +46,9 @@ module Transpec
     def process(paths)
       runtime_data = nil
 
-      unless @configuration.skip_dynamic_analysis?
+      unless configuration.skip_dynamic_analysis?
         puts 'Copying the project for dynamic analysis...'
-        DynamicAnalyzer.new(rspec_command: @configuration.rspec_command) do |analyzer|
+        DynamicAnalyzer.new(rspec_command: configuration.rspec_command) do |analyzer|
           puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
           runtime_data = analyzer.analyze(paths)
         end
@@ -63,52 +63,49 @@ module Transpec
     def convert_file(file_path, runtime_data = nil)
       puts "Converting #{file_path}"
 
-      converter = Converter.new(@configuration, @project.rspec_version, runtime_data, @report)
+      converter = Converter.new(configuration, project.rspec_version, runtime_data)
       converter.convert_file!(file_path)
 
-      @report.context_errors.concat(converter.context_errors)
-
-      converter.context_errors.each do |error|
-        warn_invalid_context_error(error)
-      end
+      warn_annotations(converter.report)
+      report << converter.report
     rescue Parser::SyntaxError => error
-      @report.syntax_errors << error
+      report.syntax_errors << error
       warn_syntax_error(error)
     end
 
     private
 
     def fail_if_should_not_continue!
-      unless @configuration.forced?
+      unless configuration.forced?
         if Git.command_available? && Git.inside_of_repository? && !Git.clean?
           fail 'The current Git repository is not clean. Aborting.'
         end
       end
 
-      if @project.rspec_version < Transpec.required_rspec_version
+      if project.rspec_version < Transpec.required_rspec_version
         fail "Your project must have rspec gem dependency #{Transpec.required_rspec_version} " +
-             "or later but currently it's #{@project.rspec_version}. Aborting."
+             "or later but currently it's #{project.rspec_version}. Aborting."
       end
     end
 
     def display_summary
       puts
 
-      unless @report.records.empty?
+      unless report.records.empty?
         puts 'Summary:'
         puts
-        puts @report.colored_summary
+        puts report.colored_summary
         puts
       end
 
-      puts @report.colored_stats
+      puts report.colored_stats
     end
 
     def generate_commit_message
-      return if @report.records.empty?
+      return if report.records.empty?
       return unless Git.command_available? && Git.inside_of_repository?
 
-      commit_message = CommitMessage.new(@report, @project.rspec_version, ARGV)
+      commit_message = CommitMessage.new(report, project.rspec_version, ARGV)
       Git.write_commit_message(commit_message.to_s)
 
       puts
@@ -119,7 +116,7 @@ module Transpec
     end
 
     def display_final_guide
-      return if @report.records.empty?
+      return if report.records.empty?
 
       puts
       puts "Done! Now run #{'rspec'.bright} and check if everything is green."
@@ -129,19 +126,30 @@ module Transpec
       warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
     end
 
-    def warn_invalid_context_error(error)
-      message = error.message.color(:yellow) + $RS
-      message << highlighted_source(error)
+    def warn_annotations(report)
+      annotations = report.records.map(&:annotation).compact
+      annotations.concat(report.conversion_errors)
+      annotations.sort_by! { |a| a.source_range.line }
+
+      annotations.each do |annotation|
+        warn_annotation(annotation)
+      end
+    end
+
+    def warn_annotation(annotation)
+      color = annotation.is_a?(Annotation) ? :yellow : :magenta
+      message = annotation.message.color(color) + $RS
+      message << highlighted_source(annotation)
       warn message
     end
 
-    def highlighted_source(error)
-      filename = error.source_buffer.name.color(:cyan)
+    def highlighted_source(annotation)
+      filename = annotation.source_buffer.name.color(:cyan)
 
-      line_number = error.source_range.line
+      line_number = annotation.source_range.line
 
-      source = error.source_range.source_line
-      highlight_range = error.source_range.column_range
+      source = annotation.source_range.source_line
+      highlight_range = annotation.source_range.column_range
       source[highlight_range] = source[highlight_range].underline
 
       [filename, line_number, source].join(':')