itunes: add support for <itunes:episodeType>

GitHub: fix GH-45

Reported by Tim Uckun. Thanks!!!

Author: kou

lib/rss/itunes.rb

@@ -265,6 +265,7 @@ def append_features(klass)
         ["image", :attribute, "href"],
         ["season", :positive_integer],
         ["episode", :positive_integer],
+        ["episodeType", :itunes_episode_type],
         ["title"],
       ]
 

lib/rss/maker/itunes.rb

@@ -15,8 +15,8 @@ def def_class_accessor(klass, name, type, *args)
           def_yes_other_accessor(klass, full_name)
         when :explicit_clean_other
           def_explicit_clean_other_accessor(klass, full_name)
-        when :itunes_episode
-          def_itunes_episode_accessor(klass, full_name)
+        when :positive_integer, :itunes_episode, :itunes_episode_type
+          klass.def_other_element(full_name)
         when :csv
           def_csv_accessor(klass, full_name)
         when :element, :attribute
@@ -54,10 +54,6 @@ def #{full_name}?
         EOC
       end
 
-      def def_itunes_episode_accessor(klass, full_name)
-        klass.def_other_element(full_name)
-      end
-
       def def_csv_accessor(klass, full_name)
         klass.def_csv_element(full_name)
       end

lib/rss/rss.rb

@@ -589,6 +589,18 @@ def #{name}=(new_value)
       EOC
     end
 
+    def itunes_episode_type_writer(name, disp_name=name)
+      module_eval(<<-DEF, *get_file_and_line_from_caller(2))
+        def #{name}=(new_value)
+          if @do_validate and
+               !["Full", "Trailer", "Bonus", nil].include?(new_value)
+            raise NotAvailableValueError.new('#{disp_name}', new_value)
+          end
+          @#{name} = new_value
+        end
+      DEF
+    end
+
     def def_children_accessor(accessor_name, plural_name)
       module_eval(<<-EOC, *get_file_and_line_from_caller(2))
       def #{plural_name}
@@ -780,6 +792,8 @@ def def_corresponded_attr_writer(name, type=nil, disp_name=nil)
           csv_integer_writer name, disp_name
         when :itunes_episode
           itunes_episode_writer name, disp_name
+        when :itunes_episode_type
+          itunes_episode_type_writer name, disp_name
         else
           attr_writer name
         end

test/test-itunes.rb

@@ -117,6 +117,12 @@ def test_episode
       end
     end
 
+    def test_episodeType
+      assert_itunes_episodeType(%w(items last)) do |content, xmlns|
+         make_rss20(make_channel20(make_item20(content)), xmlns)
+      end
+    end
+
     def test_title
       assert_itunes_title(%w(channel)) do |content, xmlns|
         make_rss20(make_channel20(content), xmlns)
@@ -439,6 +445,23 @@ def assert_itunes_episode(readers, &rss20_maker)
       end
     end
 
+    def set_itunes_episodeType(episode_type, readers, &rss20_maker)
+      content = tag("itunes:episodeType", episode_type)
+      rss20 = itunes_rss20_parse(content, &rss20_maker)
+      target = chain_reader(rss20, readers)
+      target.itunes_episodeType
+    end
+
+    def assert_itunes_episodeType(readers, &rss20_maker)
+      _wrap_assertion do
+        assert_equal("Trailer",
+                     set_itunes_episodeType("Trailer", readers, &rss20_maker))
+        assert_raise(NotAvailableValueError.new("episodeType", "Unknown")) do
+          set_itunes_episodeType("Unknown", readers, &rss20_maker)
+        end
+      end
+    end
+
     def assert_itunes_title(readers, &rss20_maker)
       _wrap_assertion do
         title = "Interview with John Lennon"

test/test-maker-itunes.rb

@@ -60,6 +60,18 @@ def test_summary
       assert_maker_itunes_summary(%w(items last))
     end
 
+    def test_season
+      assert_maker_itunes_season(%w(items last))
+    end
+
+    def test_episode
+      assert_maker_itunes_episode(%w(items last))
+    end
+
+    def test_episodeType
+      assert_maker_itunes_episodeType(%w(items last))
+    end
+
     def test_title
       assert_maker_itunes_title(%w(channel))
       assert_maker_itunes_title(%w(items last))
@@ -508,6 +520,54 @@ def assert_maker_itunes_summary(maker_readers, feed_readers=nil)
       end
     end
 
+    def assert_maker_itunes_season(maker_readers, feed_readers=nil)
+      _wrap_assertion do
+        feed_readers ||= maker_readers
+        season = 1
+        rss20 = ::RSS::Maker.make("rss2.0") do |maker|
+          setup_dummy_channel(maker)
+          setup_dummy_item(maker)
+
+          target = chain_reader(maker, maker_readers)
+          target.itunes_season = season
+        end
+        target = chain_reader(rss20, feed_readers)
+        assert_equal(season, target.itunes_season)
+      end
+    end
+
+    def assert_maker_itunes_episode(maker_readers, feed_readers=nil)
+      _wrap_assertion do
+        feed_readers ||= maker_readers
+        episode = 1
+        rss20 = ::RSS::Maker.make("rss2.0") do |maker|
+          setup_dummy_channel(maker)
+          setup_dummy_item(maker)
+
+          target = chain_reader(maker, maker_readers)
+          target.itunes_episode = episode
+        end
+        target = chain_reader(rss20, feed_readers)
+        assert_equal(episode, target.itunes_episode)
+      end
+    end
+
+    def assert_maker_itunes_episodeType(maker_readers, feed_readers=nil)
+      _wrap_assertion do
+        feed_readers ||= maker_readers
+        episodeType = "Trailer"
+        rss20 = ::RSS::Maker.make("rss2.0") do |maker|
+          setup_dummy_channel(maker)
+          setup_dummy_item(maker)
+
+          target = chain_reader(maker, maker_readers)
+          target.itunes_episodeType = episodeType
+        end
+        target = chain_reader(rss20, feed_readers)
+        assert_equal(episodeType, target.itunes_episodeType)
+      end
+    end
+
     def assert_maker_itunes_title(maker_readers, feed_readers=nil)
       _wrap_assertion do
         feed_readers ||= maker_readers