king_konf 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6744213f0b37e03068723d66aed90974aaa0674d
+  data.tar.gz: 8e425438c7a1d649754dbaf913888032adfbd7c3
+SHA512:
+  metadata.gz: 1934dbad4faea5353f43a376f11e58ebbef4347298615210888508d16ead83e3473bb757efdc3ff56ffcacfb5a93f04c8eb5fa63224d36d5dfc434b55740794f
+  data.tar.gz: ad7c4aa1ac20152f3afc4399402f9774a75ac2bdbb89c41cbdc9e5a1efb97ade303d83d7cb764a7e4673275566d038db044da55f96ec623bb79ad0579367ed1b

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in king_konf.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Daniel Schierbeck
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,88 @@
+# KingKonf
+
+KingKonf gives you a way of declaratively specifying configuration variables for your application or library. It is focused on simplicity and being able to work well with environment variables, meaning that there is no nesting or fancy structures: all configuration can be passed as strings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'king_konf'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install king_konf
+
+## Usage
+
+In order to specify a set configuration variables, simply subclass `KingKonf::Config` and use the DSL:
+
+```ruby
+require "king_konf"
+
+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
+
+  # Strings are the simplest:
+  string :title
+
+  # Integer variables require the value to be a valid integer:
+  integer :score
+
+  # Booleans by default use "true", "false", "1", and "0" as valid values:
+  boolean :promoted
+
+  # These can be configured:
+  boolean :allow_comments, true_values: ["yes"], false_values: ["no"]
+
+  # Lists are by default comma-separated arrays of strings:
+  list :tags
+
+  # You can separate with other characters, and decode each value as another type:
+  list :codes, sep: ";", items: :integer
+
+  # You can also provide a default value to any variable:
+  string :body, default: "N/A"
+end
+```
+
+Now that we've defined a configuration class, we can initialize it. KingKonf will read the ENV and detect any variables that match the prefix:
+
+```ruby
+# These would normally be passed by the system running your app:
+ENV["MY_APP_TITLE"] = "Hello, World!"
+ENV["MY_APP_SCORE"] = "85"
+ENV["MY_APP_PROMOTED"] = "true"
+ENV["MY_APP_ALLOW_COMMENTS"] = "no"
+ENV["MY_APP_TAGS"] = "greetings,introductions,articles"
+ENV["MY_APP_CODES"] = "435;2342;8678"
+
+config = MyApplication::Config.new
+
+config.title #=> "Hello, World!"
+config.score #=> 85
+config.promoted #=> true
+config.allow_comments #=> false
+config.tags #=> ["greetings", "introductions", "articles"]
+config.codes #=> [435, 2342, 8678]
+```
+
+## 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.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/dasch/king_konf.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "king_konf"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/king_konf.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "king_konf/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "king_konf"
+  spec.version = KingKonf::VERSION
+  spec.authors = ["Daniel Schierbeck"]
+  spec.email = ["daniel.schierbeck@gmail.com"]
+
+  spec.summary = "A simple configuration library"
+  spec.description = "A simple configuration library"
+  spec.homepage = "https://github.com/dasch/king_konf"
+  spec.license = "MIT"
+
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/king_konf/config.rb

@@ -0,0 +1,154 @@
+require "king_konf/config_file_loader"
+
+module KingKonf
+  class Decoder
+    def self.boolean(value, true_values: ["true", "1"], false_values: ["false", "0"])
+      if true_values.include?(value)
+        true
+      elsif false_values.include?(value)
+        false
+      else
+        values = true_values + false_values
+        raise ConfigError, "#{value.inspect} is not a boolean: must be one of #{values.join(', ')}"
+      end
+    end
+
+    def self.string(value, **)
+      value
+    end
+
+    def self.list(value, sep: ",", items: :string)
+      value.split(sep).map {|s| public_send(items, s) }
+    end
+
+    def self.integer(value, **)
+      Integer(value)
+    rescue ArgumentError
+      raise ConfigError, "#{value.inspect} is not an integer"
+    end
+  end
+
+  class Variable
+    attr_reader :name, :type, :default, :options
+
+    def initialize(name, type, default, options)
+      @name, @type, @default = name, type, default
+      @options = options
+    end
+
+    def valid?(value)
+      case @type
+      when :string then value.is_a?(String)
+      when :list then value.is_a?(Array)
+      when :integer then value.is_a?(Integer)
+      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 = {}
+
+    class << self
+      def prefix(prefix = nil)
+        @prefix = prefix if prefix
+        @prefix
+      end
+
+      def variable(name)
+        @variables.fetch(name.to_s)
+      end
+
+      def variable?(name)
+        @variables.key?(name.to_s)
+      end
+
+      def variables
+        @variables.values
+      end
+
+      %i(boolean integer string list).each do |type|
+        define_method(type) do |name, default: nil, **options|
+          variable = Variable.new(name, type, default, options)
+
+          @variables ||= {}
+          @variables[name.to_s] = variable
+
+          define_method(name) do
+            get(name)
+          end
+
+          define_method("#{name}=") do |value|
+            set(name, value)
+          end
+        end
+      end
+    end
+
+    def initialize(env: ENV)
+      load_env(env)
+    end
+
+    def load_file(path, environment)
+      loader = ConfigFileLoader.new(self)
+      loader.load_file(path, environment)
+    end
+
+    def get(name)
+      if value = instance_variable_get("@#{name}")
+        value
+      else
+        variable = self.class.variable(name)
+        variable.default
+      end
+    end
+
+    def set(name, value)
+      unless self.class.variable?(name)
+        raise ConfigError, "unknown configuration variable #{name}"
+      end
+
+      variable = self.class.variable(name)
+
+      if variable.valid?(value)
+        instance_variable_set("@#{name}", value)
+      else
+        raise ConfigError, "invalid value #{value.inspect}, expected #{variable.type}"
+      end
+    end
+
+    private
+
+    def load_config(config)
+      config.each do |variable, value|
+        set(variable, value)
+      end
+    end
+
+    def load_env(env)
+      loaded_keys = []
+      prefix = self.class.prefix || ""
+
+      self.class.variables.each do |variable|
+        key = "#{prefix.upcase}_#{variable.name.upcase}"
+
+        if string = env[key]
+          value = variable.decode(string)
+          set(variable.name, value)
+          loaded_keys << key
+        end
+      end
+
+      env.keys.grep(/^#{prefix.upcase}_/).each do |key|
+        unless loaded_keys.include?(key)
+          raise ConfigError, "unknown env variable #{key}"
+        end
+      end
+    end
+  end
+end

data/lib/king_konf/config_file_loader.rb

@@ -0,0 +1,23 @@
+require "erb"
+require "yaml"
+
+module KingKonf
+  class ConfigFileLoader
+    def initialize(config)
+      @config = config
+    end
+
+    def load_file(path, environment)
+      # 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)
+
+      processed.fetch(environment).each do |variable, value|
+        @config.set(variable, value)
+      end
+    end
+  end
+end

data/lib/king_konf/version.rb

@@ -0,0 +1,3 @@
+module KingKonf
+  VERSION = "0.1.0"
+end

data/lib/king_konf.rb

@@ -0,0 +1,6 @@
+require "king_konf/version"
+require "king_konf/config"
+
+module KingKonf
+  ConfigError = Class.new(StandardError)
+end

metadata

@@ -0,0 +1,99 @@
+--- !ruby/object:Gem::Specification
+name: king_konf
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Schierbeck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-09-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: A simple configuration library
+email:
+- daniel.schierbeck@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- king_konf.gemspec
+- lib/king_konf.rb
+- lib/king_konf/config.rb
+- lib/king_konf/config_file_loader.rb
+- lib/king_konf/version.rb
+homepage: https://github.com/dasch/king_konf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+specification_version: 4
+summary: A simple configuration library
+test_files: []