simple_scripting 0.11.0 → 0.11.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cc0247a6611c5316dad4d41f31b6127cf6bc7aaed615bcc271e548c11f272226
-  data.tar.gz: 3f6602c871caf6666caacfc001d47b6296be49e76c69f56e9903b0438a1fc38e
+  metadata.gz: bd6f01ad9ea507d97ac4024fa8e78feb1093e67f75b16d4ac5c5db79354caf18
+  data.tar.gz: a0a1ad4b67822086544890b54590af03a2877a7210f3198109d605a6fa772d57
 SHA512:
-  metadata.gz: '09293ef72e58432cfbb31d282f3ac86141e978dcacdc00a30203f621871bc72663c7566aaf344cb45cc8990ba6e65f1e5b7b401e09e1acc9c86bc0c6f42f05ec'
-  data.tar.gz: 024a82b8d6e483df5e679b549f17266e9c5e6d74cc25a46038484f5ac69b1534d7147ce2114f09f07589625d16f6ef51e1cfa41c12ea0655b40600d335aed1ad
+  metadata.gz: 2ee276b4af46f3746523f9ed11d7b11b4097f65c7139709506363708f1e6303ec1ead4d48c182f480918597272f2c1af92af6620920dad296967540c5b14105c
+  data.tar.gz: 9059bae5453cc7e64eeea88c8279167020bd7cae0c1b67337c4bf83acb055a0ab04b75c746e7c0ea6d2a9184a8b1df5af0754dcfff55a8ad8e9e2b2409c8fe59

data/lib/simple_scripting/configuration.rb

@@ -10,11 +10,16 @@ module SimpleScripting
 
     extend self
 
-    def load(config_file: default_config_file, passwords_key: nil)
+    # `required`: list of strings. this currently support only keys outside a group; group names
+    #             are not considered keys.
+    #
+    def load(config_file: default_config_file, passwords_key: nil, required: [])
       create_empty_file(config_file) if !File.exists?(config_file)
 
       configuration = ParseConfig.new(config_file)
 
+      enforce_required_keys(configuration.params, required)
+
       convert_to_cool_format(OpenStruct.new, configuration.params, passwords_key)
     end
 
@@ -30,6 +35,12 @@ module SimpleScripting
       File.expand_path(base_config_filename, '~')
     end
 
+    def enforce_required_keys(configuration, required)
+      missing_keys = required - configuration.select { |key, value| !value.is_a?(Hash) }.keys
+
+      raise "Missing required configuration key(s): #{missing_keys.join(', ')}" if !missing_keys.empty?
+    end
+
     # Performs two conversions:
     #
     # 1. the configuration as a whole is converted to an OpenStruct

data/lib/simple_scripting/version.rb

@@ -1,5 +1,5 @@
 module SimpleScripting
 
-  VERSION = "0.11.0"
+  VERSION = "0.11.1"
 
 end

data/simple_scripting.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |s|
   s.platform    = Gem::Platform::RUBY
   s.required_ruby_version = '>= 2.3.0'
   s.authors     = ["Saverio Miroddi"]
-  s.date        = "2019-03-20"
+  s.date        = "2019-03-31"
   s.email       = ["saverio.pub2@gmail.com"]
   s.homepage    = "https://github.com/saveriomiroddi/simple_scripting"
   s.summary     = "Library for simplifying some typical scripting functionalities."

data/spec/simple_scripting/configuration_spec.rb

@@ -54,6 +54,14 @@ g2_key=bang
     end
   end
 
+  it "should raise an error when required keys are missing" do
+    with_tempfile(configuration_text) do |config_file|
+      error_call = -> { described_class.load(config_file: config_file, required: %w(abspath_key missing_key group1)) }
+
+      expect(error_call).to raise_error(RuntimeError, "Missing required configuration key(s): missing_key, group1")
+    end
+  end
+
   it "should create the configuration file if it doesn't exist" do
     temp_config_file = File.join(Dir.tmpdir, '.test_simple_scripting_config')
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_scripting
 version: !ruby/object:Gem::Version
-  version: 0.11.0
+  version: 0.11.1
 platform: ruby
 authors:
 - Saverio Miroddi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-20 00:00:00.000000000 Z
+date: 2019-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: parseconfig