controller-testing-kwargs 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1cfbdf0a08f8925a6725626f947e766e79075ec8
-  data.tar.gz: dd0db95be2052e95f41bd762b092a60104b542f5
+  metadata.gz: d73c4de37761656efc91f3e08bb894ed62a009da
+  data.tar.gz: f9a4c5810fba29f702bd104c094090f7be4cda49
 SHA512:
-  metadata.gz: 7ac2b59d33909eaf0881d465493bef526bf942a0105ab29ba150b04ff47a022c5e05df76b7df16c00a0ef9b4f7ffdddc228823a271a3016701554af8a15311f9
-  data.tar.gz: 122f134d856a219171d7f57680d298376c4370cbfcd0631f79fe1841ebe929579f4234c2f5c8456636aeeac2a672222f1a96f02f1d8f90eceac65ddcb2c524cc
+  metadata.gz: 61329363599e362de4b82e85e47aea47029e6fc9eef263e074c973e6c4f85f5352724cf09ecb3eab32bbc9aac224ca08d02b4dfa132581aeada636b49429a0c5
+  data.tar.gz: 1bd91c023b29ec0d0da0e41222866dd44a5e343b75015115239601c7bd96026b651c576d7346bc4e161d0a52eea6d7d57f55d1386f9a5a4cbce4da3708112db8

data/README.md

@@ -7,7 +7,7 @@ Backport Rails 5 style controller/integration testing syntax using kwargs to Rai
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'controller-testing-kwargs'
+gem 'controller-testing-kwargs', require: false
 ```
 
 And then execute:
@@ -18,6 +18,12 @@ Or install it yourself as:
 
     $ gem install controller-testing-kwargs
 
+At the appropriate spot in your `test_helper.rb`, `spec_helper.rb`, or similar file add the following line:
+
+```ruby
+require 'controller/testing/kwargs'
+```
+
 ## Usage
 
 Allows you to simultaneously use the old and new syntax while making HTTP calls to your controllers
@@ -37,6 +43,26 @@ 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
+Controller::Testing::Kwargs.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
+Controller::Testing::Kwargs.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.

data/lib/controller/testing/kwargs.rb

@@ -4,12 +4,43 @@ require "rails/test_help"
 module Controller
   module Testing
     module Kwargs
+      ERROR_MESSAGE = 'Please use Rails 5 syntax. See: https://github.com/appfolio/controller-testing-kwargs'
+
+      class <<self
+        @on_old = :deprecate
+
+        attr_reader :on_old
+
+        def deprecate
+          @on_old = :warn
+        end
+
+        def deprecated?
+          @on_old == :warn
+        end
+
+        def ignore
+          @on_old = :ignore
+        end
+
+        def raise_exception
+          @on_old = :raise
+        end
+
+        def raise_exception?
+          @on_old == :raise
+        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) || false
+            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
@@ -19,12 +50,34 @@ module Controller
             elsif request_params[:headers]
               request_headers = request_params[:headers]
               request_params = nil
+            else
+              old_method = true
+            end
+          elsif request_headers.is_a?(Hash)
+            old_method = true
+          end
+
+          raise Exception, ERROR_MESSAGE if Controller::Testing::Kwargs.raise_exception? && old_method
+
+          if xhr
+            previous_value = Controller::Testing::Kwargs.on_old
+            Controller::Testing::Kwargs.ignore
+            begin
+              return xhr(method, action, request_params, request_headers)
+            ensure
+              Controller::Testing::Kwargs.instance_variable_set(:@on_old, previous_value)
             end
-            return xhr(method, action, request_params, request_headers) if xhr
           end
+          ActiveSupport::Deprecation.warn(ERROR_MESSAGE) if Controller::Testing::Kwargs.deprecated?
           super(action, request_params, request_headers)
         end
       end
+
+      def xhr(request_method, action, parameters = nil, *args)
+        raise Exception ERROR_MESSAGE if Controller::Testing::Kwargs.raise_exception?
+        ActiveSupport::Deprecation.warn(ERROR_MESSAGE) if Controller::Testing::Kwargs.deprecated?
+        super(request_method, action, parameters, *args)
+      end
     end
   end
 end

data/lib/controller/testing/kwargs/version.rb

@@ -1,7 +1,7 @@
 module Controller
   module Testing
     module Kwargs
-      VERSION = "0.1.0"
+      VERSION = "1.0.0"
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: controller-testing-kwargs
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chad Shaffer
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-03 00:00:00.000000000 Z
+date: 2017-08-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler