oscal 0.1.1 → 0.2.0

data/lib/oscal/include_control.rb

@@ -5,13 +5,14 @@ module Oscal
     KEY = %i(with_child_controls with_ids matching)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'with_ids'
+      when "with_ids"
         WithId.wrap(val)
-      when 'matching'
+      when "matching"
         Matching.wrap(val)
       else
         val

data/lib/oscal/insert_control.rb

@@ -5,13 +5,14 @@ module Oscal
     KEY = %i(order include_all include_controls exclude_controls)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'include_controls'
+      when "include_controls"
         IncludeControl.wrap(val)
-      when 'exclude_controls'
+      when "exclude_controls"
         ExcludeControls.wrap(val)
       else
         val

data/lib/oscal/link.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(href rel media_type text)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/list.rb

@@ -0,0 +1,160 @@
+require_relative("link")
+require_relative("property")
+require_relative("logger")
+
+module Oscal
+  class OscalArray < Array
+    include ParsingLogger
+
+    def validate_member_type(input)
+      @logger.debug("Validating array members are #{self.class::MEMBER_TYPE}")
+      input.map do |item|
+        self.class::MEMBER_TYPE.new(item)
+      end
+    end
+
+    def initialize(input)
+      super
+      @logger = get_logger
+      @logger.debug("#{self.class}.new called with #{input.to_s[0, 25]}")
+      validate_member_type(input)
+    end
+  end
+
+  # These classes define generic arrays of basic DataTypes,
+  # They appear in several different places in the Oscal specs
+  # and can be subclassed with a different name
+  class StringDataTypeArray < Oscal::OscalArray
+    MEMBER_TYPE = StringDataType
+  end
+
+  class TokenDataTypeArray < Oscal::OscalArray
+    MEMBER_TYPE = TokenDataType
+  end
+
+  class UuidArray < Oscal::OscalArray
+    MEMBER_TYPE = Uuid
+  end
+
+  module AssessmentResult
+    class ActivityArray < Oscal::OscalArray
+      MEMBER_TYPE = Activity
+    end
+
+    class AssessmentPlatformArray < Oscal::OscalArray
+      MEMBER_TYPE = AssessmentPlatform
+    end
+
+    class AssessmentTaskArray < Oscal::OscalArray
+      MEMBER_TYPE = AssessmentTask
+    end
+
+    class AssociatedActivityArray < Oscal::OscalArray
+      MEMBER_TYPE = AssociatedActivity
+    end
+
+    class AttestationArray < Oscal::OscalArray
+      MEMBER_TYPE = Attestation
+    end
+
+    class ComponentArray < Oscal::OscalArray
+      MEMBER_TYPE = Component
+    end
+
+    class ControlObjectiveSelectionArray < Oscal::OscalArray
+      MEMBER_TYPE = ControlObjectiveSelection
+    end
+
+    class ControlSelectionArray < Oscal::OscalArray
+      MEMBER_TYPE = ControlSelection
+    end
+
+    class EntryArray < Oscal::OscalArray
+      MEMBER_TYPE = Entry
+    end
+
+    class ExcludeControlArray < Oscal::OscalArray
+      MEMBER_TYPE = ExcludeControl
+    end
+
+    class ExcludeObjectiveArray < Oscal::OscalArray
+      MEMBER_TYPE = ExcludeObjective
+    end
+
+    class FindingArray < Oscal::OscalArray
+      MEMBER_TYPE = Finding
+    end
+
+    class IncludeControlArray < Oscal::OscalArray
+      MEMBER_TYPE = IncludeControl
+    end
+
+    class InventoryItemArray < Oscal::OscalArray
+      MEMBER_TYPE = InventoryItem
+    end
+
+    class LinkArray < Oscal::OscalArray
+      MEMBER_TYPE = Oscal::Link
+    end
+
+    class MethodArray < StringDataTypeArray
+    end
+
+    class ObjectivesAndMethodsArray < Oscal::OscalArray
+      MEMBER_TYPE = ObjectivesAndMethods
+    end
+
+    class ObservationArray < Oscal::OscalArray
+      MEMBER_TYPE = Observation
+    end
+
+    class PartArray < Oscal::OscalArray
+      MEMBER_TYPE = Link
+    end
+
+    class PartyUuidArray < UuidArray
+    end
+
+    class PropArray < Oscal::OscalArray
+      MEMBER_TYPE = Property
+    end
+
+    class RelatedObservationArray < Oscal::OscalArray
+      MEMBER_TYPE = RelatedObservation
+    end
+
+    class RelatedRiskArray < Oscal::OscalArray
+      MEMBER_TYPE = AssociatedRisk
+    end
+
+    class ResponsibleRoleArray < Oscal::OscalArray
+      MEMBER_TYPE = ResponsibleRole
+    end
+
+    class ResultArray < Oscal::OscalArray
+      MEMBER_TYPE = Result
+    end
+
+    class RiskArray < Oscal::OscalArray
+      MEMBER_TYPE = Risk
+    end
+
+    class StatementIdArray < TokenDataTypeArray
+    end
+
+    class StepArray < Oscal::OscalArray
+      MEMBER_TYPE = Step
+    end
+
+    class SubjectArray < Oscal::OscalArray
+      MEMBER_TYPE = Subject
+    end
+
+    class TypeArray < TokenDataTypeArray
+    end
+
+    class UserArray < Oscal::OscalArray
+      MEMBER_TYPE = User
+    end
+  end
+end

data/lib/oscal/location.rb

@@ -3,24 +3,25 @@ require_relative "base_class"
 module Oscal
   class Location < Oscal::BaseClass
     KEY = %i(uuid title address email_addresses telephone_numbers urls
-      props links remakrs)
+             props links remakrs)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'address'
+      when "address"
         Address.wrap(val)
-      when 'email_addresses'
+      when "email_addresses"
         EmailAddress.wrap(val)
-      when 'telephone_numbers'
+      when "telephone_numbers"
         TelephoneNumber.wrap(val)
-      when 'urls'
+      when "urls"
         Url.wrap(val)
-      when 'props'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
       else
         val

data/lib/oscal/location_uuid.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(val)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/logger.rb

@@ -0,0 +1,8 @@
+module Oscal
+  module ParsingLogger
+    require "logger"
+    def get_logger
+      Logger.new($stdout)
+    end
+  end
+end

data/lib/oscal/matching.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(pattern)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/member_of_organization.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(val)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/merge.rb

@@ -5,11 +5,12 @@ module Oscal
     KEY = %i(combine flat as_is custom)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'custom'
+      when "custom"
         Custom.wrap(val)
       else
         val

data/lib/oscal/metadata_block.rb

@@ -3,29 +3,30 @@ require_relative "base_class"
 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)
+             oscal_version revisions document_ids props links roles
+             locations parties responsible_parties remarks)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'revisions'
+      when "revisions"
         Revision.wrap(val)
-      when 'docuement_ids'
+      when "docuement_ids"
         DocumentId.wrap(val)
-      when 'props'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
-      when 'roles'
+      when "roles"
         Role.wrap(val)
-      when 'locations'
+      when "locations"
         Location.wrap(val)
-      when 'parties'
+      when "parties"
         Party.wrap(val)
-      when 'responsible_parties'
+      when "responsible_parties"
         ResponsibleParty.wrap(val)
       else
         val

data/lib/oscal/modify.rb

@@ -5,13 +5,14 @@ module Oscal
     KEY = %i(set_parameters alters)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'set_parameters'
+      when "set_parameters"
         SetParameter.wrap(val)
-      when 'alters'
+      when "alters"
         Alter.wrap(val)
       else
         val

data/lib/oscal/parameter.rb

@@ -3,24 +3,25 @@ require_relative "base_class"
 module Oscal
   class Parameter < Oscal::BaseClass
     KEY = %i(id klass depneds_on props links label usage
-      constraints guidelines values select remarks)
+             constraints guidelines values select remarks)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'props'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
-      when 'constraints'
+      when "constraints"
         Constraint.wrap(val)
-      when 'guidelines'
+      when "guidelines"
         Guideline.wrap(val)
-      when 'values'
+      when "values"
         Value.wrap(val)
-      when 'select'
+      when "select"
         Select.wrap(val)
       else
         val

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

@@ -5,15 +5,16 @@ module Oscal
     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'
+      when "props"
         Property.wrap(val)
-      when 'parts'
+      when "parts"
         Part.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
       else
         val

data/lib/oscal/party.rb

@@ -3,29 +3,30 @@ 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)
+             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'
+      when "external_ids"
         ExternalId.wrap(val)
-      when 'props'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
-      when 'email_addresses'
+      when "email_addresses"
         EmailAddress.wrap(val)
-      when 'telephone_numbers'
+      when "telephone_numbers"
         TelephoneNumber.wrap(val)
-      when 'addresses'
+      when "addresses"
         Address.wrap(val)
-      when 'location_uuids'
+      when "location_uuids"
         LocationUuid.wrap(val)
-      when 'member_of_organizations'
+      when "member_of_organizations"
         MemberOfOrganization.wrap(val)
       else
         val

data/lib/oscal/party_uuid.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(val)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/profile.rb

@@ -8,6 +8,7 @@ module Oscal
 
     KEY = %i(uuid metadata imports merge modify back_matter)
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def initialize(uuid, metadata, imports, merge, modify, back_matter)
@@ -23,12 +24,12 @@ module Oscal
       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']
+      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

data/lib/oscal/property.rb

@@ -5,6 +5,7 @@ module Oscal
     KEY = %i(name uuid ns value klass remarks)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
   end
 end

data/lib/oscal/remove.rb

@@ -5,6 +5,7 @@ module Oscal
     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

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

data/lib/oscal/responsible_party.rb

@@ -5,19 +5,20 @@ module Oscal
     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
+      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

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

data/lib/oscal/rlink.rb

@@ -5,11 +5,12 @@ module Oscal
     KEY = %i(href media_type hashes)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'hashes'
+      when "hashes"
         HashObject.wrap(val)
       else
         val

data/lib/oscal/role.rb

@@ -5,13 +5,14 @@ module Oscal
     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'
+      when "props"
         Property.wrap(val)
-      when 'links'
+      when "links"
         Link.wrap(val)
       else
         val

data/lib/oscal/select.rb

@@ -5,11 +5,12 @@ module Oscal
     KEY = %i(how_many choice)
 
     attr_accessor *KEY
+
     attr_serializable *KEY
 
     def set_value(key_name, val)
       case key_name
-      when 'choice'
+      when "choice"
         Choice.wrap(val)
       else
         val