oscal 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c9dffa10602fbcd753774bb2705bfa2e16f2ff29bbed89e7a2283a6b0d7391
-  data.tar.gz: dd31b313d847beb37d506adfedf853a588b977e06c49eb4fd973b064ffd2bcb6
+  metadata.gz: 562c827a391c4d86af9edb5cdf98ee1a61fb3a7d57374aa29a3a70609df09bb3
+  data.tar.gz: 2031cf36b122b094cb3532bff51534de756907327d7f3bb09456a9120a510607
 SHA512:
-  metadata.gz: a8f32ccd54e26dbc258dd8d2523379b62e4cddb04283ac473abf1553b27c66d87cb68ce465ae1841afb37adcad9b67d537388f3b0f0abd7795767ee0bdbec072
-  data.tar.gz: a963912423d5de00406411403949bb010309a07721e6b6de7d6362f30324d281ae05701cb8ca9f17c830d393210a4a1e0a649d77e86aabb25d58699316c592dd
+  metadata.gz: cbd11774c99f75b1e8b365488fb3fdd4969a7917de692cbf7546118b2a3102767af8b9ed9a140c2998a0d4cff9f282061eeea03da47371b864d67067307433c3
+  data.tar.gz: d7510b9543be93b734be45f0d4140d32413af2d8a5462339bac65db9de3ff9a98c3b696537af73a9f23c1f491e85b269e898008df07da5180b2036e52fdff48a

data/.docker/Dockerfile

@@ -0,0 +1,19 @@
+ARG RUBY_IMAGE=ruby:3.1.2-slim
+
+FROM ${RUBY_IMAGE}
+
+RUN apt-get update \
+    && apt-get install -y build-essential git \
+    && apt-get clean && rm -rf /var/lib/apt/lists/*
+
+# install latest bundler
+RUN gem install bundler
+
+# Create app directory
+WORKDIR /workspace
+
+# Set bundle path
+ENV BUNDLE_PATH /bundle
+
+# Default to console
+CMD ["bin/console"]

data/.docker/Makefile

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

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

data/.docker/readme.md

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

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

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

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

data/.gitmodules

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

data/.hound.yml

@@ -0,0 +1,5 @@
+# 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,3 +1,2 @@
---format documentation
 --color
 --require spec_helper

data/.rubocop.yml

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

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

data/Gemfile

@@ -10,3 +10,7 @@ gem "rake", "~> 13.0"
 gem "rspec", "~> 3.0"
 
 gem "rubocop", "~> 1.21"
+
+gem "rubocop-performance", "~> 1.16"
+
+gem "debug"

data/LICENSE

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

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

data/README.adoc

@@ -1,5 +1,15 @@
 = 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:
@@ -20,6 +30,59 @@ gem 'oscal'
 
 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
@@ -47,3 +110,6 @@ Everyone interacting in the Oscal project's codebases, issue trackers, chat room
 == LICENSE
 
 Copyright Ribose. The OSCAL schema is published by NIST.
+
+Published under the 2-clause BSD license.
+

data/Rakefile

@@ -3,10 +3,17 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
-RSpec::Core::RakeTask.new(:spec)
-
-require "rubocop/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]
 
-RuboCop::RakeTask.new
-
-task default: %i[spec rubocop]
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec

data/bin/console

@@ -0,0 +1,30 @@
+#!/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

@@ -0,0 +1,27 @@
+#!/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

@@ -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/docker-compose.yml

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