Merge pull request #442 from DannyBen/add/libraries-yml-validation

Validate libraries.yml

Author: DannyBen

examples/render-mandoc/docs/download.1

@@ -14,7 +14,7 @@
 . ftr VB CB
 . ftr VBI CBI
 .\}
-.TH "download" "1" "September 2023" "Version 0.1.0" "Sample application"
+.TH "download" "1" "October 2023" "Version 0.1.0" "Sample application"
 .hy
 .SH NAME
 .PP

examples/render-mandoc/docs/download.md

@@ -1,6 +1,6 @@
 % download(1) Version 0.1.0 | Sample application
 % Lana Lang
-% September 2023
+% October 2023
 
 NAME
 ==================================================

lib/bashly.rb

@@ -15,6 +15,7 @@ module Bashly
   autoload :ConfigValidator, 'bashly/config_validator'
   autoload :Library, 'bashly/library'
   autoload :LibrarySource, 'bashly/library_source'
+  autoload :LibrarySourceConfig, 'bashly/library_source_config'
   autoload :MessageStrings, 'bashly/message_strings'
   autoload :RenderContext, 'bashly/render_context'
   autoload :RenderSource, 'bashly/render_source'

lib/bashly/library_source.rb

@@ -15,7 +15,7 @@ def git?
     end
 
     def config
-      @config ||= YAML.load_file config_path
+      @config ||= LibrarySourceConfig.new(config_path).validated_data
     end
 
     def libraries

lib/bashly/library_source_config.rb

@@ -0,0 +1,48 @@
+module Bashly
+  class LibrarySourceConfig
+    include ValidationHelpers
+
+    attr_reader :path
+
+    def initialize(path)
+      @path = path
+    end
+
+    def data
+      @data ||= YAML.load_file path
+    end
+
+    def validated_data
+      validate
+      data
+    end
+
+    def validate
+      assert_root path, data
+    end
+
+  private
+
+    def assert_root(path, value)
+      assert_hash path, value
+      data.each { |id, spec| assert_lib "[#{path}] #{id}", spec }
+    end
+
+    def assert_lib(key, value)
+      assert_string "#{key}.help", value['help']
+
+      assert_optional_string "#{key}.usage", value['usage']
+      assert_optional_string "#{key}.handler", value['handler']
+      assert_optional_string "#{key}.post_install_message", value['post_install_message']
+
+      return if value['handler']
+
+      assert_array "#{key}.files", value['files'], of: :filespec
+    end
+
+    def assert_filespec(key, value)
+      assert_string "#{key}.source", value['source']
+      assert_string "#{key}.target", value['target']
+    end
+  end
+end

spec/approvals/examples/render-mandoc

@@ -44,4 +44,4 @@ ISSUE TRACKER
 AUTHORS
        Lana Lang.
 
-Version 0.1.0                   September 2023                     download(1)
+Version 0.1.0                    October 2023                      download(1)

spec/approvals/libraries/render/mandoc/render-1-download.1

@@ -29,4 +29,4 @@ EXAMPLES
               download example.com ./output -f
 
 
-Version 0.1.0                   MONTH YEAR                     download(1)
+Version 0.1.0                    MONTH YEAR                      download(1)

spec/approvals/libraries_validation/files_array

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: [spec/fixtures/libraries/errors/files_array.yml] database.files must be an array>

spec/approvals/libraries_validation/files_source

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: [spec/fixtures/libraries/errors/files_source.yml] database.files[0].source must be a string>

spec/approvals/libraries_validation/files_target

@@ -0,0 +1 @@
+#<Bashly::ConfigurationError: [spec/fixtures/libraries/errors/files_target.yml] database.files[0].target must be a string>