oscal 0.2.3 → 0.4.1

data/.docker/Makefile

@@ -1,43 +0,0 @@
-export SPEC ?= spec
-SPEC_FILE = $(subst ../,, $(SPEC))
-export RUBY_IMAGE ?= ruby:3.1.2-slim
-
-.PHONY: up
-up:
-	docker-compose up
-
-.PHONY: down
-down:
-	docker-compose down
-
-.PHONY: test
-test: rspec
-
-.PHONY: ssh
-ssh:
-	docker-compose run lib bash
-
-.PHONY: install
-install:
-	docker-compose run lib bin/setup
-
-.PHONY: console
-console:
-	docker-compose run lib bin/console
-
-.PHONY: rspec
-rspec:
-	docker-compose run lib bin/rspec ${SPEC_FILE}
-
-.PHONY: rake
-rake:
-	docker-compose run lib bundle exec rake
-
-.PHONY: lint
-lint:
-	docker-compose run lib bundle exec rubocop
-
-.PHONY: setup
-setup:
-	docker-compose build --build-arg RUBY_IMAGE=${RUBY_IMAGE}
-	docker-compose run lib bin/setup

data/.docker/docker-compose.yml

@@ -1,14 +0,0 @@
-version: "3"
-
-services:
-  lib:
-    build:
-      context: .
-      dockerfile: ./.docker/Dockerfile
-
-    volumes:
-      - .:/workspace
-      - bundle:/bundle
-
-volumes:
-  bundle:

data/.docker/readme.md

@@ -1,61 +0,0 @@
-## Docker
-
-This directory is only meant to be used for development, and contains some
-necessary setup to spin up docker containers with multiple ruby environment.
-
-### Setup
-
-Before doing anything, you might want to create a symlink to the docker file and
-Makefile. This would allow you to avoid some of the unnecessary work related to
-the file paths To do that run the following from the root of the project.
-
-```
-ln -sf .docker/Makefile .
-ln -sf .docker/docker-compose.yml .
-```
-
-By default it usages the most recent ruby version for docker environment, but if
-you want to run it in any specific version then you can set it up by exporting
-`RUBY_IMAGE` environment variable in your shell:
-
-```sh
-export RUBY_IMAGE=ruby:3.0-buster
-```
-
-Once everything is set then you would need to build the development images for
-the first time and you can do that using:
-
-```sh
-make setup
-```
-
-The setup process will install all dependencies and it will also setup a volume
-to speed up the repeated gem installation.
-
-### Playground
-
-The `Makefile` contains two target for tests, and you can run the tests using
-any of the following commands:
-
-```sh
-make test
-
-# or
-make rspec
-```
-
-If you need more control, and you want to do some development on the go then you
-can get into the container using:
-
-```sh
-make ssh
-```
-
-### Cleanup
-
-Once you are done with your experiment then you can cleanup the docker
-environment using the following command.
-
-```sh
-make down
-```

data/.github/workflows/rake.yml

@@ -1,15 +0,0 @@
-# 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:
-
-jobs:
-  rake:
-    uses: metanorma/ci/.github/workflows/generic-rake.yml@main
-    secrets:
-      pat_token: ${{ secrets.METANORMA_CI_PAT_TOKEN }}

data/.github/workflows/release.yml

@@ -1,24 +0,0 @@
-# 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
-        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

@@ -1,13 +0,0 @@
-/.bundle/
-/.yardoc
-/_yardoc/
-/coverage/
-/doc/
-/pkg/
-/spec/reports/
-/tmp/
-
-# rspec failure tracking
-.rspec_status
-.rubocop-https---**
-Gemfile.lock

data/.gitmodules

@@ -1,3 +0,0 @@
-[submodule "spec/oscal-content"]
-	path = spec/oscal-content
-	url = https://github.com/usnistgov/oscal-content

data/.hound.yml

@@ -1,5 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-ruby:
-  enabled: true
-  config_file: .rubocop.yml

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

data/.rubocop.yml

@@ -1,10 +0,0 @@
-# Auto-generated by Cimas: Do not edit it manually!
-# See https://github.com/metanorma/cimas
-inherit_from:
-  - https://raw.githubusercontent.com/riboseinc/oss-guides/master/ci/rubocop.yml
-
-# local repo-specific modifications
-# ...
-
-AllCops:
-  TargetRubyVersion: 2.7

data/.ruby-version

@@ -1 +0,0 @@
-3.3.1

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ronald.tse@ribose.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-source "https://rubygems.org"
-
-# Specify your gem's dependencies in oscal.gemspec
-gemspec
-
-gem "rake", "~> 13.0"
-
-gem "rspec", "~> 3.0"
-
-gem "rubocop", "~> 1.21"
-
-gem "rubocop-performance", "~> 1.16"
-
-gem "debug"

data/LICENSE

@@ -1,25 +0,0 @@
-BSD 2-Clause License
-
-Copyright (c) 2023, Ribose
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions are met:
-
-* Redistributions of source code must retain the above copyright notice, this
-  list of conditions and the following disclaimer.
-
-* Redistributions in binary form must reproduce the above copyright notice,
-  this list of conditions and the following disclaimer in the documentation
-  and/or other materials provided with the distribution.
-
-THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
-AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
-IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
-DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
-FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
-DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
-SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
-CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
-OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/Makefile

@@ -1 +0,0 @@
-.docker/Makefile

data/README.adoc

@@ -1,115 +0,0 @@
-= OSCAL in Ruby
-
-== Purpose
-
-This is an implementation of the OSCAL models, allowing the manipulation of
-these models, as well as reading and writing of OSCAL serialization formats
-(YAML, JSON, XML).
-
-NOTE: This gem is used by the
-https://github.com/metanorma/metanorma-plugin-oscal[Metanorma plugin for OSCAL].
-
-
-== Installation
-
-Install the gem:
-
-[source,console]
-----
-[sudo] gem install oscal
-----
-
-or add it to your `Gemfile`:
-
-[source,ruby]
-----
-gem 'oscal'
-----
-
-== Command-line usage
-
-TODO: Write usage instructions here
-
-[source,ruby]
-----
-> require 'oscal'
-> x = Oscal::Catalog.load_from_yaml('spec/oscal-content/examples/catalog/yaml/basic-catalog.yaml')
-=>
-#<Oscal::Catalog:0x000000010b817e08
-...
-> x.groups.first.groups.first.parts.first.prose
-=> "To establish a management framework to initiate and control the implementation and operation of information security within the organization."
-----
-
-Get all controls
-
-[source,ruby]
-----
-> require 'oscal'
-> x = Oscal::Catalog.load_from_yaml('spec/oscal-content/examples/catalog/yaml/basic-catalog.yaml')
-=>
-#<Oscal::Catalog:0x000000010b817e08
-...
-> o = x.get_all_controls
-> o.count
-=> 4
-----
-
-Find object by id
-
-[source,ruby]
-----
-> require 'oscal'
-> x = Oscal::Catalog.load_from_yaml('spec/oscal-content/examples/catalog/yaml/basic-catalog.yaml')
-=>
-#<Oscal::Catalog:0x000000010b817e08
-...
-> p = x.find_object_by_id('s1.1_smt')
-=>
-#<Oscal::Part:0x000000014c0c4070 @id="s1.1_smt", ...>
-----
-
-Find object by uuid
-
-[source,ruby]
-----
-> require 'oscal'
-> x = Oscal::Catalog.load_from_yaml('spec/oscal-content/examples/catalog/yaml/basic-catalog.yaml')
-=>
-#<Oscal::Catalog:0x000000010b817e08
-...
-> p = x.find_object_by_id('74c8ba1e-5cd4-4ad1-bbfd-d888e2f6c724', x, :uuid)
-=>
-#<Oscal::Catalog:0x000000014c0c5f38 @uuid="74c8ba1e-5cd4-4ad1-bbfd-d888e2f6c724", ...>
-----
-
-== Ruby library usage
-
-TODO: Write usage instructions here
-
-== 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
-https://rubygems.org.
-
-== Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/metanorma/oscal. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the https://github.com/metanorma/oscal/blob/main/CODE_OF_CONDUCT.md[code of conduct].
-
-== Code of Conduct
-
-Everyone interacting in the Oscal project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the https://github.com/metanorma/oscal/blob/main/CODE_OF_CONDUCT.md[code of conduct].
-
-== LICENSE
-
-Copyright Ribose. The OSCAL schema is published by NIST.
-
-Published under the 2-clause BSD license.
-

data/Rakefile

@@ -1,19 +0,0 @@
-# frozen_string_literal: true
-
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-
-# Note:
-#
-# There seems to be lots of issue with the current rubocop rules
-# We are commenting this out for the moment, so instead of fixing
-# those right away, we can focus on the new codes and then later
-# come back to this and fix the issues.
-#
-# require "rubocop/rake_task"
-# RuboCop::RakeTask.new
-#
-# task default: %i[spec rubocop]
-
-RSpec::Core::RakeTask.new(:spec)
-task default: :spec

data/bin/console

@@ -1,30 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-require "bundler/setup"
-require "oscal"
-
-# 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"
-
-def reload!(print = true)
-  puts "Reloading ..." if print
-  # Main project directory.
-  root_dir = File.expand_path("..", __dir__)
-  # Directories within the project that should be reloaded.
-  reload_dirs = %w{lib}
-  # Loop through and reload every file in all relevant project directories.
-  reload_dirs.each do |dir|
-    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
-  end
-  # Return true when complete.
-  true
-end
-
-IRB.start(__FILE__)

data/bin/rspec

@@ -1,27 +0,0 @@
-#!/usr/bin/env ruby
-# frozen_string_literal: true
-
-#
-# This file was generated by Bundler.
-#
-# The application 'rspec' is installed as part of a gem, and
-# this file is here to facilitate running it.
-#
-
-ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../Gemfile", __dir__)
-
-bundle_binstub = File.expand_path("bundle", __dir__)
-
-if File.file?(bundle_binstub)
-  if /This file was generated by Bundler/.match?(File.read(bundle_binstub, 300))
-    load(bundle_binstub)
-  else
-    abort("Your `bin/bundle` was not generated by Bundler, so this binstub cannot run.
-Replace `bin/bundle` by running `bundle binstubs bundler --force`, then run this command again.")
-  end
-end
-
-require "rubygems"
-require "bundler/setup"
-
-load Gem.bin_path("rspec-core", "rspec")

data/bin/setup

@@ -1,8 +0,0 @@
-#!/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/docker-compose.yml

@@ -1 +0,0 @@
-.docker/docker-compose.yml