Add deprecation messages to legacy concerns and create new ones

Author: David Revelo

app/controllers/graphql_devise/concerns/set_user_by_token.rb

@@ -7,7 +7,7 @@ module SetUserByToken
 
       included do
         include DeviseTokenAuth::Concerns::SetUserByToken
-        include GraphqlDevise::Concerns::AdditionalControllerMethods
+        include AdditionalControllerMethods
       end
     end
   end

app/controllers/graphql_devise/graphql_controller.rb

@@ -4,17 +4,17 @@
 
 module GraphqlDevise
   class GraphqlController < ApplicationController
-    include GraphqlDevise::Concerns::SetUserByToken
+    include Concerns::SetUserByToken
 
     def auth
       result = if params[:_json]
-        GraphqlDevise::Schema.multiplex(
+        Schema.multiplex(
           params[:_json].map do |param|
             { query: param[:query] }.merge(execute_params(param))
           end
         )
       else
-        GraphqlDevise::Schema.execute(params[:query], **execute_params(params))
+        Schema.execute(params[:query], **execute_params(params))
       end
 
       render json: result unless performed?

lib/graphql_devise.rb

@@ -12,10 +12,11 @@
 loader = Zeitwerk::Loader.for_gem
 
 ['additional_model_methods', 'controller_methods', 'model'].each do |concern_name|
-  require_relative "graphql_devise/concerns/#{concern_name}"
-  loader.ignore("#{__dir__}/graphql_devise/concerns/#{concern_name}.rb")
+  require_relative "graphql_devise/concerns/legacy/#{concern_name}"
+  loader.ignore("#{__dir__}/graphql_devise/concerns/legacy/#{concern_name}.rb")
 end
 
+loader.collapse("#{__dir__}/graphql_devise/concerns")
 loader.collapse("#{__dir__}/graphql_devise/errors")
 loader.collapse("#{__dir__}/generators")
 
@@ -29,7 +30,7 @@
 module GraphqlDevise
   class Error < StandardError; end
 
-  class InvalidMountOptionsError < GraphqlDevise::Error; end
+  class InvalidMountOptionsError < Error; end
 
   @schema_loaded     = false
   @mounted_resources = []

lib/graphql_devise/concerns/authenticatable.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module GraphqlDevise
+  module Authenticatable
+    extend ActiveSupport::Concern
+
+    included do
+      include DeviseTokenAuth::Concerns::User
+
+      ::GraphqlDevise.configure_warden_serializer_for_model(self)
+    end
+
+    class_methods do
+      def reconfirmable
+        devise_modules.include?(:confirmable) && column_names.include?('unconfirmed_email')
+      end
+    end
+
+    def update_with_email(attributes = {})
+      Model::WithEmailUpdater.new(self, attributes).call
+    end
+  end
+end

lib/graphql_devise/concerns/controller_methods.rb

@@ -1,101 +1,99 @@
 # frozen_string_literal: true
 
 module GraphqlDevise
-  module Concerns
-    module ControllerMethods
-      extend ActiveSupport::Concern
+  module ControllerMethods
+    extend ActiveSupport::Concern
 
-      private
+    private
 
-      def check_redirect_url_whitelist!(redirect_url)
-        if blacklisted_redirect_url?(redirect_url)
-          raise_user_error(I18n.t('graphql_devise.redirect_url_not_allowed', redirect_url: redirect_url))
-        end
+    def check_redirect_url_whitelist!(redirect_url)
+      if blacklisted_redirect_url?(redirect_url)
+        raise_user_error(I18n.t('graphql_devise.redirect_url_not_allowed', redirect_url: redirect_url))
       end
+    end
 
-      def raise_user_error(message)
-        raise GraphqlDevise::UserError, message
-      end
+    def raise_user_error(message)
+      raise UserError, message
+    end
 
-      def raise_user_error_list(message, errors:)
-        raise GraphqlDevise::DetailedUserError.new(message, errors: errors)
-      end
+    def raise_user_error_list(message, errors:)
+      raise DetailedUserError.new(message, errors: errors)
+    end
 
-      def remove_resource
-        controller.resource = nil
-        controller.client_id = nil
-        controller.token = nil
-      end
+    def remove_resource
+      controller.resource = nil
+      controller.client_id = nil
+      controller.token = nil
+    end
 
-      def response
-        controller.response
-      end
+    def response
+      controller.response
+    end
 
-      def controller
-        context[:controller]
-      end
+    def controller
+      context[:controller]
+    end
 
-      def resource_name
-        GraphqlDevise.to_mapping_name(resource_class)
-      end
+    def resource_name
+      ::GraphqlDevise.to_mapping_name(resource_class)
+    end
 
-      def resource_class
-        self.class.instance_variable_get(:@resource_klass)
-      end
+    def resource_class
+      self.class.instance_variable_get(:@resource_klass)
+    end
 
-      def recoverable_enabled?
-        resource_class.devise_modules.include?(:recoverable)
-      end
+    def recoverable_enabled?
+      resource_class.devise_modules.include?(:recoverable)
+    end
 
-      def confirmable_enabled?
-        resource_class.devise_modules.include?(:confirmable)
-      end
+    def confirmable_enabled?
+      resource_class.devise_modules.include?(:confirmable)
+    end
 
-      def blacklisted_redirect_url?(redirect_url)
-        DeviseTokenAuth.redirect_whitelist && !DeviseTokenAuth::Url.whitelisted?(redirect_url)
-      end
+    def blacklisted_redirect_url?(redirect_url)
+      DeviseTokenAuth.redirect_whitelist && !DeviseTokenAuth::Url.whitelisted?(redirect_url)
+    end
 
-      def current_resource
-        @current_resource ||= controller.send(:set_resource_by_token, resource_class)
-      end
+    def current_resource
+      @current_resource ||= controller.send(:set_resource_by_token, resource_class)
+    end
 
-      def client
-        if Gem::Version.new(DeviseTokenAuth::VERSION) <= Gem::Version.new('1.1.0')
-          controller.client_id
-        else
-          controller.token.client if controller.token.present?
-        end
+    def client
+      if Gem::Version.new(DeviseTokenAuth::VERSION) <= Gem::Version.new('1.1.0')
+        controller.client_id
+      else
+        controller.token.client if controller.token.present?
       end
+    end
 
-      def set_auth_headers(resource)
-        auth_headers = resource.create_new_auth_token
-        response.headers.merge!(auth_headers)
+    def set_auth_headers(resource)
+      auth_headers = resource.create_new_auth_token
+      response.headers.merge!(auth_headers)
 
-        auth_headers
-      end
+      auth_headers
+    end
 
-      def find_resource(field, value)
-        if resource_class.connection.adapter_name.downcase.include?('mysql')
-          # fix for mysql default case insensitivity
-          resource_class.where("BINARY #{field} = ? AND provider= ?", value, provider).first
-        elsif Gem::Version.new(DeviseTokenAuth::VERSION) < Gem::Version.new('1.1.0')
-          resource_class.find_by(field => value, :provider => provider)
-        else
-          resource_class.dta_find_by(field => value, :provider => provider)
-        end
+    def find_resource(field, value)
+      if resource_class.connection.adapter_name.downcase.include?('mysql')
+        # fix for mysql default case insensitivity
+        resource_class.where("BINARY #{field} = ? AND provider= ?", value, provider).first
+      elsif Gem::Version.new(DeviseTokenAuth::VERSION) < Gem::Version.new('1.1.0')
+        resource_class.find_by(field => value, :provider => provider)
+      else
+        resource_class.dta_find_by(field => value, :provider => provider)
       end
+    end
 
-      def get_case_insensitive_field(field, value)
-        if resource_class.case_insensitive_keys.include?(field)
-          value.downcase
-        else
-          value
-        end
+    def get_case_insensitive_field(field, value)
+      if resource_class.case_insensitive_keys.include?(field)
+        value.downcase
+      else
+        value
       end
+    end
 
-      def provider
-        :email
-      end
+    def provider
+      :email
     end
   end
 end

…ise/concerns/additional_model_methods.rb …cerns/legacy/additional_model_methods.rblib/graphql_devise/concerns/additional_model_methods.rb renamed to lib/graphql_devise/concerns/legacy/additional_model_methods.rb lib/graphql_devise/concerns/additional_model_methods.rb renamed to lib/graphql_devise/concerns/legacy/additional_model_methods.rb

@@ -0,0 +1,133 @@
+# frozen_string_literal: true
+
+module GraphqlDevise
+  module Concerns
+    module ControllerMethods
+      extend ActiveSupport::Concern
+
+      included do
+        ActiveSupport::Deprecation.warn(<<-DEPRECATION.strip_heredoc, caller)
+          Including GraphqlDevise::Concerns::ControllerMethods is deprecated and will be removed in a future version of
+          this gem. Please use GraphqlDevise::ControllerMethods instead.
+
+          EXAMPLE
+
+          include GraphqlDevise::ControllerMethods
+        DEPRECATION
+      end
+
+      private
+
+      def check_redirect_url_whitelist!(redirect_url)
+        if blacklisted_redirect_url?(redirect_url)
+          raise_user_error(I18n.t('graphql_devise.redirect_url_not_allowed', redirect_url: redirect_url))
+        end
+      end
+
+      def raise_user_error(message)
+        raise GraphqlDevise::UserError, message
+      end
+
+      def raise_user_error_list(message, errors:)
+        raise GraphqlDevise::DetailedUserError.new(message, errors: errors)
+      end
+
+      def remove_resource
+        controller.resource = nil
+        controller.client_id = nil
+        controller.token = nil
+      end
+
+      def request
+        controller.request
+      end
+
+      def response
+        controller.response
+      end
+
+      def controller
+        context[:controller]
+      end
+
+      def resource_name
+        GraphqlDevise.to_mapping_name(resource_class)
+      end
+
+      def resource_class
+        self.class.instance_variable_get(:@resource_klass)
+      end
+
+      def recoverable_enabled?
+        resource_class.devise_modules.include?(:recoverable)
+      end
+
+      def confirmable_enabled?
+        resource_class.devise_modules.include?(:confirmable)
+      end
+
+      def blacklisted_redirect_url?(redirect_url)
+        DeviseTokenAuth.redirect_whitelist && !DeviseTokenAuth::Url.whitelisted?(redirect_url)
+      end
+
+      def current_resource
+        @current_resource ||= controller.send(:set_resource_by_token, resource_class)
+      end
+
+      def client
+        if Gem::Version.new(DeviseTokenAuth::VERSION) <= Gem::Version.new('1.1.0')
+          controller.client_id
+        else
+          controller.token.client if controller.token.present?
+        end
+      end
+
+      def set_auth_headers(resource)
+        auth_headers = resource.create_new_auth_token
+        response.headers.merge!(auth_headers)
+
+        auth_headers
+      end
+
+      def client_and_token(token)
+        if Gem::Version.new(DeviseTokenAuth::VERSION) <= Gem::Version.new('1.1.0')
+          { client_id: token.first, token: token.last }
+        else
+          { client_id: token.client, token: token.token }
+        end
+      end
+
+      def redirect_headers(token_info, redirect_header_options)
+        controller.send(
+          :build_redirect_headers,
+          token_info.fetch(:token),
+          token_info.fetch(:client_id),
+          redirect_header_options
+        )
+      end
+
+      def find_resource(field, value)
+        if resource_class.connection.adapter_name.downcase.include?('mysql')
+          # fix for mysql default case insensitivity
+          resource_class.where("BINARY #{field} = ? AND provider= ?", value, provider).first
+        elsif Gem::Version.new(DeviseTokenAuth::VERSION) < Gem::Version.new('1.1.0')
+          resource_class.find_by(field => value, :provider => provider)
+        else
+          resource_class.dta_find_by(field => value, :provider => provider)
+        end
+      end
+
+      def get_case_insensitive_field(field, value)
+        if resource_class.case_insensitive_keys.include?(field)
+          value.downcase
+        else
+          value
+        end
+      end
+
+      def provider
+        :email
+      end
+    end
+  end
+end