relaton-bib 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 05365dd34321a3c2f80a6d73fd16abe5c530f3c5
+  data.tar.gz: 5d7fdd3b5eaea30767632c884a803e615e9eea00
+SHA512:
+  metadata.gz: a88c9d5bc6fc001f6a6f8b13813e5225c662d25f97d0cd6fc852169886480a9210b590c69620c6a2f4ac1eb223328e525c0ef0f0da7b8f730b582c1e66e89882
+  data.tar.gz: b7b48023c0bd6f22e4685a0b8e44d9d07672f37cd82d861ab2dda33c9675b3288d665c712d0308e2c001b738eabec9cb8294b6776ffe8149375f14637c03ba90

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.vscode/
+
+# rspec failure tracking
+.rspec_status
+.rubocop-https---raw-githubusercontent-com-riboseinc-oss-guides-master-ci-rubocop-yml

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,10 @@
+# This project follows the Ribose OSS style guide.
+# https://github.com/riboseinc/oss-guides
+# All project-specific additions and overrides should be specified in this file.
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.3
+Rails:
+  Enabled: true

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton-bib.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,57 @@
+PATH
+  remote: .
+  specs:
+    relaton-bib (0.1.0)
+      nokogiri (~> 1.8.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    debase (0.2.2)
+      debase-ruby_core_source (>= 0.10.2)
+    debase-ruby_core_source (0.10.4)
+    diff-lcs (1.3)
+    docile (1.3.1)
+    equivalent-xml (0.6.0)
+      nokogiri (>= 1.4.3)
+    json (2.2.0)
+    mini_portile2 (2.3.0)
+    nokogiri (1.8.5)
+      mini_portile2 (~> 2.3.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    ruby-debug-ide (0.6.1)
+      rake (>= 0.8.1)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  debase
+  equivalent-xml (~> 0.6)
+  rake (~> 10.0)
+  relaton-bib!
+  rspec (~> 3.0)
+  ruby-debug-ide
+  simplecov
+
+BUNDLED WITH
+   2.0.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Andrei Kislichenko
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.adoc

@@ -0,0 +1,272 @@
+= RelatonBib
+
+image:https://img.shields.io/gem/v/relaton-bib.svg["Gem Version", link="https://rubygems.org/gems/relaton-bib"]
+image:https://img.shields.io/travis/metanorma/relaton-bib["Build Status", link="https://travis-ci.com/metanorma/relaton-bib"]
+image:https://codeclimate.com/github/metanorma/relaton-bib["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-bib"]
+
+RlatonBib is a Ruby gem that implements the https://github.com/metanorma/relaton-models#bibliography-uml-models[BibliographicItem model].
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'relaton-bib'
+----
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install relaton-bib
+
+== Usage
+
+=== Create bibliographic item
+
+[source,ruby]
+----
+item = RelatonBib::BibliographicItem.new(
+  id: "ISO/TC211",
+  fetched: Date.today.to_s,
+  type: "standard",
+  titles: [
+    { type: "main", content: "Geographic information", language: "en", script: "Latn" },
+    {
+      content: "Information géographique", language: "fr", script: "Latn"
+    },
+  ],
+  link: [
+    { type: "src", content: "https://www.iso.org/standard/53798.html" },
+    { type: "obp",
+      content: "https://www.iso.org/obp/ui/#!iso:std:53798:en" },
+    { type: "rss", content: "https://www.iso.org/contents/data/standard"\
+      "/05/37/53798.detail.rss" }
+  ],
+  docid: [
+    RelatonBib::DocumentIdentifier.new(id: "TC211", type: "ISO")
+  ],
+  docnumber: "123456",
+  dates: [
+    { type: "published", on: "2014-04" },
+    { type: "accessed", on: "2015" }
+  ],
+  contributors: [
+    { entity: {
+        name: "International Organization for Standardization",
+        url: "www.iso.org", abbreviation: "ISO", subdivision: "division" },
+      roles: [["publisher", ["Publisher role"]]], }
+  ],
+  edition: "1",
+  version: RelatonBib::BibliographicItem::Version.new("2019-04-01", ["draft"]),
+  language: ["en", "fr"],
+  script: ["Latn"],
+  abstract: [
+    { content: "ISO 19115-1:2014 defines the schema required for ...",
+      language: "en", script: "Latn", format: "text/plain" },
+    { content: "L'ISO 19115-1:2014 définit le schéma requis pour ...",
+      language: "fr", script: "Latn", format: "text/plain" },
+  ],
+  docstatus: RelatonBib::DocumentStatus.new(
+    RelatonBib::LocalizedString.new("standard", "en", "Latn")
+  ),
+  copyright: { owner: {
+      name: "International Organization for Standardization",
+      abbreviation: "ISO", url: "www.iso.org"
+    },
+    from: "2014", to: "2020" },
+  relations: [
+    { type: "updates",
+      bibitem: RelatonBib::BibliographicItem.new(
+        formattedref: RelatonBib::FormattedRef.new(content: "ISO 19115:2003"),
+      ),
+      bib_locality: [RelatonBib::BibItemLocality.new("updates", "Reference form")],
+    }
+  ],
+  series: [
+    RelatonBib::Series.new(
+      type: "main",
+      title: RelatonBib::TypedTitleString.new(
+        type: "original", content: "ISO/IEC FDIS 10118-3", language: "en",
+        script: "Latn", format: "text/plain",
+      ),
+      place: "Serie's place",
+      organization: "Serie's organization",
+      abbreviation: RelatonBib::LocalizedString.new("ABVR", "en", "Latn"),
+      from: "2009-02-01",
+      to: "2010-12-20",
+      number: "serie1234",
+      partnumber: "part5678",
+    ),
+    RelatonBib::Series.new(
+      type: "alt",
+      formattedref: RelatonBib::FormattedRef.new(
+        content: "serieref", language: "en", script: "Latn"
+      ),
+    )
+  ],
+  medium: RelatonBib::Medium.new(
+    form: "medium form", size: "medium size", scale: "medium scale"
+  ),
+  place: ["bib place"],
+  extent: [
+    RelatonBib::BibItemLocality.new(
+      "section", "Reference from", "Reference to"
+    ),
+  ],
+  accesslocation: ["accesslocation1", "accesslocation2"],
+  classification: RelatonBib::Classification.new(type: "type", value: "value"),
+  validity: RelatonBib::Validity.new(
+    begins: Time.new(2010, 10, 10, 12, 21),
+    ends: Time.new(2011, 2, 3, 18,30),
+    revision: Time.new(2011, 3, 4, 9, 0)
+  )
+)
+----
+
+=== BibliographicItem Typed Title Strings
+
+[source,ruby]
+----
+item.title
+=> [#<RelatonBib::TypedTitleString:0x007fa49a360290
+  @title=#<RelatonBib::FormattedString:0x007fa49a360088 @content="Geographic information", @format=nil, @language=["en"], @script=["Latn"]>,
+  @type="main">,
+ #<RelatonBib::TypedTitleString:0x007fa49a35bf38
+  @title=#<RelatonBib::FormattedString:0x007fa49a35bdd0 @content="Information géographique", @format=nil, @language=["fr"], @script=["Latn"]>,
+  @type=nil>]
+----
+
+=== BibliographicItem Formatted Strings
+
+[source,ruby]
+----
+item.abstract
+=> [#<RelatonBib::FormattedString:0x007fa49a35aed0 @content="ISO 19115-1:2014 defines the schema required for ...", @format="text/plain", @language=["en"], @script=["Latn"]>,
+ #<RelatonBib::FormattedString:0x007fa49a35ae08 @content="L'ISO 19115-1:2014 définit le schéma requis pour ...", @format="text/plain", @language=["fr"], @script=["Latn"]>]
+
+item.abstract(lang: "en").to_s
+=> "ISO 19115-1:2014 defines the schema required for ..."
+"
+----
+
+=== BibliographicItem references
+
+[source,ruby]
+----
+item.shortref item
+=> "ISO/TC211:2014"
+----
+
+=== XML serialization
+
+[source,ruby]
+----
+item.to_xml
+=>"<bibitem id=\"ISO/TC211\" type=\"standard\">
+  <fetched>2019-04-30</fetched>
+  <title type=\"main\" language=\"en\" script=\"Latn\">Geographic information</title>
+  <title language=\"fr\" script=\"Latn\">Information géographique</title>
+  <uri type=\"src\">https://www.iso.org/standard/53798.html</uri>
+  <uri type=\"obp\">https://www.iso.org/obp/ui/#!iso:std:53798:en</uri>
+  <uri type=\"rss\">https://www.iso.org/contents/data/standard/05/37/53798.detail.rss</uri>
+  <docidentifier type=\"ISO\">TC211</docidentifier>
+  <docnumber>123456</docnumber>
+  <date type=\"published\">
+    <on>2014-04</on>
+  </date>
+  <date type=\"accessed\">
+    <on>2015-01</on>
+  </date>
+  <contributor>
+    <role type=\"publisher\">
+      <description>Publisher role</description>
+    </role>
+    <organization>
+      <name>International Organization for Standardization</name>
+      <subdivision>division</subdivision>
+      <abbreviation>ISO</abbreviation>
+      <uri>www.iso.org</uri>
+    </organization>
+  </contributor>
+  <edition>1</edition>
+  <version>
+    <revision_date>2019-04-01</revision_date>
+    <draft>draft</draft>
+  </version>
+  <language>en</language>
+  <language>fr</language>
+  <script>Latn</script>
+  <abstract format=\"text/plain\" language=\"en\" script=\"Latn\">ISO 19115-1:2014 defines the schema required for ...</abstract>
+  <abstract format=\"text/plain\" language=\"fr\" script=\"Latn\">L'ISO 19115-1:2014 définit le schéma requis pour ...</abstract>
+  <status language=\"en\" script=\"Latn\">standard</status>
+  <copyright>
+    <from>2014</from>
+    <to>2020</to>
+    <owner>
+      <organization>
+        <name>International Organization for Standardization</name>
+        <abbreviation>ISO</abbreviation>
+        <uri>www.iso.org</uri>
+      </organization>
+    </owner>
+  </copyright>
+  <relation type=\"updates\">
+    <bibitem>
+      <formattedref>ISO 19115:2003</formattedref>
+    </bibitem>
+    <locality type=\"updates\">
+      <referenceFrom>Reference form</referenceFrom>
+    </locality>
+  </relation>
+  <series type=\"main\">
+    <title type=\"original\" format=\"text/plain\" language=\"en\" script=\"Latn\">ISO/IEC FDIS 10118-3</title>
+    <place>Serie's place</place>
+    <organization>Serie's organization</organization>
+    <abbreviation language=\"en\" script=\"Latn\">ABVR</abbreviation>
+    <from>2009-02-01</from>
+    <to>2010-12-20</to>
+    <number>serie1234</number>
+    <partnumber>part5678</partnumber>
+  </series>
+  <series type=\"alt\">
+    <formattedref language=\"en\" script=\"Latn\">serieref</formattedref>
+  </series>
+  <medium>
+    <form>medium form</form>
+    <size>medium size</size>
+    <scale>medium scale</scale>
+  </medium>
+  <place>bib place</place>
+  <locality type=\"section\">
+    <referenceFrom>Reference from</referenceFrom>
+    <referenceTo>Reference to</referenceTo>
+  </locality>
+  <accesslocation>accesslocation1</accesslocation>
+  <accesslocation>accesslocation2</accesslocation>
+  <classification type=\"type\">value</classification>
+  <validity>
+    <validityBegins>2010-10-10 12:21</validityBegins>
+    <validityEnds>2011-02-03 18:30</validityEnds>
+    <validityRevision>2011-03-04 09:00</validityRevision>
+  </validity>
+</bibitem>"
+----
+
+== Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/relaton-bib.
+
+== License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "relaton_bib"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/relaton_bib.rb

@@ -0,0 +1,7 @@
+require "relaton_bib/version"
+require "relaton_bib/bibliographic_item.rb"
+
+module RelatonBib
+  class Error < StandardError; end
+  # Your code goes here...
+end