123456789_123456789_123456789_123456789_123456789_

Class: RSS::Atom::Feed

Relationships & Source Files
Namespace Children
Classes:
Author, Category, Contributor, Entry, Generator, Icon, Id, Link, Logo, Rights, Subtitle, Title, Updated
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RSS::Element, ::RSS::Utils::InheritedReader, ::RSS::BaseModel, ::RSS::Utils
Instance Chain:
self, ::RSS::DublinCoreModel, DuplicateLinkChecker, CommonModel, ::RSS::RootElementMixin, ::RSS::XMLStyleSheetMixin, ::RSS::Element, ::RSS::SetupMaker, ::RSS::Utils
Inherits: RSS::Element
Defined in: lib/rss/atom.rb,
lib/rss/dublincore/atom.rb

Overview

Defines the top-level element of an ::RSS::Atom Feed Document. It consists of a number of children Entry elements, and has the following attributes:

  • author

  • categories

  • category

  • content

  • contributor

  • entries (aliased as items)

  • entry

  • generator

  • icon

  • id

  • link

  • logo

  • rights

  • subtitle

  • title

  • updated

Reference: validator.w3.org/feed/docs/rfc4287.html#element.feed

Constant Summary

::RSS::Element - Inherited

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

CommonModel - Included

ELEMENTS, NSPOOL

::RSS::DublinCoreModel - Included

DATE_ELEMENTS, ELEMENTS, ELEMENT_NAME_INFOS, TEXT_ELEMENTS

Class Attribute Summary

::RSS::Element - Inherited

.have_content?, .need_parent?

Class Method Summary

::RSS::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

::RSS::Utils::InheritedReader - Extended

inherited_array_reader, inherited_hash_reader, inherited_reader

::RSS::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

::RSS::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

::RSS::RootElementMixin - Included

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

::RSS::XMLStyleSheetMixin - Included

#xml_stylesheets

::RSS::Element - Inherited

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

Instance Method Summary

DuplicateLinkChecker - Included

#validate_duplicate_links

Checks if there are duplicate links with the same type and hreflang attributes that have an alternate (or empty) rel attribute.

::RSS::RootElementMixin - Included

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

::RSS::XMLStyleSheetMixin - Included

#initialize, #xml_stylesheet_pi

::RSS::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

::RSS::SetupMaker - Included

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

::RSS::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(version = nil, encoding = nil, standalone = nil) ⇒ Feed

Creates a new ::RSS::Atom feed

[ GitHub ] 

  


# File 'lib/rss/atom.rb', line 313



def initialize(version=nil, encoding=nil, standalone=nil)
  super("1.0", version, encoding, standalone)
  @feed_type = "atom"
  @feed_subtype = "feed"
end


  







Instance Attribute Details



  

    #have_author?  ⇒ Boolean  (readonly)
  



  

    

Returns true if there are any authors for the feed or any of the Feed::Entry child elements have an author


  





  


  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 323



def have_author?
  authors.any? {|author| !author.to_s.empty?} or
    entries.any? {|entry| entry.have_author?(false)}
end


  








  

    #have_required_elements?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 336



def have_required_elements?
  super and have_author?
end


  







Instance Method Details



  

    #atom_validate(ignore_unknown_element, tags, uri)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 329



def atom_validate(ignore_unknown_element, tags, uri)
  unless have_author?
    raise MissingTagError.new("author", tag_name)
  end
  validate_duplicate_links(links)
end


  








  

    #items  
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 319



alias_method :items, :entries


  








  

    #maker_target(maker)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 340



def maker_target(maker)
  maker.channel
end


  








  

    #setup_maker_element(channel)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 344



def setup_maker_element(channel)
  prev_dc_dates = channel.dc_dates.to_a.dup
  super
  channel.about = id.content if id
  channel.dc_dates.replace(prev_dc_dates)
end


  








  

    #setup_maker_elements(channel)   (private)
  

  [ GitHub ]


  

  


# File 'lib/rss/atom.rb', line 351



def setup_maker_elements(channel)
  super
  items = channel.maker.items
  entries.each do |entry|
    entry.setup_maker(items)
  end
end