rails-forward_compatible_controller_tests 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: c14737488ec9d88e466310f7b7c6df11426a25df
+  data.tar.gz: 8dcde00c075180b1905c20848ebf57ef79b59ea8
+SHA512:
+  metadata.gz: 9d76badb16031b39c287245791052be7d460c284cd15dba5870bd3557bbd0e17b84fc021905c8dc407423fc2e4f0abeee666346c5a102ecb3e7f150ce1eb00de
+  data.tar.gz: 2a30af7fccd62babe9255b419836c39b59aae0b0e05a8efb44cdc6807e602aa0aae5319db91b1f6cb83c71539a87529a4571eeb271efe78ff574e105f703d97d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 AppFolio, Inc.
+
+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,79 @@
+# Rails::ForwardCompatibleControllerTests
+
+Backport Rails 5 style controller/integration testing syntax using kwargs to Rails 4
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails-forward_compatible_controller_tests', require: false
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rails-forward_compatible_controller_tests
+
+At the appropriate spot in your `test_helper.rb`, `spec_helper.rb`, or similar file add the following line:
+
+```ruby
+require 'rails/forward_compatible_controller_tests'
+```
+
+## Usage
+
+Allows you to simultaneously use the old and new syntax while making HTTP calls to your controllers
+in your test suite. So both:
+
+```ruby
+get #{url_or_action}, params, headers
+xhr :post, #{url_or_action}, params, headers
+```
+
+and
+
+```ruby
+get #{url_or_action}, params: params, headers: headers
+get #{url_or_action}, xhr: true, params: params, headers: headers
+```
+
+should work while you transition your test suite.
+
+## Modes of Operation
+
+Deprecation warnings will appear by default when executing statements that
+utilize the old method. Deprecation warnings can be disabled by adding the
+following to your appropriate test helper:
+
+```ruby
+Rails::ForwardCompatibleControllerTests.ignore
+```
+
+The above is useful if you simply want to support the Rails 5 syntax. If
+instead you want to prevent new uses of the old syntax, add the following:
+
+```ruby
+Rails::ForwardCompatibleControllerTests.raise_exception
+```
+
+The above is useful when you're done coverting the syntax but are not yet ready
+to make the switch to Rails 5.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/appfolio/rails-forward_compatible_controller_tests.
+
+## 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,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/rails/forward_compatible_controller_tests.rb

@@ -0,0 +1,90 @@
+require "rails/forward_compatible_controller_tests/version"
+require "rails/test_help"
+
+module Rails
+  module ForwardCompatibleControllerTests
+    ERROR_MESSAGE = 'Please use Rails 5 syntax. See: https://github.com/appfolio/rails-forward_compatible_controller_tests'
+
+    class <<self
+      @action = :deprecation_warning
+
+      attr_reader :action
+
+      def deprecate
+        @action = :deprecation_warning
+      end
+
+      def deprecated?
+        @action == :deprecation_warning
+      end
+
+      def ignore
+        @action = nil
+      end
+
+      def raise_exception
+        @action = :raise_exceptioon
+      end
+
+      def raise_exception?
+        @action == :raise_exceptioon
+      end
+
+      private
+
+      def with_ignore
+        previous_action = @action
+        @action = nil
+        begin
+          yield
+        ensure
+          @action = previous_action
+        end
+      end
+    end
+
+    %i[get post patch put head delete].each do |method|
+      define_method(method) do |action, *args|
+        request_params = args[0]&.dup
+        request_headers = args[1]&.dup
+
+        old_method = false
+        xhr = false
+        if request_params && request_params.is_a?(Hash)
+          xhr = request_params.delete(:xhr)
+          if request_params[:params].is_a?(Hash)
+            request_params.merge!(request_params.delete(:params) || {})
+            request_headers = request_params.delete(:headers) || request_headers
+          elsif request_params.key?(:params)
+            request_headers = request_params[:headers]
+            request_params = request_params[:params]
+          elsif request_params.key?(:headers)
+            request_headers = request_params[:headers]
+            request_params = nil
+          elsif !xhr
+            old_method = true
+          end
+        elsif request_headers.is_a?(Hash)
+          old_method = true
+        end
+
+        raise Exception, ERROR_MESSAGE if ForwardCompatibleControllerTests.raise_exception? && old_method
+        ActiveSupport::Deprecation.warn(ERROR_MESSAGE) if ForwardCompatibleControllerTests.deprecated? && old_method
+
+        ForwardCompatibleControllerTests.send(:with_ignore) do
+          return xhr(method, action, request_params, request_headers)
+        end if xhr
+        super(action, request_params, request_headers)
+      end
+    end
+
+    def xhr(request_method, action, parameters = nil, *args)
+      raise Exception ERROR_MESSAGE if ForwardCompatibleControllerTests.raise_exception?
+      ActiveSupport::Deprecation.warn(ERROR_MESSAGE) if ForwardCompatibleControllerTests.deprecated?
+      super(request_method, action, parameters, *args)
+    end
+  end
+end
+
+ActionController::TestCase.prepend(Rails::ForwardCompatibleControllerTests)
+ActionDispatch::IntegrationTest.prepend(Rails::ForwardCompatibleControllerTests)

data/lib/rails/forward_compatible_controller_tests/version.rb

@@ -0,0 +1,5 @@
+module Rails
+  module ForwardCompatibleControllerTests
+    VERSION = "2.0.0"
+  end
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: rails-forward_compatible_controller_tests
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Chad Shaffer
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-08-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !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: 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: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: actionpack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+description: Makes upgrading to Rails 5 from Rails 4 easier
+email:
+- chad.shaffer@mycase.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/rails/forward_compatible_controller_tests.rb
+- lib/rails/forward_compatible_controller_tests/version.rb
+homepage: https://github.com/appfolio/rails-forward_compatible_controller_tests
+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.6.8
+signing_key: 
+specification_version: 4
+summary: Back-porting Rails 5 controller & integration tests into Rails 4
+test_files: []