mab2 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ddffd930eea7cf17107898031a771fc6dad90be
-  data.tar.gz: b05ecb5a0ac27dfd41c2b6abec9d198a24db5031
+  metadata.gz: 91501bcd9e26b7515c4e60e93b552a1b5a698f49
+  data.tar.gz: 8adb6ae2b71b4c392c3c974194f971a648badfae
 SHA512:
-  metadata.gz: fa6d7aac578e249cd39daf51aba91ccacd0430e9950326521637d659703eac0fc0c9733fe65cbe557db5f8b8b8959c792ca216cd1c7cd7bf3469e4fdc3af9dbf
-  data.tar.gz: 4037cb77b8a966576f3e8e7cb0b78fb7393a2410d50b67956392848cb6f03e594e315c52ea640b17754fef00f8bd3c858f42a0d5303a9a2e9c46987b9747b3f2
+  metadata.gz: 554ec9a0c4a6396fd1ba9ed14c4efe8bf4bd3086c4f5a0c6c1955f857b1cdde6f9324f84ddca3ec918b1e66965b182338978912a426f86801f028e163d9d48ef
+  data.tar.gz: 681cb470282c20a3e8488131577dc432eb3fbcfe3c81dfc5d5dab9afd4c16059597e82ba4d484c7e8f6834504cc8a38291b90ec04bd79e912b771935f7b05769

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format documentation
+--require spec_helper

data/Gemfile

@@ -1,6 +1,20 @@
-source 'https://rubygems.org'
-
-gem 'badgerfish', path: '~/github/msievers/badgerfish'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in mab2.gemspec
 gemspec
+
+if !ENV["CI"]
+  group :development do
+    gem "pry",                "~> 0.9.12.6"
+    gem "pry-byebug",         "<= 1.3.2"
+    gem "pry-rescue",         "~> 1.4.1"
+    gem "pry-stack_explorer", "~> 0.4.9.1"
+    gem "pry-syntax-hacks",   "~> 0.0.6"
+  end
+end
+
+group :test do
+  gem "codeclimate-test-reporter", require: nil
+end
+
+gem "badgerfish", github: "msievers/badgerfish", branch: :master

data/Rakefile

@@ -1,8 +1,6 @@
-require 'bundler/gem_tasks'
-require 'rake/testtask'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
-Rake::TestTask.new do |t|
-  t.pattern = 'test/test_*.rb'
-end
+RSpec::Core::RakeTask.new(:spec)
 
-task :default => :test
+task :default => :spec

data/lib/mab2.rb

@@ -1,4 +1,5 @@
+require "mab2/version"
+
 module Mab2
-  require 'mab2/document'
-  require 'mab2/version'
+  require_relative "mab2/document"
 end

data/lib/mab2/document.rb

@@ -1,75 +1,102 @@
-require 'mab2/aleph_sequential_adapter'
-require 'mab2/mab_xml_adapter'
+require "active_support"
+require "active_support/core_ext"
+require "badgerfish"
 
 class Mab2::Document
-  require_relative 'document/datafield'
-  require_relative 'document/scope'
-  require_relative 'document/subfield'
+  require_relative "./document/scope"
 
-  attr_accessor :controlfields
-  attr_accessor :datafields
+  attr_accessor :legacy_mabmapper_mode
 
-  def initialize(input)
-    mab = if input.is_a?(Mab2::MabXmlAdapter) || input.is_a?(Mab2::AlephSequentialAdapter)
-      input
-    elsif input.is_a?(String) && input.starts_with?('<?xml')
-      Mab2::MabXmlAdapter.new(input)
-    elsif input.is_a?(String) && input.starts_with?('LEADER')
-      Mab2::AlephSequentialAdapter.new(input)
+  def initialize(xml, options = {})
+    @badgerfish_hash = Badgerfish::Parser.new.load(xml, options)
+
+    # the original mabmapper dsl is buggy at certain points, but this
+    # behaviour might be needed for certain legacy rules
+    @legacy_mabmapper_mode =
+    if options[:legacy_mabmapper_mode].nil?
+      false
     else
-      raise 'Unknown input format or adapter!'
+      !!options[:legacy_mabmapper_mode]
     end
 
-    @controlfields = mab.controlfields
-    @datafields = mab.datafields
+    create_controlfields_tag_index
+    create_datafields_tag_index
   end
 
   #
-  # scope functions
+  # dsl methods
   #
   def controlfield(tag)
-    tag = tag.to_sym # tag should be a symbol
-    Mab2::Document::Scope.new(self).controlfield(tag)
+    controlfields_by_tag(tag)
+    .first
+    .try do |controlfield|
+      controlfield["$"].chars.map! do |char|
+        char == "|" ? nil : char
+      end
+    end || []
+  end
+ 
+  def doc
+    self
   end
 
-  # mabmapper uses field instead of datafield
-  def field(tag, indicators = {})
-    tag = tag.to_sym                                                                                          # tag should be a symbol
-    indicators.each_pair { |key, val| indicators[key] = val.is_a?(Array) ? val.map(&:to_sym) : [val.to_sym] } # indicators should be hash of symbol arrays
-    Mab2::Document::Scope.new(self).datafield(tag, indicators)
+  def field(tag, options = {})
+    Scope.new(options.merge(document: self, tag: tag))
   end
 
   #
-  # query functions
+  # other public methods
   #
-  def controlfields_by(options = {})
-    (result = @controlfields[options[:tag]]).nil? ? [] : result.chars
+  def controlfields_by_tag(tag)
+    (@controlfields_tag_index[tag] || []).map do |index|
+      controlfields[index]
+    end
   end
 
-  def datafields_by(options = {})
-    indicators = options[:indicators]
-    tag = options[:tag]
-    query_result = []
+  def datafields_by_tag(tag)
+    (@datafields_tag_index[tag] || []).map do |index|
+      datafields[index]
+    end
+  end
 
-    return [] if @datafields[tag].nil? # shortcut for 'no datafield with that tag exists'
+  def legacy_mabmapper_mode?
+    @legacy_mabmapper_mode
+  end
 
-    matching_datafields = @datafields[tag].select do |indicator_one_key, indicator_one_value|
-      indicators[:ind1].nil? || (indicators[:ind1].any? { |ind1| ind1.length > 1 && ind1.to_s.starts_with?('-') } ^ indicators[:ind1].include?(indicator_one_key)) && indicator_one_value.any? do |indicator_two_key, indicator_two_value|
-        indicators[:ind2].nil? || indicators[:ind2].include?(indicator_two_key)
+  #
+  private
+  #
+  def create_controlfields_tag_index
+    controlfields.each.with_index.inject(@controlfields_tag_index = {}) do |index, (controlfield, index_within_array)|
+      index.tap do |_index|
+        (_index[controlfield["@tag"]] ||= []).push(index_within_array)
       end
     end
+  end
 
-    if !matching_datafields.nil?
-      matching_datafields.each_pair do |indicator_one_key, indicator_one_value|
-        indicator_one_value.each_pair do |indicator_two_key, indicator_two_value|
-          indicator_two_value.each do |subfields|
-            query_result.push Mab2::Document::Datafield.new(tag, indicators, subfields)
-          end
-        end
+  def create_datafields_tag_index
+    datafields.each.with_index.inject(@datafields_tag_index = {}) do |index, (datafield, index_within_array)|
+      index.tap do |_index|
+        (_index[datafield["@tag"]] ||= []).push(index_within_array)
       end
     end
+  end
 
-    return query_result
+  def controlfields
+    @controlfields ||=
+    begin
+      @badgerfish_hash["OAI-PMH"]["ListRecords"]["record"]["metadata"]["record"]["controlfield"].try do |controlfields|
+        controlfields.is_a?(Array) ? controlfields : [controlfields]
+      end || []
+    end
   end
 
+  def datafields
+    @datafields ||=
+    begin
+      @badgerfish_hash["OAI-PMH"]["ListRecords"]["record"]["metadata"]["record"]["datafield"].try do |datafields|
+        datafields.is_a?(Array) ? datafields : [datafields]
+      end || []
+    end
+  end
 end

data/lib/mab2/document/scope.rb

@@ -1,56 +1,116 @@
-class Mab2::Document::Scope
+require "active_support"
+require "active_support/core_ext"
+require "mab2/document"
 
-  def initialize(document)
-    @document = document
+class Mab2::Document::Scope
+  class Subfield < Struct.new(:code, :value)
+    alias_method :name, :code
   end
 
-  def controlfield(tag)
-    @document.controlfields_by(tag: tag)
+  def initialize(options = {})
+    @document = options[:document]
+    @ind1 = [options[:ind1]].flatten(1).compact
+    @ind2 = [options[:ind2]].flatten(1).compact
+    @tag = options[:tag]
+    @subfield = [options[:subfield]].flatten(1).compact
+
+    # negation extraction
+    @ind1.delete_if do |ind1|
+      if ind1.start_with?("-") && ind1.length > 1
+        (@not_ind1 ||= []).push(ind1[1..-1])
+        true
+      end
+    end
   end
 
-  def datafield(tag, indicators = {})
-    @scope_datafields = @document.datafields_by(tag: tag, indicators: indicators)
+  def get
     self
   end
 
-  def subfield(subfield_codes)
-    subfield_codes = subfield_codes.is_a?(Array) ? subfield_codes : [subfield_codes] # subfield_codes should be an array
+  def get_subfield(code)
+    [datafields.first["subfield"]].compact.flatten(1)
+    .try(:find) do |subfield|
+      subfield["@code"] == code
+    end
+    .try do |subfield|
+      Subfield.new(subfield["@code"], subfield["$"])
+    end || Subfield.new
+  end
 
-    @scope_subfields = @scope_datafields.map do |datafield|
-      datafield.subfields.select { |subfield| subfield_codes.include? subfield.name.to_s }
-    end.flatten! || []
+  def fields
+    datafields.map do |datafield|
+      self.class.new({
+        document: @document,
+        ind1: datafield["@ind1"],
+        ind2: datafield["@ind2"],
+        tag: datafield["@tag"]
+      })
+    end
+  end
 
-    self
+  def subfield(codes)
+    self.class.new(to_options.merge(subfield: codes))
+  end
+
+  def subfields
+    datafields.map do |datafield|
+      [datafield["subfield"]].compact.flatten(1).try(:map) do |subfield|
+        Subfield.new(subfield["@code"], subfield["$"])
+      end
+    end.compact.flatten(1) || []
   end
 
   def value(options = {})
-    values.first
+    separator = options[:join_subfields] || " "
+
+    if @document.legacy_mabmapper_mode?
+      values.first.join(separator)
+    else
+      values.map(&:presence).compact.first.try(:join, separator)
+    end
   end
 
   def values(options = {})
-    unless @scope_values
-      # if no subfields where specified so far, take all (e.g. doc.datafield('100').values))
-      @scope_subfields ||= (@scope_datafields.map { |datafield| datafield.subfields }).flatten! || []
-      subfield_values = @scope_subfields.map { |subfield| subfield.value }
-      @scope_values = options[:join_subfields] ? subfield_values.join(options[:join_subfields]) : subfield_values
-    else
-      @scope_values
+    datafields
+    .map do |field|
+      [field["subfield"]].compact.flatten(1)
+      .select do |subfield|
+        @subfield.empty? || @subfield.include?(subfield["@code"])
+      end
+      .map do |subfield|
+        subfield["$"]
+      end
+      .try do |subfield_values|
+        if separator = options[:join_subfields]
+          subfield_values.join(separator)
+        else
+          subfield_values
+        end
+      end
     end
   end
 
   #
-  # compatibility
+  private
   #
-  def get
-    self
-  end
-
-  def fields
-    @scope_datafields
+  def datafields
+    @document.datafields_by_tag(@tag)
+    .dup
+    .tap do |fields|
+      fields.select! do |field|
+        (@ind1.empty? || @ind1.include?(field["@ind1"]) || (@not_ind1.present? && !@not_ind1.include?(field["@ind1"]))) &&
+        (@ind2.empty? || @ind2.include?(field["@ind2"]))
+      end
+    end
   end
 
-  def subfields
-    @scope_subfields
+  def to_options
+    {
+      document: @document,
+      ind1: @ind1,
+      ind2: @ind2,
+      tag: @tag,
+      subfield: @subfield
+    }
   end
-
 end

data/lib/mab2/version.rb

@@ -1,3 +1,3 @@
 module Mab2
-  VERSION = "0.0.4"
+  VERSION = "0.1.0"
 end

data/mab2.gemspec

@@ -1,29 +1,27 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'mab2/version'
+require "mab2/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'mab2'
+  spec.name          = "mab2"
   spec.version       = Mab2::VERSION
   spec.authors       = ["Michael Sievers"]
-  spec.email         = ["michael_sievers@web.de"]
-  spec.description   = %q{Simplifies access and handling of MAB documents}
+  spec.description   = %q{Simplifies access and handling of Mab documents}
   spec.summary       = %q{Implementation if the mabmapper DSL}
-  spec.homepage      = 'https://github.com/msievers/mab2'
-  spec.license       = 'MIT'
+  spec.homepage      = "https://github.com/msievers/mab2"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ["lib"]
 
-  spec.add_dependency 'nokogiri', '~> 1.6.0'
+  spec.add_dependency "activesupport"
+  spec.add_dependency "badgerfish",            ">= 0.2.0"
 
-  spec.add_development_dependency 'activesupport', '>= 3.2.0', '< 4.0.0'
-  spec.add_development_dependency 'bundler',       '~> 1.3'
-  spec.add_development_dependency 'minitest',      '~> 5.0.6'
-  spec.add_development_dependency 'pry',           '~> 0.9.12.2'
-  spec.add_development_dependency 'pry-nav',       '~> 0.2.3'
-  spec.add_development_dependency 'rake'
+  spec.add_development_dependency "bundler",   "~> 1.7"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec",     ">= 3.0.0"
+  spec.add_development_dependency "simplecov", ">= 0.8.0"
 end

data/{test/mab_files/dsl_2.xml → spec/assets/mab_files/mab.xml}

@@ -4,32 +4,24 @@
     <record>
       <metadata>
         <record xmlns="http://www.ddb.de/professionell/mabxml/mabxml-1.xsd">
-          <datafield tag="PSW" ind1="-" ind2="1">
-            <subfield code="s">Politik</subfield>
-            <subfield code="x">Theorie</subfield>
-            <subfield code="9">(DE-588)4046563-9</subfield>
+          <controlfield tag="050">a|||||||||||||</controlfield>
+          <datafield tag="100" ind1="1" ind2="2">
+            <subfield code="a">Some string</subfield>
           </datafield>
-          <datafield tag="PSW" ind1="-" ind2="1">
+          <datafield tag="PSW" ind1="1" ind2="1">
             <subfield code="s">Politiktheorie</subfield>
             <subfield code="9">(DE-588)4046563-9</subfield>
           </datafield>
-          <datafield tag="PSW" ind1="-" ind2="1">
-            <subfield code="s">Politische Theorien</subfield>
-            <subfield code="9">(DE-588)4046563-9</subfield>
-          </datafield>
           <datafield tag="PSW" ind1="-" ind2="1">
             <subfield code="s">Politik</subfield>
             <subfield code="x">Theorie</subfield>
             <subfield code="9">(DE-588)4046563-9</subfield>
           </datafield>
-          <datafield tag="PSW" ind1="-" ind2="1">
-            <subfield code="s">Politiktheorie</subfield>
-            <subfield code="9">(DE-588)4046563-9</subfield>
-          </datafield>
-          <datafield tag="PSW" ind1="-" ind2="1">
+          <datafield tag="PSW" ind1="1" ind2="2">
             <subfield code="s">Politische Theorien</subfield>
             <subfield code="9">(DE-588)4046563-9</subfield>
           </datafield>
+          <controlfield tag="SYS">000978177</controlfield>
         </record>
       </metadata>
     </record>

data/spec/mab2/document/scope/subfield_spec.rb

@@ -0,0 +1,34 @@
+describe Mab2::Document::Scope::Subfield do
+  let(:code)  { "s" }
+  let(:value) { "Politiktheorie" }
+
+  let(:subfield) do
+    described_class.new(code, value)
+  end
+
+  describe "#initialize" do
+    context "if callend with a code and a value" do
+      it "returns an instance of #{described_class}" do
+        expect(subfield).to be_a(described_class)
+      end
+    end
+  end
+
+  describe "#code" do
+    it "returns the code of the subfield" do
+      expect(subfield.code).to eq(code)
+    end
+  end
+
+  describe "#name" do
+    it "is an alias for #code" do
+      expect(subfield.name).to eq(subfield.code)
+    end
+  end
+
+  describe "#value" do
+    it "returns the value of the subfield" do
+      expect(subfield.value).to eq(value)
+    end
+  end
+end