metacrunch-marcxml 3.0.0 → 3.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3634c811258d11102cde40466592986814cb3ecf463985fd4ff139934539fe8b
-  data.tar.gz: 9b86c52e489af8bd05f698af04526d3c1561d67180fd37db88d797d351481ca9
+  metadata.gz: 639f08dad0d34c7b863be2778a8aa961085b1865d44fdf1ecf84d073f9cac1e5
+  data.tar.gz: 4d1a9023bafef92c0fb6ebaa0b6904895946dc49b550db53e5b9cf1351e79439
 SHA512:
-  metadata.gz: 170cb959fb34cd493867c07e0d6ff3553385ccb7c7cca41beeee1f70208725921ea80f2a3765511fd87d330a1d61b90ab7167cf3a25df65797f6194960f8ec7b
-  data.tar.gz: ccfd0da9bfc9cb8d66dbf6fb632f0b7949fc0fb539586a9eff1ef2d148446f8d611ddea48346dbbb82052ff794ed6b8704fa5d3ed967a38c4c61f3b7eeabc33e
+  metadata.gz: 5d0755a1ccaa39754ba1c1bfded2a1d8d9826498fc671a11f9168c1781e13feee3027779cc9a80b4f2631879926ce18a78a4dad5ca12c08e2b06d30723377022
+  data.tar.gz: 0e7fc91bbcca1e2252fe515c53cefdd14782f0fa03b621661861851b9beaa1c5bf89c897e377c936e751e83fd804e1802d9d59e85198482a6be37511a0568bfa

data/lib/metacrunch/marcxml.rb

@@ -1,6 +1,5 @@
 require "active_support"
 require "active_support/core_ext"
-require "htmlentities"
 require "ox"
 
 module Metacrunch
@@ -12,11 +11,10 @@ module Metacrunch
     #
     # Convenience method for Metacrunch::Marcxml.parse
     #
-    # @return [Metacrunch::Marcxml::Document] the parsed {Metacrunch::Marcxml::Document}
     # @see Metacrunch::Marcxml#parse
     #
-    def Marcxml(xml)
-      Metacrunch::Marcxml.parse(xml)
+    def Marcxml(xml, collection_mode: false)
+      Metacrunch::Marcxml.parse(xml, collection_mode: collection_mode)
     end
   end
 
@@ -27,20 +25,23 @@ module Metacrunch
       # Parses a MARCXML string into a {Metacrunch::Marcxml::Document}.
       #
       # @param xml [String] the MARCXML document as a string
-      # @return [Metacrunch::Marcxml::Document] the parsed {Metacrunch::Marcxml::Document}
+      # @param collection_mode [true, false] set to `true` if the MARCXML contains more than one record.
+      #  Default is `false`.
+      # @return [Metacrunch::Marcxml::Document, Array<Metacrunch::Marcxml::Document>, nil] the parsed
+      #   {Metacrunch::Marcxml::Document}, an array of documents if `collection_mode` was `true`
+      #   or `nil` if the MARCXML did not contain valid data.
       #
-      def parse(xml)
-        Parser.new.parse(xml)
+      def parse(xml, collection_mode: false)
+        Parser.new.parse(xml, collection_mode: collection_mode)
       end
 
       #
-      # Convenience method for Metacrunch::Marcxml.parse
+      # Convenience method for Metacrunch::Marcxml.parse(xml, collection_mode: false)
       #
-      # @return [Metacrunch::Marcxml::Document] the parsed {Metacrunch::Marcxml::Document}
       # @see Metacrunch::Marcxml#parse
       #
       def [](xml)
-        self.parse(xml)
+        self.parse(xml, collection_mode: false)
       end
     end
   end

data/lib/metacrunch/marcxml/document.rb

@@ -13,6 +13,10 @@ module Metacrunch
         @datafields_map    = {}
       end
 
+      def empty?
+        @controlfields_map.blank? && @datafields_map.blank?
+      end
+
       # ------------------------------------------------------------------------------
       # Control fields
       # ------------------------------------------------------------------------------

data/lib/metacrunch/marcxml/document/controlfield.rb

@@ -3,10 +3,10 @@ module Metacrunch
     class Document
       class Controlfield
 
-        attr_reader :tag
-        attr_reader :value
+        attr_accessor :tag
+        attr_accessor :value
 
-        def initialize(tag, value)
+        def initialize(tag = nil, value = nil)
           @tag = tag
           @value = value
         end

data/lib/metacrunch/marcxml/document/datafield.rb

@@ -3,10 +3,10 @@ module Metacrunch
     class Document
       class Datafield
 
-        attr_reader :tag
-        attr_reader :ind1, :ind2
+        attr_accessor :tag
+        attr_accessor :ind1, :ind2
 
-        def initialize(tag, ind1:nil, ind2:nil)
+        def initialize(tag = nil, ind1:nil, ind2:nil)
           @tag  = tag
           @ind1 = ind1
           @ind2 = ind2

data/lib/metacrunch/marcxml/document/subfield.rb

@@ -3,10 +3,10 @@ module Metacrunch
     class Document
       class Subfield
 
-        attr_reader :code
-        attr_reader :value
+        attr_accessor :code
+        attr_accessor :value
 
-        def initialize(code, value)
+        def initialize(code = nil, value = nil)
           @code  = code
           @value = value
         end

data/lib/metacrunch/marcxml/parser.rb

@@ -1,80 +1,78 @@
 module Metacrunch
   module Marcxml
     class Parser < Ox::Sax
+      class ParsingDone < StandardError ; end
 
-      def parse(marc_xml)
-        # initialize state machine
-        @in_controlfield = @in_datafield = @in_subfield = false
+      def parse(marc_xml, collection_mode: false)
+        @stack     = []
+        @documents = []
+        @collection_mode = collection_mode
 
-        @controlfield = @datafield = @subfield = nil
-        @document = Document.new
-        @html_entities_coder = HTMLEntities.new
+        begin
+          Ox.sax_parse(self, marc_xml, convert_special: true)
+        rescue ParsingDone ; end
 
-        # convert_special tells ox to convert some html entities already during
-        # parsing, which minifies the amount of entities we have to decode using
-        # html_entities_coder in #text.
-        Ox.sax_parse(self, marc_xml, convert_special: true)
-
-        return @document
+        collection_mode ? @documents : @documents.first
       end
 
       def start_element(name)
-        if name == :subfield
-          @in_subfield = true
-          @subfield = {}
-        elsif name == :datafield
-          @in_datafield = true
-          @datafield = {subfields: []}
-        elsif name == :controlfield
-          @in_controlfield = true
-          @controlfield = {}
+        @stack << [name, {}]
+
+        element_name, element_data = @stack[-1]
+        parent_name, parent_data   = @stack[-2]
+
+        if element_name == :record
+          element_data[:document] = Document.new
+        elsif element_name == :controlfield && parent_name == :record
+          element_data[:controlfield] = Document::Controlfield.new
+        elsif element_name == :datafield && parent_name == :record
+          element_data[:datafield] = Document::Datafield.new
+        elsif element_name == :subfield && parent_name == :datafield
+          element_data[:subfield] = Document::Subfield.new
         end
       end
 
       def end_element(name)
-        if @in_subfield
-          @in_subfield = false
-
-          subfield = Document::Subfield.new(@subfield[:code], @subfield[:value])
-          @datafield[:subfields] << subfield
-        elsif @in_datafield
-          @in_datafield = false
-
-          datafield = Document::Datafield.new(@datafield[:tag], ind1: @datafield[:ind1], ind2: @datafield[:ind2])
-          @datafield[:subfields].each do |subfield|
-            datafield.add_subfield(subfield)
-          end
+        element_name, element_data = @stack[-1]
+        parent_name, parent_data   = @stack[-2]
 
-          @document.add_datafield(datafield)
-        elsif @in_controlfield
-          @in_controlfield = false
-
-          controlfield = Document::Controlfield.new(@controlfield[:tag], @controlfield[:values])
-          @document.add_controlfield(controlfield)
+        if element_name == :record
+          @documents << element_data[:document] unless element_data[:document].empty?
+          raise ParsingDone unless @collection_mode
+        elsif element_name == :controlfield && parent_name == :record
+          parent_data[:document].add_controlfield(element_data[:controlfield])
+        elsif element_name == :datafield && parent_name == :record
+          parent_data[:document].add_datafield(element_data[:datafield])
+        elsif element_name == :subfield && parent_name == :datafield
+          parent_data[:datafield].add_subfield(element_data[:subfield])
         end
+
+        @stack.pop
       end
 
       def attr(name, value)
-        if @in_subfield
-          @subfield[:code] = value if name == :code
-        elsif @in_datafield
-          if name == :tag
-            @datafield[:tag] = value
-          elsif name == :ind1
-            @datafield[:ind1] = value
-          elsif name == :ind2
-            @datafield[:ind2] = value
-          end
-        elsif @in_controlfield
-          @controlfield[:tag] = value if name == :tag
+        element_name, element_data = @stack[-1]
+        parent_name, parent_data   = @stack[-2]
+
+        if element_name == :controlfield && parent_name == :record
+          element_data[:controlfield].tag = value if name == :tag
+        elsif element_name == :datafield && parent_name == :record
+          element_data[:datafield].tag  = value if name == :tag
+          element_data[:datafield].ind1 = value if name == :ind1
+          element_data[:datafield].ind2 = value if name == :ind2
+        elsif element_name == :subfield && parent_name == :datafield
+          element_data[:subfield].code = value if name == :code
         end
       end
 
       def text(value)
-        if @in_subfield
-          @subfield[:value] = value.include?("&") ? @html_entities_coder.decode(value) : value
-        elsif @in_controlfield
-          @controlfield[:values] = value
+        element_name, element_data = @stack[-1]
+        parent_name, parent_data   = @stack[-2]
+
+        if element_name == :controlfield && parent_name == :record
+          element_data[:controlfield].value = value
+        elsif element_name == :subfield && parent_name == :datafield
+          element_data[:subfield].value = value
         end
       end
     end

data/lib/metacrunch/marcxml/version.rb

@@ -1,5 +1,5 @@
 module Metacrunch
   module Marcxml
-    VERSION = "3.0.0"
+    VERSION = "3.1.0"
   end
 end

data/metacrunch-marcxml.gemspec

@@ -18,7 +18,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "activesupport", ">= 5.1"
-  spec.add_dependency "htmlentities",  ">= 4.3"
   spec.add_dependency "ox",            ">= 2.11"
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: metacrunch-marcxml
 version: !ruby/object:Gem::Version
-  version: 3.0.0
+  version: 3.1.0
 platform: ruby
 authors:
 - René Sprotte
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-16 00:00:00.000000000 Z
+date: 2021-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -24,20 +24,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: htmlentities
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '4.3'
 - !ruby/object:Gem::Dependency
   name: ox
   requirement: !ruby/object:Gem::Requirement