keycloak_ruby 0.1.1 → 0.1.3

data/lib/keycloak_ruby/version.rb

@@ -1,62 +1,56 @@
 # frozen_string_literal: true
 
 # lib/keycloak_ruby/version.rb
-# Module for interacting with Keycloak
 module KeycloakRuby
-  # Version module following Semantic Versioning 2.0 guidelines
-  # Provides detailed version information and helper methods
+  # The current version of the KeycloakRuby gem as a string.
+  # Follows Semantic Versioning 2.0 (https://semver.org)
+  # @example
+  #   KeycloakRuby::VERSION # => "0.1.3"
+  VERSION = "0.1.3"
+
+  # Provides version information and comparison methods for the KeycloakRuby gem.
+  # This module follows Semantic Versioning 2.0 guidelines.
   #
   # @example Getting version information
-  #   KeycloakRuby::Version::VERSION      # => "0.1.0"
-  #   KeycloakRuby::Version.to_a          # => [0, 1, 0]
-  #   KeycloakRuby::Version.to_h          # => { major: 0, minor: 1, patch: 0, pre: nil }
-  #   KeycloakRuby.version                # => "0.1.0"
+  #   KeycloakRuby::Version.to_a    # => [0, 1, 1]
+  #   KeycloakRuby::Version.to_h    # => { major: 0, minor: 1, patch: 1 }
+  #   KeycloakRuby::Version.to_s    # => "0.1.1"
   #
-  # @example Checking version
-  #   KeycloakRuby::Version >= '0.1.0'    # => true
-  # Module for work with Version
+  # @example Version comparison
+  #   KeycloakRuby::Version >= '0.1.0'  # => true
+  #   KeycloakRuby::Version >= '1.0.0'  # => false
   module Version
-    # Major version number (incompatible API changes)
-    MAJOR = 0
-    # Minor version number (backwards-compatible functionality)
-    MINOR = 1
-    # Patch version number (backwards-compatible bug fixes)
-    PATCH = 1
-    # Pre-release version (nil for stable releases)
-    PRE = nil
-
-    # Full version string
-    VERSION = [MAJOR, MINOR, PATCH, PRE].compact.join(".").freeze
-
-    # Returns version components as an array
-    # @return [Array<Integer, Integer, Integer, String|nil>]
+    # Returns the version components as an array of integers
+    # @return [Array<Integer>] the version components [major, minor, patch]
+    # @example
+    #   KeycloakRuby::Version.to_a # => [0, 1, 1]
     def self.to_a
-      [MAJOR, MINOR, PATCH, PRE]
+      VERSION.split(".").map(&:to_i)
     end
 
-    # Returns version components as a hash
-    # @return [Hash<Symbol, Integer|String|nil>]
+    # Returns the version components as a hash with symbols
+    # @return [Hash<Symbol, Integer>] the version components {major:, minor:, patch:}
+    # @example
+    #   KeycloakRuby::Version.to_h # => { major: 0, minor: 1, patch: 1 }
     def self.to_h
-      { major: MAJOR, minor: MINOR, patch: PATCH, pre: PRE }
+      { major: to_a[0], minor: to_a[1], patch: to_a[2] }
     end
 
-    # Compares version with another version string
-    # @param version_string [String] version to compare with (e.g., "1.2.3")
-    # @return [Boolean]
+    # Compares the current version with another version string
+    # @param version_string [String] the version to compare with (e.g. "1.2.3")
+    # @return [Boolean] true if current version is greater or equal
+    # @example
+    #   KeycloakRuby::Version >= '0.1.0' # => true
     def self.>=(version_string)
       Gem::Version.new(VERSION) >= Gem::Version.new(version_string)
     end
 
-    # Returns the full version string
-    # @return [String]
+    # Returns the version string
+    # @return [String] the version string
+    # @example
+    #   KeycloakRuby::Version.to_s # => "0.1.1"
     def self.to_s
       VERSION
     end
   end
-
-  # Returns the current gem version
-  # @return [String]
-  def self.version
-    Version::VERSION
-  end
 end

data/lib/keycloak_ruby.rb

@@ -1,23 +1,21 @@
 # frozen_string_literal: true
 
+# lib/keycloak_ruby.rb
 require "omniauth"
 require "omniauth_openid_connect"
 require "httparty"
 require "jwt"
+require "zeitwerk"
+require "omniauth/rails_csrf_protection/version"
+require "omniauth/rails_csrf_protection/railtie" if defined?(Rails)
+loader = Zeitwerk::Loader.for_gem
+loader.ignore(
+  "#{__dir__}/generators",
+  "#{__dir__}/templates"
+)
+loader.setup
 
-# lib/keycloak_ruby.rb
 require "generators/keycloak_ruby/install_generator" if defined?(Rails)
-require "keycloak_ruby/authentication"
-require "keycloak_ruby/client"
-require "keycloak_ruby/config"
-require "keycloak_ruby/errors"
-require "keycloak_ruby/request_params"
-require "keycloak_ruby/request_performer"
-require "keycloak_ruby/response_validator"
-require "keycloak_ruby/token_refresher"
-require "keycloak_ruby/token_service"
-require "keycloak_ruby/user"
-require "keycloak_ruby/version"
 
 # Module for interacting with Keycloak
 module KeycloakRuby
@@ -27,15 +25,11 @@ module KeycloakRuby
     # Defaults to Rails.logger if available, or a standard Logger.
     #
     # @return [Logger]
+    # :reek:Attribute
     attr_writer :logger
 
     def logger
-      @logger ||= if defined?(Rails) && Rails.respond_to?(:logger) && Rails.logger
-                    Rails.logger
-                  else
-                    require "logger"
-                    Logger.new($stdout).tap { |log| log.level = Logger::INFO }
-                  end
+      @logger ||= resolve_logger
     end
 
     # Returns the singleton configuration object. The configuration is
@@ -55,9 +49,32 @@ module KeycloakRuby
       yield config
       config.validate!
     end
+
+    private
+
+    def resolve_logger
+      if rails_defined? && rails_logger
+        rails_logger
+      else
+        default_logger
+      end
+    end
+
+    def rails_defined?
+      defined?(Rails)
+    end
+
+    def rails_logger
+      Rails.logger if rails_defined?
+    rescue NoMethodError
+      nil
+    end
+
+    def default_logger
+      require "logger"
+      Logger.new($stdout).tap { |log| log.level = Logger::INFO }
+    end
   end
-  VERSION = Version::VERSION
-  # Only load test helpers when in test environment
   # Load test helpers only in test environment
   if ENV["RACK_ENV"] == "test" || ENV["RAILS_ENV"] == "test" || defined?(RSpec) || defined?(Minitest)
     require "keycloak_ruby/testing"