loadable_config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f9e359a1aa612416d1e8c84476e0f2e955208816710333d0d94e88dbcdd07a0
+  data.tar.gz: 5cea5fb4d8af5246fd5b36906f4120ea9a1e128a58772fe856c2ddeb467fab44
+SHA512:
+  metadata.gz: ebe69bc54c01a15a12e0611aabace5ed1ed5fd269b0ca2ae66b1bffd291128410f2d8efa634c6ddaa8241af4a16ed559d32a8b3bc4f36dd97fbf73f133294240
+  data.tar.gz: cc068e42ecbf05a68307929ece847b5b3da1a8c525b1a8062df16a23c23f791f86cf833eed87741c10b4bd75fdc339a4ca4d3f8adf050e7b3ec08adc26cac735

data/.circleci/config.yml

@@ -0,0 +1,98 @@
+version: 2.1
+
+executors:
+  ruby:
+    parameters:
+      ruby-version:
+        type: string
+        default: "2.6"
+      gemfile:
+        type: string
+        default: "Gemfile"
+    docker:
+      - image: circleci/ruby:<< parameters.ruby-version >>
+        environment:
+          BUNDLE_JOBS: 3
+          BUNDLE_RETRY: 3
+          BUNDLE_PATH: vendor/bundle
+          RAILS_ENV: test
+          BUNDLE_GEMFILE: << parameters.gemfile >>
+
+jobs:
+  test:
+    parameters:
+      ruby-version:
+        type: string
+    executor:
+      name: ruby
+      ruby-version: << parameters.ruby-version >>
+    parallelism: 1
+    steps:
+      - checkout
+
+      - run:
+          # Remove the non-appraisal gemfile for safety: we never want to use it.
+          name: Prepare bundler
+          command: bundle -v
+
+      - run:
+          name: Compute a gemfile lock
+          command: bundle lock && cp "${BUNDLE_GEMFILE}.lock" /tmp/gem-lock
+
+      - restore_cache:
+          keys:
+            - loadable_config-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+            - loadable_config-
+
+      - run:
+          name: Bundle Install
+          command: bundle check || bundle install
+
+      - save_cache:
+          key: loadable_config-<< parameters.ruby-version >>-{{ checksum "/tmp/gem-lock" }}
+          paths:
+            - vendor/bundle
+
+      - run:
+          name: Run rspec
+          command: bundle exec rspec --profile 10 --format RspecJunitFormatter --out test_results/rspec.xml --format progress
+
+      - store_test_results:
+          path: test_results
+
+  publish:
+    executor: ruby
+    steps:
+       - checkout
+       - run:
+           name: Setup Rubygems
+           command: |
+             mkdir ~/.gem &&
+             echo -e "---\r\n:rubygems_api_key: $RUBYGEMS_API_KEY" > ~/.gem/credentials &&
+             chmod 0600 ~/.gem/credentials
+       - run:
+           name: Publish to Rubygems
+           command: |
+             gem build loadable_config.gemspec
+             gem push loadable_config-*.gem
+
+
+workflows:
+  version: 2.1
+  build:
+    jobs:
+      - test:
+          name: 'ruby 2.5'
+          ruby-version: "2.5"
+      - test:
+          name: 'ruby 2.6'
+          ruby-version: "2.6"
+      - publish:
+          requires:
+            - 'ruby 2.5'
+            - 'ruby 2.6'
+          filters:
+            branches:
+              only: master
+            tags:
+              ignore: /.*/

data/.gitignore

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

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+dist: trusty
+sudo: false
+language: ruby
+rvm:
+  - 2.5
+notifications:
+  email: false

data/Gemfile

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in loadable_config.gemspec
+gemspec
+gem 'rspec_junit_formatter'

data/LICENSE.txt

@@ -0,0 +1,9 @@
+Copyright (c) 2017, DMM.com. All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,62 @@
+[![Build Status](https://travis-ci.org/iknow/loadable_config.svg?branch=master)](https://travis-ci.org/iknow/loadable_config)
+
+# LoadableConfig
+LoadableConfig is a tool you can use to load and parse configuration
+from YAML. It validates your declaration of the configuration against
+the provided file and gives you a singleton to access configuration.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'loadable_config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install loadable_config
+
+## Usage
+
+Subclass from LoadableConfig:
+
+```ruby
+class MyConfig < LoadableConfig
+  attribute :size, type: :integer
+  attribute :name # implictly a string
+
+  config_file 'config/my_config.yml'
+end
+```
+
+You can then access the configuration through the instance of the class:
+
+`MyConfig.instance.size # => 3`
+
+If you store configuration keyed by environment, or want to set a
+project root for all subclasses, you can set global options:
+
+```ruby
+LoadableConfig.configure! do |config|
+  config.config_path_prefix = Rails.root
+  config.environment_key    = Rails.env
+end
+```
+
+Attributes are validated according to [JSON Schema](http://json-schema.org)
+
+# 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/iknow/loadable_config.
+

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 "loadable_config"
+
+# 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

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/loadable_config.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+require 'loadable_config/version'
+require 'loadable_config/options'
+require 'json_schema'
+require 'yaml'
+require 'singleton'
+
+class LoadableConfig
+  Attribute = Struct.new(:name, :type, :schema, :optional, :serializer)
+
+  class << self
+    attr_reader :_attributes, :_config_file
+
+    def inherited(subclass)
+      subclass.send(:include, Singleton)
+    end
+
+    def config_file(path)
+      @_config_file = path
+    end
+
+    def attribute(attr, type: :string, schema: {}, optional: false, serializer: nil)
+      @_attributes ||= []
+      attr = attr.to_sym
+      if ATTRIBUTE_BLACKLIST.include?(attr)
+        raise ArgumentError.new("Illegal attribute name '#{attr}': "\
+                                'attributes must not collide with class methods of LoadableConfig')
+      end
+
+      type = [type] unless type.kind_of?(Array)
+      type.map! { |t| t.to_s }
+
+      _attributes << Attribute.new(attr.to_s, type, schema, optional, serializer)
+      attr_accessor attr
+      define_singleton_method(attr) { instance.send(attr) }
+    end
+
+    def attributes(*attrs, type: :string, optional: false, serializer: nil)
+      attrs.each do |attr|
+        attribute(attr, type: type, optional: optional, serializer: serializer)
+      end
+    end
+
+    def _configuration
+      @@_configuration
+    end
+
+    def configure!
+      if @@_configuration.frozen?
+        raise ArgumentError.new('Cannot configure LoadableConfig: already configured')
+      end
+      yield(@@_configuration)
+      @@_configuration.freeze
+    end
+
+    private
+
+    def _reinitialize_configuration!
+      @@_configuration = LoadableConfig::Options.new
+    end
+  end
+
+  _reinitialize_configuration!
+
+  ATTRIBUTE_BLACKLIST = Set.new(self.methods - Object.instance_methods)
+
+  def initialize
+    if self.class._config_file.nil? || self.class._config_file.empty?
+      raise RuntimeError.new("Incomplete LoadableConfig '#{self.class.name}': config_file not set")
+    end
+
+    config_file_path = self.class._config_file
+
+    if (prefix = LoadableConfig._configuration.config_path_prefix)
+      config_file_path = File.join(prefix, config_file_path)
+    end
+
+    unless File.exist?(config_file_path)
+      raise RuntimeError.new("Cannot configure #{self.class.name}: "\
+                             "configuration file '#{config_file_path}' missing")
+    end
+
+    config_data = File.read(config_file_path)
+
+    if (preprocessor = LoadableConfig._configuration.preprocessor)
+      config_data = preprocessor.call(config_data)
+    end
+
+    config = YAML.safe_load(config_data, [], [], true)
+    unless config
+      raise RuntimeError.new("Cannot configure #{self.class.name}: "\
+                             "Configuration file empty for #{self.class.name}.")
+    end
+
+    if (env = LoadableConfig._configuration.environment_key)
+      config = config.fetch(env) do
+        raise RuntimeError.new("Cannot configure #{self.class.name}: "\
+                               "Configuration missing for environment '#{env}'")
+      end
+    end
+
+    unless config
+      raise RuntimeError.new("Configuration file missing config for #{self.class.name}.")
+    end
+
+    valid, errors = _schema.validate(config)
+    unless valid
+      raise ArgumentError.new("Errors parsing #{self.class.name}:\n" +
+                              errors.map { |e| "#{e.pointer}: #{e.message}" }.join("\n"))
+    end
+
+    self.class._attributes.each do |attr|
+      value = config[attr.name]
+      if attr.serializer
+        value = attr.serializer.load(value)
+      end
+      self.public_send(:"#{attr.name}=", value)
+    end
+
+    self.freeze
+  end
+
+  private
+
+  def _schema
+    JsonSchema.parse!(
+      'type'                 => 'object',
+      'description'          => "#{self.class.name} Configuration",
+      'properties'           => self.class._attributes.each_with_object({}) do |attr, h|
+                                  h[attr.name] = { 'type' => attr.type }.merge!(attr.schema)
+                                end,
+      'required'             => self.class._attributes.reject(&:optional).map(&:name),
+      'additionalProperties' => false,
+    )
+  end
+end

data/lib/loadable_config/options.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+class LoadableConfig::Options
+  attr_reader :config_path_prefix, :environment_key, :preprocessor
+
+  def initialize
+    # Prefix for configuration file paths. Must be a valid directory, for
+    # example `Rails.root`. If unset, configuration files are resolved relative
+    # to the current working directory.
+    @config_path_prefix = nil
+
+    # If set, assumes that all LoadableConfig configuration files are structured
+    # with top-level keys specifying different environments, each of which is a
+    # hash of the configuration attributes. Setting this specifies which top
+    # level key to select. For example, `Rails.env`.
+    @environment_key     = nil
+
+    # If set, uses the provided block to preprocess the configuration file
+    # before YAML parsing.
+    @preprocessor        = nil
+  end
+
+  def config_path_prefix=(val)
+    unless File.directory?(val)
+      raise ArgumentError.new("Config path prefix '#{val}' is not a valid directory")
+    end
+
+    @config_path_prefix = File.expand_path(val)
+  end
+
+  def environment_key=(val)
+    @environment_key = val.to_s
+  end
+
+  def preprocess(&block)
+    @preprocessor = block
+  end
+end

data/lib/loadable_config/version.rb

@@ -0,0 +1,3 @@
+class LoadableConfig
+  VERSION = '1.0.0'
+end

data/loadable_config.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'loadable_config/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "loadable_config"
+  spec.version       = LoadableConfig::VERSION
+  spec.authors       = ["iKnow Team"]
+  spec.email         = ["dev@iknow.jp"]
+
+  spec.summary       = %q{Simple declarative configuration files}
+  spec.homepage      = "http://github.com/iknow/loadable_config"
+  spec.license       = "BSD-2-Clause"
+
+  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 "json_schema"
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+end

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: loadable_config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- iKnow Team
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-04-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json_schema
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '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: 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'
+description: 
+email:
+- dev@iknow.jp
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/loadable_config.rb
+- lib/loadable_config/options.rb
+- lib/loadable_config/version.rb
+- loadable_config.gemspec
+homepage: http://github.com/iknow/loadable_config
+licenses:
+- BSD-2-Clause
+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: Simple declarative configuration files
+test_files: []