Merge pull request #658 from johnnyshields/rubocop-round3

Rubocop Round 3

Author: pitbulk

.rubocop.yml

@@ -15,3 +15,9 @@ AllCops:
     - '.git/**/*'
     - 'tmp/**/*'
     - 'vendor/**/*'
+
+Style/NumericPredicate:
+  EnforcedStyle: comparison
+
+Style/RaiseArgs:
+  EnforcedStyle: compact

.rubocop_todo.yml

@@ -1,12 +1,12 @@
 # This configuration was generated by
 # `rubocop --auto-gen-config`
-# on 2023-03-08 09:07:11 UTC using RuboCop version 1.45.1.
+# on 2023-03-08 09:38:19 UTC using RuboCop version 1.45.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
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 11
+# Offense count: 18
 # This cop supports safe autocorrection (--autocorrect).
 Layout/EmptyLineAfterGuardClause:
   Exclude:
@@ -16,6 +16,7 @@ Layout/EmptyLineAfterGuardClause:
     - 'lib/onelogin/ruby-saml/logoutresponse.rb'
     - 'lib/onelogin/ruby-saml/response.rb'
     - 'lib/onelogin/ruby-saml/saml_message.rb'
+    - 'lib/onelogin/ruby-saml/slo_logoutrequest.rb'
     - 'lib/onelogin/ruby-saml/slo_logoutresponse.rb'
 
 # Offense count: 10
@@ -94,7 +95,7 @@ Layout/IndentationConsistency:
   Exclude:
     - 'lib/onelogin/ruby-saml/authrequest.rb'
 
-# Offense count: 3
+# Offense count: 6
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: Width, AllowedPatterns.
 Layout/IndentationWidth:
@@ -205,23 +206,18 @@ Lint/UselessAssignment:
 # Offense count: 39
 # Configuration parameters: AllowedMethods, AllowedPatterns, CountRepeatedAttributes.
 Metrics/AbcSize:
-  Max: 101
+  Max: 100
 
 # Offense count: 1
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 # AllowedMethods: refine
 Metrics/BlockLength:
   Max: 27
 
-# Offense count: 4
-# Configuration parameters: CountBlocks.
-Metrics/BlockNesting:
-  Max: 4
-
 # Offense count: 9
 # Configuration parameters: CountComments, CountAsOne.
 Metrics/ClassLength:
-  Max: 668
+  Max: 652
 
 # Offense count: 23
 # Configuration parameters: AllowedMethods, AllowedPatterns.
@@ -231,7 +227,7 @@ Metrics/CyclomaticComplexity:
 # Offense count: 58
 # Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
 Metrics/MethodLength:
-  Max: 68
+  Max: 63
 
 # Offense count: 2
 # Configuration parameters: Max, CountKeywordArgs.
@@ -379,15 +375,14 @@ Style/Documentation:
     - 'lib/onelogin/ruby-saml/logging.rb'
     - 'lib/xml_security.rb'
 
-# Offense count: 3
+# Offense count: 1
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: MinBodyLength, AllowConsecutiveConditionals.
 Style/GuardClause:
   Exclude:
     - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/utils.rb'
 
-# Offense count: 69
+# Offense count: 60
 # This cop supports safe autocorrection (--autocorrect).
 Style/IfUnlessModifier:
   Exclude:
@@ -403,35 +398,6 @@ Style/IfUnlessModifier:
     - 'lib/onelogin/ruby-saml/utils.rb'
     - 'lib/xml_security.rb'
 
-# Offense count: 1
-# This cop supports safe autocorrection (--autocorrect).
-Style/NegatedIfElseCondition:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/authrequest.rb'
-
-# Offense count: 6
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, MinBodyLength.
-# SupportedStyles: skip_modifier_ifs, always
-Style/Next:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/logoutresponse.rb'
-    - 'lib/onelogin/ruby-saml/metadata.rb'
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/slo_logoutrequest.rb'
-    - 'lib/xml_security.rb'
-
-# Offense count: 7
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle, AllowedMethods, AllowedPatterns.
-# SupportedStyles: predicate, comparison
-Style/NumericPredicate:
-  Exclude:
-    - 'spec/**/*'
-    - 'lib/onelogin/ruby-saml/attribute_service.rb'
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/slo_logoutrequest.rb'
-
 # Offense count: 15
 # Configuration parameters: AllowedMethods.
 # AllowedMethods: respond_to_missing?
@@ -447,86 +413,15 @@ Style/OptionalBooleanParameter:
     - 'lib/onelogin/ruby-saml/utils.rb'
     - 'lib/xml_security.rb'
 
-# Offense count: 9
-# This cop supports unsafe autocorrection (--autocorrect-all).
-# Configuration parameters: EnforcedStyle.
-# SupportedStyles: short, verbose
-Style/PreferredHashMethods:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/attributes.rb'
-    - 'lib/onelogin/ruby-saml/logoutresponse.rb'
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/slo_logoutrequest.rb'
-
-# Offense count: 21
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowedCompactTypes.
-# SupportedStyles: compact, exploded
-Style/RaiseArgs:
-  EnforcedStyle: compact
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantRegexpEscape:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/utils.rb'
-
-# Offense count: 5
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowMultipleReturnValues.
-Style/RedundantReturn:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/logoutresponse.rb'
-    - 'lib/onelogin/ruby-saml/utils.rb'
-    - 'lib/xml_security.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-Style/RedundantSelf:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/utils.rb'
-    - 'lib/xml_security.rb'
-
-# Offense count: 4
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowInnerSlashes.
-# SupportedStyles: slashes, percent_r, mixed
-Style/RegexpLiteral:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/utils.rb'
-
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/SlicingWithRange:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/utils.rb'
-    - 'lib/xml_security.rb'
-
-# Offense count: 10
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: AllowModifier.
-Style/SoleNestedConditional:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/idp_metadata_parser.rb'
-    - 'lib/onelogin/ruby-saml/logoutresponse.rb'
-    - 'lib/onelogin/ruby-saml/response.rb'
-    - 'lib/onelogin/ruby-saml/settings.rb'
-    - 'lib/onelogin/ruby-saml/slo_logoutrequest.rb'
-
-# Offense count: 7
+# Offense count: 2
 # This cop supports unsafe autocorrection (--autocorrect-all).
 # Configuration parameters: Mode.
 Style/StringConcatenation:
   Exclude:
-    - 'lib/onelogin/ruby-saml/idp_metadata_parser.rb'
-    - 'lib/onelogin/ruby-saml/metadata.rb'
     - 'lib/onelogin/ruby-saml/response.rb'
     - 'lib/onelogin/ruby-saml/saml_message.rb'
-    - 'lib/onelogin/ruby-saml/utils.rb'
 
-# Offense count: 452
+# Offense count: 450
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: EnforcedStyle, ConsistentQuotesInMultiline.
 # SupportedStyles: single_quotes, double_quotes
@@ -548,41 +443,7 @@ Style/StringLiterals:
     - 'lib/onelogin/ruby-saml/utils.rb'
     - 'lib/xml_security.rb'
 
-# Offense count: 8
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: MinSize.
-# SupportedStyles: percent, brackets
-Style/SymbolArray:
-  EnforcedStyle: brackets
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyle, AllowSafeAssignment.
-# SupportedStyles: require_parentheses, require_no_parentheses, require_parentheses_when_complex
-Style/TernaryParentheses:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/authrequest.rb'
-    - 'lib/onelogin/ruby-saml/logoutrequest.rb'
-    - 'lib/onelogin/ruby-saml/slo_logoutresponse.rb'
-
-# Offense count: 3
-# This cop supports safe autocorrection (--autocorrect).
-# Configuration parameters: EnforcedStyleForMultiline.
-# SupportedStylesForMultiline: comma, consistent_comma, no_comma
-Style/TrailingCommaInHashLiteral:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/authrequest.rb'
-    - 'lib/onelogin/ruby-saml/idp_metadata_parser.rb'
-    - 'lib/onelogin/ruby-saml/metadata.rb'
-
-# Offense count: 4
-# This cop supports unsafe autocorrection (--autocorrect-all).
-Style/ZeroLengthPredicate:
-  Exclude:
-    - 'lib/onelogin/ruby-saml/attribute_service.rb'
-    - 'lib/onelogin/ruby-saml/response.rb'
-
-# Offense count: 96
+# Offense count: 100
 # This cop supports safe autocorrection (--autocorrect).
 # Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
 # URISchemes: http, https

lib/onelogin/ruby-saml/attribute_service.rb

@@ -24,7 +24,7 @@ def configure(&block)
       # @return [Boolean] True if the AttributeService object has been initialized and set with the required values
       #                   (has attributes and a name)
       def configured?
-        @attributes.length > 0 && !@name.nil?
+        !@attributes.empty? && !@name.nil?
       end
 
       # Set a name to the service

lib/onelogin/ruby-saml/attributes.rb

@@ -48,7 +48,7 @@ def each(&block)
       # @param name [String] The attribute name to be checked
       #
       def include?(name)
-        attributes.has_key?(canonize_name(name))
+        attributes.key?(canonize_name(name))
       end
 
       # Return first value for an attribute

lib/onelogin/ruby-saml/authrequest.rb

@@ -38,7 +38,7 @@ def request_id
       #
       def create(settings, params = {})
         params = create_params(settings, params)
-        params_prefix = (settings.idp_sso_service_url =~ /\?/) ? '&' : '?'
+        params_prefix = /\?/.match?(settings.idp_sso_service_url) ? '&' : '?'
         saml_request = CGI.escape(params.delete("SAMLRequest"))
         request_params = +"#{params_prefix}SAMLRequest=#{saml_request}"
         params.each_pair do |key, value|
@@ -152,14 +152,14 @@ def create_xml_document(settings)
 
         if settings.authn_context || settings.authn_context_decl_ref
 
-          if !settings.authn_context_comparison.nil?
-            comparison = settings.authn_context_comparison
-          else
+          if settings.authn_context_comparison.nil?
             comparison = 'exact'
+          else
+            comparison = settings.authn_context_comparison
           end
 
           requested_context = root.add_element "samlp:RequestedAuthnContext", {
-            "Comparison" => comparison,
+            "Comparison" => comparison
           }
 
           unless settings.authn_context.nil?

lib/onelogin/ruby-saml/idp_metadata_parser.rb

@@ -42,7 +42,7 @@ module Vocabulary
 
       # fetch IdP descriptors from a metadata document
       def self.get_idps(metadata_document, only_entity_id=nil)
-        path = "//md:EntityDescriptor#{('[@entityID="' + only_entity_id + '"]') if only_entity_id}/md:IDPSSODescriptor"
+        path = "//md:EntityDescriptor#{"[@entityID=\"#{only_entity_id}\"]" if only_entity_id}/md:IDPSSODescriptor"
         REXML::XPath.match(
           metadata_document,
           path,
@@ -125,10 +125,8 @@ def parse(idp_metadata, options = {})
 
         unless parsed_metadata[:cache_duration].nil?
           cache_valid_until_timestamp = OneLogin::RubySaml::Utils.parse_duration(parsed_metadata[:cache_duration])
-          unless cache_valid_until_timestamp.nil?
-            if parsed_metadata[:valid_until].nil? || cache_valid_until_timestamp < Time.parse(parsed_metadata[:valid_until], Time.now.utc).to_i
-              parsed_metadata[:valid_until] = Time.at(cache_valid_until_timestamp).utc.strftime("%Y-%m-%dT%H:%M:%SZ")
-            end
+          if !cache_valid_until_timestamp.nil? && (parsed_metadata[:valid_until].nil? || cache_valid_until_timestamp < Time.parse(parsed_metadata[:valid_until], Time.now.utc).to_i)
+            parsed_metadata[:valid_until] = Time.at(cache_valid_until_timestamp).utc.strftime("%Y-%m-%dT%H:%M:%SZ")
           end
         end
         # Remove the cache_duration because on the settings
@@ -240,7 +238,7 @@ def to_hash(options = {})
             idp_cert_fingerprint: nil,
             idp_cert_multi: nil,
             valid_until: valid_until,
-            cache_duration: cache_duration,
+            cache_duration: cache_duration
           }.tap do |response_hash|
             merge_certificates_into(response_hash) unless certificates.nil?
           end

lib/onelogin/ruby-saml/logoutrequest.rb

@@ -35,7 +35,7 @@ def request_id
       #
       def create(settings, params={})
         params = create_params(settings, params)
-        params_prefix = (settings.idp_slo_service_url =~ /\?/) ? '&' : '?'
+        params_prefix = /\?/.match?(settings.idp_slo_service_url) ? '&' : '?'
         saml_request = CGI.escape(params.delete("SAMLRequest"))
         request_params = +"#{params_prefix}SAMLRequest=#{saml_request}"
         params.each_pair do |key, value|