Fix FrozenStringLiteralComment, LeadingCommentSpace

johnnyshields · johnnyshields · commit 416799685b16 · 2023-03-08T16:37:07.000+09:00
diff --git a/.rubocop_todo.yml b/.rubocop_todo.yml
@@ -163,13 +163,6 @@ Layout/IndentationWidth:
     - 'lib/onelogin/ruby-saml/authrequest.rb'
     - 'lib/onelogin/ruby-saml/response.rb'
 
-# Offense count: 15
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowDoxygenCommentStyle, AllowGemfileRubyComment.
-Layout/LeadingCommentSpace:
-  Exclude:
-    - 'lib/xml_security.rb'
-
 # Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, IndentationWidth.
@@ -542,13 +535,6 @@ Style/For:
   Exclude:
     - 'lib/onelogin/ruby-saml/metadata.rb'
 
-# Offense count: 22
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: always, always_true, never
-Style/FrozenStringLiteralComment:
-  Enabled: false
-
 # Offense count: 1
 # This cop supports unsafe autocorrection (--autocorrect-all).
 Style/GlobalStdStream:
diff --git a/lib/onelogin/ruby-saml.rb b/lib/onelogin/ruby-saml.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'onelogin/ruby-saml/logging'
 require 'onelogin/ruby-saml/saml_message'
 require 'onelogin/ruby-saml/authrequest'
diff --git a/lib/onelogin/ruby-saml/attribute_service.rb b/lib/onelogin/ruby-saml/attribute_service.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
 
diff --git a/lib/onelogin/ruby-saml/attributes.rb b/lib/onelogin/ruby-saml/attributes.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
 
diff --git a/lib/onelogin/ruby-saml/authrequest.rb b/lib/onelogin/ruby-saml/authrequest.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rexml/document"
 
 require "onelogin/ruby-saml/logging"
diff --git a/lib/onelogin/ruby-saml/error_handling.rb b/lib/onelogin/ruby-saml/error_handling.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "onelogin/ruby-saml/validation_error"
 
 module OneLogin
diff --git a/lib/onelogin/ruby-saml/http_error.rb b/lib/onelogin/ruby-saml/http_error.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
     class HttpError < StandardError
diff --git a/lib/onelogin/ruby-saml/idp_metadata_parser.rb b/lib/onelogin/ruby-saml/idp_metadata_parser.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "base64"
 require "net/http"
 require "net/https"
@@ -19,10 +21,10 @@ class IdpMetadataParser
 
       module SamlMetadata
         module Vocabulary
-          METADATA       = "urn:oasis:names:tc:SAML:2.0:metadata".freeze
-          DSIG           = "http://www.w3.org/2000/09/xmldsig#".freeze
-          NAME_FORMAT    = "urn:oasis:names:tc:SAML:2.0:attrname-format:*".freeze
-          SAML_ASSERTION = "urn:oasis:names:tc:SAML:2.0:assertion".freeze
+          METADATA       = "urn:oasis:names:tc:SAML:2.0:metadata"
+          DSIG           = "http://www.w3.org/2000/09/xmldsig#"
+          NAME_FORMAT    = "urn:oasis:names:tc:SAML:2.0:attrname-format:*"
+          SAML_ASSERTION = "urn:oasis:names:tc:SAML:2.0:assertion"
         end
 
         NAMESPACE = {
diff --git a/lib/onelogin/ruby-saml/logging.rb b/lib/onelogin/ruby-saml/logging.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'logger'
 
 # Simplistic log class when we're running in Rails
diff --git a/lib/onelogin/ruby-saml/logoutrequest.rb b/lib/onelogin/ruby-saml/logoutrequest.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "onelogin/ruby-saml/logging"
 require "onelogin/ruby-saml/saml_message"
 require "onelogin/ruby-saml/utils"
diff --git a/lib/onelogin/ruby-saml/logoutresponse.rb b/lib/onelogin/ruby-saml/logoutresponse.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "xml_security"
 require "onelogin/ruby-saml/saml_message"
 
diff --git a/lib/onelogin/ruby-saml/metadata.rb b/lib/onelogin/ruby-saml/metadata.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "uri"
 
 require "onelogin/ruby-saml/logging"
diff --git a/lib/onelogin/ruby-saml/response.rb b/lib/onelogin/ruby-saml/response.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "xml_security"
 require "onelogin/ruby-saml/attributes"
 
diff --git a/lib/onelogin/ruby-saml/saml_message.rb b/lib/onelogin/ruby-saml/saml_message.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cgi'
 require 'zlib'
 require 'base64'
@@ -15,8 +17,8 @@ module RubySaml
     class SamlMessage
       include REXML
 
-      ASSERTION = "urn:oasis:names:tc:SAML:2.0:assertion".freeze
-      PROTOCOL  = "urn:oasis:names:tc:SAML:2.0:protocol".freeze
+      ASSERTION = "urn:oasis:names:tc:SAML:2.0:assertion"
+      PROTOCOL  = "urn:oasis:names:tc:SAML:2.0:protocol"
 
       BASE64_FORMAT = %r(\A([A-Za-z0-9+/]{4})*([A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?\Z)
       @@mutex = Mutex.new
diff --git a/lib/onelogin/ruby-saml/setting_error.rb b/lib/onelogin/ruby-saml/setting_error.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
     class SettingError < StandardError
diff --git a/lib/onelogin/ruby-saml/settings.rb b/lib/onelogin/ruby-saml/settings.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "xml_security"
 require "onelogin/ruby-saml/attribute_service"
 require "onelogin/ruby-saml/utils"
diff --git a/lib/onelogin/ruby-saml/slo_logoutrequest.rb b/lib/onelogin/ruby-saml/slo_logoutrequest.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'zlib'
 require 'time'
 require 'nokogiri'
diff --git a/lib/onelogin/ruby-saml/slo_logoutresponse.rb b/lib/onelogin/ruby-saml/slo_logoutresponse.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "onelogin/ruby-saml/logging"
 
 require "onelogin/ruby-saml/saml_message"
diff --git a/lib/onelogin/ruby-saml/utils.rb b/lib/onelogin/ruby-saml/utils.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'securerandom'
 require "openssl"
 
@@ -7,10 +9,10 @@ module RubySaml
     # SAML2 Auxiliary class
     #
     class Utils
-      BINDINGS = { :post => "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST".freeze,
-                   :redirect => "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect".freeze }.freeze
-      DSIG = "http://www.w3.org/2000/09/xmldsig#".freeze
-      XENC = "http://www.w3.org/2001/04/xmlenc#".freeze
+      BINDINGS = { :post => "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST",
+                   :redirect => "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" }.freeze
+      DSIG = "http://www.w3.org/2000/09/xmldsig#"
+      XENC = "http://www.w3.org/2001/04/xmlenc#"
       DURATION_FORMAT = %r(^
         (-?)P                       # 1: Duration sign
         (?:
diff --git a/lib/onelogin/ruby-saml/validation_error.rb b/lib/onelogin/ruby-saml/validation_error.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
     class ValidationError < StandardError
diff --git a/lib/onelogin/ruby-saml/version.rb b/lib/onelogin/ruby-saml/version.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module OneLogin
   module RubySaml
     VERSION = '1.15.0'
diff --git a/lib/ruby-saml.rb b/lib/ruby-saml.rb
@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'onelogin/ruby-saml'
diff --git a/lib/xml_security.rb b/lib/xml_security.rb
@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # The contents of this file are subject to the terms
 # of the Common Development and Distribution License
 # (the License). You may not use this file except in
@@ -99,21 +101,21 @@ def uuid
       end
     end
 
-    #<Signature>
-      #<SignedInfo>
-        #<CanonicalizationMethod />
-        #<SignatureMethod />
-        #<Reference>
-           #<Transforms>
-           #<DigestMethod>
-           #<DigestValue>
-        #</Reference>
-        #<Reference /> etc.
-      #</SignedInfo>
-      #<SignatureValue />
-      #<KeyInfo />
-      #<Object />
-    #</Signature>
+    # <Signature>
+    #   <SignedInfo>
+    #     <CanonicalizationMethod />
+    #     <SignatureMethod />
+    #     <Reference>
+    #        <Transforms>
+    #        <DigestMethod>
+    #        <DigestValue>
+    #     </Reference>
+    #     <Reference /> etc.
+    #   </SignedInfo>
+    #   <SignatureValue />
+    #   <KeyInfo />
+    #   <Object />
+    # </Signature>
     def sign_document(private_key, certificate, signature_method = RSA_SHA1, digest_method = SHA1)
       noko = Nokogiri::XML(self.to_s) do |config|
         config.options = XMLSecurity::BaseDocument::NOKOGIRI_OPTIONS

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'onelogin/ruby-saml/logging'`
`2`	`4`	`require 'onelogin/ruby-saml/saml_message'`
`3`	`5`	`require 'onelogin/ruby-saml/authrequest'`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`module OneLogin`
`2`	`4`	`module RubySaml`
`3`	`5`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require "rexml/document"`
`2`	`4`
`3`	`5`	`require "onelogin/ruby-saml/logging"`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require "onelogin/ruby-saml/validation_error"`
`2`	`4`
`3`	`5`	`module OneLogin`
Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,5 @@`
	`1`	`+# frozen_string_literal: true`
	`2`	`+`
`1`	`3`	`require 'logger'`
`2`	`4`
`3`	`5`	`# Simplistic log class when we're running in Rails`