mimi-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ede4e9494fa2da839879c476231cb7b53e917717
+  data.tar.gz: d6f19fbe2a4f66d6ffd2260becc0c724e0fbadbf
+SHA512:
+  metadata.gz: 552d80c961767e0b097abfc384d15629e39bbca6495ff3651087d900c822f1f743dcc3e81ec7764a6ecc3a0fb6647db45d3e415022cba780dd6c1f2c178ea031
+  data.tar.gz: e303ea389d4ca52aa61e9b30593ae3e6c18afddb563c93af400174d558ad5a046253aef55d47dc387069c70619d95bf9b49c07a2e24c14bb2f97fb4ef6e3b8e6

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at alex@kukushk.in. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+
+gemspec
+
+# Comment out the following gem instructions, if you not using gem sources
+gem 'mimi-core', path: '/mimi-core'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Alex Kukushkin
+
+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 @@
+# mimi-config
+
+A simple ENV based configuration for microservice applications.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mimi-config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install mimi-config
+
+## Usage
+
+`Mimi::Config` allows you to define a set of configurable parameters and constants in a *manifest* file with a simple YAML format.
+
+### Example manifest.yml
+```yaml,name=manifest.yml
+opt1:
+  desc: This is an optional configurable parameter
+  default: 123
+
+opt2:
+  desc: This is an optional configurable parameter with the default value of nil
+  default:
+
+const1:
+  desc: This is a constant parameter, that cannot be changed via an ENV variable
+  const: 456
+
+
+req1: This is a required configurable parameter
+
+req2:
+  desc: And so is this one
+
+# And so is this one with no description
+req3:
+```
+
+### How to load configuration from your app
+
+Providing you have placed your manifest into `config/manifest.yml`:
+
+```ruby
+config = Mimi::Config.new('config/manifest.yml')
+
+config.const1 # => 456, from manifest.yml
+config.opt1 # value from ENV['opt1'] or default from manifest.yml
+config.req2 # value from ENV['req2']
+
+# alternatively use [] syntax:
+config.opt2    #
+config[:opt2]  # all three refer to the same configurable parameter
+config['opt2'] #
+
+# you cannot access parameters not defined in the manifest:
+config.req5 # => NoMethodError
+config['req5'] # => ArgumentError
+
+# check, if parameter is defined:
+config.include?('req5') # => false
+```
+
+## 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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/mimi-config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+
+## 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,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mimi/config'
+
+require 'pry'
+Pry.start

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/lib/mimi/config/version.rb

@@ -0,0 +1,5 @@
+module Mimi
+  class Config
+    VERSION = '0.1.0'.freeze
+  end # class Config
+end # module Mimi

data/lib/mimi/config.rb

@@ -0,0 +1,177 @@
+require 'pathname'
+require 'yaml'
+require 'dotenv'
+require 'mimi/core'
+
+module Mimi
+  #
+  # Config stores the manifest and reads and stores configurable parameters from ENV.
+  #
+  # @see README.md
+  #
+  class Config
+    include Mimi::Core::Module
+
+    # Current set of values for configurable and const parameters
+    attr_reader :params
+
+    default_options(
+      raise_on_missing_params: true,
+      use_dotenv: true
+    )
+
+    # Creates a Config object.
+    #
+    # Loads and parses manifest.yml, reads and sets configurable parameters
+    # from ENV.
+    #
+    # Raises an error if any of the required configurable parameters are missing.
+    #
+    # @param manifest_filename [String,nil] path to the manifest.yml or nil to skip loading manifest
+    #
+    def initialize(manifest_filename = nil, opts = {})
+      @manifest = {}
+      @params = {}
+      load(manifest_filename, opts) if manifest_filename
+    end
+
+    # Loads and parses manifest.yml, reads and sets configurable parameters
+    # from ENV.
+    #
+    def load(manifest_filename, opts = {})
+      opts = self.class.module_options.deep_merge(opts)
+      manifest_filename = Pathname.new(manifest_filename).expand_path
+      load_manifest(manifest_filename, opts)
+      load_params(opts)
+      if opts[:raise_on_missing_params] && !missing_params.empty?
+        raise "Missing required configurable parameters: #{missing_params.join(', ')}"
+      end
+      self
+    end
+
+    # Returns list of missing required params
+    #
+    def missing_params
+      required_params = manifest.select { |p| p[:required] }.map { |p| p[:name] }
+      required_params - @params.keys
+    end
+
+    # Returns annotated manifest
+    #
+    def manifest
+      @manifest.map do |k, v|
+        {
+          name: k,
+          desc: v[:desc],
+          required: !v.key?(:default),
+          const: v[:const],
+          default: v[:default]
+        }
+      end
+    end
+
+    # Returns true if the config manifest includes the parameter with the given name.
+    #
+    # If manifest includes the parameter name, it is safe to access paramter
+    # via #[] and #<name> methods.
+    #
+    def include?(name)
+      @manifest.key?(name.to_sym)
+    end
+
+    # Returns the parameter value
+    #
+    # @param key [String,Symbol] parameter name
+    #
+    def [](key)
+      raise ArgumentError, "Undefined parameter '#{key}'" unless include?(key)
+      @params[key.to_sym]
+    end
+
+    # Provides access to parameters as methods.
+    #
+    # Example:
+    #   config['foo'] # => 'bar'
+    #   config.foo # => 'bar'
+    #
+    #   # missing parameter
+    #   config['bar'] # => ArgumentError
+    #   config.bar # => NoMethodError
+    #
+    def method_missing(name, *)
+      return self[name] if include?(name)
+      super
+    end
+
+    def respond_to_missing?(name, *)
+      include?(name) || super
+    end
+
+    private
+
+    # Reads manifest file and merges it with the current manifest.
+    #
+    def load_manifest(filename, _opts = {})
+      new_manifest = YAML.load(File.read(filename))
+      return manifest unless new_manifest
+      raise 'Invalid manifest file format' unless new_manifest.is_a?(Hash)
+      new_manifest.each do |k, v|
+        merge_manifest_key(k, v)
+      end
+      manifest
+    rescue StandardError => e
+      raise "Failed to load manifest file: #{e}"
+    end
+
+    # Reads parameters from the ENV according to the current manifest
+    #
+    def load_params(opts = {})
+      Dotenv.load if opts[:use_dotenv]
+      manifest.each do |p|
+        env_name = p[:name].to_s
+        if p[:const]
+          # const
+          @params[p[:name]] = p[:default]
+        elsif p[:required]
+          # required configurable
+          @params[p[:name]] = ENV[env_name] if ENV.key?(env_name)
+        else
+          # optional configurable
+          @params[p[:name]] = ENV.key?(env_name) ? ENV[env_name] : p[:default]
+        end
+      end
+      @params
+    end
+
+    def merge_manifest_key(k, v)
+      k = k.to_sym
+      @manifest[k] ||= {}
+      if v.nil?
+        # var:
+      elsif v.is_a?(String)
+        # var: A description
+        @manifest[k][:desc] = v
+      elsif v.is_a?(Hash)
+        merge_manifest_key_hash(k, v)
+      end
+    end
+
+    def merge_manifest_key_hash(k, v)
+      @manifest[k][:desc] = v['desc'] if v.key?('desc')
+
+      if v.key?('const') && v.key?('default')
+        raise "Invalid mix of 'const' and 'default' in parameter definition '#{k}'"
+      end
+
+      if v.key?('default')
+        @manifest[k][:const] = false
+        @manifest[k][:default] = v['default']
+      elsif v.key?('const')
+        @manifest[k][:const] = true
+        @manifest[k][:default] = v['const']
+      end
+    end
+  end # class Config
+end # module Mimi
+
+require_relative 'config/version'

data/mimi-config.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mimi/config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mimi-config'
+  spec.version       = Mimi::Config::VERSION
+  spec.authors       = ['Alex Kukushkin']
+  spec.email         = ['alex@kukushk.in']
+
+  spec.summary       = 'Simple ENV based configuration for microservice apps'
+  spec.description   = 'Simple ENV based configuration for microservice apps'
+  spec.homepage      = 'https://github.com/kukushkin/mimi-config'
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org/'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'mimi-core', '~> 0.1'
+  spec.add_dependency 'dotenv', '~> 2.1'
+
+  spec.add_development_dependency 'bundler', '~> 1.11'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry', '~> 0.10'
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: mimi-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Alex Kukushkin
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-04-29 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mimi-core
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.1'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+description: Simple ENV based configuration for microservice apps
+email:
+- alex@kukushk.in
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/mimi/config.rb
+- lib/mimi/config/version.rb
+- mimi-config.gemspec
+homepage: https://github.com/kukushkin/mimi-config
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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: Simple ENV based configuration for microservice apps
+test_files: []