relaton 1.7.pre7 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 669c9390b4e3b0a3be1a928f3a13db65cff18d9e36d1ee434662ebccab367402
-  data.tar.gz: 9d285c4d6e00df82eb38baff1a191d8a4527456d689556312db1bef74c1fc364
+  metadata.gz: c04670d96d910f7279ae306322df75cc9939ce240c37fb237716f97877207029
+  data.tar.gz: f25fc7f76f03fa90dcbe18c881b8781353e55dc9f867af5464cdcd0423d76be9
 SHA512:
-  metadata.gz: f0489929bc69ac678f9a3b5b2f4a73961102d72e9f0917807a422dbf495d3319b94e84c11cdfb46fc9cc423a523f04af20a1bacdd6964988e9deb2a87676470a
-  data.tar.gz: 792fa2b3c0cf6f95362ff7039c867ec57766fe691fb75dd71e0413b77c3982b3bfdf7ee57748ae4de9aaea18b2e76a1f0c3ae67eb9c01a81ec594865e4a20531
+  metadata.gz: e858712ad2f9691936dfd5af9563896be74447eb4985cd1b56ede9a2e283fb6205f1ef791a9d4bc2921376e0346a8ac826ec1666abf3199f212d483bc007628e
+  data.tar.gz: '08b9ada0c3c65394c8301c5bbc9b0cb025ba0cf94c64dd042aec313fbb124740a6f55e91a3d8a5e2e1952f79517130ffc28b0cd2fc4b5ca8106998723e74fb9c'

data/.github/workflows/macos.yml

@@ -0,0 +1,34 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: macos
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-macos:
+    name: Test on Ruby ${{ matrix.ruby }} macOS
+    runs-on: macos-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          sudo gem install bundler --force
+          ruby -v | grep 2.5 && bundle config set build.debase --with-cflags="-Wno-error=implicit-function-declaration"
+          ruby -v | grep 2.5 && bundle config set build.ruby-debug-ide --with-cflags="-Wno-error=implicit-function-declaration"
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/ubuntu.yml

@@ -0,0 +1,32 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: ubuntu
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-linux:
+    name: Test on Ruby ${{ matrix.ruby }} Ubuntu
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        run: |
+          gem install bundler
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/.github/workflows/windows.yml

@@ -0,0 +1,35 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: windows
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ '**' ]
+
+jobs:
+  test-windows:
+    name: Test on Ruby ${{ matrix.ruby }} Windows
+    runs-on: windows-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: [ '2.6', '2.5', '2.4' ]
+    steps:
+      - uses: actions/checkout@master
+      - name: Use Ruby
+        uses: actions/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          architecture: 'x64'
+      - name: Update gems
+        shell: pwsh
+        run: |
+          gem install bundler
+          bundle config --local path vendor/bundle
+          bundle update
+          bundle install --jobs 4 --retry 3
+      - name: Run specs
+        run: |
+          bundle exec rake

data/docs/README.adoc

@@ -62,13 +62,6 @@ e.g. `get("ISO 19115-1", "2014", all_parts: true)` is transformed into a referen
 
 == Usage
 
-=== Create DB
-
-`Relaton::Db#new(globalcache, localcache)` creates new DB. Returns Relaton::Db instance.
-
-* `globalcache` - (String or nil) path to globalcache directory
-* `localcache` - (String or nil) path to localcache directory
-
 [source,ruby]
 ----
 require "relaton"
@@ -100,51 +93,7 @@ db = Relaton::Db.new("globalcache", "localcache")
  @local_db=#<Relaton::DbCache:0x007faabc8fa5c0 @dir="localcache", @ext="xml">,
  @local_db_name="localcache",
 ...
-----
-
-=== Modify DB
-
-==== Move DB
-
-`Relaton::Db#mv(new_dir, type: :global)` moves DB directory to new location. Returns path to new directory if successful, or `nil` if target directiory exists.
-
-* `new_dir` - (String) new cache location
-* `type` - (Symbol) type of cache DB. Allowed values are: `:global`, `:local`. Default is `:global`.
-
-[source,ruby]
-----
-db.mv("new_global_dir")
-=> "new_global_dir"
-
-db.mv("new_local_dir", type: :local)
-=> "new_local_dir"
-----
 
-==== Clear DB
-
-`Relaton::Db#clear` removes all entries form DB
-
-=== Fetch documens
-
-==== Fetch document by references
-
-There are 3 fetching methods:
-
-* `Relaton::Db#fetch(reference, year, options)` - fetches document from local cache or remote source.
-* `Relaton::Db#fetch_db(reference, year, options)` - fetches document from local cache
-* `Relaton::Db#fetch_async(reference, year, options, &block)` - fetches document asynchronously
-
-Arguments:
-
-* `reference` - (String) reference to fethc document
-* `year` - (String or nil) year to filter relult (optional)
-* `options` - (Hash) hash of options. Alloved options:
-- `:all_parts` - (Boolean) should be `true` if all-parts reference is required
-- `:keep_yer` - (Boolean) should be `true` if undated reference should return actual reference with year
-- `:retries` - (Number) number of network retries. Default 1
-
-[source,ruby]
-----
 x = db.fetch("IEEE 19011")
 [relaton-ieee] ("IEEE 19011") fetching...
 [relaton-ieee] WARNING: no match found online for IEEE 19011. The code must be exactly like it is on the standards website.
@@ -156,7 +105,7 @@ x = db.fetch("ISO 19011")
 => #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d0ab2f00
 ...
 
-x = db.fetch("ISO 19011", "2011", retries: 3)
+x = db.fetch("ISO 19011", "2011")
 [relaton-iso] ("ISO 19011") fetching...
 [relaton-iso] ("ISO 19011") found ISO 19011:2011
 => #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d2593068
@@ -168,185 +117,9 @@ x = db.fetch("ISO 19115", nil, all_parts: true)
 => #<RelatonIsoBib::IsoBibliographicItem:0x007fb1d0ae8bf0
 ...
 
-# Fetchig from local cache
-
-x = db.fetch("ISO 19011")
-=> #<RelatonIsoBib::IsoBibliographicItem:0x007fde5f48a9f0
-...
-
-x = db.fetch_db("ISO 5749")
-=> nil
-
-# Fetching asynchronously
-
-# prepare queue for results
-results = Queue.new
-
-# fetch document
-db.fetch_async("ISO 19115") do |result|
-  results << { "ISO 19115" => result }
-end
-# fetch other documets the same way
-
-# wait until documets fetching
-while x = results.pop
-  # do thatever you need with result x
-end
-----
-
-==== Fetch by URN
-
-This functionality works only for IEC documents.
-
-[source,ruby]
-----
-x = db.fetch "urn:iec:std:iec:60050-102:2007:::"
-[relaton-iec] ("IEC 60050-102") fetching...
-[relaton-iec] ("IEC 60050-102") found IEC 60050-102:2007
-=> #<RelatonIec::IecBibliographicItem:0x007fbd6c3790e8
-...
-----
-
-=== Fetch combined documents
-
-This functionality works only for ISO, IEC, ITU, and NIST documents.
-
-==== Fetch included documents
-[source,ruby]
-----
-bib = db.fetch "ISO 19115-1 + Amd 1"
-[relaton-iso] ("ISO 19115-1") fetching...
-[relaton-iso] ("ISO 19115-1") found ISO 19115-1:2014
-[relaton-iso] ("ISO 19115-1/Amd 1") fetching...
-[relaton-iso] ("ISO 19115-1/Amd 1") found ISO 19115-1:2014/Amd 1:2018
-=> #<RelatonIsoBib::IsoBibliographicItem:0x007f95a929a748
-
-bib.docidentifier[0].id
-=> "ISO 19115-1 + Amd 1"
-
-bib.relation[0].type
-=> "updates"
-
-bib.relation[0].bibitem.docidentifier[0].id
-=> "ISO 19115-1"
-
-bib.relation[1].type
-=> "derivedFrom"
-
-bib.relation[1].bibitem.docidentifier[0].id
-=> "ISO 19115-1/Amd 1:2018"
-
-bib.docidentifier[0].id
-=> "ISO 19115-1, Amd 1"
-
-bib.relation[0].type
-=> "updates"
-
-bib.relation[0].bibitem.docidentifier[0].id
-=> "ISO 19115-1"
-
-bib.relation[1].type
-=> "complements"
-
-bib.relation[1].description
-=> "amendment"
-
-bib.relation[1].bibitem.docidentifier[0].id
-=> "ISO 19115-1/Amd 1:2018"
-----
-
-==== Fetch applied documents
-[source,ruby]
-----
-bib = db.fetch "ISO 19115-1, Amd 1"
-=> ["Chinese Standard", "GB/T 1.1"]
-[relaton-iso] ("ISO 19115-1") fetching...
-[relaton-iso] ("ISO 19115-1") found ISO 19115-1:2014
-[relaton-iso] ("ISO 19115-1/Amd 1") fetching...
-[relaton-iso] ("ISO 19115-1/Amd 1") found ISO 19115-1:2014/Amd 1:2018
-=> #<RelatonIsoBib::IsoBibliographicItem:0x007fb09b36d1b8
-...
-----
-
-==== Fetch all documents from cache
-
-`Relaton::Db#fetch_all(text = nil, edition: nil, year: nil)` - fetches all document from local cache
-
-* `text` - (String) filter entries by a text (optional)
-* `edition` - (String) filter entries by an edition (optional)
-* `year` - (Integer) filter entries by a year (optional)
-
-[source,ruby]
-----
-# query for all entries in a cahche
-
-items = db.fetch_all
-=> [#<RelatonIec::IecBibliographicItem:0x007facda8fdc28
-...
-
-items.size
-=> 6
-
-# query for all entries in a cahche for a certain string
-
-items = db.fetch_all("mathematical terminology")
-=> [#<RelatonIec::IecBibliographicItem:0x007ffeae5bd240
-...
-
-items.size
-=> 1
-
-items[0].docidentifier[0].id
-=> "IEC 60050-102:2007"
-
-# query for all entries in a cahche for a certain string and edition
-
-items = db.fetch_all("system", edition: "2")
-=> [#<RelatonIsoBib::IsoBibliographicItem:0x007ffebe2d1be8
-...
-
-items.size
-=> 1
-
-items[0].docidentifier[0].id
-=> "ISO 19011:2011"
-
-# query for all entries in a cahche for a certain string and year
-
-items = db.fetch_all("system", year: 2018)
-=> [#<RelatonIsoBib::IsoBibliographicItem:0x007ffeae645fa0
-...
-
-items.size
-=> 1
-
-items[0].docidentifier[0].id
-=> "ISO 19011 (all parts)"
-----
-
-=== Static DB
-
-This gem has a static DB which is distributed with it. Now the static contains documents:
-----
-ISO/IEC DIR 1 IEC SUP
-ISO/IEC DIR 1 ISO SUP
-ISO/IEC DIR 1
-ISO/IEC DIR 2 IEC
-ISO/IEC DIR 2 ISO
-ISO/IEC DIR IEC SUP
-ISO/IEC DIR 1 JTC SUP
-----
-
-=== Get document type
-[source,ruby]
-----
 db.docid_type("CN(GB/T 1.1)")
 => ["Chinese Standard", "GB/T 1.1"]
-----
 
-=== Serializing
-[source,ruby]
-----
 x.to_xml
 => "<bibitem id="ISO19115(allparts)" type="standard">
       ...
@@ -372,15 +145,12 @@ x.to_xml bibdata: true
 db.load_entry("ISO(ISO 19011)")
 => "<bibdata type="standard">
       ...
-    </bibdata>"
-----
+    <?bibdata>"
 
-=== Entry manipulation
-[source,ruby]
-----
 db.save_entry("ISO(ISO 19011)", nil)
 => nil
 
 db.load_entry("ISO(ISO 19011)")
 => nil
+
 ----

data/lib/relaton/config.rb

@@ -12,11 +12,10 @@ module Relaton
   end
 
   class Configuration
-    attr_accessor :logs, :use_api
+    attr_accessor :logs
 
     def initialize
-      @logs = %i(warning error)
-      @use_api = false # @TODO change to true when we start using api.relaton.org
+      @logs ||= %i(warning error)
     end
   end