rb-konfig 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7bffadd86f96ef3163efc25608dde8cc6b13e238687d9e5b1366afcf5ee67b56
+  data.tar.gz: 0fa8992ef19d0985253337af611418d20f8a1cbf74642879571d8c400e479cf4
+SHA512:
+  metadata.gz: 4e354c93f08eba4c21fd691fc012c01769afec1dbf931da322fee7b3e46e58fa07ab0d13004e5b1c211ebeb55647656ee02816043aee9f441b3fb3c27e80a148
+  data.tar.gz: cbbbf864513bf6dfac4958616fd3e536962204cab81d7c1039e1832919b777f925e66dc485f3830413daabf0f24f389b2b4cb1afaef9d946110103d394219da0

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+/.byebug_history
+/.idea

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,7 @@
+require: rubocop-performance
+Metrics/LineLength:
+  Max: 150
+Metrics/BlockLength:
+  Max: 150
+Metrics/CyclomaticComplexity:
+  Max: 12

data/.ruby-gemset

@@ -0,0 +1 @@
+konfig

data/.ruby-version

@@ -0,0 +1,2 @@
+ruby-2.5.5
+

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in konfig.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,76 @@
+PATH
+  remote: .
+  specs:
+    rb-konfig (0.1.0)
+      activesupport
+      hash_dot (~> 2.4)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.3)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    ast (2.4.0)
+    byebug (11.0.1)
+    concurrent-ruby (1.1.5)
+    diff-lcs (1.3)
+    factory_bot (5.0.2)
+      activesupport (>= 4.2.0)
+    hash_dot (2.4.1)
+    i18n (1.6.0)
+      concurrent-ruby (~> 1.0)
+    jaro_winkler (1.5.3)
+    minitest (5.11.3)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.1)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.72.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-performance (1.4.0)
+      rubocop (>= 0.71.0)
+    ruby-progressbar (1.10.1)
+    rufo (0.7.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.0)
+  byebug
+  factory_bot (~> 5.0)
+  rake (~> 10.0)
+  rb-konfig!
+  rspec (~> 3.8)
+  rubocop (~> 0.69)
+  rubocop-performance (~> 1.3)
+  rufo (~> 0.7)
+
+BUNDLED WITH
+   2.0.2

data/README.md

@@ -0,0 +1,101 @@
+# Konfig
+
+Konfig is a Kubernetes friendly Rails configuration file. While Rails applications can easily read YAML files to load configurations, Kubernetes is good at serving individual configuration values as files via Kubernetes Secrets. This means your Rails application needs to read the same configuration file from a YAML file in development or an individual file while running in Kubernetes. Konfig can load configuration and secrets from both YAML or folders with individual files and present them to your application the same way.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rb-konfig'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rb-konfig
+
+## Usage
+
+```ruby
+Konfig.configuration.mode = :yaml
+Konfig.configuration.workdir = "settings/folder"
+Konfig.load
+```
+
+or if you'd like to use it in Kubernetes:
+
+```ruby
+Konfig.configuration.mode = :directory
+Konfig.configuration.workdir = "settings/folder"
+Konfig.load
+```
+
+Now you can use Konfig anywhere in the code:
+
+```ruby
+puts Settings.some.configuration.value
+```
+
+In `development` mode, Konfig, looks for `development.yml` in `work_dir`. In `kubernetes` mode, it looks for a file for each one of the given configuration keys. For example:
+
+```yml
+# development.yml
+some:
+    configuration:
+        value: true
+```
+
+```bash
+# directory mode
+$ ls config/settings
+-rw-r--r--    1 khash  staff    20 10 May 07:20 some.configuration.value
+
+$ cat config/settings/some.configuration.value
+true
+```
+
+The value in `some.configuration.value` file can be `true`. Konfig tries to clean the file and coerce the value into the right type before returning. If the file or the key in yaml is missing, it will return a `Konfig::MissingConfiguration` is thrown.
+
+### NULL / nil values
+
+By default YAML returns `nil` for a `null` value in a YAML file. This is also replicated in directory mode.
+
+### Configuration
+You can change or reach the following from `Konfig.configuration`
+
+`namespace`: Default is `Settings`
+`delimiter`: Default is `.`
+`default_config_file`: Default is `development.yml`
+`allow_nil`: Default is `true`
+`nil_word`: Default is `null`
+`mode`: No default value
+`workdir`: No default value
+
+### Data types
+
+The directory mode, supports the following data types in files and tries to return the right type:
+
+- Integer
+- Float
+- String
+- Date time
+- Boolean
+- Null (see above)
+
+### ERB
+
+YAML mode supports ERB in your YAML file, just like default Rails behavior
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/khash/konfig.

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "konfig"
+
+# 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/konfig.gemspec

@@ -0,0 +1,37 @@
+lib = File.expand_path("lib", __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "konfig/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "rb-konfig"
+  spec.version = Konfig::VERSION
+  spec.authors = ["Khash Sajadi"]
+  spec.email = ["khash@sajadi.co.uk"]
+
+  spec.summary = %q{Konfig is a Kubernetes friendly Rails configuration gem}
+  spec.homepage = "https://github.com/khash/konfig"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/khash/konfig"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path("..", __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "hash_dot", "~> 2.4"
+  spec.add_dependency "activesupport"
+
+  spec.add_development_dependency "bundler", "~> 2.0"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "factory_bot", "~> 5.0"
+  spec.add_development_dependency "rspec", "~> 3.8"
+  spec.add_development_dependency "rubocop", "~> 0.69"
+  spec.add_development_dependency "rubocop-performance", "~> 1.3"
+  spec.add_development_dependency "rufo", "~> 0.7"
+  spec.add_development_dependency "byebug"
+end

data/lib/konfig.rb

@@ -0,0 +1,55 @@
+require "active_support/core_ext/hash"
+Dir["#{File.dirname(__FILE__)}/konfig/**/*.rb"].each { |f| load(f) }
+
+module Konfig
+  def self.configuration
+    @config ||= Konfig::Config.new
+  end
+
+  def self.load
+    provider = ConfigProvider.provider(mode: self.configuration.mode, workdir: self.configuration.workdir)
+    provider.load
+  end
+
+  class Config
+    attr_writer :namespace
+    attr_writer :delimiter
+    attr_writer :default_config_file
+    attr_writer :allow_nil
+    attr_writer :nil_word
+    attr_writer :mode
+    attr_writer :workdir
+
+    def namespace
+      @namespace || "Settings"
+    end
+
+    def workdir
+      raise NotConfiguredError, "have you set workdir?" unless @workdir
+
+      @workdir
+    end
+
+    def mode
+      raise NotConfiguredError, "have you set mode?" unless @mode
+
+      @mode
+    end
+
+    def delimiter
+      @delimiter || "."
+    end
+
+    def default_config_file
+      @default_config_file || "development.yml"
+    end
+
+    def allow_nil
+      @allow_nil.nil? ? true : @allow_nil
+    end
+
+    def nil_word
+      @nil_word || "null"
+    end
+  end
+end

data/lib/konfig/config_provider.rb

@@ -0,0 +1,28 @@
+module Konfig
+  class ConfigProvider
+    attr_reader :mode
+    attr_reader :workdir
+
+    def initialize(mode:, workdir:)
+      raise ArgumentError unless workdir
+      raise ArgumentError unless [:yaml, :directory].include? mode
+      raise FileNotFound, "directory #{workdir} not found" unless Dir.exist? workdir
+
+      @mode = mode
+      @workdir = workdir
+    end
+
+    def self.provider(mode:, workdir:)
+      raise ArgumentError unless workdir
+      raise ArgumentError unless [:yaml, :directory].include? mode
+
+      if mode == :yaml
+        return YamlProvider.new(workdir: workdir)
+      elsif mode == :directory
+        return DirectoryProvider.new(workdir: workdir)
+      else
+        raise ArgumentError
+      end
+    end
+  end
+end

data/lib/konfig/directory_provider.rb

@@ -0,0 +1,76 @@
+require_relative "config_provider"
+require "date"
+
+module Konfig
+  class NilClass; end
+
+  NIL_VALUE = NilClass.new
+
+  class DirectoryProvider < ConfigProvider
+    def initialize(workdir:)
+      super(mode: :yaml, workdir: workdir)
+      @files = Dir.children(@workdir)
+    end
+
+    def load
+      build_object_from_list(@files)
+    end
+
+    private
+
+    # deserializers. order matters here
+    DESERIALIZERS = [
+      lambda { |value| Integer(value) rescue NIL_VALUE }, # integer
+      lambda { |value| Float(value) rescue NIL_VALUE }, # float
+      lambda { |value| (["true", "false"].include?(value)) ? (value == "true") : NIL_VALUE }, # boolean
+      lambda { |value| DateTime.parse(value) rescue NIL_VALUE }, # date time
+      lambda { |value| (value == Konfig.configuration.nil_word && Konfig.configuration.allow_nil) ? nil : NIL_VALUE }, # nil value
+      lambda { |value| value }, # string. should always be the last one
+    ]
+
+    def get_value(filepath)
+      fullpath = File.join(@workdir, filepath)
+      raise FileNotFound, "key #{filepath} not found. Expecting to find it in #{fullpath}" unless File.exist? fullpath
+      content = File.read(fullpath).chomp
+      return coerce(content)
+    end
+
+    def coerce(value)
+      # assume a float first
+      DESERIALIZERS.each do |deseralizer|
+        result = deseralizer.call(value)
+        return result unless result == NIL_VALUE
+      end
+
+      raise UnsupportedValueType, "'#{value}' is unsupported type"
+    end
+
+    def build_hash_from_list(list)
+      result = []
+      list.each do |item|
+        value = get_value(item)
+        result << build_hash(item, value)
+      end
+
+      return result
+    end
+
+    def build_object_from_list(list)
+      Object.send(:remove_const, Konfig.configuration.namespace) if Object.const_defined?(Konfig.configuration.namespace)
+
+      full_hash = {}
+      hash_list = build_hash_from_list(list)
+      hash_list.each do |item|
+        full_hash.deep_merge!(item)
+      end
+
+      Object.const_set(Konfig.configuration.namespace, full_hash.to_dot)
+    end
+
+    def build_hash(key, value)
+      parts = key.split(Konfig.configuration.delimiter)
+      parts << value
+      parts.reverse.inject { |a, n| { n => a } }
+    end
+  end
+end

data/lib/konfig/errors.rb

@@ -0,0 +1,5 @@
+module Konfig
+  class Error < StandardError; end
+  class FileNotFound < Error; end
+  class NotConfiguredError < Error; end
+end

data/lib/konfig/version.rb

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

data/lib/konfig/yaml_provider.rb

@@ -0,0 +1,30 @@
+require_relative "config_provider"
+require "yaml"
+require "hash_dot"
+require "erb"
+
+module Konfig
+  class YamlProvider < ConfigProvider
+    attr_reader :file
+    attr_reader :raw_settings
+
+    def initialize(workdir:, filename: Konfig.configuration.default_config_file)
+      super(mode: :yaml, workdir: workdir)
+      @file = File.join(workdir, filename)
+      raise FileNotFound, "#{@file} not found" unless File.exists? @file
+    end
+
+    def load
+      content = YAML.load(ERB.new(IO.read(@file)).result) if @file and File.exist?(@file)
+      content ||= {}
+
+      @raw_settings = content.to_dot
+      Object.send(:remove_const, Konfig.configuration.namespace) if Object.const_defined?(Konfig.configuration.namespace)
+      Object.const_set(Konfig.configuration.namespace, @raw_settings)
+    rescue Psych::SyntaxError => exc
+      raise "YAML syntax error occurred while parsing #{@file}. " \
+            "Please note that YAML must be consistently indented using spaces. Tabs are not allowed. " \
+            "Error: #{exc.message}"
+    end
+  end
+end

metadata

@@ -0,0 +1,203 @@
+--- !ruby/object:Gem::Specification
+name: rb-konfig
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Khash Sajadi
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-06-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hash_dot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !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: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.8'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.69'
+- !ruby/object:Gem::Dependency
+  name: rubocop-performance
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rufo
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- khash@sajadi.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-gemset"
+- ".ruby-version"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- konfig.gemspec
+- lib/konfig.rb
+- lib/konfig/config_provider.rb
+- lib/konfig/directory_provider.rb
+- lib/konfig/errors.rb
+- lib/konfig/version.rb
+- lib/konfig/yaml_provider.rb
+homepage: https://github.com/khash/konfig
+licenses: []
+metadata:
+  homepage_uri: https://github.com/khash/konfig
+  source_code_uri: https://github.com/khash/konfig
+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.7.6.2
+signing_key: 
+specification_version: 4
+summary: Konfig is a Kubernetes friendly Rails configuration gem
+test_files: []