Module: Linkety::ViewHelpers

Defined in:
lib/linkety/view_helpers.rb

Instance Method Summary collapse

Instance Method Details

Public: Generates an HTML anchor tag in either an active or inactive state, depending on a given truth value.

If the truth value is true, this method will generate a link that has an ‘active’ class (or whatever class name you optionally specify for :active_class).

If the truth value is false, this method will generate a link by default with an href of ‘#’ (or whatever you specify for :inactive_url) and with an added ‘inactive’ class (or whatever you specify for :inactive_class).

truth - A Boolean truth value. text - A String of anchor text. url - A String URL. options - A Hash of options. In addition to the regular #link_to options,

you may set the following:
:active_class   - A String class to add if the link is active 
                  (default: 'active').
:inactive_class - A String class to add if the link is inactive
                  (default: 'inactive').
:inactive_url   - A String URL for when the link is inactive
                  (default: '#').

Returns a String anchor tag.



28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/linkety/view_helpers.rb', line 28

def active_link_to_if(truth, text, url, options = {})
  active_class   = options[:active_class]   || "active"
  inactive_class = options[:inactive_class] || "inactive"
  inactive_url   = options[:inactive_url]   || "#"
  klasses        = (options.delete(:class)  || "").split(' ')
  
  klasses << (truth ? active_class : inactive_class)
  url = inactive_url unless truth
  
  link_to(text, url, options.merge(:class => klasses.join(' ')))
end

#current_link_to(text, url, options = {}) ⇒ Object

Public: Generates an HTML anchor tag that has a ‘current’ class if the current request path matches the link path.

text - A String of anchor text. url - A String URL. options - A Hash of options. In addition to the regular #link_to options,

you may set the following:
:current_class - The String class to add if the link is current
                 (default: 'current').
:pattern       - A Regexp pattern to match against the current 
                 path (default: the link URL path).

Returns a String anchor tag.



74
75
76
77
78
79
80
81
82
 
# File 'lib/linkety/view_helpers.rb', line 74

def current_link_to(text, url, options = {})
  current_class = options[:current_class] || "current"
  klasses       = (options.delete(:class) || "").split(' ')
  href_path     = extract_path(url)
  pattern       = options[:pattern] || Regexp.new(href_path)

  klasses << current_class if current_path =~ pattern
  link_to(text, url, options.merge(:class => klasses.join(' ')))
end

#current_path ⇒ Object

Private: The path of the current request.

Returns a String.



87
88
89
90
91
 
# File 'lib/linkety/view_helpers.rb', line 87

def current_path
  raise "A Request object must be present" unless request
  fullpath = request.fullpath.split("?")[0]
  extract_path(fullpath)
end

#extract_path(uri) ⇒ Object

Private: Extract just the path portion of a URL without the query string.

uri - A String URL.

Examples

extract_path("http://google.com/foo/bar")
=> "/foo/bar"

extract_path("/foo/bar/que?order=asc")
=> "/foo/bar/que"

Returns a String.



106
107
108
109
110
 
# File 'lib/linkety/view_helpers.rb', line 106

def extract_path(uri)
  matches = /(^\w+)*(:\/\/){0,1}(\w|\.)*(\/.*)/.match(uri)
  path = matches ? matches[4] : ""
  path.split("?")[0] || ""
end

#inactive_link_to_if(truth, text, url, options = {}) ⇒ Object

Public: Generates an HTML anchor tag in either an inactive or active state, depending on a given truth value. (See #active_link_to_if for more details.)

truth - A Boolean truth value. text - A String of anchor text. url - A String URL. options - A Hash of options. In addition to the regular #link_to options,

you may set the following:
:active_class   - A String class to add if the link is active 
                  (default: 'active').
:inactive_class - A String class to add if the link is inactive
                  (default: 'inactive').
:inactive_url   - A String URL for when the link is inactive
                  (default: '#').

Returns a String anchor tag.



57
58
59
 
# File 'lib/linkety/view_helpers.rb', line 57

def inactive_link_to_if(truth, text, url, options = {})
  active_link_to_if(!truth, text, url, options)
end