rails5-spec-converter 1.0.4 → 1.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 828614a89d1694bc81dafc184bbfa9ac32f60719
-  data.tar.gz: dafbae38f00ecc71e583f3415ae28e9f2972e30b
+  metadata.gz: f063f02a538854ce40ba052bee57619976d13984
+  data.tar.gz: 2953c939e47421e564bb1c38009b25c7e55eab57
 SHA512:
-  metadata.gz: 46e9d313500d4615d4f220bae8381c963668332a5d8803a1870d6fb3fdef58ff394c185d89d3a0b6873652e45bba8d29bbc230abff808b189f64ae572b4f21de
-  data.tar.gz: 4eee1870ad1c50952d0d6b443c273817f2470c3ac697d893366c759b6bc6b1477831f545b4a468522960a95e95bf354993bd14f7668c4fa494188f89eb00aebe
+  metadata.gz: caec295f2a297a1f7041d8cddb3129555f4ff20b886ae1ccf5baf85bd512008daca842885b608fae1ac0df2ff35ab92d3cfd1bd64d2db8e29e6631098d5c9ba6
+  data.tar.gz: 38bd4a4c918a0cb108d20c3b7f120eac19caeae42bdfd31e0b79bed40d49cb4d84973110632707966e65b422e47a2b7bbea9f6fd900c031f4b70eb41255175aa

data/README.md

@@ -33,6 +33,36 @@ Make sure you've committed everything to Git first, then
 
 This will update all the files in that directory matching the glob `spec/**/*_spec.rb`. It should be idempotent.
 
+If you want to specify a specific set of files instead, you can run `rails5-spec-converter path_to_my_files`.
+
+By default it will make some noise, run with `rails5-spec-converter --quiet` if you want it not to.
+
+### Whitespace
+
+The tool will attempt to indent the newly-added "params" hash in situations when the arguments are on newlines, e.g.:
+
+```
+  get :index
+      search: 'bayleef',
+      format: :json
+```
+
+becomes
+
+```
+  get :index
+      params: {
+        search: 'bayleef'
+      },
+      format: :json
+```
+
+Since the extra spaces in front of 'params' are brand-new whitespace, you may want to configure them (default is 2 spaces).
+
+`rails5-spec-converter --indent '    '`
+
+`rails5-spec-converter --indent '\t'`
+
 ## 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/cli.rb

@@ -1,15 +1,45 @@
 require 'rails5/spec_converter/text_transformer'
+require 'optparse'
 
 module Rails5
   module SpecConverter
     class CLI
+      def initialize
+        @options = {}
+        OptionParser.new do |opts|
+          opts.banner = "Usage: rails5-spec-converter [options] [files]"
+
+          opts.on("-q", "--quiet", "Run quietly") do |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")
+          end
+        end.parse!
+
+        @files = ARGV
+      end
+
       def run
-        Dir.glob("spec/**/*_spec.rb") do |path|
-          original_content = File.read(path)
-          transformed_content = Rails5::SpecConverter::TextTransformer.new(original_content).transform
-          File.write(path, transformed_content)
+        paths = @files.length > 0 ? @files : ["spec/**/*_spec.rb"]
+
+        paths.each do |path|
+          Dir.glob(path) do |file_path|
+            log "Processing: #{file_path}"
+
+            original_content = File.read(file_path)
+            transformed_content = Rails5::SpecConverter::TextTransformer.new(original_content, @options).transform
+            File.write(file_path, transformed_content)
+          end
         end
       end
+
+      def log(str)
+        return if @options[:quiet]
+
+        puts str
+      end
     end
   end
 end

data/lib/rails5/spec_converter/text_transformer.rb

@@ -8,7 +8,9 @@ module Rails5
     ALLOWED_KWARG_KEYS = %i(params session flash method body xhr format)
 
     class TextTransformer
-      def initialize(content)
+      def initialize(content, options = {})
+        @indent = options[:indent] || '  '
+        @quiet = options[:quiet]
         @content = content
       end
 
@@ -75,20 +77,73 @@ module Rails5
           end
         end
 
-        curly_sep = hash_node.parent.loc.expression.source.match(/{\S/) ? '' : ' '
-
         if pairs_that_belong_in_params.length > 0
-          rewritten_hashes = ["params: {#{curly_sep}#{restring_hash(pairs_that_belong_in_params)}#{curly_sep}}"]
+          joiner = joiner_between_pairs(hash_node)
+          params_hash = appropriately_spaced_params_hash(
+            hash_node: hash_node,
+            pairs: pairs_that_belong_in_params
+          )
+
+          rewritten_hashes = ["params: #{params_hash}"]
           if pairs_that_belong_outside_params.length > 0
-            rewritten_hashes << restring_hash(pairs_that_belong_outside_params)
+            rewritten_hashes << restring_hash(pairs_that_belong_outside_params, joiner: joiner)
           end
           source_rewriter.replace(
             hash_node.loc.expression,
-            rewritten_hashes.join(', ')
+            rewritten_hashes.join(joiner)
           )
         end
       end
 
+      def additional_indent(hash_node)
+        joiner = joiner_between_pairs(hash_node)
+        joiner && joiner.include?("\n") ? @indent : nil
+      end
+
+      def existing_indent(hash_node)
+        previous_sibling = hash_node.parent.children[hash_node.sibling_index - 1]
+        text_before_hash = text_between_siblings(previous_sibling, hash_node)
+        whitespace_match = text_before_hash.match("\n(\s*)")
+        return whitespace_match[1] if whitespace_match
+
+        joiner = joiner_between_pairs(hash_node)
+        pair_joiner_match = joiner.match("\n(\s*)") if joiner
+        return pair_joiner_match[1] if pair_joiner_match
+      end
+
+      def has_space_after_curly?(hash_node)
+        hash_node.parent.loc.expression.source.match(/{\S/)
+      end
+
+      def joiner_between_pairs(hash_node)
+        texts_between = []
+        hash_node.children[0..-2].each_with_index do |pair, index|
+          next_pair = hash_node.children[index + 1]
+          texts_between << text_between_siblings(pair, next_pair)
+        end
+        if texts_between.uniq.length > 1
+          log "Inconsistent whitespace between hash pairs, using the first separator (#{texts_between[0].inspect})."
+          log "Seen when processing this expression: \n```\n#{hash_node.loc.expression.source}\n```\n\n"
+        end
+        texts_between[0]
+      end
+
+      def text_between_siblings(node1, node2)
+        @content[node1.loc.expression.end_pos...node2.loc.expression.begin_pos]
+      end
+
+      def appropriately_spaced_params_hash(hash_node:, pairs:)
+        extra_indent = additional_indent(hash_node)
+
+        if extra_indent
+          base_indent = existing_indent(hash_node)
+          "{\n#{restring_hash(pairs, indent: base_indent + extra_indent, joiner: ",\n")}\n#{base_indent}}"
+        else
+          curly_sep = has_space_after_curly?(hash_node) ? '' : ' '
+          "{#{curly_sep}#{restring_hash(pairs)}#{curly_sep}}"
+        end
+      end
+
       def wrap_arg(source_rewriter, node, key)
         node_loc = node.loc.expression
         node_source = node_loc.source
@@ -98,8 +153,14 @@ module Rails5
         source_rewriter.replace(node_loc, "#{key}: #{node_source}")
       end
 
-      def restring_hash(pairs)
-        pairs.map { |pair| pair.loc.expression.source }.join(", ")
+      def restring_hash(pairs, joiner: ", ", indent: '')
+        pairs.map { |pair| "#{indent}#{pair.loc.expression.source}" }.join(joiner)
+      end
+
+      def log(str)
+        return if @quiet
+
+        puts str
       end
     end
   end

data/lib/rails5/spec_converter/version.rb

@@ -1,5 +1,5 @@
 module Rails5
   module SpecConverter
-    VERSION = "1.0.4"
+    VERSION = "1.0.5"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rails5-spec-converter
 version: !ruby/object:Gem::Version
-  version: 1.0.4
+  version: 1.0.5
 platform: ruby
 authors:
 - Travis Grathwell
@@ -139,8 +139,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A tool to upgrade Rails 4-style specs to Rails 5-style
 test_files: []
+has_rdoc: