qonfig 0.0.0 → 0.12.0

data/Rakefile

@@ -1,6 +1,20 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
+# frozen_string_literal: true
 
-RSpec::Core::RakeTask.new(:spec)
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'rubocop'
+require 'rubocop-rspec'
+require 'rubocop-performance'
+require 'rubocop/rake_task'
 
-task :default => :spec
+RuboCop::RakeTask.new(:rubocop) do |t|
+  config_path = File.expand_path(File.join('.rubocop.yml'), __dir__)
+
+  t.options = ['--config', config_path]
+  t.requires << 'rubocop-rspec'
+  t.requires << 'rubocop-performance'
+end
+
+RSpec::Core::RakeTask.new(:rspec)
+
+task default: :rspec

data/bin/console

@@ -1,14 +1,8 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
-require "bundler/setup"
-require "qonfig"
+require 'bundler/setup'
+require 'qonfig'
 
-# 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__)
+require 'pry'
+Pry.start

data/bin/rspec

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'pathname'
+require 'optparse'
+
+module QonfigSpecRunner
+  extend self
+
+  expand_gemfile_path = lambda do |gemfile_name|
+    File.expand_path(File.join('..', 'gemfiles', gemfile_name), __dir__)
+  end
+
+  GEMFILES = {
+    with_external_deps: expand_gemfile_path.call('with_external_deps.gemfile'),
+    without_external_deps: expand_gemfile_path.call('without_external_deps.gemfile')
+  }.freeze
+
+  def run!
+    OptionParser.new do |opts|
+      opts.banner = 'Usage: bin/rspec [options]'
+
+      opts.on(
+        '-w', '--with-plugins',
+        'Run tests with test for plugins'
+      ) { run_with_specs_for_plugins! }
+
+      opts.on(
+        '-n', '--without-plugins',
+        'Run tests without tests for plugins'
+      ) { run_without_specs_for_plugins! }
+    end.parse!
+  end
+
+  private
+
+  def run_with_specs_for_plugins!
+    ENV['TEST_PLUGINS'] = 'true'
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:with_external_deps]
+    run_tests!
+  end
+
+  def run_without_specs_for_plugins!
+    ENV['BUNDLE_GEMFILE'] = GEMFILES[:without_external_deps]
+    run_tests!
+  end
+
+  def run_tests!
+    require 'rubygems'
+    require 'bundler/setup'
+    load Gem.bin_path('rspec-core', 'rspec')
+  end
+end
+
+QonfigSpecRunner.run!

data/bin/setup

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+
 set -euo pipefail
 IFS=$'\n\t'
 set -vx

data/gemfiles/with_external_deps.gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# @since 0.12.0 (qonfig: :toml plugin)
+gem 'toml-rb', '>= 1'
+
+gemspec path: '..'

data/gemfiles/without_external_deps.gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec path: '..'

data/lib/qonfig.rb

@@ -1,5 +1,25 @@
-require "qonfig/version"
+# frozen_string_literal: true
+
+require 'yaml'
+require 'json'
+require 'erb'
 
 module Qonfig
-  # Your code goes here...
+  require_relative 'qonfig/errors'
+  require_relative 'qonfig/loaders'
+  require_relative 'qonfig/uploaders'
+  require_relative 'qonfig/commands'
+  require_relative 'qonfig/command_set'
+  require_relative 'qonfig/settings'
+  require_relative 'qonfig/dsl'
+  require_relative 'qonfig/data_set'
+  require_relative 'qonfig/configurable'
+  require_relative 'qonfig/plugins'
+
+  # @api public
+  # @since 0.4.0
+  extend Plugins::AccessMixin
+
+  # @since 0.12.0
+  register_plugin('toml', Qonfig::Plugins::TOML)
 end

data/lib/qonfig/command_set.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class Qonfig::CommandSet
+  # @return [Array<Qonfig::Commands::Base>]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :commands
+
+  # @api private
+  # @since 0.1.0
+  def initialize
+    @commands = []
+    @access_lock = Mutex.new
+  end
+
+  # @param command [Qonfig::Commands::Base]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def add_command(command)
+    thread_safe { commands << command }
+  end
+  alias_method :<<, :add_command
+
+  # @param block [Proc]
+  # @return [Enumerable]
+  #
+  # @api private
+  # @since 0.1.0
+  def each(&block)
+    thread_safe { block_given? ? commands.each(&block) : commands.each }
+  end
+
+  # @param command_set [Qonfig::CommandSet]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def concat(command_set)
+    thread_safe { commands.concat(command_set.commands) }
+  end
+
+  # @return [Qonfig::CommandSet]
+  #
+  # @api private
+  # @since 0.2.0
+  def dup
+    thread_safe do
+      self.class.new.tap { |duplicate| duplicate.concat(self) }
+    end
+  end
+
+  private
+
+  # @param block [Proc]
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.2.0
+  def thread_safe(&block)
+    @access_lock.synchronize(&block)
+  end
+end

data/lib/qonfig/commands.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+module Qonfig::Commands
+  require_relative 'commands/base'
+  require_relative 'commands/add_option'
+  require_relative 'commands/add_nested_option'
+  require_relative 'commands/compose'
+  require_relative 'commands/load_from_yaml'
+  require_relative 'commands/load_from_json'
+  require_relative 'commands/load_from_self'
+  require_relative 'commands/load_from_env'
+  require_relative 'commands/expose_yaml'
+end

data/lib/qonfig/commands/add_nested_option.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::AddNestedOption < Qonfig::Commands::Base
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :key
+
+  # @return [Class<Qonfig::DataSet>]
+  #
+  # @api private
+  # @since 0.2.0
+  attr_reader :nested_data_set_klass
+
+  # @param key [Symbol, String]
+  # @param nested_definitions [Proc]
+  #
+  # @raise [Qonfig::ArgumentError]
+  # @raise [Qonfig::CoreMethodIntersectionError]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(key, nested_definitions)
+    Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
+
+    @key = key
+    @nested_data_set_klass = Class.new(Qonfig::DataSet).tap do |data_set|
+      data_set.instance_eval(&nested_definitions)
+    end
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    nested_settings = nested_data_set_klass.new.settings
+
+    settings.__define_setting__(key, nested_settings)
+  end
+end

data/lib/qonfig/commands/add_option.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::AddOption < Qonfig::Commands::Base
+  # @return [Symbol, String]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :key
+
+  # @return [Object]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :value
+
+  # @param key [Symbol, String]
+  # @param value [Object]
+  #
+  # @raise [Qonfig::ArgumentError]
+  # @raise [Qonfig::CoreMethodIntersectionError]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(key, value)
+    Qonfig::Settings::KeyGuard.prevent_incomparabilities!(key)
+
+    @key = key
+    @value = value
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    settings.__define_setting__(key, value)
+  end
+end

data/lib/qonfig/commands/base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::Base
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings); end
+end

data/lib/qonfig/commands/compose.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.1.0
+class Qonfig::Commands::Compose < Qonfig::Commands::Base
+  # @return [Qonfig::DataSet]
+  #
+  # @api private
+  # @since 0.1.0
+  attr_reader :data_set_klass
+
+  # @param data_set_klass [Qonfig::DataSet]
+  #
+  # @raise [Qonfig::ArgumentError]
+  #
+  # @api private
+  # @since 0.1.0
+  def initialize(data_set_klass)
+    raise(
+      Qonfig::ArgumentError,
+      'Composed config class should be a subtype of Qonfig::DataSet'
+    ) unless data_set_klass.is_a?(Class) && data_set_klass < Qonfig::DataSet
+
+    @data_set_klass = data_set_klass
+  end
+
+  # @param settings [Qonfig::Settings]
+  # @return [void]
+  #
+  # @api private
+  # @since 0.1.0
+  def call(settings)
+    composite_settings = data_set_klass.new.settings
+
+    settings.__append_settings__(composite_settings)
+  end
+end

data/lib/qonfig/commands/expose_yaml.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+# @api private
+# @since 0.7.0
+class Qonfig::Commands::ExposeYAML < Qonfig::Commands::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