oscal 0.1.0 → 0.1.1

data/lib/oscal/base_class.rb

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

data/lib/oscal/catalog.rb

@@ -1,22 +1,62 @@
+require "date"
+require_relative "serializer"
+require_relative "common_utils"
+
 module Oscal
   class Catalog
-    attr_accessor :uuid, :metadata, :groups
+    include Serializer
+    include CommonUtils
+
+    KEY = %i(uuid metadata params controls groups back_matter)
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def initialize(uuid, metadata, params, controls, groups, back_matter)
+      @uuid        = uuid
+      @metadata    = MetadataBlock.new(metadata)
+      @params      = Parameter.wrap(params) if params
+      @controls    = Control.wrap(controls) if controls
+      @groups      = Group.wrap(groups) if groups
+      @back_matter = BackMatter.wrap(back_matter) if back_matter
 
-    def initialize(metadata, groups)
-      @metadata = MetadataBlock.new(metadata)
-      @groups = Group.wrap(groups)
+      @all_controls = []
     end
 
     def self.load_from_yaml(path)
-      yaml_data = YAML.load_file(path, permitted_classes: [Time, Date, DateTime])
+      yaml_data     = safe_load_yaml(path)
+      yaml_catalog  = yaml_data["catalog"]
 
-      yaml_catalog = yaml_data['catalog']
+      uuid          = yaml_catalog['uuid']
+      metadata      = yaml_catalog['metadata']
+      params        = yaml_catalog['params']
+      controls      = yaml_catalog['controls']
+      groups        = yaml_catalog['groups']
+      back_matter   = yaml_catalog['back-matter']
 
-      metadata = yaml_catalog['metadata']
-      group_data = yaml_catalog['groups']
+      Catalog.new(uuid, metadata, params, controls, groups, back_matter)
+    end
 
-      Catalog.new(metadata, group_data)
+    def get_all_controls
+      append_all_control_group(self)
+      @all_controls.uniq
     end
-  end
 
+    def append_all_control_group(obj)
+      if obj.to_s.match(/Oscal::Control/)
+        @all_controls << obj
+      end
+
+      if obj.respond_to?(:controls) && !obj.controls.nil?
+        obj.controls.each do |c|
+          append_all_control_group(c)
+        end
+      end
+
+      if obj.respond_to?(:groups) && !obj.groups.nil?
+        obj.groups.each do |g|
+          append_all_control_group(g)
+        end
+      end
+    end
+  end
 end

data/lib/oscal/choice.rb

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

data/lib/oscal/citation.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class Citation < Oscal::BaseClass
+    KEY = %i(text props links)
+
+    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/combine.rb

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

data/lib/oscal/common_utils.rb

@@ -0,0 +1,35 @@
+module Oscal
+  module CommonUtils
+    def find_object_by_id(id, obj = self, attribute_name = :id)
+      if obj.respond_to?(attribute_name) && obj.send(attribute_name) == id
+        return obj
+      end
+
+      res = nil
+
+      obj.instance_variables.each do |ins_var|
+        val = obj.send(ins_var.to_s.delete('@').to_sym)
+
+        if val.is_a? Array
+          val.each do |v|
+            res = find_object_by_id(id, v, attribute_name.to_sym)
+            break unless res.nil?
+          end
+        else
+          res = find_object_by_id(id, val, attribute_name.to_sym)
+        end
+
+        break unless res.nil?
+      end
+
+      res
+    end
+
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    module ClassMethods
+    end
+  end
+end

data/lib/oscal/constraint.rb

@@ -0,0 +1,19 @@
+require_relative "base_class"
+
+module Oscal
+  class Constraint < Oscal::BaseClass
+    KEY = %i(description tests)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when 'test'
+        Test.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/control.rb

@@ -1,37 +1,26 @@
-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
+require_relative "base_class"
 
-      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
+module Oscal
+  class Control < Oscal::BaseClass
+    KEY = %i(id klass title params props links parts controls)
 
-        val = case key_name
-        when 'params'
-          Parameter.wrap(val)
-        when 'props'
-          Property.wrap(val)
-        when 'parts'
-          Part.wrap(val)
-        else
-          val
-        end
+    attr_accessor *KEY
+    attr_serializable *KEY
 
-        self.send("#{key_name}=", val)
+    def set_value(key_name, val)
+      case key_name
+      when 'params'
+        Parameter.wrap(val)
+      when 'props'
+        Property.wrap(val)
+      when 'links'
+        Link.wrap(val)
+      when 'parts'
+        Part.wrap(val)
+      when 'controls'
+        Control.wrap(val)
+      else
+        val
       end
     end
   end

data/lib/oscal/custom.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class Custom < Oscal::BaseClass
+    KEY = %i(groups insert_controls)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when 'groups'
+        Group.wrap(val)
+      when 'insert_controls'
+        InsertControl.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/document_id.rb

@@ -0,0 +1,10 @@
+require_relative "base_class"
+
+module Oscal
+  class DocumentId < Oscal::BaseClass
+    KEY = %i(schema identifier)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/email_address.rb

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

data/lib/oscal/exclude_control.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class ExcludeControl < Oscal::BaseClass
+    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'
+        WithId.wrap(val)
+      when 'matching'
+        Matching.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/external_id.rb

@@ -0,0 +1,10 @@
+require_relative "base_class"
+
+module Oscal
+  class ExternalId < Oscal::BaseClass
+    KEY = %i(schema id)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/group.rb

@@ -1,41 +1,32 @@
-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('-','_')
+require_relative "base_class"
 
-        unless KEYS.include?(key_name.to_sym)
-          raise UnknownAttributeError.new("Unknown key `#{key}` in Group")
-        end
+module Oscal
+  class Group < Oscal::BaseClass
+    KEY = %i(id klass title params props links parts groups
+      controls insert_controls)
 
-        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
+    attr_accessor *KEY
+    attr_serializable *KEY
 
-        self.send("#{key_name}=", val)
+    def set_value(key_name, val)
+      case key_name
+      when 'params'
+        Parameter.wrap(val)
+      when 'props'
+        Property.wrap(val)
+      when 'links'
+        Link.wrap(val)
+      when 'parts'
+        Part.wrap(val)
+      when 'groups'
+        Group.wrap(val)
+      when 'controls'
+        Control.wrap(val)
+      when 'insert_controls'
+        InsertControl.wrap(val)
+      else
+        val
       end
     end
-
   end
-end
+end

data/lib/oscal/guideline.rb

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

data/lib/oscal/hash_object.rb

@@ -0,0 +1,10 @@
+require_relative "base_class"
+
+module Oscal
+  class HashObject < Oscal::BaseClass
+    KEY = %i(algorithm value)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/import_object.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class ImportObject < Oscal::BaseClass
+    KEY = %i(href include_all include_controls exclude_controls)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when 'include_controls'
+        IncludeControl.wrap(val)
+      when 'exclude_controls'
+        ExcludeControl.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/include_control.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class IncludeControl < Oscal::BaseClass
+    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'
+        WithId.wrap(val)
+      when 'matching'
+        Matching.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/insert_control.rb

@@ -0,0 +1,21 @@
+require_relative "base_class"
+
+module Oscal
+  class InsertControl < Oscal::BaseClass
+    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'
+        IncludeControl.wrap(val)
+      when 'exclude_controls'
+        ExcludeControls.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/link.rb

@@ -0,0 +1,10 @@
+require_relative "base_class"
+
+module Oscal
+  class Link < Oscal::BaseClass
+    KEY = %i(href rel media_type text)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+  end
+end

data/lib/oscal/location.rb

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

data/lib/oscal/location_uuid.rb

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

data/lib/oscal/matching.rb

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

data/lib/oscal/member_of_organization.rb

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

data/lib/oscal/merge.rb

@@ -0,0 +1,19 @@
+require_relative "base_class"
+
+module Oscal
+  class Merge < Oscal::BaseClass
+    KEY = %i(combine flat as_is custom)
+
+    attr_accessor *KEY
+    attr_serializable *KEY
+
+    def set_value(key_name, val)
+      case key_name
+      when 'custom'
+        Custom.wrap(val)
+      else
+        val
+      end
+    end
+  end
+end

data/lib/oscal/metadata_block.rb

@@ -1,21 +1,35 @@
-module Oscal
-  class MetadataBlock
-
-    METADATA_VALUES = %i(title published last_modified version
-      oscal_version remarks)
+require_relative "base_class"
 
-    attr_accessor *METADATA_VALUES
+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)
 
-    def initialize(options={})
-      options.each_pair.each do |key,val|
-        key_name = key.gsub('-','_')
+    attr_accessor *KEY
+    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,21 @@
+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