relaton-jis 1.14.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 30edf630d85d2e1abafa0c0c03c7b5b22be3b5eebe8c18a7b9df955d8588e22b
+  data.tar.gz: 79ce45cba39f96353038c95c608c38b893ddbad335a671ade2361384ab8e3a3c
+SHA512:
+  metadata.gz: b0a58bb07a4b7b6f00b8b18014e3b6500ec5403f0c26cca6fac3286aa97ff0736a604d4d1e7a61c3e4379f5625409720c1119229a9c0dc4642173da46498b170
+  data.tar.gz: 6ba60be774e61bbfbcff9d10fe4dc031e4e07026c52fb64bbd56b9e6ccb59a2999f46c7c29475afcc8801effcc7fccf5f7076d64cb27744612abb291d1ad8219

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,12 @@
+# 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.
+
+require: rubocop-rails
+
+inherit_from:
+  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
+AllCops:
+  TargetRubyVersion: 2.7
+Rails:
+  Enabled: false

data/Gemfile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in relaton_jis.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.48"
+gem "rubocop-performance", "~> 1.11"
+gem "rubocop-rails", "~> 2.12"
+
+gem "equivalent-xml", "~> 0.6"
+gem "ruby-jing"
+gem "simplecov", "~> 0.21"
+gem "vcr", "~> 6.0"
+gem "webmock", "~> 3.0"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Ribose Inc.
+
+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,141 @@
+= RelatonJis: retrieve JIS Standards for bibliographic use using the BibliographicItem model
+
+image:https://img.shields.io/gem/v/relaton-jis.svg["Gem Version", link="https://rubygems.org/gems/relaton-jis"]
+image:https://github.com/relaton/relaton-jis/workflows/macos/badge.svg["Build Status, link="https://github.com/relaton/relaton-jis/actions?workflow=rake"]
+image:https://codeclimate.com/github/relaton/relaton-jis/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/metanorma/relaton-jis"]
+image:https://img.shields.io/github/issues-pr-raw/relaton/relaton-jis.svg["Pull Requests", link="https://github.com/relaton/relaton-jis/pulls"]
+image:https://img.shields.io/github/commits-since/relaton/relaton-jis/latest.svg["Commits since latest",link="https://github.com/relaton/relaton-jis/releases"]
+
+RelatonJis is a Ruby gem that implements the https://github.com/metanorma/metanorma-model-iso#iso-bibliographic-item[IsoBibliographicItem model].
+
+You can use it to retrieve metadata of JIS Standards from https://webdesk.jsa.or.jp, and access such metadata through the `RelatonJis::BibliographicItem` object.
+
+== Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add relaton-jis
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install relaton-jis
+
+== Usage
+
+=== Search for standards using keywords
+
+[source,ruby]
+----
+require 'relaton_jis'
+=> true
+
+hit_collection = RelatonJis::Bibliography.search("JIS X 0208")
+=> <RelatonJis::HitCollection:0x00000000018858 @ref=JIS X 0208 @fetched=false>
+
+hit_collection.first
+=> <RelatonJis::Hit:0x00000000018880 @text="JIS X 0208" @fetched="false" @fullIdentifier="" @title="">
+
+item = hit_collection[2].fetch
+=> #<RelatonJis::BibliographicItem:0x00007fe4564a7580
+...
+
+item.docidentifier
+=> [#<RelatonBib::DocumentIdentifier:0x00007fe46625c518
+  @id="JIS X 0208:1997/AMENDMENT 1:2012",
+  @language=nil,
+  @primary=true,
+  @scope=nil,
+  @script=nil,
+  @type="JIS">]
+----
+
+=== Fetch document by reference and year
+
+[source,ruby]
+----
+item = RelatonJis::Bibliography.get "JIS X 0208:1997"
+[relaton-jis] ("JIS X 0208:1997") fetching...
+[relaton-jis] ("JIS X 0208:1997") found JIS X 0208:1997
+=> #<RelatonJis::BibliographicItem:0x00007fe4478ecc08
+...
+
+item = RelatonJis::Bibliography.get "JIS X 0208", "1997"
+[relaton-jis] ("JIS X 0208") fetching...
+[relaton-jis] ("JIS X 0208") found JIS X 0208:1997
+=> #<RelatonJis::BibliographicItem:0x00007fe436b49d90
+...
+
+item.docidentifier[0].id
+=> "JIS X 0208:1997"
+----
+
+=== XML serialization
+
+Possible options:
+
+- *bibdata* - If true then wrapp item with _bibdata_ element and add _ext_ element.
+
+[source,ruby]
+----
+item.to_xml
+=> "<bibitem id="JISX0208-1997" type="standard" schema-version="v1.2.3">
+      <fetched>2023-03-18</fetched>
+      <title format="text/plain" language="ja" script="Jpan">７ビット及び８ビットの２バイト情報交換用符号化漢字集合</title>
+      <title format="text/plain" language="en" script="Lant">7-bit and 8-bit double byte coded KANJI sets for information interchange</title>
+      ...
+    </bibitem>"
+
+item.to_xml bibdata: true
+=> "<bibdata type="standard" schema-version="v1.2.3">
+      <fetched>2023-03-18</fetched>
+      <title format="text/plain" language="ja" script="Jpan">７ビット及び８ビットの２バイト情報交換用符号化漢字集合</title>
+      <title format="text/plain" language="en" script="Lant">7-bit and 8-bit double byte coded KANJI sets for information interchange</title>
+      ...
+      <ext schema-version="">
+        <doctype>standard</doctype>
+        <editorialgroup>
+          <technical-committee>一般財団法人　日本規格協会</technical-committee>
+        </editorialgroup>
+        <ics>
+          <code>35.040</code>
+          <text>Information coding</text>
+        </ics>
+        <structuredidentifier type="JIS">
+          <project-number>X0208</project-number>
+        </structuredidentifier>
+      </ext>
+    </bibdata>"
+----
+
+=== Typed links
+
+Each JIS document has `src` type link and optional `pdf`.
+
+[source,ruby]
+----
+item.link
+=> [#<RelatonBib::TypedUri:0x00007fe436a626c0
+  @content=#<Addressable::URI:0xc620 URI:https://webdesk.jsa.or.jp/books/W11M0090/index/?bunsyo_id=JIS+X+0208%3A1997>,
+  @language=nil,
+  @script=nil,
+  @type="src">,
+ #<RelatonBib::TypedUri:0x00007fe436a60ed8
+  @content=#<Addressable::URI:0xc634 URI:https://webdesk.jsa.or.jp/preview/pre_jis_x_00208_000_000_1997_j_pr11_i4.pdf>,
+  @language=nil,
+  @script=nil,
+  @type="pdf">]
+----
+
+== 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 the created tag, 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/relaton/relaton-jis.
+
+== 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,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :spec