qonfig 0.25.0 → 0.26.0

data/spec/features/non_redefineable_core_methods_spec.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+describe 'Non-redefineable core methods' do
+  specify 'fails when setting key intersects with any internal Qonfig::Settings core method' do
+    core_methods = (
+      Qonfig::Settings.instance_methods(false) |
+      Qonfig::Settings.private_instance_methods(false) |
+      %i[define_singleton_method super self]
+    )
+
+    expect(core_methods).not_to include(:super_test_key)
+
+    core_methods.each do |core_method|
+      expect do
+        Class.new(Qonfig::DataSet) do
+          setting core_method
+        end
+      end.to raise_error(Qonfig::CoreMethodIntersectionError)
+
+      expect do
+        Class.new(Qonfig::DataSet) do
+          setting :super_test_key do
+            setting core_method
+          end
+        end
+      end.to raise_error(Qonfig::CoreMethodIntersectionError)
+    end
+  end
+end

data/spec/features/plugins/pretty_print_spec.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+describe 'Plugins(:pretty_print): Pretty print :)', plugin: :pretty_print do
+  before do
+    stub_const('PrettyPrintableConfig', Class.new(Qonfig::DataSet) do
+      setting :api do
+        setting :domain, 'google'
+        setting :creds do
+          setting :token, 'a0sdj10k@'
+          setting :login, 'D2'
+        end
+      end
+
+      setting :database do
+        setting :adapter, 'pg'
+        setting 'logging.queries', nil
+      end
+
+      setting :logging, false
+      setting :author, nil
+    end)
+  end
+
+  shared_examples 'pretty printing :)' do
+    subject(:print_to_console!) { PP.pp(config, pretty_printer_output) }
+
+    let(:pretty_printer_output) { StringIO.new }
+
+    if Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.7.0')
+      specify 'shows config settings in beatufied format' do
+        print_to_console!
+
+        expect(pretty_printer_output.string).to include(
+          "#<#{expected_config_klass_name}:0x"
+        )
+
+        expect(pretty_printer_output.string).to include(
+          " api.domain: \"google\",\n" \
+          " api.creds.token: \"a0sdj10k@\",\n" \
+          " api.creds.login: \"D2\",\n" \
+          " database.adapter: \"pg\",\n" \
+          " database.logging.queries: nil,\n" \
+          " logging: false,\n" \
+          " author: nil>\n"
+        )
+      end
+    else
+      specify 'shows config settings in beatufied format' do
+        print_to_console!
+        value_space = SpecSupport.from_object_id_space_to_value_space(config)
+
+        expect(pretty_printer_output.string).to eq(
+          "#<#{expected_config_klass_name}:0x#{value_space}\n" \
+          " api.domain: \"google\",\n" \
+          " api.creds.token: \"a0sdj10k@\",\n" \
+          " api.creds.login: \"D2\",\n" \
+          " database.adapter: \"pg\",\n" \
+          " database.logging.queries: nil,\n" \
+          " logging: false,\n" \
+          " author: nil>\n"
+        )
+      end
+    end
+  end
+
+  context 'pretty-printed Qonfig::DataSet' do
+    include_examples 'pretty printing :)' do
+      let(:config) { PrettyPrintableConfig.new }
+      let(:expected_config_klass_name) { 'PrettyPrintableConfig' }
+    end
+  end
+
+  context 'pretty-printed Qonfig::Settings' do
+    include_examples 'pretty printing :)' do
+      let(:config) { PrettyPrintableConfig.new.settings }
+      let(:expected_config_klass_name) { 'Qonfig::Settings' }
+    end
+  end
+
+  context 'pretty-printed Qonfig::Compacted' do
+    include_examples 'pretty printing :)' do
+      let(:config) { PrettyPrintableConfig.new.compacted }
+      let(:expected_config_klass_name) { 'Qonfig::Compacted' }
+    end
+  end
+end

data/spec/features/plugins/toml/expose_self/format_option_toml_spec.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): #expose_self => format: :toml', plugin: :toml do
+  specify ':toml-format support' do
+    class ExposeTomlEndDataConfig < Qonfig::DataSet
+      setting :staging_env do
+        expose_self format: :toml, env: :staging
+      end
+
+      setting :prod_env do
+        expose_self format: :toml, env: :production
+      end
+
+      setting :test_env do
+        expose_self format: :toml, env: :test
+      end
+    end
+
+    config = ExposeTomlEndDataConfig.new
+
+    # NOTE: production env
+    expect(config.settings.prod_env.credentials.user).to eq('admin')
+    expect(config.settings.prod_env.credentials.password).to eq('123')
+    expect(config.settings.prod_env.credentials.enabled).to eq(true)
+    expect(config.settings.prod_env.api).to eq('google.com')
+    expect(config.settings.prod_env.ports).to eq([10001, 10002, 10003])
+
+    # NOTE: test env
+    expect(config.settings.test_env.credentials.user).to eq('megaman')
+    expect(config.settings.test_env.credentials.password).to eq('atata123')
+    expect(config.settings.test_env.credentials.enabled).to eq(false)
+    expect(config.settings.test_env.api).to eq('yandex.ru')
+    expect(config.settings.test_env.ports).to eq([1, 2, 3])
+
+    # NOTE: staging env
+    expect(config.settings.staging_env.credentials.user).to eq('diablo')
+    expect(config.settings.staging_env.credentials.password).to eq('testornot')
+    expect(config.settings.staging_env.credentials.enabled).to eq(true)
+    expect(config.settings.staging_env.api).to eq('battle.net')
+    expect(config.settings.staging_env.ports).to eq([111, 222, 333])
+  end
+end
+
+__END__
+
+[production]
+  api = "google.com"
+  ports = [ 10001, 10002, 10003 ]
+
+  [production.credentials]
+  user = "admin"
+  password = "123"
+  enabled = true
+
+[test]
+  api = "yandex.ru"
+  ports = [ 1, 2, 3 ]
+
+  [test.credentials]
+  user = "megaman"
+  password = "atata123"
+  enabled = false
+
+[staging]
+  api = "battle.net"
+  ports = [ 111, 222, 333 ]
+
+  [staging.credentials]
+  user = "diablo"
+  password = "testornot"
+  enabled = true

data/spec/features/plugins/toml/expose_toml_spec.rb

@@ -0,0 +1,221 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): expose TOML file', plugin: :toml do
+  specify 'defines config object by toml instructions and specific environment settings' do
+    class ExposeTOMLConfig < Qonfig::DataSet
+      toml_file_path = SpecSupport.fixture_path('plugins', 'toml', 'expose_toml', 'project.toml')
+
+      setting :file_name_based do
+        setting :test_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.test.toml
+          expose_toml toml_file_path, via: :file_name, env: :test
+        end
+
+        setting :prod_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.production.toml
+          expose_toml toml_file_path, via: :file_name, env: :production
+        end
+
+        setting :stage_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.staging.toml
+          expose_toml toml_file_path, via: :file_name, env: :staging
+        end
+
+        setting :dev_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.development.yml
+          expose_toml toml_file_path, via: :file_name, env: :development
+        end
+      end
+
+      setting :env_based do
+        setting :test_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.toml
+          expose_toml toml_file_path, via: :env_key, env: :test
+        end
+
+        setting :prod_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.toml
+          expose_toml toml_file_path, via: :env_key, env: :production
+        end
+
+        setting :stage_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.toml
+          expose_toml toml_file_path, via: :env_key, env: :staging
+        end
+
+        setting :dev_env do
+          # spec/fixtures/plugins/toml/expose_toml/project.toml
+          expose_toml toml_file_path, via: :env_key, env: :development
+        end
+      end
+    end
+
+    settings = ExposeTOMLConfig.new.settings
+
+    # NOTE: file-name based expose
+    # spec/fixtures/plugins/toml/expose_toml/project.test.toml
+    expect(settings.file_name_based.test_env.api_mode_enabled).to eq(false)
+    expect(settings.file_name_based.test_env.db_driver).to eq('in_memory')
+    expect(settings.file_name_based.test_env.logging).to eq(false)
+    expect(settings.file_name_based.test_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/project.production.toml
+    expect(settings.file_name_based.prod_env.api_mode_enabled).to eq(true)
+    expect(settings.file_name_based.prod_env.db_driver).to eq('rom')
+    expect(settings.file_name_based.prod_env.logging).to eq(true)
+    expect(settings.file_name_based.prod_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/project.development.toml
+    expect(settings.file_name_based.dev_env.api_mode_enabled).to eq(true)
+    expect(settings.file_name_based.dev_env.db_driver).to eq('sequel')
+    expect(settings.file_name_based.dev_env.logging).to eq(false)
+    expect(settings.file_name_based.dev_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/project.staging.toml
+    expect(settings.file_name_based.stage_env.api_mode_enabled).to eq(true)
+    expect(settings.file_name_based.stage_env.db_driver).to eq('active_record')
+    expect(settings.file_name_based.stage_env.logging).to eq(true)
+    expect(settings.file_name_based.stage_env.credentials).to eq({})
+
+    # NOTE: environment based expose
+    # spec/fixtures/plugins/toml/expose_toml/projecttoml (table: 'test')
+    expect(settings.env_based.test_env.api_mode_enabled).to eq(true)
+    expect(settings.env_based.test_env.db_driver).to eq('in_memory')
+    expect(settings.env_based.test_env.logging).to eq(false)
+    expect(settings.env_based.test_env.throttle_requests).to eq(false)
+    expect(settings.env_based.test_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/project.toml (table: 'production')
+    expect(settings.env_based.prod_env.api_mode_enabled).to eq(true)
+    expect(settings.env_based.prod_env.db_driver).to eq('rom')
+    expect(settings.env_based.prod_env.logging).to eq(true)
+    expect(settings.env_based.prod_env.throttle_requests).to eq(true)
+    expect(settings.env_based.prod_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/projecttoml (table: 'development')
+    expect(settings.env_based.dev_env.api_mode_enabled).to eq(true)
+    expect(settings.env_based.dev_env.db_driver).to eq('sequel')
+    expect(settings.env_based.dev_env.logging).to eq(false)
+    expect(settings.env_based.dev_env.throttle_requests).to eq(false)
+    expect(settings.env_based.dev_env.credentials).to eq({})
+    # spec/fixtures/plugins/toml/expose_toml/projecttoml (table: 'staging')
+    expect(settings.env_based.stage_env.api_mode_enabled).to eq(true)
+    expect(settings.env_based.stage_env.db_driver).to eq('active_record')
+    expect(settings.env_based.stage_env.logging).to eq(true)
+    expect(settings.env_based.stage_env.throttle_requests).to eq(true)
+    expect(settings.env_based.stage_env.credentials).to eq({})
+  end
+
+  describe 'failures and inconsistent situations' do
+    describe 'definition level errors' do
+      specify 'fails when :env attribute has non-string / non-symbol / non-numeric value' do
+        expect do
+          Class.new(Qonfig::DataSet) do
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'project.toml'
+            ), via: :env_key, env: Object.new
+          end
+        end.to raise_error(Qonfig::ArgumentError)
+      end
+
+      specify 'fails when :env is empty' do
+        expect do
+          Class.new(Qonfig::DataSet) do
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'project.toml'
+            ), via: :env_key, env: ''
+          end
+        end.to raise_error(Qonfig::ArgumentError)
+      end
+
+      specify 'fails when provided :via is not supported' do
+        expect do
+          Class.new(Qonfig::DataSet) do
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'project.toml'
+            ), via: :auto, env: :production
+          end
+        end.to raise_error(Qonfig::ArgumentError)
+      end
+    end
+
+    describe 'initialization level errors' do
+      describe 'strict mode' do
+        specify(
+          'disabled (non-strict): ' \
+          'file existence requirement + yaml-env-key existence requirement'
+        ) do
+          # NOTE: file does not exist + env key does not exist in toml file
+          class NoFileNonStrictExposeTOMLConfig < Qonfig::DataSet
+            setting :non_strict_by_file do
+              expose_toml SpecSupport.fixture_path(
+                'plugins', 'toml', 'expose_toml', 'nonexistent.toml'
+              ), strict: false, via: :file_name, env: :development
+            end
+
+            setting :non_strict_by_env do
+              expose_toml SpecSupport.fixture_path(
+                'plugins', 'toml', 'expose_toml', 'nonexistent.toml'
+              ), strict: false, via: :env_key, env: :development
+            end
+          end
+
+          expect(NoFileNonStrictExposeTOMLConfig.new.to_h).to match(
+            'non_strict_by_file' => {},
+            'non_strict_by_env'  => {}
+          )
+
+          # NOTE: file is exist + env key does not exist in toml file
+          class NoEnvKeyNonStrictExposeTOMLConfig < Qonfig::DataSet
+            setting :non_strict_by_file do
+              expose_toml SpecSupport.fixture_path(
+                'plugins', 'toml', 'expose_toml', 'project.toml'
+              ), strict: false, via: :file_name, env: :nonexistent
+            end
+
+            setting :non_strict_by_env do
+              expose_toml SpecSupport.fixture_path(
+                'plugins', 'toml', 'expose_toml', 'project.toml'
+              ), strict: false, via: :env_key, env: :nonexistent
+            end
+          end
+
+          expect(NoEnvKeyNonStrictExposeTOMLConfig.new.to_h).to match(
+            'non_strict_by_file' => {},
+            'non_strict_by_env'  => {}
+          )
+        end
+
+        specify(
+          'enabled (strict, by default): ' \
+          'file existence requirement + yaml-env-key existence requirement'
+        ) do
+          # NOTE: file does not exist
+          class StrictFileViaFileNameConfig < Qonfig::DataSet
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'nonexistent.toml'
+            ), via: :file_name, env: :production
+          end
+
+          # NOTE: file does not exist
+          class StrictFileViaEnvKeyConfig < Qonfig::DataSet
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'nonexistent.toml'
+            ), via: :env_key, env: :production
+          end
+
+          # NOTE: file does not exist
+          expect { StrictFileViaFileNameConfig.new }.to raise_error(Qonfig::FileNotFoundError)
+          expect { StrictFileViaEnvKeyConfig.new }.to   raise_error(Qonfig::FileNotFoundError)
+
+          # NOTE:
+          #   - file exists but env key does not exist
+          #   - file: spec/fixtures/plugins/toml/expose_toml/project.toml
+          class NonExistentEnvKeyConfig < Qonfig::DataSet
+            expose_toml SpecSupport.fixture_path(
+              'plugins', 'toml', 'expose_toml', 'project.toml'
+            ), via: :env_key, env: :nonexistent
+          end
+
+          # NOTE: env key does not exist
+          expect { NonExistentEnvKeyConfig.new }.to raise_error(Qonfig::ExposeError)
+        end
+      end
+    end
+  end
+end

data/spec/features/plugins/toml/load_from_self/format_option_toml_spec.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): #load_from_self => format: :toml', plugin: :toml do
+  specify ':toml-format support' do
+    class TomlEndDataConfig < Qonfig::DataSet
+      load_from_self format: :toml
+    end
+
+    config = TomlEndDataConfig.new
+
+    expect(config.settings.amount).to eq(123.456)
+    expect(config.settings.methods).to eq([['test'], [true, false], [1, 2, 3]])
+    expect(config.settings.credentials.user).to eq('admin')
+    expect(config.settings.credentials.password).to eq('123')
+    expect(config.settings.credentials.enabled).to eq(true)
+  end
+end
+
+__END__
+
+amount = 123.456
+methods = [ [ "test" ], [ true, false ], [ 1, 2, 3 ] ]
+
+[credentials]
+user = "admin"
+password = "123"
+enabled = true

data/spec/features/plugins/toml/load_from_toml_spec.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): Load from .toml (TOML)', plugin: :toml do
+  specify 'defines config object by toml instructions' do
+    class TomlConfig < Qonfig::DataSet
+      load_from_toml SpecSupport.fixture_path('plugins', 'toml', 'toml_sample_with_all_types.toml')
+    end
+
+    TomlConfig.new.settings.tap do |conf|
+      expect(conf.key_in_air).to eq('TOML Example')
+
+      expect(conf.inline_table_of_tables).to eq([
+        { 'x' => 1, 'y' => 2, 'z' => 3 },
+        { 'x' => 7, 'y' => 8, 'z' => 9 },
+        { 'x' => 2, 'y' => 4, 'z' => 8 }
+      ])
+
+      expect(conf.strings.simple_string).to eq('Simple String')
+      expect(conf.strings.first_multi_line_string).to eq("first multiline\nstring defined")
+      expect(conf.strings.second_multiline_string).to eq("second multiline\nstring defined\n")
+
+      expect(conf.times.first_format).to eq(Time.utc(1979, 0o5, 27, 0o7, 32, 0))
+      expect(conf.times.second_format).to eq(Time.new(1979, 0o5, 27, 0o0, 32, 0, '-07:00'))
+      expect(conf.times.third_format).to eq(Time.new(1979, 0o5, 27, 0o0, 32, 0.999999, '-07:00'))
+
+      expect(conf.arrays.array_of_integers).to eq([1, 2, 3])
+      expect(conf.arrays.array_of_strings).to eq(%w[a b c])
+      expect(conf.arrays.array_of_integer_arrays).to eq([[1, 2], [3, 4, 5]])
+      expect(conf.arrays.array_of_different_string_literals).to eq(%w[azaza trazaza kek pek])
+      expect(conf.arrays.array_of_multityped_arrays).to eq([[1, 2], %w[a b c]])
+      expect(conf.arrays.multyline_array).to eq(%w[super puper])
+
+      expect(conf.number_definitions.number_with_parts).to eq([8_001, 8_001, 8_002])
+      expect(conf.number_definitions.number_with_idiot_parts).to eq(5_000)
+      expect(conf.number_definitions.simple_float).to eq(3.12138)
+      expect(conf.number_definitions.epic_float).to eq(5e+22)
+      expect(conf.number_definitions.haha_float).to eq(1e6)
+      expect(conf.number_definitions.wow_float).to eq(-2E-2)
+
+      expect(conf.booleans.boolean_true).to eq(true)
+      expect(conf.booleans.boolean_false).to eq(false)
+
+      expect(conf.nesteds.first.ip).to    eq('10.0.0.1')
+      expect(conf.nesteds.first.host).to  eq('google.sru')
+      expect(conf.nesteds.second.ip).to   eq('10.0.0.2')
+      expect(conf.nesteds.second.host).to eq('poogle.fru')
+
+      expect(conf.deep_nesteds).to eq([
+        {
+          'name'   => 'apple',
+          'first'  => { 'model' => 'iphone xs', 'color' => 'white' },
+          'second' => [{ 'model' => 'iphone x' }],
+          'third'  => [{ 'model' => 'iphone se' }]
+        },
+        {
+          'name'=>'xiaomi',
+          'fourth'=>[{ 'model' => 'mi8 explorer edition' }]
+        }
+      ])
+    end
+  end
+
+  specify 'support for Pathanme in filepath' do
+    class PathanmeTomlLoadCheckConfig < Qonfig::DataSet
+      load_from_toml Pathname.new(SpecSupport.fixture_path('plugins', 'toml', 'mini_file.toml'))
+    end
+
+    config = PathanmeTomlLoadCheckConfig.new
+
+    expect(config.settings.enabled).to eq(false)
+    expect(config.settings.adapter).to eq('sidekiq')
+    expect(config.settings.credentials.user).to eq('0exp')
+    expect(config.settings.credentials.timeout).to eq(123)
+  end
+
+  describe ':strict mode option (when file does not exist)' do
+    context 'when :strict => true (by default)' do
+      specify 'fails with corresponding error' do
+        # check default behaviour (strict: true)
+        class FailingTomlConfig < Qonfig::DataSet
+          load_from_toml 'no_file.toml'
+        end
+
+        expect { FailingTomlConfig.new }.to raise_error(Qonfig::FileNotFoundError)
+
+        class ExplicitlyStrictedTomlConfig < Qonfig::DataSet
+          load_from_toml 'no_file.toml', strict: true
+        end
+
+        expect { ExplicitlyStrictedTomlConfig.new }.to raise_error(Qonfig::FileNotFoundError)
+      end
+    end
+
+    context 'when :strict => false' do
+      specify 'does not fail - empty config' do
+        class NonFailingTomlConfig < Qonfig::DataSet
+          load_from_toml 'no_file.toml', strict: false
+
+          setting :nested do
+            load_from_toml 'no_file.toml', strict: false
+          end
+        end
+
+        expect { NonFailingTomlConfig.new }.not_to raise_error
+        expect(NonFailingTomlConfig.new.to_h).to eq('nested' => {})
+      end
+    end
+  end
+end