oscal 0.1.0 → 0.2.0

data/lib/oscal/metadata_block.rb

@@ -1,21 +1,36 @@
-module Oscal
-  class MetadataBlock
+require_relative "base_class"
 
-    METADATA_VALUES = %i(title published last_modified version
-      oscal_version remarks)
+module Oscal
+  class MetadataBlock < Oscal::BaseClass
+    KEY = %i(title published last_modified version
+             oscal_version revisions document_ids props links roles
+             locations parties responsible_parties remarks)
 
-    attr_accessor *METADATA_VALUES
+    attr_accessor *KEY
 
-    def initialize(options={})
-      options.each_pair.each do |key,val|
-        key_name = key.gsub('-','_')
+    attr_serializable *KEY
 
-        unless METADATA_VALUES.include?(key_name.to_sym)
-          raise UnknownAttributeError.new("Unknown key `#{key}` in MetadataBlock")
-        end
-        self.send("#{key_name}=", val)
+    def set_value(key_name, val)
+      case key_name
+      when "revisions"
+        Revision.wrap(val)
+      when "docuement_ids"
+        DocumentId.wrap(val)
+      when "props"
+        Property.wrap(val)
+      when "links"
+        Link.wrap(val)
+      when "roles"
+        Role.wrap(val)
+      when "locations"
+        Location.wrap(val)
+      when "parties"
+        Party.wrap(val)
+      when "responsible_parties"
+        ResponsibleParty.wrap(val)
+      else
+        val
       end
     end
-
   end
 end

data/lib/oscal/modify.rb

@@ -0,0 +1,22 @@
+require_relative "base_class"
+
+module Oscal
+  class Modify < Oscal::BaseClass
+    KEY = %i(set_parameters alters)
+
+    attr_accessor *KEY
+
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when "set_parameters"
+        SetParameter.wrap(val)
+      when "alters"
+        Alter.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/parameter.rb

@@ -1,27 +1,30 @@
+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
 
-    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
+    attr_serializable *KEY
 
-        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/parsing_functions.rb

@@ -0,0 +1,19 @@
+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,31 +1,23 @@
-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
+    attr_serializable *KEY
 
-        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,36 @@
+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,11 @@
+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,37 @@
+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,11 @@
-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
+    attr_serializable *KEY
   end
 end

data/lib/oscal/remove.rb

@@ -0,0 +1,11 @@
+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,29 @@
+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,24 @@
+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,23 @@
+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,20 @@
+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,22 @@
+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,20 @@
+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,31 @@
+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,11 @@
+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,11 @@
+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,11 @@
+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,37 @@
+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.2.0"
 end

data/lib/oscal/with_id.rb

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