Add alias file lib/xml_security.rb

Author: johnnyshields

.rubocop_todo.yml

@@ -1,6 +1,6 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2024-07-09 07:40:52 UTC using RuboCop version 1.64.1.
+# on 2024-07-09 11:29:15 UTC using RuboCop version 1.64.1.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
@@ -170,12 +170,11 @@ Lint/UnreachableLoop:
   Exclude:
     - 'lib/ruby_saml/saml_message.rb'
 
-# Offense count: 3
+# Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: AutoCorrect.
 Lint/UselessAssignment:
   Exclude:
-    - 'lib/ruby_saml/logging.rb'
     - 'lib/ruby_saml/slo_logoutrequest.rb'
 
 # Offense count: 42
@@ -407,6 +406,14 @@ Style/IfUnlessModifier:
     - 'lib/ruby_saml/xml/document.rb'
     - 'lib/ruby_saml/xml/signed_document.rb'
 
+# Offense count: 1
+# This cop supports unsafe autocorrection (--autocorrect-all).
+# Configuration parameters: EnforcedStyle, Autocorrect.
+# SupportedStyles: module_function, extend_self, forbidden
+Style/ModuleFunction:
+  Exclude:
+    - 'lib/ruby_saml/logging.rb'
+
 # Offense count: 15
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?

UPGRADING.md

@@ -27,7 +27,8 @@ codebase for `RubySaml::XML::` and replace it as appropriate. In addition, you m
 `require 'xml_security'` with `require 'ruby_saml/xml'`.
 
 For backward compatibility, the alias `XMLSecurity = RubySaml::XML` has been set, so `RubySaml::XML::` will still work
-as before. This alias will be removed in RubySaml version `2.1.0`.
+as before. In addition, a shim file has been added so that `require 'xml_security'` continues to work.
+These aliases will be removed in RubySaml version `2.1.0`.
 
 ### Security: Change default hashing algorithm to SHA-256 (was SHA-1)
 

lib/ruby_saml.rb

@@ -19,6 +19,5 @@
 require 'ruby_saml/utils'
 require 'ruby_saml/version'
 
-# @deprecated These aliases add compatibility with v1.x and will be removed in v2.1.0
+# @deprecated This alias adds compatibility with v1.x and will be removed in v2.1.0
 OneLogin = Object
-XMLSecurity = RubySaml::XML

lib/ruby_saml/logging.rb

@@ -2,32 +2,33 @@
 
 require 'logger'
 
-# Simplistic log class when we're running in Rails
 module RubySaml
-  class Logging
+  module Logging
+    extend self
+
     DEFAULT_LOGGER = ::Logger.new($stdout)
 
-    def self.logger
+    attr_writer :logger
+
+    def logger
       @logger ||= begin
         logger = Rails.logger if defined?(::Rails) && Rails.respond_to?(:logger)
-        logger ||= DEFAULT_LOGGER
+        logger || DEFAULT_LOGGER
       end
     end
 
-    class << self
-      attr_writer :logger
+    %i[error warn debug info].each do |level|
+      define_method(level) do |message|
+        logger.send(level, message) if enabled?
+      end
     end
 
-    def self.debug(message)
-      return if ENV['ruby-saml/testing']
-
-      logger.debug(message)
+    def deprecate(message)
+      warn("[DEPRECATION] RubySaml: #{message}")
     end
 
-    def self.info(message)
-      return if ENV['ruby-saml/testing']
-
-      logger.info(message)
+    def enabled?
+      !ENV['ruby-saml/testing']
     end
   end
 end

lib/ruby_saml/xml.rb

@@ -3,3 +3,6 @@
 require 'ruby_saml/xml/base_document'
 require 'ruby_saml/xml/document'
 require 'ruby_saml/xml/signed_document'
+
+# @deprecated This alias adds compatibility with v1.x and will be removed in v2.1.0
+XMLSecurity = RubySaml::XML

lib/xml_security.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'ruby_saml/logging'
+RubySaml::Logging.deprecate 'Using `require "xml_security"` is deprecated and will be removed ' \
+                            'in RubySaml 2.1.0. Please use `require "ruby_saml/xml"` instead.'
+
+# @deprecated This file adds compatibility with v1.x and will be removed in v2.1.0
+require 'ruby_saml/xml'

test/xml_security_alias_test.rb

@@ -1,5 +1,5 @@
 require_relative 'test_helper'
-require 'ruby_saml/xml'
+require 'xml_security'
 
 class XmlSecurityAliasTest < Minitest::Test