compliance 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3334cb98507d29e5249dc7f542ee2acb68c5dd0fb5a995b0303f2636da8bc6b2
-  data.tar.gz: 2154be63063316e33ca4046d317c7a2a68d20cad649640fe2c10f07358dc7301
+  metadata.gz: 2f821883f9be036f7d0c4b4b4c46a54cfb4d9c65f03d2a8e09a739d595d69cb4
+  data.tar.gz: e89f86fc987e18cae6643dd593f2388dd1f5822238eb4d72356735478626eb44
 SHA512:
-  metadata.gz: 70cd172b262c2caa19616dda3fb9ab176baff4a187818bf949f6edc30a1fcdf241409fe4c6435a4d28f326b1fc87f1fd1d85d44776dd3b70e9908b584cf427ab
-  data.tar.gz: 6de40f9d88eff321ed532a124a18a54e7af2f07f61506641fb956d846332da183ed179a273e7aab52f3771063363978e430b1999f8111121a6260bfeb90e2666
+  metadata.gz: d31ba046177f99b0bb31f11f5760e0b875dd4c1150c7cbca1a4bccca7bd3f07165a247a8fe24af28601e66632043fb5cca994baea85a14d98cb4f5d97b159371
+  data.tar.gz: 6502b0285c36ca163ff3e2f573a7072552bbae42047f54417b03688e2d2b60fd386ef548bfd8d03a98a904c27968d07d2d7e286b3bd2a6576372261370153faa

data/bake/compliance/attest.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2024, by Samuel Williams.
+
+def initialize(...)
+	super
+	
+	require 'compliance'
+end
+
+# Attest to a requirement.
+# @parameter id [String] The unique identifier for the attestation, matching the requirement.
+# @parameter description [String] A description of how the requirement is satisfied.
+# @parameter by [String] The entity attesting to the requirement.
+def attest(id, description: nil, by: nil)
+	compliance_root = Compliance::Document.path(context.root)
+	
+	if File.exist?(compliance_root)
+		document = Compliance::Document.load(compliance_root)
+	else
+		document = Compliance::Document.new
+	end
+	
+	attestation = self.attestation_for(id, document)
+	
+	if description
+		attestation.metadata[:description] = description
+	end
+	
+	if by
+		attestation.metadata[:by] = by
+	end
+	
+	File.write(compliance_root, JSON.pretty_generate(document))
+	
+	return attestation
+end
+
+def all(description: nil, by: nil)
+	compliance_root = Compliance::Document.path(context.root)
+	
+	if File.exist?(compliance_root)
+		document = Compliance::Document.load(compliance_root)
+	else
+		document = Compliance::Document.new
+	end
+	
+	policy = self.policy
+	
+	policy.requirements.each do |id, requirement|
+		attestation = self.attestation_for(id, document)
+		
+		if description
+			attestation.metadata[:description] = description
+		end
+		
+		if by
+			attestation.metadata[:by] = by
+		end
+	end
+	
+	File.write(compliance_root, JSON.pretty_generate(document))
+end
+
+private
+
+# Load the default compliance policy.
+def policy
+	loader = Compliance::Loader.default([context.root])
+	
+	return Compliance::Policy.default(loader)
+end
+
+def attestation_for(id, document)
+	document.attestations.each do |attestation|
+		if attestation.id == id
+			return attestation
+		end
+	end
+	
+	attestation = Compliance::Attestation.new(id: id)
+	document.attestations << attestation
+	
+	return attestation
+end

data/bake/compliance.rb

@@ -25,6 +25,24 @@ def list
 	end
 end
 
+# Show a specific requirement and any associated attestations.
+# @parameter id [String] The unique identifier for the requirement.
+def show(id)
+	policy = self.policy
+	
+	requirement = policy.requirements[id]
+	
+	if requirement
+		$stdout.puts "Requirement: #{requirement.id}"
+		$stdout.puts JSON.pretty_generate(requirement)
+	end
+	
+	policy.attestations[id]&.each do |attestations|
+		$stdout.puts "Attestation: #{attestation.id}"
+		$stdout.puts JSON.pretty_generate(attestation)
+	end
+end
+
 # Check compliance with the policy.
 def check
 	policy = self.policy
@@ -46,46 +64,3 @@ def check
 		return results
 	end
 end
-
-# Attest to a requirement.
-# @parameter id [String] The unique identifier for the attestation, matching the requirement.
-# @parameter description [String] A description of how the requirement is satisfied.
-# @parameter by [String] The entity attesting to the requirement.
-def attest(id, description: nil, by: nil)
-	compliance_root = Compliance::Document.path(context.root)
-	
-	if File.exist?(compliance_root)
-		document = Compliance::Document.load(compliance_root)
-	else
-		document = Compliance::Document.new
-	end
-	
-	attestation = self.attestation_for(id, document)
-	
-	if description
-		attestation.metadata[:description] = description
-	end
-	
-	if by
-		attestation.metadata[:by] = by
-	end
-	
-	File.write(compliance_root, JSON.pretty_generate(document))
-	
-	return attestation
-end
-
-private
-
-def attestation_for(id, document)
-	document.attestations.each do |attestation|
-		if attestation.id == id
-			return attestation
-		end
-	end
-	
-	attestation = Compliance::Attestation.new(id: id)
-	document.attestations << attestation
-	
-	return attestation
-end

data/lib/compliance/version.rb

@@ -4,5 +4,5 @@
 # Copyright, 2024, by Samuel Williams.
 
 module Compliance
-	VERSION = "0.1.0"
+	VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: compliance
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Samuel Williams
@@ -60,6 +60,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - bake/compliance.rb
+- bake/compliance/attest.rb
 - lib/compliance.rb
 - lib/compliance/attestation.rb
 - lib/compliance/document.rb