blueprint_config 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: be61b7fe3cee8680edfeddde8bbd290aa4463fd68ea2b2582651f740afe4685b
+  data.tar.gz: 9e6f745b5acc18080066a2ffb482eee0d69f704010ef923b8cab0f960c10ba48
+SHA512:
+  metadata.gz: e2849e6eb9237668d42fa9d7c10fe3075798e2cbc296a4a21d76429dcd921252d012a0c96672b69debc18f919d650dc8a2f1897f3401b664c6b6b688326c6719
+  data.tar.gz: c76bd8289d7075f53358f9d7035b9d8e3479c4dc081c40c2c826e1cb3f561803bbe2380f66b741b6dea13636b2337c7cef4587dd29d241cb59a04790f236c97e

data/.gitignore

@@ -0,0 +1,19 @@
+.idea
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+bundler_stubs

data/.idea/.gitignore

@@ -0,0 +1,8 @@
+# Default ignored files
+/shelf/
+/workspace.xml
+# Editor-based HTTP Client requests
+/httpRequests/
+# Datasource local storage ignored files
+/dataSources/
+/dataSources.local.xml

data/.idea/blue_config.iml

@@ -0,0 +1,72 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<module type="RUBY_MODULE" version="4">
+  <component name="ModuleRunConfigurationManager">
+    <shared />
+  </component>
+  <component name="NewModuleRootManager">
+    <content url="file://$MODULE_DIR$">
+      <sourceFolder url="file://$MODULE_DIR$/features" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/spec" isTestSource="true" />
+      <sourceFolder url="file://$MODULE_DIR$/test" isTestSource="true" />
+    </content>
+    <orderEntry type="inheritedJdk" />
+    <orderEntry type="sourceFolder" forTests="false" />
+    <orderEntry type="library" scope="PROVIDED" name="activemodel (v7.1.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activerecord (v7.1.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="activesupport (v7.1.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="base64 (v0.2.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bigdecimal (v3.1.5, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="bundler (v2.4.22, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="concurrent-ruby (v1.2.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="connection_pool (v2.4.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="diff-lcs (v1.5.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="drb (v2.2.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="i18n (v1.14.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="minitest (v5.20.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="mutex_m (v0.2.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rake (v13.1.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="redis (v5.0.8, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="redis-client (v0.19.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec (v3.12.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-core (v3.12.2, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-expectations (v3.12.3, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-mocks (v3.12.6, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="rspec-support (v3.12.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="sqlite3 (v1.7.0, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="timeout (v0.4.1, rbenv: 3.2.2) [gem]" level="application" />
+    <orderEntry type="library" scope="PROVIDED" name="tzinfo (v2.0.6, rbenv: 3.2.2) [gem]" level="application" />
+  </component>
+  <component name="RakeTasksCache">
+    <option name="myRootTask">
+      <RakeTaskImpl id="rake">
+        <subtasks>
+          <RakeTaskImpl description="Build econfig-0.1.1.gem into the pkg directory" fullCommand="build" id="build" />
+          <RakeTaskImpl id="build">
+            <subtasks>
+              <RakeTaskImpl description="Generate SHA512 checksum if econfig-0.1.1.gem into the checksums directory" fullCommand="build:checksum" id="checksum" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Remove any temporary products" fullCommand="clean" id="clean" />
+          <RakeTaskImpl description="Remove any generated files" fullCommand="clobber" id="clobber" />
+          <RakeTaskImpl description="Build and install econfig-0.1.1.gem into system gems" fullCommand="install" id="install" />
+          <RakeTaskImpl id="install">
+            <subtasks>
+              <RakeTaskImpl description="Build and install econfig-0.1.1.gem into system gems without network access" fullCommand="install:local" id="local" />
+            </subtasks>
+          </RakeTaskImpl>
+          <RakeTaskImpl description="Create tag v0.1.1 and build and push econfig-0.1.1.gem to rubygems.org" fullCommand="release[remote]" id="release[remote]" />
+          <RakeTaskImpl description="Run RSpec code examples" fullCommand="spec" id="spec" />
+          <RakeTaskImpl description="" fullCommand="default" id="default" />
+          <RakeTaskImpl description="" fullCommand="release" id="release" />
+          <RakeTaskImpl id="release">
+            <subtasks>
+              <RakeTaskImpl description="" fullCommand="release:guard_clean" id="guard_clean" />
+              <RakeTaskImpl description="" fullCommand="release:rubygem_push" id="rubygem_push" />
+              <RakeTaskImpl description="" fullCommand="release:source_control_push" id="source_control_push" />
+            </subtasks>
+          </RakeTaskImpl>
+        </subtasks>
+      </RakeTaskImpl>
+    </option>
+  </component>
+</module>

data/.idea/misc.xml

@@ -0,0 +1,4 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectRootManager" version="2" project-jdk-name="rbenv: 3.2.2" project-jdk-type="RUBY_SDK" />
+</project>

data/.idea/modules.xml

@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="ProjectModuleManager">
+    <modules>
+      <module fileurl="file://$PROJECT_DIR$/.idea/blue_config.iml" filepath="$PROJECT_DIR$/.idea/blue_config.iml" />
+    </modules>
+  </component>
+</project>

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="" vcs="Git" />
+  </component>
+</project>

data/.rspec

@@ -0,0 +1 @@
+-r spec_helper

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in econfig.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2024 Vladimir Elchinov, Rails Blueprint
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,152 @@
+# Blueprint Config
+
+Blueprint Config is a gem which allows you to easily configure your Ruby applications
+in a multitude of ways.
+
+It was highly inspired by other solutions, Econfig in first place. 
+
+## Installation
+
+Add this to your Gemfile:
+
+``` ruby
+gem "blueprint_config"
+```
+
+## Using with Ruby on Rails app
+
+In Rails, you'll want to add this in `config/application.rb`:
+
+``` ruby
+module MyApp
+  class Application < Rails::Application
+    BlueprintConfig.configure_rails(config)
+  end
+end
+```
+
+This will create module "AppConfig" for accessing configuration options,
+and load configuration in following order:
+- config/app.yml
+- credentials
+- ENV variables 
+- settings in database
+- config/app.local.yml
+
+Settings form database will be available only after rails app initialization.
+Everything else can be used in initializers.
+
+## Accessing configuration variables.
+
+You can access configuration variables in any of followining ways:
+
+### Member access syntax:
+
+```ruby
+irb(main):001> AppConfig.action_mailer.smtp_settings.address
+=> "127.0.0.1"
+```
+
+If at some level variable is not defined and you try to access nested variable, 
+you'll gen an exception 
+
+```ruby
+irb(main):001> AppConfig.some.var
+(irb):1:in `<main>': undefined method `var' for nil:NilClass (NoMethodError)
+
+AppConfig.some.var
+              ^^^^
+```
+
+If nil is suitable as a default value tyou can use safe navigation operator
+
+```ruby
+irb(main):001> AppConfig.some&.var
+=> nil
+
+```
+
+
+
+Optionaly you use bang methods to allways raise exception when variable is not defined
+
+```ruby
+irb(main):001> AppConfig.some
+=> nil
+irb(main):002> AppConfig.some!
+(irb):2:in `<main>': Configuration key 'some' is not set (KeyError)
+irb(main):003> AppConfig.some!.var!
+(irb):3:in `<main>': Configuration key 'some' is not set (KeyError)
+```
+
+Or use question mark to check if variable is defined
+
+```ruby
+irb(main):001> AppConfig.some?
+=> false
+irb(main):002> AppConfig.host?
+=> true
+```
+
+Note: Because question mark methods return Boolean you cannot chain em.
+
+### Hash access syntax
+You can use both symbols or strings as keys
+
+```ruby
+irb(main):001> AppConfig[:action_mailer][:delivery_method]
+=> :letter_opener
+irb(main):002> AppConfig['action_mailer']['delivery_method']
+=> :letter_opener
+
+```
+Again, if some level is missing you'll get an exception
+```ruby
+irb(main):001> AppConfig[:some][:var]
+(irb):1:in `<main>': undefined method `[]' for nil:NilClass (NoMethodError)
+
+AppConfig[:some][:var]
+                ^^^^^^
+```
+
+### Fetch
+
+You can use hash-style fetch method, but it works only for one level 
+(but you can chain it). Default values as second parameter or block are 
+supported. Without default value missing key will raise exception.
+
+```ruby
+irb(main):001> AppConfig.fetch(:host)
+=> "localhost"
+irb(main):002> AppConfig.fetch(:var)
+(irb):2:in `<main>': Configuration key 'var' is not set (KeyError)
+irb(main):003> AppConfig.fetch(:var, 123)
+=> 123
+irb(main):004> AppConfig.fetch(:var){123}
+=> 123
+```
+
+### Dig
+
+Dig permits to sefely get value in nested structures (including arrays)
+
+```ruby
+irb(main):001> AppConfig.dig(:action_mailer, :smtp_settings, :address)
+=> "127.0.0.1"
+irb(main):002> AppConfig.dig(:action_mailer, :smtp_settings, :unknown)
+=> nil
+```
+Bang version will raise exception when key at any level is missing
+```ruby
+irb(main):001> AppConfig.dig!(:action_mailer, :smtp_settings, :unknown)
+(irb):1:in `<main>': Configuration key 'action_mailer.smtp_settings.unknown' is not set (KeyError)
+irb(main):002> AppConfig.dig!(:action, :smtp_settings, :address)
+(irb):2:in `<main>': Configuration key 'action' is not set (KeyError)
+```
+
+Whenever possible exception message specifies which key is missing.
+
+
+## License
+
+MIT, see separate LICENSE.txt file

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new
+
+task default: :spec

data/blueprint_config.gemspec

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+require 'English'
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'blueprint_config/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'blueprint_config'
+  gem.version       = BlueprintConfig::VERSION
+  gem.authors       = ['Vladimir Elchinov', 'Rails Blueprint']
+  gem.email         = ['elik@elik.ru', 'info@railsblueprint.com']
+  gem.description   = 'Flexible configuration for Ruby/Rails applications with a variety of backends'
+  gem.summary       = 'Congifure Ruby apps'
+  gem.homepage      = 'https://github.com/railsblueprint/blueprint_config'
+  gem.license       = 'MIT'
+
+  gem.files         = `git ls-files`.split($INPUT_RECORD_SEPARATOR)
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.required_ruby_version = '~> 3.0'
+
+  gem.add_development_dependency 'activerecord'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'redis'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'sqlite3'
+end

data/lib/blueprint_config/backend/active_record.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+require 'active_record'
+require 'blueprint_config/backend/base'
+require 'blueprint_config/setting'
+
+module BlueprintConfig
+  module Backend
+    class ActiveRecord < Base
+      MISSING_TABLE_WARNING = <<-WARNING.gsub(/^ */, '')
+        =======================================================================
+        Settings table not found. Please add the configuration table by running:
+
+        rails generate blue_config:migration
+        rake db:migrate
+        =======================================================================
+      WARNING
+
+      def initialize(options = {})
+        @options = options
+        @updated_at = nil
+        @last_checked_at = nil
+        @mutex = Mutex.new
+      end
+
+      def load_keys
+        update_timestamp
+
+        data = Setting.all.map { |s| { s.key => s.parsed_value } }.reduce(:merge) || {}
+        return data.transform_keys(&:to_sym) unless @options[:nest]
+
+        nest_hash(data, @options[:nest_separator] || '.')
+      end
+
+      def update_timestamp
+        @mutex.synchronize do
+          @updated_at = Setting.maximum(:updated_at)
+        end
+      end
+
+      def fresh?
+        return true if @last_checked_at.present? && @last_checked_at > 1.second.ago
+
+        @mutex.synchronize do
+          @last_checked_at = Time.now
+        end
+        @updated_at.present? && @updated_at >= Setting.maximum(:updated_at)
+      end
+    end
+  end
+end

data/lib/blueprint_config/backend/base.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require 'active_support/core_ext/hash/deep_merge'
+
+module BlueprintConfig
+  module Backend
+    class Base
+      def nest_hash(hash, delimiter = '_')
+        hash.each_with_object({}) do |(key, value), results|
+          steps = key.split(delimiter).reverse
+          nested = steps.reduce(value) { |value, key| { key.to_sym => value } }
+
+          results.deep_merge!(nested) do |_key, a, b|
+            if a.is_a?(Hash) && b.is_a?(String)
+              a.deep_merge(nil => b)
+            elsif b.is_a?(Hash) && a.is_a?(String)
+              b.deep_merge(nil => a)
+            else
+              b
+            end
+          end
+        end
+      end
+
+      def source
+        self.class.name
+      end
+
+      def fresh?
+        true
+      end
+    end
+  end
+end

data/lib/blueprint_config/backend/credentials.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'active_support/encrypted_configuration'
+
+module BlueprintConfig
+  module Backend
+    class Credentials < Base
+      def load_keys
+        credentials.to_h
+      end
+
+      def credentials
+        if defined?(Rails)
+          Rails.application.credentials
+        else
+          ActiveSupport::EncryptedConfiguration.new(
+            config_path: 'config/credentials.yml.enc',
+            key_path: 'config/master.key',
+            env_key: 'RAILS_MASTER_KEY',
+            raise_if_missing_key: false
+          )
+        end
+      end
+    end
+  end
+end

data/lib/blueprint_config/backend/env.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require 'blueprint_config/backend/base'
+
+module BlueprintConfig
+  module Backend
+    class ENV < Base
+      attr_accessor :options
+
+      def initialize(options = {})
+        @options = options
+      end
+
+      def load_keys
+        {
+          # env: ::ENV.to_h.transform_keys(&:to_sym),
+          ** transformed_env
+        }
+      end
+
+      def env_downcased
+        @env_downcased ||= ::ENV.to_h.transform_keys(&:downcase)
+      end
+
+      def env_downcased_keys
+        @env_downcased_keys ||= env_downcased.keys
+      end
+
+      def filtered_env
+        return env_downcased if @options[:allow_all]
+
+        allowed_keys = @options[:whitelist_keys]&.map(&:to_s) || []
+        @options[:whitelist_prefixes]&.each do |prefix|
+          allowed_keys += env_downcased_keys.select { |key| key.to_s.start_with?(prefix.to_s) }
+        end
+
+        env_downcased.slice(* allowed_keys)
+      end
+
+      def transformed_env
+        return filtered_env.transform_keys(&:to_sym) unless @options[:nest]
+
+        nest_hash(filtered_env, @options[:nest_separator] || '_')
+      end
+    end
+  end
+end

data/lib/blueprint_config/backend/yaml.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require 'erb'
+require 'yaml'
+require 'active_support/hash_with_indifferent_access'
+
+module BlueprintConfig
+  module Backend
+    class YAML < Base
+      def initialize(path = 'config/app.yml')
+        @path = path
+      end
+
+      def load_keys
+        if File.exist?(path)
+          parsed = ::YAML.load(File.read(path), aliases: true).deep_symbolize_keys
+          parsed.fetch(:default, {}).deep_merge(parsed.fetch(BlueprintConfig.env&.to_sym, {}))
+        else
+          {}
+        end
+      end
+
+      private
+
+      def path
+        File.expand_path(@path, BlueprintConfig.root)
+      end
+    end
+  end
+end

data/lib/blueprint_config/backend_collection.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module BlueprintConfig
+  class BackendCollection
+    include Enumerable
+
+    def initialize
+      @backends = []
+    end
+
+    def [](name)
+      pair = @backends.assoc(name)
+      pair&.last
+    end
+
+    def each
+      if block_given?
+        @backends.each { |(_name, backend)| yield backend }
+      else
+        enum_for { @backends.length }
+      end
+    end
+
+    def push(name, backend)
+      exists?(name)
+      @backends.push([name, backend])
+    end
+    alias use push
+
+    def unshift(name, backend)
+      exists?(name)
+      @backends.unshift([name, backend])
+    end
+
+    def insert_before(other, name, backend)
+      exists?(name)
+      @backends.insert(index_of!(other), [name, backend])
+    end
+
+    def insert_after(other, name, backend)
+      exists?(name)
+      @backends.insert(index_of!(other) + 1, [name, backend])
+    end
+
+    def delete(name)
+      @backends.delete_at(index_of!(name))
+    end
+
+    def fresh?
+      @backends.all? { |(_name, backend)| backend.fresh? }
+    end
+
+    private
+
+    def exists?(name)
+      raise KeyError, "#{name} is already set" if index_of(name)
+    end
+
+    def index_of!(name)
+      index_of(name) or raise KeyError, "#{name} is not set"
+    end
+
+    def index_of(name)
+      @backends.index(@backends.assoc(name))
+    end
+  end
+end