Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extract a helpers #160

Merged
merged 1 commit into from
Mar 16, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
80 changes: 9 additions & 71 deletions lib/phlex/rails/helpers.rb
Original file line number Diff line number Diff line change
@@ -1,80 +1,18 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers
autoload :Tag, "phlex/rails/helpers/tag"
autoload :ActionCableMetaTag, "phlex/rails/helpers/action_cable_meta_tag"
autoload :ActionName, "phlex/rails/helpers/action_name"
autoload :AssetPath, "phlex/rails/helpers/asset_path"
autoload :AssetURL, "phlex/rails/helpers/asset_url"
autoload :AudioPath, "phlex/rails/helpers/audio_path"
autoload :AudioTag, "phlex/rails/helpers/audio_tag"
autoload :AudioURL, "phlex/rails/helpers/audio_url"
autoload :AutoDiscoveryLinkTag, "phlex/rails/helpers/auto_discovery_link_tag"
autoload :Routes, "phlex/rails/helpers/routes"
autoload :Tag, "phlex/rails/helpers/tag"
autoload :TurboStream, "phlex/rails/helpers/turbo_stream"

module ActionCableMetaTag
extend Phlex::Rails::HelperMacros

# @!method action_cable_meta_tag
# Outputs an "action-cable-url" meta tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag:
# @see https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag
# @return [nil]
define_output_helper :action_cable_meta_tag
end

module ActionName
extend Phlex::Rails::HelperMacros

# @!method action_name
# @return [String] the name of the controller action, e.g. <code>"index"</code>
# @see https://api.rubyonrails.org/classes/AbstractController/Base.html#method-i-action_name
define_value_helper :action_name
end

module AssetPath
extend Phlex::Rails::HelperMacros

# @!method asset_path(source, host: nil, protocol: nil, type: nil, skip_pipeline: nil, extname: nil)
# @param source [String]
# @param host [String]
# @param protocol [String] e.g. <code>"https"</code>
# @param type [Symbol] e.g. <code>:javascript</code>
# @param skip_pipeline [bool]
# @param extname [String] e.g. <code>".js"</code>
# @see https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path
define_value_helper :asset_path
end

module AssetURL
extend Phlex::Rails::HelperMacros

# @!method asset_url(...)
define_value_helper :asset_url
end

module AudioPath
extend Phlex::Rails::HelperMacros

# @!method audio_path(...)
define_value_helper :audio_path
end

module AudioTag
extend Phlex::Rails::HelperMacros

# @!method audio_tag(...)
# @return [nil]
define_output_helper :audio_tag
end

module AudioURL
extend Phlex::Rails::HelperMacros

# @!method audio_url(...)
define_value_helper :audio_url
end

module AutoDiscoveryLinkTag
extend Phlex::Rails::HelperMacros

# @!method auto_discovery_link_tag(...)
# @return [nil]
define_output_helper :auto_discovery_link_tag
end

module BuildTagValues
extend Phlex::Rails::HelperMacros

Expand Down
11 changes: 11 additions & 0 deletions lib/phlex/rails/helpers/action_cable_meta_tag.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::ActionCableMetaTag
extend Phlex::Rails::HelperMacros

# @!method action_cable_meta_tag
# Outputs an "action-cable-url" meta tag with the value of the URL specified in your configuration. Ensure this is above your JavaScript tag:
# @see https://api.rubyonrails.org/classes/ActionCable/Helpers/ActionCableHelper.html#method-i-action_cable_meta_tag
# @return [nil]
define_output_helper :action_cable_meta_tag
end
10 changes: 10 additions & 0 deletions lib/phlex/rails/helpers/action_name.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::ActionName
extend Phlex::Rails::HelperMacros

# @!method action_name
# @return [String] the name of the controller action, e.g. <code>"index"</code>
# @see https://api.rubyonrails.org/classes/AbstractController/Base.html#method-i-action_name
define_value_helper :action_name
end
15 changes: 15 additions & 0 deletions lib/phlex/rails/helpers/asset_path.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AssetPath
extend Phlex::Rails::HelperMacros

# @!method asset_path(source, host: nil, protocol: nil, type: nil, skip_pipeline: nil, extname: nil)
# @param source [String]
# @param host [String]
# @param protocol [String] e.g. <code>"https"</code>
# @param type [Symbol] e.g. <code>:javascript</code>
# @param skip_pipeline [bool]
# @param extname [String] e.g. <code>".js"</code>
# @see https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path
define_value_helper :asset_path
end
8 changes: 8 additions & 0 deletions lib/phlex/rails/helpers/asset_url.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AssetURL
extend Phlex::Rails::HelperMacros

# @!method asset_url(...)
define_value_helper :asset_url
end
8 changes: 8 additions & 0 deletions lib/phlex/rails/helpers/audio_path.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AudioPath
extend Phlex::Rails::HelperMacros

# @!method audio_path(...)
define_value_helper :audio_path
end
9 changes: 9 additions & 0 deletions lib/phlex/rails/helpers/audio_tag.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AudioTag
extend Phlex::Rails::HelperMacros

# @!method audio_tag(...)
# @return [nil]
define_output_helper :audio_tag
end
8 changes: 8 additions & 0 deletions lib/phlex/rails/helpers/audio_url.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AudioURL
extend Phlex::Rails::HelperMacros

# @!method audio_url(...)
define_value_helper :audio_url
end
9 changes: 9 additions & 0 deletions lib/phlex/rails/helpers/auto_discovery_link_tag.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# frozen_string_literal: true

module Phlex::Rails::Helpers::AutoDiscoveryLinkTag
extend Phlex::Rails::HelperMacros

# @!method auto_discovery_link_tag(...)
# @return [nil]
define_output_helper :auto_discovery_link_tag
end