oscal 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c6c9dffa10602fbcd753774bb2705bfa2e16f2ff29bbed89e7a2283a6b0d7391
+  data.tar.gz: dd31b313d847beb37d506adfedf853a588b977e06c49eb4fd973b064ffd2bcb6
+SHA512:
+  metadata.gz: a8f32ccd54e26dbc258dd8d2523379b62e4cddb04283ac473abf1553b27c66d87cb68ce465ae1841afb37adcad9b67d537388f3b0f0abd7795767ee0bdbec072
+  data.tar.gz: a963912423d5de00406411403949bb010309a07721e6b6de7d6362f30324d281ae05701cb8ca9f17c830d393210a4a1e0a649d77e86aabb25d58699316c592dd

data/.rspec

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

data/CODE_OF_CONDUCT.md

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

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

data/README.adoc

@@ -0,0 +1,49 @@
+= OSCAL in Ruby
+
+== 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
+
+== 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.

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/lib/oscal/catalog.rb

@@ -0,0 +1,22 @@
+module Oscal
+  class Catalog
+    attr_accessor :uuid, :metadata, :groups
+
+    def initialize(metadata, groups)
+      @metadata = MetadataBlock.new(metadata)
+      @groups = Group.wrap(groups)
+    end
+
+    def self.load_from_yaml(path)
+      yaml_data = YAML.load_file(path, permitted_classes: [Time, Date, DateTime])
+
+      yaml_catalog = yaml_data['catalog']
+
+      metadata = yaml_catalog['metadata']
+      group_data = yaml_catalog['groups']
+
+      Catalog.new(metadata, group_data)
+    end
+  end
+
+end

data/lib/oscal/component.rb

@@ -0,0 +1,14 @@
+module Oscal
+  class Component
+    attr_accessor :id, :name, :type, :description, :properties
+
+    def initialize(id, name, type, description, properties)
+      @id = id
+      @name = name
+      @type = type
+      @description = description
+      @properties = properties
+    end
+  end
+
+end

data/lib/oscal/control.rb

@@ -0,0 +1,38 @@
+module Oscal
+  class Control
+    KEY = %i(id title params props parts)
+    attr_accessor *KEY
+
+    def self.wrap(obj)
+      return obj if obj.is_a? Control
+      return Control.new(obj) unless obj.is_a? Array
+
+      obj.map do |x|
+        Control.wrap(x)
+      end
+    end
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless KEY.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in Control")
+        end
+
+        val = case key_name
+        when 'params'
+          Parameter.wrap(val)
+        when 'props'
+          Property.wrap(val)
+        when 'parts'
+          Part.wrap(val)
+        else
+          val
+        end
+
+        self.send("#{key_name}=", val)
+      end
+    end
+  end
+end

data/lib/oscal/group.rb

@@ -0,0 +1,41 @@
+module Oscal
+  class Group
+    KEYS = %i(id class title controls props parts groups)
+    attr_accessor *KEYS
+
+    def self.wrap(obj)
+      return obj if obj.is_a? Group
+      return Group.new(obj) unless obj.is_a? Array
+
+      obj.map do |x|
+        Group.wrap(x)
+      end
+    end
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless KEYS.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in Group")
+        end
+
+        val = case key_name
+        when 'groups'
+          Group.wrap(val)
+        when 'params'
+          Parameter.wrap(val)
+        when 'props'
+          Property.wrap(val)
+        when 'parts'
+          Part.wrap(val)
+        else
+          val
+        end
+
+        self.send("#{key_name}=", val)
+      end
+    end
+
+  end
+end

data/lib/oscal/metadata_block.rb

@@ -0,0 +1,21 @@
+module Oscal
+  class MetadataBlock
+
+    METADATA_VALUES = %i(title published last_modified version
+      oscal_version remarks)
+
+    attr_accessor *METADATA_VALUES
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless METADATA_VALUES.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in MetadataBlock")
+        end
+        self.send("#{key_name}=", val)
+      end
+    end
+
+  end
+end

data/lib/oscal/parameter.rb

@@ -0,0 +1,28 @@
+module Oscal
+  class Parameter
+
+    KEY = %i(id label select)
+    attr_accessor *KEY
+
+    def self.wrap(obj)
+      return obj if obj.is_a? Parameter
+      return Parameter.new(obj) unless obj.is_a? Array
+
+      obj.map do |x|
+        Parameter.wrap(x)
+      end
+    end
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless KEY.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in Parameter")
+        end
+
+        self.send("#{key_name}=", val)
+      end
+    end
+  end
+end

data/lib/oscal/part.rb

@@ -0,0 +1,32 @@
+require_relative "serializer"
+
+module Oscal
+  class Part
+    include Serializer
+
+    KEY = %i(id name prose)
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def self.wrap(obj)
+      return obj if obj.is_a? Part
+      return Part.new(obj) unless obj.is_a? Array
+
+      obj.map do |x|
+        Part.wrap(x)
+      end
+    end
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless KEY.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in Part")
+        end
+
+        self.send("#{key_name}=", val)
+      end
+    end
+  end
+end

data/lib/oscal/profile.rb

@@ -0,0 +1,11 @@
+module Oscal
+    class Profile
+    attr_accessor :metadata, :imports, :controls
+
+    def initialize(metadata, imports, controls)
+      @metadata = metadata
+      @imports = imports
+      @controls = controls
+    end
+  end
+end

data/lib/oscal/property.rb

@@ -0,0 +1,32 @@
+require_relative "serializer"
+
+module Oscal
+  class Property
+    include Serializer
+
+    KEY = %i(name value)
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def self.wrap(obj)
+      return obj if obj.is_a? Property
+      return Property.new(obj) unless obj.is_a? Array
+
+      obj.map do |x|
+        Property.wrap(x)
+      end
+    end
+
+    def initialize(options={})
+      options.each_pair.each do |key,val|
+        key_name = key.gsub('-','_')
+
+        unless KEY.include?(key_name.to_sym)
+          raise UnknownAttributeError.new("Unknown key `#{key}` in Property")
+        end
+
+        self.send("#{key_name}=", val)
+      end
+    end
+  end
+end

data/lib/oscal/prose.rb

@@ -0,0 +1,13 @@
+require_relative "serializer"
+
+module Oscal
+  class Prose
+    include Serializer
+
+    attr_serializable :value, :media_type
+
+    def to_xml(builder)
+      builder.prose(value, {'media-type' => media_type})
+    end
+  end
+end

data/lib/oscal/serializer.rb

@@ -0,0 +1,62 @@
+require 'yaml'
+
+module Oscal
+  module Serializer
+    def to_h
+      instance_variables.each_with_object({}) do |var, hash|
+        var_name = var.to_s.delete('@')
+        hash[var_name] = instance_variable_get(var)
+      end
+    end
+
+    def to_json(*args)
+      to_h.to_json(*args)
+    end
+
+    def to_yaml
+      to_h.to_yaml
+    end
+
+    def to_xml(builder)
+      raise NotImplementedError, "#{self.class}#to_xml not implemented!"
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      def from_h(data)
+        new(*data.values_at(*attribute_names))
+      end
+
+      def from_json(json_string)
+        data = JSON.parse(json_string)
+        from_h(data)
+      end
+
+      def from_yaml(yaml_string)
+        data = YAML.load(yaml_string)
+        from_h(data)
+      end
+
+      def from_xml(xml_element)
+        raise NotImplementedError, "#{self}#from_xml not implemented!"
+      end
+
+      private
+
+      def attribute_names
+        @attribute_names ||= []
+      end
+
+      def attr_serializable(*attrs)
+        attrs.each do |attr|
+          attribute_names << attr.to_sym
+          define_method(attr) { instance_variable_get("@#{attr}") }
+          define_method("#{attr}=") { |value| instance_variable_set("@#{attr}", value) }
+        end
+      end
+    end
+  end
+end

data/lib/oscal/statement.rb

@@ -0,0 +1,12 @@
+module Oscal
+  class Statement
+    attr_accessor :description, :prose, :properties
+
+    def initialize(description, prose, properties)
+      @description = description
+      @prose = prose
+      @properties = properties
+    end
+  end
+
+end

data/lib/oscal/version.rb

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

data/lib/oscal.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require_relative "oscal/version"
+require_relative "oscal/serializer"
+require_relative "oscal/catalog"
+require_relative "oscal/component"
+require_relative "oscal/control"
+require_relative "oscal/group"
+require_relative "oscal/part"
+require_relative "oscal/parameter"
+require_relative "oscal/metadata_block"
+require_relative "oscal/profile"
+require_relative "oscal/property"
+require_relative "oscal/prose"
+require_relative "oscal/statement"
+
+module Oscal
+  class Error < StandardError; end
+
+  class UnknownAttributeError < Error; end
+  class InvalidTypeError < Error; end
+end

data/oscal.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/oscal/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "oscal"
+  spec.version = Oscal::VERSION
+  spec.authors = ["Ronald Tse"]
+  spec.email = ["ronald.tse@ribose.com"]
+
+  spec.summary = "Interact with OSCAL models"
+  spec.description = "Ruby library and parser for OSCAL models"
+  spec.homepage = "https://github.com/metanorma/oscal-ruby/"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/metanorma/oscal-ruby/"
+  spec.metadata["changelog_uri"] = "https://github.com/metanorma/oscal-ruby/CHANGELOG"
+
+  # 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(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "yaml"
+end

data/sig/oscal.rbs

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

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: oscal
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ronald Tse
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-03-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yaml
+  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: Ruby library and parser for OSCAL models
+email:
+- ronald.tse@ribose.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- README.adoc
+- Rakefile
+- lib/oscal.rb
+- lib/oscal/catalog.rb
+- lib/oscal/component.rb
+- lib/oscal/control.rb
+- lib/oscal/group.rb
+- lib/oscal/metadata_block.rb
+- lib/oscal/parameter.rb
+- lib/oscal/part.rb
+- lib/oscal/profile.rb
+- lib/oscal/property.rb
+- lib/oscal/prose.rb
+- lib/oscal/serializer.rb
+- lib/oscal/statement.rb
+- lib/oscal/version.rb
+- oscal.gemspec
+- sig/oscal.rbs
+homepage: https://github.com/metanorma/oscal-ruby/
+licenses: []
+metadata:
+  homepage_uri: https://github.com/metanorma/oscal-ruby/
+  source_code_uri: https://github.com/metanorma/oscal-ruby/
+  changelog_uri: https://github.com/metanorma/oscal-ruby/CHANGELOG
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: Interact with OSCAL models
+test_files: []