saxophone 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 57c5242aea2b5daec2f7129d6b12fe56e28e07a8
-  data.tar.gz: c5f4823813e45c56693feeafbb808253367cf533
+SHA256:
+  metadata.gz: 99eb0392977bf92c77b61dd1d79feddde93e8d91b5eea7a76fb03892354ee3b6
+  data.tar.gz: 0c2c3c808f9b5c70258238835ee9240b4745876a5948c9fce7879372d4a4077a
 SHA512:
-  metadata.gz: 18a39e8330f39c5da059bfcb39f147084d8d707fd6375a9561d4711ce3269dc16a98f860a717d45b181cbd79c555edfc329e7ff80818c0f7e41a65f29a0ce9e6
-  data.tar.gz: 6d4b5006f62bacf0d51e6300ba146083301fcb3922dd960282216272622a130ce7cd6fac88481ad5149ceedf4f0e69c5538decde24cae5fa16ae7944594a3c7c
+  metadata.gz: c40ff56245b84fc4592a949726455feb15c25fe914e93234203976409e8a6b9d47dc6d7b636f29644992e553bb4f88847594890abee24ce88bdeb7de9bf0ca7a
+  data.tar.gz: f2d65e68ba0dbf5bb91f97a644d1a4a4a74860186f365dc5f1aa3deb443d8260ec42c7a1fb2f5207f3f24d0ac12a53877f9e76f44d177ca3c3b6f3cfbece8bf4

data/.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: build
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+      - master
+jobs:
+  build:
+    if: "!contains(github.event.head_commit.message, '[skip ci]')"
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby: ['2.5', '2.6', '2.7', '3.0']
+        handler: ['nokogiri', 'ox', 'oga']
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true
+    - run: bundle exec rake
+      env:
+        HANDLER: ${{ matrix.handler }}

data/.ruby-version

@@ -1 +1 @@
-2.5.1
+3.0.1

data/Gemfile

@@ -8,12 +8,12 @@ group :development, :test do
   gem 'simplecov', require: false, platforms: [:mri]
   gem 'coveralls', require: false, platforms: [:mri]
 
-  gem 'activerecord', '~> 5.0.0'
+  gem 'activerecord', '~> 6.0'
   gem 'nokogiri', '>= 1.8.2'
-  gem 'ox', '>= 2.1.2', platforms: [:mri, :rbx]
-  gem 'oga', '>= 0.3.4'
+  gem 'ox', '>= 2.10.0'
+  gem 'oga', '>= 2.15'
 end
 
 group :test do
-  gem 'sqlite3'
+  gem 'sqlite3', '~> 1.4.2'
 end

data/README.md

@@ -1,6 +1,14 @@
-# Saxophone
-
-A declarative SAX parsing library backed by Nokogiri, Ox or Oga.
+<div align="center">
+  <img alt="Saxophone" src="logo.svg" width="400px">
+  <br>
+  <br>
+  <strong>A declarative SAX parsing library backed by Nokogiri, Ox or Oga.</strong>
+  <br>
+  <br>
+  <a href="https://github.com/Absolventa/saxophone/actions/workflows/build.yml">
+    <img src="https://github.com/Absolventa/saxophone/actions/workflows/build.yml/badge.svg" alt="Build Status" style="max-width: 100%;">
+  </a>
+</div>
 
 ## Origins
 
@@ -37,13 +45,13 @@ gem 'nokogiri', '~> 1.6'
 To use **Ox** add this line to your Gemfile:
 
 ```ruby
-gem 'ox', '>= 2.1.2'
+gem 'ox', '>= 2.10.0'
 ```
 
 To use **Oga** add this line to your Gemfile:
 
 ```ruby
-gem 'oga', '>= 0.2.0'
+gem 'oga', '>= 2.15'
 ```
 
 You can also specify which handler to use manually, like this:
@@ -66,34 +74,42 @@ end
 class AtomEntry
   include Saxophone
   element :title
+
   # The :as argument makes this available through entry.author instead of .name
   element :name, as: :author
   element "feedburner:origLink", as: :url
+
   # The :default argument specifies default value for element when it's missing
   element :summary, class: String, default: "No summary available"
+
   element :content, class: AtomContent
   element :published
+
   ancestor :ancestor
 end
 
 class Atom
   include Saxophone
+
   # Use block to modify the returned value
   # Blocks are working with pretty much everything,
   # except for `elements` with `class` attribute
   element :title do |title|
     title.strip
   end
+
   # The :with argument means that you only match a link tag
   # that has an attribute of type: "text/html"
   element :link, value: :href, as: :url, with: {
     type: "text/html"
   }
+
   # The :value argument means that instead of setting the value
   # to the text between the tag, it sets it to the attribute value of :href
   element :link, value: :href, as: :feed_url, with: {
     type: "application/atom+xml"
   }
+
   elements :entry, as: :entries, class: AtomEntry
 end
 ```
@@ -101,7 +117,7 @@ end
 Then parse any XML with your class:
 
 ```ruby
-feed = Atom.parse(xml_text)
+feed = Atom.parse(xml)
 
 feed.title # Whatever the title of the blog is
 feed.url # The main URL of the blog
@@ -151,11 +167,11 @@ Multiple elements can be mapped to the same alias:
 ```ruby
 class RSSEntry
   include Saxophone
-  # ...
-  element :pubDate, as: :published
-  element :pubdate, as: :published
-  element :"dc:date", as: :published
-  element :"dc:Date", as: :published
+
+  element :pubDate,           as: :published
+  element :pubdate,           as: :published
+  element :"dc:date",         as: :published
+  element :"dc:Date",         as: :published
   element :"dcterms:created", as: :published
 end
 ```
@@ -166,6 +182,25 @@ document determines the value assigned to the alias.
 
 If an element is defined in the source but is blank (e.g., `<pubDate></pubDate>`), it is ignored, and non-empty one is picked.
 
+## Parsing Errors
+By default, there are no notification or exceptions on parsing errors and warnings. For Nokogiri and Ox, you can 
+specify a custom behavior by passing procs that receive a string:
+
+```ruby
+on_error = ->(error_string) { raise error_string }
+on_warning = ->(warning_string) { raise warning_string }
+
+feed = Atom.parse(xml, on_error, on_warning)
+```
+
+You can also use a global setting (e.g. in `config/initializers/saxophone.rb` when using Saxophone together
+with Ruby on Rails):
+
+```ruby
+Saxophone.on_error = ->(error_string) { raise error_string }
+Saxophone.on_warning = ->(warning_string) { raise warning_string }
+```
+
 ## Contributing
 
 1. Fork it
@@ -178,7 +213,7 @@ If an element is defined in the source but is blank (e.g., `<pubDate></pubDate>`
 
 The MIT License
 
-Copyright (c) 2009-2018:
+Copyright (c) 2009-2020:
 
 * [Paul Dix](http://www.pauldix.net)
 * [Julien Kirch](http://www.archiloque.net)

data/lib/saxophone/handlers/sax_abstract_handler.rb

@@ -125,15 +125,11 @@ module Saxophone
     end
 
     def _error(string)
-      if @on_error
-        @on_error.call(string)
-      end
+      @on_error.call(string)
     end
 
     def _warning(string)
-      if @on_warning
-        @on_warning.call(string)
-      end
+      @on_warning.call(string)
     end
 
     private

data/lib/saxophone/sax_document.rb

@@ -4,7 +4,7 @@ module Saxophone
     base.extend(ClassMethods)
   end
 
-  def parse(xml_input, on_error = nil, on_warning = nil)
+  def parse(xml_input, on_error = Saxophone.on_error, on_warning = Saxophone.on_warning)
     handler_klass = Saxophone.const_get("SAX#{Saxophone.handler.capitalize}Handler")
 
     handler = handler_klass.new(self, on_error, on_warning)
@@ -15,7 +15,7 @@ module Saxophone
 
   module InstanceMethods
     def initialize(attributes = {})
-      attributes.each do |name, value|
+      attributes&.each do |name, value|
         send("#{name}=", value)
       end
 

data/lib/saxophone/version.rb

@@ -1,3 +1,3 @@
 module Saxophone
-  VERSION = "1.0.0"
+  VERSION = "1.1.0"
 end

data/lib/saxophone.rb

@@ -14,6 +14,22 @@ module Saxophone
       @@handler = handler
     end
   end
+
+  def self.on_error
+    @@on_error ||= ->(_) {}
+  end
+
+  def self.on_error=(on_error_proc)
+    @@on_error = on_error_proc
+  end
+
+  def self.on_warning
+    @@on_warning ||= ->(_) {}
+  end
+
+  def self.on_warning=(on_warning_proc)
+    @@on_warning = on_warning_proc
+  end
 end
 
 # Try handlers

data/logo.svg

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<svg viewBox="0 0 764 245" width="764" height="245" xmlns="http://www.w3.org/2000/svg">
+  <g fill="none" fill-rule="evenodd">
+    <path d="M157.09 209.91c12.955 0 18.683-3.137 23.592-13.092C182.59 205.41 186.409 208 196.5 208v-6.955c-8.182.137-10.636-3.136-10.636-14.454V151c0-21.955-6.955-29.182-28.773-29.182-15.955 0-22.364 4.637-26.591 18.955l7.227 1.772c3.137-10.5 7.637-13.636 19.364-13.636 16.227 0 21.273 5.182 21.273 22.091v8.455H157.09c-21.682 0-28.636 6-28.636 25.772 0 18.682 6.954 24.682 28.636 24.682Zm0-6.955c-16.226 0-21.135-4.228-21.135-17.728 0-14.59 4.909-18.954 21.136-18.954h21.273v12.136c0 18.682-5.046 24.546-21.273 24.546ZM221.183 208l21.273-35.182L263.864 208h8.454l-25.5-42.136 25.5-42.137h-8.454l-21.41 35.182-21.272-35.182h-8.591l25.636 42.137L212.591 208h8.59Zm103.09 1.91c22.5 0 29.728-10.774 29.728-44.046 0-33.273-7.227-44.046-29.727-44.046s-29.591 10.773-29.591 44.046c0 33.272 7.09 44.045 29.59 44.045Zm0-6.955c-16.772 0-22.09-8.728-22.09-37.091 0-28.364 5.318-37.091 22.09-37.091 16.773 0 22.228 8.727 22.228 37.09 0 28.364-5.455 37.092-22.227 37.092Zm60.546 29.863v-34.5c3.682 8.727 11.727 11.591 22.227 11.591 22.5 0 29.728-10.773 29.728-44.182 0-33.272-7.228-43.909-29.728-43.909-10.227 0-18.272 2.046-22.227 8.455v-6.546h-7.5v109.091h7.5Zm22.227-29.863c-13.363 0-22.227-6-22.227-22.773v-39.818c0-8.864 10.227-11.591 22.227-11.591 16.773 0 22.228 8.727 22.228 36.954 0 28.364-5.455 37.228-22.228 37.228ZM468.41 208v-56.182c0-18.545 4.773-23.045 20.864-23.045 15.954 0 21.136 8.318 21.136 35.318V208h7.5v-43.91c0-32.045-6.954-42.272-28.636-42.272-10.228 0-17.864 2.455-20.864 10.227V98.91h-7.5V208h7.5Zm101.318 1.91c22.5 0 29.728-10.774 29.728-44.046 0-33.273-7.228-44.046-29.728-44.046s-29.59 10.773-29.59 44.046c0 33.272 7.09 44.045 29.59 44.045Zm0-6.955c-16.772 0-22.09-8.728-22.09-37.091 0-28.364 5.318-37.091 22.09-37.091 16.773 0 22.228 8.727 22.228 37.09 0 28.364-5.455 37.092-22.228 37.092Zm61.5 5.045v-56.182c0-18.818 5.591-23.045 24.137-23.045 13.772 0 18.136 5.863 18.136 24.545V208h7.5v-54.682c0-24-6.136-31.5-25.636-31.5-13.228 0-19.228 3-24.137 10.091v-8.182h-7.5V208h7.5Zm102.546 1.91c13.909 0 20.727-3.41 28.363-14.046l-6-4.091c-6.681 8.59-11.863 11.182-22.363 11.182-18.137 0-24.137-8.728-24.41-36.682h54.273c0-33.546-7.227-44.455-29.863-44.455-24.273 0-31.91 10.773-31.91 44.046 0 33.272 7.637 44.045 31.91 44.045Zm22.09-50.455H709.5c.682-23.319 6.955-30.682 24.273-30.682 15.545 0 20.863 7.363 22.09 30.682Z" fill="#000" fill-rule="nonzero"/>
+    <path d="M139.791 3.5c-7.052 1.164-11.908 2.19-14.566 3.077-7.587 2.53-12.196 5.953-15.414 8.235-4.983 3.534-8.586 8.8-11.227 13.486-3.3 5.853-5.02 11.347-5.137 17.714-.68 52.755-1.203 125.916-1.203 151.243 0 1.848-.113 3.67-.333 5.458-2.69 21.86-21.324 38.787-43.912 38.787-24.435 0-44.244-19.81-44.244-44.245v-61.562l41.965-21.24.585 75.634" stroke="#0A0909" stroke-width="7"/>
+    <path d="m76.021 96.23h34.416m-34.416 17.979h34.416m-34.416 18.109h34.416" stroke="#0A0909" stroke-width="5"/>
+  </g>
+</svg>

data/spec/saxophone/global_config_spec.rb

@@ -0,0 +1,88 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Saxophone global configurations" do
+  before(:all) do
+    class A
+      include Saxophone
+    end
+  end
+
+  after(:all) do
+    Object.send(:remove_const, :A)
+  end
+
+  describe "handler config" do
+    after(:all) do
+      Saxophone.handler = :ox # restore default settings
+    end
+
+    context "with handler set to ox" do
+      before do
+        Saxophone.handler = :ox
+      end
+
+      it "uses ox as handler" do
+        expect(Saxophone.handler).to eq :ox
+      end
+    end
+
+    context "with handler set to oga" do
+      before do
+        Saxophone.handler = :oga
+      end
+
+      it "uses oga as handler" do
+        expect(Saxophone.handler).to eq :oga
+      end
+    end
+
+    context "with handler set to nokogiri" do
+      before do
+        Saxophone.handler = :nokogiri
+      end
+
+      it "uses nokogiri as handler" do
+        expect(Saxophone.handler).to eq :nokogiri
+      end
+    end
+
+    context "with handler set to some other value" do
+      it "raises error" do
+        expect { Saxophone.handler = :not_a_valid_handler }.to raise_error(LoadError)
+      end
+    end
+  end
+
+  describe "global on_error config" do
+    broken_xml = "<top><title>Te & st</title><b>Matched!</b><c>And Again</c></top>"
+    xml = "<top><title>Test</title><b>Matched!</b><c>And Again</c></top>"
+
+    context "not configured" do
+      it "does not raise exception on valid xml" do
+        expect { A.parse xml }.not_to raise_error
+      end
+
+      it "does not raise exception on broken xml" do
+        expect { A.parse broken_xml }.not_to raise_error
+      end
+    end
+
+    context "configured to raise exception" do
+      before(:all) do
+        Saxophone.on_error = ->(error_string) { raise error_string }
+      end
+
+      after(:all) do
+        Saxophone.on_error = ->(_) {} # restore default settings
+      end
+
+      it "does not raise exception on valid xml" do
+        expect { A.parse xml }.not_to raise_error
+      end
+
+      it "raises exception on broken xml" do
+        expect { A.parse broken_xml }.to raise_error(RuntimeError)
+      end
+    end
+  end
+end

data/spec/saxophone/sax_document_spec.rb

@@ -1172,8 +1172,9 @@ describe "Saxophone" do
   describe "with error handling" do
     before do
       @xml = %[
-        <item id="1">
+        <item:a:b id="1">
           <title>sweet</title>
+        </idem>
       ]
 
       class ItemElement5
@@ -1190,9 +1191,7 @@ describe "Saxophone" do
       )
     end
 
-    it "has error" do
-      expect(@errors.uniq.size).to eq(1)
-    end
+    it { expect(@errors.uniq.size).to be >= 1 }
 
     it "has no warning" do
       expect(@warnings.uniq.size).to eq(0)

data/spec/spec_helper.rb

@@ -1,22 +1,2 @@
-begin
-  require 'simplecov'
-  require 'coveralls'
-
-  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
-    SimpleCov::Formatter::HTMLFormatter,
-    Coveralls::SimpleCov::Formatter
-  ]
-
-  SimpleCov.start do
-    add_filter '/spec/'
-  end
-rescue LoadError
-end
-
 require File.expand_path(File.dirname(__FILE__) + '/../lib/saxophone')
 Saxophone.handler = ENV['HANDLER'].to_sym if ENV['HANDLER']
-
-RSpec.configure do |config|
-  config.run_all_when_everything_filtered = true
-  config.filter_run :focus
-end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: saxophone
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Paul Dix
@@ -9,10 +9,10 @@ authors:
 - Ezekiel Templin
 - Dmitry Krasnoukhov
 - Robin Neumann
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-19 00:00:00.000000000 Z
+date: 2021-10-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -28,16 +28,16 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.6'
-description: 
-email: 
+description:
+email:
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/build.yml"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
-- ".travis.yml"
 - Gemfile
 - README.md
 - Rakefile
@@ -56,9 +56,11 @@ files:
 - lib/saxophone/sax_configure.rb
 - lib/saxophone/sax_document.rb
 - lib/saxophone/version.rb
+- logo.svg
 - saxophone.gemspec
 - spec/fixtures/atom-content.html
 - spec/fixtures/atom.xml
+- spec/saxophone/global_config_spec.rb
 - spec/saxophone/sax_activerecord_spec.rb
 - spec/saxophone/sax_configure_spec.rb
 - spec/saxophone/sax_document_spec.rb
@@ -68,7 +70,7 @@ homepage: http://github.com/Absolventa/saxophone
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -83,14 +85,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.2.2
-signing_key: 
+rubygems_version: 3.2.15
+signing_key:
 specification_version: 4
 summary: Declarative SAX Parsing with Nokogiri, Ox or Oga
 test_files:
 - spec/fixtures/atom-content.html
 - spec/fixtures/atom.xml
+- spec/saxophone/global_config_spec.rb
 - spec/saxophone/sax_activerecord_spec.rb
 - spec/saxophone/sax_configure_spec.rb
 - spec/saxophone/sax_document_spec.rb

data/.travis.yml

@@ -1,35 +0,0 @@
-language: ruby
-
-rvm:
-  - 1.9.3
-  - 2.0
-  - 2.1
-  - 2.2
-  - 2.3
-  - 2.4
-  - 2.5
-  - jruby-1.7
-  - rbx-2
-  - ruby-head
-  - jruby-head
-
-sudo: false
-
-env:
-  matrix:
-    - HANDLER="nokogiri"
-    - HANDLER="ox"
-    - HANDLER="oga"
-
-matrix:
-  exclude:
-    - env: HANDLER="ox"
-      rvm: jruby-1.7
-    - env: HANDLER="ox"
-      rvm: jruby-head
-  allow_failures:
-    - env: HANDLER="oga"
-      rvm: jruby-1.7
-    - rvm: rbx-2
-    - rvm: ruby-head
-    - rvm: jruby-head