docbrown/app/lib/url.rb
Fernando Valverde e5e36a2e2d
Comment fragment link when signed out (#18517)
* Comment fragment link when signed out

* Optional chaining for article path

* Fix comment liquid tag rendering

* Extract signed in/out logic into helper

* Debugging specs

* Fix specs

* Use named empty anchor to link comments with id_code
2022-10-03 07:58:34 -06:00

113 lines
3 KiB
Ruby

# Utilities methods to safely build app wide URLs
module URL
def self.protocol
ApplicationConfig["APP_PROTOCOL"]
end
def self.database_available?
ActiveRecord::Base.connected? && has_site_configs?
end
private_class_method :database_available?
def self.has_site_configs?
@has_site_configs ||= ActiveRecord::Base.connection.table_exists?("site_configs")
end
private_class_method :has_site_configs?
def self.domain
if database_available?
Settings::General.app_domain
else
ApplicationConfig["APP_DOMAIN"]
end
end
def self.url(uri = nil)
base_url = "#{protocol}#{domain}"
return base_url unless uri
Addressable::URI.parse(base_url).join(uri).normalize.to_s
end
# Creates an article URL
#
# @param article [Article] the article to create the URL for
def self.article(article)
url(article.path)
end
# Creates a comment URL
#
# @param comment [Comment] the comment to create the URL for
def self.comment(comment)
url(comment.path)
end
# Creates a fragment URL for a comment on an article page
# if an article path is available
#
# @param comment [Comment] the comment to create the URL for
# @param path [String, nil] the path of the article to anchor the
# comment link instead of using the comment's permalink
def self.fragment_comment(comment, path:)
return comment(comment) if path.nil?
url("#{path}#comment-#{comment.id_code}")
end
# Creates a reaction URL
#
# A reaction URL is the URL of its reactable.
#
# @param reaction [Reaction, #reactable] the reaction to create the URL for
# @return [String]
# @see .url
def self.reaction(reaction)
url(reaction.reactable.path)
end
# Creates a tag URL
#
# @param tag [Tag] the tag to create the URL for
def self.tag(tag, page = 1)
url([tag_path(tag), ("/page/#{page}" if page > 1)].join)
end
def self.tag_path(tag)
"/t/#{CGI.escape(tag.name)}"
end
# Creates a user URL
#
# @param user [User] the user to create the URL for
def self.user(user)
url(user.username)
rescue URI::InvalidURIError # invalid username containing spaces will result in an error
nil
end
# Creates an Image URL - a shortcut for the .image_url helper
#
# @param image_name [String] the image file name
# @param host [String] (optional) the host for the image URL you'd like to use
def self.local_image(image_name, host: nil)
host ||= ActionController::Base.asset_host || url(nil)
ActionController::Base.helpers.image_url(image_name, host: host)
end
# Creates a deep link URL (for mobile) to a page in the current Forem and it
# relies on a UDL server to bounce back mobile users to the local `/r/mobile`
# fallback page. More details here: https://github.com/forem/udl-server
#
# @param path [String] the target path to deep link
def self.deep_link(path)
target_path = CGI.escape(url("/r/mobile?deep_link=#{path}"))
"https://udl.forem.com/?r=#{target_path}"
end
def self.organization(organization)
url(organization.slug)
end
end