king_konf 0.3.7 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7097bd818496d31561799b6756a83779daade1ff0e7b6be133d2c287ad60e646
-  data.tar.gz: fbf115254e0d7bf1a906011624cee8daa43b97fcf5a1330a35f12cc2d973b450
+  metadata.gz: 2d2502b9771fc107ad2db0f49241e302ed80465c3e769d9c8f0dbb0888214aa4
+  data.tar.gz: bf947978e987de8ee67df77556768e7851a67637f18b5d83e74b2cdc5f8ac27e
 SHA512:
-  metadata.gz: 643c92f40690416dc179f79e83617f0ff5f8cd40aaea2dc1f04b941ccec69c4ea2217ecaba7f8af2881bf90e1fa8f1458eafc439354bdd4b7f266c55ee3a917e
-  data.tar.gz: 2d858fffd1123d9282c705dc85ba090ab95f5ffee6e0e93a3945e87801e87103768a278b93531cf87392f2f8c8b7b904a6bce900c9ebabfaf4c15d269fe916a5
+  metadata.gz: f5419839b71bdca08588802b2ae5dac5d4e040e816e04e8482b213f7ef3866c0f7bf0a0e07fdd9a84e873fcd518cc8811c41b3a21d1a141a332192a9103b263e
+  data.tar.gz: f1cd338ae1e5379f65ac54a6e63d5525795a85201b97e7bb2b6f2ce876922713a18957ef696ec671d6591422b5027372575968be8a10f0b41de168b83e8f0216

data/.github/workflows/ci.yml

@@ -0,0 +1,28 @@
+name: CI
+
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/README.md

@@ -55,6 +55,9 @@ class MyApplication::Config < KingKonf::Config
 
   # You can restrict the set of allowed values:
   string :category, allowed_values: ["news", "stuff", "accouncements"]
+
+  # You can provide a custom validation function:
+  integer :even_number, validate_with: ->(int) { int % 2 == 0 }
 end
 ```
 

data/king_konf.gemspec

@@ -20,7 +20,7 @@ Gem::Specification.new do |spec|
 
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 2"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "rspec_junit_formatter"

data/lib/king_konf/config.rb

@@ -33,8 +33,8 @@ module KingKonf
       end
 
       TYPES.each do |type|
-        define_method(type) do |name, default: nil, required: false, allowed_values: nil, **options|
-          description, @desc = @desc, nil
+        define_method(type) do |name, default: nil, required: false, allowed_values: nil, validate_with: ->(_) { true }, **options|
+          description, @desc = @desc, nil if defined?(@desc)
           variable = Variable.new(
             name: name,
             type: type,
@@ -42,6 +42,7 @@ module KingKonf
             required: required,
             description: description,
             allowed_values: allowed_values,
+            validate_with: validate_with,
             options: options,
           )
 
@@ -70,6 +71,8 @@ module KingKonf
     end
 
     def initialize(env: ENV)
+      @desc = nil
+      @ignore_unknown_variables = nil
       load_env(env)
     end
 
@@ -106,6 +109,10 @@ module KingKonf
         raise ConfigError, "invalid value #{value.inspect} for variable `#{name}`, allowed values are #{variable.allowed_values}"
       end
 
+      if !variable.valid?(value)
+        raise ConfigError, "invalid value #{value.inspect} for variable `#{name}`"
+      end
+
       instance_variable_set("@#{name}", cast_value)
     end
 

data/lib/king_konf/config_file_loader.rb

@@ -11,7 +11,13 @@ module KingKonf
       # First, load the ERB template from disk.
       template = ERB.new(File.new(path).read)
 
-      data = YAML.load(template.result(binding))
+      begin
+        # Without flag, loading the configuration file fails in Ruby 3.1 if it contains aliases.
+        data = YAML.load(template.result(binding), aliases: true)
+      rescue ArgumentError
+        # Covering prior YAML versions
+        data = YAML.load(template.result(binding))
+      end
 
       # Grab just the config for the environment, if specified.
       data = data.fetch(environment) unless environment.nil?

data/lib/king_konf/variable.rb

@@ -2,15 +2,16 @@ require "king_konf/decoder"
 
 module KingKonf
   class Variable
-    attr_reader :name, :type, :default, :description, :allowed_values, :options
+    attr_reader :name, :type, :default, :description, :allowed_values, :validate_with, :options
 
-    def initialize(name:, type:, default: nil, description: "", required: false, allowed_values: nil, options: {})
+    def initialize(name:, type:, default: nil, description: "", required: false, allowed_values: nil, validate_with: ->(_) { true }, options: {})
       @name, @type = name, type
       @description = description
       @required = required
       @allowed_values = allowed_values
       @options = options
       @default = cast(default) unless default.nil?
+      @validate_with = validate_with
     end
 
     def cast(value)
@@ -31,11 +32,11 @@ module KingKonf
     end
 
     def valid?(value)
-      cast(value)
+      cast_value = cast(value)
     rescue ConfigError
       false
     else
-      true
+      !!validate_with.call(cast_value)
     end
 
     def allowed?(value)

data/lib/king_konf/version.rb

@@ -1,3 +1,3 @@
 module KingKonf
-  VERSION = "0.3.7"
+  VERSION = "1.0.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: king_konf
 version: !ruby/object:Gem::Version
-  version: 0.3.7
+  version: 1.0.1
 platform: ruby
 authors:
 - Daniel Schierbeck
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-10-26 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -74,6 +74,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
 - Gemfile
@@ -94,7 +95,7 @@ homepage: https://github.com/dasch/king_konf
 licenses:
 - Apache License Version 2.0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -109,9 +110,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
-signing_key: 
+rubygems_version: 3.3.3
+signing_key:
 specification_version: 4
 summary: A simple configuration library
 test_files: []