Module: RSS::Atom::TextConstruct

Included in:
Feed::Entry::Summary, Feed::Rights, Feed::Subtitle, Feed::Title
Defined in:
lib/rss/atom.rb

Overview

The TextConstruct module is used to define a Text construct Atom element, which is used to store small quantities of human-readable text.

The TextConstruct has a type attribute, e.g. text, html, xhtml

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#xhtml ⇒ Object

Returns or builds the XHTML content.



130
131
132
133
134
135
136
137
138
139
140
141
 
# File 'lib/rss/atom.rb', line 130

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

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

Class Method Details

.append_features(klass) ⇒ Object 



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/rss/atom.rb', line 103

def self.append_features(klass)
  super
  klass.class_eval do
    [
     ["type", ""],
    ].each do |name, uri, required|
      install_get_attribute(name, uri, required, :text_type)
    end

    content_setup
    add_need_initialize_variable("xhtml")

    class << self
      def xml_getter
        "xhtml"
      end

      def xml_setter
        "xhtml="
      end
    end
  end
end

Instance Method Details

#atom_validate(ignore_unknown_element, tags, uri) ⇒ Object

Raises a MissingTagError or NotExpectedTagError if the element is not properly formatted.



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/rss/atom.rb', line 150

def atom_validate(ignore_unknown_element, tags, uri)
  if have_xml_content?
    if @xhtml.nil?
      raise MissingTagError.new("div", tag_name)
    end
    unless [@xhtml.name, @xhtml.uri] == ["div", XHTML_URI]
      raise NotExpectedTagError.new(@xhtml.name, @xhtml.uri, tag_name)
    end
  end
end

#have_xml_content? ⇒ Boolean

Returns true if type is “xhtml”.

Returns:

  • (Boolean) 


144
145
146
 
# File 'lib/rss/atom.rb', line 144

def have_xml_content?
  @type == "xhtml"
end