123456789_123456789_123456789_123456789_123456789_

Class: RSS::Rss

Relationships & Source Files
Namespace Children
Classes:
Channel
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, Element, Utils::InheritedReader, BaseModel, Utils
Instance Chain:
self, RootElementMixin, XMLStyleSheetMixin, RSS09, Element, SetupMaker, Utils
Inherits: RSS::Element
Defined in: lib/rss/2.0.rb,
lib/rss/0.9.rb,
lib/rss/itunes.rb,
lib/rss/trackback.rb,
lib/rss/content/2.0.rb,
lib/rss/dublincore/2.0.rb

Overview

RSS 2.0 support

::RSS has three different versions. This module contains support for version 2.0

Producing RSS 2.0

Producing our own ::RSS feeds is easy as well. Let's make a very basic feed:

require "rss"

rss = RSS::Maker.make("2.0") do |maker|
  maker.channel.language = "en"
  maker.channel.author = "matz"
  maker.channel.updated = Time.now.to_s
  maker.channel.link = "http://www.ruby-lang.org/en/feeds/news.rss"
  maker.channel.title = "Example Feed"
  maker.channel.description = "A longer description of my feed."
  maker.items.new_item do |item|
    item.link = "http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
    item.title = "Ruby 1.9.2-p136 is released"
    item.updated = Time.now.to_s
  end
end

puts rss

As you can see, this is a very Builder-like DSL. This code will spit out an ::RSS 2.0 feed with one item. If we needed a second item, we'd make another block with maker.items.new_item and build a second one.

Constant Summary

Element - Inherited

GET_ATTRIBUTES, HAVE_CHILDREN_ELEMENTS, INDENT, MODELS, MUST_CALL_VALIDATORS, NEED_INITIALIZE_VARIABLES, PLURAL_FORMS, TO_ELEMENT_METHODS

RSS09 - Included

ELEMENTS, NSPOOL

Class Attribute Summary

Element - Inherited

.have_content?, .need_parent?

Class Method Summary

Element - Inherited

.add_have_children_element, .add_need_initialize_variable, .add_plural_form, .add_to_element_method, .content_setup, .def_corresponded_attr_reader, .def_corresponded_attr_writer, .get_attributes, .have_children_elements, .inherited, .inherited_base, .install_get_attribute, .install_model, .install_must_call_validator, .install_ns, .models, .must_call_validators, .need_initialize_variables, .new, .plural_forms, .required_prefix, .required_uri, .tag_name, .to_element_methods

Utils::InheritedReader - Extended

inherited_array_reader, inherited_hash_reader, inherited_reader

BaseModel - Extended

install_date_element,
install_have_attribute_element

Alias for BaseModel#install_have_child_element.
install_have_child_element, install_have_children_element, install_text_element, boolean_writer, content_writer, convert_attr_reader, csv_attr_reader, csv_integer_writer, csv_writer, date_writer, def_children_accessor, inherit_convert_attr_reader, install_element, integer_writer, positive_integer_writer, text_type_writer, uri_convert_attr_reader, yes_clean_other_attr_reader, yes_clean_other_writer, yes_other_attr_reader, yes_other_writer

Utils - Included

element_initialize_arguments?

This method is used inside of several different objects to determine if special behavior is needed in the constructor.
get_file_and_line_from_caller

Returns an array of two elements: the filename where the calling method is located, and the line number where it is defined.
h,
html_escape

Takes a string s with some HTML in it, and escapes '&', '“', '<' and '>', by replacing them with the appropriate entities.
new_with_value_if_need

If value is an instance of class klass, return it, else create a new instance of klass with value value.
to_class_name

Given a name in a name_with_underscores or a name-with-dashes format, returns the CamelCase version of name.

Instance Attribute Summary

RootElementMixin - Included

#encoding, #output_encoding, #output_encoding=, #standalone, #version, #feed_subtype, #feed_type, #feed_version

XMLStyleSheetMixin - Included

#xml_stylesheets

Element - Inherited

#do_validate, #parent, #have_xml_content?, #need_base64_encode?, #converter=, #have_required_elements?, #content_is_set?, #empty_content?

Instance Method Summary

RootElementMixin - Included

#feed_info, #initialize, #setup_maker, #to_atom, #to_feed, #to_rss, #to_xml, #maker_target, #ns_declarations, #same_feed_type?, #tag, #xmldecl

XMLStyleSheetMixin - Included

#initialize, #xml_stylesheet_pi

Element - Inherited

#convert, #full_name, #set_next_element, #tag_name, #to_s, #valid?, #validate, #validate_for_stream, #__validate, #_attrs, #_tags, #_validate,
#calc_indent

For backward compatibility.
#children, #collect_attrs, #initialize_have_children_elements, #initialize_variables, #make_start_tag, #tag, #tag_filter, #tag_name_with_prefix, #validate_attribute, #xmled_content

SetupMaker - Included

#setup_maker, #maker_target, #not_need_to_call_setup_maker_variables, #setup_maker_attributes, #setup_maker_element, #setup_maker_elements

Utils - Included

#element_initialize_arguments?

This method is used inside of several different objects to determine if special behavior is needed in the constructor.
#get_file_and_line_from_caller

Returns an array of two elements: the filename where the calling method is located, and the line number where it is defined.
#h,
#html_escape

Takes a string s with some HTML in it, and escapes '&', '“', '<' and '>', by replacing them with the appropriate entities.
#new_with_value_if_need

If value is an instance of class klass, return it, else create a new instance of klass with value value.
#to_class_name

Given a name in a name_with_underscores or a name-with-dashes format, returns the CamelCase version of name.

Constructor Details

.new(feed_version, version = nil, encoding = nil, standalone = nil) ⇒ Rss

[ GitHub ] 

  


# File 'lib/rss/0.9.rb', line 62



def initialize(feed_version, version=nil, encoding=nil, standalone=nil)
  super
  @feed_type = "rss"
end


  







Instance Attribute Details



  

    #feed_version=(value)   (writeonly)
    Also known as: #rss_version=
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 58



attr_writer :feed_version


  







Instance Method Details



  

    #_attrs   (private)
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 101



def _attrs
  [
    ["version", true, "feed_version"],
  ]
end


  








  

    #image  
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 75



def image
  if @channel
    @channel.image
  else
    nil
  end
end


  








  

    #items  
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 67



def items
  if @channel
    @channel.items
  else
    []
  end
end


  








  

    #rss_version   (writeonly)
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 59



alias_method(:rss_version, :feed_version)


  








  

    #setup_maker_elements(maker)  
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 91



def setup_maker_elements(maker)
  super
  items.each do |item|
    item.setup_maker(maker.items)
  end
  image.setup_maker(maker) if image
  textinput.setup_maker(maker) if textinput
end


  








  

    #textinput  
  

  [ GitHub ]


  

  


# File 'lib/rss/0.9.rb', line 83



def textinput
  if @channel
    @channel.textInput
  else
    nil
  end
end