rss 0.2.9 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 228e90a8417df4ef1a69fe4f26f41df3e8e8058aa8e2ff5e777d046d5ddb80ef
-  data.tar.gz: a2ebe156cafdb3f3f7b6db774d6dda4af3a06050831abd9b56eb6b347c97a4f8
+  metadata.gz: 58f47515ab88a55b8a9167dba145b023e87ef01de35cbe4fa6e2f0872689325a
+  data.tar.gz: a7f2ecc1d5c444d90d62ea7ccdf249c5553cca01e0741c1a3e481d71fbd1afd7
 SHA512:
-  metadata.gz: dd0353495019535ddec0da221dca824b83edee471f93f28ec9046c3239c8fdaed9d5fa16a5942af86065957153ecd643287319b302030be680116f2b96b886d6
-  data.tar.gz: edfbad62f743b1b324b5ff8a2ed695e154684077a7045649e45200f1233768eafa6c9a2e6c9681b964a658279b5dc2f00a1f43b2a9f7487d5def5f2441bf6aa3
+  metadata.gz: f8ae8d5e4ec7ab53fda8fc389b70c36542e3e964fc341e80379c1aa9128bad3cba1d31fb45bb68a8cbf5b40e81204780b7b57124b7fd431540b3bc9989ef133a
+  data.tar.gz: 7c63fda45b9f9c8002b6c7273de075ac01ec086e2e7596dc1f3d9521910dae7259248c52162e21d57f4f07cd0a20779d8a781448a2260a3bbe4e8ffc5c07283d

data/NEWS.md

@@ -1,5 +1,43 @@
 # News
 
+## 0.3.0 - 2023-08-12
+
+### Improvements
+
+  * itunes: Added support for `<itunes:type>`.
+
+    GH-16
+
+    Patch by Luis Alfredo Lorenzo.
+
+  * itunes: Added support for `<itunes:episode>` and `<itunes:season>`.
+
+    GH-31
+
+    Patch by Daniel-Ernest Luff.
+
+  * itunes: Added support for `<itunes:title>`.
+
+    GH-44
+
+    Patch by Ryan Brunner.
+
+  * itunes: Added support for `<itunes:episodeType>`.
+
+    GH-45
+
+    Reported by Tim Uckun.
+
+### Thanks
+
+  * Luis Alfredo Lorenzo
+
+  * Daniel-Ernest Luff
+
+  * Ryan Brunner
+
+  * Tim Uckun
+
 ## 0.2.9 - 2020-02-19
 
 ### Improvements

data/README.md

@@ -1,14 +1,14 @@
 # RSS
 
-Really Simple Syndication (RSS) is a family of formats that describe 'feeds,' specially constructed XML documents that allow an interested person to subscribe and receive updates from a particular web service. This portion of the standard library provides tooling to read and create these feeds.
+Really Simple Syndication (RSS) is a family of formats that describe _feeds_, specially constructed XML documents that allow an interested person to subscribe and receive updates from a particular web service. This portion of the standard library provides tooling to read and create these feeds.
 
 The standard library supports RSS 0.91, 1.0, 2.0, and Atom, a related format. Here are some links to the standards documents for these formats:
 
 * RSS
-  * 0.9.1[http://www.rssboard.org/rss-0-9-1-netscape]
-  * 1.0[http://web.resource.org/rss/1.0/]
-  * 2.0[http://www.rssboard.org/rss-specification]
-* Atom[http://tools.ietf.org/html/rfc4287]
+  * [0.9.1](http://www.rssboard.org/rss-0-9-1-netscape)
+  * [1.0](http://web.resource.org/rss/1.0/)
+  * [2.0](http://www.rssboard.org/rss-specification)
+* [Atom](https://tools.ietf.org/html/rfc4287)
 
 ## Installation
 
@@ -32,12 +32,12 @@ Or install it yourself as:
 
 If you'd like to read someone's RSS feed with your Ruby code, you've come to the right place. It's really easy to do this, but we'll need the help of open-uri:
 
-```
+```ruby
   require 'rss'
   require 'open-uri'
 
-  url = 'http://www.ruby-lang.org/en/feeds/news.rss'
-  open(url) do |rss|
+  url = 'https://www.ruby-lang.org/en/feeds/news.rss'
+  URI.open(url) do |rss|
     feed = RSS::Parser.parse(rss)
     puts "Title: #{feed.channel.title}"
     feed.items.each do |item|
@@ -52,17 +52,17 @@ As you can see, the workhorse is RSS::Parser#parse, which takes the source of th
 
 Producing our own RSS feeds is easy as well. Let's make a very basic feed:
 
-```
+```ruby
   require "rss"
 
   rss = RSS::Maker.make("atom") do |maker|
     maker.channel.author = "matz"
     maker.channel.updated = Time.now.to_s
-    maker.channel.about = "http://www.ruby-lang.org/en/feeds/news.rss"
+    maker.channel.about = "https://www.ruby-lang.org/en/feeds/news.rss"
     maker.channel.title = "Example Feed"
 
     maker.items.new_item do |item|
-      item.link = "http://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
+      item.link = "https://www.ruby-lang.org/en/news/2010/12/25/ruby-1-9-2-p136-is-released/"
       item.title = "Ruby 1.9.2-p136 is released"
       item.updated = Time.now.to_s
     end

data/lib/rss/itunes.rb

@@ -80,6 +80,8 @@ module RSS
                      ["image", :attribute, "href"],
                      ["owner", :element],
                      ["new-feed-url"],
+                     ["type", :itunes_episode],
+                     ["title"],
                     ] + ITunesBaseModel::ELEMENT_INFOS
 
     class ITunesCategory < Element
@@ -258,7 +260,14 @@ module RSS
     end
 
     ELEMENT_INFOS = ITunesBaseModel::ELEMENT_INFOS +
-      [["duration", :element, "content"], ["image", :attribute, "href"]]
+      [
+        ["duration", :element, "content"],
+        ["image", :attribute, "href"],
+        ["season", :positive_integer],
+        ["episode", :positive_integer],
+        ["episodeType", :itunes_episode_type],
+        ["title"],
+      ]
 
     class ITunesImage < Element
       include RSS09

data/lib/rss/maker/itunes.rb

@@ -15,6 +15,8 @@ module RSS
           def_yes_other_accessor(klass, full_name)
         when :explicit_clean_other
           def_explicit_clean_other_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

data/lib/rss/rss.rb

@@ -1,4 +1,7 @@
 # frozen_string_literal: false
+
+require "English"
+require "cgi/util"
 require "time"
 
 class Time
@@ -61,8 +64,6 @@ class Time
   end
 end
 
-
-require "English"
 require_relative "utils"
 require_relative "converter"
 require_relative "xml-stylesheet"
@@ -260,7 +261,7 @@ EOC
         end
         if content
           rv = "\#{indent}<#{elem_name}>"
-          value = html_escape(content)
+          value = CGI.escapeHTML(content.to_s)
           if need_convert
             rv << convert(value)
           else
@@ -291,7 +292,7 @@ EOC
         <<-EOC
         if @#{n}
           rv = "\#{indent}<#{elem_name}>"
-          value = html_escape(@#{n}.#{type})
+          value = CGI.escapeHTML(@#{n}.#{type}.to_s)
           if need_convert
             rv << convert(value)
           else
@@ -375,7 +376,7 @@ EOC
         module_eval(<<-EOC, __FILE__, __LINE__ + 1)
           attr_reader(:#{attr})
           def #{attr}?
-            ExplicitCleanOther.parse(@#{attr})
+            Utils::ExplicitCleanOther.parse(@#{attr})
           end
         EOC
       end
@@ -541,7 +542,7 @@ EOC
     end
 
     def explicit_clean_other_writer(name, disp_name=name)
-      module_eval(<<-EOC, __FILE__, __LINE__ + 1)
+      module_eval(<<-EOC, *get_file_and_line_from_caller(2))
         def #{name}=(value)
           value = (value ? "yes" : "no") if [true, false].include?(value)
           @#{name} = value
@@ -550,7 +551,7 @@ EOC
     end
 
     def yes_other_writer(name, disp_name=name)
-      module_eval(<<-EOC, __FILE__, __LINE__ + 1)
+      module_eval(<<-EOC, *get_file_and_line_from_caller(2))
         def #{name}=(new_value)
           if [true, false].include?(new_value)
             new_value = new_value ? "yes" : "no"
@@ -561,7 +562,7 @@ EOC
     end
 
     def csv_writer(name, disp_name=name)
-      module_eval(<<-EOC, __FILE__, __LINE__ + 1)
+      module_eval(<<-EOC, *get_file_and_line_from_caller(2))
         def #{name}=(new_value)
           @#{name} = Utils::CSV.parse(new_value)
         end
@@ -569,13 +570,37 @@ EOC
     end
 
     def csv_integer_writer(name, disp_name=name)
-      module_eval(<<-EOC, __FILE__, __LINE__ + 1)
+      module_eval(<<-EOC, *get_file_and_line_from_caller(2))
         def #{name}=(new_value)
           @#{name} = Utils::CSV.parse(new_value) {|v| Integer(v)}
         end
       EOC
     end
 
+    def itunes_episode_writer(name, disp_name=name)
+      module_eval(<<-EOC, *get_file_and_line_from_caller(2))
+        def #{name}=(new_value)
+          if @do_validate and
+               !["episodic", "serial", nil].include?(new_value)
+            raise NotAvailableValueError.new('#{disp_name}', new_value)
+          end
+          @#{name} = new_value
+        end
+      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}
@@ -659,7 +684,6 @@ EOC
 
   class Element
     extend BaseModel
-    include Utils
     extend Utils::InheritedReader
     include SetupMaker
 
@@ -736,7 +760,7 @@ EOC
         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
+        if type == :boolean and /\Ais/ =~ name
           alias_method "#{$POSTMATCH}?", name
         end
         self::GET_ATTRIBUTES << [name, uri, required, element_name]
@@ -763,9 +787,13 @@ EOC
         when :yes_other
           yes_other_writer name, disp_name
         when :csv
-          csv_writer name
+          csv_writer name, disp_name
         when :csv_integer
-          csv_integer_writer name
+          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
@@ -1023,7 +1051,7 @@ EOC
       start_tag = ["#{indent}<#{full_name}"]
       unless attrs.empty?
         start_tag << attrs.collect do |key, value|
-          %Q[#{h key}="#{h value}"]
+          %Q[#{CGI.escapeHTML(key.to_s)}="#{CGI.escapeHTML(value.to_s)}"]
         end.join("\n#{next_indent}")
       end
       start_tag.join(" ")
@@ -1231,7 +1259,7 @@ EOC
       else
         _content = content
         _content = [_content].pack("m0") if need_base64_encode?
-        h(_content)
+        CGI.escapeHTML(_content.to_s)
       end
     end
   end

data/lib/rss/utils.rb

@@ -87,24 +87,6 @@ module RSS
       [file, line]
     end
 
-    # Takes a string +s+ with some HTML in it, and escapes '&', '"', '<' and '>', by
-    # replacing them with the appropriate entities.
-    #
-    # This method is also aliased to h, for convenience.
-    #
-    # Examples:
-    #
-    #   require 'rss/utils'
-    #
-    #   RSS::Utils.html_escape("Dungeons & Dragons")
-    #   # => "Dungeons &amp; Dragons"
-    #   RSS::Utils.h(">_>")
-    #   # => "&gt;_&gt;"
-    def html_escape(s)
-      s.to_s.gsub(/&/, "&amp;").gsub(/\"/, "&quot;").gsub(/>/, "&gt;").gsub(/</, "&lt;")
-    end
-    alias h html_escape
-
     # If +value+ is an instance of class +klass+, return it, else
     # create a new instance of +klass+ with value +value+.
     def new_with_value_if_need(klass, value)

data/lib/rss/version.rb

@@ -1,4 +1,4 @@
 module RSS
   # The current version of RSS
-  VERSION = "0.2.9"
+  VERSION = "0.3.0"
 end

data/lib/rss/xml-stylesheet.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
-require_relative "utils"
+
+require "cgi/util"
 
 module RSS
 
@@ -24,8 +25,6 @@ module RSS
 
   class XMLStyleSheet
 
-    include Utils
-
     ATTRIBUTES = %w(href type title media charset alternate)
 
     GUESS_TABLE = {
@@ -59,7 +58,7 @@ module RSS
         rv << %Q[<?xml-stylesheet]
         ATTRIBUTES.each do |name|
           if __send__(name)
-            rv << %Q[ #{name}="#{h __send__(name)}"]
+            rv << %Q[ #{name}="#{CGI.escapeHTML(__send__(name).to_s)}"]
           end
         end
         rv << %Q[?>]

data/lib/rss/xml.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: false
-require_relative "utils"
+
+require "cgi/util"
 
 module RSS
   module XML
@@ -46,7 +47,7 @@ module RSS
       def to_s
         rv = "<#{full_name}"
         attributes.each do |key, value|
-          rv << " #{Utils.html_escape(key)}=\"#{Utils.html_escape(value)}\""
+          rv << " #{CGI.escapeHTML(key.to_s)}=\"#{CGI.escapeHTML(value.to_s)}\""
         end
         if children.empty?
           rv << "/>"

data/lib/rss.rb

@@ -79,16 +79,16 @@ end
 
 require "rss/version"
 
-require 'rss/1.0'
-require 'rss/2.0'
-require 'rss/atom'
-require 'rss/content'
-require 'rss/dublincore'
-require 'rss/image'
-require 'rss/itunes'
-require 'rss/slash'
-require 'rss/syndication'
-require 'rss/taxonomy'
-require 'rss/trackback'
+require "rss/1.0"
+require "rss/2.0"
+require "rss/atom"
+require "rss/content"
+require "rss/dublincore"
+require "rss/image"
+require "rss/itunes"
+require "rss/slash"
+require "rss/syndication"
+require "rss/taxonomy"
+require "rss/trackback"
 
 require "rss/maker"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rss
 version: !ruby/object:Gem::Version
-  version: 0.2.9
+  version: 0.3.0
 platform: ruby
 authors:
 - Kouhei Sutou
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-02-18 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -73,11 +73,9 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- Gemfile
 - LICENSE.txt
 - NEWS.md
 - README.md
-- Rakefile
 - lib/rss.rb
 - lib/rss/0.9.rb
 - lib/rss/1.0.rb
@@ -122,57 +120,11 @@ files:
 - lib/rss/xml.rb
 - lib/rss/xmlparser.rb
 - lib/rss/xmlscanner.rb
-- rss.gemspec
-- test/dot.png
-- test/rss-assertions.rb
-- test/rss-testcase.rb
-- test/run-test.rb
-- test/test_1.0.rb
-- test/test_2.0.rb
-- test/test_accessor.rb
-- test/test_atom.rb
-- test/test_content.rb
-- test/test_dublincore.rb
-- test/test_image.rb
-- test/test_inherit.rb
-- test/test_itunes.rb
-- test/test_maker_0.9.rb
-- test/test_maker_1.0.rb
-- test/test_maker_2.0.rb
-- test/test_maker_atom_entry.rb
-- test/test_maker_atom_feed.rb
-- test/test_maker_content.rb
-- test/test_maker_dc.rb
-- test/test_maker_image.rb
-- test/test_maker_itunes.rb
-- test/test_maker_slash.rb
-- test/test_maker_sy.rb
-- test/test_maker_taxo.rb
-- test/test_maker_trackback.rb
-- test/test_maker_xml-stylesheet.rb
-- test/test_parser.rb
-- test/test_parser_1.0.rb
-- test/test_parser_2.0.rb
-- test/test_parser_atom_entry.rb
-- test/test_parser_atom_feed.rb
-- test/test_setup_maker_0.9.rb
-- test/test_setup_maker_1.0.rb
-- test/test_setup_maker_2.0.rb
-- test/test_setup_maker_atom_entry.rb
-- test/test_setup_maker_atom_feed.rb
-- test/test_setup_maker_itunes.rb
-- test/test_setup_maker_slash.rb
-- test/test_slash.rb
-- test/test_syndication.rb
-- test/test_taxonomy.rb
-- test/test_to_s.rb
-- test/test_trackback.rb
-- test/test_xml-stylesheet.rb
 homepage: https://github.com/ruby/rss
 licenses:
 - BSD-2-Clause
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -187,54 +139,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6.2
-signing_key: 
+rubygems_version: 3.5.0.dev
+signing_key:
 specification_version: 4
 summary: Family of libraries that support various formats of XML "feeds".
-test_files:
-- test/test_maker_2.0.rb
-- test/test_dublincore.rb
-- test/test_setup_maker_slash.rb
-- test/test_parser.rb
-- test/test_maker_xml-stylesheet.rb
-- test/test_maker_0.9.rb
-- test/test_setup_maker_atom_feed.rb
-- test/test_maker_image.rb
-- test/test_parser_atom_entry.rb
-- test/test_maker_taxo.rb
-- test/run-test.rb
-- test/test_itunes.rb
-- test/test_maker_content.rb
-- test/test_maker_dc.rb
-- test/test_inherit.rb
-- test/dot.png
-- test/test_maker_atom_entry.rb
-- test/test_setup_maker_2.0.rb
-- test/test_to_s.rb
-- test/test_setup_maker_itunes.rb
-- test/rss-assertions.rb
-- test/test_xml-stylesheet.rb
-- test/test_1.0.rb
-- test/test_accessor.rb
-- test/test_taxonomy.rb
-- test/test_maker_trackback.rb
-- test/rss-testcase.rb
-- test/test_slash.rb
-- test/test_setup_maker_atom_entry.rb
-- test/test_syndication.rb
-- test/test_maker_1.0.rb
-- test/test_parser_atom_feed.rb
-- test/test_maker_itunes.rb
-- test/test_image.rb
-- test/test_setup_maker_1.0.rb
-- test/test_atom.rb
-- test/test_maker_slash.rb
-- test/test_parser_1.0.rb
-- test/test_setup_maker_0.9.rb
-- test/test_2.0.rb
-- test/test_trackback.rb
-- test/test_content.rb
-- test/test_maker_sy.rb
-- test/test_parser_2.0.rb
-- test/test_maker_atom_feed.rb
+test_files: []

data/Gemfile

@@ -1,6 +0,0 @@
-source "https://rubygems.org"
-
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
-
-# Specify your gem's dependencies in rss.gemspec
-gemspec

data/Rakefile

@@ -1,15 +0,0 @@
-require "bundler/gem_tasks"
-
-helper = Bundler::GemHelper.new(__dir__)
-def helper.version_tag
-  version
-end
-
-helper.install
-
-desc "Run test"
-task :test do
-  ruby("test/run-test.rb")
-end
-
-task :default => :test

data/rss.gemspec

@@ -1,30 +0,0 @@
-require_relative "lib/rss/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "rss"
-  spec.version       = RSS::VERSION
-  spec.authors       = ["Kouhei Sutou"]
-  spec.email         = ["kou@cozmixng.org"]
-
-  spec.summary       = %q{Family of libraries that support various formats of XML "feeds".}
-  spec.description   = %q{Family of libraries that support various formats of XML "feeds".}
-  spec.homepage      = "https://github.com/ruby/rss"
-  spec.license       = "BSD-2-Clause"
-
-  spec.files = [
-    "#{spec.name}.gemspec",
-    "Gemfile",
-    "LICENSE.txt",
-    "NEWS.md",
-    "README.md",
-    "Rakefile",
-  ]
-  spec.files += Dir.glob("lib/**/*.rb")
-  spec.test_files += Dir.glob("test/**/*")
-  spec.require_paths = ["lib"]
-
-  spec.add_dependency "rexml"
-  spec.add_development_dependency "bundler"
-  spec.add_development_dependency "rake"
-  spec.add_development_dependency "test-unit"
-end