cconfig 1.0.0

data/lib/cconfig.rb

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+# CConfig contains all the classes and modules that implement this library.
+module CConfig
+end
+
+require "cconfig/cconfig"
+require "cconfig/railtie" if defined?(Rails)

data/lib/cconfig/cconfig.rb

@@ -0,0 +1,73 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cconfig/hash_utils"
+require "cconfig/errors"
+require "yaml"
+
+module CConfig
+  # Config is the main class of this library. It allows you to fetch the current
+  # configuration (after merging the values from all sources) as a hash. This
+  # has will have the special method `::CConfig::HashUtils::Extensions#enabled?`.
+  class Config
+    include ::CConfig::HashUtils
+
+    # Instantiate an object with `default` as the path to the default
+    # configuration, `local` as the alternate file, and `prefix` as the prefix
+    # for environment variables.
+    #
+    # Note: the `local` value will be discarded in favor of the
+    # `#{prefix}_LOCAL_CONFIG_PATH` environment variable if it was set.
+    def initialize(default:, local:, prefix:)
+      @default = default
+      @local   = ENV["#{prefix.upcase}_LOCAL_CONFIG_PATH"] || local
+      @prefix  = prefix
+    end
+
+    # Returns a hash with the app configuration contained in it.
+    def fetch
+      cfg   = {}
+      cfg   = YAML.load_file(@default) if File.file?(@default)
+      local = fetch_local
+
+      hsh = strict_merge_with_env(default: cfg, local: local, prefix: @prefix)
+      hsh.extend(::CConfig::HashUtils::Extensions)
+    end
+
+    # Returns a string representation of the evaluated configuration.
+    def to_s
+      hide_password(fetch.dup).to_yaml
+    end
+
+    protected
+
+    # Returns a hash with the alternate values that have to override the default
+    # ones.
+    def fetch_local
+      if File.file?(@local)
+        # Check for bad user input in the local config.yml file.
+        local = YAML.load_file(@local)
+        raise FormatError unless local.is_a?(::Hash)
+        local
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/cconfig/errors.rb

@@ -0,0 +1,30 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+module CConfig
+  # FormatError is the exception to be raised when a configuration file cannot
+  # be parsed.
+  class FormatError < StandardError
+    DEFAULT_MSG = "Wrong format for the config-local file!".freeze
+
+    def initialize
+      super(DEFAULT_MSG)
+    end
+  end
+end

data/lib/cconfig/hash_utils.rb

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+module CConfig
+  # HashUtils provides a handful of methods that help with the manipulation of
+  # hashes in the gem.
+  module HashUtils
+    # Extensions contains the methods to be provided for each hash object
+    # produced by this gem.
+    module Extensions
+      # Returns true if the given feature is enabled, false otherwise. This also
+      # works in embedded configuration values. For example: enabled?("a.b")
+      # will return true for:
+      #   a:
+      #     b:
+      #       enabled: true
+      def enabled?(feature)
+        objs = feature.split(".")
+        if objs.length == 2
+          return false if !self[objs[0]][objs[1]] || self[objs[0]][objs[1]].empty?
+          self[objs[0]][objs[1]]["enabled"].eql?(true)
+        else
+          return false if !self[feature] || self[feature].empty?
+          self[feature]["enabled"].eql?(true)
+        end
+      end
+    end
+
+    protected
+
+    # Applies a deep merge while respecting the values from environment
+    # variables. A deep merge consists of a merge of all the nested elements of
+    # the two given hashes `config` and `local`. The `config` hash is supposed
+    # to contain all the accepted keys, and the `local` hash is a subset of it.
+    #
+    # Moreover, let's say that we have the following hash: { "ldap" => {
+    # "enabled" => true } }. An environment variable that can modify the value
+    # of the previous hash has to be named `#{prefix}_LDAP_ENABLED`. The `prefix`
+    # argument specifies how all the environment variables have to start.
+    #
+    # Returns the merged hash, where the precedence of the merge is as follows:
+    #   1. The value of the related environment variable if set.
+    #   2. The value from the `local` hash.
+    #   3. The value from the `config` hash.
+    def strict_merge_with_env(default:, local:, prefix:)
+      hsh = {}
+
+      default.each do |k, v|
+        # The corresponding environment variable. If it's not the final value,
+        # then this just contains the partial prefix of the env. variable.
+        env = "#{prefix}_#{k}"
+
+        # If the current value is a hash, then go deeper to perform a deep
+        # merge, otherwise we merge the final value by respecting the order as
+        # specified in the documentation.
+        if v.is_a?(Hash)
+          l = local[k] || {}
+          hsh[k] = strict_merge_with_env(default: default[k], local: l, prefix: env)
+        else
+          hsh[k] = first_non_nil(get_env(env), local[k], v)
+        end
+      end
+      hsh
+    end
+
+    # Hide any sensitive value, replacing it with "*" characters.
+    def hide_password(hsh)
+      hsh.each do |k, v|
+        if v.is_a?(Hash)
+          hsh[k] = hide_password(v)
+        elsif k == "password"
+          hsh[k] = "****"
+        end
+      end
+      hsh
+    end
+
+    private
+
+    # Get the typed value of the specified environment variable. If it doesn't
+    # exist, it will return nil. Otherwise, it will try to cast the fetched
+    # value into the proper type and return it.
+    def get_env(key)
+      env = ENV[key.upcase]
+      return nil if env.nil?
+
+      # Try to convert it into a boolean value.
+      return true if env.casecmp("true").zero?
+      return false if env.casecmp("false").zero?
+
+      # Try to convert it into an integer. Otherwise just keep the string.
+      begin
+        Integer(env)
+      rescue ArgumentError
+        env
+      end
+    end
+
+    # Returns the first value that is not nil from the given argument list.
+    def first_non_nil(*values)
+      values.each { |v| return v unless v.nil? }
+    end
+  end
+end

data/lib/cconfig/railtie.rb

@@ -0,0 +1,47 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+require "rails"
+
+module CConfig
+  # This class will set up this gem for Ruby on Rails:
+  #   - On initialization this Railtie will set the `APP_CONFIG` global
+  #     constant with the resulting merged values of the configuration.
+  #   - The `cconfig:info` rake task will be loaded.
+  class Railtie < Rails::Railtie
+    railtie_name :cconfig
+
+    initializer "cconfig" do |app|
+      prefix     = ENV["CCONFIG_PREFIX"] || app.class.parent_name.inspect
+      default    = File.join(Rails.root, "config", "config.yml")
+      local      = File.join(Rails.root, "config", "config-local.yml")
+      cfg        = ::CConfig::Config.new(default: default, local: local, prefix: prefix)
+
+      # NOTE: this is a global constant from now on. The Rails application
+      # expects this exact constant to be set by this Railtie.
+      ::APP_CONFIG = cfg.fetch
+    end
+
+    rake_tasks do
+      Dir[File.join(File.dirname(__FILE__), "../tasks/*.rake")].each do |task|
+        load task
+      end
+    end
+  end
+end

data/lib/cconfig/version.rb

@@ -0,0 +1,23 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+module CConfig
+  # The current version of CConfig.
+  VERSION = "1.0.0".freeze
+end

data/lib/tasks/info.rake

@@ -0,0 +1,32 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+namespace :cconfig do
+  desc "Prints the evaluated configuration"
+  task :info, [:prefix] => :environment do |_, args|
+    prefix  = args[:prefix]
+    default = File.join(Rails.root, "config", "config.yml")
+    local   = File.join(Rails.root, "config", "config-local.yml")
+
+    # Note that local will change if "#{prefix.upcase}_LOCAL_CONFIG_PATH" was
+    # specified.
+    cfg = ::CConfig::Config.new(default: default, local: local, prefix: prefix)
+    puts "Evaluated configuration:\n#{cfg}"
+  end
+end

data/spec/config_spec.rb

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+# Copyright (C) 2017 Miquel Sabaté Solà <msabate@suse.com>
+#
+# This file is part of CConfig.
+#
+# CConfig is free software: you can redistribute it and/or modify
+# it under the terms of the GNU Lesser General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# CConfig is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public License
+# along with CConfig.  If not, see <http://www.gnu.org/licenses/>.
+
+require "cconfig/cconfig"
+
+# Returns a Config configured with the two given config files.
+def get_config(default, local)
+  base    = File.join(File.dirname(__FILE__), "fixtures")
+  default = File.join(base, default)
+  local   = File.join(base, local)
+  ::CConfig::Config.new(default: default, local: local, prefix: "test")
+end
+
+describe CConfig::Config do
+  after do
+    ["TEST_LOCAL_CONFIG_PATH"].each { |key| ENV[key] = nil }
+  end
+
+  it "returns an empty config if neither the global nor the local were found" do
+    cfg = get_config("", "").fetch
+    expect(cfg).to be_empty
+  end
+
+  it "only uses the global if the local config was not found" do
+    cfg = get_config("config.yml", "").fetch
+    expect(cfg["gravatar"]["enabled"]).to be_truthy
+  end
+
+  it "merges both config files and work as expected" do
+    cfg = get_config("config.yml", "local.yml").fetch
+
+    expect(cfg.enabled?("gravatar")).to be_truthy
+    expect(cfg.enabled?("ldap")).to be_truthy
+    expect(cfg["ldap"]["hostname"]).to eq "ldap.example.com"
+    expect(cfg["ldap"]["port"]).to eq 389
+    expect(cfg["ldap"]["base"]).to eq "ou=users,dc=example,dc=com"
+    expect(cfg["unknown"]).to be nil
+  end
+
+  it "raises an error when the local file is badly formatted" do
+    bad = get_config("config.yml", "bad.yml")
+    msg =  "Wrong format for the config-local file!"
+    expect { bad.fetch }.to raise_error(::CConfig::FormatError, msg)
+  end
+
+  it "returns the proper config while hiding passwords" do
+    cfg     = get_config("config.yml", "local.yml")
+    fetched = cfg.fetch
+    evaled  = YAML.safe_load(cfg.to_s)
+
+    expect(fetched).not_to eq(evaled)
+    fetched["ldap"]["authentication"]["password"] = "****"
+    expect(fetched).to eq(evaled)
+  end
+
+  it "works for nested options" do
+    cfg = get_config("config.yml", "").fetch
+    expect(cfg.enabled?("email.smtp")).to be true
+  end
+
+  it "selects the proper local file depending of the environment variable" do
+    # Instead of bad.yml (which will raise an error on `fetch`), we will pick up
+    # the local.yml file.
+    base  = File.join(File.dirname(__FILE__), "fixtures")
+    local = File.join(base, "bad.yml")
+    ENV["TEST_LOCAL_CONFIG_PATH"] = File.join(base, "local.yml")
+
+    cfg = ::CConfig::Config.new(default: "config.yml", local: local, prefix: "test")
+    expect { cfg.fetch }.not_to raise_error
+  end
+end

data/spec/fixtures/bad.yml

@@ -0,0 +1 @@
+- ""