confset 1.0.0

data/lib/confset.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+require "confset/options"
+require "confset/configuration"
+require "confset/version"
+require "confset/sources/yaml_source"
+require "confset/sources/hash_source"
+require "confset/sources/env_source"
+require "confset/validation/schema"
+require "deep_merge"
+
+module Confset
+  extend Confset::Validation::Schema
+  extend Confset::Configuration.new(
+    # general options
+    const_name: "Settings",
+    use_env: false,
+    env_prefix: "Settings",
+    env_separator: ".",
+    env_converter: :downcase,
+    env_parse_values: true,
+    fail_on_missing: false,
+    # deep_merge options
+    knockout_prefix: nil,
+    merge_nil_values: true,
+    overwrite_arrays: true,
+    merge_hash_arrays: false,
+    validation_contract: nil,
+    evaluate_erb_in_yaml: true
+  )
+
+  def self.setup
+    yield self unless @_ran_once
+    @_ran_once = true
+  end
+
+  # Create a populated Options instance from a settings file. If a second file is given, then the sections of that
+  # file will overwrite existing sections of the first file.
+  def self.load_files(*sources)
+    config = Options.new
+
+    # add settings sources
+    [sources].flatten.compact.each do |source|
+      config.add_source!(source)
+    end
+
+    config.add_source!(Sources::EnvSource.new(ENV)) if Confset.use_env
+
+    config.load!
+    config
+  end
+
+  # Loads and sets the settings constant!
+  def self.load_and_set_settings(*sources)
+    name = Confset.const_name
+    Object.send(:remove_const, name) if Object.const_defined?(name)
+    Object.const_set(name, Confset.load_files(sources))
+  end
+
+  def self.setting_files(config_root, env)
+    [
+      File.join(config_root, "settings.yml").to_s,
+      File.join(config_root, "settings", "#{env}.yml").to_s,
+      File.join(config_root, "environments", "#{env}.yml").to_s,
+      *local_setting_files(config_root, env)
+    ].freeze
+  end
+
+  def self.local_setting_files(config_root, env)
+    [
+      (File.join(config_root, "settings.local.yml").to_s if env != "test"),
+      File.join(config_root, "settings", "#{env}.local.yml").to_s,
+      File.join(config_root, "environments", "#{env}.local.yml").to_s
+    ].compact
+  end
+
+  def self.reload!
+    until Confset.const_name do
+      const = Object.const_get(Confset.const_name)
+      const.reload!
+    end
+  end
+end
+
+# Rails integration
+require("confset/integrations/rails/railtie") if defined?(::Rails)
+
+# Sinatra integration
+require("confset/integrations/sinatra") if defined?(::Sinatra)

data/lib/generators/confset/install_generator.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Confset
+  module Generators
+    class InstallGenerator < ::Rails::Generators::Base
+      desc "Generates a custom Rails Confset initializer file."
+
+      def self.source_root
+        @_config_source_root ||= File.expand_path("../templates", __FILE__)
+      end
+
+      def copy_initializer
+        template "confset.rb", "config/initializers/confset.rb"
+      end
+
+      def copy_settings
+        template "settings.yml", "config/settings.yml"
+        template "settings.local.yml", "config/settings.local.yml"
+        directory "settings", "config/settings"
+      end
+
+      def modify_gitignore
+        create_file ".gitignore" unless File.exist? ".gitignore"
+
+        append_to_file ".gitignore" do
+          "\n"                                +
+          "config/settings.local.yml\n"       +
+          "config/settings/*.local.yml\n"     +
+          "config/environments/*.local.yml\n"
+        end
+      end
+    end
+  end
+end

data/lib/generators/confset/templates/confset.rb

@@ -0,0 +1,58 @@
+Confset.setup do |config|
+  # Name of the constant exposing loaded settings
+  config.const_name = 'Settings'
+
+  # Ability to remove elements of the array set in earlier loaded settings file. For example value: '--'.
+  #
+  # config.knockout_prefix = nil
+
+  # Overwrite an existing value when merging a `nil` value.
+  # When set to `false`, the existing value is retained after merge.
+  #
+  # config.merge_nil_values = true
+
+  # Overwrite arrays found in previously loaded settings file. When set to `false`, arrays will be merged.
+  #
+  # config.overwrite_arrays = true
+
+  # Load environment variables from the `ENV` object and override any settings defined in files.
+  #
+  # config.use_env = false
+
+  # Define ENV variable prefix deciding which variables to load into config.
+  #
+  # Reading variables from ENV is case-sensitive. If you define lowercase value below, ensure your ENV variables are
+  # prefixed in the same way.
+  #
+  # When not set it defaults to `config.const_name`.
+  #
+  config.env_prefix = 'SETTINGS'
+
+  # What string to use as level separator for settings loaded from ENV variables. Default value of '.' works well
+  # with Heroku, but you might want to change it for example for '__' to easy override settings from command line, where
+  # using dots in variable names might not be allowed (eg. Bash).
+  #
+  # config.env_separator = '.'
+
+  # Ability to process variables names:
+  #   * nil  - no change
+  #   * :downcase - convert to lower case
+  #
+  # config.env_converter = :downcase
+
+  # Parse numeric values as integers instead of strings.
+  #
+  # config.env_parse_values = true
+
+  # Validate presence and type of specific config values. Check https://github.com/dry-rb/dry-validation for details.
+  #
+  # config.schema do
+  #   required(:name).filled
+  #   required(:age).maybe(:int?)
+  #   required(:email).filled(format?: EMAIL_REGEX)
+  # end
+
+  # Evaluate ERB in YAML config files at load time.
+  #
+  # config.evaluate_erb_in_yaml = true
+end

data/spec/config_env_spec.rb

@@ -0,0 +1,238 @@
+# frozen_string_literal: true
+
+require "spec_helper"
+
+describe Confset::Options do
+  before :each do
+    Confset.reset
+  end
+
+  context "when overriding settings via ENV variables is enabled" do
+    let(:config) do
+      Confset.load_files "spec/fixtures/settings.yml", "spec/fixtures/multilevel.yml"
+    end
+
+    after :all do
+      Confset.use_env = false
+    end
+
+    before :each do
+      ENV.clear
+
+      Confset.use_env              = true
+      Confset.env_prefix           = nil
+      Confset.env_separator        = "."
+      Confset.env_converter        = :downcase
+      Confset.env_parse_values     = true
+    end
+
+    it "should add new setting from ENV variable" do
+      ENV["Settings.new_var"] = "value"
+
+      expect(config.new_var).to eq("value")
+    end
+
+    context "should override existing setting with a value from ENV variable" do
+      it "for a basic values" do
+        ENV["Settings.size"] = "overwritten by env"
+
+        expect(config.size).to eq("overwritten by env")
+      end
+
+      it "for multilevel sections" do
+        ENV["Settings.number_of_all_countries"] = "0"
+        ENV["Settings.world.countries.europe"]  = "0"
+
+        expect(config.number_of_all_countries).to eq(0)
+        expect(config.world.countries.europe).to eq(0)
+        expect(config.world.countries.australia).to eq(1)
+      end
+    end
+
+    context "and parsing ENV variable values" do
+      context "is enabled" do
+        it 'should recognize "false" and expose as Boolean' do
+          ENV["Settings.new_var"] = "false"
+
+          expect(config.new_var).to eq(false)
+          expect(config.new_var.is_a? FalseClass).to eq(true)
+        end
+
+        it 'should recognize "true" and expose as Boolean' do
+          ENV["Settings.new_var"] = "true"
+
+          expect(config.new_var).to eq(true)
+          expect(config.new_var.is_a? TrueClass).to eq(true)
+        end
+
+        it "should recognize numbers and expose them as integers" do
+          ENV["Settings.new_var"] = "123"
+
+          expect(config.new_var).to eq(123)
+          expect(config.new_var.is_a? Integer).to eq(true)
+        end
+
+        it "should recognize fixed point numbers and expose them as float" do
+          ENV["Settings.new_var"] = "1.9"
+
+          expect(config.new_var).to eq(1.9)
+          expect(config.new_var.is_a? Float).to eq(true)
+        end
+
+        it "should leave strings intact" do
+          ENV["Settings.new_var"] = "foobar"
+
+          expect(config.new_var).to eq("foobar")
+          expect(config.new_var.is_a? String).to eq(true)
+        end
+      end
+
+      context "is disabled" do
+        it "should not convert numbers to integers" do
+          ENV["Settings.new_var"] = "123"
+
+          Confset.env_parse_values = false
+
+          expect(config.new_var).to eq("123")
+        end
+      end
+    end
+
+    context "and custom ENV variables prefix is defined" do
+      before :each do
+        Confset.env_prefix = "MyConfig"
+      end
+
+      it "should load variables from the new prefix" do
+        ENV["MyConfig.new_var"] = "value"
+
+        expect(config.new_var).to eq("value")
+      end
+
+      it "should not load variables from the default prefix" do
+        ENV["Settings.new_var"] = "value"
+
+        expect(config.new_var).to eq(nil)
+      end
+
+      it "should skip ENV variable when partial prefix match" do
+        ENV["MyConfigs.new_var"] = "value"
+
+        expect(config.new_var).to eq(nil)
+      end
+    end
+
+    context "and custom ENV variables separator is defined" do
+      before :each do
+        Confset.env_separator = "__"
+      end
+
+      it "should load variables and correctly recognize the new separator" do
+        ENV["Settings__new_var"]                  = "value"
+        ENV["Settings__var.with.dot"]             = "value"
+        ENV["Settings__world__countries__europe"] = "0"
+
+        expect(config.new_var).to eq("value")
+        expect(config["var.with.dot"]).to eq("value")
+        expect(config.world.countries.europe).to eq(0)
+      end
+
+      it "should ignore variables wit default separator" do
+        ENV["Settings.new_var"] = "value"
+
+        expect(config.new_var).to eq(nil)
+      end
+    end
+
+    context "and custom ENV variables prefix includes custom ENV variables separator" do
+      before :each do
+        Confset.env_prefix = "MY_CONFIG"
+        Confset.env_separator = "_"
+      end
+
+      it "should load environment variables which begin with the custom prefix" do
+        ENV["MY_CONFIG_KEY"] = "value"
+
+        expect(config.key).to eq("value")
+      end
+
+      it "should not load environment variables which begin with the default prefix" do
+        ENV["Settings_key"] = "value"
+
+        expect(config.key).to eq(nil)
+      end
+
+      it "should not load environment variables which partially begin with the custom prefix" do
+        ENV["MY_CONFIGS_KEY"] = "value"
+
+        expect(config.key).to eq(nil)
+      end
+
+      it "should recognize the custom separator" do
+        ENV["MY_CONFIG_KEY.WITH.DOT"]           = "value"
+        ENV["MY_CONFIG_WORLD_COUNTRIES_EUROPE"] = "0"
+
+        expect(config["key.with.dot"]).to eq("value")
+        expect(config.world.countries.europe).to eq(0)
+      end
+
+      it "should not recognize the default separator" do
+        ENV["MY_CONFIG.KEY"] = "value"
+
+        expect(config.key).to eq(nil)
+      end
+    end
+
+    context "and variable names conversion" do
+      context "is enabled" do
+        it "should downcase variable names when :downcase conversion enabled" do
+          ENV["Settings.NEW_VAR"] = "value"
+
+          Confset.env_converter = :downcase
+
+          expect(config.new_var).to eq("value")
+        end
+      end
+
+      context "is disabled" do
+        it "should not change variable names by default" do
+          ENV["Settings.NEW_VAR"] = "value"
+
+          Confset.env_converter = nil
+
+          expect(config.new_var).to eq(nil)
+          expect(config.NEW_VAR).to eq("value")
+        end
+      end
+    end
+
+    it "should always load ENV variables when reloading settings from files" do
+      ENV["Settings.new_var"] = "value"
+
+      expect(config.new_var).to eq("value")
+
+      Confset.reload!
+
+      expect(config.new_var).to eq("value")
+    end
+
+    context "and env variable names conflict with new namespaces" do
+      it "should throw a descriptive error message" do
+        ENV["Settings.backend_database"] = "development"
+        ENV["Settings.backend_database.user"] = "postgres"
+
+        expected_message = "Environment variable Settings.backend_database.user "\
+          "conflicts with variable Settings.backend_database"
+        expect { config }.to raise_error(RuntimeError, expected_message)
+      end
+    end
+
+    context "and env variable names conflict with existing namespaces" do
+      it "should allow overriding the namespace" do
+        ENV["Settings.databases"] = "new databases"
+
+        expect(config.databases).to eq("new databases")
+      end
+    end
+  end
+end