octool 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 245e14c9cf523957cca7c2826364125a1f11715a080015124c9477b1c99c6707
-  data.tar.gz: '0759efbc98a8ce26407649d2c4c458e273d3711c8661fbc94b6bb13e194a9695'
+  metadata.gz: 6fecd506f9519e5dea7be955335b43359dc1cf4b9b1f996410c952ec72384471
+  data.tar.gz: f841b91bd3e05d74a1dd90c634a9274119870bdb8698ac2c19685dd727ee6f06
 SHA512:
-  metadata.gz: a27114864b9430e4096429a2d26d13d92ed6bc53ebfb9fa00008e1beb04cc8527f0637d336020826172b47109b192a94b9adfb6eef3036ce160f150be35b6f5d
-  data.tar.gz: 684fca7c472d21356ce73e63d6c079c959108ebd5debfb66b10e35acfdf04a899a50c9d669db938f284963159eaa656b4f3c981e560a17b1e3396ae8a7c99da8
+  metadata.gz: 725f37921c2943422622aad442451cf7178edd98b3f23f02ebcc27030f498290689711345a40baa160bc3054929cac00e1e2f2ff8a39cf0db6de75014a9cd324
+  data.tar.gz: 68e8b51a7784db9cb243caae5122faf05dfdcbb05b822b69b9afed5fff58fd857a93606d8adf7c5b62457642b6d6df30b4a5db2dd3f2e480f08905d6ccd36fb7

data/lib/octool/parser.rb

@@ -41,12 +41,12 @@ module OCTool
         end
 
         def validate_file(path, type)
-            kwal = kwalifyer(type)
-            data = kwal.parse_file(path)
-            errors = kwal.errors
+            kwalify = kwalifyer(type)
+            data = kwalify.parse_file(path)
+            errors = kwalify.errors
             raise ValidationError.new(path, errors) unless errors.empty?
 
-            RecursiveOpenStruct.new(data, recurse_over_arrays: true, preserve_original_keys: true)
+            data
         rescue SystemCallError, Kwalify::SyntaxError, ValidationError => e
             die e.message
         end
@@ -88,14 +88,14 @@ module OCTool
         end
 
         def parsed_component(component)
-            component.attestations.map! do |a|
+            component['attestations'].map! do |a|
                 # Add a "component_key" field to each attestation.
-                a['component_key'] = component.component_key
-                a.satisfies.map! do |s|
+                a['component_key'] = component['component_key']
+                a['satisfies'].map! do |s|
                     # Add "attestation_key" to each control satisfied by this attestation.
-                    s['attestation_key'] = a.summary
+                    s['attestation_key'] = a['summary']
                     # Add "component_key" to each control satisfied by this attestation.
-                    s['component_key'] = component.component_key
+                    s['component_key'] = component['component_key']
                     s
                 end
                 a
@@ -105,13 +105,13 @@ module OCTool
 
         def parsed_standard(standard)
             # Add 'standard_key' to each control family and to each control.
-            standard.families.map! { |f| f['standard_key'] = standard.standard_key; f }
-            standard.controls.map! { |c| c['standard_key'] = standard.standard_key; c }
+            standard['families'].map! { |f| f['standard_key'] = standard['standard_key']; f }
+            standard['controls'].map! { |c| c['standard_key'] = standard['standard_key']; c }
             standard
         end
 
         def parsed_certification(cert)
-            cert.requires.map! { |r| r['certification_key'] = cert.certification_key; r }
+            cert['requires'].map! { |r| r['certification_key'] = cert['certification_key']; r }
             cert
         end
 

data/lib/octool/system.rb

@@ -23,56 +23,53 @@ module OCTool
         end
 
         def certifications
-            @certifications ||= data.select { |e| e.type == 'certification' }
+            @certifications ||= data.select { |e| e['type'] == 'certification' }
         end
 
         def components
-            @components ||= data.select { |e| e.type == 'component' }
+            @components ||= data.select { |e| e['type'] == 'component' }
         end
 
         def standards
-            @standards ||= data.select { |e| e.type == 'standard' }
+            @standards ||= data.select { |e| e['type'] == 'standard' }
         end
 
         # List of all attestations claimed by components in the system.
         def attestations
-            @attestations ||= components.map(&:attestations).flatten
+            @attestations ||= components.map { |c| c['attestations'] }.flatten
         end
 
         # List of all coverages.
         def satisfies
-            @satisfies ||= attestations.map(&:satisfies).flatten
+            @satisfies ||= attestations.map { |a| a['satisfies'] }.flatten
         end
 
         # List of all controls defined by standards in the system.
         def controls
-            @controls ||= standards.map(&:controls).flatten
+            @controls ||= standards.map { |s| s['controls'] }.flatten
         end
 
         # List of all families defined by standards in the system.
         def families
-            @families ||= standards.map(&:families).flatten
+            @families ||= standards.map { |s| s['families'] }.flatten
         end
 
         # List of required controls for all certifications.
         def requires
-            @requires ||= certifications.map(&:requires).flatten
+            @requires ||= certifications.map { |c| c['requires'] }.flatten
         end
 
         def dump(writable_dir)
-            TABLE_NAMES.each do |type|
-                write_csv method(type.to_sym).call, File.join(writable_dir, "#{type}.csv")
+            TABLE_NAMES.each do |table|
+                write_csv method(table.to_sym).call, File.join(writable_dir, "#{table}.csv")
             end
         end
 
         # Convert array of hashes into a CSV.
         def write_csv(ary, filename)
-            ary = ary.map do |e|
-                # Convert each element from RecursiveOStruct to a Hash.
-                e = e.is_a?(Hash) ? e : e.to_h
-                # Throw away nested hashes.
-                e.reject { |_, val| val.is_a?(Enumerable) }
-            end
+            # Throw away nested hashes. The parser already created separate tables for them.
+            ary = ary.map { |e| e.reject { |_, val| val.is_a?(Enumerable) } }
+
             warn "[INFO] write #{filename}"
             CSV.open(filename, 'wb') do |csv|
                 column_names = ary.first.keys

data/lib/octool/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OCTool
-    VERSION = '0.0.6'
+    VERSION = '0.0.7'
 end

data/lib/octool.rb

@@ -9,7 +9,6 @@ require 'pp'
 # 3rd-party libs.
 require 'kwalify'
 require 'kwalify/util/hashlike'
-require 'recursive-open-struct'
 
 # OCTool libs.
 require 'octool/constants'

data/octool.rdoc

@@ -1,6 +1,6 @@
 == octool - Open Compliance Tool
 
-v0.0.6
+v0.0.7
 
 === Global Options
 === --help

data/templates/ssp.erb

@@ -1,25 +1,25 @@
 ---
-<% if @system.config.logo -%>
+<% if @system.config['logo'] -%>
 title: |
-    ![](<%= @system.config.logo.path -%>){width=<%= @system.config.logo.width %>}
+    ![](<%= @system.config['logo']['path'] -%>){width=<%= @system.config['logo']['width'] %>}
 
-    <%= @system.config.name %>
+    <%= @system.config['name'] %>
 <% else %>
-title: "<%= @system.config.name -%>"
+title: "<%= @system.config['name'] -%>"
 <% end %>
 
 subtitle: "System Security Plan"
 
 author:
-<% @system.config.maintainers.each do |maintainer| %>
+<% @system.config['maintainers'].each do |maintainer| %>
     - <%= maintainer -%>
 <% end %>
 
 absract: |
-    <%= @system.config.metadata.abstract rescue 'None' %>
+    <%= @system.config['metadata']['abstract'] rescue 'None' %>
 
 description: |
-    <%= @system.config.metadata.description rescue 'None' %>
+    <%= @system.config['metadata']['description'] rescue 'None' %>
 
 fontsize: 11pt
 mainfont: NotoSans
@@ -54,18 +54,18 @@ geometry:
     - bottom=2cm
 ---
 
-# <%= @system.config.name %>
+# <%= @system.config['name'] %>
 
 ## Overview
 
-<%= @system.config.overview %>
+<%= @system.config['overview'] %>
 
 ## Standards
 
 This System Security Plan (SSP) addresses these standards:
 
 <% @system.standards.each do |s| -%>
-- <%= s.name %>
+- <%= s['name'] %>
 <% end %>
 
 The full copy of each standard is included in the appendix.
@@ -74,30 +74,30 @@ The full copy of each standard is included in the appendix.
 ## Components
 
 <% @system.components.each do |c| %>
-### <%= c.name %>
+### <%= c['name'] %>
 
-<%= c.description %>
+<%= c['description'] %>
 
-<% if c.attestations.empty? %>
+<% if c['attestations'].empty? %>
 _The organization has not yet documented attestations for this component_.
 <% else %>
 The organization offers the following attestations for this component.
 <% end %>
 
-<% c.attestations.each do |a| %>
-####  <%= a.summary %>
+<% c['attestations'].each do |a| %>
+####  <%= a['summary'] %>
 
-Status: <%= a.status %>
+Status: <%= a['status'] %>
 
-Date verified: <%= a.date_verified if a.date_verified %>
+Date verified: <%= a['date_verified'] if a['date_verified'] %>
 
 Satisfies:
 
-<% a.satisfies.each do |cid| -%>
-- <%= cid.standard_key %> control <%= cid.control_key %>
+<% a['satisfies'].each do |cid| -%>
+- <%= cid['standard_key'] %> control <%= cid['control_key'] %>
 <% end -%>
 
-<%= a.narrative %>
+<%= a['narrative'] %>
 
 <% end %>
 <% end %>
@@ -106,14 +106,14 @@ Satisfies:
 # Appendix: Standards
 
 <% @system.standards.each do |s| %>
-## <%=s.name %>
+## <%=s['name'] %>
 
-<% if s.families and !s.families.empty? %>
+<% if s['families'] and !s['families'].empty? %>
 ### Families
 
-<% s.families.each do |family| %>
-<%= family.family_key %>
-  ~ <%= family.name %>
+<% s['families'].each do |family| %>
+<%= family['family_key'] %>
+  ~ <%= family['name'] %>
 
 <% end %>
 
@@ -121,10 +121,10 @@ Satisfies:
 
 ### Controls
 
-<% s.controls.each do |c| %>
-#### Control <%= c.control_key -%>: <%= c.name %>
+<% s['controls'].each do |c| %>
+#### Control <%= c['control_key'] -%>: <%= c['name'] %>
 
-<%= c.description %>
+<%= c['description'] %>
 
 <% end %>
 <% end %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octool
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Paul Morgan
@@ -134,20 +134,6 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 0.4.0.1
-- !ruby/object:Gem::Dependency
-  name: recursive-open-struct
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.1
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - '='
-      - !ruby/object:Gem::Version
-        version: 1.1.1
 description: 
 email: jumanjiman@gmail.com
 executables: