rails5_xhr_update 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f497a964384cd6e1d4ecf8548e04523b0d67d68
-  data.tar.gz: a01b99820e5eeb16917828abe3fabaf4790558cd
+  metadata.gz: d19181a6108a0532b5961af8d091c75f83bbd8d0
+  data.tar.gz: de4de5565dd2ea26ed3b43a55d0781bd1e596c47
 SHA512:
-  metadata.gz: 391227f5befb412d105e3562746a6d62d42f1221afdc05a8661632d68f002ec1c9d910364b4a2bd920e6dea7558d6a76ea1e9286f61beba078581ff0e2ef7821
-  data.tar.gz: 3fd9861315aefd2be0862e104ff6c80164a4170fb6a7630e7a7c6eff6aea408b68c55d541ff8a9fde446836e37653a6ec497382367bd280561891a320eef141a
+  metadata.gz: 0f4a132a262a96259c36343b7bcda68066340124d48ccd4047bade8c7988f459c7b25ae4be71d8fcac107c33c721d4640de4ffcb0e0af2b4461d4f3e3c91e35d
+  data.tar.gz: 8cd00a5be4ac82e7dcbb96e5ef39f7b7feb66dd3f1c6118aeac1c7116aad266096d9106f9638e4f25e77f08e9e13afce59b476f4de768c38e7d391e99b5128fd

data/CHANGES.md

@@ -0,0 +1,14 @@
+# Change Log
+
+## 0.2.0 (2018/05/25)
+
+__Added__
+
+* Filenames can be provided via STDIN when not provided on the command line.
+
+## 0.1.0 (2018/05/24)
+
+__Added__
+
+* Initial version of rails5_xhr_update with `--write` option and takes
+  filenames as command line arguments.

data/README.md

@@ -1,15 +1,16 @@
 # rails5_xhr_update
 
-rails5_xhr_update is a program that can be used to help convert from the:
+rails5_xhr_update is a program that can be used to help convert from the Rails
+4 xhr test syntax, like the following:
 
 ```ruby
-xhr :get, :action
+xhr :get, images_path, limit: 10, sort: 'new'
 ```
 
-test syntax used in rails prior to Rails 5, to the Rails 5 syntax:
+to the equivalent Rails 5 syntax:
 
 ```ruby
-get :action, xhr: true
+get images_path, params: { limit: 10, sort: 'new' }, xhr: true
 ```
 
 ## Installation
@@ -33,5 +34,29 @@ output to STDOUT.
 Consider running the following to find files with potential issues:
 
 ```sh
-git grep -l "xhr :" | xargs rails5_xhr_update --write
+git grep -l "xhr :" | rails5_xhr_update --write
 ```
+
+
+## See Also
+
+### Handling non-XHR cases
+
+As part of the upgrade to Rails 5 one also needs to use keyword arguments for
+`params` and `headers` when calling these *request* test methods. Fortunately,
+[rubocop](https://github.com/bbatsov/rubocop) can help handle that conversion:
+
+
+```sh
+rubocop -a --only Rails/HttpPositionalArguments PATH
+```
+
+### Supporting Rails 5 syntax in Rails 4
+
+Finally, with your project, it might be difficult to do all this conversion
+work at once. You might instead, prefer to remain on Rails 4, but be forward
+compatible with Rails 5. And you might want to output a `DeprecationWarning`,
+or even raise an exception when attempting to use the older syntax. To help
+with that please see our
+[rails-forward_compatible_controller_tests](https://github.com/appfolio/rails-forward_compatible_controller_tests)
+gem.

data/bin/rails5_xhr_update

@@ -2,4 +2,4 @@
 # frozen_string_literal: true
 
 require 'rails5_xhr_update'
-exit Rails5XhrUpdate::Cli.new.run
+exit Rails5XHRUpdate::Cli.new.run

data/lib/rails5_xhr_update.rb

@@ -1,110 +1,4 @@
 # frozen_string_literal: true
 
-require 'optparse'
-require 'unparser'
-
-# Provide the Rails5XhrUpdate module including its command-line tool.
-module Rails5XhrUpdate
-  AST_TRUE = Parser::AST::Node.new(:true) # rubocop:disable Lint/BooleanSymbol)
-
-  # Provide the entry point to this program.
-  class Cli
-    def output(source, path)
-      if @options[:write]
-        File.open(path, 'w') do |file|
-          file.write(source)
-        end
-      else
-        puts source
-      end
-    end
-
-    def parse_options
-      @options = {}
-      OptionParser.new do |config|
-        config.banner = 'Usage: rails5_update.rb [options] FILE...'
-        config.on('-w', '--write', 'Write changes back to files') do |write|
-          @options[:write] = write
-        end
-      end.parse!
-    end
-
-    def run
-      parse_options
-      ARGV.each do |path|
-        buffer = Parser::Source::Buffer.new(path)
-        buffer.read
-        new_source = XHRToRails5.new.rewrite(
-          buffer, Parser::CurrentRuby.new.parse(buffer)
-        )
-        output(new_source, path)
-      end
-      0
-    end
-  end
-
-  # Convert uses of the xhr method to use the rails 5 syntax.
-  #
-  # For example prior to rails 5 one might write:
-  #
-  #     xhr :get, images_path, limit: 10, sort: 'new'
-  #
-  # This class will convert that into:
-  #
-  #     get images_path, params: { limit: 10, sort: 'new' }, xhr: true
-  #
-  # Conversion of xhr methods using headers is also supported:
-  #
-  #     xhr :get, root_path {}, { Accept: => 'application/json' }
-  #
-  # This class will convert the above into:
-  #
-  #     get root_path, headers: { Accept: => 'application/json' }, xhr: true
-  class XHRToRails5 < Parser::TreeRewriter
-    def on_send(node)
-      return if node.children[1] != :xhr
-      arguments = extract_and_validate_arguments(node)
-      children = initial_children(node) + add_xhr_node(*arguments)
-      replace(node.loc.expression, ast_to_string(node.updated(nil, children)))
-    end
-
-    private
-
-    def add_xhr_node(params, headers = nil)
-      children = []
-      children << ast_pair(:headers, headers) unless headers.nil?
-      children << ast_pair(:params, params) unless params.children.empty?
-      children << ast_pair(:xhr, AST_TRUE)
-      [Parser::AST::Node.new(:hash, children)]
-    end
-
-    def extract_and_validate_arguments(node)
-      arguments = node.children[4..-1]
-      raise Exception, 'should this happen?' if new_syntax?(arguments)
-      raise Exception "Unhandled:\n\n #{arguments}" if arguments.size > 2
-      arguments
-    end
-
-    def initial_children(node)
-      http_method = node.children[2].children[0]
-      http_path = node.children[3]
-      [nil, http_method, http_path]
-    end
-
-    def new_syntax?(arguments)
-      return false if arguments.size != 1
-      first_key = arguments[0].children[0].children[0].children[0]
-      %i[params headers].include?(first_key)
-    end
-  end
-
-  def ast_pair(name, data)
-    Parser::AST::Node.new(:pair, [Parser::AST::Node.new(:sym, [name]), data])
-  end
-
-  def ast_to_string(ast)
-    string = Unparser.unparse(ast)[0..-2]
-    string[string.index('(')] = ' '
-    string
-  end
-end
+require 'rails5_xhr_update/cli'
+require 'rails5_xhr_update/xhr_to_rails5'

data/lib/rails5_xhr_update/cli.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'optparse'
+
+module Rails5XHRUpdate
+  # Provide the entry point to this program.
+  class Cli
+    def run
+      parse_options
+      filenames.each do |path|
+        buffer = Parser::Source::Buffer.new(path)
+        buffer.read
+        new_source = XHRToRails5.new.rewrite(
+          buffer, Parser::CurrentRuby.new.parse(buffer)
+        )
+        output(new_source, path)
+      end
+      0
+    end
+
+    private
+
+    def filenames
+      ARGV.empty? ? STDIN.read.split("\n") : ARGV
+    end
+
+    def output(source, path)
+      if @options[:write]
+        File.open(path, 'w') do |file|
+          file.write(source)
+        end
+      else
+        puts source
+      end
+    end
+
+    def parse_options
+      @options = {}
+      OptionParser.new do |config|
+        config.banner = <<~USAGE
+          Usage: rails5_update.rb [options] FILE...
+
+          Files can also be provided via stdin when not provided as a command line argument.
+        USAGE
+        config.on('-w', '--write', 'Write changes back to files') do |write|
+          @options[:write] = write
+        end
+      end.parse!
+    end
+  end
+end

data/lib/rails5_xhr_update/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-# Rails5XhrUpdate
-module Rails5XhrUpdate
-  VERSION = '0.1.0'
+module Rails5XHRUpdate
+  VERSION = '0.2.0'
 end

data/lib/rails5_xhr_update/xhr_to_rails5.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require 'unparser'
+
+# Provide the XHRToRails5 class.
+module Rails5XHRUpdate
+  AST_TRUE = Parser::AST::Node.new(:true) # rubocop:disable Lint/BooleanSymbol)
+
+  # Convert uses of the xhr method to use the rails 5 syntax.
+  #
+  # For example prior to rails 5 one might write:
+  #
+  #     xhr :get, images_path, limit: 10, sort: 'new'
+  #
+  # This class will convert that into:
+  #
+  #     get images_path, params: { limit: 10, sort: 'new' }, xhr: true
+  #
+  # Conversion of xhr methods using headers is also supported:
+  #
+  #     xhr :get, root_path {}, { Accept: => 'application/json' }
+  #
+  # This class will convert the above into:
+  #
+  #     get root_path, headers: { Accept: => 'application/json' }, xhr: true
+  class XHRToRails5 < Parser::TreeRewriter
+    def on_send(node)
+      return if node.children[1] != :xhr
+      arguments = extract_and_validate_arguments(node)
+      children = initial_children(node) + add_xhr_node(*arguments)
+      replace(node.loc.expression, ast_to_string(node.updated(nil, children)))
+    end
+
+    private
+
+    def add_xhr_node(params, headers = nil)
+      children = []
+      children << ast_pair(:headers, headers) unless headers.nil?
+      children << ast_pair(:params, params) unless params.children.empty?
+      children << ast_pair(:xhr, AST_TRUE)
+      [Parser::AST::Node.new(:hash, children)]
+    end
+
+    def extract_and_validate_arguments(node)
+      arguments = node.children[4..-1]
+      raise Exception, 'should this happen?' if new_syntax?(arguments)
+      raise Exception "Unhandled:\n\n #{arguments}" if arguments.size > 2
+      arguments
+    end
+
+    def initial_children(node)
+      http_method = node.children[2].children[0]
+      http_path = node.children[3]
+      [nil, http_method, http_path]
+    end
+
+    def new_syntax?(arguments)
+      return false if arguments.size != 1
+      first_key = arguments[0].children[0].children[0].children[0]
+      %i[params headers].include?(first_key)
+    end
+  end
+
+  def ast_pair(name, data)
+    Parser::AST::Node.new(:pair, [Parser::AST::Node.new(:sym, [name]), data])
+  end
+
+  def ast_to_string(ast)
+    string = Unparser.unparse(ast)[0..-2]
+    string[string.index('(')] = ' '
+    string
+  end
+end

metadata

@@ -1,47 +1,50 @@
 --- !ruby/object:Gem::Specification
 name: rails5_xhr_update
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Bryce Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-24 00:00:00.000000000 Z
+date: 2018-05-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.2'
 description: |
   rails5_xhr_update is a program that can be used to help convert from the
-  ``xhr :get, :action`` test syntax used in rails prior to Rails 5, to the Rails
-  5 syntax: ``get :action, xhr: true``.
+  ``xhr :get, :action`` test syntax used in rails prior to Rails 5, to the
+  Rails 5 syntax: ``get :action, xhr: true``.
 email: bryce.boe@appfolio.com
 executables:
 - rails5_xhr_update
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGES.md
 - LICENSE.txt
 - README.md
 - bin/rails5_xhr_update
 - lib/rails5_xhr_update.rb
+- lib/rails5_xhr_update/cli.rb
 - lib/rails5_xhr_update/version.rb
+- lib/rails5_xhr_update/xhr_to_rails5.rb
 homepage: https://github.com/appfolio/rails5_xhr_update
 licenses:
-- Simplified BSD
+- BSD-2-Clause
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -62,5 +65,5 @@ rubyforge_project:
 rubygems_version: 2.6.13
 signing_key: 
 specification_version: 4
-summary: Program to help update Rails 4 xhr test method calls to rails 5 syntax.
+summary: Update Rails 4 xhr test method calls to rails 5 syntax.
 test_files: []