123456789_123456789_123456789_123456789_123456789_

Class: RSS::Atom::Feed::Entry::Content

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Class Chain:
self, ::RSS::Element, ::RSS::Utils::InheritedReader, ::RSS::BaseModel, ::RSS::Utils
Instance Chain:
self, ::RSS::Atom::CommonModel, ::RSS::Element, ::RSS::SetupMaker, ::RSS::Utils
Inherits: RSS::Element
Defined in: lib/rss/atom.rb

Overview

Contains or links to the content of the ::RSS::Atom::Feed::Entry. It has the following attributes:

  • type

  • src

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

Constant Summary

::RSS::Element - Inherited

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

::RSS::Atom::CommonModel - Included

ELEMENTS, NSPOOL

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::Element - Inherited

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

Instance Method Summary

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

This class inherits a constructor from RSS::Element

Class Method Details

.xml_getter

[ GitHub ] 

  


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



def xml_getter
  "xml"
end


  








  

    .xml_setter  
  

  [ GitHub ]


  

  


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



def xml_setter
  "xml="
end


  







Instance Attribute Details



  

    #empty_content?  ⇒ Boolean  (readonly, private)
  

  [ GitHub ]


  

  


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



def empty_content?
  out_of_line? or super
end


  








  

    #have_xml_content?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element has inline ::RSS::XML content.


  





  


  [ GitHub ]


  

  


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



def have_xml_content?
  inline_xhtml? or inline_other_xml?
end


  








  

    #inline_html?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a HTML media type.


  





  


  [ GitHub ]


  

  


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



def inline_html?
  return false if out_of_line?
  @type == "html" or mime_split == ["text", "html"]
end


  








  

    #inline_other?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a MIME media type.


  





  


  [ GitHub ]


  

  


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



def inline_other?
  return false if out_of_line?
  media_type, subtype = mime_split
  return false if media_type.nil? or subtype.nil?
  true
end


  








  

    #inline_other_base64?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content encoded in base64.


  





  


  [ GitHub ]


  

  


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



def inline_other_base64?
  inline_other? and !inline_other_text? and !inline_other_xml?
end


  








  

    #inline_other_text?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a text media type.


  





  


  [ GitHub ]


  

  


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



def inline_other_text?
  return false unless inline_other?
  return false if inline_other_xml?

  media_type, = mime_split
  return true if "text" == media_type.downcase
  false
end


  








  

    #inline_other_xml?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a ::RSS::XML media type.


  





  


  [ GitHub ]


  

  


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



def inline_other_xml?
  return false unless inline_other?

  media_type, subtype = mime_split
  normalized_mime_type = "#{media_type}/#{subtype}".downcase
  if /(?:\+xml|^xml)$/ =~ subtype or
      %w(text/xml-external-parsed-entity
         application/xml-external-parsed-entity
         application/xml-dtd).find {|x| x == normalized_mime_type}
    return true
  end
  false
end


  








  

    #inline_text?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a text or HTML media type, or no media type at all.


  





  


  [ GitHub ]


  

  


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



def inline_text?
  !out_of_line? and [nil, "text", "html"].include?(@type)
end


  








  

    #inline_xhtml?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains inline content that has a XHTML media type.


  





  


  [ GitHub ]


  

  


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



def inline_xhtml?
  !out_of_line? and @type == "xhtml"
end


  








  

    #need_base64_encode?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the content needs to be encoded in base64.


  





  


  [ GitHub ]


  

  


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



def need_base64_encode?
  inline_other_base64?
end


  








  

    #out_of_line?  ⇒ Boolean  (readonly)
  



  

    

Returns true if the element contains linked content.


  





  


  [ GitHub ]


  

  


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



def out_of_line?
  not @src.nil?
end


  








  

    #xml   (rw)
  



  

    

Returns or builds the element content in ::RSS::XML.


  



  [ GitHub ]


  

  


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



def xml
  return @xml unless inline_xhtml?
  return @xml if @xml.nil?
  if @xml.is_a?(XML::Element) and
      [@xml.name, @xml.uri] == ["div", XHTML_URI]
    return @xml
  end

  children = @xml
  children = [children] unless children.is_a?(Array)
  XML::Element.new("div", nil, XHTML_URI,
                   {"xmlns" => XHTML_URI}, children)
end


  








  

    #xml=(value)   (rw)
  



  

    

Returns the element content in ::RSS::XML.


  



  [ GitHub ]


  

  


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



attr_writer :xml


  







Instance Method Details



  

    #atom_validate(ignore_unknown_element, tags, uri)  
  



  

    

Raises a ::RSS::MissingAttributeError, ::RSS::NotAvailableValueError, ::RSS::MissingTagError or ::RSS::NotExpectedTagError if the element is not properly formatted.


  



  [ GitHub ]


  

  


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



def atom_validate(ignore_unknown_element, tags, uri)
  if out_of_line?
    raise MissingAttributeError.new(tag_name, "type") if @type.nil?
    unless (content.nil? or content.empty?)
      raise NotAvailableValueError.new(tag_name, content)
    end
  elsif inline_xhtml?
    if @xml.nil?
      raise MissingTagError.new("div", tag_name)
    end
    unless @xml.name == "div" and @xml.uri == XHTML_URI
      raise NotExpectedTagError.new(@xml.name, @xml.uri, tag_name)
    end
  end
end


  








  

    #mime_split  
  



  

    

Splits the type attribute into an array, e.g. [“text”, “xml”]


  



  [ GitHub ]


  

  


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



def mime_split
  media_type = subtype = nil
  if /\A\s*([a-z])\/([a-z\]+)\s*(?:;.*)?\z/i =~ @type.to_s
    media_type = $1.downcase
    subtype = $2.downcase
  end
  [media_type, subtype]
end


  








  

    #xhtml  
  



  

    

Returns the element content in XHTML.


  



  [ GitHub ]


  

  


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



def xhtml
  if inline_xhtml?
    xml
  else
    nil
  end
end