transpec 2.3.1 → 2.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c90c3e229024fe5588256af42c0ac3fdc30f146a
-  data.tar.gz: 3d786286cac9c9298c9aaa073288ad2bb1e83a50
+  metadata.gz: e2ca68d2ec61ab33ba2a0111a03728a08925606d
+  data.tar.gz: df0d66e1266197c0fe17a3533cafa4a6cd1649ee
 SHA512:
-  metadata.gz: 28e8ac6dacd5834196381b9510bd3b4d8394f084eedfb584407a7a6234d68cd3fe6da89957a7b7be2f7481c0f3ab0aa43e25655554885bd3258a626faf59f793
-  data.tar.gz: ee3405cacf7e33bcfe378ebc55af52e9b69d4e2041bc78cdbb8e363706ae0b9011f65db64c6a8b94ea69a5291b0aa9e74c0827fb50254baa974a6d3d19d47c7f
+  metadata.gz: 7221ef0ade502c3ab43987fc1fcb24c671795f840ebe4e29d073803f417592e616dc97130a12e8bcd4b75c78fb21b1b693bd7630522577b084c090747656092d
+  data.tar.gz: 5aa6b286c235b51e47ab7bba1ac8f26bc25a26e85e3632f3305bdcd0f4c12bc39e04096fe4ee76b71bcc47652c78b53810e6a4a3c178bee42867bc425f77e2ec

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v2.3.2
+
+* Fix a bug where explicit spec type metadata are added to wrong position when the `describe` has multiple non-metadata arguments (e.g. `describe Something, '#some_method' { }`). ([#77](https://github.com/yujinakayama/transpec/issues/77))
+
 ## v2.3.1
 
 * Remove conversion support for non-existent configuration option `backtrace_cleaner=`.

data/CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing
 
-If you're going to report an issue or submit a pull requrest, please follow these guidelines.
+If you're going to report an issue or submit a pull request, please follow these guidelines.
 
 ## Reporting an Issue
 

data/Gemfile

@@ -2,8 +2,6 @@ source 'https://rubygems.org'
 
 gemspec
 
-gem 'rubocop', github: 'bbatsov/rubocop' if RUBY_VERSION.start_with?('2.2')
-
 group :test do
   gem 'coveralls',      '~> 0.6'
   gem 'simplecov-rcov', '~> 0.2'

data/README.md

@@ -147,7 +147,7 @@ Converting spec/transpec/ast/node_spec.rb
 
 This will run the specs, convert them, and overwrite all spec files in the `spec` directory.
 
-After the conversion, run `rspec` again and check whether everything is green:
+After the conversion, run `rspec` again and check whether everything is still green:
 
 ```bash
 $ bundle exec rspec
@@ -164,7 +164,7 @@ And you are done!
 
 ## Advanced Usage
 
-### Convert only specific specs
+### Convert only specific files
 
 You can pass `transpec` arbitrary paths to convert:
 
@@ -183,15 +183,17 @@ $ transpec spec/baz_spec.rb
 ```
 
 Note that the current working directory always needs to be the project root directory,
-so that Transpec can copy the project in dynamic analysis.
+so that Transpec can know where the root is.
 
 ### Enable/disable specific conversions
 
 You can disable specific conversions that are enabled by default with `-k/--keep` option,
 and enable conversions that are disabled by default with the `-v/--convert` option.
 
-```bash
-$ transpec --keep its --convert example_group
+If you are willing to try the latest and modern syntax, type the following:
+
+```
+$ transpec --convert example_group,hook_scope
 ```
 
 See [`-k/--keep`](#-k--keep) and [`-v/--convert`](#-v--convert) for more details.
@@ -325,6 +327,12 @@ 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/--no-explicit-spec-type`
+
+Suppress adding explicit spec `:type` metadata to example groups in a project using rspec-rails.
+
+See [Supported Conversions - Implicit spec types in rspec-rails](#implicit-spec-types-in-rspec-rails) for more details.
+
 ### `-p/--no-parens-matcher-arg`
 
 Suppress parenthesizing arguments of matchers when converting

data/README.md.erb

@@ -121,7 +121,7 @@ Converting spec/transpec/ast/node_spec.rb
 
 This will run the specs, convert them, and overwrite all spec files in the `spec` directory.
 
-After the conversion, run `rspec` again and check whether everything is green:
+After the conversion, run `rspec` again and check whether everything is still green:
 
 ```bash
 $ bundle exec rspec
@@ -138,7 +138,7 @@ And you are done!
 
 ## Advanced Usage
 
-### Convert only specific specs
+### Convert only specific files
 
 You can pass `transpec` arbitrary paths to convert:
 
@@ -157,15 +157,17 @@ $ transpec spec/baz_spec.rb
 ```
 
 Note that the current working directory always needs to be the project root directory,
-so that Transpec can copy the project in dynamic analysis.
+so that Transpec can know where the root is.
 
 ### Enable/disable specific conversions
 
 You can disable specific conversions that are enabled by default with `-k/--keep` option,
 and enable conversions that are disabled by default with the `-v/--convert` option.
 
-```bash
-$ transpec --keep its --convert example_group
+If you are willing to try the latest and modern syntax, type the following:
+
+```
+$ transpec --convert example_group,hook_scope
 ```
 
 See [`-k/--keep`](#-k--keep) and [`-v/--convert`](#-v--convert) for more details.
@@ -313,6 +315,12 @@ 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/--no-explicit-spec-type`
+
+Suppress adding explicit spec `:type` metadata to example groups in a project using rspec-rails.
+
+See [Supported Conversions - Implicit spec types in rspec-rails](#implicit-spec-types-in-rspec-rails) for more details.
+
 ### `-p/--no-parens-matcher-arg`
 
 Suppress parenthesizing arguments of matchers when converting

data/lib/transpec/ast/node.rb

@@ -1,88 +1,15 @@
 # coding: utf-8
 
-require 'parser'
+require 'astrolabe/node'
 
 module Transpec
   module AST
-    class Node < Parser::AST::Node
+    class Node < Astrolabe::Node
       attr_reader :metadata
 
       def initialize(type, children = [], properties = {})
         @metadata = {}
-        @mutable_attributes = {}
-
-        # ::AST::Node#initialize freezes itself.
         super
-
-        each_child_node do |child_node|
-          child_node.parent_node = self
-        end
-      end
-
-      Parser::Meta::NODE_TYPES.each do |node_type|
-        method_name = "#{node_type.to_s.gsub(/\W/, '')}_type?"
-        define_method(method_name) do
-          type == node_type
-        end
-      end
-
-      def parent_node
-        @mutable_attributes[:parent_node]
-      end
-
-      def parent_node=(node)
-        @mutable_attributes[:parent_node] = node
-      end
-
-      protected :parent_node=
-
-      def each_ancestor_node(&block)
-        return to_enum(__method__) unless block_given?
-
-        if parent_node
-          yield parent_node
-          parent_node.each_ancestor_node(&block)
-        end
-
-        self
-      end
-
-      def ancestor_nodes
-        each_ancestor_node.to_a
-      end
-
-      def each_child_node
-        return to_enum(__method__) unless block_given?
-
-        children.each do |child|
-          next unless child.is_a?(self.class)
-          yield child
-        end
-
-        self
-      end
-
-      def child_nodes
-        each_child_node.to_a
-      end
-
-      def each_descendent_node(&block)
-        return to_enum(__method__) unless block_given?
-
-        each_child_node do |child_node|
-          yield child_node
-          child_node.each_descendent_node(&block)
-        end
-      end
-
-      def descendent_nodes
-        each_descendent_node.to_a
-      end
-
-      def each_node(&block)
-        return to_enum(__method__) unless block_given?
-        yield self
-        each_descendent_node(&block)
       end
     end
   end

data/lib/transpec/directory_cloner.rb

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+require 'fileutils'
+require 'find'
+require 'pathname'
+
+module Transpec
+  # This module performs almost the same thing as FileUtils#cp_r, expect ignoring pseudo files
+  # (e.g.pipe, socket).
+  module DirectoryCloner
+    module_function
+
+    def copy_recursively(source_root, destination_root)
+      source_root = File.expand_path(source_root)
+      source_root_pathname = Pathname.new(source_root)
+
+      destination_root = File.expand_path(destination_root)
+      if File.directory?(destination_root)
+        destination_root = File.join(destination_root, File.basename(source_root))
+      end
+
+      Find.find(source_root) do |source_path|
+        relative_path = Pathname.new(source_path).relative_path_from(source_root_pathname).to_s
+        destination_path = File.join(destination_root, relative_path)
+        copy(source_path, destination_path)
+      end
+
+      destination_root
+    end
+
+    def copy(source, destination)
+      if File.symlink?(source)
+        File.symlink(File.readlink(source), destination)
+      elsif File.directory?(source)
+        FileUtils.mkdir_p(destination)
+      elsif File.file?(source)
+        FileUtils.copy_file(source, destination)
+      end
+
+      copy_permission(source, destination) if File.exist?(destination)
+    end
+
+    def copy_permission(source, destination)
+      source_mode = File.lstat(source).mode
+      begin
+        File.lchmod(source_mode, destination)
+      rescue NotImplementedError, Errno::ENOSYS
+        # Should not change mode of symlink's destination.
+        File.chmod(source_mode, destination) unless File.symlink?(destination)
+      end
+    end
+  end
+end

data/lib/transpec/dynamic_analyzer.rb

@@ -2,14 +2,12 @@
 
 require 'transpec/dynamic_analyzer/rewriter'
 require 'transpec/dynamic_analyzer/runtime_data'
+require 'transpec/directory_cloner'
 require 'transpec/project'
 require 'transpec/spec_suite'
-require 'tmpdir'
-require 'find'
-require 'pathname'
-require 'fileutils'
-require 'shellwords'
 require 'erb'
+require 'shellwords'
+require 'tmpdir'
 require 'English'
 
 module Transpec
@@ -47,30 +45,7 @@ module Transpec
         put_analysis_helper
         modify_dot_rspec
         run_rspec(paths)
-
-        begin
-          File.open(RESULT_FILE) do |file|
-            RuntimeData.load(file)
-          end
-        rescue
-          raise AnalysisError
-        end
-      end
-    end
-
-    def copy_recursively(source_root, destination_root)
-      source_root = File.expand_path(source_root)
-      source_root_pathname = Pathname.new(source_root)
-
-      destination_root = File.expand_path(destination_root)
-      if File.directory?(destination_root)
-        destination_root = File.join(destination_root, File.basename(source_root))
-      end
-
-      Find.find(source_root) do |source_path|
-        relative_path = Pathname.new(source_path).relative_path_from(source_root_pathname).to_s
-        destination_path = File.join(destination_root, relative_path)
-        copy(source_path, destination_path)
+        load_analysis_result
       end
     end
 
@@ -82,8 +57,7 @@ module Transpec
       @in_copied_project = true
 
       Dir.mktmpdir do |tmpdir|
-        copy_recursively(project.path, tmpdir)
-        copied_project_path = File.join(tmpdir, project.basename)
+        copied_project_path = DirectoryCloner.copy_recursively(project.path, tmpdir)
         Dir.chdir(copied_project_path) do
           yield
         end
@@ -136,26 +110,12 @@ module Transpec
       File.write(filename, content)
     end
 
-    def copy(source, destination)
-      if File.symlink?(source)
-        File.symlink(File.readlink(source), destination)
-      elsif File.directory?(source)
-        FileUtils.mkdir_p(destination)
-      elsif File.file?(source)
-        FileUtils.copy_file(source, destination)
-      end
-
-      copy_permission(source, destination) if File.exist?(destination)
-    end
-
-    def copy_permission(source, destination)
-      source_mode = File.lstat(source).mode
-      begin
-        File.lchmod(source_mode, destination)
-      rescue NotImplementedError, Errno::ENOSYS
-        # Should not change mode of symlink's destination.
-        File.chmod(source_mode, destination) unless File.symlink?(destination)
+    def load_analysis_result
+      File.open(RESULT_FILE) do |file|
+        RuntimeData.load(file)
       end
+    rescue
+      raise AnalysisError
     end
 
     class AnalysisError < StandardError; end

data/lib/transpec/record.rb

@@ -98,13 +98,22 @@ module Transpec
       new(*args).build
     end
 
+    def self.param_names(*names)
+      names.each_with_index do |name, index|
+        define_method(name) do
+          @initializer_params[index]
+        end
+      end
+    end
+
     def build
       Record.new(old_syntax, new_syntax, { type: type, annotation: annotation })
     end
 
     private
 
-    def initialize(*)
+    def initialize(*params)
+      @initializer_params = params
     end
 
     def old_syntax

data/lib/transpec/rspec_dsl.rb

@@ -3,8 +3,6 @@
 # Aliases by Capybara:
 # https://github.com/jnicklas/capybara/blob/2.2.0/lib/capybara/rspec/features.rb
 
-# rubocop:disable LineLength
-
 module Transpec
   module RSpecDSL
     # https://github.com/rspec/rspec-core/blob/77cc21e/lib/rspec/core/example_group.rb#L239-L265

data/lib/transpec/static_context_inspector.rb

@@ -68,7 +68,7 @@ module Transpec
     def valid_ancestor_nodes
       valid_nodes = []
 
-      self_and_ancestor_nodes = [node] + node.ancestor_nodes
+      self_and_ancestor_nodes = [node] + node.each_ancestor.to_a
 
       self_and_ancestor_nodes.each_cons(2) do |child, parent|
         valid_nodes << parent unless belong_to_direct_outer_scope?(child)
@@ -78,8 +78,8 @@ module Transpec
     end
 
     def belong_to_direct_outer_scope?(node)
-      return false unless TWISTED_SCOPE_TYPES.include?(node.parent_node.type)
-      scope_node = node.parent_node
+      return false unless TWISTED_SCOPE_TYPES.include?(node.parent.type)
+      scope_node = node.parent
       return true if node.equal?(scope_node.children[0])
       scope_node.class_type? && node.equal?(scope_node.children[1])
     end

data/lib/transpec/syntax/current_example.rb

@@ -34,9 +34,8 @@ module Transpec
       def block_node
         return @block_node if instance_variable_defined?(:@block_node)
 
-        @block_node ||= node.each_ancestor_node.find do |ancestor_node|
-          next false unless ancestor_node.block_type?
-          method_name = method_name_of_block_node(ancestor_node)
+        @block_node = node.each_ancestor(:block).find do |block_node|
+          method_name = method_name_of_block_node(block_node)
           METHODS_YIELD_EXAMPLE.include?(method_name)
         end
       end
@@ -72,11 +71,7 @@ module Transpec
       class RecordBuilder < Transpec::RecordBuilder
         include RSpecDSL
 
-        attr_reader :current_example
-
-        def initialize(current_example)
-          @current_example = current_example
-        end
+        param_names :current_example
 
         def old_syntax
           if current_example.block_node

data/lib/transpec/syntax/example.rb

@@ -40,7 +40,7 @@ module Transpec
         metadata_key_nodes.each do |node|
           next unless pending_symbol?(node)
           replace(symbol_range_without_colon(node), 'skip')
-          if node.parent_node.pair_type?
+          if node.parent.pair_type?
             add_record("it 'is an example', :pending => value { }",
                        "it 'is an example', :skip => value { }")
           else

data/lib/transpec/syntax/example_group.rb

@@ -57,7 +57,7 @@ module Transpec
                   "type: #{type.inspect}"
                 end
 
-        insert_after(arg_node.loc.expression, code)
+        insert_after(metadata_insertion_point, code)
 
         add_record(ExplicitTypeMetadataRecordBuilder.build(self))
       end
@@ -96,12 +96,20 @@ module Transpec
         end
       end
 
-      class NonMonkeyPatchRecordBuilder < RecordBuilder
-        attr_reader :example_group
+      def metadata_insertion_point
+        hash_metadata_node_index = arg_nodes.find_index(&:hash_type?)
 
-        def initialize(example_group)
-          @example_group = example_group
-        end
+        last_non_hash_arg_node = if hash_metadata_node_index
+                                   arg_nodes[hash_metadata_node_index - 1]
+                                 else
+                                   arg_nodes.last
+                                 end
+
+        last_non_hash_arg_node.loc.expression.end
+      end
+
+      class NonMonkeyPatchRecordBuilder < RecordBuilder
+        param_names :example_group
 
         def old_syntax
           base_syntax
@@ -117,11 +125,7 @@ module Transpec
       end
 
       class ExplicitTypeMetadataRecordBuilder < RecordBuilder
-        attr_reader :example_group
-
-        def initialize(example_group)
-          @example_group = example_group
-        end
+        param_names :example_group
 
         def old_syntax
           "describe 'some #{spec_type}' { }"

data/lib/transpec/syntax/have/dynamic_analysis.rb

@@ -47,9 +47,7 @@ module Transpec
           # `expect(owner).to have(n).things` invokes private owner#things with Object#__send__
           # if the owner does not respond to any of #size, #count and #length.
           #
-          # rubocop:disable LineLength
           # https://github.com/rspec/rspec-expectations/blob/v2.14.3/lib/rspec/matchers/built_in/have.rb#L48-L58
-          # rubocop:enable LineLength
           @collection_accessor_inspection_code ||= <<-END.gsub(/^\s+\|/, '').chomp
             |begin
             |  exact_name = #{items_name.inspect}

data/lib/transpec/syntax/have/record_builder.rb

@@ -6,11 +6,7 @@ module Transpec
   class Syntax
     class Have
       class RecordBuilder < Transpec::RecordBuilder
-        attr_reader :have
-
-        def initialize(have)
-          @have = have
-        end
+        param_names :have
 
         def annotation
           return @annotation if instance_variable_defined?(:@annotation)

data/lib/transpec/syntax/its.rb

@@ -50,7 +50,7 @@ module Transpec
       alias_method :attribute_node, :arg_node
 
       def block_node
-        node.parent_node
+        node.parent
       end
 
       def description?
@@ -182,11 +182,7 @@ module Transpec
       Attribute = Struct.new(:selector, :description)
 
       class RecordBuilder < Transpec::RecordBuilder
-        attr_reader :its
-
-        def initialize(its)
-          @its = its
-        end
+        param_names :its
 
         def old_syntax
           if its.attribute_expression.brackets?

data/lib/transpec/syntax/method_stub.rb

@@ -11,13 +11,11 @@ module Transpec
     class MethodStub < Syntax
       include Mixin::MonkeyPatchAnyInstance, Mixin::MessagingHost, Util
 
-      # rubocop:disable LineLength
       CLASSES_DEFINING_OWN_STUB_METHOD = [
         'Typhoeus', # https://github.com/typhoeus/typhoeus/blob/6a59c62/lib/typhoeus.rb#L66-L85
         'Excon',    # https://github.com/geemus/excon/blob/6af4f9c/lib/excon.rb#L143-L178
         'Factory'   # https://github.com/thoughtbot/factory_girl/blob/v3.6.2/lib/factory_girl/syntax/vintage.rb#L112
       ]
-      # rubocop:enable LineLength
 
       define_dynamic_analysis do |rewriter|
         register_syntax_availability_analysis_request(
@@ -170,12 +168,7 @@ module Transpec
       end
 
       class AllowRecordBuilder < RecordBuilder
-        attr_reader :method_stub, :conversion_type
-
-        def initialize(method_stub, conversion_type)
-          @method_stub = method_stub
-          @conversion_type = conversion_type
-        end
+        param_names :method_stub, :conversion_type
 
         def old_syntax
           syntax = method_stub.any_instance? ? 'Klass.any_instance' : 'obj'
@@ -208,11 +201,7 @@ module Transpec
       end
 
       class DeprecatedMethodRecordBuilder < RecordBuilder
-        attr_reader :method_stub
-
-        def initialize(method_stub)
-          @method_stub = method_stub
-        end
+        param_names :method_stub
 
         def old_syntax
           syntax = method_stub.any_instance? ? 'Klass.any_instance' : 'obj'
@@ -227,16 +216,12 @@ module Transpec
       end
 
       class NoMessageAllowanceRecordBuilder < RecordBuilder
-        attr_reader :method_stub
-
-        def initialize(method_stub)
-          @method_stub = method_stub
-        end
+        param_names :method_stub
 
         def old_syntax
           syntax = base_syntax
-          syntax << '.any_number_of_times' if @method_stub.any_number_of_times?
-          syntax << '.at_least(0)' if @method_stub.at_least_zero?
+          syntax << '.any_number_of_times' if method_stub.any_number_of_times?
+          syntax << '.at_least(0)' if method_stub.at_least_zero?
           syntax
         end
 
@@ -245,7 +230,7 @@ module Transpec
         end
 
         def base_syntax
-          "obj.#{@method_stub.method_name}(:message)"
+          "obj.#{method_stub.method_name}(:message)"
         end
       end
     end

data/lib/transpec/syntax/mixin/any_instance_block.rb

@@ -37,11 +37,7 @@ module Transpec
         end
 
         class RecordBuilder < Transpec::RecordBuilder
-          attr_reader :host
-
-          def initialize(host)
-            @host = host
-          end
+          param_names :host
 
           def old_syntax
             "#{base_syntax} { |arg| }"

data/lib/transpec/syntax/mixin/expect_base.rb

@@ -43,7 +43,7 @@ module Transpec
           return nil unless parent_node
 
           if parent_node.block_type? && parent_node.children.first.equal?(node)
-            parent_node.parent_node
+            parent_node.parent
           elsif parent_node.send_type? && parent_node.children.first.equal?(node)
             parent_node
           else

data/lib/transpec/syntax/mixin/metadata.rb

@@ -11,7 +11,16 @@ module Transpec
         include Send
 
         def metadata_nodes
-          arg_nodes[1..-1] || []
+          return arg_nodes if arg_nodes.empty?
+
+          # The first argument must be always description.
+          non_description_arg_nodes = arg_nodes.drop(1)
+
+          non_description_arg_nodes.drop_while do |node|
+            # Possibly there still may be descriptions after the first arg.
+            #   describe 'something', '#some_method', :foo, bar: true { }
+            ![:hash, :sym].include?(node.type)
+          end
         end
 
         def metadata_key_nodes