oscal 0.1.0 → 0.1.1

data/lib/oscal/parameter.rb

@@ -1,27 +1,29 @@
+require_relative "base_class"
+
 module Oscal
-  class Parameter
+  class Parameter < Oscal::BaseClass
+    KEY = %i(id klass depneds_on props links label usage
+      constraints guidelines values select remarks)
 
-    KEY = %i(id label select)
     attr_accessor *KEY
+    attr_serializable *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)
+    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

data/lib/oscal/part.rb

@@ -1,31 +1,22 @@
-require_relative "serializer"
+require_relative "base_class"
 
 module Oscal
-  class Part
-    include Serializer
+  class Part < Oscal::BaseClass
+    KEY = %i(id name ns klass title props prose parts links)
 
-    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)
+    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

data/lib/oscal/party.rb

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

@@ -0,0 +1,10 @@
+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,11 +1,36 @@
+require_relative "serializer"
+require_relative "common_utils"
+
 module Oscal
-    class Profile
-    attr_accessor :metadata, :imports, :controls
+  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']
 
-    def initialize(metadata, imports, controls)
-      @metadata = metadata
-      @imports = imports
-      @controls = controls
+      Profile.new(uuid, metadata, imports, merge, modify, back_matter)
     end
   end
-end
+end

data/lib/oscal/property.rb

@@ -1,32 +1,10 @@
-require_relative "serializer"
+require_relative "base_class"
 
 module Oscal
-  class Property
-    include Serializer
+  class Property < Oscal::BaseClass
+    KEY = %i(name uuid ns value klass remarks)
 
-    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/remove.rb

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

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

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

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

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

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

@@ -0,0 +1,19 @@
+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,10 +1,10 @@
-require 'yaml'
+require "yaml"
 
 module Oscal
   module Serializer
     def to_h
       instance_variables.each_with_object({}) do |var, hash|
-        var_name = var.to_s.delete('@')
+        var_name = var.to_s.delete("@")
         hash[var_name] = instance_variable_get(var)
       end
     end
@@ -36,7 +36,7 @@ module Oscal
       end
 
       def from_yaml(yaml_string)
-        data = YAML.load(yaml_string)
+        data = YAML.safe_load(yaml_string)
         from_h(data)
       end
 
@@ -44,6 +44,17 @@ module Oscal
         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
@@ -54,7 +65,9 @@ module Oscal
         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) }
+          define_method("#{attr}=") do |value|
+            instance_variable_set("@#{attr}", value)
+          end
         end
       end
     end

data/lib/oscal/set_parameter.rb

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

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

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

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

@@ -0,0 +1,36 @@
+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/version.rb

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

data/lib/oscal/with_id.rb

@@ -0,0 +1,39 @@
+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/lib/oscal.rb

@@ -1,18 +1,6 @@
 # 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"
+Dir[File.join(__dir__, 'oscal', '*.rb')].each { |file| require file }
 
 module Oscal
   class Error < StandardError; end

data/oscal.gemspec

@@ -5,28 +5,26 @@ 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.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.required_ruby_version = ">= 2.7.0"
+  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"
 
-  # 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
+  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.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  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/spec/oscal/catalog_spec.rb

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