Contents

# encoding: utf-8

module Nanoc3::Helpers

  # Nanoc3::Helpers::Tagging provides some support for managing tags added to
  # items. To add tags to items, set the +tags+ attribute to an array of
  # tags that should be applied to the item. For example:
  #
  #   tags: [ 'foo', 'bar', 'baz' ]
  #
  # To activate this helper, +include+ it, like this:
  #
  #   include Nanoc3::Helpers::Tagging
  module Tagging

    # Returns a formatted list of tags for the given item as a string. Several
    # parameters allow customization:
    #
    # :base_url:: The URL to which the tag will be appended to construct the
    #             link URL. This URL must have a trailing slash. Defaults to
    #             "http://technorati.com/tag/".
    #
    # :none_text:: The text to display when the item has no tags. Defaults to
    #              "(none)".
    #
    # :separator:: The separator to put between tags. Defaults to ", ".
    def tags_for(item, params={})
      base_url  = params[:base_url]  || 'http://technorati.com/tag/'
      none_text = params[:none_text] || '(none)'
      separator = params[:separator] || ', '

      if item[:tags].nil? or item[:tags].empty?
        none_text
      else
        item[:tags].map { |tag| link_for_tag(tag, base_url) }.join(separator)
      end
    end

    # Returns all items with the given tag.
    def items_with_tag(tag)
      @items.select { |i| (i[:tags] || []).include?(tag) }
    end

    # Returns a link to to the specified tag. The link is marked up using the
    # rel-tag microformat.
    #
    # +tag+:: The name of the tag, which should consist of letters and numbers
    #         (no spaces, slashes, or other special characters).
    #
    # +base_url+:: The URL to which the tag will be appended to construct the
    #              link URL. This URL must have a trailing slash.
    def link_for_tag(tag, base_url)
      %[<a href="#{base_url}#{tag}" rel="tag">#{tag}</a>]
    end

  end

end

Version data entries

3 entries across 3 versions & 1 rubygems

Version	Path
nanoc3-3.0.2	lib/nanoc3/helpers/tagging.rb
nanoc3-3.0.1	lib/nanoc3/helpers/tagging.rb
nanoc3-3.0.0	lib/nanoc3/helpers/tagging.rb