rails5_xhr_update 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d19181a6108a0532b5961af8d091c75f83bbd8d0
-  data.tar.gz: de4de5565dd2ea26ed3b43a55d0781bd1e596c47
+  metadata.gz: fee933190f7c4836569a6925afd4281466e6150d
+  data.tar.gz: 429a19dc4003f90b164972afd2ef3a6c89c9f33b
 SHA512:
-  metadata.gz: 0f4a132a262a96259c36343b7bcda68066340124d48ccd4047bade8c7988f459c7b25ae4be71d8fcac107c33c721d4640de4ffcb0e0af2b4461d4f3e3c91e35d
-  data.tar.gz: 8cd00a5be4ac82e7dcbb96e5ef39f7b7feb66dd3f1c6118aeac1c7116aad266096d9106f9638e4f25e77f08e9e13afce59b476f4de768c38e7d391e99b5128fd
+  metadata.gz: '09777cb0429c67a9e58a4c7597fb3715428cfefdcca1503d266b7238de5d508f17a290d1883a31bba55802f5790e5cd43f3602479617352f7b6d9d9cc1b943e6'
+  data.tar.gz: 0a16fb5c56d32435e5bcd710bdcbe41fe599ebcdc8353dd66de974fe609674961e06e9218ac4f3bf7515ff6eee31400328189ded031afd5df523c95fa33546b0

data/CHANGES.md

@@ -1,5 +1,15 @@
 # Change Log
 
+## 0.3.0 (2018/05/26)
+
+__Added__
+
+* Added conversion support for the `flash` parameter.
+
+__Fixed__
+
+* The second parameter is correctly named `session` and not `headers`.
+
 ## 0.2.0 (2018/05/25)
 
 __Added__

data/README.md

@@ -1,3 +1,6 @@
+[![Gem](https://img.shields.io/gem/v/rails5_xhr_update.svg)](https://rubygems.org/gems/rails5_xhr_update)
+[![Build Status](https://travis-ci.org/appfolio/rails5_xhr_update.svg?branch=master)](https://travis-ci.org/appfolio/rails5_xhr_update)
+
 # rails5_xhr_update
 
 rails5_xhr_update is a program that can be used to help convert from the Rails
@@ -13,6 +16,19 @@ to the equivalent Rails 5 syntax:
 get images_path, params: { limit: 10, sort: 'new' }, xhr: true
 ```
 
+Furthermore, `xhr` calls using `session`, or `flash` parameters are also
+supported. The following call:
+
+```ruby
+xhr :get, images_path, { id: 1 }, { user_ud: 2 }, success: 'logged in'
+```
+
+is translated into:
+
+```ruby
+get images_path, flash: { success: "logged in" }, params: { id: 1 }, session: { user_ud: 2 }, xhr: true
+```
+
 ## Installation
 
 To install rails5_xhr_update run:
@@ -22,7 +38,7 @@ To install rails5_xhr_update run:
 
 ## Running
 
-Simply run:
+Execute this program via:
 
 ```sh
 rails5_xhr_update --write FILE...
@@ -31,7 +47,8 @@ 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:
+Consider running the following to locate and run against files with potential
+issues:
 
 ```sh
 git grep -l "xhr :" | rails5_xhr_update --write
@@ -59,4 +76,4 @@ 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.
+gem.

data/lib/rails5_xhr_update.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
 
 require 'rails5_xhr_update/cli'
+require 'rails5_xhr_update/util'
 require 'rails5_xhr_update/xhr_to_rails5'

data/lib/rails5_xhr_update/cli.rb

@@ -7,7 +7,7 @@ module Rails5XHRUpdate
   class Cli
     def run
       parse_options
-      filenames.each do |path|
+      paths.each do |path|
         buffer = Parser::Source::Buffer.new(path)
         buffer.read
         new_source = XHRToRails5.new.rewrite(
@@ -20,7 +20,7 @@ module Rails5XHRUpdate
 
     private
 
-    def filenames
+    def paths
       ARGV.empty? ? STDIN.read.split("\n") : ARGV
     end
 

data/lib/rails5_xhr_update/util.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+# Provide some helper methods to the module
+module Rails5XHRUpdate
+  def self.ast_pair(name, data)
+    Parser::AST::Node.new(:pair, [Parser::AST::Node.new(:sym, [name]), data])
+  end
+
+  def self.ast_to_string(ast)
+    string = Unparser.unparse(ast)[0..-2]
+    string[string.index('(')] = ' '
+    string
+  end
+end

data/lib/rails5_xhr_update/version.rb

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

data/lib/rails5_xhr_update/xhr_to_rails5.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'parser'
 require 'unparser'
 
 # Provide the XHRToRails5 class.
@@ -15,36 +16,34 @@ module Rails5XHRUpdate
   # 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)))
+      replace(node.loc.expression, Rails5XHRUpdate.ast_to_string(
+                                     node.updated(nil, children)
+      ))
     end
 
     private
 
-    def add_xhr_node(params, headers = nil)
+    def add_xhr_node(params = nil, session = nil, flash = 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)
+      children << Rails5XHRUpdate.ast_pair(:flash, flash) \
+        unless flash.nil? || flash.children.empty?
+      children << Rails5XHRUpdate.ast_pair(:params, params) \
+        unless params.nil? || params.children.empty?
+      children << Rails5XHRUpdate.ast_pair(:session, session) \
+        unless session.nil? || session.children.empty?
+      children << Rails5XHRUpdate.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
+      raise Exception, 'should this happen?' if keyword_args?(arguments)
+      raise Exception, "Unhandled:\n\n #{arguments}" if arguments.size > 3
       arguments
     end
 
@@ -54,20 +53,11 @@ module Rails5XHRUpdate
       [nil, http_method, http_path]
     end
 
-    def new_syntax?(arguments)
+    def keyword_args?(arguments)
       return false if arguments.size != 1
+      return false if arguments[0].children.empty?
       first_key = arguments[0].children[0].children[0].children[0]
-      %i[params headers].include?(first_key)
+      %i[params session flash].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,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: rails5_xhr_update
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Bryce Boe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-25 00:00:00.000000000 Z
+date: 2018-05-26 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
 - !ruby/object:Gem::Dependency
   name: unparser
   requirement: !ruby/object:Gem::Requirement
@@ -40,6 +68,7 @@ files:
 - bin/rails5_xhr_update
 - lib/rails5_xhr_update.rb
 - lib/rails5_xhr_update/cli.rb
+- lib/rails5_xhr_update/util.rb
 - lib/rails5_xhr_update/version.rb
 - lib/rails5_xhr_update/xhr_to_rails5.rb
 homepage: https://github.com/appfolio/rails5_xhr_update