diff options
author | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-04-26 05:36:51 +0000 |
---|---|---|
committer | zzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2013-04-26 05:36:51 +0000 |
commit | 1eb500466092961f2e8ee6a5afa5920615162de3 (patch) | |
tree | 4d212844e5cbd6a0237dc610b81e2f89e350876b /lib/rss/maker.rb | |
parent | 66938f38a309f6649fa29b62266b0992c391b2f3 (diff) |
* lib/rss/atom.rb: Documentation for RSS::Atom based on a patch by
Michael Denomy
* lib/rss/maker.rb: Documentation for RSS::Maker also by @mdenomy
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@40475 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'lib/rss/maker.rb')
-rw-r--r-- | lib/rss/maker.rb | 26 |
1 files changed, 25 insertions, 1 deletions
diff --git a/lib/rss/maker.rb b/lib/rss/maker.rb index a7ee200b32..c4ddbcae99 100644 --- a/lib/rss/maker.rb +++ b/lib/rss/maker.rb @@ -1,32 +1,56 @@ require "rss/rss" module RSS + ## + # + # Provides a set of builders for various RSS objects + # + # * Feeds + # * RSS 0.91 + # * RSS 1.0 + # * RSS 2.0 + # * Atom 1.0 + # + # * Elements + # * Atom::Entry + module Maker + + # Collection of supported makers MAKERS = {} class << self + # Builder for an RSS object + # Creates an object of the type passed in +args+ + # + # Executes the +block+ to populate elements of the created RSS object def make(version, &block) self[version].make(&block) end + # Returns the maker for the +version+ def [](version) maker_info = maker(version) raise UnsupportedMakerVersionError.new(version) if maker_info.nil? maker_info[:maker] end + # Adds a maker to the set of supported makers def add_maker(version, normalized_version, maker) MAKERS[version] = {:maker => maker, :version => normalized_version} end + # Returns collection of supported maker versions def versions MAKERS.keys.uniq.sort end + # Returns collection of supported makers def makers - MAKERS.values.collect {|info| info[:maker]}.uniq + MAKERS.values.collect { |info| info[:maker] }.uniq end + # Returns true if the version is supported def supported?(version) versions.include?(version) end |