Module: Nanoc::Helpers::Blogging

Included in:

AtomFeedBuilder

Defined in:

lib/nanoc/helpers/blogging.rb

Overview

See Also:

• https://nanoc.app/doc/reference/helpers/#blogging

Defined Under Namespace

Classes: AtomFeedBuilder

Instance Method Summary

• #articles ⇒ Array
• #atom_feed(params = {}) ⇒ String
• #atom_tag_for(item) ⇒ String
• #attribute_to_time(arg) ⇒ Time
• #feed_url ⇒ String
• #sorted_articles ⇒ Array
• #url_for(item) ⇒ String

Instance Method Details

#articles ⇒ Array

Returns:

• (Array)

# File 'lib/nanoc/helpers/blogging.rb', line 7

def articles
  blk = -> { @items.select { |item| item[:kind] == 'article' } }
  if @items.frozen?
    @article_items ||= blk.call
  else
    blk.call
  end
end

#atom_feed(params = {}) ⇒ String

Parameters:

• params (Hash) (defaults to: {}) —

  a customizable set of options

Options Hash (params):

• :limit (Number)
• :articles (Array)
• :preserve_order (Boolean)
• :content_proc (Proc)
• :excerpt_proc (Proc)
• :title_proc (Proc)
• :alt_link (String)
• :id (String)
• :title (String)
• :author_name (String)
• :author_uri (String)
• :icon (String)
• :logo (String)

Returns:

• (String)

# File 'lib/nanoc/helpers/blogging.rb', line 191

def atom_feed(params = {})
  require 'builder'

  # Create builder
  builder = AtomFeedBuilder.new(@config, @item)

  # Fill builder
  builder.alt_link          = params[:alt_link]
  builder.id                = params[:id]
  builder.limit             = params[:limit] || 5
  builder.relevant_articles = params[:articles] || articles || []
  builder.preserve_order    = params.fetch(:preserve_order, false)
  builder.content_proc      = params[:content_proc] || ->(a) { a.compiled_content(snapshot: :pre) }
  builder.excerpt_proc      = params[:excerpt_proc] || ->(a) { a[:excerpt] }
  builder.title_proc        = params[:title_proc] || ->(a) { a[:title] }
  builder.title             = params[:title] || @item[:title] || @config[:title]
  builder.author_name       = params[:author_name] || @item[:author_name] || @config[:author_name]
  builder.author_uri        = params[:author_uri] || @item[:author_uri] || @config[:author_uri]
  builder.icon              = params[:icon]
  builder.logo              = params[:logo]

  # Run
  builder.validate
  builder.build
end

#atom_tag_for(item) ⇒ String

Returns:

• (String)

# File 'lib/nanoc/helpers/blogging.rb', line 245

def atom_tag_for(item)
  hostname, base_dir = %r{^.+?://([^/]+)(.*)$}.match(@config[:base_url])[1..2]

  formatted_date = attribute_to_time(item[:created_at]).__nanoc_to_iso8601_date

  'tag:' + hostname + ',' + formatted_date + ':' + base_dir + (item.path || item.identifier.to_s)
end

#attribute_to_time(arg) ⇒ Time

Parameters:

• arg (String, Time, Date, DateTime)

Returns:

• (Time)

# File 'lib/nanoc/helpers/blogging.rb', line 256

def attribute_to_time(arg)
  case arg
  when DateTime
    arg.to_time
  when Date
    Time.utc(arg.year, arg.month, arg.day)
  when String
    Time.parse(arg)
  else
    arg
  end
end

#feed_url ⇒ String

Returns:

• (String)

# File 'lib/nanoc/helpers/blogging.rb', line 235

def feed_url
  # Check attributes
  if @config[:base_url].nil?
    raise Nanoc::Core::TrivialError.new('Cannot build Atom feed: site configuration has no base_url')
  end

  @item[:feed_url] || @config[:base_url] + @item.path
end

#sorted_articles ⇒ Array

Returns:

• (Array)

# File 'lib/nanoc/helpers/blogging.rb', line 17

def sorted_articles
  blk = -> { articles.sort_by { |a| attribute_to_time(a[:created_at]) }.reverse }

  if @items.frozen?
    @sorted_article_items ||= blk.call
  else
    blk.call
  end
end

#url_for(item) ⇒ String

Returns:

• (String)

# File 'lib/nanoc/helpers/blogging.rb', line 218

def url_for(item)
  # Check attributes
  if @config[:base_url].nil?
    raise Nanoc::Core::TrivialError.new('Cannot build Atom feed: site configuration has no base_url')
  end

  # Build URL
  if item[:custom_url_in_feed]
    item[:custom_url_in_feed]
  elsif item[:custom_path_in_feed]
    @config[:base_url] + item[:custom_path_in_feed]
  elsif item.path
    @config[:base_url] + item.path
  end
end