blueprint_config 1.0.0

data/spec/blueprint_config/options_array_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+RSpec.describe BlueprintConfig::OptionsArray do
+  let(:source) do
+    %w[a b c]
+  end
+  subject { described_class.new(source, source: 'env', path: 'path') }
+
+  describe '#initialize' do
+    it 'succeeds' do
+      expect { subject }.not_to raise_error
+    end
+  end
+
+  describe 'getting values' do
+    it 'retrieves members with []', :aggregate_failures do
+      expect(subject[0]).to eq('a')
+      expect(subject[1]).to eq('b')
+      expect(subject[2]).to eq('c')
+    end
+  end
+
+  describe '#dig' do
+    it 'retrieves members using position', :aggregate_failures do
+      expect(subject[0]).to eq('a')
+      expect(subject[1]).to eq('b')
+      expect(subject[2]).to eq('c')
+      expect(subject[3]).to eq(nil)
+    end
+  end
+
+  describe '#dig!' do
+    it 'retrieves members using position', :aggregate_failures do
+      expect(subject.dig!(0)).to eq('a')
+      expect(subject.dig!(1)).to eq('b')
+      expect(subject.dig!(2)).to eq('c')
+    end
+
+    it 'raises exception when key not found', :aggregate_failures do
+      expect { subject.dig!(3) }.to raise_error(IndexError, "Configuration key 'path.3' is not set")
+    end
+  end
+
+  describe '#fetch' do
+    it 'retrieves members using position', :aggregate_failures do
+      expect(subject.fetch(0)).to eq('a')
+      expect(subject.fetch(1)).to eq('b')
+    end
+
+    it 'raise error when key is not present and no block is given', :aggregate_failures do
+      expect { subject.fetch(3) }.to raise_error(IndexError, "Configuration key 'path.3' is not set")
+    end
+
+    it 'calls block when it is given and key is not present', :aggregate_failures do
+      expect(subject.fetch(3, 1)).to eq(1)
+    end
+  end
+
+  describe '#source' do
+    it 'returns the source', :aggregate_failures do
+      expect(subject.source(0)).to eq('env path.0')
+      expect(subject.source(1)).to eq('env path.1')
+      expect(subject.source(2)).to eq('env path.2')
+    end
+
+    context 'when out of range' do
+      it 'raises exception', :aggregate_failures do
+        expect { subject.source(3) }.to raise_error(IndexError, "Configuration key 'path.3' is not set")
+      end
+    end
+
+    context 'when merging 2 sources' do
+      let(:source1) do
+        %w[a b c]
+      end
+      let(:source2) do
+        %w[__append e f]
+      end
+      let(:options1) { described_class.new(source1, source: 'env1', path: 'path1') }
+      let(:options2) { described_class.new(source2, source: 'env2', path: 'path1') }
+      subject { options1.__assign(options2) }
+
+      it 'returns the source correctly', :aggregate_failures do
+        expect(subject.source(0)).to eq('env1 path1.0')
+        expect(subject.source(1)).to eq('env1 path1.1')
+        expect(subject.source(2)).to eq('env1 path1.2')
+        expect(subject.source(3)).to eq('env2 path1.1')
+        expect(subject.source(4)).to eq('env2 path1.2')
+      end
+    end
+
+    context 'when overriding from different source' do
+      let(:source1) do
+        %w[a b c]
+      end
+      let(:source2) do
+        %w[e f]
+      end
+      let(:options1) { described_class.new(source1, source: 'env1') }
+      let(:options2) { described_class.new(source2, source: 'env2') }
+      subject { options1.__assign(options2) }
+
+      it 'returns the source', :aggregate_failures do
+        expect(subject.source(0)).to eq('env2 0')
+        expect(subject.source(1)).to eq('env2 1')
+      end
+    end
+  end
+end

data/spec/blueprint_config/options_hash_spec.rb

@@ -0,0 +1,211 @@
+# frozen_string_literal: true
+
+RSpec.describe BlueprintConfig::OptionsHash do
+  let(:source) do
+    {
+      a: 1,
+      b: 2,
+      c: {
+        d: 1,
+        e: 2
+      },
+      k: [1, 2, 3],
+      j: [{ a: 1 }, { b: 2 }]
+    }
+  end
+  subject { described_class.new(source, source: 'env') }
+
+  describe '#initialize' do
+    it 'succeeds' do
+      expect { subject }.not_to raise_error
+    end
+  end
+
+  describe 'getting values' do
+    it 'retrieves members as method calls', :aggregate_failures do
+      expect(subject.a).to eq(1)
+      expect(subject.b).to eq(2)
+      expect(subject.c.d).to eq(1)
+      expect(subject.c.e).to eq(2)
+      expect(subject.c.f).to eq(nil)
+      expect(subject.d).to eq(nil)
+    end
+
+    it 'retrieves members with [] and symbol keys', :aggregate_failures do
+      expect(subject[:a]).to eq(1)
+      expect(subject[:b]).to eq(2)
+      expect(subject[:c][:d]).to eq(1)
+      expect(subject[:c][:e]).to eq(2)
+      expect(subject[:c][:f]).to eq(nil)
+      expect(subject[:d]).to eq(nil)
+    end
+
+    it 'retrieves members with [] and string keys', :aggregate_failures do
+      expect(subject['a']).to eq(1)
+      expect(subject['b']).to eq(2)
+      expect(subject['c']['d']).to eq(1)
+      expect(subject['c']['e']).to eq(2)
+      expect(subject['c']['f']).to eq(nil)
+      expect(subject['d']).to eq(nil)
+    end
+
+    it 'retrieves members with [] and mixed keys', :aggregate_failures do
+      expect(subject[:c]['d']).to eq(1)
+      expect(subject['c'][:e]).to eq(2)
+      expect(subject['c'][:f]).to eq(nil)
+      expect(subject[:c]['f']).to eq(nil)
+    end
+
+    it 'retrieves members with [] and array elements', :aggregate_failures do
+      expect(subject[:k][0]).to eq(1)
+      expect(subject[:k][1]).to eq(2)
+      expect(subject[:j][0][:a]).to eq(1)
+      expect(subject[:j][1][:b]).to eq(2)
+    end
+  end
+
+  describe '#dig' do
+    it 'retrieves members using string keys', :aggregate_failures do
+      expect(subject['a']).to eq(1)
+      expect(subject['b']).to eq(2)
+      expect(subject.dig('c', 'd')).to eq(1)
+      expect(subject.dig('c', 'e')).to eq(2)
+      expect(subject.dig('c', 'f')).to eq(nil)
+      expect(subject['d']).to eq(nil)
+    end
+
+    it 'retrieves members using symbol keys', :aggregate_failures do
+      expect(subject[:a]).to eq(1)
+      expect(subject[:b]).to eq(2)
+      expect(subject.dig(:c, :d)).to eq(1)
+      expect(subject.dig(:c, :e)).to eq(2)
+      expect(subject.dig(:c, :f)).to eq(nil)
+      expect(subject[:d]).to eq(nil)
+    end
+
+    it 'retrieves members using mixed keys', :aggregate_failures do
+      expect(subject.dig('c', :d)).to eq(1)
+      expect(subject.dig(:c, 'e')).to eq(2)
+      expect(subject.dig('c', :f)).to eq(nil)
+      expect(subject.dig(:c, 'g')).to eq(nil)
+    end
+
+    it 'retrieves members with array elements', :aggregate_failures do
+      expect(subject.dig(:k, 0)).to eq(1)
+      expect(subject.dig(:k, 1)).to eq(2)
+      expect(subject.dig(:j, 0, :a)).to eq(1)
+      expect(subject.dig(:j, 1, :b)).to eq(2)
+    end
+  end
+
+  describe '#dig!' do
+    it 'retrieves members using string keys', :aggregate_failures do
+      expect(subject.dig!('a')).to eq(1)
+      expect(subject.dig!('b')).to eq(2)
+      expect(subject.dig!('c', 'd')).to eq(1)
+      expect(subject.dig!('c', 'e')).to eq(2)
+    end
+
+    it 'retrieves members using symbol keys', :aggregate_failures do
+      expect(subject.dig!(:a)).to eq(1)
+      expect(subject.dig!(:b)).to eq(2)
+      expect(subject.dig!(:c, :d)).to eq(1)
+      expect(subject.dig!(:c, :e)).to eq(2)
+    end
+
+    it 'retrieves members using mixed keys', :aggregate_failures do
+      expect(subject.dig!('c', :d)).to eq(1)
+      expect(subject.dig!(:c, 'e')).to eq(2)
+    end
+
+    it 'retrieves members with array elements', :aggregate_failures do
+      expect(subject.dig!(:k, 0)).to eq(1)
+      expect(subject.dig!(:k, 1)).to eq(2)
+      expect(subject.dig!(:j, 0, :a)).to eq(1)
+      expect(subject.dig!(:j, 1, :b)).to eq(2)
+    end
+
+    it 'raises exception when key not found', :aggregate_failures do
+      expect { subject.dig!('c', 'f') }.to raise_error(KeyError, "Configuration key 'c.f' is not set")
+      expect { subject.dig!('d') }.to raise_error(KeyError, "Configuration key 'd' is not set")
+      expect { subject.dig!(:j, 1, :c) }.to raise_error(KeyError, "Configuration key 'j.1.c' is not set")
+    end
+  end
+
+  describe '#fetch' do
+    it 'retrieves members using string keys', :aggregate_failures do
+      expect(subject.fetch('a')).to eq(1)
+      expect(subject.fetch('b')).to eq(2)
+    end
+
+    it 'retrieves members using symbol keys', :aggregate_failures do
+      expect(subject.fetch(:a)).to eq(1)
+      expect(subject.fetch(:b)).to eq(2)
+    end
+
+    it 'raise error when key is not present and no block is given', :aggregate_failures do
+      expect { subject.fetch('d') }.to raise_error(KeyError, "Configuration key 'd' is not set")
+      expect { subject.fetch(:e) }.to raise_error(KeyError, "Configuration key 'e' is not set")
+    end
+
+    it 'calls block when it is given and key is not present', :aggregate_failures do
+      expect(subject.fetch(:e, 1)).to eq(1)
+      expect(subject.fetch('f', 2)).to eq(2)
+    end
+  end
+
+  describe '#source' do
+    it 'returns the source', :aggregate_failures do
+      expect(subject.source(:a)).to eq('env a')
+      expect(subject.source(:b)).to eq('env b')
+      expect(subject.source(:c)).to eq('env c')
+      expect(subject.source(:c, :d)).to eq('env c.d')
+      expect(subject.source(:c, :e)).to eq('env c.e')
+      expect(subject.source(:k, 0)).to eq('env k.0')
+      expect(subject.source(:j, 0)).to eq('env j.0')
+      expect(subject.source(:j, 0, :a)).to eq('env j.0.a')
+    end
+
+    context 'when merging 2 sources' do
+      let(:source1) do
+        {
+          a: 1,
+          b: 2,
+          c: {
+            d: 1,
+            e: 2
+          },
+          k: [1, 2, 3],
+          j: [{ a: 1 }, { b: 2 }]
+        }
+      end
+      let(:source2) do
+        {
+          a: 1,
+          g: 3,
+          c: {
+            d: 2,
+            f: 3
+          },
+          k: [:__append, 4, 5],
+          j: [:__append, { x: 1 }, { y: 2 }]
+        }
+      end
+      let(:options1) { described_class.new(source1, source: 'env1') }
+      let(:options2) { described_class.new(source2, source: 'env2') }
+      subject { options1.deep_merge(options2) }
+
+      it 'returns the source', :aggregate_failures do
+        expect(subject.source(:a)).to eq('env1 a')
+        expect(subject.source(:b)).to eq('env1 b')
+        expect(subject.source(:c)).to eq('env1 c')
+        expect(subject.source(:g)).to eq('env2 g')
+        expect(subject.source(:c, :d)).to eq('env1 c.d')
+        expect(subject.source(:c, :e)).to eq('env1 c.e')
+        expect(subject.source(:k, 4)).to eq('env2 k.2')
+        expect(subject.source(:j, 0, :a)).to eq('env1 j.0.a')
+        expect(subject.source(:j, 3, :y)).to eq('env2 j.2.y')
+      end
+    end
+  end
+end

data/spec/config/app.yml

@@ -0,0 +1,24 @@
+default:
+  nested:
+    a: 1
+    b: 2
+  array:
+    - a
+    - b
+    - x
+  array2:
+    - a:
+        d: 1
+        e: 2
+      b: 2
+    - b: 1
+      c: 3
+    - x: 4
+      y: 5
+
+test:
+  quox: baz
+  envir: "<%= ENV['APP_EXAMPLE'] %>"
+  nested:
+    a: 3
+    c: 4

data/spec/configuration_spec.rb

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+describe BlueprintConfig::Configuration do
+  let(:key_set1) do
+    {
+      a: 1,
+      b: 2
+    }
+  end
+
+  let(:key_set2) do
+    {
+      a: 3,
+      c: 4,
+      e: '<%= AppConfig.a %>'
+    }
+  end
+
+  let(:backend) { double('backend', load_keys: key_set1, source: 'backend', fresh?: true) }
+  let(:other_backend) { double('other backend', load_keys: key_set2, source: 'other_backend', fresh?: true) }
+  let(:config) { described_class.instance }
+
+  before do
+    stub_const('AppConfig', config)
+    config.init do |backends|
+      backends.push(:one, backend)
+      backends.push(:other, other_backend)
+    end
+  end
+
+  describe 'getting values as method calls' do
+    it 'returns the value of a given key' do
+      expect(config.a).to eq(3)
+      expect(config.c).to eq(4)
+      expect(config.e).to eq('3')
+    end
+    it 'checks backend freshness' do
+      expect(backend).to receive(:fresh?).and_return(true)
+      expect(config.c).to eq(4)
+    end
+    it 'reloads when backend is stale' do
+      expect(backend).to receive(:fresh?).and_return(false)
+      expect(config).to receive(:reload!).and_call_original
+      expect(config.c).to eq(4)
+    end
+  end
+
+  describe 'getting values with []' do
+    it 'returns the value of a given key' do
+      expect(config[:a]).to eq(3)
+      expect(config[:c]).to eq(4)
+      expect(config[:e]).to eq('3')
+    end
+    it 'checks backend freshness' do
+      expect(backend).to receive(:fresh?).and_return(true)
+      expect(config[:c]).to eq(4)
+    end
+    it 'reloads when backend is stale' do
+      expect(backend).to receive(:fresh?).and_return(false)
+      expect(config).to receive(:reload!).and_call_original
+      expect(config[:c]).to eq(4)
+    end
+  end
+
+  describe 'getting values with dig' do
+    it 'returns the value of a given key' do
+      expect(config[:a]).to eq(3)
+      expect(config[:c]).to eq(4)
+      expect(config[:e]).to eq('3')
+    end
+    it 'checks backend freshness' do
+      expect(backend).to receive(:fresh?).and_return(true)
+      expect(config[:c]).to eq(4)
+    end
+    it 'reloads when backend is stale' do
+      expect(backend).to receive(:fresh?).and_return(false)
+      expect(config).to receive(:reload!).and_call_original
+      expect(config[:c]).to eq(4)
+    end
+  end
+
+  describe 'getting values with dig!' do
+    it 'returns the value of a given key' do
+      expect(config.dig!(:a)).to eq(3)
+      expect(config.dig!(:c)).to eq(4)
+      expect(config.dig!(:e)).to eq('3')
+    end
+    it 'checks backend freshness' do
+      expect(backend).to receive(:fresh?).and_return(true)
+      expect(config.dig!(:c)).to eq(4)
+    end
+    it 'reloads when backend is stale' do
+      expect(backend).to receive(:fresh?).and_return(false)
+      expect(config).to receive(:reload!).and_call_original
+      expect(config.dig!(:c)).to eq(4)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'blueprint_config'
+
+BlueprintConfig.root = File.dirname(__FILE__)
+BlueprintConfig.env = 'test'
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |c|
+    c.syntax = %i[expect should]
+  end
+
+  config.mock_with :rspec do |c|
+    c.syntax = %i[expect should]
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: blueprint_config
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Vladimir Elchinov
+- Rails Blueprint
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: redis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Flexible configuration for Ruby/Rails applications with a variety of
+  backends
+email:
+- elik@elik.ru
+- info@railsblueprint.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".idea/.gitignore"
+- ".idea/blue_config.iml"
+- ".idea/misc.xml"
+- ".idea/modules.xml"
+- ".idea/vcs.xml"
+- ".rspec"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- blueprint_config.gemspec
+- lib/blueprint_config.rb
+- lib/blueprint_config/backend/active_record.rb
+- lib/blueprint_config/backend/base.rb
+- lib/blueprint_config/backend/credentials.rb
+- lib/blueprint_config/backend/env.rb
+- lib/blueprint_config/backend/yaml.rb
+- lib/blueprint_config/backend_collection.rb
+- lib/blueprint_config/configuration.rb
+- lib/blueprint_config/options_array.rb
+- lib/blueprint_config/options_hash.rb
+- lib/blueprint_config/setting.rb
+- lib/blueprint_config/version.rb
+- lib/blueprint_config/yaml.rb
+- lib/generators/blueprint_config/install/USAGE
+- lib/generators/blueprint_config/install/install_generator.rb
+- lib/generators/blueprint_config/install/templates/migration.rb.erb
+- spec/backend_collection_spec.rb
+- spec/blueprint_config/backend/active_record_spec.rb
+- spec/blueprint_config/backend/env_spec.rb
+- spec/blueprint_config/backend/yaml_spec.rb
+- spec/blueprint_config/options_array_spec.rb
+- spec/blueprint_config/options_hash_spec.rb
+- spec/config/app.yml
+- spec/configuration_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/railsblueprint/blueprint_config
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - "~>"
+    - !ruby/object:Gem::Version
+      version: '3.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.22
+signing_key:
+specification_version: 4
+summary: Congifure Ruby apps
+test_files:
+- spec/backend_collection_spec.rb
+- spec/blueprint_config/backend/active_record_spec.rb
+- spec/blueprint_config/backend/env_spec.rb
+- spec/blueprint_config/backend/yaml_spec.rb
+- spec/blueprint_config/options_array_spec.rb
+- spec/blueprint_config/options_hash_spec.rb
+- spec/config/app.yml
+- spec/configuration_spec.rb
+- spec/spec_helper.rb