ali 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 87c6eabd67795103f67548a9d919c6d32f18f33cff4031732af54d5d476793e6
+  data.tar.gz: '0813d3011868515c36890d1ff33252b7f085b67556865ca83d91da4dddab19b5'
+SHA512:
+  metadata.gz: 5e2a51ca271a68b902b7271b136112d5044f54a1b4b94ad7880818c7587aedc4d9745a88d61b991c38a5748acf40f1c227f0c725c175e2bf0b8afefd46f4eb63
+  data.tar.gz: 4b3d02847bd0d2afab3a9d44af3c25f02a6a63a43493f7c722db9ca6304990923efb0ec8e1a6afce38a8d0e020078d743827ae04442aa747724c4748dcde5e30

data/.github/workflows/rake.yml

@@ -0,0 +1,12 @@
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/graphviz-rake.yml@main

data/.github/workflows/release.yml

@@ -0,0 +1,22 @@
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch or pre|rc|etc
+        required: true
+        default: 'skip'
+  push:
+    tags: [ v* ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.LUTAML_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.LUTAML_CI_PAT_TOKEN }}
+

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,34 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.7
+
+Gemspec/DevelopmentDependencies:
+  Enabled: false
+
+Gemspec/RequireMFA:
+  Enabled: false
+
+Metrics/BlockLength:
+  AllowedMethods:
+    - describe
+
+Style/Documentation:
+  Enabled: false
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+Style/TrailingCommaInArguments:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInArrayLiteral:
+  EnforcedStyleForMultiline: consistent_comma
+
+Style/TrailingCommaInHashLiteral:
+  EnforcedStyleForMultiline: consistent_comma

data/.rubocop_todo.yml

@@ -0,0 +1,20 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-10-30 08:03:48 UTC using RuboCop version 1.67.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'ali.gemspec'
+
+# Offense count: 5
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 81

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in reqif.gemspec
+gemspec
+
+gem "nokogiri"
+gem "rake", "~> 13.0"
+gem "rspec", "~> 3.0"
+gem "rubocop", "~> 1.21"
+gem "rubocop-performance"
+gem "xml-c14n"

data/README.adoc

@@ -0,0 +1,171 @@
+= ALI
+
+image:https://img.shields.io/gem/v/ali.svg["Gem Version", link="https://rubygems.org/gems/ali"]
+image:https://github.com/lutaml/ali/workflows/rake/badge.svg["Build Status", link="https://github.com/lutaml/ali/actions?workflow=rake"]
+image:https://codeclimate.com/github/lutaml/ali/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/lutaml/ali"]
+
+== Purpose
+
+This Ruby gem implements the
+https://www.niso.org/schemas/ali/1.0[NISO Access and License Indicators (ALI) Schemas].
+
+Specification:
+
+* https://www.niso.org/publications/rp-22-2021-ali[NISO RP 22-2021]
+
+It can be used to parse and generate ALI XML and JSON files.
+
+NOTE: NISO ALI is used by the NISO JATS standard to indicate the access and
+license information of a document.
+
+NOTE: The `ali` gem is used by the `niso-jats` gem to parse and generate ALI
+files in the context of JATS documents.
+
+
+== Installation
+
+To install the `ali` gem, use one of the following methods.
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'ali'
+----
+
+Then execute:
+
+[source,sh]
+----
+$ bundle install
+----
+
+Or install it directly using:
+
+[source,sh]
+----
+$ gem install ali
+----
+
+After installation, you can start using the ali gem in your Ruby projects
+or via the command-line interface.
+
+
+
+== API
+
+=== General
+
+The gem provides the following classes:
+
+* `Ali::FreeToRead`:: Represents the `free_to_read` element.
+* `Ali::License`:: Represents the `license` element.
+* `Ali::Container`:: Represents the root element of the ALI document. (Applies to JSON only)
+
+=== Differences between XML and JSON usage of ALI
+
+Notice that the XML usage and JSON usage of ALI differs:
+
+XML:: The `free_to_read` and `license` elements are directly incorporated into
+an XML document that is defined by an external schema. ALI itself does not
+define any root container.
+
+JSON-LD:: The `free_to_read` and `license` elements are contained in a JSON
+object under the JSON-LD context defined in ALI. In the `ali` gem, the
+`Ali::Container` class is used to represent the root element of the ALI
+document.
+
+=== Usage with XML
+
+When parsing ALI in XML, you need to incorporate the ALI element
+classes in the context of the XML document.
+
+[example]
+====
+Usage of ALI elements in XML is not contained in a particular element.
+
+[source,xml]
+----
+<external-document ...>
+  <!-- other elements -->
+  <free_to_read xmlns="http://www.niso.org/schemas/ali/1.0/"
+    start_date="2014-01-01" end_date="2014-12-31"/>
+  <license_ref xmlns="http://www.niso.org/schemas/ali/1.0/"
+    start_date="2015-02-03">
+    http://www.examplesite.org/open_license.html
+  </license_ref>
+  <!-- other elements -->
+</external-document>
+----
+====
+
+.Usage with XML
+[source,ruby]
+----
+> require 'ali'
+> xml = '<free_to_read xmlns="http://www.niso.org/schemas/ali/1.0/" start_date="2014-01-01"
+end_date="2014-12-31"/>'
+> free_to_read = Ali::FreeToRead.from_xml(xml)
+> free_to_read.start_date
+# => "2014-01-01"
+> free_to_read.end_date
+# => "2014-12-31"
+----
+
+=== Usage with JSON
+
+When parsing ALI in JSON, you need to use the `Ali::Container` class to
+parse the root element of the ALI object.
+
+[example]
+====
+Usage of ALI in JSON-LD is contained in an JSON object.
+
+[source,json]
+----
+{
+  "@context": "http://www.niso.org/schemas/ali/1.0.1/jsonld.json",
+  "free_to_read": {
+    "start_date": "2014-01-01",
+    "end_date": "2014-12-31"
+  },
+  "license_ref": {
+    "start_date": "2014-04-04",
+    "uri": "http://creativecommons.org/licenses/by/3.0/"
+  }
+}
+----
+====
+
+.Usage with JSON
+[source,ruby]
+----
+> require 'ali'
+> json = '{"free_to_read": {"start_date": "2014-01-01", "end_date": "2014-12-31"}}'
+> container = Ali::Container.from_json(json)
+> free_to_read = container.free_to_read
+> free_to_read.start_date
+# => "2014-01-01"
+> free_to_read.end_date
+# => "2014-12-31"
+----
+
+
+== Tests
+
+The `spec/fixtures` folder tests the library against known examples of ALI.
+
+Including:
+
+`spec/fixtures/json`:: JSON examples from
+https://www.niso.org/publications/rp-22-2021-ali[NISO RP 22-2021], A.4.
+
+`spec/fixtures/xml`:: XML examples from
+https://www.niso.org/publications/rp-22-2021-ali[NISO RP 22-2021], A.1.
+
+
+== License
+
+Copyright Ribose.
+
+BSD-3 license.

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: %i[spec rubocop]

data/ali.gemspec

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require_relative "lib/ali/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ali"
+  spec.version = Ali::VERSION
+  spec.authors = ["Ribose Inc."]
+  spec.email = ["open.source@ribose.com'"]
+
+  spec.summary = "NISO Access and License Indicators (ALI) Schemas library"
+  spec.description = "A Ruby library for parsing and generating NISO Access and License Indicators (ALI) Schemas data"
+  spec.homepage = "https://github.com/lutaml/ali"
+  spec.license = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/lutaml/ali/releases"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem
+  # that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.add_dependency "lutaml-model"
+end

data/bin/console

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ali"
+
+# 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.
+
+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/ali/container.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ali
+  # The container is only used in the case of JSON and is not from the NISO ALI
+  # spec. The NISO ALI contains multiple JSON examples stored in object form
+  # that assumes an object container to parse.
+  class Container < Lutaml::Model::Serializable
+    attribute :free_to_read, FreeToRead, collection: true
+    attribute :license_ref, LicenseRef, collection: true
+
+    xml do
+      root "ali-container"
+      namespace "http://www.niso.org/schemas/ali/1.0/"
+
+      map_element "free_to_read", to: :free_to_read
+      map_element "license_ref", to: :license_ref
+    end
+
+    json do
+      map "free_to_read", to: :free_to_read
+      map "license_ref", to: :license_ref
+    end
+  end
+end

data/lib/ali/free_to_read.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Ali
+  class FreeToRead < Lutaml::Model::Serializable
+    attribute :start_date, :date
+    attribute :end_date, :date
+
+    xml do
+      root "free_to_read"
+      namespace "http://www.niso.org/schemas/ali/1.0/"
+
+      map_attribute "start_date", to: :start_date
+      map_attribute "end_date", to: :end_date
+    end
+
+    json do
+      map "start_date", to: :start_date
+      map "end_date", to: :end_date
+    end
+  end
+end

data/lib/ali/license_ref.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Ali
+  class LicenseRef < Lutaml::Model::Serializable
+    attribute :start_date, :date
+    attribute :applies_to, :string
+    attribute :uri, :string
+
+    xml do
+      root "license_ref"
+      namespace "http://www.niso.org/schemas/ali/1.0/"
+
+      map_attribute "start_date", to: :start_date
+      map_attribute "applies_to", to: :applies_to
+      map_content to: :uri
+    end
+
+    json do
+      map "start_date", to: :start_date
+      map "applies_to", to: :applies_to
+      map "uri", to: :uri
+    end
+  end
+end

data/lib/ali/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Ali
+  VERSION = "0.1.0"
+end

data/lib/ali.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative "ali/version"
+require "lutaml/model"
+
+module Ali
+  class Error < StandardError; end
+
+  # Your code goes here...
+end
+
+require_relative "ali/free_to_read"
+require_relative "ali/license_ref"
+require_relative "ali/container"

data/sig/ali.rbs

@@ -0,0 +1,4 @@
+module Ali
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: ali
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ribose Inc.
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: lutaml-model
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A Ruby library for parsing and generating NISO Access and License Indicators
+  (ALI) Schemas data
+email:
+- open.source@ribose.com'
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- Gemfile
+- README.adoc
+- Rakefile
+- ali.gemspec
+- bin/console
+- bin/setup
+- lib/ali.rb
+- lib/ali/container.rb
+- lib/ali/free_to_read.rb
+- lib/ali/license_ref.rb
+- lib/ali/version.rb
+- sig/ali.rbs
+homepage: https://github.com/lutaml/ali
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/lutaml/ali
+  source_code_uri: https://github.com/lutaml/ali
+  changelog_uri: https://github.com/lutaml/ali/releases
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: NISO Access and License Indicators (ALI) Schemas library
+test_files: []