* lib/rss: supported Image module.

  http://web.resource.org/rss/1.0/modules/image/


git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@7876 b2dd03c8-39d4-4d8f-98ff-823fe69b080e

9 files changed, 381 insertions, 8 deletions

diff --git a/lib/rss/0.9.rb b/lib/rss/0.9.rb
index 24560324ed..2bb59763d9 100644
--- a/lib/rss/0.9.rb
+++ b/lib/rss/0.9.rb
@@ -223,6 +223,10 @@ module RSS
         end
       end
 
+      def not_need_to_call_setup_maker_variables
+        %w(image textInput)
+      end
+    
       class SkipDays < Element
         include RSS09
 
diff --git a/lib/rss/dublincore.rb b/lib/rss/dublincore.rb
index 7ea9cf31dd..afdd4d392d 100644
--- a/lib/rss/dublincore.rb
+++ b/lib/rss/dublincore.rb
@@ -56,7 +56,6 @@ module RSS
   end
 
   prefix_size = DC_PREFIX.size + 1
-  DublinCoreModel::ELEMENTS.uniq!
   DublinCoreModel::ELEMENTS.each do |x|
     BaseListener.install_get_text_element(x[prefix_size..-1], DC_URI, "#{x}=")
   end
diff --git a/lib/rss/image.rb b/lib/rss/image.rb
new file mode 100644
index 0000000000..9cc3c73018
--- /dev/null
+++ b/lib/rss/image.rb
@@ -0,0 +1,216 @@
+require 'rss/1.0'
+require 'rss/dublincore'
+
+module RSS
+
+  IMAGE_PREFIX = 'image'
+  IMAGE_URI = 'http://web.resource.org/rss/1.0/modules/image/'
+
+  RDF.install_ns(IMAGE_PREFIX, IMAGE_URI)
+
+  module ImageModelUtils
+    def validate_one_tag_name(name, tags)
+      invalid = tags.find {|tag| tag != name}
+      raise UnknownTagError.new(invalid, IMAGE_URI) if invalid
+      raise TooMuchTagError.new(name, tag_name) if tags.size > 1
+    end
+  end
+  
+  module ImageItemModel
+    include ImageModelUtils
+    extend BaseModel
+
+    def self.append_features(klass)
+      super
+
+      klass.install_have_child_element("#{IMAGE_PREFIX}_item")
+    end
+
+    def image_validate(tags)
+      validate_one_tag_name("item", tags)
+    end
+    
+    class Item < Element
+      include RSS10
+      include DublinCoreModel
+
+      class << self
+        def required_prefix
+          IMAGE_PREFIX
+        end
+        
+        def required_uri
+          IMAGE_URI
+        end
+      end
+      
+      [
+        ["about", ::RSS::RDF::URI, true],
+        ["resource", ::RSS::RDF::URI, false],
+      ].each do |name, uri, required|
+        install_get_attribute(name, uri, required)
+      end
+
+      %w(width height).each do |tag|
+        full_name = "#{IMAGE_PREFIX}_#{tag}"
+        install_text_element(full_name)
+        BaseListener.install_get_text_element(tag, IMAGE_URI, "#{full_name}=")
+      end
+
+      def initialize(about=nil, resource=nil)
+        super()
+        @about = about
+        @resource = resource
+      end
+
+      def full_name
+        tag_name_with_prefix(IMAGE_PREFIX)
+      end
+      
+      def to_s(need_convert=true, indent=calc_indent)
+        rv = tag(indent) do |next_indent|
+          [
+            other_element(false, next_indent),
+          ]
+        end
+        rv = convert(rv) if need_convert
+        rv
+      end
+
+      alias _image_width= image_width=
+      def image_width=(new_value)
+        if @do_validate
+          self._image_width = Integer(new_value)
+        else
+          self._image_width = new_value.to_i
+        end
+      end
+
+      alias _image_height= image_height=
+      def image_height=(new_value)
+        if @do_validate
+          self._image_height = Integer(new_value)
+        else
+          self._image_height = new_value.to_i
+        end
+      end
+
+      alias width= image_width=
+      alias width image_width
+      alias height= image_height=
+      alias height image_height
+
+      private
+      def _tags
+        [
+          [IMAGE_URI, 'width'],
+          [IMAGE_URI, 'height'],
+        ].delete_if do |x|
+          send(x[1]).nil?
+        end
+      end
+        
+      def _attrs
+        [
+          ["#{::RSS::RDF::PREFIX}:about", true, "about"],
+          ["#{::RSS::RDF::PREFIX}:resource", false, "resource"],
+        ]
+      end
+
+      def maker_target(target)
+        target.image_item
+      end
+
+      def setup_maker_attributes(item)
+        item.about = self.about
+        item.resource = self.resource
+      end
+    end
+  end
+  
+  module ImageFaviconModel
+    include ImageModelUtils
+    extend BaseModel
+    
+    def self.append_features(klass)
+      super
+
+      unless klass.class == Module
+        klass.install_have_child_element("#{IMAGE_PREFIX}_favicon")
+      end
+    end
+
+    def image_validate(tags)
+      validate_one_tag_name("favicon", tags)
+    end
+    
+    class Favicon < Element
+      include RSS10
+      include DublinCoreModel
+
+      class << self
+        def required_prefix
+          IMAGE_PREFIX
+        end
+        
+        def required_uri
+          IMAGE_URI
+        end
+      end
+      
+      [
+        ["about", ::RSS::RDF::URI, true],
+        ["size", IMAGE_URI, true],
+      ].each do |name, uri, required|
+        install_get_attribute(name, uri, required)
+      end
+
+      alias image_size= size=
+      alias image_size size
+
+      def initialize(about=nil, size=nil)
+        super()
+        @about = about
+        @size = size
+      end
+
+      def full_name
+        tag_name_with_prefix(IMAGE_PREFIX)
+      end
+      
+      def to_s(need_convert=true, indent=calc_indent)
+        rv = tag(indent) do |next_indent|
+          [
+            other_element(false, next_indent),
+          ]
+        end
+        rv = convert(rv) if need_convert
+        rv
+      end
+
+      private
+      def _attrs
+        [
+          ["#{::RSS::RDF::PREFIX}:about", true, "about"],
+          ["#{IMAGE_PREFIX}:size", true, "size"],
+        ]
+      end
+
+      def maker_target(target)
+        target.image_favicon
+      end
+
+      def setup_maker_attributes(favicon)
+        favicon.about = self.about
+        favicon.size = self.size
+      end
+    end
+
+  end
+
+  class RDF
+    class Channel; include ImageFaviconModel; end
+    class Item; include ImageItemModel; end
+  end
+
+end
diff --git a/lib/rss/maker.rb b/lib/rss/maker.rb
index 66c3bc2928..d248711aa2 100644
--- a/lib/rss/maker.rb
+++ b/lib/rss/maker.rb
@@ -33,3 +33,4 @@ require "rss/maker/content"
 require "rss/maker/dublincore"
 require "rss/maker/syndication"
 require "rss/maker/trackback"
+require "rss/maker/image"
diff --git a/lib/rss/maker/base.rb b/lib/rss/maker/base.rb
index 7faafe8d4e..0b157b1ee2 100644
--- a/lib/rss/maker/base.rb
+++ b/lib/rss/maker/base.rb
@@ -144,7 +144,7 @@ module RSS
           end
 
           def make_#{element}
-            self.class::#{element[0,1].upcase}#{element[1..-1]}.new(self)
+            self.class::#{Utils.to_class_name(element)}.new(self)
           end
 EOC
       end
@@ -255,7 +255,7 @@ EOC
           end
 
           def make_#{element}
-            self.class::#{element[0,1].upcase}#{element[1..-1]}.new(@maker)
+            self.class::#{Utils.to_class_name(element)}.new(@maker)
           end
 EOC
       end
@@ -443,7 +443,7 @@ EOC
           end
 
           def make_#{element}
-            self.class::#{element[0,1].upcase}#{element[1..-1]}.new(@maker)
+            self.class::#{Utils.to_class_name(element)}.new(@maker)
           end
 EOC
         end
diff --git a/lib/rss/maker/dublincore.rb b/lib/rss/maker/dublincore.rb
index a9b8d58715..3eeb269df1 100644
--- a/lib/rss/maker/dublincore.rb
+++ b/lib/rss/maker/dublincore.rb
@@ -7,7 +7,7 @@ module RSS
       def self.append_features(klass)
         super
 
-        ::RSS::DublinCoreModel::ELEMENTS.each do |element|
+        ::RSS::DublinCoreModel::ELEMENTS.uniq.each do |element|
           klass.add_need_initialize_variable(element)
           klass.add_other_element(element)
           klass.__send__(:attr_accessor, element)
diff --git a/lib/rss/maker/image.rb b/lib/rss/maker/image.rb
new file mode 100644
index 0000000000..98d59f733c
--- /dev/null
+++ b/lib/rss/maker/image.rb
@@ -0,0 +1,136 @@
+require 'rss/image'
+require 'rss/maker/1.0'
+require 'rss/maker/dublincore'
+
+module RSS
+  module Maker
+    module ImageItemModel
+      def self.append_features(klass)
+        super
+
+        name = "#{RSS::IMAGE_PREFIX}_item"
+        klass.add_need_initialize_variable(name, "make_#{name}")
+        klass.add_other_element(name)
+        klass.__send__(:attr_reader, name)
+        klass.module_eval(<<-EOC, __FILE__, __LINE__)
+          def setup_#{name}(rss, current)
+            if @#{name}
+              @#{name}.to_rss(rss, current)
+            end
+          end
+
+          def make_#{name}
+            self.class::#{Utils.to_class_name(name)}.new(@maker)
+          end
+EOC
+      end
+
+      class ImageItemBase
+        include Base
+        include Maker::DublinCoreModel
+
+        attr_accessor :about, :resource, :image_width, :image_height
+        add_need_initialize_variable(:about, :resource)
+        add_need_initialize_variable(:image_width, :image_height)
+        alias width= image_width=
+        alias width image_width
+        alias height= image_height=
+        alias height image_height
+
+        def have_required_values?
+          @about
+        end
+      end
+    end
+
+    module ImageFaviconModel
+      def self.append_features(klass)
+        super
+
+        name = "#{RSS::IMAGE_PREFIX}_favicon"
+        klass.add_need_initialize_variable(name, "make_#{name}")
+        klass.add_other_element(name)
+        klass.__send__(:attr_reader, name)
+        klass.module_eval(<<-EOC, __FILE__, __LINE__)
+          def setup_#{name}(rss, current)
+            if @#{name}
+              @#{name}.to_rss(rss, current)
+            end
+          end
+
+          def make_#{name}
+            self.class::#{Utils.to_class_name(name)}.new(@maker)
+          end
+EOC
+      end
+
+      class ImageFaviconBase
+        include Base
+        include Maker::DublinCoreModel
+
+        attr_accessor :about, :image_size
+        add_need_initialize_variable(:about, :image_size)
+        alias size image_size
+        alias size= image_size=
+
+        def have_required_values?
+          @about and @image_size
+        end
+      end
+    end
+
+    class ChannelBase; include Maker::ImageFaviconModel; end
+    
+    class ItemsBase
+      class ItemBase; include Maker::ImageItemModel; end
+    end
+
+    class RSS10
+      class Items
+        class Item
+          class ImageItem < ImageItemBase
+            def to_rss(rss, current)
+              if @about
+                item = ::RSS::ImageItemModel::Item.new(@about, @resource)
+                setup_values(item)
+                current.image_item = item
+              end
+            end
+          end
+        end
+      end
+      
+      class Channel
+        class ImageFavicon < ImageFaviconBase
+          def to_rss(rss, current)
+            if @about and @image_size
+              args = [@about, @image_size]
+              favicon = ::RSS::ImageFaviconModel::Favicon.new(*args)
+              setup_values(favicon)
+              current.image_favicon = favicon
+            end
+          end
+        end
+      end
+    end
+
+    class RSS09
+      class Items
+        class Item
+          class ImageItem < ImageItemBase
+            def to_rss(*args)
+            end
+          end
+        end
+      end
+      
+      class Channel
+        class ImageFavicon < ImageFaviconBase
+          def to_rss(*args)
+          end
+        end
+      end
+    end
+
+  end
+end
diff --git a/lib/rss/rss.rb b/lib/rss/rss.rb
index 7ffb475007..848fbd7b79 100644
--- a/lib/rss/rss.rb
+++ b/lib/rss/rss.rb
@@ -627,12 +627,22 @@ EOC
     
     def setup_maker_element(target)
       self.class.need_initialize_variables.each do |var|
-        setter = "#{var}="
-        if target.respond_to?(setter)
-          target.__send__(setter, __send__(var))
+        value = __send__(var)
+        if value.respond_to?("setup_maker") and
+            !not_need_to_call_setup_maker_variables.include?(var)
+          value.setup_maker(target)
+        else
+          setter = "#{var}="
+          if target.respond_to?(setter)
+            target.__send__(setter, value)
+          end
         end
       end
     end
+
+    def not_need_to_call_setup_maker_variables
+      []
+    end
     
     def setup_maker_elements(parent)
       self.class.have_children_elements.each do |name, plural_name|
diff --git a/lib/rss/utils.rb b/lib/rss/utils.rb
index 1c30ae74bc..19f27183eb 100644
--- a/lib/rss/utils.rb
+++ b/lib/rss/utils.rb
@@ -2,6 +2,13 @@ module RSS
 
   module Utils
 
+    module_function
+    def to_class_name(name)
+      name.split(/_/).collect do |part|
+        "#{part[0, 1].upcase}#{part[1..-1]}"
+      end.join("")
+    end
+    
     def get_file_and_line_from_caller(i=0)
       file, line, = caller[i].split(':')
       [file, line.to_i]