qonfig 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 05d98b03ee4891914d9701ee98e6965d523f0b75b84d8c5d8aafc6e0d1efdcf0
-  data.tar.gz: 493e96ebeb18d92870a538d21b68f6b79905f719433e8ba201345e60f4d6317f
+  metadata.gz: 508503230a1e21322689d23c7e0bd68c1f3bd3e268719f3b7adcdb1e5595926e
+  data.tar.gz: efc18abe1dce63006df0de913a1b1969d1fc36b4e80353985a3126f6b86a9c16
 SHA512:
-  metadata.gz: 013cf27437a8434c3b9ba5750ca0a9483479e224bc35244cf8d76d53e712e47c120a22e14e44ed15b0092f1d89a5e41c9d26aee47e16d2edc32ce3f1543a26da
-  data.tar.gz: fa6498dd72113cde54b22659dfad3d8ae5a092a34d4f1b9efb4d004a5f89c2d1470abe5eef81fd5bd86e9d0a8fde5036670ea41ce76b468e6fa5090c5f787565
+  metadata.gz: 5f507d2ef122bdd22258972c6630fd1e8f384d39476e3eb751a2131a505e8fedaae44140deaedac26bbba735854482207da89f80bc862bab4f10b739f547ade3
+  data.tar.gz: 7160203dbfd9613b78032307dcd3f1f5bcbb00d0751a0bfbea3621b8fd9e1b645aa6e3783ba790918bba49f9151426b6e17fbdc252ce5da191e7232d2d7ed193

data/.travis.yml

@@ -2,9 +2,9 @@ language: ruby
 matrix:
   fast_finish: true
   include:
-  - rvm: 2.3.7
-  - rvm: 2.4.4
-  - rvm: 2.5.1
+  - rvm: 2.3.8
+  - rvm: 2.4.5
+  - rvm: 2.5.3
   - rvm: ruby-head
   - rvm: jruby-head
   allow_failures:

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 # Changelog
 All notable changes to this project will be documented in this file.
 
+## [0.7.0] - 2018-10-20
+### Added
+- `expose_yaml` - a command that provides an ability to define config settings
+  by loading them from a yaml file where the concrete settings depends on the chosen environment;
+
 ## [0.6.0] - 2018-08-22
 ### Added
 - `#shared_config` - instance method that provides an access to the class level config

data/README.md

@@ -31,6 +31,7 @@ require 'qonfig'
 - [State freeze](#state-freeze)
 - [Settings as Predicates](#settings-as-predicates)
 - [Load from YAML file](#load-from-yaml-file)
+- [Expose YAML](#expose-yaml) (`Rails`-like environment-based YAML configs)
 - [Load from JSON file](#load-from-json-file)
 - [Load from ENV](#load-from-env)
 - [Load from \_\_END\_\_](#load-from-__end__) (aka `load_from_self`)
@@ -407,12 +408,14 @@ config.settings.database.engine.driver? # => true (true => true)
 
 ### Load from YAML file
 
+- supports `ERB`;
 - `:strict` mode (fail behaviour when the required yaml file doesnt exist):
   - `true` (by default) - causes `Qonfig::FileNotFoundError`;
   - `false` - do nothing, ignore current command;
 
 ```yaml
-<!-- travis.yml -->
+# travis.yml
+
 sudo: false
 language: ruby
 rvm:
@@ -421,14 +424,16 @@ rvm:
 ```
 
 ```yaml
-<!-- project.yml -->
+# project.yml
+
 enable_api: false
 Sidekiq/Scheduler:
   enable: true
 ```
 
 ```yaml
-<!-- ruby_data.yml -->
+# ruby_data.yml
+
 version: <%= RUBY_VERSION %>
 platform: <%= RUBY_PLATFORM %>
 ```
@@ -483,6 +488,110 @@ Config.new.to_h # => { "nonexistent_yaml" => {}, "another_key" => nil }
 
 ---
 
+### Expose YAML
+
+- load configurations from YAML file in Rails-like manner (with environments);
+- works in `load_from_yaml` manner;
+- `via:` - how an environment will be determined:
+    - `:file_name`
+        - load configuration from YAML file that have an `:env` part in it's name;
+    - `:env_key`
+        - load configuration from YAML file;
+        - concrete configuration should be defined in the root key with `:env` name;
+- `env:` - your environment name (must be a type of `String`, `Symbol` or `Numeric`);
+- `strict:` - requires the existence of the file and/or key with the name of the used environment:
+    - `true`:
+        - file should exist;
+        - root key with `:env` name should exist (if `via: :env_key` is used);
+        - raises `Qonfig::ExposeError` if file does not contain the required env key (if `via: :env` key is used);
+        - raises `Qonfig::FileNotFoundError` if the required file does not exist;
+    - `false`:
+        - file is not required;
+        - root key with `:env` name is not required (if `via: :env_key` is used);
+
+#### Environment is defined as a root key of YAML file
+
+```yaml
+# config/project.yml
+
+default: &default
+  enable_api_mode: true
+  google_key: 12345
+  window:
+    width: 100
+    height: 100
+
+development:
+  <<: *default
+
+test:
+  <<: *default
+  sidekiq_instrumentation: false
+
+staging:
+  <<: *default
+  google_key: 777
+  enable_api_mode: false
+
+production:
+  google_key: asd1-39sd-55aI-O92x
+  enable_api_mode: true
+  window:
+    width: 50
+    height: 150
+```
+
+```ruby
+class Config < Qonfig::DataSet
+  expose_yaml 'config/project.yml', via: :env_key, env: :production # load from production env
+
+  # NOTE: in rails-like application you can use this:
+  expose_yaml 'config/project.yml', via: :env_key, env: Rails.env
+end
+
+config = Config.new
+
+config.settings.enable_api_mode # => true (from :production subset of keys)
+config.settings.google_key # => asd1-39sd-55aI-O92x (from :production subset of keys)
+config.settings.window.width # => 50 (from :production subset of keys)
+config.settings.window.height # => 150 (from :production subset of keys)
+```
+
+#### Environment is defined as a part of YAML file name
+
+```yaml
+# config/sidekiq.staging.yml
+
+web:
+  username: staging_admin
+  password: staging_password
+```
+
+```yaml
+# config/sidekiq.production.yml
+
+web:
+  username: urj1o2
+  password: u192jd0ixz0
+```
+
+```ruby
+class SidekiqConfig < Qonfig::DataSet
+  # NOTE: file name should be described WITHOUT environment part (in file name attribute)
+  expose_yaml 'config/sidekiq.yml', via: :file_name, env: :staging # load from staging env
+
+  # NOTE: in rails-like application you can use this:
+  expose_yaml 'config/sidekiq.yml', via: :file_name, env: Rails.env
+end
+
+config = SidekiqConfig.new
+
+config.settings.web.username # => staging_admin (from sidekiq.staging.yml)
+config.settings.web.password # => staging_password (from sidekiq.staging.yml)
+```
+
+---
+
 ### Load from JSON file
 
 - `:strict` mode (fail behaviour when the required yaml file doesnt exist):
@@ -490,7 +599,8 @@ Config.new.to_h # => { "nonexistent_yaml" => {}, "another_key" => nil }
   - `false` - do nothing, ignore current command;
 
 ```json
-<!-- options.json -->
+// options.json
+
 {
   "user": "0exp",
   "password": 12345,

data/Rakefile

@@ -2,7 +2,17 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop'
+require 'rubocop-rspec'
+require 'rubocop/rake_task'
 
-RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop) do |t|
+  config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
 
-task default: :spec
+  t.options = ['--config', config_path]
+  t.requires << 'rubocop-rspec'
+end
+
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: :rspec

data/lib/qonfig.rb

@@ -18,6 +18,7 @@ module Qonfig
   require_relative 'qonfig/commands/load_from_self'
   require_relative 'qonfig/commands/load_from_env'
   require_relative 'qonfig/commands/load_from_env/value_converter'
+  require_relative 'qonfig/commands/expose_yaml'
   require_relative 'qonfig/command_set'
   require_relative 'qonfig/settings'
   require_relative 'qonfig/settings/lock'

data/lib/qonfig/commands/expose_yaml.rb

@@ -0,0 +1,163 @@
+# frozen_string_literal: true
+
+module Qonfig
+  module Commands
+    # @api private
+    # @since 0.7.0
+    class ExposeYAML < Base
+      # @return [Hash]
+      #
+      # @api private
+      # @since 0.7.0
+      EXPOSERS = { file_name: :file_name, env_key: :env_key }.freeze
+
+      # @return [Hash]
+      #
+      # @api private
+      # @since 0.7.0
+      EMPTY_YAML_DATA = {}.freeze
+
+      # @return [String]
+      #
+      # @api private
+      # @since 0.7.0
+      attr_reader :file_path
+
+      # @return [Boolean]
+      #
+      # @api private
+      # @since 0.7.0
+      attr_reader :strict
+
+      # @return [Symbol]
+      #
+      # @api private
+      # @since 0.7.0
+      attr_reader :via
+
+      # @return [Symbol, String]
+      #
+      # @api private
+      # @since 0.7.0
+      attr_reader :env
+
+      # @param file_path [String]
+      # @option strict [Boolean]
+      # @option via [Symbol]
+      # @option env [String, Symbol]
+      #
+      # @api private
+      # @since 0.7.0
+      def initialize(file_path, strict: true, via:, env:)
+        unless env.is_a?(Symbol) || env.is_a?(String) || env.is_a?(Numeric)
+          raise Qonfig::ArgumentError, ':env should be a string or a symbol'
+        end
+
+        raise Qonfig::ArgumentError, ':env should be provided'  if env.to_s.empty?
+        raise Qonfig::ArgumentError, 'used :via is unsupported' unless EXPOSERS.key?(via)
+
+        @file_path = file_path
+        @strict    = strict
+        @via       = via
+        @env       = env
+      end
+
+      # @param settings [Qonfig::Settings]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.7.0
+      def call(settings)
+        case via
+        when EXPOSERS[:file_name]
+          expose_file_name!(settings)
+        when EXPOSERS[:env_key]
+          expose_env_key!(settings)
+        end
+      end
+
+      private
+
+      # @param settings [Qonfig::Settings]
+      # @return [void]
+      #
+      # @api private
+      # @since 0.7.0
+      # rubocop:disable Metrics/AbcSize
+      def expose_file_name!(settings)
+        # NOTE: transform file name (insert environment name into the file name)
+        #   from: path/to/file/file_name.file_extension
+        #   to:   path/to/file/file_name.env_name.file_extension
+
+        pathname = Pathname.new(file_path)
+        dirname  = pathname.dirname
+        extname  = pathname.extname.to_s
+        basename = pathname.basename.to_s.sub!(extname, '')
+        envname  = [env.to_s, extname].reject(&:empty?).join('')
+        envfile  = [basename, envname].reject(&:empty?).join('.')
+        realfile = dirname.join(envfile).to_s
+
+        yaml_data = load_yaml_data(realfile)
+        yaml_based_settings = build_data_set_class(yaml_data).new.settings
+
+        settings.__append_settings__(yaml_based_settings)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # @param settings [Qonfig::Settings]
+      # @return [void]
+      #
+      # @raise [Qonfig::ExposeError]
+      # @raise [Qonfig::IncompatibleYAMLStructureError]
+      #
+      # @api private
+      # @since 0.7.0
+      # rubocop:disable Metrics/AbcSize
+      def expose_env_key!(settings)
+        yaml_data       = load_yaml_data(file_path)
+        yaml_data_slice = yaml_data[env] || yaml_data[env.to_s] || yaml_data[env.to_sym]
+        yaml_data_slice = EMPTY_YAML_DATA.dup if yaml_data_slice.nil? && !strict
+
+        raise(
+          Qonfig::ExposeError,
+          "#{file_path} file does not contain settings with <#{env}> environment key!"
+        ) unless yaml_data_slice
+
+        raise(
+          Qonfig::IncompatibleYAMLStructureError,
+          'YAML content should have a hash-like structure'
+        ) unless yaml_data_slice.is_a?(Hash)
+
+        yaml_based_settings = build_data_set_class(yaml_data_slice).new.settings
+
+        settings.__append_settings__(yaml_based_settings)
+      end
+      # rubocop:enable Metrics/AbcSize
+
+      # @param file_path [String]
+      # @return [Hash]
+      #
+      # @raise [Qonfig::IncompatibleYAMLStructureError]
+      #
+      # @api private
+      # @since 0.7.0
+      def load_yaml_data(file_path)
+        Qonfig::Loaders::YAML.load_file(file_path, fail_on_unexist: strict).tap do |yaml_data|
+          raise(
+            Qonfig::IncompatibleYAMLStructureError,
+            'YAML content should have a hash-like structure'
+          ) unless yaml_data.is_a?(Hash)
+        end
+      end
+
+      # @param yaml_data [Hash]
+      # @return [Class<Qonfig::DataSet>]
+      #
+      # @api private
+      # @since 0.7.0
+      def build_data_set_class(yaml_data)
+        Qonfig::DataSet::ClassBuilder.build_from_hash(yaml_data)
+      end
+    end
+  end
+end

data/lib/qonfig/dsl.rb

@@ -108,5 +108,17 @@ module Qonfig
     def load_from_json(file_path, strict: true)
       commands << Qonfig::Commands::LoadFromJSON.new(file_path, strict: strict)
     end
+
+    # @param file_path [String]
+    # @option strict [Boolean]
+    # @option via [Symbol]
+    # @option env [Symbol, String]
+    # @return [void]
+    #
+    # @api public
+    # @since 0.7.0
+    def expose_yaml(file_path, strict: true, via:, env:)
+      commands << Qonfig::Commands::ExposeYAML.new(file_path, strict: strict, via: via, env: env)
+    end
   end
 end

data/lib/qonfig/error.rb

@@ -80,4 +80,10 @@ module Qonfig
   # @api public
   # @since 0.4.0
   UnregisteredPluginError = Class.new(Error)
+
+  # @see Qonfig::Commands::ExposeYAML
+  #
+  # @api public
+  # @since 0.7.0
+  ExposeError = Class.new(Error)
 end

data/lib/qonfig/version.rb

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Qonfig
+  # @return [String]
+  #
   # @api public
   # @since 0.1.0
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

data/qonfig.gemspec

@@ -29,10 +29,9 @@ Gem::Specification.new do |spec|
   end
 
   spec.add_development_dependency 'coveralls',        '~> 0.8'
-  spec.add_development_dependency 'simplecov',        '~> 0.14'
-  spec.add_development_dependency 'simplecov-json',   '~> 0.2'
+  spec.add_development_dependency 'simplecov',        '~> 0.16'
   spec.add_development_dependency 'rspec',            '~> 3.8'
-  spec.add_development_dependency 'armitage-rubocop', '~> 0.6'
+  spec.add_development_dependency 'armitage-rubocop', '~> 0.10'
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'rake'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qonfig
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Rustam Ibragimov
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-22 00:00:00.000000000 Z
+date: 2018-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -30,28 +30,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
+        version: '0.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.14'
-- !ruby/object:Gem::Dependency
-  name: simplecov-json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.2'
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -72,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -150,6 +136,7 @@ files:
 - lib/qonfig/commands/add_option.rb
 - lib/qonfig/commands/base.rb
 - lib/qonfig/commands/compose.rb
+- lib/qonfig/commands/expose_yaml.rb
 - lib/qonfig/commands/load_from_env.rb
 - lib/qonfig/commands/load_from_env/value_converter.rb
 - lib/qonfig/commands/load_from_json.rb