oscal 0.2.2 → 0.4.0

data/lib/oscal/parsing_functions.rb

@@ -1,19 +0,0 @@
-module Oscal
-  module ParsingFunctions
-    def sym2str(key)
-      if key.is_a?(Symbol)
-        key.to_s.gsub("-", "_").gsub("class", "klass")
-      elsif key.is_a?(String)
-        key
-      end
-    end
-
-    def str2sym(var)
-      if var.is_a?(String)
-        var.gsub("-", "_").gsub("class", "klass").to_sym
-      elsif var.is_a?(Symbol)
-        var
-      end
-    end
-  end
-end

data/lib/oscal/part.rb

@@ -1,24 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Part < Oscal::BaseClass
-    KEY = %i(id name ns klass title props prose parts links)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "props"
-        Property.wrap(val)
-      when "parts"
-        Part.wrap(val)
-      when "links"
-        Link.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/party.rb

@@ -1,36 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Party < Oscal::BaseClass
-    KEY = %i(uuid type name short_name external_ids props links
-             email_addresses telephone_numbers addresses location_uuids
-             member_of_organizations remakrs)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "external_ids"
-        ExternalId.wrap(val)
-      when "props"
-        Property.wrap(val)
-      when "links"
-        Link.wrap(val)
-      when "email_addresses"
-        EmailAddress.wrap(val)
-      when "telephone_numbers"
-        TelephoneNumber.wrap(val)
-      when "addresses"
-        Address.wrap(val)
-      when "location_uuids"
-        LocationUuid.wrap(val)
-      when "member_of_organizations"
-        MemberOfOrganization.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/party_uuid.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class PartyUuid < Oscal::BaseClass
-    KEY = %i(val)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/profile.rb

@@ -1,37 +0,0 @@
-require_relative "serializer"
-require_relative "common_utils"
-
-module Oscal
-  class Profile
-    include Serializer
-    include CommonUtils
-
-    KEY = %i(uuid metadata imports merge modify back_matter)
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def initialize(uuid, metadata, imports, merge, modify, back_matter)
-      @uuid        = uuid
-      @metadata    = MetadataBlock.new(metadata)
-      @imports     = ImportObject.wrap(imports) if imports
-      @merge       = Merge.wrap(merge) if merge
-      @modify      = Modify.wrap(modify) if modify
-      @back_matter = BackMatter.wrap(back_matter) if back_matter
-    end
-
-    def self.load_from_yaml(path)
-      yaml_data     = safe_load_yaml(path)
-      yaml_profile  = yaml_data["profile"]
-
-      uuid          = yaml_profile["uuid"]
-      metadata      = yaml_profile["metadata"]
-      imports       = yaml_profile["imports"]
-      merge         = yaml_profile["merge"]
-      modify        = yaml_profile["modify"]
-      back_matter   = yaml_profile["back-matter"]
-
-      Profile.new(uuid, metadata, imports, merge, modify, back_matter)
-    end
-  end
-end

data/lib/oscal/property.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Property < Oscal::BaseClass
-    KEY = %i(name uuid ns value klass remarks)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/remove.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Remove < Oscal::BaseClass
-    KEY = %i(by_name by_class by_id by_item_name by_ns)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/resource.rb

@@ -1,29 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Resource < Oscal::BaseClass
-    KEY = %i(uuid title description props docuement_ids citation rlinks
-             base64 remarks)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "props"
-        Property.wrap(val)
-      when "document_ids"
-        DocumentId.wrap(val)
-      when "citation"
-        Citation.wrap(val)
-      when "rlinks"
-        Rlink.wrap(val)
-      when "base64"
-        Base64Object.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/responsible_party.rb

@@ -1,24 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class ResponsibleParty < Oscal::BaseClass
-    KEY = %i(role_id party_uuids props links remakrs)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "party_uuids"
-        PartyUuid.wrap(val)
-      when "props"
-        Property.wrap(val)
-      when "links"
-        Link.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/revision.rb

@@ -1,23 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Revision < Oscal::BaseClass
-    KEY = %i(title published last_modified version oscal_version
-             props links remarks)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "props"
-        Property.wrap(val)
-      when "links"
-        Link.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/rlink.rb

@@ -1,20 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Rlink < Oscal::BaseClass
-    KEY = %i(href media_type hashes)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "hashes"
-        HashObject.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/role.rb

@@ -1,22 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Role < Oscal::BaseClass
-    KEY = %i(id title short_name description props links remakrs)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "props"
-        Property.wrap(val)
-      when "links"
-        Link.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/select.rb

@@ -1,20 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Select < Oscal::BaseClass
-    KEY = %i(how_many choice)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "choice"
-        Choice.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/serializer.rb

@@ -1,75 +0,0 @@
-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.safe_load(yaml_string)
-        from_h(data)
-      end
-
-      def from_xml(xml_element)
-        raise NotImplementedError, "#{self}#from_xml not implemented!"
-      end
-
-      # Psych >= 4 requires permitted_classes to load such classes
-      # https://github.com/ruby/psych/issues/533
-      def safe_load_yaml(path)
-        YAML.load_file(
-          path,
-          permitted_classes: [::Time, ::Date, ::DateTime],
-        )
-      rescue ArgumentError
-        YAML.load_file(path)
-      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}=") do |value|
-            instance_variable_set("@#{attr}", value)
-          end
-        end
-      end
-    end
-  end
-end

data/lib/oscal/set_parameter.rb

@@ -1,31 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class SetParameter < Oscal::BaseClass
-    KEY = %i(param_id klass depneds_on props links label usage
-             constraints guidelines values select)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def set_value(key_name, val)
-      case key_name
-      when "props"
-        Property.wrap(val)
-      when "links"
-        Link.wrap(val)
-      when "constraints"
-        Constraint.wrap(val)
-      when "guidelines"
-        Guideline.wrap(val)
-      when "values"
-        Value.wrap(val)
-      when "select"
-        Select.wrap(val)
-      else
-        val
-      end
-    end
-  end
-end

data/lib/oscal/telephone_number.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class TelephoneNumber < Oscal::BaseClass
-    KEY = %i(type number)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/test.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Test < Oscal::BaseClass
-    KEY = %i(expression remarks)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/url.rb

@@ -1,11 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Url < Oscal::BaseClass
-    KEY = %i(val)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-  end
-end

data/lib/oscal/value.rb

@@ -1,37 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class Value < Oscal::BaseClass
-    include Serializer
-
-    KEY = %i(val)
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def self.wrap(obj)
-      return obj if obj.is_a? Value
-      return Value.new(obj) unless obj.is_a? Array
-
-      obj.map do |x|
-        Value.wrap(x)
-      end
-    end
-
-    def initialize(options = {})
-      unless options.is_a? Hash
-        options = { "val" => options }
-      end
-
-      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 Value")
-        end
-
-        self.send("#{key_name}=", val)
-      end
-    end
-  end
-end

data/lib/oscal/with_id.rb

@@ -1,40 +0,0 @@
-require_relative "base_class"
-
-module Oscal
-  class WithId < Oscal::BaseClass
-    include Serializer
-
-    KEY = %i(val)
-
-    attr_accessor *KEY
-
-    attr_serializable *KEY
-
-    def self.wrap(obj)
-      return obj if obj.is_a? WithId
-      return WithId.new(obj) unless obj.is_a? Array
-
-      obj.map do |x|
-        WithId.wrap(x)
-      end
-    end
-
-    def initialize(options = {})
-      klass = self.class
-
-      unless options.is_a? Hash
-        options = { KEY.first.to_s => options }
-      end
-
-      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 #{klass.name}")
-        end
-
-        send("#{key_name}=", val)
-      end
-    end
-  end
-end

data/oscal.gemspec

@@ -1,30 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "lib/oscal/version"
-
-Gem::Specification.new do |spec|
-  spec.name = "oscal"
-  spec.version = Oscal::VERSION
-  spec.authors = ["Ribose Inc."]
-  spec.email = ["open.source@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.license = "BSD-2-Clause"
-
-  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"
-
-  spec.files         = `git ls-files`.split("\n")
-  spec.executables   = `git ls-files -- exe/*`.split("\n").map do |f|
-    File.basename(f)
-  end
-  spec.bindir        = "exe"
-  spec.require_paths = ["lib"]
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")
-
-  spec.add_dependency "yaml"
-  spec.metadata["rubygems_mfa_required"] = "true"
-end

data/sig/oscal.rbs

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

data/spec/oscal/catalog_spec.rb

@@ -1,40 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Oscal::Catalog do
-  let(:subject) do
-    Oscal::Catalog.load_from_yaml(
-      "spec/oscal-content/examples/catalog/yaml/basic-catalog.yaml",
-    )
-  end
-
-  it "parses oscal-content YAML" do
-    expect(subject.class).to be Oscal::Catalog
-    expect(subject.groups.first.groups.first.controls.first.parts.first.prose).to eq(
-      "To establish a management framework to initiate and " \
-      "control the implementation and operation of information security " \
-      "within the organization.",
-    )
-  end
-
-  it "gets all controls" do
-    expect(subject.class).to be Oscal::Catalog
-    expect(subject.get_all_controls.count).to eq(4)
-  end
-
-  it "find object by id" do
-    obj = subject.find_object_by_id("s2.1_smt")
-    expect(obj.to_s).to match(/Oscal::Part/)
-    expect(obj.prose).to eq(
-      "To limit access to information and information processing facilities.",
-    )
-  end
-
-  it "find object by uuid" do
-    uuid = "74c8ba1e-5cd4-4ad1-bbfd-d888e2f6c724"
-    obj = subject.find_object_by_id(
-      uuid, subject, :uuid
-    )
-    expect(obj.to_s).to match(/Oscal::Catalog/)
-    expect(obj.uuid).to eq(uuid)
-  end
-end

data/spec/oscal_spec.rb

@@ -1,18 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe Oscal do
-  it "has a version number" do
-    expect(Oscal::VERSION).not_to be nil
-  end
-
-  it "allows setting a new logger" do
-    logger = double(Logger)
-    Oscal::ParsingLogger.logger = logger
-
-    class LoggerTest
-      include Oscal::ParsingLogger
-    end
-
-    expect(LoggerTest.new.get_logger).to eq logger
-  end
-end

data/spec/sample_inputs/import-ap.json

@@ -1,4 +0,0 @@
-{
-    "href": "../3-implementation/ssp.oscal.xml",
-    "remarks": "These are valid remarks."
-}

data/spec/spec_helper.rb

@@ -1,15 +0,0 @@
-# frozen_string_literal: true
-
-require "oscal"
-
-RSpec.configure do |config|
-  # Enable flags like --only-failures and --next-failure
-  config.example_status_persistence_file_path = ".rspec_status"
-
-  # Disable RSpec exposing methods globally on `Module` and `main`
-  config.disable_monkey_patching!
-
-  config.expect_with :rspec do |c|
-    c.syntax = :expect
-  end
-end