octool 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b4309625dcbe93d28161179e763a38c4d4c25bd46f75b8a717e314167984356
-  data.tar.gz: eb021712e5165c88df02c1ecb40b6017c4c1abbe9c05c7ef77e074255b04298a
+  metadata.gz: 6a99d4ae79b106f19c3a49be0fd5fa84de52aaf790494a0f78e55c16fd00bbc5
+  data.tar.gz: d50899b6e334df9a7f40071f053824af296c842e7d11c8add1ae8e0b17c8313b
 SHA512:
-  metadata.gz: 4534786fd6fbb5a0e1be118872e9a0fba4cb50b87d05b59ba4262b6cf6fc884d3f81b9dd48690cb382c5f5cc347228e37497dc2a4c02ecc9bdb2c1290b4268b1
-  data.tar.gz: a715d521b431f1f20770bba0df3ac1eb2091f837a1902c017bc15d881f09a9301c3eef794f54c18d7eccc9b8836b8d347a0d71819a1a7b688590f5fb14f4a9be
+  metadata.gz: d447539ed45f3c6d55eaabdc04763b21a15bcfb1c9a25bcc8db050c885dba0d030634693353614243e59cec9c9622f09289c35d71aec52fdc56a1fc2922e896e
+  data.tar.gz: 728c1d363e0f30c4c3f52149088d867cefdb0b63e3b3594fbe5aa1e70b04e66749fe2466ed90643fd84e94b416367f59f26e9d4f049741f8b0bb2d61b15f6306

data/bin/octool

@@ -8,6 +8,22 @@ require 'octool'
 class App
     extend GLI::App
 
+    def self.data_dir
+        [ENV['TMPDIR'], ENV['TMP'], ENV['TEMP'], '/tmp'].each do |dir|
+            next if dir.nil?
+
+            stat = File.stat(dir)
+            return dir if stat.directory? && stat.writable?
+        end
+        OCTool::DEFAULT_OUTPUT_DIR
+    end
+
+    def self.find_config(args)
+        path = args.first || OCTool::DEFAULT_CONFIG_FILENAME
+        path = File.join(path, OCTool::DEFAULT_CONFIG_FILENAME) if File.directory?(path)
+        path
+    end
+
     program_desc 'Open Compliance Tool'
     version OCTool::VERSION
 
@@ -39,7 +55,7 @@ class App
     arg_name 'path/to/system/config.yaml'
     command :ssp do |s|
         s.desc 'where to store outputs'
-        s.default_value OCTool::DEFAULT_OUTPUT_DIR
+        s.default_value data_dir
         s.long_desc 'Default output directory respects env vars TMPDIR, TMP, TEMP'
         s.arg_name 'path/to/output/dir'
         s.flag [:d, :dir]
@@ -86,10 +102,4 @@ class App
     end
 end
 
-def find_config(args)
-    path = args.first || OCTool::DEFAULT_CONFIG_FILENAME
-    path = File.join(path, OCTool::DEFAULT_CONFIG_FILENAME) if File.directory?(path)
-    path
-end
-
 exit App.run(ARGV)

data/lib/octool.rb

@@ -4,7 +4,6 @@ require 'octool/version.rb'
 
 # Built-ins.
 require 'pp'
-require 'tmpdir'
 
 # 3rd-party libs.
 require 'kwalify'

data/lib/octool/ssp.rb

@@ -6,9 +6,15 @@ module OCTool
         def initialize(system, output_dir)
             @system = system
             @output_dir = output_dir
-            # Load paru/pandoc late enough that help functions work
-            # and early enough to be confident that we catch the correct error.
-            require 'paru/pandoc'
+        end
+
+        def pandoc
+            @pandoc ||= begin
+                # Load paru/pandoc late enough that help functions work
+                # and early enough to be confident that we catch the correct error.
+                require 'paru/pandoc'
+                Paru::Pandoc.new
+            end
         rescue UncaughtThrowError => e
             STDERR.puts '[FAIL] octool requires pandoc to generate the SSP. Is pandoc installed?'
             exit(1)
@@ -20,7 +26,8 @@ module OCTool
                 exit(1)
             end
             render_template
-            write
+            write 'pdf'
+            write 'docx'
         end
 
         def render_template
@@ -32,12 +39,12 @@ module OCTool
             puts 'done'
         end
 
-        def write
-            print "Building #{pdf_path} ... "
-            pandoc = Paru::Pandoc.new
+        def write(type = 'pdf')
+            out_path = File.join(@output_dir, "ssp.#{type}")
+            print "Building #{out_path} ... "
             converter = pandoc.configure do
                 from 'markdown'
-                to 'pdf'
+                to type
                 pdf_engine 'lualatex'
                 toc
                 toc_depth 3
@@ -45,16 +52,12 @@ module OCTool
                 highlight_style 'pygments'
             end
             output = converter << File.read(md_path)
-            File.new(pdf_path, 'wb').write(output)
+            File.new(out_path, 'wb').write(output)
             puts 'done'
         end
 
         def md_path
             @md_path ||= File.join(@output_dir, 'ssp.md')
         end
-
-        def pdf_path
-            @pdf_path ||= File.join(@output_dir, 'ssp.pdf')
-        end
     end
 end

data/lib/octool/version.rb

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

data/octool.rdoc

@@ -1,6 +1,6 @@
 == octool - Open Compliance Tool
 
-v0.0.3
+v0.0.4
 
 === Global Options
 === --help
@@ -33,7 +33,7 @@ generate System Security Plan
 
 where to store outputs
 
-[Default Value] /data
+[Default Value] /tmp
 Default output directory respects env vars TMPDIR, TMP, TEMP
 
 ==== Command: <tt>validate </tt>

data/templates/ssp.erb

@@ -25,10 +25,10 @@ mainfontoptions:
     - BoldFont=*-Bold
     - BoldItalicFont=*-BoldItalic
 
-lof: false
-lot: false
+lof: true
+lot: true
 colorlinks: true
-linkcolor: blue
+linkcolor: black  # internal links (e.g., lof and lot)
 urlcolor: blue
 
 documentclass: report
@@ -104,7 +104,9 @@ Satisfies:
 ### Families
 
 <% s.families.each do |family| %>
-- <%= family.family_key -%>: <%= family.name %>
+<%= family.family_key %>
+  ~ <%= family.name %>
+
 <% end %>
 
 <% end %>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: octool
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Paul Morgan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-05-15 00:00:00.000000000 Z
+date: 2020-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake