king_konf 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: abc81cff30b2a3d480020c088f5134c054571f73
-  data.tar.gz: e076879bbfc0d94890fe661fdd2162df8ab21902
+  metadata.gz: bbb0ce734f3e5eff7f0c2fca94727d80ca6e9ca8
+  data.tar.gz: 58e2b1c6539e83090d91be374963bcd1ad2dae6a
 SHA512:
-  metadata.gz: df30bcc671ebd55378a87ca970a86df2cf8f702523092aaaea634902df34475bd1b375ff7abeb5670f5d80ea419650230d612b872bca631b65a402a4906d5546
-  data.tar.gz: 60706bc33e11bef6bb59238a55d651ec8d157d74c9d81603ec9bdc777ed3bd4e352bdf1c2167b95c069676a642e5ee6f14d20c2e664c3f88b939c96dfff7979b
+  metadata.gz: 9745236ead021ed7741da1dedd6f9fa8db02c09412f9ecff22e0b5f9c90e6e8082b6cd28c41af2ea8f5fd674958a3680216ee21bc50f718074f1a6c1bbf06bb7
+  data.tar.gz: c4467ce101c3a2b514266f771e7bc035e94eea558873ee8dd0ce1eb0a7808e356fa26b83a74041df02a4b34474fedbd9d87ef2fbcdb53302297ac61e4dd9e997

data/README.md

@@ -75,6 +75,35 @@ config.tags #=> ["greetings", "introductions", "articles"]
 config.codes #=> [435, 2342, 8678]
 ```
 
+If you prefer to use a config file, that's also possible. Simply load a YAML file with `#load_file`:
+
+```ruby
+config.load_file("config/my_app.yml")
+```
+
+A common pattern is to store config for all runtime environments in a single file and select the config based on the current environment, e.g.:
+
+```ruby
+config.load_file("config/my_app.yml", Rails.environment)
+```
+
+In that case, structure the config file like so:
+
+```yaml
+development:
+  title: hello
+  score: 25
+
+test:
+  title: yolo
+  score: 13
+
+production:
+  title: yeah
+  score: 99
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/king_konf/config.rb

@@ -1,31 +1,7 @@
-require "king_konf/decoder"
+require "king_konf/variable"
 require "king_konf/config_file_loader"
 
 module KingKonf
-  class Variable
-    attr_reader :name, :type, :default, :description, :options
-
-    def initialize(name, type, default, description, options)
-      @name, @type, @default = name, type, default
-      @description = description
-      @options = options
-    end
-
-    def valid?(value)
-      case @type
-      when :string then value.is_a?(String) || value.nil?
-      when :list then value.is_a?(Array)
-      when :integer then value.is_a?(Integer) || value.nil?
-      when :boolean then value == true || value == false
-      else raise "invalid type #{@type}"
-      end
-    end
-
-    def decode(value)
-      Decoder.public_send(@type, value, **options)
-    end
-  end
-
   class Config
     @variables = {}
 
@@ -48,9 +24,16 @@ module KingKonf
       end
 
       %i(boolean integer string list).each do |type|
-        define_method(type) do |name, default: nil, **options|
+        define_method(type) do |name, default: nil, required: false, **options|
           description, @desc = @desc, nil
-          variable = Variable.new(name, type, default, description, options)
+          variable = Variable.new(
+            name: name,
+            type: type,
+            default: default,
+            required: required,
+            description: description,
+            options: options,
+          )
 
           @variables ||= {}
           @variables[name.to_s] = variable
@@ -76,7 +59,7 @@ module KingKonf
       load_env(env)
     end
 
-    def load_file(path, environment)
+    def load_file(path, environment = nil)
       loader = ConfigFileLoader.new(self)
       loader.load_file(path, environment)
     end
@@ -110,6 +93,14 @@ module KingKonf
       end
     end
 
+    def validate!
+      self.class.variables.each do |variable|
+        if variable.required? && get(variable.name).nil?
+          raise ConfigError, "required variable `#{variable.name}` is not defined"
+        end
+      end
+    end
+
     private
 
     def load_config(config)

data/lib/king_konf/config_file_loader.rb

@@ -7,15 +7,18 @@ module KingKonf
       @config = config
     end
 
-    def load_file(path, environment)
+    def load_file(path, environment = nil)
       # First, load the ERB template from disk.
       template = ERB.new(File.new(path).read)
 
       # The last argument to `safe_load` allows us to use aliasing to share
       # configuration between environments.
-      processed = YAML.safe_load(template.result(binding), [], [], true)
+      data = YAML.safe_load(template.result(binding), [], [], true)
 
-      processed.fetch(environment).each do |variable, value|
+      # Grab just the config for the environment, if specified.
+      data = data.fetch(environment) unless environment.nil?
+
+      data.each do |variable, value|
         @config.set(variable, value)
       end
     end

data/lib/king_konf/variable.rb

@@ -0,0 +1,38 @@
+require "king_konf/decoder"
+
+module KingKonf
+  class Variable
+    attr_reader :name, :type, :default, :description, :options
+
+    def initialize(name:, type:, default: nil, description: "", required: false, options: {})
+      @name, @type, @default = name, type, default
+      @description = description
+      @required = required
+      @options = options
+    end
+
+    def required?
+      @required
+    end
+
+    def valid?(value)
+      case @type
+      when :string then value.is_a?(String) || value.nil?
+      when :list then value.is_a?(Array)
+      when :integer then value.is_a?(Integer) || value.nil?
+      when :boolean then value == true || value == false
+      else raise "invalid type #{@type}"
+      end
+    end
+
+    def decode(value)
+      Decoder.public_send(@type, value, **options)
+    end
+
+    %i(boolean integer string list).each do |type|
+      define_method("#{type}?") do
+        @type == type
+      end
+    end
+  end
+end

data/lib/king_konf/version.rb

@@ -1,3 +1,3 @@
 module KingKonf
-  VERSION = "0.1.5"
+  VERSION = "0.1.6"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: king_konf
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-15 00:00:00.000000000 Z
+date: 2017-09-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -72,6 +72,7 @@ files:
 - lib/king_konf/config.rb
 - lib/king_konf/config_file_loader.rb
 - lib/king_konf/decoder.rb
+- lib/king_konf/variable.rb
 - lib/king_konf/version.rb
 homepage: https://github.com/dasch/king_konf
 licenses:
@@ -93,7 +94,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: A simple configuration library