reqif 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f0f9bdc52dbdc885bb1b46156c06618ba14184f46fe33769c82e75382a40fcdc
+  data.tar.gz: f91af84530330b4ad4b412648db399903ea96a340ec510afe36c8644c60fb5f6
+SHA512:
+  metadata.gz: 6939509f792d37e0822fbf9e3a363354cf3826ea1e89007622b864fa4e21ad3723e6d7792a05c0096be61069845ac7b4f9b66704759e5f582e40994416d7b69e
+  data.tar.gz: 4428ff962c5049f6542424a1c6aaeec7d30ccbe4525596cf087d2bfd034a3d27d83c43d28f03c442b23b6daaa35191e69e39f0c15f2e66d7b31aa4dd53a4e8a6

data/.github/workflows/rake.yml

@@ -0,0 +1,18 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: rake
+
+on:
+  push:
+    branches: [ master, main ]
+    tags: [ v* ]
+  pull_request:
+
+permissions:
+  contents: write
+
+jobs:
+  rake:
+    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
+    secrets:
+      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -0,0 +1,25 @@
+# Auto-generated by Cimas: Do not edit it manually!
+# See https://github.com/metanorma/cimas
+name: release
+
+on:
+  workflow_dispatch:
+    inputs:
+      next_version:
+        description: |
+          Next release version. Possible values: x.y.z, major, minor, patch (or pre|rc|etc).
+          Also, you can pass 'skip' to skip 'git tag' and do 'gem push' for the current version
+        required: true
+        default: 'skip'
+  repository_dispatch:
+    types: [ do-release ]
+
+jobs:
+  release:
+    uses: metanorma/ci/.github/workflows/rubygems-release.yml@main
+    with:
+      next_version: ${{ github.event.inputs.next_version }}
+    secrets:
+      rubygems-api-key: ${{ secrets.METANORMA_CI_RUBYGEMS_API_KEY }}
+      pat_token: ${{ secrets.METANORMA_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,8 @@
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/Gemfile

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

data/README.adoc

@@ -0,0 +1,73 @@
+= ReqIF Ruby library
+
+The `reqif` library is a parser and generator for ReqIF XML documents.
+
+It is intended to be used to parse and generate ReqIF XML v1.2 documents.
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+[source,ruby]
+----
+gem 'reqif'
+----
+
+And then execute:
+
+[source]
+----
+$ bundle install
+----
+
+Or install it yourself as:
+
+[source]
+----
+$ gem install reqif
+----
+
+
+== Usage
+
+To parse a ReqIF XML document:
+
+[source,ruby]
+----
+require 'reqif'
+
+reqif = Reqif::ReqIf.new(File.read('reqif.xml'))
+puts reqif.title
+puts reqif.abstract
+puts reqif.sections
+----
+
+To generate a ReqIF XML document:
+
+[source,ruby]
+----
+require 'reqif'
+
+reqif = Reqif::ReqIf.new
+reqif.title = 'An Article Title'
+reqif.abstract = 'An Article Abstract'
+reqif.sections = [
+  Reqif::Section.new('Section 1', 'This is the first section'),
+  Reqif::Section.new('Section 2', 'This is the second section')
+]
+
+puts reqif.to_xml
+----
+
+
+== Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/lutaml/reqif.
+
+
+== Copyright and license
+
+The gem is available as open source under the terms of the BSD 2-clause license.
+
+All rights reserved. Ribose
+

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/bin/console

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

@@ -0,0 +1,14 @@
+require "lutaml/model"
+
+module Reqif
+  class AlternativeId < Lutaml::Model::Serializable
+    attribute :identifier, :string
+
+    xml do
+      root "ALTERNATIVE-ID"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "IDENTIFIER", to: :identifier
+    end
+  end
+end

data/lib/reqif/attribute_definition_boolean.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionBoolean < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-BOOLEAN"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_date.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionDate < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-DATE"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_enumeration.rb

@@ -0,0 +1,30 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionEnumeration < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :multi_valued, :boolean
+    attribute :default_value, DefaultValue
+    attribute :alternative_id, AlternativeId
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-ENUMERATION"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_attribute "MULTI-VALUED", to: :multi_valued
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_integer.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionInteger < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-INTEGER"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_real.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionReal < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-REAL"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_string.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionString < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-STRING"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_definition_xhtml.rb

@@ -0,0 +1,28 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeDefinitionXhtml < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :is_editable, :boolean
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :default_value, DefaultValue
+    attribute :type, Type
+
+    xml do
+      root "ATTRIBUTE-DEFINITION-XHTML"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "IS-EDITABLE", to: :is_editable
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "DEFAULT-VALUE", to: :default_value
+      map_element "TYPE", to: :type
+    end
+  end
+end

data/lib/reqif/attribute_value_boolean.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueBoolean < Lutaml::Model::Serializable
+    attribute :the_value, :boolean
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-BOOLEAN"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "THE-VALUE", to: :the_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/attribute_value_date.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueDate < Lutaml::Model::Serializable
+    attribute :the_value, :time
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-DATE"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "THE-VALUE", to: :the_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/attribute_value_enumeration.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueEnumeration < Lutaml::Model::Serializable
+    attribute :definition, Definition
+    attribute :values, Values
+
+    xml do
+      root "ATTRIBUTE-VALUE-ENUMERATION"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_element "DEFINITION", to: :definition
+      map_element "VALUES", to: :values
+    end
+  end
+end

data/lib/reqif/attribute_value_integer.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueInteger < Lutaml::Model::Serializable
+    attribute :the_value, :integer
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-INTEGER"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "THE-VALUE", to: :the_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/attribute_value_real.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueReal < Lutaml::Model::Serializable
+    attribute :the_value, :float
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-REAL"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "THE-VALUE", to: :the_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/attribute_value_string.rb

@@ -0,0 +1,16 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueString < Lutaml::Model::Serializable
+    attribute :the_value, :string
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-STRING"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "THE-VALUE", to: :the_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/attribute_value_xhtml.rb

@@ -0,0 +1,20 @@
+require "lutaml/model"
+
+module Reqif
+  class AttributeValueXhtml < Lutaml::Model::Serializable
+    attribute :is_simplified, :boolean
+    attribute :the_value, XhtmlContent
+    attribute :the_original_value, XhtmlContent
+    attribute :definition, Definition
+
+    xml do
+      root "ATTRIBUTE-VALUE-XHTML"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "IS-SIMPLIFIED", to: :is_simplified
+      map_element "THE-VALUE", to: :the_value
+      map_element "THE-ORIGINAL-VALUE", to: :the_original_value
+      map_element "DEFINITION", to: :definition
+    end
+  end
+end

data/lib/reqif/children.rb

@@ -0,0 +1,14 @@
+require "lutaml/model"
+
+module Reqif
+  class Children < Lutaml::Model::Serializable
+    attribute :spec_hierarchy, SpecHierarchy, collection: true
+
+    xml do
+      root "CHILDREN"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_element "SPEC-HIERARCHY", to: :spec_hierarchy
+    end
+  end
+end

data/lib/reqif/core_content.rb

@@ -0,0 +1,14 @@
+require "lutaml/model"
+
+module Reqif
+  class CoreContent < Lutaml::Model::Serializable
+    attribute :req_if_content, ReqIfContent
+
+    xml do
+      root "CORE-CONTENT"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_element "REQ-IF-CONTENT", to: :req_if_content
+    end
+  end
+end

data/lib/reqif/datatype_definition_boolean.rb

@@ -0,0 +1,22 @@
+require "lutaml/model"
+
+module Reqif
+  class DatatypeDefinitionBoolean < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+
+    xml do
+      root "DATATYPE-DEFINITION-BOOLEAN"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+    end
+  end
+end

data/lib/reqif/datatype_definition_date.rb

@@ -0,0 +1,22 @@
+require "lutaml/model"
+
+module Reqif
+  class DatatypeDefinitionDate < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+
+    xml do
+      root "DATATYPE-DEFINITION-DATE"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+    end
+  end
+end

data/lib/reqif/datatype_definition_enumeration.rb

@@ -0,0 +1,24 @@
+require "lutaml/model"
+
+module Reqif
+  class DatatypeDefinitionEnumeration < Lutaml::Model::Serializable
+    attribute :desc, :string
+    attribute :identifier, :string
+    attribute :last_change, :time
+    attribute :long_name, :string
+    attribute :alternative_id, AlternativeId
+    attribute :specified_values, SpecifiedValues
+
+    xml do
+      root "DATATYPE-DEFINITION-ENUMERATION"
+      namespace "http://www.omg.org/spec/ReqIF/20110401/reqif.xsd", "REQIF"
+
+      map_attribute "DESC", to: :desc
+      map_attribute "IDENTIFIER", to: :identifier
+      map_attribute "LAST-CHANGE", to: :last_change
+      map_attribute "LONG-NAME", to: :long_name
+      map_element "ALTERNATIVE-ID", to: :alternative_id
+      map_element "SPECIFIED-VALUES", to: :specified_values
+    end
+  end
+end