Fix Rails deprecations for Rails 5.1

Author: nunosilva800

.travis.yml

@@ -1,20 +1,16 @@
 language: ruby
 sudo: false
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1.7
   - 2.2.3
   - 2.3.3
 gemfile:
-  - Gemfile.rails40
   - Gemfile.rails41
   - Gemfile.rails42
   - Gemfile.rails50 # Min ruby 2.2.2
 matrix:
   exclude:
-    - rvm: 1.9.3
-      gemfile: Gemfile.rails50
     - rvm: 2.0.0
       gemfile: Gemfile.rails50
     - rvm: 2.1.7

Gemfile.rails40

@@ -10,13 +10,13 @@ Gem::Specification.new do |s|
   s.homepage    = "http://github.com/Apipie/apipie-rails"
   s.summary     = %q{Rails REST API documentation tool}
   s.description = %q{Rails REST API documentation tool}
-
+  s.required_ruby_version = '>= 2.0.0'
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.require_paths = ["lib"]
 
-  s.add_dependency "rails", ">= 4.0"
+  s.add_dependency "rails", ">= 4.1"
   s.add_development_dependency "rspec-rails", "~> 3.0"
   s.add_development_dependency "sqlite3"
   s.add_development_dependency "minitest"

apipie-rails.gemspec

@@ -237,7 +237,7 @@ def _apipie_define_validators(description)
               # Only allow params passed in that are defined keys in the api
               # Auto skip the default params (format, controller, action)
               if Apipie.configuration.validate_key?
-                params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_key do |param|
+                params.reject{|k,_| %w[format controller action].include?(k.to_s) }.each_pair do |param, _|
                   # params allowed
                   raise UnknownParam.new(param) if method_params.select {|_,p| p.name.to_s == param.to_s}.empty?
                 end

lib/apipie/dsl_definition.rb

@@ -17,7 +17,7 @@ class Apipie::Railtie
     end
     app.middleware.use ::Apipie::Extractor::Recorder::Middleware
     ActionController::TestCase::Behavior.instance_eval do
-      include Apipie::Extractor::Recorder::FunctionalTestRecording
+      prepend Apipie::Extractor::Recorder::FunctionalTestRecording
     end
   end
 end

lib/apipie/extractor.rb

@@ -145,12 +145,8 @@ def analyze(env, &block)
       end
 
       module FunctionalTestRecording
-        def self.included(base)
-          base.alias_method_chain :process, :api_recording
-        end
-
-        def process_with_api_recording(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
-          ret = process_without_api_recording(*args)
+        def process(*args) # action, parameters = nil, session = nil, flash = nil, http_method = 'GET')
+          ret = super(*args)
           if Apipie.configuration.record
             Apipie::Extractor.call_recorder.analyze_functional_test(self)
             Apipie::Extractor.call_finished

lib/apipie/extractor/recorder.rb

@@ -13,7 +13,7 @@
   end
 
   it "should pass if required parameter is missing" do
-    expect { get :show, :id => '5' }.not_to raise_error
+    expect { get :show, :params => { :id => '5' } }.not_to raise_error
   end
 
   it "peserved the order of methods being defined in file" do

spec/controllers/concerns_controller_spec.rb

@@ -71,7 +71,7 @@ def compare_hashes(h1, h2)
       end
 
       it "should pass if required parameter is missing" do
-        expect { get :show, :id => 5 }.not_to raise_error
+        expect { get :show, :params => { :id => 5 } }.not_to raise_error
       end
 
     end
@@ -205,7 +205,7 @@ def reload_controllers
           end
 
           it "should work with Hash validator" do
-            post :create, :user => { :name => "root", :pass => "12345", :membership => "standard" }
+            post :create, params: { :user => { :name => "root", :pass => "12345", :membership => "standard" } }
             assert_response :success
 
             a = Apipie[UsersController, :create]
@@ -219,18 +219,18 @@ def reload_controllers
             hash_params[2].name == :membership
 
             expect {
-              post :create, :user => { :name => "root", :pass => "12345", :membership => "____" }
+              post :create, :params => { :user => { :name => "root", :pass => "12345", :membership => "____" } }
             }.to raise_error(Apipie::ParamInvalid, /membership/)
 
             expect {
-              post :create, :user => { :name => "root" }
+              post :create, :params => { :user => { :name => "root" } }
             }.to raise_error(Apipie::ParamMissing, /pass/)
 
             expect {
-              post :create, :user => "a string is not a hash"
+              post :create, :params => { :user => "a string is not a hash" }
             }.to raise_error(Apipie::ParamInvalid, /user/)
 
-            post :create, :user => { :name => "root", :pass => "pwd" }
+            post :create, :params => { :user => { :name => "root", :pass => "pwd" } }
             assert_response :success
           end
 
@@ -251,23 +251,27 @@ def reload_controllers
 
           it "should allow nil when allow_nil is set to true" do
             post :create,
-                 :user => {
-                   :name => "root",
-                   :pass => "12345",
-                   :membership => "standard",
-                 },
-                 :facts => { :test => 'test' }
+                 :params => {
+                   :user => {
+                     :name => "root",
+                     :pass => "12345",
+                     :membership => "standard",
+                   },
+                   :facts => { :test => 'test' }
+                 }
             assert_response :success
           end
 
           it "should allow blank when allow_blank is set to true" do
             post :create,
-              :user => {
-                :name => "root",
-                :pass => "12345",
-                :membership => "standard"
-              },
-              :age => ""
+              :params => {
+                :user => {
+                  :name => "root",
+                  :pass => "12345",
+                  :membership => "standard"
+                },
+                :age => ""
+              }
             assert_response :success
           end
 
@@ -276,7 +280,7 @@ def reload_controllers
             context "with valid input" do
               it "should succeed" do
                 put :update,
-                    {
+                    :params => {
                       :id => 5,
                       :user => {
                         :name => "root",
@@ -319,7 +323,7 @@ def reload_controllers
             end
             it "should work with empty array" do
               put :update,
-                  {
+                  :params => {
                     :id => 5,
                     :user => {
                       :name => "root",
@@ -567,7 +571,7 @@ def reload_controllers
                           :expected_type=>"string"},
                          {:required=>true,
                           :allow_nil => false,
-                          :allow_blank => false,   
+                          :allow_blank => false,
                           :validator=>"Must be a String",
                           :description=>"\n<p>Password for login</p>\n",
                           :name=>"apassword", :full_name=>"resource_param[apassword]",
@@ -709,13 +713,13 @@ class IgnoredController < ApplicationController; end
     end
 
     it "process correctly the parameters" do
-      post :create, :user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard' }, :facts => {:test => 'test'}
+      post :create, :params => {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard' }, :facts => {:test => 'test'}}
 
       expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}, :facts => {:test => 'test'}}.with_indifferent_access)
     end
 
     it "ignore not described parameters" do
-      post :create, {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
+      post :create, :params => {:user => {:name => 'dummy', :pass => 'dummy', :membership => 'standard', :id => 0}}
 
       expect(assigns(:api_params).with_indifferent_access).to eq({:user => {:name=>"dummy", :pass=>"dummy", :membership=>"standard"}}.with_indifferent_access)
     end

spec/controllers/users_controller_spec.rb

@@ -4,13 +4,13 @@ module SampleController
 
     api!
     def index
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:id'
     param :id, String
     def show
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     def_param_group :concern do
@@ -23,19 +23,19 @@ def show
     api :POST, '/:resource_id', "Create a :concern"
     param_group :concern
     def create
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :PUT, '/:resource_id/:id'
     param :id, String
     param_group :concern
     def update
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
 
     api :GET, '/:resource_id/:custom_subst'
     def custom
-      render :text => "OK #{params.inspect}"
+      render :plain => "OK #{params.inspect}"
     end
   end
 end

spec/dummy/app/controllers/concerns/sample_controller.rb

@@ -192,15 +192,15 @@ class UsersController < ApplicationController
   end
   def show
     unless params[:session] == "secret_hash"
-      render :text => "Not authorized", :status => 401
+      render :plain => "Not authorized", :status => 401
       return
     end
 
     unless params[:id].to_i == 5
-      render :text => "Not Found", :status => 404 and return
+      render :plain => "Not Found", :status => 404 and return
     end
 
-    render :text => "OK"
+    render :plain => "OK"
   end
 
   def_param_group :credentials do
@@ -223,7 +223,7 @@ def show
   param :facts, Hash, :desc => "Additional optional facts about the user", :allow_nil => true
   param :age, :number, :desc => "Age is just a number", :allow_blank => true
   def create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :PUT, "/users/:id", "Update an user"
@@ -232,13 +232,13 @@ def create
     param :comment, String
   end
   def update
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :POST, "/users/admin", "Create admin user"
   param_group :user, :as => :create
   def admin_create
-    render :text => "OK #{params.inspect}"
+    render :plain => "OK #{params.inspect}"
   end
 
   api :GET, "/users", "List users"
@@ -248,14 +248,14 @@ def admin_create
   param :oauth, nil,
         :desc => "Hide this global param (eg dont need auth here)"
   def index
-    render :text => "List of users"
+    render :plain => "List of users"
   end
 
   api :GET, '/company_users', 'Get company users'
   api :GET, '/company/:id/users', 'Get users working in given company'
   param :id, Integer, :desc => "Company ID"
   def two_urls
-    render :text => 'List of users'
+    render :plain => 'List of users'
   end
 
   api :GET, '/users/see_another', 'Boring method'
@@ -264,14 +264,14 @@ def two_urls
   see 'development#users#index', "very interesting method reference"
   desc 'This method is boring, look at users#create.  It is hidden from documentation.'
   def see_another
-    render :text => 'This is very similar to create action'
+    render :plain => 'This is very similar to create action'
   end
 
 
   api :GET, '/users/desc_from_file', 'desc from file'
   document 'users/desc_from_file.md'
   def desc_from_file
-    render :text => 'document from file action'
+    render :plain => 'document from file action'
   end
 
   api! 'Create user'

spec/dummy/app/controllers/users_controller.rb

@@ -11,12 +11,8 @@
 
 module Rails4Compatibility
   module Testing
-    def process_with_rails4_compat(*args)
-      compatible_request(*args) { |*new_args| process_without_rails4_compat(*new_args) }
-    end
-
-    def self.included(base)
-      base.alias_method_chain :process, :rails4_compat
+    def process(*args)
+      compatible_request(*args) { |*new_args| super(*new_args) }
     end
 
     def compatible_request(method, action, hash = {})
@@ -71,5 +67,4 @@ def compatible_request(method, action, hash = {})
 end
 
 require 'action_controller/test_case.rb'
-# TODO: replace with prepend once we deprecate ruby 2.0.0
-ActionController::TestCase::Behavior.send(:include, Rails4Compatibility::Testing)
+ActionController::TestCase::Behavior.send(:prepend, Rails4Compatibility::Testing)