fieldhand 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c1ca08a8fb6ab7682f308d7cb2ffe4ac3cc0829d
-  data.tar.gz: dea8d65de365fb51ef9788e4cfd4c34dd11af2b4
+  metadata.gz: fe77387e599f04fe11981420174c0c53c6f1b3ce
+  data.tar.gz: f3bc88686b42bca448c52a06988273dcae890b8f
 SHA512:
-  metadata.gz: e797e8d9625730ac9bed36bbeaae6fb8d490695e6b165a94f7e48ea0b743d8c4f95322bbd3c119533a2a446a5014a1e90fd1adcc96a003bceba83cc61a8a9fa1
-  data.tar.gz: '0295cc11eb9ad3f6c6782022cf1f06953aa4675ef608a32c9dc9cb363f1733750f08bedd3e69870d1973d031e8ed6366a1ff509a951818bcb3985fe72d1db6c6'
+  metadata.gz: aac19ca6cdda6acc837c4d8f2e33874fccaa30ee91b3e78e9f0e0a5948b93712785507e960a3c13cfa55da963695b7ce695ddd86333358041335868ee6dca6bd
+  data.tar.gz: e1dfdb2adf541cf2a4dc2c3cfbe39da2b5843595b484ff6a7fcf31f22694431a38b09dcbbbc855d6ee3426ad789ce3fcea45f4263f215b62001be4cf076c8f48

data/README.md

@@ -2,19 +2,19 @@
 
 A Ruby library for harvesting metadata from [OAI-PMH](https://www.openarchives.org/OAI/openarchivesprotocol.html) repositories.
 
-**Current version:** 0.2.0  
+**Current version:** 0.3.0  
 **Supported Ruby versions:** 1.8.7, 1.9.2, 1.9.3, 2.0, 2.1, 2.2
 
 ## Installation
 
 ```
-gem install fieldhand -v '~> 0.2'
+gem install fieldhand -v '~> 0.3'
 ```
 
 Or, in your `Gemfile`:
 
 ```ruby
-gem 'fieldhand', '~> 0.2'
+gem 'fieldhand', '~> 0.3'
 ```
 
 ## Usage
@@ -286,10 +286,10 @@ Returns the compression encodings supported by the repository as an `Array` of `
 
 ```ruby
 repository.identify.descriptions
-#=> [#<Ox::Element...>]
+#=> ["<description>..."]
 ```
 
-Returns XML elements describing this repository as an `Array` of [`Ox::Element`][Element]s.
+Returns descriptions of this repository as an `Array` of `String`s.
 
 As descriptions can be in any format, Fieldhand doesn't attempt to parse descriptions but leaves parsing to the client.
 
@@ -368,10 +368,10 @@ Return a short human-readable `String` naming the set.
 
 ```ruby
 repository.sets.first.descriptions
-#=> [#<Ox::Element: ...>]
+#=> ["<setDescription>..."]
 ```
 
-Return an `Array` of [`Ox::Element`][Element]s of any optional and repeatable containers that may hold community-specific XML-encoded data about the set.
+Return an `Array` of `String`s of any optional and repeatable containers that may hold community-specific XML-encoded data about the set.
 
 #### `Fieldhand::Set#response_date`
 
@@ -439,10 +439,10 @@ Return an `Array` of `String` [set specs](#fieldhandsetspec) indicating set memb
 
 ```ruby
 repository.records.first.metadata
-#=> #<Ox::Element: ...>
+#=> "<metadata>..."
 ```
 
-Return a single manifestation of the metadata from a record as [`Ox::Element`][Element]s or `nil` if this is a deleted record.
+Return a single manifestation of the metadata from a record as a `String` or `nil` if this is a deleted record.
 
 As the metadata can be in [any format supported by the repository](#fieldhandrepositorymetadata_formatsidentifier), Fieldhand doesn't attempt to parse the metadata but leaves parsing to the client.
 
@@ -450,10 +450,10 @@ As the metadata can be in [any format supported by the repository](#fieldhandrep
 
 ```ruby
 repository.records.first.about
-#=> [#<Ox::Element: ...>]
+#=> ["<about>..."]
 ```
 
-Return an `Array` of [`Ox::Element`][Element]s of any optional and repeatable containers holding data about the metadata part of the record.
+Return an `Array` of `String`s of any optional and repeatable containers holding data about the metadata part of the record.
 
 #### `Fieldhand::Record#response_date`
 
@@ -585,7 +585,6 @@ This can be used to rescue all the following child error types.
   [Enumerator]: https://ruby-doc.org/core/Enumerator.html
   [Time]: https://ruby-doc.org/core/Time.html
   [URI]: https://ruby-doc.org/stdlib/libdoc/uri/rdoc/URI.html
-  [Element]: http://www.rubydoc.info/github/ohler55/ox/Ox/Element
 
 ## Acknowledgements
 

data/lib/fieldhand/record.rb

@@ -1,4 +1,5 @@
 require 'fieldhand/header'
+require 'ox'
 
 module Fieldhand
   # A record is metadata expressed in a single format.
@@ -33,11 +34,11 @@ module Fieldhand
     end
 
     def metadata
-      @metadata ||= element.locate('metadata[0]').first
+      @metadata ||= element.locate('metadata[0]').map { |metadata| Ox.dump(metadata) }.first
     end
 
     def about
-      @about ||= element.locate('about')
+      @about ||= element.locate('about').map { |about| Ox.dump(about) }
     end
 
     def header

data/lib/fieldhand/set.rb

@@ -1,3 +1,5 @@
+require 'ox'
+
 module Fieldhand
   # A set is an optional construct for grouping items for the purpose of selective harvesting.
   #
@@ -23,7 +25,7 @@ module Fieldhand
     end
 
     def descriptions
-      @descriptions ||= element.locate('setDescription')
+      @descriptions ||= element.locate('setDescription').map { |description| Ox.dump(description) }
     end
   end
 end

data/spec/fieldhand/record_spec.rb

@@ -19,6 +19,22 @@ module Fieldhand
       end
     end
 
+    describe '#metadata' do
+      it 'returns nil if there is no metadata' do
+        element = ::Ox.parse('<record/>')
+        record = described_class.new(element)
+
+        expect(record.metadata).to be_nil
+      end
+
+      it 'returns the metadata as a string' do
+        element = ::Ox.parse('<record><metadata>Foo</metadata></record>')
+        record = described_class.new(element)
+
+        expect(record.metadata).to eq("\n<metadata>Foo</metadata>\n")
+      end
+    end
+
     describe '#about' do
       it 'returns an empty array if there are no about elements' do
         element = ::Ox.parse('<record/>')
@@ -33,6 +49,13 @@ module Fieldhand
 
         expect(record.about.size).to eq(2)
       end
+
+      it 'returns about sections as strings' do
+        element = ::Ox.parse('<record><about>Foo</about><about>Bar</about></record>')
+        record = described_class.new(element)
+
+        expect(record.about).to contain_exactly("\n<about>Foo</about>\n", "\n<about>Bar</about>\n")
+      end
     end
 
     describe '#response_date' do

data/spec/fieldhand/set_spec.rb

@@ -17,6 +17,14 @@ module Fieldhand
 
         expect(set.descriptions.size).to eq(2)
       end
+
+      it 'returns descriptions as strings' do
+        element = ::Ox.parse('<set><setDescription>Foo</setDescription><setDescription>Bar</setDescription></set>')
+        set = described_class.new(element)
+
+        expect(set.descriptions).
+          to contain_exactly("\n<setDescription>Foo</setDescription>\n", "\n<setDescription>Bar</setDescription>\n")
+      end
     end
 
     describe '#to_s' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fieldhand
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Paul Mucur