king_konf 0.1.6 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: bbb0ce734f3e5eff7f0c2fca94727d80ca6e9ca8
-  data.tar.gz: 58e2b1c6539e83090d91be374963bcd1ad2dae6a
+  metadata.gz: 9cfc7834fa0e179ec6d7d68fe27c8b449b461145
+  data.tar.gz: 5960fea340b02ee4efe9be802b9b0a74154cd289
 SHA512:
-  metadata.gz: 9745236ead021ed7741da1dedd6f9fa8db02c09412f9ecff22e0b5f9c90e6e8082b6cd28c41af2ea8f5fd674958a3680216ee21bc50f718074f1a6c1bbf06bb7
-  data.tar.gz: c4467ce101c3a2b514266f771e7bc035e94eea558873ee8dd0ce1eb0a7808e356fa26b83a74041df02a4b34474fedbd9d87ef2fbcdb53302297ac61e4dd9e997
+  metadata.gz: 80bb1349da489d686f787e3107f671fb773653adde8600cd030f73d72d7bacd535422bc1497c2c32102c88dbb4d90b1c99c3c323660097169b2aaa1480c79cff
+  data.tar.gz: dc459ac8ac90b3d5ee040946de5fef611b06d35b07446c62184a137688bc4a4371e2c73d5408e4f058dcf699cc5ed694e57f848766a329d692de17991f8a319b

data/README.md

@@ -29,10 +29,11 @@ class MyApplication::Config < KingKonf::Config
   # The prefix is used to identify environment variables. Here, we require
   # that all environment variables used for config start with `MY_APP_`,
   # followed by the all caps name of the variable.
-  prefix :my_app
+  env_prefix :my_app
 
-  # Strings are the simplest:
-  string :title
+  # Strings are the simplest. This variable is required and *must* be set. By default,
+  # a variable is optional.
+  string :title, required: true
 
   # Integer variables require the value to be a valid integer:
   integer :score
@@ -67,12 +68,20 @@ ENV["MY_APP_CODES"] = "435;2342;8678"
 
 config = MyApplication::Config.new
 
+# This validates that all required variables have been set, raising
+# KingKonf::ConfigError if one is missing.
+config.validate!
+
 config.title #=> "Hello, World!"
 config.score #=> 85
 config.promoted #=> true
 config.allow_comments #=> false
 config.tags #=> ["greetings", "introductions", "articles"]
 config.codes #=> [435, 2342, 8678]
+
+# Boolean variables also get a nice query method alias:
+config.promoted? #=> true
+config.allow_comments? #=> false
 ```
 
 If you prefer to use a config file, that's also possible. Simply load a YAML file with `#load_file`:

data/lib/king_konf/config.rb

@@ -6,9 +6,9 @@ module KingKonf
     @variables = {}
 
     class << self
-      def prefix(prefix = nil)
-        @prefix = prefix if prefix
-        @prefix
+      def env_prefix(prefix = nil)
+        @env_prefix = prefix if prefix
+        @env_prefix
       end
 
       def variable(name)
@@ -23,7 +23,7 @@ module KingKonf
         @variables.values
       end
 
-      %i(boolean integer string list).each do |type|
+      %i(boolean integer float string list).each do |type|
         define_method(type) do |name, default: nil, required: false, **options|
           description, @desc = @desc, nil
           variable = Variable.new(
@@ -42,6 +42,10 @@ module KingKonf
             get(name)
           end
 
+          if variable.boolean?
+            alias_method("#{name}?", name)
+          end
+
           define_method("#{name}=") do |value|
             set(name, value)
           end
@@ -87,9 +91,9 @@ module KingKonf
       variable = self.class.variable(name)
 
       if variable.valid?(value)
-        instance_variable_set("@#{name}", value)
+        instance_variable_set("@#{name}", variable.cast(value))
       else
-        raise ConfigError, "invalid value #{value.inspect}, expected #{variable.type}"
+        raise ConfigError, "invalid value #{value.inspect} for variable `#{name}`, expected #{variable.type}"
       end
     end
 
@@ -111,7 +115,7 @@ module KingKonf
 
     def load_env(env)
       loaded_keys = []
-      prefix = self.class.prefix ? "#{self.class.prefix.upcase}_" : ""
+      prefix = self.class.env_prefix ? "#{self.class.env_prefix.upcase}_" : ""
 
       self.class.variables.each do |variable|
         key = prefix + variable.name.upcase.to_s
@@ -124,7 +128,7 @@ module KingKonf
       end
 
       # Only complain about unknown ENV vars if there's a prefix defined.
-      if self.class.prefix
+      if self.class.env_prefix
         env.keys.grep(/^#{prefix}/).each do |key|
           unless loaded_keys.include?(key)
             raise ConfigError, "unknown environment variable #{key}"

data/lib/king_konf/variable.rb

@@ -11,6 +11,13 @@ module KingKonf
       @options = options
     end
 
+    def cast(value)
+      case @type
+      when :float then value.to_f
+      else value
+      end
+    end
+
     def required?
       @required
     end
@@ -20,6 +27,7 @@ module KingKonf
       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 :float then value.is_a?(Float) || value.is_a?(Integer) || value.nil?
       when :boolean then value == true || value == false
       else raise "invalid type #{@type}"
       end
@@ -29,7 +37,7 @@ module KingKonf
       Decoder.public_send(@type, value, **options)
     end
 
-    %i(boolean integer string list).each do |type|
+    %i(boolean integer float string list).each do |type|
       define_method("#{type}?") do
         @type == type
       end

data/lib/king_konf/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: king_konf
 version: !ruby/object:Gem::Version
-  version: 0.1.6
+  version: 0.1.7
 platform: ruby
 authors:
 - Daniel Schierbeck
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-18 00:00:00.000000000 Z
+date: 2017-10-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler