rails5-spec-converter 1.0.11 → 1.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5358fe3940ec49c5084895afcffe7cf51a07d06a
-  data.tar.gz: b0363014912a09bf02040da8f8b2f738358f4613
+  metadata.gz: dd33f82a367cba9cb53594ef8b6606e265267bf7
+  data.tar.gz: 369d01c3d4b27d19ea7de004054fc8376f5a5d6b
 SHA512:
-  metadata.gz: 3d1f2a9f62a860a713aed9450112d3964aab94b626e09352d262082cb2a9a649ee473e2c017c5220b122a4a3df1106616bb3c26631911bc2594eced205f4c901
-  data.tar.gz: 65f4b19f4086ec55cb1d24cadb0473e9277005d977e4ceddf6b53d0d10e07b529d52aa7350d3c5985ad4f8f957d54f4ce82db0c148eec8ae33fce99390a2f726
+  metadata.gz: 2694b5710bf049e67d199b643a07cf7fb456e8d83ee65c51e99f2ca4ef60a3174f564a732018a599191e728cf9e68d7ee36126828849d5bbc1bc9077d7b0e1a5
+  data.tar.gz: 0004df17a2b3a31d88ace9af26194c6281acd92da24fa58d707d00b3e83934b759d4b42bb453e4003aaa9df3d12d199fdf9cff1be6ec2ff729cfbdd2e44c6600

data/README.md

@@ -39,6 +39,35 @@ If you want to specify a specific set of files instead, you can run `rails5-spec
 
 By default it will make some noise, run with `rails5-spec-converter --quiet` if you want it not to.
 
+### Strategy
+
+`rails5-spec-converter` wants to partition your arguments into two sets, those that belong in `params` and those that don't.
+
+But it doesn't do any runtime analysis, so it can only effectively sort out non-`params` keys if they're included in a hash literal on the test invocation site. Hence:
+
+```
+all_the_params = {
+  search: 'bayleef',
+  format: :json
+}
+
+get :users, all_the_params
+```
+
+will become
+
+```
+get :users, params: all_the_params
+```
+
+even though `format` should be **outside** the params hash.
+
+* `--warn-if-ambiguous` will print a message every time `rails5-spec-converter` encounters this situation
+
+* `--strategy optimistic` (default) will always wrap the unknowable args in `params`
+
+* `--strategy skip` will never wrap the unknowable args in `params`
+
 ### Whitespace
 
 #### Indentation
@@ -85,32 +114,9 @@ To force hashes to be written without extra whitespace in all files regardless o
 
 To force hashes to be written WITH extra whitespace in all files regardless of context, use the argument `--hash-spacing`.
 
-## Limitations
-
-`rails5-spec-converter` wants to partition your arguments into two sets, those that belong in `params` and those that don't.
-
-But it doesn't do any runtime analysis, so it can only effectively sort out non-`params` keys if they're included in a hash literal on the test invocation site. Hence:
-
-```
-all_the_params = {
-  search: 'bayleef',
-  format: :json
-}
-
-get :users, all_the_params
-```
-
-will become
-
-```
-get :users, params: all_the_params
-```
-
-even though `format` should be **outside** the params hash.
-
-#### Future Work
+### Future Work
 
-In cases where the hash keys are unknowable at parse time, future versions may optionally attempt to produce this sort of result:
+Future versions may introduce an `uglify` argument for `--strategy`, which resolves the runtime hash heys problem the following way:
 
 ```
 all_the_params = {
@@ -122,7 +128,7 @@ r5sc_user_params, r5sc_other_params = all_the_params.partition { |k,v| %i{sessio
 get :users, r5sc_other_params.merge(params: r5sc_user_params)
 ```
 
-...which should allow your tests to pass without deprecation warnings while introducing an enticing code cleanup oppurtunity.
+This should allow your tests to pass without deprecation warnings while introducing an enticing code cleanup oppurtunity.
 
 ## Development
 

data/lib/rails5/spec_converter/cli.rb

@@ -1,4 +1,5 @@
 require 'rails5/spec_converter/text_transformer'
+require 'rails5/spec_converter/text_transformer_options'
 require 'rails5/spec_converter/version'
 require 'optparse'
 
@@ -6,7 +7,7 @@ module Rails5
   module SpecConverter
     class CLI
       def initialize
-        @options = {}
+        @options = TextTransformerOptions.new
         OptionParser.new do |opts|
           opts.banner = "Usage: rails5-spec-converter [options] [files]"
 
@@ -16,15 +17,23 @@ module Rails5
           end
 
           opts.on("-q", "--quiet", "Run quietly") do |q|
-            @options[:quiet] = q
+            @options.quiet = q
           end
 
           opts.on("-i", "--indent INDENT", "Use specified string for indentation (default is two spaces)") do |indent|
-            @options[:indent] = indent.gsub("\\t", "\t")
+            @options.indent = indent.gsub("\\t", "\t")
           end
 
           opts.on("--[no-]hash-spacing", "Always/never add space around hashes ({foo: 'bar'} vs { foo: 'bar' })") do |hash_spacing|
-            @options[:hash_spacing] = hash_spacing
+            @options.hash_spacing = hash_spacing
+          end
+
+          opts.on("-s", "--strategy STRATEGY", "Set unknown hash parameters strategy (see README)") do |strategy|
+            @options.strategy = strategy.to_sym
+          end
+
+          opts.on("--warn-if-ambiguous", "Emit warnings when hash parameters are unknowable (see README)") do |warn_if_ambigous|
+            @options.warn_if_ambiguous = warn_if_ambigous
           end
         end.parse!
 
@@ -39,6 +48,7 @@ module Rails5
             log "Processing: #{file_path}"
 
             original_content = File.read(file_path)
+            @options.file_path = file_path
             transformed_content = Rails5::SpecConverter::TextTransformer.new(original_content, @options).transform
             File.write(file_path, transformed_content)
           end
@@ -46,7 +56,7 @@ module Rails5
       end
 
       def log(str)
-        return if @options[:quiet]
+        return if @options.quiet?
 
         puts str
       end

data/lib/rails5/spec_converter/text_transformer.rb

@@ -1,5 +1,6 @@
 require 'parser/current'
 require 'astrolabe/builder'
+require 'rails5/spec_converter/text_transformer_options'
 
 module Rails5
   module SpecConverter
@@ -8,10 +9,8 @@ module Rails5
     ALLOWED_KWARG_KEYS = %i(params session flash method body xhr format)
 
     class TextTransformer
-      def initialize(content, options = {})
-        @indent = options[:indent] || '  '
-        @hash_spacing = options[:hash_spacing]
-        @quiet = options[:quiet]
+      def initialize(content, options = TextTransformerOptions.new)
+        @options = options
         @content = content
 
         @source_buffer = Parser::Source::Buffer.new('(string)')
@@ -30,7 +29,9 @@ module Rails5
           next unless args.length > 0
           next unless target.nil? && HTTP_VERBS.include?(verb)
 
-          if args[0].hash_type? && args[0].children.length > 0
+          if args[0].hash_type? && args[0].children.length == 0
+            wrap_arg(args[0], 'params')
+          elsif args[0].hash_type?
             next if looks_like_route_definition?(args[0])
             next if has_kwsplat?(args[0])
             next if has_key?(args[0], :params)
@@ -40,7 +41,8 @@ module Rails5
               original_indent: node.loc.expression.source_line.match(/^(\s*)/)[1]
             )
           else
-            wrap_arg(args[0], 'params')
+            warn_about_ambiguous_params(node) if @options.warn_about_ambiguous_params?
+            wrap_arg(args[0], 'params') if @options.wrap_ambiguous_params?
           end
 
           wrap_arg(args[1], 'headers') if args[1]
@@ -144,7 +146,7 @@ module Rails5
         return nil if indent_before_first_pair(hash_node)
 
         joiner = joiner_between_pairs(hash_node)
-        joiner && joiner.include?("\n") ? @indent : nil
+        joiner && joiner.include?("\n") ? @options.indent : nil
       end
 
       def existing_indent(hash_node)
@@ -206,8 +208,8 @@ module Rails5
       end
 
       def determine_curly_sep(hash_node)
-        return ' ' if @hash_spacing == true
-        return '' if @hash_spacing == false
+        return ' ' if @options.hash_spacing == true
+        return '' if @options.hash_spacing == false
 
         no_space_after_curly?(hash_node) ? '' : ' '
       end
@@ -247,8 +249,14 @@ module Rails5
         @content[node.loc.expression.begin_pos...node.loc.expression.end_pos]
       end
 
+      def warn_about_ambiguous_params(node)
+        log "Ambiguous params found"
+        log "#{@options.file_path}:#{node.loc.line}" if @options.file_path
+        log "```\n#{node.loc.expression.source}\n```\n\n"
+      end
+
       def log(str)
-        return if @quiet
+        return if @options.quiet?
 
         puts str
       end

data/lib/rails5/spec_converter/text_transformer_options.rb

@@ -0,0 +1,25 @@
+class TextTransformerOptions
+  attr_accessor :strategy, :hash_spacing, :indent, :file_path
+  attr_writer :quiet, :warn_if_ambiguous
+
+  def initialize
+    @file_path = nil
+    @strategy = :optimistic
+    @quiet = false
+    @indent = '  '
+    @hash_spacing = nil
+    @warn_if_ambiguous = false
+  end
+
+  def wrap_ambiguous_params?
+    @strategy == :optimistic
+  end
+
+  def warn_about_ambiguous_params?
+    @warn_if_ambiguous
+  end
+
+  def quiet?
+    @quiet
+  end
+end

data/lib/rails5/spec_converter/version.rb

@@ -1,5 +1,5 @@
 module Rails5
   module SpecConverter
-    VERSION = "1.0.11"
+    VERSION = "1.0.12"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails5-spec-converter
 version: !ruby/object:Gem::Version
-  version: 1.0.11
+  version: 1.0.12
 platform: ruby
 authors:
 - Travis Grathwell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-01 00:00:00.000000000 Z
+date: 2016-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser
@@ -117,6 +117,7 @@ files:
 - lib/rails5/spec_converter.rb
 - lib/rails5/spec_converter/cli.rb
 - lib/rails5/spec_converter/text_transformer.rb
+- lib/rails5/spec_converter/text_transformer_options.rb
 - lib/rails5/spec_converter/version.rb
 - rails5-spec-converter.gemspec
 homepage: https://github.com/tjgrathwell/rails5-spec-converter