rails5_xhr_update 0.1.0

checksums.yaml

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

data/LICENSE.txt

@@ -0,0 +1,23 @@
+Copyright (c) 2018, AppFolio, Inc.
+Copyright (c) 2018, Bryce Boe
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,37 @@
+# rails5_xhr_update
+
+rails5_xhr_update is a program that can be used to help convert from the:
+
+```ruby
+xhr :get, :action
+```
+
+test syntax used in rails prior to Rails 5, to the Rails 5 syntax:
+
+```ruby
+get :action, xhr: true
+```
+
+## Installation
+
+To install rails5_xhr_update run:
+
+    gem install rails5_xhr_udpate
+
+
+## Running
+
+Simply run:
+
+```sh
+rails5_xhr_update --write FILE...
+```
+
+Omit ``--write`` if you don't want to write back to the files, and instead
+output to STDOUT.
+
+Consider running the following to find files with potential issues:
+
+```sh
+git grep -l "xhr :" | xargs rails5_xhr_update --write
+```

data/bin/rails5_xhr_update

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'rails5_xhr_update'
+exit Rails5XhrUpdate::Cli.new.run

data/lib/rails5_xhr_update.rb

@@ -0,0 +1,110 @@
+# 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

data/lib/rails5_xhr_update/version.rb

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

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: rails5_xhr_update
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Bryce Boe
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: unparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+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``.
+email: bryce.boe@appfolio.com
+executables:
+- rails5_xhr_update
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- bin/rails5_xhr_update
+- lib/rails5_xhr_update.rb
+- lib/rails5_xhr_update/version.rb
+homepage: https://github.com/appfolio/rails5_xhr_update
+licenses:
+- Simplified BSD
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+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.
+test_files: []