transpec 0.2.3 → 0.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 51efb48bbde5bb4b866edc7919290fd09c1286ea
-  data.tar.gz: 0a2a2f6ad3b6310f0dd4ecb53b8ac157c3ab9642
+  metadata.gz: e4282d3fbc1652d1d78046fe2a04392fea0cee1c
+  data.tar.gz: 6eab8ef44e5a6b8e672246b7fd420bf220cd7006
 SHA512:
-  metadata.gz: 2141b0d96bcc0e92b4fa4652010f560abbe10745172b3cf2140fecaec9c454ef9e05ab61a6a73f8df6b0a2e4d13437bdae157c4ec78b95284cd10e6d6452854d
-  data.tar.gz: d5a6b210ee1559ed1dc5b99f478959108f3a7a2d2b8815bd50961cca190430609266ee1cb946f859aef485f8cbac9373a8dead74605757f537a66713b3f8efe7
+  metadata.gz: c4e376be4d7ef6f6c33c2cdc9d31a66f2817d0902be4d83541b3d79f637e83c4b23f0a021791a623d4214ee215e3909ffbaa602e0357f0bc1b1989325cb7c3eb
+  data.tar.gz: 4d1b3b9346eea8526948a8475c4c0fba32e2c1c35a1dfeecba9eec5c69f3df11dc0387f38baba7f9b596bfc78e92c0b0c81c18a213998693fc5f5d9fddd5ac50

data/.rubocop.yml

@@ -9,7 +9,7 @@ LineLength:
   Max: 100
 
 MethodLength:
-  Max: 20
+  Max: 17
 
 WordArray:
   Enabled: false
@@ -48,10 +48,6 @@ Documentation:
 IndentationWidth:
   Enabled: false
 
-# Custom error classes require custom arguments.
-RaiseArgs:
-  Enabled: false
-
-# Currently ClassLength counts innner class' codes in a namespace class.
+# TODO: Shorten to 100.
 ClassLength:
-  Enabled: false
+  Max: 186

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Master
 
+## v0.2.4
+
+* Improve context detection
+
 ## v0.2.3
 
 * Fix a bug where arguments of positive error expectation with block were removed (e.g. `expect { }.to raise_error(SpecificErrorClass) { |e| ... }` was converted to `expect { }.to raise_error { |e| ... }` unintentionally)

data/README.md

@@ -16,7 +16,7 @@ Note that Transpec does not yet support all conversions for the RSpec changes,
 and also the changes for RSpec 3 is not fixed and may vary in the future.
 So it's recommended to follow updates of both RSpec and Transpec.
 
-## Example
+## Examples
 
 Here's an example spec:
 
@@ -91,6 +91,14 @@ describe Account do
 end
 ```
 
+### Real Examples
+
+You can see real conversion examples below:
+
+* https://github.com/yujinakayama/guard/commit/transpec-demo
+* https://github.com/yujinakayama/mail/commit/transpec-demo
+* https://github.com/yujinakayama/twitter/commit/transpec-demo
+
 ## Installation
 
 ```bash
@@ -234,12 +242,50 @@ describe 'converted spec with -p/--no-parentheses-matcher-arg option' do
 end
 ```
 
+## Troubleshooting
+
+You might see the following warning while conversion:
+
+```
+Cannot convert #should into #expect since #expect is not available in the context.
+spec/awesome_spec.rb:4:      1.should == 1
+```
+
+This message would be shown with specs like this:
+
+```ruby
+describe '#should that cannot be converted to #expect' do
+  class MyAwesomeTestRunner
+    def run
+      1.should == 1
+    end
+  end
+
+  it 'is 1' do
+    test_runner = MyAwesomeTestRunner.new
+    test_runner.run
+  end
+end
+```
+
+### Reason
+
+* `should` is defined on `Kernel` (included by `Object`), so you can use `should` almost everywhere.
+* `expect` is defined on `RSpec::Matchers` (included by `RSpec::Core::ExampleGroup`), so you can use `expect` only where `self` is an instance of `RSpec::Core::ExampleGroup`.
+
+With the above example, in the context of `1.should == 1`, the `self` is an instance of `MyAwesomeTestRunner`.
+So Transpec tracks contexts and skips conversion if the target syntax cannot be converted in a case like this.
+
+### Solution
+
+You need to rewrite the spec by yourself.
+
 ## Supported Conversions
 
 ### Standard expectations
 
 ```ruby
-# Target
+# Targets
 obj.should matcher
 obj.should_not matcher
 
@@ -255,7 +301,7 @@ expect(obj).to_not matcher # with `--negative-form to_not`
 ### Operator matchers
 
 ```ruby
-# Target
+# Targets
 1.should == 1
 1.should < 2
 Integer.should === 1
@@ -275,7 +321,7 @@ expect([1, 2, 3]).to match_array([2, 1, 3])
 ### `be_close` matcher
 
 ```ruby
-# Target
+# Targets
 (1.0 / 3.0).should be_close(0.333, 0.001)
 
 # Converted
@@ -288,7 +334,7 @@ expect([1, 2, 3]).to match_array([2, 1, 3])
 ### Expectations on Proc
 
 ```ruby
-# Target
+# Targets
 lambda { do_something }.should raise_error
 proc { do_something }.should raise_error
 -> { do_something }.should raise_error
@@ -303,7 +349,7 @@ expect { do_something }.to raise_error
 ### Negative error expectations with specific error
 
 ```ruby
-# Target
+# Targets
 expect { do_something }.not_to raise_error(SomeErrorClass)
 expect { do_something }.not_to raise_error('message')
 expect { do_something }.not_to raise_error(SomeErrorClass, 'message')
@@ -320,7 +366,7 @@ lambda { do_something }.should_not raise_error # with `--disable expect_to_match
 ### Message expectations
 
 ```ruby
-# Target
+# Targets
 obj.should_receive(:foo)
 SomeClass.any_instance.should_receive(:foo)
 
@@ -335,7 +381,7 @@ expect_any_instance_of(SomeClass).to receive(:foo)
 ### Message expectations that are actually method stubs
 
 ```ruby
-# Target
+# Targets
 obj.should_receive(:foo).any_number_of_times
 obj.should_receive(:foo).at_least(0)
 
@@ -356,7 +402,7 @@ SomeClass.any_instance.stub(:foo) # with `--disable allow_to_receive`
 ### Method stubs
 
 ```ruby
-# Target
+# Targets
 obj.stub(:foo)
 
 obj.stub!(:foo)
@@ -382,7 +428,7 @@ allow_any_instance_of(SomeClass).to receive(:foo)
 ### Deprecated method stub aliases
 
 ```ruby
-# Target
+# Targets
 obj.stub!(:foo)
 obj.unstub!(:foo)
 
@@ -397,7 +443,7 @@ obj.unstub(:foo)
 ### Method stubs with deprecated specification of number of times
 
 ```ruby
-# Target
+# Targets
 obj.stub(:foo).any_number_of_times
 obj.stub(:foo).at_least(0)
 
@@ -412,7 +458,7 @@ obj.stub(:foo) # with `--disable allow_to_receive`
 ### Deprecated test double aliases
 
 ```ruby
-# Target
+# Targets
 stub('something')
 mock('something')
 

data/README.md.erb

@@ -16,7 +16,7 @@ Note that Transpec does not yet support all conversions for the RSpec changes,
 and also the changes for RSpec 3 is not fixed and may vary in the future.
 So it's recommended to follow updates of both RSpec and Transpec.
 
-## Example
+## Examples
 
 Here's an example spec:
 
@@ -64,6 +64,14 @@ Transpec would convert it to the following form:
 <%= Transpec::Rewriter.new.rewrite(example) -%>
 ```
 
+### Real Examples
+
+You can see real conversion examples below:
+
+* https://github.com/yujinakayama/guard/commit/transpec-demo
+* https://github.com/yujinakayama/mail/commit/transpec-demo
+* https://github.com/yujinakayama/twitter/commit/transpec-demo
+
 ## Installation
 
 ```bash
@@ -230,12 +238,50 @@ rewriter.rewrite(parenthesizing_example)
 -%>
 ```
 
+## Troubleshooting
+
+You might see the following warning while conversion:
+
+```
+Cannot convert #should into #expect since #expect is not available in the context.
+spec/awesome_spec.rb:4:      1.should == 1
+```
+
+This message would be shown with specs like this:
+
+```ruby
+describe '#should that cannot be converted to #expect' do
+  class MyAwesomeTestRunner
+    def run
+      1.should == 1
+    end
+  end
+
+  it 'is 1' do
+    test_runner = MyAwesomeTestRunner.new
+    test_runner.run
+  end
+end
+```
+
+### Reason
+
+* `should` is defined on `Kernel` (included by `Object`), so you can use `should` almost everywhere.
+* `expect` is defined on `RSpec::Matchers` (included by `RSpec::Core::ExampleGroup`), so you can use `expect` only where `self` is an instance of `RSpec::Core::ExampleGroup`.
+
+With the above example, in the context of `1.should == 1`, the `self` is an instance of `MyAwesomeTestRunner`.
+So Transpec tracks contexts and skips conversion if the target syntax cannot be converted in a case like this.
+
+### Solution
+
+You need to rewrite the spec by yourself.
+
 ## Supported Conversions
 
 ### Standard expectations
 
 ```ruby
-# Target
+# Targets
 obj.should matcher
 obj.should_not matcher
 
@@ -251,7 +297,7 @@ expect(obj).to_not matcher # with `--negative-form to_not`
 ### Operator matchers
 
 ```ruby
-# Target
+# Targets
 1.should == 1
 1.should < 2
 Integer.should === 1
@@ -271,7 +317,7 @@ expect([1, 2, 3]).to match_array([2, 1, 3])
 ### `be_close` matcher
 
 ```ruby
-# Target
+# Targets
 (1.0 / 3.0).should be_close(0.333, 0.001)
 
 # Converted
@@ -284,7 +330,7 @@ expect([1, 2, 3]).to match_array([2, 1, 3])
 ### Expectations on Proc
 
 ```ruby
-# Target
+# Targets
 lambda { do_something }.should raise_error
 proc { do_something }.should raise_error
 -> { do_something }.should raise_error
@@ -299,7 +345,7 @@ expect { do_something }.to raise_error
 ### Negative error expectations with specific error
 
 ```ruby
-# Target
+# Targets
 expect { do_something }.not_to raise_error(SomeErrorClass)
 expect { do_something }.not_to raise_error('message')
 expect { do_something }.not_to raise_error(SomeErrorClass, 'message')
@@ -316,7 +362,7 @@ lambda { do_something }.should_not raise_error # with `--disable expect_to_match
 ### Message expectations
 
 ```ruby
-# Target
+# Targets
 obj.should_receive(:foo)
 SomeClass.any_instance.should_receive(:foo)
 
@@ -331,7 +377,7 @@ expect_any_instance_of(SomeClass).to receive(:foo)
 ### Message expectations that are actually method stubs
 
 ```ruby
-# Target
+# Targets
 obj.should_receive(:foo).any_number_of_times
 obj.should_receive(:foo).at_least(0)
 
@@ -352,7 +398,7 @@ SomeClass.any_instance.stub(:foo) # with `--disable allow_to_receive`
 ### Method stubs
 
 ```ruby
-# Target
+# Targets
 obj.stub(:foo)
 
 obj.stub!(:foo)
@@ -378,7 +424,7 @@ allow_any_instance_of(SomeClass).to receive(:foo)
 ### Deprecated method stub aliases
 
 ```ruby
-# Target
+# Targets
 obj.stub!(:foo)
 obj.unstub!(:foo)
 
@@ -393,7 +439,7 @@ obj.unstub(:foo)
 ### Method stubs with deprecated specification of number of times
 
 ```ruby
-# Target
+# Targets
 obj.stub(:foo).any_number_of_times
 obj.stub(:foo).at_least(0)
 
@@ -408,7 +454,7 @@ obj.stub(:foo) # with `--disable allow_to_receive`
 ### Deprecated test double aliases
 
 ```ruby
-# Target
+# Targets
 stub('something')
 mock('something')
 

data/lib/transpec/cli.rb

@@ -39,17 +39,9 @@ module Transpec
 
       fail_if_should_not_continue!
 
-      paths = non_option_args
+      base_paths = base_target_paths(non_option_args)
 
-      if paths.empty?
-        if Dir.exists?('spec')
-          paths = ['spec']
-        else
-          fail ArgumentError, 'Specify target files or directories.'
-        end
-      end
-
-      target_files(paths).each do |file_path|
+      target_files(base_paths).each do |file_path|
         process_file(file_path)
       end
 
@@ -71,7 +63,7 @@ module Transpec
       @report.invalid_context_errors.concat(rewriter.invalid_context_errors)
 
       rewriter.invalid_context_errors.each do |error|
-        warn_not_in_example_group_context_error(error)
+        warn_invalid_context_error(error)
       end
     rescue Parser::SyntaxError => error
       @report.syntax_errors << error
@@ -176,6 +168,12 @@ module Transpec
 
     private
 
+    def base_target_paths(args)
+      return args unless args.empty?
+      return ['spec'] if Dir.exists?('spec')
+      fail ArgumentError, 'Specify target files or directories.'
+    end
+
     def ruby_files_in_directory(directory_path)
       ruby_file_paths = []
 
@@ -229,7 +227,7 @@ module Transpec
       warn "Syntax error at #{error.diagnostic.location}. Skipping the file.".color(:red)
     end
 
-    def warn_not_in_example_group_context_error(error)
+    def warn_invalid_context_error(error)
       message = error.message.color(:yellow) + $RS
       message << highlighted_source(error)
       warn message

data/lib/transpec/context.rb

@@ -8,11 +8,45 @@ module Transpec
 
     SCOPE_TYPES = [:module, :class, :sclass, :def, :defs, :block].freeze
 
-    EXAMPLE_GROUP_METHOD_NAMES = [
+    EXAMPLE_GROUP_METHODS = [
       :describe, :context,
       :shared_examples, :shared_context, :share_examples_for, :shared_examples_for
     ].freeze
 
+    EXAMPLE_METHODS = [
+      :example, :it, :specify,
+      :focus, :focused, :fit,
+      :pending, :xexample, :xit, :xspecify
+    ].freeze
+
+    HOOK_METHODS = [:before, :after, :around].freeze
+
+    HELPER_METHODS = [:subject, :subject!, :let, :let!]
+
+    NON_MONKEY_PATCH_EXPECTATION_AVAILABLE_CONTEXT = [
+      [:example_group, :example],
+      [:example_group, :each_before_after],
+      [:example_group, :all_before_after],
+      [:example_group, :around],
+      [:example_group, :helper],
+      [:example_group, :def],
+      [:rspec_configure, :each_before_after],
+      [:rspec_configure, :all_before_after],
+      [:rspec_configure, :around],
+      [:rspec_configure, :def],
+      [:module, :def]
+    ].freeze
+
+    NON_MONKEY_PATCH_MOCK_AVAILABLE_CONTEXT = [
+      [:example_group, :example],
+      [:example_group, :each_before_after],
+      [:example_group, :helper],
+      [:example_group, :def],
+      [:rspec_configure, :each_before_after],
+      [:rspec_configure, :def],
+      [:module, :def]
+    ].freeze
+
     attr_reader :nodes
 
     # @param nodes [Array] An array containing from root node to the target node.
@@ -23,79 +57,94 @@ module Transpec
     def scopes
       @scopes ||= begin
         scopes = @nodes.map { |node| scope_type(node) }
-        scopes.compact
+        scopes.compact!
+        scopes.extend(ArrayExtension)
+      end
+    end
+
+    def non_monkey_patch_expectation_available?
+      return @expectation_available if instance_variable_defined?(:@expectation_available)
+
+      return @expectation_available = true if scopes == [:def]
+
+      @expectation_available = NON_MONKEY_PATCH_EXPECTATION_AVAILABLE_CONTEXT.any? do |suffix|
+        scopes.end_with?(suffix)
       end
     end
 
-    def in_example_group?
-      return @in_example_group if instance_variable_defined?(:@in_example_group)
-      @in_example_group = in_method_or_block_in_example_group?   ||
-                          in_method_or_block_in_rspec_configure? ||
-                          in_method_in_module?                   ||
-                          in_method_in_top_level?
+    alias_method :expect_to_matcher_available?, :non_monkey_patch_expectation_available?
+
+    def non_monkey_patch_mock_available?
+      return @mock_available if instance_variable_defined?(:@mock_available)
+
+      return @mock_available = true if scopes == [:def]
+
+      @mock_available = NON_MONKEY_PATCH_MOCK_AVAILABLE_CONTEXT.any? do |suffix|
+        scopes.end_with?(suffix)
+      end
     end
 
+    alias_method :expect_to_receive_available?, :non_monkey_patch_mock_available?
+    alias_method :allow_to_receive_available?, :non_monkey_patch_mock_available?
+
     private
 
     def scope_type(node)
       return nil unless SCOPE_TYPES.include?(node.type)
-      return node.type unless node.type == :block
 
-      send_node = node.children.first
+      case node.type
+      when :block
+        special_block_type(node)
+      when :defs
+        if node.children.first.type == :self
+          nil
+        else
+          node.type
+        end
+      else
+        node.type
+      end
+    end
+
+    def special_block_type(block_node)
+      send_node = block_node.children.first
       receiver_node, method_name, *_ = *send_node
 
       if const_name(receiver_node) == 'RSpec' && method_name == :configure
         :rspec_configure
+      elsif HOOK_METHODS.include?(method_name)
+        hook_type(send_node)
       elsif receiver_node
-        node.type
-      elsif EXAMPLE_GROUP_METHOD_NAMES.include?(method_name)
+        nil
+      elsif EXAMPLE_GROUP_METHODS.include?(method_name)
         :example_group
+      elsif EXAMPLE_METHODS.include?(method_name)
+        :example
+      elsif HELPER_METHODS.include?(method_name)
+        :helper
       else
-        node.type
+        nil
       end
     end
 
-    def in_method_or_block_in_example_group?
-      scopes_in_example_group = inner_scopes_of(:example_group)
-      return false unless scopes_in_example_group
-      return false if include_class_scope?(scopes_in_example_group)
-      include_method_or_block_scope?(scopes_in_example_group)
-    end
-
-    def in_method_or_block_in_rspec_configure?
-      scopes_in_rspec_configure = inner_scopes_of(:rspec_configure)
-      return false unless scopes_in_rspec_configure
-      return false if include_class_scope?(scopes_in_rspec_configure)
-      include_method_or_block_scope?(scopes_in_rspec_configure)
-    end
-
-    def in_method_in_module?
-      scopes_in_module = inner_scopes_of(:module)
-      return false unless scopes_in_module
-      return false if include_class_scope?(scopes_in_module)
-      scopes_in_module.include?(:def)
-    end
+    def hook_type(send_node)
+      _, method_name, arg_node, *_ = *send_node
 
-    def in_method_in_top_level?
-      return false unless scopes.first == :def
-      scopes_in_method = scopes[1..-1]
-      !include_class_scope?(scopes_in_method)
-    end
+      return :around if method_name == :around
 
-    def inner_scopes_of(scope_type)
-      index = scopes.rindex(scope_type)
-      return nil unless index
-      scopes[Range.new(index + 1, -1)]
-    end
+      if arg_node && [:sym, :str].include?(arg_node.type)
+         hook_arg = arg_node.children.first.to_sym
+         return :all_before_after if hook_arg == :all
+      end
 
-    def include_class_scope?(scopes)
-      !(scopes & [:class, :sclass]).empty?
+      :each_before_after
     end
 
-    def include_method_or_block_scope?(scopes)
-      # TODO: Should validate whether the method taking the block is RSpec's
-      #   special method. (e.g. #subject, #let, #before, #after)
-      !(scopes & [:def, :block]).empty?
+    module ArrayExtension
+      def end_with?(*args)
+        tail = args.flatten
+        self[-(tail.size)..-1] == tail
+      end
     end
   end
 end