rails5-spec-converter 1.0.17 → 1.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b30c8ac0b4d815e5e31d439c98845c7d0b9ddf3c
-  data.tar.gz: 2e5c2c892127cc0d03c05e8333a739bde933ff86
+  metadata.gz: bfd9be6c8436f667718042b22fb9c3c4391175f3
+  data.tar.gz: d5213028fc60af13ff39ea58167d55b038271416
 SHA512:
-  metadata.gz: 9ab4fbf2947035aade8879caf9fa0673c7c038b3930385a450e1d612427389b6e03a40905c6c282c846bcb28b0b8007266a7234c5bf17ee93045d8d4d86f56d9
-  data.tar.gz: 442ec1884fbbfa2d748281f7f07a0316892462a4d20e3c74688ac814bf1581f6de106daa80cb5fcc5f3a527f38fd53bbc40ebb6d86d7169cda3d9a427933d58f
+  metadata.gz: e0aa8e20f7b38a4702fd4729ea175b176fe9284a04f3367a5d01a16dd42379bb7d2742c7b16333a5500e0914f23ae79b5536525cec7f8e949041d4d42faf2f21
+  data.tar.gz: 718159ad161733c7b8384ea519560fae793caa430be899ef561a6b9b7c8cbb1224fcb73c649a143070bdb83c08c8db0e60744163628d248eeabbb38b0a0a910b

data/README.md

@@ -68,6 +68,20 @@ even though `format` should be **outside** the params hash.
 
 * `--strategy skip` will never wrap the unknowable args in `params`
 
+* `--strategy uglify` will attempt to split the hash into `params` and non-`params` hashes at runtime, like so:
+
+  ```
+  all_the_params = {
+    search: 'bayleef',
+    format: :json
+  }
+
+  _inner, _outer = all_the_params.partition { |k,v| %i{session flash method body xhr format}.include?(k) }.map { |a| Hash[a] }
+  get :users, _outer.merge(params: _inner)
+  ```
+
+  This should allow your tests to pass without deprecation warnings while introducing an enticing code cleanup oppurtunity.
+
 ### Whitespace
 
 #### Indentation
@@ -114,22 +128,6 @@ 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`.
 
-### Future Work
-
-Future versions may introduce an `uglify` argument for `--strategy`, which resolves the runtime hash heys problem the following way:
-
-```
-all_the_params = {
-  search: 'bayleef',
-  format: :json
-}
-
-r5sc_user_params, r5sc_other_params = all_the_params.partition { |k,v| %i{session flash method body xhr format}.include?(k) }.map { |a| Hash[a] }
-get :users, r5sc_other_params.merge(params: r5sc_user_params)
-```
-
-This should allow your tests to pass without deprecation warnings while introducing an enticing code cleanup oppurtunity.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bundle exec rspec spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/rails5/spec_converter/text_transformer.rb

@@ -11,6 +11,7 @@ module Rails5
       def initialize(content, options = TextTransformerOptions.new)
         @options = options
         @content = content
+        @textifier = NodeTextifier.new(@content)
 
         @source_buffer = Parser::Source::Buffer.new('(string)')
         @source_buffer.source = @content
@@ -48,7 +49,7 @@ module Rails5
                 content: @content,
                 options: @options,
                 hash_node: args[0],
-                original_indent: node.loc.expression.source_line.match(/^(\s*)/)[1]
+                original_indent: line_indent(node)
               )
 
               @source_rewriter.replace(
@@ -58,7 +59,7 @@ module Rails5
             end
           else
             warn_about_ambiguous_params(node) if @options.warn_about_ambiguous_params?
-            wrap_arg(args[0], 'params') if @options.wrap_ambiguous_params?
+            handle_ambiguous_method_call!(node)
           end
 
           wrap_arg(args[1], 'headers') if args[1]
@@ -69,6 +70,52 @@ module Rails5
 
       private
 
+      def handle_ambiguous_method_call!(node)
+        target, verb, action, *args = node.children
+
+        if @options.wrap_ambiguous_params?
+          wrap_arg(args[0], 'params') if @options.wrap_ambiguous_params?
+        end
+
+        if @options.uglify_ambiguous_params?
+          keys = (HashRewriter::ALLOWED_KWARG_KEYS - [:params]).join(' ')
+          partition_clause = [
+            @textifier.node_to_string(args[0]),
+            "partition { |k,v| %i{#{keys}}.include?(k) }",
+            'map { |a| Hash[a] }'
+          ].join('.')
+
+          text_before_node = node.loc.expression.source_line[0...node.loc.expression.column]
+          first_line_content = "_inner, _outer = #{partition_clause}"
+          if text_before_node =~ /^\s+$/
+            @source_rewriter.insert_before(node.loc.expression, "#{first_line_content}\n#{line_indent(node)}")
+            @source_rewriter.replace(args[0].loc.expression, '_outer.merge(params: _inner)')
+          else
+            return unless in_a_block_with_only_whitespace?(node)
+
+            new_indent = line_indent(node) + @options.indent
+            @source_rewriter.insert_before(node.loc.expression, "\n" + new_indent + first_line_content + "\n" + new_indent)
+            @source_rewriter.replace(args[0].loc.expression, '_outer.merge(params: _inner)')
+            @source_rewriter.insert_after(node.loc.expression, "\n#{line_indent(node)}")
+            trim_enclosing_spaces!(node)
+          end
+        end
+      end
+
+      def in_a_block_with_only_whitespace?(node)
+        return false unless node.parent && node.parent.block_type?
+        content_before = @content[node.parent.loc.begin.end_pos...node.loc.expression.begin_pos]
+        content_after = @content[node.loc.expression.end_pos...node.parent.loc.end.begin_pos]
+        content_before =~ /^\s*$/ && content_after =~ /^\s*$/
+      end
+
+      def trim_enclosing_spaces!(node)
+        before_range = Parser::Source::Range.new(@source_buffer, node.parent.loc.begin.end_pos, node.loc.expression.begin_pos)
+        after_range = Parser::Source::Range.new(@source_buffer, node.loc.expression.end_pos, node.parent.loc.end.begin_pos)
+        @source_rewriter.remove(before_range)
+        @source_rewriter.remove(after_range)
+      end
+
       def looks_like_route_definition?(hash_node)
         keys = hash_node.children.map { |pair| pair.children[0].children[0] }
         route_definition_keys = [:to, :controller]
@@ -110,6 +157,10 @@ module Rails5
         log "```\n#{node.loc.expression.source}\n```\n\n"
       end
 
+      def line_indent(node)
+        node.loc.expression.source_line.match(/^(\s*)/)[1]
+      end
+
       def log(str)
         return if @options.quiet?
 

data/lib/rails5/spec_converter/text_transformer_options.rb

@@ -15,6 +15,10 @@ class TextTransformerOptions
     @strategy == :optimistic
   end
 
+  def uglify_ambiguous_params?
+    @strategy == :uglify
+  end
+
   def warn_about_ambiguous_params?
     @warn_if_ambiguous
   end

data/lib/rails5/spec_converter/version.rb

@@ -1,5 +1,5 @@
 module Rails5
   module SpecConverter
-    VERSION = "1.0.17"
+    VERSION = "1.0.18"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails5-spec-converter
 version: !ruby/object:Gem::Version
-  version: 1.0.17
+  version: 1.0.18
 platform: ruby
 authors:
 - Travis Grathwell
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-09-22 00:00:00.000000000 Z
+date: 2016-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parser