libis-tools 0.9.65 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e20556c8d995577522538e74f68c9495cdcb8988
-  data.tar.gz: ee609560a8adbb810ed7be297806e610ff0b1468
+  metadata.gz: 6ac60f332c876e86ca3f751e4a99b68a10b60f03
+  data.tar.gz: cc488738791b1535b7c79fdc9dbf7b7e75847dca
 SHA512:
-  metadata.gz: 1244dcd1307b9eea5792750037686900d7c1a145a69ef8d3e5a30396b6ae0f0f8d4bc2c108f83a3481ce5cda6f6da90edd837de6981287f8b0f0fd0936619c82
-  data.tar.gz: bcaca90c28543679c1aee0a27f4b93b7fc7330ace6be042abe5ba45135bac614d42477cce36b4048d5ce7d969031c07fef50e6ed5e0baa22d46701f0e380f5a9
+  metadata.gz: 3c74151553d0042175b87149cc9f19d15efbb23191e32dce0c37d3f40ef17eb9872005b9757aafec0cf159b905fbdd4bbc9609248d61a0874d5a3fa3f1a47a66
+  data.tar.gz: ee214d77eae0e39be7a08b6bfdbb1daf4568814aa5be02bc35ee93095b090fd0abd04ee5bee4f40e96e9413dc3fa30769c08feb02a6db9b0ed8da7dac0ffe05c

data/README.md

@@ -76,25 +76,7 @@ It also initializes a default logger.
 
 The ::Libis::Tools::Logger module adds support for logging functionality to any class.
 
-## {::Libis::Tools::Metadata}
-
-This gem also provides some modules and classes that assist in working with metadata. There are classes that allow to 
-create and/or read metadata for MARC(21), Dublin Core and SharePoint. These classes all live in the 
-Libis::Tools::Metadata namespace.
-
-### MARC
-
-The classes {::Libis::Tools::Metadata::MarcRecord} and it's child class {::Libis::Tools::Metadata::Marc21Record} are 
-mainly built for reading MARC(21) records. Most of the class logic is in the base class 
-{::Libis::Tools::Metadata::MarcRecord MarcRecord}, which is incomplete and should be considered an abstract class. 
-
-{::Libis::Tools::Metadata::Marc21Record Marc21Record} on the other hand only contains the logic to parse the XML data 
-into the internal structure. A {::Libis::Tools::Metadata::MarcRecord MarcRecord} is created by supplying it an XML node
-(from Nokogiri or {::Libis::Tools::XmlDocument}) that contains child nodes with the MARC data of a single record. 
-
-The code will strip namespaces from the input in order to greatly simplify working with the XML.
-
-## {::Libis::Tools::Parameter} and {::Libis::Tools::ParameterContainer} 
+## {::Libis::Tools::Parameter} and {::Libis::Tools::ParameterContainer}
 
 The class {::Libis::Tools::Parameter} and the {::Libis::Tools::ParameterContainer} module provide a simple framework for
 instance variables that are type-safe and can easily be documented and provide defaults.
@@ -104,7 +86,7 @@ instance variables that are type-safe and can easily be documented and provide d
 A small and simple module that provides some convenience methods to deal with temp files. Random file names are generated
 in a similar way as the standard Ruby Tempfile class does. It has the form:
 ```
-    <Optional prefix with '_' appended>_<YYYYMMDD>_<process id>_<random base36 number><optional suffix>
+    <Optional prefix with '_' appended><YYYYMMDD>_<process id>_<random base36 number><optional suffix>
 ```
 
 The #name method creates a random file name. Optional parameters are the prefix and suffix (including '.' character if
@@ -117,14 +99,14 @@ when the block ends. In that case the return value will be whatever the block re
 
 Without a block, the method still creates and opens the file, but it will return the open file pointer to the caller. The
 caller is responsible to #close and #unlink or #delete the file. The #unlink and #delete methods are injected into the
-returned IO object for your convenience, but it calling the corresponding File methods instead is equally valid.
+returned IO object for your convenience, but calling the corresponding File methods instead is equally valid.
 
 ## {::Libis::Tools::ThreadSafe}
 
 A convenience method that embeds the mutex implementation. Just include this module whenever you need a thread-save
 implementation and use the mutex instance variable without any concerns regarding initialization. Your class will have
-access to an instance variable 'mutex' as well as a class variable 'class_mutex'. The mutexes (Montor instance) are created
-in a thread-safe way.
+access to an instance variable 'mutex' as well as a class variable 'class_mutex'. The mutexes (Montor instance) themselves
+are created in a thread-safe way.
 
 ## {::Libis::Tools::XmlDocument}
 

data/lib/libis/tools.rb

@@ -20,5 +20,4 @@ module Libis
   end
 end
 
-require_relative 'tools/metadata'
 require_relative 'tools/extend/struct'

data/lib/libis/tools/version.rb

@@ -1,5 +1,5 @@
 module Libis
   module Tools
-    VERSION = '0.9.65'
+    VERSION = '1.0.0'
   end
 end

data/libis-tools.gemspec

@@ -44,7 +44,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'simple_xlsx_reader', '~> 1.0'
   spec.add_runtime_dependency 'logging', '~> 2.0'
   spec.add_runtime_dependency 'concurrent-ruby', '~> 1.0'
-  spec.add_runtime_dependency 'yard', '~> 0.8'
+  spec.add_runtime_dependency 'yard', '~> 0.9.11'
   spec.add_runtime_dependency 'roo', '~> 2.5'
   spec.add_runtime_dependency 'roo-xls', '~> 1.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: libis-tools
 version: !ruby/object:Gem::Version
-  version: 0.9.65
+  version: 1.0.0
 platform: ruby
 authors:
 - Kris Dekeyser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-14 00:00:00.000000000 Z
+date: 2018-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -226,14 +226,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.8'
+        version: 0.9.11
 - !ruby/object:Gem::Dependency
   name: roo
   requirement: !ruby/object:Gem::Requirement
@@ -293,28 +293,6 @@ files:
 - lib/libis/tools/extend/string.rb
 - lib/libis/tools/extend/struct.rb
 - lib/libis/tools/logger.rb
-- lib/libis/tools/metadata.rb
-- lib/libis/tools/metadata/dublin_core_record.rb
-- lib/libis/tools/metadata/field_format.rb
-- lib/libis/tools/metadata/fix_field.rb
-- lib/libis/tools/metadata/mapper.rb
-- lib/libis/tools/metadata/mappers/flandrica.rb
-- lib/libis/tools/metadata/mappers/kuleuven.rb
-- lib/libis/tools/metadata/mappers/scope.rb
-- lib/libis/tools/metadata/marc21_record.rb
-- lib/libis/tools/metadata/marc_record.rb
-- lib/libis/tools/metadata/parser/basic_parser.rb
-- lib/libis/tools/metadata/parser/dublin_core_parser.rb
-- lib/libis/tools/metadata/parser/marc21_parser.rb
-- lib/libis/tools/metadata/parser/marc_format_parser.rb
-- lib/libis/tools/metadata/parser/marc_rules.rb
-- lib/libis/tools/metadata/parser/marc_select_parser.rb
-- lib/libis/tools/metadata/parser/patch.rb
-- lib/libis/tools/metadata/parser/subfield_criteria_parser.rb
-- lib/libis/tools/metadata/parsers.rb
-- lib/libis/tools/metadata/sharepoint_mapping.rb
-- lib/libis/tools/metadata/sharepoint_record.rb
-- lib/libis/tools/metadata/var_field.rb
 - lib/libis/tools/mets_dnx.rb
 - lib/libis/tools/mets_file.rb
 - lib/libis/tools/mets_objects.rb
@@ -331,7 +309,6 @@ files:
 - spec/config_file_spec.rb
 - spec/config_spec.rb
 - spec/csv_spec.rb
-- spec/data/MetadataMapping.xlsx
 - spec/data/test-headers.csv
 - spec/data/test-headers.tsv
 - spec/data/test-noheaders.csv
@@ -343,17 +320,6 @@ files:
 - spec/data/test_config.yml
 - spec/deep_struct_spec.rb
 - spec/logger_spec.rb
-- spec/metadata/123456789.marc
-- spec/metadata/8389207.marc
-- spec/metadata/BE_942855_1927_4898_corrected.XML
-- spec/metadata/BE_942855_1927_4898_md.XML
-- spec/metadata/dublin_core_parser_spec.rb
-- spec/metadata/dublin_core_spec.rb
-- spec/metadata/marc21_parser_data.rb
-- spec/metadata/marc21_parser_spec.rb
-- spec/metadata/marc21_spec.rb
-- spec/metadata/metadata_mapper_spec.rb
-- spec/metadata/scope_mapper_spec.rb
 - spec/mets_file_spec.rb
 - spec/parameter_container_spec.rb
 - spec/parameter_spec.rb
@@ -363,7 +329,6 @@ files:
 - spec/test.xsd
 - spec/thread_safe_spec.rb
 - spec/xmldocument_spec.rb
-- test.rb
 - test/test_helper.rb
 - test/webservices/test_ca_item_info.rb
 - test/webservices/test_ca_search.rb
@@ -398,7 +363,6 @@ test_files:
 - spec/config_file_spec.rb
 - spec/config_spec.rb
 - spec/csv_spec.rb
-- spec/data/MetadataMapping.xlsx
 - spec/data/test-headers.csv
 - spec/data/test-headers.tsv
 - spec/data/test-noheaders.csv
@@ -410,17 +374,6 @@ test_files:
 - spec/data/test_config.yml
 - spec/deep_struct_spec.rb
 - spec/logger_spec.rb
-- spec/metadata/123456789.marc
-- spec/metadata/8389207.marc
-- spec/metadata/BE_942855_1927_4898_corrected.XML
-- spec/metadata/BE_942855_1927_4898_md.XML
-- spec/metadata/dublin_core_parser_spec.rb
-- spec/metadata/dublin_core_spec.rb
-- spec/metadata/marc21_parser_data.rb
-- spec/metadata/marc21_parser_spec.rb
-- spec/metadata/marc21_spec.rb
-- spec/metadata/metadata_mapper_spec.rb
-- spec/metadata/scope_mapper_spec.rb
 - spec/mets_file_spec.rb
 - spec/parameter_container_spec.rb
 - spec/parameter_spec.rb

data/lib/libis/tools/metadata.rb

@@ -1,25 +0,0 @@
-module Libis
-  module Tools
-
-    # This module groups several metadata formats. Note that all metadata related classes will move into a Gem of their
-    # own in the future.
-    module Metadata
-
-      autoload :MarcRecord, 'libis/tools/metadata/marc_record'
-      autoload :Marc21Record, 'libis/tools/metadata/marc21_record'
-      autoload :DublinCoreRecord, 'libis/tools/metadata/dublin_core_record'
-
-      # Mappers implementations for converting MARC records to Dublin Core.
-      module Mappers
-
-        autoload :Kuleuven, 'libis/tools/metadata/mappers/kuleuven'
-        autoload :Flandrica, 'libis/tools/metadata/mappers/flandrica'
-        autoload :Scope, 'libis/tools/metadata/mappers/scope'
-
-      end
-
-    end
-  end
-end
-
-require_relative 'metadata/parsers'

data/lib/libis/tools/metadata/dublin_core_record.rb

@@ -1,116 +0,0 @@
-# encoding: utf-8
-require 'nori'
-require 'libis/tools/assert'
-
-module Libis
-  module Tools
-    module Metadata
-
-      # Conveniece class to create and read DC records.
-      # Most of the functionality is derived from the {::Libis::Tools::XmlDocument} base class. This class puts its
-      # focus on supporting the <dc:xxx> and <dcterms:xxx> namespaces. For most tags the namespaces are added
-      # automatically by checking which tag you want to add. In some cases the same tag exists in both namespaces and
-      # you may want to state the namespace explicitely. Even then things are made as easily as possible.
-      class DublinCoreRecord < Libis::Tools::XmlDocument
-
-        # List of known tags in the DC namespace
-        DC_ELEMENTS = %w'contributor coverage creator date description format identifier language' +
-            %w'publisher relation rights source subject title type'
-        # List of known tags in the DCTERMS namespace
-        DCTERMS_ELEMENTS = %w'abstract accessRights accrualMethod accrualPeriodicity accrualPolicy alternative' +
-            %w'audience available bibliographicCitation conformsTo contributor coverage created creator date' +
-            %w'dateAccepted dateCopyrighted dateSubmitted description educationLevel extent format hasFormat' +
-            %w'hasPart hasVersion identifier instructionalMethod isFormatOf isPartOf isReferencedBy isReplacedBy' +
-            %w'isRequiredBy issued isVersionOf language license mediator medium modified provenance publisher' +
-            %w'references relation replaces requires rights rightsHolder source spatial subject tableOfContents' +
-            %w'temporal title type valid'
-
-        # Create new DC document.
-        # If the doc parameter is nil a new empty DC document will be created with the dc:record root element and all
-        # required namespaces defined.
-        # @note The input document is not checked if it is a valid DC record XML.
-        # @param [::Libis::Tools::XmlDocument,String,IO,Hash] doc optional document to read.
-        def initialize(doc = nil)
-          super()
-          xml_doc = case doc
-                      when ::Libis::Tools::XmlDocument
-                        doc
-                      when String
-                        # noinspection RubyResolve
-                        File.exist?(doc) ? Libis::Tools::XmlDocument.open(doc) : Libis::Tools::XmlDocument.parse(doc)
-                      when IO
-                        Libis::Tools::XmlDocument.parse(doc.read)
-                      when Hash
-                        Libis::Tools::XmlDocument.from_hash(doc)
-                      when NilClass
-                        Libis::Tools::XmlDocument.new.build do |xml|
-                          xml[:dc].record('xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance',
-                                     'xmlns:dc' => 'http://purl.org/dc/elements/1.1/',
-                                     'xmlns:dcterms' => 'http://purl.org/dc/terms/') {
-                            yield xml if block_given?
-                          }
-                        end
-                      else
-                        raise ArgumentError, "Invalid argument: #{doc.inspect}"
-                    end
-          @document = xml_doc.document if xml_doc
-          raise ArgumentError, 'XML document not valid.' if self.invalid?
-        end
-
-        # Search the document with xpath.
-        # If no namespace is present, the 'dc:' namespace will be added.
-        # @param [String] path any valid XPath expression
-        def xpath(path)
-          m = /^([\/.]*\/)?(dc(terms)?:)?(.*)/.match(path.to_s)
-          return [] unless m[4]
-          path = (m[1] || '') + ('dc:' || m[2]) + m[4]
-          @document.xpath(path.to_s)
-        end
-
-        # Add a node.
-        # You can omit the namespace in the name parameter. The method will add the correct namespace for you. If using
-        # symbols for name, an underscore ('_') can be used as separator instead of the colon (':').
-        # @param [String,Symbol] name tag name of the element
-        # @param [String] value content of the new element
-        # @param [Nokogiri::XML::Node] parent the new element will be attached to this node
-        # @param [Hash] attributes list of <attribute_name>, <attribute_value> pairs for the new element
-        def add_node(name, value = nil, parent = nil, attributes = {})
-          ns, tag = get_namespace(name.to_s)
-          (attributes[:namespaces] ||= {})[:node_ns] ||= ns if ns
-          super tag, value, parent, attributes
-        end
-
-        protected
-
-        def get_nodes(tag, parent = nil)
-          parent ||= root
-          m = /^([\/\.]*\/)?(dc(?:terms)?:)?(.*)/.match(tag.to_s)
-          return [] unless m[3]
-          path = (m[1] || '')
-          ns, tag = get_namespace(tag)
-          path += "#{ns}:" if ns
-          path += tag
-          parent.xpath(path)
-        end
-
-        def get_namespace(tag)
-          m = /^((dc)?(terms)?(?:_|:)?)?([a-zA-Z_][-_.0-9a-zA-Z]+)(.*)/.match tag
-          ns = if m[1].blank?
-                   if DC_ELEMENTS.include?(m[4])
-                     :dc
-                   else
-                     DCTERMS_ELEMENTS.include?(m[4]) ? :dcterms : nil
-                   end
-               elsif m[3].blank?
-                 :dc
-               else
-                 :dcterms
-               end
-          [ns, "#{m[4]}#{m[5]}"]
-        end
-
-      end
-
-    end
-  end
-end

data/lib/libis/tools/metadata/field_format.rb

@@ -1,121 +0,0 @@
-# coding: utf-8
-
-module Libis
-  module Tools
-    module Metadata
-
-      # Helper class for formatting field data.
-      #
-      # The FieldFormat class can omit prefix and or postfix if no data is present and omits the join string if only
-      # one data element is present.
-      class FieldFormat
-
-        # [Array] the list that makes up the data
-        attr_accessor :parts
-
-        # [String] the text that will be placed in front of the generated text
-        attr_accessor :prefix
-
-        # [String] the text that will be placed at the end of the generated text
-        attr_accessor :postfix
-
-        # [String] the text used between the parts of the data
-        attr_accessor :join
-
-        # Create new formatter
-        #
-        # The method takes any number of arguments and processes them as data parts. If the last one is a Hash, it is
-        # interpreted as options hash. The data parts can either be given as an Array or set of arguments or within the
-        # options hash with key +:parts+.
-        #
-        # On each element in the data set the formatter will call the #to_s method to
-        # give each data object the opportunity to process it's data.
-        #
-        # @param [Array, Hash] parts whatever makes up the data to be formatted.
-        def initialize(*parts)
-          @parts = []
-          self[*parts]
-        end
-
-        # Parses the arguments, stripping of an optional last Hash as options.
-        # @param (see #initialize)
-        def [](*parts)
-          options = parts.last.is_a?(Hash) ? parts.pop : {}
-          add parts
-          x = options.delete(:parts)
-          add x if x
-          add_options options
-        end
-
-        # Set options.
-        #
-        # Besides the tree options +:prefix+, +:postfix+ and +:join+ it also accepts the option +:fix+. This combines
-        # both +:prefix+ and +:postfix+ options by specifying "<prefix>|<postfix>". If both prefix and postfix are only
-        # 1 character wide the format "<prefix><postfix>" is also allowed.
-        #
-        # @param [Hash] options the options list
-        def add_options(options = {})
-          if options[:fix]
-            if options[:fix].size == 2
-              @prefix, @postfix = options[:fix].split('')
-            else
-              @prefix, @postfix = options[:fix].split('|')
-            end
-          end
-          @join = options[:join] if options[:join]
-          @prefix = FieldFormat::from(options[:prefix]) if options[:prefix]
-          @postfix = FieldFormat::from(options[:postfix]) if options[:postfix]
-          self
-        end
-
-        # Add default options.
-        # (see #add_options)
-        # None of these options will be set if they are already set. If you need to overwrite them, use {#add_options}.
-        # @param (see #add_options)
-        def add_default_options(options = {})
-          options.delete(:prefix) if @prefix
-          options.delete(:postfix) if @postfix
-          options.delete(:fix) if @prefix or @postfix
-          options.delete(:join) if @join
-          add_options options
-        end
-
-        # Shortcut class method for initializer
-        def self.from(*h)
-          self.new(*h)
-        end
-
-        # The real formatter method.
-        # This method parses the data and applies the options to generate the formatted string.
-        # @return [String] the formatter string
-        def to_s
-          @parts.delete_if { |x|
-            x.nil? or
-                (x.is_a? String and x.empty?) or
-                (x.is_a? Libis::Tools::Metadata::FieldFormat and x.to_s.empty?)
-          }
-          result = @parts.join(@join)
-          unless result.empty?
-            result = (@prefix || '').to_s + result + (@postfix || '').to_s
-          end
-          result
-        end
-
-        protected
-
-        def add(part)
-          case part
-            when Hash
-              @parts << Libis::Tools::Metadata::FieldFormat::from(part)
-            when Array
-              part.each { |x| add x }
-            else
-              @parts << part
-          end
-        end
-
-      end
-
-    end
-  end
-end