rails5-spec-converter 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: eb40ce4087decb84d90621dbff3754da8bc1041d
+  data.tar.gz: 65f8db8ed9d02fd5620e0ab3b9ccc038c145f5b8
+SHA512:
+  metadata.gz: c1c235aa76ee06967885c10c64317147c32cb7b45cf5efb55aee13bb8060e46d1b866a09bea38e2926ca4c0a50b4bc6a232036f96c1fed77c6c04f0de39b3cde
+  data.tar.gz: 34741b22342fa50139323f00b8ed12d801f3f90877c0a823e57082d96eb16f30cc36c7834995424057439f074bbc4459579d79fcde3446551316ceb4d86f6368

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+.idea
+.byebug_history

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.0
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rails5-spec-converter.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Travis Grathwell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,48 @@
+# Rails5::SpecConverter
+
+A script that fixes the syntax of your tests so Rails 5 will like them better. Inspired by [transpec](https://github.com/yujinakayama/transpec), the RSpec 2 -> 3 syntax conversion tool.
+
+If you write a test like this:
+
+```
+get :users, search: 'bayleef', format: :json
+expect(response).to be_success
+```
+
+Rails 5 will issue a hearty deprecation warning, persuading you to write this instead:
+
+```
+get :users, params: { search: 'bayleef' }, format: :json
+expect(response).to be_success
+```
+
+This is great! That syntax is great. However, if you have a thousand tests lying around, it will probably be very time consuming to find all the places where you need to fix that.
+
+## Installation
+
+Install the gem standalone like so:
+
+    $ gem install rails5-spec-converter
+
+## Usage
+
+Make sure you've committed everything to Git first, then
+
+    $ cd some-project
+    $ rails5-spec-converter
+
+This will update all the files in that directory matching the glob `spec/**/*_spec.rb`. It should be idempotent.
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tjgrathwell/rails5-spec-converter. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec_converter)
+
+task :default => :spec_converter

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails5/spec_converter"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/rails5-spec-converter

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../lib', __FILE__))
+require 'rails5/spec_converter/cli'
+
+result = Rails5::SpecConverter::CLI.new.run
+exit(result ? 0 : 1)

data/lib/rails5/spec_converter.rb

@@ -0,0 +1,2 @@
+require "rails5/spec_converter/version"
+require "rails5/spec_converter/text_transformer"

data/lib/rails5/spec_converter/cli.rb

@@ -0,0 +1,15 @@
+require 'rails5/spec_converter/text_transformer'
+
+module Rails5
+  module SpecConverter
+    class CLI
+      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)
+        end
+      end
+    end
+  end
+end

data/lib/rails5/spec_converter/text_transformer.rb

@@ -0,0 +1,70 @@
+require 'parser/current'
+require 'astrolabe/builder'
+
+module Rails5
+  module SpecConverter
+    HTTP_VERBS = %i(get post put patch delete)
+    # technically format is special
+    ALLOWED_KWARG_KEYS = %i(params session flash method body xhr format)
+
+    class TextTransformer
+      def initialize(content)
+        @content = content
+      end
+
+      def transform
+        source_buffer = Parser::Source::Buffer.new('(string)')
+        source_buffer.source = @content
+
+        ast_builder = Astrolabe::Builder.new
+        parser = Parser::CurrentRuby.new(ast_builder)
+
+        source_rewriter = Parser::Source::Rewriter.new(source_buffer)
+
+        root_node = parser.parse(source_buffer)
+        root_node.each_node(:send) do |node|
+          target, verb, action, first_argument = node.children
+          if target.nil? && HTTP_VERBS.include?(verb)
+            if first_argument && first_argument.hash_type?
+              hash_node = first_argument
+
+              pairs_that_belong_in_params = []
+              pairs_that_belong_outside_params = []
+
+              hash_node.children.each do |pair|
+                key = pair.children[0].children[0]
+
+                if ALLOWED_KWARG_KEYS.include?(key)
+                  pairs_that_belong_outside_params << pair
+                else
+                  pairs_that_belong_in_params << pair
+                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}}"]
+                if pairs_that_belong_outside_params.length > 0
+                  rewritten_hashes << restring_hash(pairs_that_belong_outside_params)
+                end
+                source_rewriter.replace(
+                  hash_node.loc.expression,
+                  rewritten_hashes.join(', ')
+                )
+              end
+            end
+          end
+        end
+
+        source_rewriter.process
+      end
+
+      private
+
+      def restring_hash(pairs)
+        pairs.map { |pair| pair.loc.expression.source }.join(", ")
+      end
+    end
+  end
+end

data/lib/rails5/spec_converter/version.rb

@@ -0,0 +1,5 @@
+module Rails5
+  module SpecConverter
+    VERSION = "1.0.0"
+  end
+end

data/rails5-spec-converter.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rails5/spec_converter/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails5-spec-converter"
+  spec.version       = Rails5::SpecConverter::VERSION
+  spec.authors       = ["Travis Grathwell"]
+  spec.email         = ["tjgrathwell@gmail.com"]
+
+  spec.summary       = %q{A tool to upgrade Rails 4-style specs to Rails 5-style}
+  spec.description   = %q{Rails 5 issues a deprecation warning if your controller/request tests don't wrap user-supplied params in a `params` keyword. This helps with that.}
+  spec.homepage      = "https://github.com/tjgrathwell/rails5-spec-converter"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'parser',        '>= 2.3.0.7'
+  spec.add_runtime_dependency 'astrolabe',     '~> 1.2'
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "byebug"
+end

metadata

@@ -0,0 +1,146 @@
+--- !ruby/object:Gem::Specification
+name: rails5-spec-converter
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Travis Grathwell
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: parser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.3.0.7
+- !ruby/object:Gem::Dependency
+  name: astrolabe
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Rails 5 issues a deprecation warning if your controller/request tests
+  don't wrap user-supplied params in a `params` keyword. This helps with that.
+email:
+- tjgrathwell@gmail.com
+executables:
+- rails5-spec-converter
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/rails5-spec-converter
+- lib/rails5/spec_converter.rb
+- lib/rails5/spec_converter/cli.rb
+- lib/rails5/spec_converter/text_transformer.rb
+- lib/rails5/spec_converter/version.rb
+- rails5-spec-converter.gemspec
+homepage: https://github.com/tjgrathwell/rails5-spec-converter
+licenses:
+- MIT
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A tool to upgrade Rails 4-style specs to Rails 5-style
+test_files: []