metacrunch-mab2 1.2.1 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1f3f60e61efdc2d800bb156ef2af37b56f005d97
-  data.tar.gz: d08b0a6f38b526dbbc29c301c84461b30e7e41f7
+  metadata.gz: 4fcb5d4bd47931fef5a39adc312f460f39e2b66b
+  data.tar.gz: 03cc9ab6343d93a805f4863e590436f5698de5d6
 SHA512:
-  metadata.gz: 8e727ba7003c508232814161f26ffad6b5a496d20376a82bb35e7bc30256535730a6b2e9a74a09e833565654dcb76950d04a76cf9234743be386fbae19dcac5d
-  data.tar.gz: 9cd3dfaf0acf24f3a9c581380a07477c7280df0e964e17c9bd7ec53db0b8d3e0db67cee4ca7eed12de2088417056aeb11d7ec22cb510c064c0bc8a0f406787b4
+  metadata.gz: a442e7314ef015a6efb7f41c1eaec8cc60fd79449c5404916a95b87d5ca2932e7082bc8ace503f56b65c0d12cb07c619369c703b1a1546ddc00a7eb1ec623090
+  data.tar.gz: 71ee09c43f5f725ffe6da22c34e82998fa1781037ee53c2abed1756b4c3a9a1c2b0b08ac309c7c4985e05e6ac23c739aea1ef50966a1cee7568f29a41bea630a

data/Readme.md

@@ -1,6 +1,69 @@
-# metacrunch-mab2
+metacrunch-mab2
+===============
 
 [![Code Climate](https://codeclimate.com/github/ubpb/metacrunch-mab2/badges/gpa.svg)](https://codeclimate.com/github/ubpb/metacrunch-mab2)
 [![Build Status](https://travis-ci.org/ubpb/metacrunch-mab2.svg)](https://travis-ci.org/ubpb/metacrunch-mab2)
 
-Dokumentation folgt in Kürze...
+This is the official MAB2 package for the [metacrunch ETL toolkit](https://github.com/ubpb/metacrunch). It allows you to parse [MAB](https://de.wikipedia.org/wiki/Maschinelles_Austauschformat_f%C3%BCr_Bibliotheken) data and gives you access to the data by a simple and powerful API.
+
+*Note: There is no runtime dependency to metacrunch, so it's fine to use this gem in any Ruby application where you need to read or manipulate MAB data.*
+
+
+Installation
+------------
+
+```
+$ gem install metacrunch-mab2
+```
+
+
+Usage example
+-------------
+
+For the full API look at the files in [https://github.com/ubpb/metacrunch-mab2/tree/master/lib/metacrunch/mab2](https://github.com/ubpb/metacrunch-mab2/tree/master/lib/metacrunch/mab2)
+
+**Loading the library**
+```ruby
+require "metacrunch/mab2"
+```
+
+**Parsing a [MAB XML file](https://github.com/ubpb/metacrunch-mab2/blob/master/spec/assets/aleph_mab_xml/file1.xml)**
+```ruby
+document = Metacrunch::Mab2::Document.from_mab_xml(File.read("my/mab.xml"))
+```
+
+**Accessing control fields**
+```ruby
+document.controlfield("LDR")
+
+# <Metacrunch::Mab2::Document::Controlfield:0x007f98061b4b08
+# @tag="LDR",
+# @values=["-", "-", "-", "-", "-", "-", "M", "2", ".", "0", "1", "2", "0", "0", "0", "2", "4", "-", "-", "-", "-", "-", "-", "h"]>
+```
+
+**Accessing data fields**
+```ruby
+document.datafields("100")
+
+#<Metacrunch::Mab2::Document::DatafieldSet:0x007f98052e5af0
+# @datafields=
+#  [#<Metacrunch::Mab2::Document::Datafield:0x007f98061a5ea0
+#    @ind1="-",
+#    @ind2="1",
+#    @subfields=
+#     {"p"=>[#<Metacrunch::Mab2::Document::Subfield:0x007f98061a5dd8 @code="p", @value="Kofler, Michael">],
+#      "d"=>[#<Metacrunch::Mab2::Document::Subfield:0x007f98061a5ce8 @code="d", @value="1967-">],
+#      "9"=>[#<Metacrunch::Mab2::Document::Subfield:0x007f98061a5bf8 @code="9", @value="(DE-588)121636763">]},
+#    @tag="100">]>
+```
+
+```ruby
+document.datafields("100", ind1: :blank).subfields("p").value
+
+# Kofler, Michael
+```
+
+License
+-------
+
+metacrunch-mab2 is available at [github](https://github.com/ubpb/metacrunch-mab2) under [MIT license](https://github.com/ubpb/metacrunch-mab2/blob/master/License.txt).

data/bin/console

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 require "bundler/setup"
-require "metacrunch"
+require "metacrunch/mab2"
 
 begin
   require "pry"

data/lib/metacrunch/mab2/document.rb

@@ -21,10 +21,17 @@ module Metacrunch
       # @param [String] xml repesenting a MAB document in Aleph MAB XML format
       # @return [Metacrunch::Mab2::Document]
       #
-      def self.from_aleph_mab_xml(xml)
+      def self.from_mab_xml(xml)
         MabXmlParser.new.parse(xml)
       end
 
+      # TODO: Remove form 2.0
+      def self.from_aleph_mab_xml(xml)
+        d = ActiveSupport::Deprecation.new("2.0", "metacrunch-mab2")
+        d.deprecation_warning("#from_aleph_mab_xml", "use #from_mab_xml instead")
+        self.from_mab_xml(xml)
+      end
+
       def initialize
         @controlfields = {}
         @datafields = {}

data/lib/metacrunch/mab2/version.rb

@@ -1,5 +1,5 @@
 module Metacrunch
   module Mab2
-    VERSION = "1.2.1"
+    VERSION = "1.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: metacrunch-mab2
 version: !ruby/object:Gem::Version
-  version: 1.2.1
+  version: 1.3.0
 platform: ruby
 authors:
 - René Sprotte
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-04-25 00:00:00.000000000 Z
+date: 2016-07-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport