oscal 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6c9dffa10602fbcd753774bb2705bfa2e16f2ff29bbed89e7a2283a6b0d7391
-  data.tar.gz: dd31b313d847beb37d506adfedf853a588b977e06c49eb4fd973b064ffd2bcb6
+  metadata.gz: b3d2839d5707adc52e720080828918e04373d2399cbd138edd403055b1712cc0
+  data.tar.gz: 0fc05ead23c4745d188f9bf359c2594463867fd1cce5256a271cf93befef287e
 SHA512:
-  metadata.gz: a8f32ccd54e26dbc258dd8d2523379b62e4cddb04283ac473abf1553b27c66d87cb68ce465ae1841afb37adcad9b67d537388f3b0f0abd7795767ee0bdbec072
-  data.tar.gz: a963912423d5de00406411403949bb010309a07721e6b6de7d6362f30324d281ae05701cb8ca9f17c830d393210a4a1e0a649d77e86aabb25d58699316c592dd
+  metadata.gz: 91233436e998fe98ae7d84873ac7d8b68f9fc84ec6f7a7775533ee45922beaeb507c031ed88da4fe0ed71f34e76064861e6e3b0cb340acac23d25b3134cc323f
+  data.tar.gz: 957a56d62c3c43b5d22f4659b993acbd6e85ad344fe042fda702a3e07dda5fed576caf6ad0b742eb783597ac0e1165020af957a8d6c9699b0aad977910a910aa

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,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

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/.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.5

data/Gemfile

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

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

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