easy-settings 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 28262b3447381ef370224446b8d64871b2391aa420f3addfde0417a9b4a3c909
+  data.tar.gz: 44c4d788c7f2b49e4748062b3f48029ce331da8c55a7b920543eadd3f2da6023
+SHA512:
+  metadata.gz: cb3b83e76da3c4ae3afa86525b35cec52f6dfe4b8809d2e080c21acad84b30cce0e3975a285daa1994d9907b629e89798ad867e6e1b8320bebd6e43ac7f16ea6
+  data.tar.gz: e4900f399e2b9d7089f5999b5b908beb5e05586a6312a8587d0f85ebab661e9a2a35e855a629a690be0b0e1263dac6fb1a5031c4fc92215583424f1963e86e53

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.idea
+
+.byebug_history

data/Dockerfile

@@ -0,0 +1,7 @@
+FROM ruby:2.6-stretch
+
+RUN groupadd --gid 1000 web && useradd --create-home --uid 1000 --gid 1000 --shell /bin/bash web
+
+WORKDIR /home/web/app
+
+USER web

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 - 2019 Corin Langosch
+
+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.rdoc

@@ -0,0 +1,61 @@
+= easy-settings
+
+Inspired by the mc-settings and config gems, but with a simpler code base and more flexible.
+
+== Installation
+
+Just include the screwdriver gem in your Bundler Gemfile
+
+  gem "easy-settings"
+
+== Usage
+
+Just create an instance of EasySettings (you can have as many as you need) and specify the sources, where this instance should load its settings/ configuration from. The sources are loaded in order and later settings override previous ones. This ways it's easy to for example put some defaults in a defaults.yml but override the settings using ENV variables or docker swarm secrets. Example:
+
+  Settings = EasySettings.new(
+    sources: [
+      EasySettings::YamlSource.new("config/settings/defaults.yml")),
+      EasySettings::YamlSource.new("config/settings/#{Rails.env}.yml")),
+      EasySettings::PathSource.new("/run/secrets"), # nice when using docker swarm secrets (the name of the file is the name of the setting, similar to the ENV source)
+      EasySettings::EnvSource.new("APP"), # APP__BUSINESS_TIME__ENABLED=true => Settings.business_time.enabled
+    ],
+    fail_on_missing: true,
+  )
+
+  MyConfig = EasySettings.new(
+    sources: [
+      EasySettings::YamlSource.new("config.yml"),
+      EasySettings::EnvSource.new("APP"),
+    ],
+  )
+
+You can also easily implement your own `Source` in case you have special requirements. Just have a look at the ones defined in this gem to see how.
+
+To access your settings:
+
+  Settings.apis.netskin.url # raises exception if setting cannot be found if fail_on_missing is true, nil otherwise
+  Settings.apis.netskin.try("url") # returns nil if setting cannot be found
+  Settings.business_time[2019].holidays # raises exception if setting cannot be found if fail_on_missing is true, nil otherwise
+
+To set/ change some settings programmatically:
+
+  Settings.apis.netskin.url = "https://www.netskin.com"
+  Settings.apis.netskin["url"] = "https://www.netskin.com"
+
+== Todo/ next steps
+
+* Add tests
+
+== Contributing
+
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
+* Fork the project
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+== Copyright
+
+Copyright (c) by Corin Langosch. Released unter the MIT license.

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/docker-compose.yml

@@ -0,0 +1,8 @@
+version: "2.1"
+
+services:
+  web:
+    build: .
+    command: bash -c 'sleep 100000'
+    volumes:
+      - ./:/home/web/app

data/easy-settings.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "easy-settings/version"
+
+Gem::Specification.new do |s|
+  s.name        = "easy-settings"
+  s.version     = EasySettings::VERSION
+  s.license     = "MIT"
+  s.authors     = ["Corin Langosch"]
+  s.email       = ["info@corinlangosch.com"]
+  s.homepage    = "https://github.com/gucki/easy-settings"
+  s.summary     = %q{flexible yet easy handling of application settings}
+  s.description = %q{flexible yet easy handling of application settings}
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "byebug"
+  s.add_runtime_dependency "activesupport", ">=3.0.0"
+end

data/lib/easy-settings.rb

@@ -0,0 +1,31 @@
+require "easy-settings/version"
+require "easy-settings/struct"
+require "easy-settings/env_source"
+require "easy-settings/path_source"
+require "easy-settings/yaml_source"
+
+class EasySettings
+  delegate :respond_to?, to: :@data
+
+  def initialize(sources:, fail_on_missing: true)
+    @sources = sources
+    @fail_on_missing = fail_on_missing
+    reload!
+  end
+
+  def reload!
+    config = {}
+    @sources.each do |source|
+      data = source.load
+      config.deep_merge!(data)
+    end
+    @data = EasySettings::Struct.import(config)
+  end
+
+  def method_missing(method_name, *args)
+    @data.send(method_name, *args)
+  rescue EasySettings::Struct::UnknownPropertyError => e
+    return unless @fail_on_missing
+    raise e
+  end
+end

data/lib/easy-settings/coercion.rb

@@ -0,0 +1,24 @@
+require "json"
+
+class EasySettings::Coercion
+  attr_reader :value
+
+  def initialize(value)
+    @value = value
+  end
+
+  def run
+    case value
+    when "false"
+      false
+    when "true"
+      true
+    when /^json:/
+      JSON.parse(value.gsub(/^json:/, ""))
+    when /^\+/ # don't treat +41791234567 as a number
+      value
+    else
+      Integer(value) rescue Float(value) rescue value
+    end
+  end
+end

data/lib/easy-settings/env_source.rb

@@ -0,0 +1,28 @@
+require "easy-settings/coercion"
+
+class EasySettings::EnvSource
+  attr_reader :prefix, :separator, :converter, :parse_values
+
+  def initialize(prefix, separator: "__", converter: :downcase, parse_values: true)
+    @prefix = prefix
+    @separator = separator
+    @converter = converter
+    @parse_values = parse_values
+  end
+
+  def load
+    {}.tap do |data|
+      ENV.each do |variable, value|
+        keys = variable.to_s.split(separator)
+        next unless keys.shift == prefix
+
+        keys.map!{ |key| key.send(converter) } if converter
+
+        leaf = keys[0...-1].inject(data){ |h, key| h[key] ||= {} }
+        leaf[keys.last] = parse_values ? EasySettings::Coercion.new(value).run : value
+      rescue NoMethodError => e
+        raise "Invalid name converter: #{converter}"
+      end
+    end
+  end
+end

data/lib/easy-settings/path_source.rb

@@ -0,0 +1,31 @@
+require "easy-settings/coercion"
+
+class EasySettings::PathSource
+  attr_reader :base_path, :separator, :converter, :parse_values
+
+  def initialize(base_path, separator: "__", converter: :downcase, parse_values: true)
+    @base_path = base_path.to_s
+    @separator = separator
+    @converter = converter
+    @parse_values = parse_values
+  end
+
+  def load
+    {}.tap do |data|
+      Dir["#{base_path}/*"].each do |path|
+        next unless File.file?(path)
+
+        variable = path.gsub("#{base_path}/", "")
+        value = File.read(path).strip
+
+        keys = variable.to_s.split(separator)
+        keys.map!{ |key| key.send(converter) } if converter
+
+        leaf = keys[0...-1].inject(data){ |h, key| h[key] ||= {} }
+        leaf[keys.last] = parse_values ? EasySettings::Coercion.new(value).run : value
+      rescue NoMethodError => e
+        raise "Invalid name converter: #{converter}"
+      end
+    end
+  end
+end

data/lib/easy-settings/struct.rb

@@ -0,0 +1,58 @@
+class EasySettings::Struct
+  include Enumerable
+
+  UnknownPropertyError = Class.new(StandardError)
+
+  delegate :each, to: :@properties
+
+  def self.import(hash)
+    new.tap do |struct|
+      hash.each do |k, v|
+        case v
+        when Hash
+          v = import(v)
+        when Array
+          v = v.collect{ |i| i.is_a?(Hash) ? import(i) : i }
+        end
+        struct[k] = v
+      end
+    end
+  end
+
+  def initialize(properties = {})
+    @properties = properties
+  end
+
+  def [](property)
+    @properties.fetch(property){ raise_unknown_property(property) }
+  end
+
+  def []=(property, value)
+    @properties[property] = value
+  end
+
+  def try(property)
+    @properties[property]
+  end
+
+  def to_h
+    @properties.transform_values{ |v| v.is_a?(EasySettings::Struct) ? v.to_h : v }
+  end
+
+  def respond_to?(property, include_private = false)
+    @properties.has_key?(property.to_s)
+  end
+
+  def method_missing(method, *args)
+    method = method.to_s
+    return @properties.fetch(method) unless method.end_with?("=")
+    property = method[0..-2]
+    @properties[property] = args[0]
+  rescue KeyError => e
+    raise_unknown_property(method)
+  end
+
+  def raise_unknown_property(property)
+    raise UnknownPropertyError, "unknown property #{property.inspect} (#{@properties.keys.map(&:inspect).join(", ")})"
+  end
+end

data/lib/easy-settings/version.rb

@@ -0,0 +1,3 @@
+class EasySettings
+  VERSION = "1.0.0"
+end

data/lib/easy-settings/yaml_source.rb

@@ -0,0 +1,16 @@
+require "yaml"
+require "erb"
+
+class EasySettings::YamlSource
+  attr_reader :path
+
+  def initialize(path)
+    @path = path.to_s
+  end
+
+  def load
+    result = File.exist?(path) ? YAML.load(ERB.new(IO.read(path)).result) : {}
+  rescue StandardError => e
+    raise "Error occurred while parsing #{path}: #{e.message}"
+  end
+end

data/spec/easy-settings_spec.rb

@@ -0,0 +1,4 @@
+require "spec_helper"
+
+describe EasySettings do
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require "bundler/setup"
+Bundler.setup
+
+RSpec.configure do |config|
+  # some (optional) config here
+end

metadata

@@ -0,0 +1,102 @@
+--- !ruby/object:Gem::Specification
+name: easy-settings
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Corin Langosch
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: flexible yet easy handling of application settings
+email:
+- info@corinlangosch.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Dockerfile
+- Gemfile
+- LICENSE.txt
+- README.rdoc
+- Rakefile
+- docker-compose.yml
+- easy-settings.gemspec
+- lib/easy-settings.rb
+- lib/easy-settings/coercion.rb
+- lib/easy-settings/env_source.rb
+- lib/easy-settings/path_source.rb
+- lib/easy-settings/struct.rb
+- lib/easy-settings/version.rb
+- lib/easy-settings/yaml_source.rb
+- spec/easy-settings_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gucki/easy-settings
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: flexible yet easy handling of application settings
+test_files: []