Home Classes Methods

In Files

rss/rss.rb

Parent

Object

Methods

::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
::have_content?
::inherited
::inherited_base
::install_get_attribute
::install_model
::install_must_call_validator
::install_ns
::models
::must_call_validators
::need_initialize_variables
::need_parent?
::new
::plural_forms
::required_prefix
::required_uri
::tag_name
::to_element_methods
#convert
#converter=
#full_name
#have_required_elements?
#have_xml_content?
#need_base64_encode?
#set_next_element
#tag_name
#to_s
#valid?
#validate
#validate_for_stream

Included Modules

Class/Module Index

RSS::Element

Attributes

do_validate[RW]

parent[RW]

Public Class Methods

add_have_children_element(variable_name, plural_name) click to toggle source

 
               # File rss/rss.rb, line 804
def add_have_children_element(variable_name, plural_name)
  self::HAVE_CHILDREN_ELEMENTS << [variable_name, plural_name]
end

add_need_initialize_variable(variable_name) click to toggle source

 
               # File rss/rss.rb, line 812
def add_need_initialize_variable(variable_name)
  self::NEED_INITIALIZE_VARIABLES << variable_name
end

add_plural_form(singular, plural) click to toggle source

 
               # File rss/rss.rb, line 816
def add_plural_form(singular, plural)
  self::PLURAL_FORMS[singular] = plural
end

add_to_element_method(method_name) click to toggle source

 
               # File rss/rss.rb, line 808
def add_to_element_method(method_name)
  self::TO_ELEMENT_METHODS << method_name
end

content_setup(type=nil, disp_name=nil) click to toggle source

 
               # File rss/rss.rb, line 793
def content_setup(type=nil, disp_name=nil)
  writer_type, reader_type = type
  def_corresponded_attr_writer :content, writer_type, disp_name
  def_corresponded_attr_reader :content, reader_type
  @have_content = true
end

def_corresponded_attr_reader(name, type=nil) click to toggle source

 
               # File rss/rss.rb, line 774
def def_corresponded_attr_reader(name, type=nil)
  case type
  when :inherit
    inherit_convert_attr_reader name
  when :uri
    uri_convert_attr_reader name
  when :yes_clean_other
    yes_clean_other_attr_reader name
  when :yes_other
    yes_other_attr_reader name
  when :csv
    csv_attr_reader name
  when :csv_integer
    csv_attr_reader name, :separator => ","
  else
    convert_attr_reader name
  end
end

def_corresponded_attr_writer(name, type=nil, disp_name=nil) click to toggle source

 
               # File rss/rss.rb, line 746
def def_corresponded_attr_writer(name, type=nil, disp_name=nil)
  disp_name ||= name
  case type
  when :integer
    integer_writer name, disp_name
  when :positive_integer
    positive_integer_writer name, disp_name
  when :boolean
    boolean_writer name, disp_name
  when :w3cdtf, :rfc822, :rfc2822
    date_writer name, type, disp_name
  when :text_type
    text_type_writer name, disp_name
  when :content
    content_writer name, disp_name
  when :yes_clean_other
    yes_clean_other_writer name, disp_name
  when :yes_other
    yes_other_writer name, disp_name
  when :csv
    csv_writer name
  when :csv_integer
    csv_integer_writer name
  else
    attr_writer name
  end
end

get_attributes() click to toggle source

 
               # File rss/rss.rb, line 683
def get_attributes
  inherited_array_reader("GET_ATTRIBUTES")
end

have_children_elements() click to toggle source

 
               # File rss/rss.rb, line 686
def have_children_elements
  inherited_array_reader("HAVE_CHILDREN_ELEMENTS")
end

have_content?() click to toggle source

 
               # File rss/rss.rb, line 800
def have_content?
  @have_content
end

inherited(klass) click to toggle source

 
               # File rss/rss.rb, line 703
def inherited(klass)
  klass.const_set(:MUST_CALL_VALIDATORS, {})
  klass.const_set(:MODELS, [])
  klass.const_set(:GET_ATTRIBUTES, [])
  klass.const_set(:HAVE_CHILDREN_ELEMENTS, [])
  klass.const_set(:TO_ELEMENT_METHODS, [])
  klass.const_set(:NEED_INITIALIZE_VARIABLES, [])
  klass.const_set(:PLURAL_FORMS, {})

  tag_name = klass.name.split(/::/).last
  tag_name[0, 1] = tag_name[0, 1].downcase
  klass.instance_variable_set(:@tag_name, tag_name)
  klass.instance_variable_set(:@have_content, false)
end

inherited_base() click to toggle source

 
               # File rss/rss.rb, line 699
def inherited_base
  ::RSS::Element
end

install_get_attribute(name, uri, required=true, type=nil, disp_name=nil, element_name=nil) click to toggle source

 
               # File rss/rss.rb, line 731
def install_get_attribute(name, uri, required=true,
                          type=nil, disp_name=nil,
                          element_name=nil)
  disp_name ||= name
  element_name ||= name
  writer_type, reader_type = type
  def_corresponded_attr_writer name, writer_type, disp_name
  def_corresponded_attr_reader name, reader_type
  if type == :boolean and /^is/ =~ name
    alias_method "#{$POSTMATCH}?", name
  end
  self::GET_ATTRIBUTES << [name, uri, required, element_name]
  add_need_initialize_variable(disp_name)
end

install_model(tag, uri, occurs=nil, getter=nil, plural=false) click to toggle source

 
               # File rss/rss.rb, line 722
def install_model(tag, uri, occurs=nil, getter=nil, plural=false)
  getter ||= tag
  if m = self::MODELS.find {|t, u, o, g, p| t == tag and u == uri}
    m[2] = occurs
  else
    self::MODELS << [tag, uri, occurs, getter, plural]
  end
end

install_must_call_validator(prefix, uri) click to toggle source

 
               # File rss/rss.rb, line 718
def install_must_call_validator(prefix, uri)
  self::MUST_CALL_VALIDATORS[uri] = prefix
end

install_ns(prefix, uri) click to toggle source

 
               # File rss/rss.rb, line 832
def install_ns(prefix, uri)
  if self::NSPOOL.has_key?(prefix)
    raise OverlappedPrefixError.new(prefix)
  end
  self::NSPOOL[prefix] = uri
end

models() click to toggle source

 
               # File rss/rss.rb, line 680
def models
  inherited_array_reader("MODELS")
end

must_call_validators() click to toggle source

 
               # File rss/rss.rb, line 677
def must_call_validators
  inherited_hash_reader("MUST_CALL_VALIDATORS")
end

need_initialize_variables() click to toggle source

 
               # File rss/rss.rb, line 692
def need_initialize_variables
  inherited_array_reader("NEED_INITIALIZE_VARIABLES")
end

need_parent?() click to toggle source

 
               # File rss/rss.rb, line 828
def need_parent?
  false
end

new(do_validate=true, attrs=nil) click to toggle source

 
               # File rss/rss.rb, line 846
def initialize(do_validate=true, attrs=nil)
  @parent = nil
  @converter = nil
  if attrs.nil? and (do_validate.is_a?(Hash) or do_validate.is_a?(Array))
    do_validate, attrs = true, do_validate
  end
  @do_validate = do_validate
  initialize_variables(attrs || {})
end

plural_forms() click to toggle source

 
               # File rss/rss.rb, line 695
def plural_forms
  inherited_hash_reader("PLURAL_FORMS")
end

required_prefix() click to toggle source

 
               # File rss/rss.rb, line 820
def required_prefix
  nil
end

required_uri() click to toggle source

 
               # File rss/rss.rb, line 824
def required_uri
  ""
end

tag_name() click to toggle source

 
               # File rss/rss.rb, line 839
def tag_name
  @tag_name
end

to_element_methods() click to toggle source

 
               # File rss/rss.rb, line 689
def to_element_methods
  inherited_array_reader("TO_ELEMENT_METHODS")
end

Public Instance Methods

convert(value) click to toggle source

 
               # File rss/rss.rb, line 875
def convert(value)
  if @converter
    @converter.convert(value)
  else
    value
  end
end

converter=(converter) click to toggle source

 
               # File rss/rss.rb, line 864
def converter=(converter)
  @converter = converter
  targets = children.dup
  self.class.have_children_elements.each do |variable_name, plural_name|
    targets.concat(__send__(plural_name))
  end
  targets.each do |target|
    target.converter = converter unless target.nil?
  end
end

full_name() click to toggle source

 
               # File rss/rss.rb, line 860
def full_name
  tag_name
end

have_xml_content?() click to toggle source

 
               # File rss/rss.rb, line 925
def have_xml_content?
  false
end

need_base64_encode?() click to toggle source

 
               # File rss/rss.rb, line 929
def need_base64_encode?
  false
end

set_next_element(tag_name, next_element) click to toggle source

 
               # File rss/rss.rb, line 933
def set_next_element(tag_name, next_element)
  klass = next_element.class
  prefix = ""
  prefix << "#{klass.required_prefix}_" if klass.required_prefix
  key = "#{prefix}#{tag_name.gsub(/-/, '_')}"
  if self.class.plural_forms.has_key?(key)
    ary = __send__("#{self.class.plural_forms[key]}")
    ary << next_element
  else
    __send__("#{key}=", next_element)
  end
end

tag_name() click to toggle source

 
               # File rss/rss.rb, line 856
def tag_name
  self.class.tag_name
end

to_s(need_convert=true, indent='') click to toggle source

 
               # File rss/rss.rb, line 904
def to_s(need_convert=true, indent='')
  if self.class.have_content?
    return "" if !empty_content? and !content_is_set?
    rv = tag(indent) do |next_indent|
      if empty_content?
        ""
      else
        xmled_content
      end
    end
  else
    rv = tag(indent) do |next_indent|
      self.class.to_element_methods.collect do |method_name|
        __send__(method_name, false, next_indent)
      end
    end
  end
  rv = convert(rv) if need_convert
  rv
end

valid?(ignore_unknown_element=true) click to toggle source

 
               # File rss/rss.rb, line 883
def valid?(ignore_unknown_element=true)
  validate(ignore_unknown_element)
  true
rescue RSS::Error
  false
end

validate(ignore_unknown_element=true) click to toggle source

 
               # File rss/rss.rb, line 890
def validate(ignore_unknown_element=true)
  do_validate = @do_validate
  @do_validate = true
  validate_attribute
  __validate(ignore_unknown_element)
ensure
  @do_validate = do_validate
end

validate_for_stream(tags, ignore_unknown_element=true) click to toggle source

 
               # File rss/rss.rb, line 899
def validate_for_stream(tags, ignore_unknown_element=true)
  validate_attribute
  __validate(ignore_unknown_element, tags, false)
end

Protected Instance Methods

have_required_elements?() click to toggle source

 
               # File rss/rss.rb, line 947
def have_required_elements?
  self.class::MODELS.all? do |tag, uri, occurs, getter|
    if occurs.nil? or occurs == "+"
      child = __send__(getter)
      if child.is_a?(Array)
        children = child
        children.any? {|c| c.have_required_elements?}
      else
        !child.to_s.empty?
      end
    else
      true
    end
  end
end

Commenting is here to help enhance the documentation. For example, code samples, or clarification of the documentation.

If you have questions about Ruby or the documentation, please post to one of the Ruby mailing lists. You will get better, faster, help that way.

If you wish to post a correction of the docs, please do so, but also file bug report so that it can be corrected for the next release. Thank you.

If you want to help improve the Ruby documentation, please see Improve the docs, or visit Documenting-ruby.org.