oscal 0.1.0 → 0.2.0

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

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+RSpec.describe Oscal do
+  it "has a version number" do
+    expect(Oscal::VERSION).not_to be nil
+  end
+end

data/spec/sample_inputs/import-ap.json

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

data/spec/spec_helper.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oscal
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
-- Ronald Tse
+- Ribose Inc.
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-03-20 00:00:00.000000000 Z
+date: 2024-06-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: yaml
@@ -26,38 +26,112 @@ dependencies:
         version: '0'
 description: Ruby library and parser for OSCAL models
 email:
-- ronald.tse@ribose.com
-executables: []
+- open.source@ribose.com
+executables:
+- convert2oscalyaml.rb
 extensions: []
 extra_rdoc_files: []
 files:
+- ".docker/Dockerfile"
+- ".docker/Makefile"
+- ".docker/docker-compose.yml"
+- ".docker/readme.md"
+- ".github/workflows/rake.yml"
+- ".github/workflows/release.yml"
+- ".gitignore"
+- ".gitmodules"
+- ".hound.yml"
 - ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
 - CODE_OF_CONDUCT.md
 - Gemfile
+- LICENSE
+- Makefile
 - README.adoc
 - Rakefile
+- bin/console
+- bin/rspec
+- bin/setup
+- docker-compose.yml
+- exe/convert2oscalyaml.rb
 - lib/oscal.rb
+- lib/oscal/add.rb
+- lib/oscal/address.rb
+- lib/oscal/address_line.rb
+- lib/oscal/alter.rb
+- lib/oscal/assembly.rb
+- lib/oscal/assessment_plan.rb
+- lib/oscal/assessment_result.rb
+- lib/oscal/attribute_type_hash.rb
+- lib/oscal/back_matter.rb
+- lib/oscal/base64_object.rb
+- lib/oscal/base_class.rb
 - lib/oscal/catalog.rb
-- lib/oscal/component.rb
+- lib/oscal/choice.rb
+- lib/oscal/citation.rb
+- lib/oscal/combine.rb
+- lib/oscal/common_utils.rb
+- lib/oscal/constraint.rb
 - lib/oscal/control.rb
+- lib/oscal/custom.rb
+- lib/oscal/datatypes.rb
+- lib/oscal/document_id.rb
+- lib/oscal/email_address.rb
+- lib/oscal/exclude_control.rb
+- lib/oscal/external_id.rb
 - lib/oscal/group.rb
+- lib/oscal/guideline.rb
+- lib/oscal/hash_object.rb
+- lib/oscal/import_object.rb
+- lib/oscal/include_control.rb
+- lib/oscal/insert_control.rb
+- lib/oscal/link.rb
+- lib/oscal/list.rb
+- lib/oscal/location.rb
+- lib/oscal/location_uuid.rb
+- lib/oscal/logger.rb
+- lib/oscal/matching.rb
+- lib/oscal/member_of_organization.rb
+- lib/oscal/merge.rb
 - lib/oscal/metadata_block.rb
+- lib/oscal/modify.rb
 - lib/oscal/parameter.rb
+- lib/oscal/parsing_functions.rb
 - lib/oscal/part.rb
+- lib/oscal/party.rb
+- lib/oscal/party_uuid.rb
 - lib/oscal/profile.rb
 - lib/oscal/property.rb
-- lib/oscal/prose.rb
+- lib/oscal/remove.rb
+- lib/oscal/resource.rb
+- lib/oscal/responsible_party.rb
+- lib/oscal/revision.rb
+- lib/oscal/rlink.rb
+- lib/oscal/role.rb
+- lib/oscal/select.rb
 - lib/oscal/serializer.rb
-- lib/oscal/statement.rb
+- lib/oscal/set_parameter.rb
+- lib/oscal/telephone_number.rb
+- lib/oscal/test.rb
+- lib/oscal/url.rb
+- lib/oscal/value.rb
 - lib/oscal/version.rb
+- lib/oscal/with_id.rb
 - oscal.gemspec
 - sig/oscal.rbs
+- spec/oscal/catalog_spec.rb
+- spec/oscal_spec.rb
+- spec/sample_inputs/import-ap.json
+- spec/spec_helper.rb
 homepage: https://github.com/metanorma/oscal-ruby/
-licenses: []
+licenses:
+- BSD-2-Clause
 metadata:
   homepage_uri: https://github.com/metanorma/oscal-ruby/
   source_code_uri: https://github.com/metanorma/oscal-ruby/
   changelog_uri: https://github.com/metanorma/oscal-ruby/CHANGELOG
+  rubygems_mfa_required: 'true'
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -73,7 +147,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Interact with OSCAL models

data/lib/oscal/component.rb

@@ -1,14 +0,0 @@
-module Oscal
-  class Component
-    attr_accessor :id, :name, :type, :description, :properties
-
-    def initialize(id, name, type, description, properties)
-      @id = id
-      @name = name
-      @type = type
-      @description = description
-      @properties = properties
-    end
-  end
-
-end

data/lib/oscal/prose.rb

@@ -1,13 +0,0 @@
-require_relative "serializer"
-
-module Oscal
-  class Prose
-    include Serializer
-
-    attr_serializable :value, :media_type
-
-    def to_xml(builder)
-      builder.prose(value, {'media-type' => media_type})
-    end
-  end
-end

data/lib/oscal/statement.rb

@@ -1,12 +0,0 @@
-module Oscal
-  class Statement
-    attr_accessor :description, :prose, :properties
-
-    def initialize(description, prose, properties)
-      @description = description
-      @prose = prose
-      @properties = properties
-    end
-  end
-
-end