feedjira 3.2.2 → 3.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5169a51338551c1253b148e944e9b63cff818f85ba5eeafd2c3239ea007b5012
-  data.tar.gz: c9966b308d0f57873c56b474cdbdc7a1a96ee6dd64d5a0ca56f30c333ada9298
+  metadata.gz: ca73bd8dd61cf4dde35246f10e5632830da4ea5a996b61767455ed4f62e7b4af
+  data.tar.gz: a8707013a54705e161e3e1968bd99ed0125d87812928c45b331064af2d615514
 SHA512:
-  metadata.gz: ad3fc7290af22ec75dbba64b2397ad3e8e6f283f73c3c793eaf9b33d28410dcaa6439618c47d741858a732df7478cbcb21f987314880ef5acd108224cc6fa7a2
-  data.tar.gz: 20422cf9fdf53491356726c29b118ce6e1b3b37c0ef7294f1c01bcaf00df72097ae6afd1a88191ca765217fe7a159996247de4837a14a1716d33ad8024f7f784
+  metadata.gz: ce8991276f54810f067e930095558d640d885f242beb0030e7d8eec33f4fd64fdd786886514fb0711adfecb022f8ee47c429c77d03e52f7e72b721dbc7381359
+  data.tar.gz: fb6c3596fd55cd2ac817881597f43f0ae98f1eb064a5513f573bc4dd03082877d4b48898c7798b5725ccc546f336155cce5df6cbc788515ca7cdc5630df936a5

data/.github/dependabot.yml

@@ -0,0 +1,17 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "bundler" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    assignees:
+      - "mockdeep"
+    groups:
+      all:
+        patterns:
+          - "*"

data/.github/workflows/ruby.yml

@@ -3,7 +3,7 @@ name: Ruby
 on:
   push:
     branches:
-      - master
+      - main
   pull_request:
 
 jobs:
@@ -12,7 +12,7 @@ jobs:
       fail-fast: false
       matrix:
         os: [ubuntu]
-        ruby: [2.7, 3.0, 3.1]
+        ruby: [2.7, 3.0, 3.1, 3.2, 3.3]
         handler: [nokogiri, ox, oga]
         exclude:
           - { ruby: jruby, handler: ox }

data/.gitignore

@@ -7,3 +7,4 @@ doc/
 .yardoc/
 pkg/
 rdoc/
+coverage/

data/.rubocop.yml

@@ -29,9 +29,6 @@ Layout/LineLength:
   Exclude:
     - 'spec/**/*.rb'
 
-Style/AsciiComments:
-  Enabled: false
-
 Style/IfUnlessModifier:
   Enabled: false
 
@@ -59,8 +56,5 @@ RSpec/MultipleMemoizedHelpers:
 RSpec/BeforeAfterAll:
   Enabled: false
 
-RSpec/VerifiedDoubles:
-  Enabled: false
-
 RSpec/RepeatedExample:
   Enabled: false

data/.rubocop_todo.yml

@@ -1,11 +1,41 @@
 # This configuration was generated by
-# `rubocop --auto-gen-config`
-# on 2020-09-02 20:02:06 UTC using RuboCop version 0.90.0.
+# `rubocop --auto-gen-config --auto-gen-only-exclude --exclude-limit 400`
+# on 2024-05-27 16:41:59 UTC using RuboCop version 1.64.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 20
+# Offense count: 16
+# Configuration parameters: AllowedConstants.
 Style/Documentation:
-  Enabled: false
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/feedjira/atom_entry_utilities.rb'
+    - 'lib/feedjira/core_ext/string.rb'
+    - 'lib/feedjira/core_ext/time.rb'
+    - 'lib/feedjira/feed.rb'
+    - 'lib/feedjira/feed_entry_utilities.rb'
+    - 'lib/feedjira/feed_utilities.rb'
+    - 'lib/feedjira/parser.rb'
+    - 'lib/feedjira/parser/atom_youtube_entry.rb'
+    - 'lib/feedjira/parser/globally_unique_identifier.rb'
+    - 'lib/feedjira/parser/google_docs_atom.rb'
+    - 'lib/feedjira/parser/google_docs_atom_entry.rb'
+    - 'lib/feedjira/parser/itunes_rss_owner.rb'
+    - 'lib/feedjira/parser/podlove_chapter.rb'
+    - 'lib/feedjira/preprocessor.rb'
+    - 'lib/feedjira/rss_entry_utilities.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperArguments:
+  Exclude:
+    - 'lib/feedjira/feed_utilities.rb'
+
+# Offense count: 1
+# This cop supports safe autocorrection (--autocorrect).
+Style/SuperWithArgsParentheses:
+  Exclude:
+    - 'lib/feedjira/feed_utilities.rb'

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Feedjira Changelog
 
+## 3.2.4
+
+* Increasing slice limit regarding able_to_parse? (#514)
+* Enable parsing of JSON feeds with escaped version URL (#515)
+
+## 3.2.3
+
+* Switch date parse error to debug (#492)
+
 ## 3.2.2
 
 * Fix time handling again usec is not a timezone

data/Gemfile

@@ -4,8 +4,18 @@ source "https://rubygems.org/"
 
 gemspec
 
+gem "faraday", "~> 2.8.1"
+gem "pry", "~> 0.15.0"
+gem "rspec", "~> 3.13.0"
+gem "rubocop", "~> 1.69.0"
+gem "rubocop-performance", "~> 1.23.0"
+gem "rubocop-rake", "~> 0.6.0"
+gem "rubocop-rspec", "~> 3.3.0"
+gem "simplecov", "~> 0.22.0"
+gem "yard", "~> 0.9.34"
+
 group :test do
-  gem "oga"
-  gem "ox", platforms: %i[mri rbx]
-  gem "rake"
+  gem "oga", "~> 3.4"
+  gem "ox", "~> 2.14.17", platforms: %i[mri rbx]
+  gem "rake", "~> 13.2.1"
 end

data/README.md

@@ -1,9 +1,9 @@
 # Feedjira
 
-[![Build Status][travis-badge]][travis] [![Code Climate][code-climate-badge]][code-climate]
+[![Build Status][actions-badge]][actions] [![Code Climate][code-climate-badge]][code-climate]
 
-[travis-badge]: https://travis-ci.org/feedjira/feedjira.svg?branch=master
-[travis]: http://travis-ci.org/feedjira/feedjira
+[actions-badge]: https://github.com/feedjira/feedjira/actions/workflows/ruby.yml/badge.svg?branch=main
+[actions]: https://github.com/feedjira/feedjira/actions?query=branch%3Amain
 [code-climate-badge]: https://codeclimate.com/github/feedjira/feedjira/badges/gpa.svg
 [code-climate]: https://codeclimate.com/github/feedjira/feedjira
 [gitter-badge]: https://badges.gitter.im/feedjira/feedjira.svg

data/Rakefile

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require "rubocop/rake_task"
 require "yard"

data/feedjira.gemspec

@@ -22,7 +22,7 @@ Gem::Specification.new do |s|
   s.metadata = {
     "homepage_uri" => "https://github.com/feedjira/feedjira",
     "source_code_uri" => "https://github.com/feedjira/feedjira",
-    "changelog_uri" => "https://github.com/feedjira/feedjira/blob/master/CHANGELOG.md",
+    "changelog_uri" => "https://github.com/feedjira/feedjira/blob/main/CHANGELOG.md",
     "rubygems_mfa_required" => "true"
   }
 
@@ -31,15 +31,6 @@ Gem::Specification.new do |s|
 
   s.required_ruby_version = ">=2.7"
 
-  s.add_dependency "loofah",             ">= 2.3.1"
-  s.add_dependency "sax-machine",        ">= 1.0"
-
-  s.add_development_dependency "faraday"
-  s.add_development_dependency "pry"
-  s.add_development_dependency "rspec"
-  s.add_development_dependency "rubocop"
-  s.add_development_dependency "rubocop-performance"
-  s.add_development_dependency "rubocop-rake"
-  s.add_development_dependency "rubocop-rspec"
-  s.add_development_dependency "yard"
+  s.add_dependency "loofah", ">= 2.3.1", "< 3"
+  s.add_dependency "sax-machine", ">= 1.0", "< 2"
 end

data/lib/feedjira/configuration.rb

@@ -59,13 +59,13 @@ module Feedjira
     # @private
     def default_parsers
       [
+        Feedjira::Parser::ITunesRSS,
         Feedjira::Parser::RSSFeedBurner,
         Feedjira::Parser::GoogleDocsAtom,
         Feedjira::Parser::AtomYoutube,
         Feedjira::Parser::AtomFeedBurner,
         Feedjira::Parser::AtomGoogleAlerts,
         Feedjira::Parser::Atom,
-        Feedjira::Parser::ITunesRSS,
         Feedjira::Parser::RSS,
         Feedjira::Parser::JSONFeed
       ]

data/lib/feedjira/core_ext/date.rb

@@ -9,10 +9,6 @@ class Date
     feed_utils_to_time(new_offset, :gm)
   end
 
-  def feed_utils_to_local_time
-    feed_utils_to_time(new_offset(DateTime.now.offset - offset), :local)
-  end
-
   private
 
   def feed_utils_to_time(dest, method)

data/lib/feedjira/core_ext/time.rb

@@ -16,12 +16,12 @@ class Time
     if datetime.is_a?(Time)
       datetime.utc
     elsif datetime.respond_to?(:to_datetime)
-      datetime.to_datetime.utc
-    elsif datetime.respond_to? :to_s
+      datetime.to_time.utc
+    else
       parse_string_safely datetime.to_s
     end
   rescue StandardError => e
-    Feedjira.logger.debug { "Failed to parse time #{datetime}" }
+    Feedjira.logger.debug("Failed to parse time #{datetime}")
     Feedjira.logger.debug(e)
     nil
   end

data/lib/feedjira/core_ext.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
-require "feedjira/core_ext/time"
-require "feedjira/core_ext/date"
-require "feedjira/core_ext/string"
+require_relative "core_ext/time"
+require_relative "core_ext/date"
+require_relative "core_ext/string"

data/lib/feedjira/feed_entry_utilities.rb

@@ -3,7 +3,6 @@
 module Feedjira
   module FeedEntryUtilities
     include Enumerable
-    include DateTimeUtilities
 
     def published
       @published ||= @updated
@@ -12,8 +11,8 @@ module Feedjira
     def parse_datetime(string)
       DateTime.parse(string).feed_utils_to_gm_time
     rescue StandardError => e
-      Feedjira.logger.warn { "Failed to parse date #{string.inspect}" }
-      Feedjira.logger.warn(e)
+      Feedjira.logger.debug("Failed to parse date #{string.inspect}")
+      Feedjira.logger.debug(e)
       nil
     end
 
@@ -64,11 +63,11 @@ module Feedjira
     end
 
     def [](field)
-      instance_variable_get("@#{field}")
+      instance_variable_get(:"@#{field}")
     end
 
     def []=(field, value)
-      instance_variable_set("@#{field}", value)
+      instance_variable_set(:"@#{field}", value)
     end
   end
 end

data/lib/feedjira/feed_utilities.rb

@@ -41,11 +41,7 @@ module Feedjira
     end
 
     def last_modified
-      @last_modified ||= begin
-        published = entries.reject { |e| e.published.nil? }
-        entry = published.max_by(&:published)
-        entry ? entry.published : nil
-      end
+      @last_modified ||= entries.reject { |e| e.published.nil? }.max_by(&:published)&.published
     end
 
     def updated?
@@ -78,7 +74,7 @@ module Feedjira
       if old_value == new_value
         false
       else
-        send("#{name}=", new_value)
+        send(:"#{name}=", new_value)
         true
       end
     end
@@ -95,7 +91,7 @@ module Feedjira
     # entries just parsed and insert each one as a new entry until we get to
     # one that has the same id as the the newest for the feed.
     def find_new_entries_for(feed)
-      return feed.entries if entries.length.zero?
+      return feed.entries if entries.empty?
 
       latest_entry = entries.first
       found_new_entries = []

data/lib/feedjira/parser/json_feed.rb

@@ -8,15 +8,16 @@ module Feedjira
       include FeedUtilities
 
       def self.able_to_parse?(json)
-        %r{https://jsonfeed.org/version/} =~ json
+        json.include?("https://jsonfeed.org/version/") ||
+          json.include?('https:\/\/jsonfeed.org\/version\/')
       end
 
       def self.parse(json)
         new(JSON.parse(json))
       end
 
-      attr_reader :json, :version, :title, :url, :feed_url, :description,
-                  :expired, :entries
+      attr_reader :json, :version, :title, :description, :url, :feed_url, :icon, :favicon,
+                  :language, :expired, :entries
 
       def initialize(json)
         @json = json
@@ -24,7 +25,10 @@ module Feedjira
         @title = json.fetch("title")
         @url = json.fetch("home_page_url", nil)
         @feed_url = json.fetch("feed_url", nil)
+        @icon = json.fetch("icon", nil)
+        @favicon = json.fetch("favicon", nil)
         @description = json.fetch("description", nil)
+        @language = json.fetch("language", nil)
         @expired = json.fetch("expired", nil)
         @entries = parse_items(json["items"])
       end

data/lib/feedjira/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Feedjira
-  VERSION = "3.2.2"
+  VERSION = "3.2.4"
 end

data/lib/feedjira.rb

@@ -6,44 +6,40 @@ require "loofah"
 require "logger"
 require "json"
 
-require "feedjira/core_ext"
-require "feedjira/configuration"
-require "feedjira/date_time_utilities/date_time_epoch_parser"
-require "feedjira/date_time_utilities/date_time_language_parser"
-require "feedjira/date_time_utilities/date_time_pattern_parser"
-require "feedjira/date_time_utilities"
-require "feedjira/feed_entry_utilities"
-require "feedjira/feed_utilities"
-require "feedjira/feed"
-require "feedjira/rss_entry_utilities"
-require "feedjira/atom_entry_utilities"
-require "feedjira/parser"
-require "feedjira/parser/globally_unique_identifier"
-require "feedjira/parser/rss_entry"
-require "feedjira/parser/rss_image"
-require "feedjira/parser/rss"
-require "feedjira/parser/atom_entry"
-require "feedjira/parser/atom"
-require "feedjira/preprocessor"
-require "feedjira/version"
+require_relative "feedjira/core_ext"
+require_relative "feedjira/configuration"
+require_relative "feedjira/feed_entry_utilities"
+require_relative "feedjira/feed_utilities"
+require_relative "feedjira/feed"
+require_relative "feedjira/rss_entry_utilities"
+require_relative "feedjira/atom_entry_utilities"
+require_relative "feedjira/parser"
+require_relative "feedjira/parser/globally_unique_identifier"
+require_relative "feedjira/parser/rss_entry"
+require_relative "feedjira/parser/rss_image"
+require_relative "feedjira/parser/rss"
+require_relative "feedjira/parser/atom_entry"
+require_relative "feedjira/parser/atom"
+require_relative "feedjira/preprocessor"
+require_relative "feedjira/version"
 
-require "feedjira/parser/rss_feed_burner_entry"
-require "feedjira/parser/rss_feed_burner"
-require "feedjira/parser/podlove_chapter"
-require "feedjira/parser/itunes_rss_owner"
-require "feedjira/parser/itunes_rss_category"
-require "feedjira/parser/itunes_rss_item"
-require "feedjira/parser/itunes_rss"
-require "feedjira/parser/atom_feed_burner_entry"
-require "feedjira/parser/atom_feed_burner"
-require "feedjira/parser/atom_google_alerts_entry"
-require "feedjira/parser/atom_google_alerts"
-require "feedjira/parser/google_docs_atom_entry"
-require "feedjira/parser/google_docs_atom"
-require "feedjira/parser/atom_youtube_entry"
-require "feedjira/parser/atom_youtube"
-require "feedjira/parser/json_feed"
-require "feedjira/parser/json_feed_item"
+require_relative "feedjira/parser/rss_feed_burner_entry"
+require_relative "feedjira/parser/rss_feed_burner"
+require_relative "feedjira/parser/podlove_chapter"
+require_relative "feedjira/parser/itunes_rss_owner"
+require_relative "feedjira/parser/itunes_rss_category"
+require_relative "feedjira/parser/itunes_rss_item"
+require_relative "feedjira/parser/itunes_rss"
+require_relative "feedjira/parser/atom_feed_burner_entry"
+require_relative "feedjira/parser/atom_feed_burner"
+require_relative "feedjira/parser/atom_google_alerts_entry"
+require_relative "feedjira/parser/atom_google_alerts"
+require_relative "feedjira/parser/google_docs_atom_entry"
+require_relative "feedjira/parser/google_docs_atom"
+require_relative "feedjira/parser/atom_youtube_entry"
+require_relative "feedjira/parser/atom_youtube"
+require_relative "feedjira/parser/json_feed"
+require_relative "feedjira/parser/json_feed_item"
 
 # Feedjira
 module Feedjira
@@ -74,7 +70,7 @@ module Feedjira
   #   parser = Feedjira.parser_for_xml(xml)
   #   parser.parse(xml)
   def parser_for_xml(xml)
-    start_of_doc = xml.slice(0, 2000)
+    start_of_doc = xml.slice(0, 4000)
     Feedjira.parsers.detect { |klass| klass.able_to_parse?(start_of_doc) }
   end
   module_function :parser_for_xml

data/spec/feedjira/core_ext/time_spec.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+RSpec.describe Time do
+  describe "#parse_safely" do
+    it "returns the datetime in utc when given a Time" do
+      time = described_class.now
+
+      expect(described_class.parse_safely(time)).to eq(time.utc)
+    end
+
+    it "returns the datetime in utc when given a Date" do
+      date = Date.today
+
+      expect(described_class.parse_safely(date)).to eq(date.to_time.utc)
+    end
+
+    it "returns the datetime in utc when given a String" do
+      timestamp = "2016-01-01 00:00:00"
+
+      expect(described_class.parse_safely(timestamp)).to eq(described_class.parse(timestamp).utc)
+    end
+
+    it "returns nil when given an empty String" do
+      timestamp = ""
+
+      expect(described_class.parse_safely(timestamp)).to be_nil
+    end
+
+    it "returns the the datetime in utc given a 14-digit time" do
+      time = described_class.now.utc
+      timestamp = time.strftime("%Y%m%d%H%M%S")
+
+      expect(described_class.parse_safely(timestamp)).to eq(time.floor)
+    end
+
+    context "when given an invalid time string" do
+      it "returns nil" do
+        timestamp = "2016-51-51 00:00:00"
+
+        expect(described_class.parse_safely(timestamp)).to be_nil
+      end
+
+      it "logs an error" do
+        timestamp = "2016-51-51 00:00:00"
+
+        expect(Feedjira.logger)
+          .to receive(:debug).with("Failed to parse time #{timestamp}")
+        expect(Feedjira.logger)
+          .to receive(:debug).with(an_instance_of(ArgumentError))
+
+        described_class.parse_safely(timestamp)
+      end
+    end
+  end
+end

data/spec/feedjira/feed_spec.rb

@@ -2,17 +2,8 @@
 
 require "spec_helper"
 
-class Hell < StandardError; end
-
-class FailParser
-  def self.parse(_xml)
-    yield "this parser always fails."
-    # on_failure.call
-  end
-end
-
 describe Feedjira::Feed do
-  describe "#add_common_feed_element" do
+  describe ".add_common_feed_element" do
     before(:all) do
       described_class.add_common_feed_element("generator")
     end
@@ -30,7 +21,25 @@ describe Feedjira::Feed do
     end
   end
 
-  describe "#add_common_feed_entry_element" do
+  describe ".add_common_feed_elements" do
+    before do
+      described_class.add_common_feed_elements(:foos)
+    end
+
+    it "parses the added element out of Atom feeds" do
+      expect(Feedjira.parse(sample_wfw_feed).foos).to eq []
+    end
+
+    it "parses the added element out of Atom Feedburner feeds" do
+      expect(Feedjira::Parser::Atom.new).to respond_to(:foos)
+    end
+
+    it "parses the added element out of RSS feeds" do
+      expect(Feedjira::Parser::RSS.new).to respond_to(:foos)
+    end
+  end
+
+  describe ".add_common_feed_entry_element" do
     before(:all) do
       tag = "wfw:commentRss"
       described_class.add_common_feed_entry_element tag, as: :comment_rss
@@ -49,4 +58,23 @@ describe Feedjira::Feed do
       expect(Feedjira::Parser::RSSEntry.new).to respond_to(:comment_rss)
     end
   end
+
+  describe ".add_common_feed_entry_elements" do
+    before do
+      described_class.add_common_feed_entry_elements(:things)
+    end
+
+    it "parses the added element out of Atom feeds entries" do
+      entry = Feedjira.parse(sample_wfw_feed).entries.first
+      expect(entry.things).to eq []
+    end
+
+    it "parses the added element out of Atom Feedburner feeds entries" do
+      expect(Feedjira::Parser::AtomEntry.new).to respond_to(:things)
+    end
+
+    it "parses the added element out of RSS feeds entries" do
+      expect(Feedjira::Parser::RSSEntry.new).to respond_to(:things)
+    end
+  end
 end

data/spec/feedjira/feed_utilities_spec.rb

@@ -116,6 +116,7 @@ describe Feedjira::FeedUtilities do
       it "updates the title if changed" do
         @updated_feed.title = "new title"
         @feed.update_from_feed(@updated_feed)
+
         expect(@feed.title).to eq @updated_feed.title
         expect(@feed).to be_updated
       end
@@ -252,11 +253,12 @@ describe Feedjira::FeedUtilities do
       let(:url_one) { "http://example.com/post_one.html" }
       let(:url_two) { "http://example.com/post_two.html" }
 
-      let(:entry_one) { double "Entry One", entry_id: id_one, url: url_one }
-      let(:entry_two) { double "Entry Two", entry_id: id_two, url: url_two }
+      let(:entry_one) { object_double(Feedjira::Parser::AtomEntry.new, entry_id: id_one, url: url_one) }
+
+      let(:entry_two) { object_double(Feedjira::Parser::AtomEntry.new, entry_id: id_two, url: url_two) }
 
       let(:feed_one) { Feedjira::Parser::Atom.new }
-      let(:feed_two) { double "Feed Two", entries: [entry_two] }
+      let(:feed_two) { object_double(Feedjira::Parser::Atom.new, entries: [entry_two]) }
 
       before do
         stub_const("Feedjira::FeedUtilities::UPDATABLE_ATTRIBUTES", [])

data/spec/feedjira/parser/json_feed_spec.rb

@@ -9,6 +9,10 @@ module Feedjira
         expect(JSONFeed).to be_able_to_parse(sample_json_feed)
       end
 
+      it "returns true for a JSON feed with escaped URIs" do
+        expect(JSONFeed).to be_able_to_parse(sample_json_feed_with_escaped_uris)
+      end
+
       it "returns false for an RSS feed" do
         expect(JSONFeed).not_to be_able_to_parse(sample_rss_feed)
       end
@@ -43,6 +47,18 @@ module Feedjira
         expect(@feed.description).to eq "Brent Simmons’s weblog."
       end
 
+      it "parses the favicon" do
+        expect(@feed.favicon).to eq "http://inessential.com/favicon.ico"
+      end
+
+      it "parses the icon" do
+        expect(@feed.icon).to eq "http://inessential.com/icon.png"
+      end
+
+      it "parses the language" do
+        expect(@feed.language).to eq "en-US"
+      end
+
       it "parses expired and return default (nil)" do
         expect(@feed.expired).to be_nil
       end