transpec 3.0.8 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: f416a719f5696f5ffad34dd279c44a4f752b0fcf
-  data.tar.gz: 4d15ecafd7523918f531fed5e882d3e25e4fe257
+  metadata.gz: 89106c8a70598e1c56947bcb35e207db8839317c
+  data.tar.gz: 3333ebd452e3be727f9261d815f7ecbf6200a5fa
 SHA512:
-  metadata.gz: 83211303a773c69cb26043e1ccd0d82d6580743f6760a419a95abc769e101bf78a1c4bdf1bbaca8964d74064fef55a4b56364c36c4336ccd46ed7ebc9bf64190
-  data.tar.gz: 8f50ef060d0aef67d2ab6244f23af2821dc14e4253accd190076c2520a53f6b2ac4b663dd0b31017287145362f726cda47ca9b08e21407024f892bf78d544aee
+  metadata.gz: 1c05920d4e39d10bf6c5dd15ad1d2075cb95d7e8a5e9a6becab4e1ac768688b19c2e2010c063d5dc58af0f9224fd72fbe0921cf34d229fd7b0ca4c7e1ad3ed69
+  data.tar.gz: d58f9e39daebde5544b9efbdb5172d54e00bd4c5160aad57d5dff28571ce85eec84b05d01d25af0d2342c1731a9b5c4d7309e1034517704b2a82517e5dd9b2b6

data/.travis.yml

@@ -6,6 +6,7 @@ rvm:
   - 2.2
   - ruby-head
   - jruby-19mode
+  - jruby-9.0.0.0.pre1
 env:
   - RSPEC_VERSION=2.14
   - RSPEC_VERSION=2.99

data/CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Development
 
+## v3.1.0
+
+* Add `-o/--convert-only` option for converting specific syntaxes while keeping all other syntaxes. ([#91](https://github.com/yujinakayama/transpec/issues/91))
+
 ## v3.0.8
 
 * Fix error on converting spec with AWS.stub! without dynamic analysis. ([#100](https://github.com/yujinakayama/transpec/issues/100))

data/README.md

@@ -275,6 +275,18 @@ regardless of this option.
 
 See [Supported Conversions - Method stubs with a hash argument](#method-stubs-with-a-hash-argument) for more details.
 
+### `-o/--convert-only`
+
+Convert specific syntaxes while keeping all other syntaxes.
+
+This option would be useful when you want to convert a non-deprecated syntax
+while keeping another syntax that would be converted by default.
+(e.g. converting the hook scope aliases while keeping the one-liner `should`).
+
+```bash
+$ transpec --convert-only example_group,hook_scope
+```
+
 ### `-s/--skip-dynamic-analysis`
 
 Skip dynamic analysis and convert with only static analysis.

data/README.md.erb

@@ -221,7 +221,7 @@ conversion_type_table = <<END
 `deprecated`     | All other deprecated syntaxes  | Latest syntaxes
 END
 
-validate_syntax_type_table(conversion_type_table, OptionParser::CONFIG_ATTRS_FOR_KEEP_TYPES.keys)
+validate_syntax_type_table(conversion_type_table, true)
 conversion_type_table
 -%>
 
@@ -250,7 +250,7 @@ conversion_type_table = <<END
 `stub_with_hash` | `obj.stub(:message => value)`  | `allow(obj).to receive(:message).and_return(value)`
 END
 
-validate_syntax_type_table(conversion_type_table, OptionParser::CONFIG_ATTRS_FOR_CONVERT_TYPES.keys)
+validate_syntax_type_table(conversion_type_table, false)
 conversion_type_table
 -%>
 
@@ -263,6 +263,18 @@ regardless of this option.
 
 See [Supported Conversions - Method stubs with a hash argument](#method-stubs-with-a-hash-argument) for more details.
 
+### `-o/--convert-only`
+
+Convert specific syntaxes while keeping all other syntaxes.
+
+This option would be useful when you want to convert a non-deprecated syntax
+while keeping another syntax that would be converted by default.
+(e.g. converting the hook scope aliases while keeping the one-liner `should`).
+
+```bash
+$ transpec --convert-only example_group,hook_scope
+```
+
 ### `-s/--skip-dynamic-analysis`
 
 Skip dynamic analysis and convert with only static analysis.

data/lib/transpec/cli.rb

@@ -1,10 +1,10 @@
 # coding: utf-8
 
+require 'transpec/cli/option_parser'
 require 'transpec/commit_message'
 require 'transpec/config'
 require 'transpec/converter'
 require 'transpec/dynamic_analyzer'
-require 'transpec/option_parser'
 require 'transpec/project'
 require 'transpec/report'
 require 'transpec/spec_suite'

data/lib/transpec/cli/option_parser.rb

@@ -0,0 +1,236 @@
+# coding: utf-8
+
+require 'transpec/config'
+require 'transpec/git'
+require 'transpec/version'
+require 'optparse'
+require 'rainbow'
+require 'rainbow/ext/string' unless String.respond_to?(:color)
+
+module Transpec
+  class CLI
+    class OptionParser # rubocop:disable ClassLength
+      VALID_BOOLEAN_MATCHER_TYPES = %w(truthy,falsey truthy,falsy true,false)
+
+      attr_reader :config
+
+      def initialize(config = Config.new)
+        @config = config
+        setup_parser
+      end
+
+      def parse(args)
+        args = convert_deprecated_options(args)
+        @parser.parse!(args)
+        args
+      end
+
+      def help
+        @parser.help
+      end
+
+      private
+
+      def setup_parser # rubocop:disable MethodLength
+        @parser = create_parser
+
+        define_option('-f', '--force') do
+          config.forced = true
+        end
+
+        define_option('-c', '--rspec-command COMMAND') do |command|
+          config.rspec_command = command
+        end
+
+        define_option('-k', '--keep TYPE[,TYPE...]') do |types|
+          configure_conversion(types, false)
+        end
+
+        define_option('-v', '--convert TYPE[,TYPE...]') do |types|
+          configure_conversion(types, true)
+        end
+
+        define_option('-o', '--convert-only TYPE[,TYPE...]') do |types|
+          Config.conversion_types.each do |type|
+            config.conversion[type] = false
+          end
+
+          configure_conversion(types, true)
+        end
+
+        define_option('-s', '--skip-dynamic-analysis') do
+          config.skip_dynamic_analysis = true
+        end
+
+        define_option('-n', '--negative-form FORM') do |form|
+          config.negative_form_of_to = form
+        end
+
+        define_option('-b', '--boolean-matcher TYPE') do |type|
+          configure_boolean_matcher(type)
+        end
+
+        define_option('-e', '--explicit-spec-type') do
+          config.add_explicit_type_metadata_to_example_group = true
+        end
+
+        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
+          config.parenthesize_matcher_arg = false
+        end
+
+        define_option('--no-color') do
+          Rainbow.enabled = false
+        end
+
+        define_option('--version') do
+          puts Version.to_s
+          exit
+        end
+      end
+
+      def create_parser
+        banner = "Usage: transpec [options] [files or directories]\n\n"
+        summary_width = 34
+        indentation = ' ' * 2
+        ::OptionParser.new(banner, summary_width, indentation)
+      end
+
+      def define_option(*options, &block)
+        description_lines = descriptions[options.first]
+        description_lines = description_lines.map { |line| highlight_text(line) }
+        @parser.on(*options, *description_lines, &block)
+      end
+
+      # rubocop:disable AlignHash
+      def descriptions # rubocop:disable MethodLength
+        @descriptions ||= {
+          '-f' => [
+            'Force processing even if the current Git repository is not',
+            'clean.'
+          ],
+          '-s' => [
+            'Skip dynamic analysis and convert with only static analysis.',
+            'The use of this option is basically *discouraged* since it',
+            'significantly decreases the overall conversion accuracy.'
+          ],
+          '-c' => [
+            'Specify a command to run your specs that is used for dynamic',
+            'analysis.',
+            'Default: "bundle exec rspec"'
+          ],
+          '-k' => [
+            'Keep specific syntaxes by disabling conversions.',
+            'Conversion Types:',
+            '  *should* (to `expect(obj).to`)',
+            '  *oneliner* (`it { should ... }` to `it { is_expected.to ... }`)',
+            '  *should_receive* (to `expect(obj).to receive`)',
+            '  *stub*  (to `allow(obj).to receive`)',
+            '  *have_items* (to `expect(collection.size).to eq(n)`)',
+            "  *its* (to `describe '#attr' { subject { }; it { } }`)",
+            '  *pending* (to `skip`)',
+            '  *deprecated* (all other deprecated syntaxes to latest syntaxes)',
+            'These conversions are enabled by default.'
+          ],
+          '-v' => [
+            'Enable specific conversions that are disabled by default.',
+            'Conversion Types:',
+            '  *example_group* (`describe` to `RSpec.describe`)',
+            '  *hook_scope* (`before(:all)` to `before(:context)`)',
+            '  *stub_with_hash* (`obj.stub(:msg => val)` to',
+            '                  `allow(obj).to receive(:msg).and_return(val)`)',
+            'These conversions are disabled by default.'
+          ],
+          '-o' => [
+            'Convert specific syntaxes while keeping all other syntaxes.'
+          ],
+          '-n' => [
+            'Specify a negative form of `to` that is used in the',
+            '`expect(...).to syntax. Either *not_to* or *to_not*.',
+            'Default: *not_to*'
+          ],
+          '-b' => [
+            'Specify a matcher type that `be_true` and `be_false` will be',
+            'converted to.',
+            '  *truthy,falsey* (conditional semantics)',
+            '  *truthy,falsy*  (alias of `falsey`)',
+            '  *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.'
+          ],
+          '-p' => [
+            'Suppress parenthesizing arguments of matchers when converting',
+            '`should` with operator matcher to `expect` with non-operator',
+            'matcher. Note that it will be parenthesized even if this option',
+            'is specified when parentheses are necessary to keep the meaning',
+            'of the expression. By default, arguments of the following',
+            'operator matchers will be parenthesized.',
+            '  `== 10` to `eq(10)`',
+            '  `=~ /pattern/` to `match(/pattern/)`',
+            '  `=~ [1, 2]` to `match_array([1, 2])`'
+          ],
+          '--no-color' => [
+            'Disable color in the output.'
+          ],
+          '--version' => [
+            'Show Transpec version.'
+          ]
+        }
+      end
+      # rubocop:enable AlignHash
+
+      def highlight_text(text)
+        text.gsub(/`.+?`/) { |code| code.gsub('`', '').underline }
+          .gsub(/\*.+?\*/) { |code| code.gsub('*', '').bright }
+      end
+
+      def convert_deprecated_options(raw_args)
+        raw_args.each_with_object([]) do |arg, args|
+          case arg
+          when '--no-parentheses-matcher-arg'
+            deprecate('--no-parentheses-matcher-arg option', '--no-parens-matcher-arg')
+            args << '--no-parens-matcher-arg'
+          else
+            args << arg
+          end
+        end
+      end
+
+      def deprecate(subject, alternative = nil)
+        message =  "DEPRECATION: #{subject} is deprecated."
+        message << " Use #{alternative} instead." if alternative
+        warn message
+      end
+
+      def configure_conversion(inputted_types, boolean)
+        inputted_types.split(',').each do |type|
+          unless Config.valid_conversion_type?(type)
+            fail ArgumentError, "Unknown syntax type #{type.inspect}"
+          end
+
+          config.conversion[type] = boolean
+        end
+      end
+
+      def configure_boolean_matcher(type)
+        unless VALID_BOOLEAN_MATCHER_TYPES.include?(type)
+          types = VALID_BOOLEAN_MATCHER_TYPES.map(&:inspect).join(', ')
+          fail ArgumentError, "Boolean matcher type must be any of #{types}"
+        end
+
+        config.boolean_matcher_type = type.include?('truthy') ? :conditional : :exact
+        config.form_of_be_falsey = type.include?('falsy') ? 'be_falsy' : 'be_falsey'
+      end
+    end
+  end
+end

data/lib/transpec/config.rb

@@ -8,40 +8,59 @@ module Transpec
 
     PREDICATES = [
       [:forced,                                                false],
-      [:convert_should,                                        true],
-      [:convert_oneliner,                                      true],
-      [:convert_should_receive,                                true],
-      [:convert_stub,                                          true],
-      [:convert_have_items,                                    true],
-      [:convert_its,                                           true],
-      [:convert_pending,                                       true],
-      [:convert_deprecated_method,                             true],
-      [:convert_example_group,                                 false],
-      [: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],
       [:parenthesize_matcher_arg,                              true]
     ].freeze
 
+    DEFAULT_CONVERSIONS = {
+              should: true,
+            oneliner: true,
+      should_receive: true,
+                stub: true,
+          have_items: true,
+                 its: true,
+             pending: true,
+          deprecated: true,
+       example_group: false,
+          hook_scope: false,
+      stub_with_hash: false # to allow(obj).to receive(:message).and_return(value) prior to RSpec 3
+    }.freeze
+
     PREDICATES.each do |predicate, _|
       attr_accessor predicate
       alias_method predicate.to_s + '?', predicate
     end
 
+    attr_reader :conversion
     attr_accessor :negative_form_of_to, :boolean_matcher_type, :form_of_be_falsey, :rspec_command
 
+    def self.valid_conversion_type?(type)
+      conversion_types.include?(type.to_sym)
+    end
+
+    def self.conversion_types
+      DEFAULT_CONVERSIONS.keys
+    end
+
     def initialize
       PREDICATES.each do |predicate, default_value|
         instance_variable_set('@' + predicate.to_s, default_value)
       end
 
+      @conversion = SymbolKeyHash.new
+      @conversion.update(DEFAULT_CONVERSIONS)
+
       self.negative_form_of_to = 'not_to'
       self.boolean_matcher_type = :conditional
       self.form_of_be_falsey = 'be_falsey'
     end
 
+    def convert?(type)
+      @conversion[type]
+    end
+
     def negative_form_of_to=(form)
       validate!(form.to_s, NEGATIVE_FORMS_OF_TO, 'Negative form of "to"')
       @negative_form_of_to = form.to_s.freeze
@@ -65,5 +84,15 @@ module Transpec
       message << valid_values.map(&:inspect).join(' or ')
       fail ArgumentError, message
     end
+
+    class SymbolKeyHash < Hash
+      def [](key)
+        super(key.to_sym)
+      end
+
+      def []=(key, value)
+        super(key.to_sym, value)
+      end
+    end
   end
 end

data/lib/transpec/converter.rb

@@ -47,64 +47,64 @@ module Transpec
     end
 
     def process_should(should)
-      return unless config.convert_should?
+      return unless config.convert?(:should)
       should.expectize!(config.negative_form_of_to)
     end
 
     def process_oneliner_should(oneliner_should)
       negative_form = config.negative_form_of_to
-      should_convert_have_items = config.convert_have_items? &&
+      should_convert_have_items = config.convert?(:have_items) &&
                                   oneliner_should.have_matcher.conversion_target?
 
       if should_convert_have_items
-        if config.convert_should?
+        if config.convert?(:should)
           oneliner_should.convert_have_items_to_standard_expect!(negative_form)
         else
           oneliner_should.convert_have_items_to_standard_should!
         end
-      elsif config.convert_oneliner? && rspec_version.oneliner_is_expected_available?
+      elsif config.convert?(:oneliner) && rspec_version.oneliner_is_expected_available?
         oneliner_should.expectize!(negative_form)
       end
     end
 
     def process_should_receive(should_receive)
       if should_receive.useless_expectation?
-        if config.convert_deprecated_method?
-          if config.convert_stub?
+        if config.convert?(:deprecated)
+          if config.convert?(:stub)
             should_receive.allowize_useless_expectation!(config.negative_form_of_to)
           else
             should_receive.stubize_useless_expectation!
           end
-        elsif config.convert_should_receive?
+        elsif config.convert?(:should_receive)
           should_receive.expectize!(config.negative_form_of_to)
         end
-      elsif config.convert_should_receive?
+      elsif config.convert?(:should_receive)
         should_receive.expectize!(config.negative_form_of_to)
       end
     end
 
     def process_double(double)
-      double.convert_to_double! if config.convert_deprecated_method?
+      double.convert_to_double! if config.convert?(:deprecated)
     end
 
     def process_method_stub(method_stub)
-      if config.convert_stub?
+      if config.convert?(:stub)
         if !method_stub.hash_arg? ||
            rspec_version.receive_messages_available? ||
-           config.convert_stub_with_hash_to_allow_to_receive_and_return?
+           config.convert?(:stub_with_hash)
           method_stub.allowize!
-        elsif config.convert_deprecated_method?
+        elsif config.convert?(:deprecated)
           method_stub.convert_deprecated_method!
         end
-      elsif config.convert_deprecated_method?
+      elsif config.convert?(:deprecated)
         method_stub.convert_deprecated_method!
       end
 
-      method_stub.remove_no_message_allowance! if config.convert_deprecated_method?
+      method_stub.remove_no_message_allowance! if config.convert?(:deprecated)
     end
 
     def process_operator(operator)
-      return unless config.convert_should?
+      return unless config.convert?(:should)
       return if operator.expectation.is_a?(Syntax::OnelinerShould) &&
                 !rspec_version.oneliner_is_expected_available?
       operator.convert_operator!(config.parenthesize_matcher_arg?)
@@ -112,7 +112,7 @@ module Transpec
 
     def process_be_boolean(be_boolean)
       return unless rspec_version.be_truthy_available?
-      return unless config.convert_deprecated_method?
+      return unless config.convert?(:deprecated)
 
       case config.boolean_matcher_type
       when :conditional
@@ -123,42 +123,42 @@ module Transpec
     end
 
     def process_be_close(be_close)
-      be_close.convert_to_be_within! if config.convert_deprecated_method?
+      be_close.convert_to_be_within! if config.convert?(:deprecated)
     end
 
     def process_raise_error(raise_error)
       return unless raise_error
-      if config.convert_deprecated_method?
+      if config.convert?(:deprecated)
         raise_error.remove_error_specification_with_negative_expectation!
       end
     end
 
     def process_its(its)
-      its.convert_to_describe_subject_it! if config.convert_its?
+      its.convert_to_describe_subject_it! if config.convert?(:its)
     end
 
     def process_example(example)
-      return if !rspec_version.rspec_2_99? || !config.convert_pending?
+      return if !rspec_version.rspec_2_99? || !config.convert?(:pending)
       example.convert_pending_to_skip!
     end
 
     def process_pending(pending)
-      return if !rspec_version.rspec_2_99? || !config.convert_pending?
+      return if !rspec_version.rspec_2_99? || !config.convert?(:pending)
       pending.convert_deprecated_syntax!
     end
 
     def process_current_example(current_example)
       return unless rspec_version.yielded_example_available?
-      current_example.convert! if config.convert_deprecated_method?
+      current_example.convert! if config.convert?(:deprecated)
     end
 
     def process_matcher_definition(matcher_definition)
       return unless rspec_version.non_should_matcher_protocol_available?
-      matcher_definition.convert_deprecated_method! if config.convert_deprecated_method?
+      matcher_definition.convert_deprecated_method! if config.convert?(:deprecated)
     end
 
     def process_example_group(example_group)
-      if rspec_version.non_monkey_patch_example_group_available? && config.convert_example_group?
+      if rspec_version.non_monkey_patch_example_group_available? && config.convert?(:example_group)
         example_group.convert_to_non_monkey_patch!
       end
 
@@ -169,13 +169,13 @@ module Transpec
     end
 
     def process_rspec_configure(rspec_configure)
-      if config.convert_deprecated_method?
+      if config.convert?(:deprecated)
         rspec_configure.convert_deprecated_options!
       end
 
       if spec_suite.main_rspec_configure_node?(rspec_configure.node)
         if rspec_version.non_monkey_patch_example_group_available? &&
-           config.convert_example_group?
+           config.convert?(:example_group)
           rspec_configure.expose_dsl_globally = false
         end
 
@@ -192,31 +192,31 @@ module Transpec
     end
 
     def process_have(have)
-      return if !have || !config.convert_have_items?
+      return if !have || !config.convert?(:have_items)
       have.convert_to_standard_expectation!(config.parenthesize_matcher_arg)
     end
 
     def process_hook(hook)
-      return if !config.convert_hook_scope? || !rspec_version.hook_scope_alias_available?
+      return if !config.convert?(:hook_scope) || !rspec_version.hook_scope_alias_available?
       hook.convert_scope_name!
     end
 
     def process_useless_and_return(messaging_host)
       return unless messaging_host
-      return unless config.convert_deprecated_method?
+      return unless config.convert?(:deprecated)
       messaging_host.remove_useless_and_return!
     end
 
     def process_any_instance_block(messaging_host)
       return unless messaging_host
       return unless rspec_version.rspec_2_99?
-      return unless config.convert_deprecated_method?
+      return unless config.convert?(:deprecated)
       return unless config.add_receiver_arg_to_any_instance_implementation_block?
       messaging_host.add_receiver_arg_to_any_instance_implementation_block!
     end
 
     def need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
-      rspec_version.rspec_2_99? && config.convert_deprecated_method? &&
+      rspec_version.rspec_2_99? && config.convert?(:deprecated) &&
         spec_suite.need_to_modify_yield_receiver_to_any_instance_implementation_blocks_config?
     end
   end

data/lib/transpec/version.rb

@@ -4,8 +4,8 @@ module Transpec
   # http://semver.org/
   module Version
     MAJOR = 3
-    MINOR = 0
-    PATCH = 8
+    MINOR = 1
+    PATCH = 0
 
     def self.to_s
       [MAJOR, MINOR, PATCH].join('.')

data/tasks/lib/test.rb

@@ -29,7 +29,10 @@ class Test < Project
   private
 
   def transpec(*args)
-    sh File.join(Transpec.root, 'bin', 'transpec'), *args
+    with_clean_bundler_env do
+      ENV['BUNDLE_GEMFILE'] = File.join(Transpec.root, 'Gemfile')
+      sh 'bundle', 'exec', File.join(Transpec.root, 'bin', 'transpec'), *args
+    end
   end
 
   def add_rspec_3_to_gemfile

data/tasks/readme.rake

@@ -158,13 +158,15 @@ class READMEContext
     /^#{'#' * level}[^#]/
   end
 
-  def validate_syntax_type_table(markdown_table, types_in_code)
+  def validate_syntax_type_table(markdown_table, enabled_by_default)
     types_in_doc = markdown_table.lines.map do |line|
       first_column = line.split('|').first
       first_column.gsub(/[^\w]/, '').to_sym
     end.sort
 
-    types_in_code.sort!
+    types_in_code = Config::DEFAULT_CONVERSIONS.select do |_type, enabled|
+      enabled == enabled_by_default
+    end.keys.sort
 
     unless types_in_doc == types_in_code
       types_missing_description = types_in_code - types_in_doc

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: transpec
 version: !ruby/object:Gem::Version
-  version: 3.0.8
+  version: 3.1.0
 platform: ruby
 authors:
 - Yuji Nakayama
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-18 00:00:00.000000000 Z
+date: 2015-03-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -133,6 +133,7 @@ files:
 - lib/transpec/ast/node.rb
 - lib/transpec/base_rewriter.rb
 - lib/transpec/cli.rb
+- lib/transpec/cli/option_parser.rb
 - lib/transpec/commit_message.rb
 - lib/transpec/config.rb
 - lib/transpec/conversion_error.rb
@@ -145,7 +146,6 @@ files:
 - lib/transpec/dynamic_analyzer/runtime_data.rb
 - lib/transpec/dynamic_analyzer/transpec_analysis_helper.rb.erb
 - lib/transpec/git.rb
-- lib/transpec/option_parser.rb
 - lib/transpec/processed_source.rb
 - lib/transpec/project.rb
 - lib/transpec/record.rb

data/lib/transpec/option_parser.rb

@@ -1,236 +0,0 @@
-# coding: utf-8
-
-require 'transpec/config'
-require 'transpec/git'
-require 'transpec/version'
-require 'optparse'
-require 'rainbow'
-require 'rainbow/ext/string' unless String.respond_to?(:color)
-
-module Transpec
-  class OptionParser # rubocop:disable ClassLength
-    CONFIG_ATTRS_FOR_KEEP_TYPES = {
-              should: :convert_should=,
-            oneliner: :convert_oneliner=,
-      should_receive: :convert_should_receive=,
-                stub: :convert_stub=,
-          have_items: :convert_have_items=,
-                 its: :convert_its=,
-             pending: :convert_pending=,
-          deprecated: :convert_deprecated_method=
-    }
-
-    CONFIG_ATTRS_FOR_CONVERT_TYPES = {
-       example_group: :convert_example_group=,
-          hook_scope: :convert_hook_scope=,
-      stub_with_hash: :convert_stub_with_hash_to_allow_to_receive_and_return=
-    }
-
-    VALID_BOOLEAN_MATCHER_TYPES = %w(truthy,falsey truthy,falsy true,false)
-
-    attr_reader :config
-
-    def self.available_conversion_types
-      CONFIG_ATTRS_FOR_KEEP_TYPES.keys
-    end
-
-    def initialize(config = Config.new)
-      @config = config
-      setup_parser
-    end
-
-    def parse(args)
-      args = convert_deprecated_options(args)
-      @parser.parse!(args)
-      args
-    end
-
-    def help
-      @parser.help
-    end
-
-    private
-
-    def setup_parser # rubocop:disable MethodLength
-      @parser = create_parser
-
-      define_option('-f', '--force') do
-        config.forced = true
-      end
-
-      define_option('-c', '--rspec-command COMMAND') do |command|
-        config.rspec_command = command
-      end
-
-      define_option('-k', '--keep TYPE[,TYPE...]') do |types|
-        configure_conversion(CONFIG_ATTRS_FOR_KEEP_TYPES, types, false)
-      end
-
-      define_option('-v', '--convert TYPE[,TYPE...]') do |types|
-        configure_conversion(CONFIG_ATTRS_FOR_CONVERT_TYPES, types, true)
-      end
-
-      define_option('-s', '--skip-dynamic-analysis') do
-        config.skip_dynamic_analysis = true
-      end
-
-      define_option('-n', '--negative-form FORM') do |form|
-        config.negative_form_of_to = form
-      end
-
-      define_option('-b', '--boolean-matcher TYPE') do |type|
-        unless VALID_BOOLEAN_MATCHER_TYPES.include?(type)
-          types = VALID_BOOLEAN_MATCHER_TYPES.map(&:inspect).join(', ')
-          fail ArgumentError, "Boolean matcher type must be any of #{types}"
-        end
-        config.boolean_matcher_type = type.include?('truthy') ? :conditional : :exact
-        config.form_of_be_falsey = type.include?('falsy') ? 'be_falsy' : 'be_falsey'
-      end
-
-      define_option('-e', '--explicit-spec-type') do
-        config.add_explicit_type_metadata_to_example_group = true
-      end
-
-      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
-        config.parenthesize_matcher_arg = false
-      end
-
-      define_option('--no-color') do
-        Rainbow.enabled = false
-      end
-
-      define_option('--version') do
-        puts Version.to_s
-        exit
-      end
-    end
-
-    def create_parser
-      banner = "Usage: transpec [options] [files or directories]\n\n"
-      summary_width = 32 # Default
-      indentation = ' ' * 2
-      ::OptionParser.new(banner, summary_width, indentation)
-    end
-
-    def define_option(*options, &block)
-      description_lines = descriptions[options.first]
-      description_lines = description_lines.map { |line| highlight_text(line) }
-      @parser.on(*options, *description_lines, &block)
-    end
-
-    # rubocop:disable AlignHash
-    def descriptions # rubocop:disable MethodLength
-      @descriptions ||= {
-        '-f' => [
-          'Force processing even if the current Git repository is not clean.'
-        ],
-        '-s' => [
-          'Skip dynamic analysis and convert with only static analysis. The',
-          'use of this option is basically *discouraged* since it',
-          'significantly decreases the overall conversion accuracy.'
-        ],
-        '-c' => [
-          'Specify a command to run your specs that is used for dynamic',
-          'analysis.',
-          'Default: "bundle exec rspec"'
-        ],
-        '-k' => [
-          'Keep specific syntaxes by disabling conversions.',
-          'Conversion Types:',
-          '  *should* (to `expect(obj).to`)',
-          '  *oneliner* (`it { should ... }` to `it { is_expected.to ... }`)',
-          '  *should_receive* (to `expect(obj).to receive`)',
-          '  *stub*  (to `allow(obj).to receive`)',
-          '  *have_items* (to `expect(collection.size).to eq(n)`)',
-          "  *its* (to `describe '#attr' { subject { }; it { } }`)",
-          '  *pending* (to `skip`)',
-          '  *deprecated* (all other deprecated syntaxes to latest syntaxes)',
-          'These conversions are enabled by default.'
-        ],
-        '-v' => [
-          'Enable specific conversions that are disabled by default.',
-          'Conversion Types:',
-          '  *example_group* (`describe` to `RSpec.describe`)',
-          '  *hook_scope* (`before(:all)` to `before(:context)`)',
-          '  *stub_with_hash* (`obj.stub(:msg => val)` to',
-          '                  `allow(obj).to receive(:msg).and_return(val)`)',
-          'These conversions are disabled by default.'
-        ],
-        '-n' => [
-          'Specify a negative form of `to` that is used in the `expect(...).to`',
-          'syntax. Either *not_to* or *to_not*.',
-          'Default: *not_to*'
-        ],
-        '-b' => [
-          'Specify a matcher type that `be_true` and `be_false` will be',
-          'converted to.',
-          '  *truthy,falsey* (conditional semantics)',
-          '  *truthy,falsy*  (alias of `falsey`)',
-          '  *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.'
-        ],
-        '-p' => [
-          'Suppress parenthesizing arguments of matchers when converting',
-          '`should` with operator matcher to `expect` with non-operator matcher.',
-          'Note that it will be parenthesized even if this option is',
-          'specified when parentheses are necessary to keep the meaning of',
-          'the expression. By default, arguments of the following operator',
-          'matchers will be parenthesized.',
-          '  `== 10` to `eq(10)`',
-          '  `=~ /pattern/` to `match(/pattern/)`',
-          '  `=~ [1, 2]` to `match_array([1, 2])`'
-        ],
-        '--no-color' => [
-          'Disable color in the output.'
-        ],
-        '--version' => [
-          'Show Transpec version.'
-        ]
-      }
-    end
-    # rubocop:enable AlignHash
-
-    def highlight_text(text)
-      text.gsub(/`.+?`/) { |code| code.gsub('`', '').underline }
-        .gsub(/\*.+?\*/) { |code| code.gsub('*', '').bright }
-    end
-
-    def convert_deprecated_options(raw_args)
-      raw_args.each_with_object([]) do |arg, args|
-        case arg
-        when '--no-parentheses-matcher-arg'
-          deprecate('--no-parentheses-matcher-arg option', '--no-parens-matcher-arg')
-          args << '--no-parens-matcher-arg'
-        else
-          args << arg
-        end
-      end
-    end
-
-    def deprecate(subject, alternative = nil)
-      message =  "DEPRECATION: #{subject} is deprecated."
-      message << " Use #{alternative} instead." if alternative
-      warn message
-    end
-
-    def configure_conversion(type_to_attr_map, inputted_types, boolean)
-      inputted_types.split(',').each do |type|
-        config_attr = type_to_attr_map[type.to_sym]
-        fail ArgumentError, "Unknown syntax type #{type.inspect}" unless config_attr
-        config.send(config_attr, boolean)
-      end
-    end
-  end
-end