hanami-utils/lib/hanami/utils/class.rb

95 lines
2.9 KiB
Ruby

require 'hanami/utils/string'
module Hanami
module Utils
# Class utilities
# @since 0.1.0
class Class
# Loads a class for the given name.
#
# @param name [String, Class] the specific class name
# @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
# @return [Class, Module] the found Ruby constant.
#
# @raise [NameError] if no constant can be found.
#
# @since 0.1.0
#
# @example
# require 'hanami/utils/class'
#
# module App
# module Service
# class Endpoint
# end
# end
#
# class ServiceEndpoint
# end
# end
#
# # basic usage
# Hanami::Utils::Class.load!('App::Service') # => App::Service
# Hanami::Utils::Class.load!(App::Service) # => App::Service
#
# # with explicit namespace
# Hanami::Utils::Class.load!('Service', App) # => App::Service
#
# # with missing constant
# Hanami::Utils::Class.load!('Unknown') # => raises NameError
def self.load!(name, namespace = Object)
namespace.const_get(name.to_s)
end
# Loads a class from the given pattern name and namespace
#
# @param pattern [String] the class name pattern
# @param namespace [Class, Module] the Ruby namespace where we want to perform the lookup.
# @return [Class, Module] the found Ruby constant.
#
# @raise [NameError] if no constant can be found.
#
# @since 0.3.1
#
# @see Hanami::Utils::String#tokenize
#
# @example
# require 'hanami/utils/class'
#
# module App
# module Service
# class Endpoint
# end
# end
#
# class ServiceEndpoint
# end
# end
#
# # basic usage
# Hanami::Utils::Class.load_from_pattern!('App::Service') # => App::Service
#
# # with explicit namespace
# Hanami::Utils::Class.load_from_pattern!('Service', App) # => App::Service
#
# # with pattern
# Hanami::Utils::Class.load_from_pattern!('App::Service(::Endpoint|Endpoint)') # => App::Service::Endpoint
# Hanami::Utils::Class.load_from_pattern!('App::Service(Endpoint|::Endpoint)') # => App::ServiceEndpoint
#
# # with missing constant
# Hanami::Utils::Class.load_from_pattern!('Unknown') # => raises NameError
def self.load_from_pattern!(pattern, namespace = Object)
String.new(pattern).tokenize do |token|
begin
return namespace.const_get(token)
rescue NameError
end
end
full_name = [ (namespace == Object ? nil : namespace), pattern ].compact.join('::')
raise NameError.new("uninitialized constant #{ full_name }")
end
end
end
end