Class: Html2rss::RssBuilder

Inherits:

Object

• Object
• Html2rss::RssBuilder

Defined in:

lib/html2rss/rss_builder.rb,
lib/html2rss/rss_builder/article.rb,
lib/html2rss/rss_builder/channel.rb,
lib/html2rss/rss_builder/enclosure.rb,
lib/html2rss/rss_builder/stylesheet.rb

Overview

Builds an RSS Feed by providing channel, articles and stylesheets.

Defined Under Namespace

Classes: Article, Channel, Enclosure, Stylesheet

Class Method Summary

• .add_item(article, item_maker) ⇒ void

Instance Method Summary

• #call ⇒ RSS::Rss

  RSS 2.0 document instance.

• #initialize(channel:, articles:, stylesheets: []) ⇒ RssBuilder constructor

  A new instance of RssBuilder.

Constructor Details

#initialize(channel:, articles:, stylesheets: []) ⇒ RssBuilder

Returns a new instance of RssBuilder.

Parameters:

• channel (Html2rss::RssBuilder::Channel) —

  The channel information for the RSS feed.

• articles (Array<Html2rss::RssBuilder::Article>) —

  The list of articles to include in the RSS feed.

• stylesheets (Array<Hash>) (defaults to: []) —

  An optional array of stylesheet configurations.

# File 'lib/html2rss/rss_builder.rb', line 50

def initialize(channel:, articles:, stylesheets: [])
  @channel = channel
  @articles = articles
  @stylesheets = stylesheets
end

Class Method Details

.add_item(article, item_maker) ⇒ void

This method returns an undefined value.

Parameters:

• article (Html2rss::RssBuilder::Article) —

  source article

• item_maker (RSS::Maker::RSS20::ItemsBase::ItemBase) —

  RSS item builder

# File 'lib/html2rss/rss_builder.rb', line 13

def add_item(article, item_maker)
  add_item_string_values(article, item_maker)
  add_item_categories(article, item_maker)
  Enclosure.add(article.enclosure, item_maker)
  add_item_guid(article, item_maker)
end

Instance Method Details

#call ⇒ RSS::Rss

Returns RSS 2.0 document instance.

Returns:

• (RSS::Rss) —

  RSS 2.0 document instance

# File 'lib/html2rss/rss_builder.rb', line 57

def call
  RSS::Maker.make('2.0') do |maker|
    Stylesheet.add(maker, stylesheets)

    make_channel(maker.channel)
    make_items(maker)
  end
end