transpec 2.3.8 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb9406724bb6b0b2dd4a820087ce298134d0abbf
-  data.tar.gz: c9cd123d3c4a95f6f74cb536b8f0e614362defb9
+  metadata.gz: fe2492f7a3b324bdfb3f2facd8a1ffb9369b6228
+  data.tar.gz: f710841766c727037a9adb01c857f4a365c39a73
 SHA512:
-  metadata.gz: 067c988d340e8d447ec75fafd9697d465651e7731c8b43fca3b76559139c16b0ee867bc57f3a06344df5127aff1af51e2ad8b3c5531d162729e705ddb2c00e50
-  data.tar.gz: 5b96068adbf78f05d7ca66faa64b6377248b51733114f916e2a67e92b9c47b3537d1f368de2dd369f7427fa4ab979509ac92fcb469972ef432246bbf9b8d39a2
+  metadata.gz: 35e7f4ef63186b8203c900cffe147e7dc0edf2686c7c2621055f72690c8f1ac8363128c869900942ef8901dcc1410db8b74d51068a1dfed6ae59f04e6ec2030b
+  data.tar.gz: c8077f07f56bee2f1828c8b7cc44b0c3c3239ae5a84a271c8e9244a8c8a5877a593d0bf211c07dd559c7f2062273735743b89c954f08174e13f8e9980ecb228d

data/.rubocop.yml

@@ -1,6 +1,7 @@
 
 AllCops:
   Include:
+    - 'Guardfile'
     - '**/*.rake'
   Exclude:
     - 'tmp/**/*'
@@ -12,6 +13,9 @@ LineLength:
 MethodLength:
   Max: 17
 
+ParameterLists:
+  Max: 6
+
 CyclomaticComplexity:
   Max: 8
 
@@ -24,6 +28,13 @@ AbcSize:
 WordArray:
   Enabled: false
 
+RegexpLiteral:
+  Exclude:
+    - 'Guardfile'
+
+EmptyElse:
+  Enabled: false
+
 AlignHash:
   # Alignment of entries using hash rocket as separator. Valid values are:
   #

data/CHANGELOG.md

@@ -2,9 +2,16 @@
 
 ## Development
 
+## v3.0.0
+
+* Check whether rspec-rails is used in the target project via `Gemfile.lock` when `-s/--skip-dynamic-analysis` option is specified. ([#88](https://github.com/yujinakayama/transpec/issues/88))
+* Now by default the addition of `config.infer_spec_type_from_file_location!` is enabled and the addition of explicit `:type` metadata to each example group is disabled in a project using `rspec-rails` (the former behavior with `-t/--no-explicit-spec-type`).
+* Remove `-t/--no-explicit-spec-type` and add `-e/--explicit-spec-type` option.
+* Handle separated git-dir repository on generation of the commit message. ([#94](https://github.com/yujinakayama/transpec/issues/94))
+
 ## v2.3.8
 
-* Fix an error on processing one-liner `should` that is not directly encloses in an example block. ([#93](https://github.com/yujinakayama/transpec/issues/93))
+* Fix an error on processing one-liner `should` that is not directly enclosed in an example block. ([#93](https://github.com/yujinakayama/transpec/issues/93))
 
 ## v2.3.7
 

data/Gemfile

@@ -4,6 +4,4 @@ gemspec
 
 group :test do
   gem 'coveralls',      '~> 0.6'
-  gem 'simplecov-rcov', '~> 0.2'
-  gem 'ci_reporter',    '~> 1.8'
 end

data/Guardfile

@@ -7,8 +7,8 @@ group :red_green_refactor, halt_on_fail: true do
   guard :rspec, cmd: 'bundle exec rspec --format Fuubar' do
     watch(%r{^spec/.+_spec\.rb$})
     watch(%r{^lib/(.+)\.rb$})        { |m| "spec/#{m[1]}_spec.rb" }
-    watch('spec/spec_helper.rb')     { "spec" }
-    watch(%r{^spec/support/.+\.rb$}) { "spec" }
+    watch('spec/spec_helper.rb')     { 'spec' }
+    watch(%r{^spec/support/.+\.rb$}) { 'spec' }
   end
 
   guard :rubocop, all_on_start: false, cli: '--format fuubar' do

data/README.md

@@ -306,6 +306,12 @@ $ transpec --boolean-matcher true,false
 
 See [Supported Conversions - Boolean matchers](#boolean-matchers) for more details.
 
+### `-e/--explicit-spec-type`
+
+Add 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.
+
 ### `-a/--no-yield-any-instance`
 
 Suppress yielding receiver instances to `any_instance` implementation blocks as the first block argument.
@@ -317,12 +323,6 @@ 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
@@ -1270,16 +1270,6 @@ end
 
 Will be converted to:
 
-```ruby
-RSpec.configure do |rspec|
-end
-
-describe SomeModel, :type => :model do
-end
-```
-
-Or with `--no-explicit-spec-type` option they will be converted to:
-
 ```ruby
 RSpec.configure do |rspec|
   # rspec-rails 3 will no longer automatically infer an example group's spec type
@@ -1298,6 +1288,16 @@ describe SomeModel do
 end
 ```
 
+Or with `--explicit-spec-type` option they will be converted to:
+
+```ruby
+RSpec.configure do |rspec|
+end
+
+describe SomeModel, :type => :model do
+end
+```
+
 * 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)

data/README.md.erb

@@ -294,6 +294,12 @@ $ transpec --boolean-matcher true,false
 
 See [Supported Conversions - Boolean matchers](#boolean-matchers) for more details.
 
+### `-e/--explicit-spec-type`
+
+Add 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.
+
 ### `-a/--no-yield-any-instance`
 
 Suppress yielding receiver instances to `any_instance` implementation blocks as the first block argument.
@@ -305,12 +311,6 @@ 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
@@ -1328,13 +1328,13 @@ END
 Will be converted to:
 
 ```ruby
-<%= convert(example, rspec_version: rspec_version, path: 'spec/models/some_model_spec.rb') -%>
+<%= convert(example, rspec_version: rspec_version, rails: true, path: 'spec/models/some_model_spec.rb') -%>
 ```
 
-Or with `--no-explicit-spec-type` option they will be converted to:
+Or with `--explicit-spec-type` option they will be converted to:
 
 ```ruby
-<%= convert(example, rspec_version: rspec_version, path: 'spec/models/some_model_spec.rb', cli: ['--no-explicit-spec-type']) -%>
+<%= convert(example, rspec_version: rspec_version, rails: true, path: 'spec/models/some_model_spec.rb', cli: ['--explicit-spec-type']) -%>
 ```
 
 * This conversion can be disabled by: `--keep deprecated`

data/lib/transpec/cli.rb

@@ -34,8 +34,12 @@ module Transpec
         return false
       end
 
-      done = process(paths)
-      return false unless done
+      begin
+        process(paths)
+      rescue DynamicAnalyzer::AnalysisError => error
+        warn "\n" + error.message.color(:red)
+        return false
+      end
 
       display_summary
       generate_commit_message
@@ -47,10 +51,9 @@ module Transpec
     def process(paths)
       unless config.skip_dynamic_analysis?
         runtime_data = run_dynamic_analysis(paths)
-        return false unless runtime_data
       end
 
-      spec_suite = SpecSuite.new(paths, runtime_data)
+      spec_suite = SpecSuite.new(project, paths, runtime_data)
       # Actually #analyze does not need to be invoked here, but doing this will avoid long freeze
       # while conversion of files.
       puts 'Gathering the spec suite data...'
@@ -60,8 +63,6 @@ module Transpec
       spec_suite.specs.each do |spec|
         convert_spec(spec, spec_suite)
       end
-
-      true
     end
 
     def run_dynamic_analysis(paths)
@@ -69,7 +70,7 @@ module Transpec
 
       puts 'Copying the project for dynamic analysis...'
 
-      DynamicAnalyzer.new(rspec_command: config.rspec_command) do |analyzer|
+      DynamicAnalyzer.new(project: project, rspec_command: config.rspec_command) do |analyzer|
         puts "Running dynamic analysis with command #{analyzer.rspec_command.inspect}..."
         runtime_data = analyzer.analyze(paths)
       end
@@ -77,15 +78,12 @@ module Transpec
       puts
 
       runtime_data
-    rescue DynamicAnalyzer::AnalysisError => error
-      warn "\n" + error.message.color(:red)
-      return nil
     end
 
     def convert_spec(spec, spec_suite)
       puts "Converting #{spec.path}"
 
-      converter = Converter.new(spec_suite, config, project.rspec_version)
+      converter = Converter.new(spec_suite, project, config)
       converter.convert_file!(spec)
 
       warn_annotations(converter.report)
@@ -129,11 +127,12 @@ module Transpec
       return unless Git.command_available? && Git.inside_of_repository?
 
       commit_message = CommitMessage.new(report, project.rspec_version, ARGV)
-      Git.write_commit_message(commit_message.to_s)
+      commit_message_path = Git.write_commit_message(commit_message.to_s)
+      commit_message_path = Pathname.new(commit_message_path).relative_path_from(Pathname.pwd)
 
       puts
       puts 'A commit message that describes the conversion summary was generated to'.color(:cyan)
-      puts '.git/COMMIT_EDITMSG. To use the message, type the following command for'.color(:cyan)
+      puts "#{commit_message_path}. To use the message, type the following command for".color(:cyan)
       puts 'the next commit:'.color(:cyan)
       puts '    git commit -aeF .git/COMMIT_EDITMSG'
     end

data/lib/transpec/config.rb

@@ -20,8 +20,8 @@ module Transpec
       [:convert_hook_scope,                                    false],
       [:convert_stub_with_hash_to_allow_to_receive_and_return, false],
       [:skip_dynamic_analysis,                                 false],
+      [:add_explicit_type_metadata_to_example_group,           false],
       [:add_receiver_arg_to_any_instance_implementation_block, true],
-      [:add_explicit_type_metadata_to_example_group,           true],
       [:parenthesize_matcher_arg,                              true]
     ].freeze
 

data/lib/transpec/converter.rb

@@ -2,8 +2,8 @@
 
 require 'transpec/base_rewriter'
 require 'transpec/config'
+require 'transpec/project'
 require 'transpec/report'
-require 'transpec/rspec_version'
 require 'transpec/spec_suite'
 require 'transpec/syntax'
 
@@ -13,16 +13,16 @@ module Transpec
   class Converter < BaseRewriter # rubocop:disable ClassLength
     include Syntax::Dispatcher
 
-    attr_reader :spec_suite, :config, :rspec_version, :report
+    attr_reader :spec_suite, :project, :config, :report
 
     alias_method :convert_file!, :rewrite_file!
     alias_method :convert_source, :rewrite_source
     alias_method :convert, :rewrite
 
-    def initialize(spec_suite = nil, config = nil, rspec_version = nil)
+    def initialize(spec_suite = nil, project = nil, config = nil)
       @spec_suite = spec_suite || SpecSuite.new
+      @project = project || Project.new
       @config = config || Config.new
-      @rspec_version = rspec_version || Transpec.required_rspec_version
       @report = Report.new
     end
 
@@ -30,12 +30,16 @@ module Transpec
       spec_suite.runtime_data
     end
 
+    def rspec_version
+      project.rspec_version
+    end
+
     def process(ast, source_rewriter)
       return unless ast
 
       ast.each_node do |node|
         begin
-          dispatch_node(node, source_rewriter, runtime_data, report)
+          dispatch_node(node, runtime_data, project, source_rewriter, report)
         rescue ConversionError => error
           report.conversion_errors << error
         end
@@ -88,7 +92,7 @@ module Transpec
         if !method_stub.hash_arg? ||
            rspec_version.receive_messages_available? ||
            config.convert_stub_with_hash_to_allow_to_receive_and_return?
-          method_stub.allowize!(rspec_version)
+          method_stub.allowize!
         elsif config.convert_deprecated_method?
           method_stub.convert_deprecated_method!
         end
@@ -166,7 +170,7 @@ module Transpec
 
     def process_rspec_configure(rspec_configure)
       if config.convert_deprecated_method?
-        rspec_configure.convert_deprecated_options!(rspec_version)
+        rspec_configure.convert_deprecated_options!
       end
 
       if spec_suite.main_rspec_configure_node?(rspec_configure.node)

data/lib/transpec/dynamic_analyzer.rb

@@ -29,7 +29,7 @@ module Transpec
     end
 
     def default_rspec_command
-      if project.require_bundler?
+      if project.using_bundler?
         'bundle exec rspec'
       else
         'rspec'
@@ -76,7 +76,7 @@ module Transpec
     def rewrite_specs(paths)
       rewriter = Rewriter.new
 
-      spec_suite = SpecSuite.new(paths)
+      spec_suite = SpecSuite.new(project, paths)
 
       spec_suite.specs.each do |spec|
         next if spec.error

data/lib/transpec/git.rb

@@ -3,7 +3,7 @@
 module Transpec
   module Git
     GIT = 'git'
-    COMMIT_MESSAGE_FILE_PATH = File.join('.git', 'COMMIT_EDITMSG')
+    COMMIT_MESSAGE_FILENAME = 'COMMIT_EDITMSG'
 
     module_function
 
@@ -24,15 +24,16 @@ module Transpec
       `#{GIT} status --porcelain`.empty?
     end
 
-    def repository_root
+    def git_dir_path
       fail_unless_inside_of_repository
-      `#{GIT} rev-parse --show-toplevel`.chomp
+      `#{GIT} rev-parse --git-dir`.chomp
     end
 
     def write_commit_message(message)
       fail_unless_inside_of_repository
-      file_path = File.join(repository_root, COMMIT_MESSAGE_FILE_PATH)
+      file_path = File.expand_path(File.join(git_dir_path, COMMIT_MESSAGE_FILENAME))
       File.write(file_path, message)
+      file_path
     end
 
     def fail_unless_inside_of_repository

data/lib/transpec/option_parser.rb

@@ -87,12 +87,12 @@ module Transpec
         config.form_of_be_falsey = type.include?('falsy') ? 'be_falsy' : 'be_falsey'
       end
 
-      define_option('-a', '--no-yield-any-instance') do
-        config.add_receiver_arg_to_any_instance_implementation_block = false
+      define_option('-e', '--explicit-spec-type') do
+        config.add_explicit_type_metadata_to_example_group = true
       end
 
-      define_option('-t', '--no-explicit-spec-type') do
-        config.add_explicit_type_metadata_to_example_group = false
+      define_option('-a', '--no-yield-any-instance') do
+        config.add_receiver_arg_to_any_instance_implementation_block = false
       end
 
       define_option('-p', '--no-parens-matcher-arg') do
@@ -173,14 +173,14 @@ module Transpec
           '  *true,false*    (exact equality)',
           'Default: *truthy,falsey*'
         ],
+        '-e' => [
+          'Add explicit `:type` metadata to example groups in a project using',
+          'rspec-rails.'
+        ],
         '-a' => [
           'Suppress yielding receiver instances to `any_instance`',
           'implementation blocks as the first block argument.'
         ],
-        '-t' => [
-          'Suppress adding explicit `:type` metadata to example groups in a',
-          'project using rspec-rails.'
-        ],
         '-p' => [
           'Suppress parenthesizing arguments of matchers when converting',
           '`should` with operator matcher to `expect` with non-operator matcher.',

data/lib/transpec/processed_source.rb

@@ -1,12 +1,9 @@
 # coding: utf-8
 
-begin
-  require 'parser/current'
-rescue NotImplementedError
-  warn 'Falling back to Ruby 2.1 parser.'
-  require 'parser/ruby21'
-  Parser::CurrentRuby = Parser::Ruby21 # rubocop:disable ConstantName
-end
+original_verbose = $VERBOSE
+$VERBOSE = nil
+require 'parser/current'
+$VERBOSE = original_verbose
 
 require 'transpec/ast/builder'
 

data/lib/transpec/project.rb

@@ -15,9 +15,18 @@ module Transpec
       File.basename(path)
     end
 
-    def require_bundler?
-      gemfile_path = File.join(path, 'Gemfile')
-      File.exist?(gemfile_path)
+    def using_bundler?
+      File.exist?(gemfile_lock_path)
+    end
+
+    def depend_on_rspec_rails?
+      return @depend_on_rspec_rails if instance_variable_defined?(:@depend_on_rspec_rails)
+      return @depend_on_rspec_rails = false unless using_bundler?
+
+      require 'bundler'
+      gemfile_lock_content = File.read(gemfile_lock_path)
+      lockfile = Bundler::LockfileParser.new(gemfile_lock_content)
+      @depend_on_rspec_rails = lockfile.specs.any? { |gem| gem.name == 'rspec-rails' }
     end
 
     def rspec_version
@@ -25,7 +34,7 @@ module Transpec
     end
 
     def with_bundler_clean_env
-      if defined?(Bundler) && require_bundler?
+      if defined?(Bundler) && using_bundler?
         Bundler.with_clean_env do
           # Bundler.with_clean_env cleans environment variables
           # which are set after bundler is loaded.
@@ -38,9 +47,13 @@ module Transpec
 
     private
 
+    def gemfile_lock_path
+      @gemfile_lock_path ||= File.join(path, 'Gemfile.lock')
+    end
+
     def fetch_rspec_version
       command = 'rspec --version'
-      command = 'bundle exec ' + command if require_bundler?
+      command = 'bundle exec ' + command if using_bundler?
 
       output = nil