qonfig 0.25.0 → 0.26.0

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative '../../../load_setting_values_from_file/by_macros_examples'
+require_relative '../../../load_setting_values_from_file/by_instance_method_examples'
+
+describe 'Plugins(toml): Load setting values from file', plugin: :toml do
+  describe 'DSL macros (Qonfig::DataSet.values_file)' do
+    it_behaves_like(
+      'load setting values from file by macros',
+      file_format: :toml,
+      file_name: SpecSupport.fixture_path('plugins', 'toml', 'values_file', 'without_env.toml'),
+      file_with_env_name: SpecSupport.fixture_path('plugins', 'toml', 'values_file',
+                                                   'with_env.toml')
+    )
+  end
+
+  describe 'Instance methods (Qonfig::DataSet#load_from_file/.load_from_toml' do
+    it_behaves_like(
+      'load setting values from file by instance methods',
+      file_format: :toml,
+      load_by: :load_from_toml,
+      file_name: SpecSupport.fixture_path('plugins', 'toml', 'values_file', 'without_env.toml'),
+      file_with_env_name: SpecSupport.fixture_path('plugins', 'toml', 'values_file',
+                                                   'with_env.toml')
+    )
+  end
+end

data/spec/features/plugins/toml/load_setting_values_from_file/load_toml_from_self/end_data_with_env_spec.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): .values_file / #load_from_self (__END__ data with env)', plugin: :toml do
+  describe 'DSL macros' do
+    context '__END__ data has corresponding env key' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) do
+          values_file :self, format: :toml, expose: :production
+
+          setting :user, 'D@iVeR'
+          setting :queue do
+            setting :adapter, 'que'
+            setting :concurrency, 2
+          end
+        end
+      end
+
+      specify 'loads setting values of corresponding environment' do
+        config = config_klass.new
+
+        expect(config.settings.user).to eq('iAmDaiveR')
+        expect(config.settings.queue.adapter).to eq('in_memory')
+        expect(config.settings.queue.concurrency).to eq(50)
+      end
+    end
+
+    context '__END__ data does not have correspodning env key' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) do
+          values_file :self, format: :toml, expose: :staging
+
+          setting :user, 'D@iVeR'
+          setting :queue do
+            setting :adapter, 'que'
+            setting :concurrency, 2
+          end
+        end
+      end
+
+      specify 'ignrores values from __END__ data' do
+        config = config_klass.new
+
+        expect(config.settings.user).to eq('D@iVeR')
+        expect(config.settings.queue.adapter).to eq('que')
+        expect(config.settings.queue.concurrency).to eq(2)
+      end
+    end
+  end
+
+  describe 'Instance method' do
+    let(:config) do
+      Qonfig::DataSet.build do
+        setting :user, 'D@iVeR'
+        setting :queue do
+          setting :adapter, 'que'
+          setting :concurrency, 2
+        end
+      end
+    end
+
+    context '__END__ data has corresponding env key' do
+      specify 'loads setting values of corresponding environment' do
+        config.load_from_self(format: :toml, expose: :production)
+
+        expect(config.settings.user).to eq('iAmDaiveR')
+        expect(config.settings.queue.adapter).to eq('in_memory')
+        expect(config.settings.queue.concurrency).to eq(50)
+      end
+    end
+
+    context '__END__ data does not have correspodning env key' do
+      specify 'ignrores values from __END__ data' do
+        config.load_from_self(format: :toml, expose: :staging)
+
+        expect(config.settings.user).to eq('D@iVeR')
+        expect(config.settings.queue.adapter).to eq('que')
+        expect(config.settings.queue.concurrency).to eq(2)
+      end
+    end
+  end
+end
+
+__END__
+
+[test]
+user = '0exp'
+[test.queue]
+  adapter = 'sidekiq'
+  concurrency = 25
+
+[production]
+user = 'iAmDaiveR'
+[production.queue]
+  adapter = 'in_memory'
+  concurrency = 50

data/spec/features/plugins/toml/load_setting_values_from_file/load_toml_from_self/with_end_data_spec.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): .values_file / #load_from_self (with __END__ data)', plugin: :toml do
+  describe 'DSL macros' do
+    let(:config_klass) do
+      Class.new(Qonfig::DataSet) do
+        values_file :self, format: :toml
+
+        setting :user, 'D@iVeR'
+        setting :queue do
+          setting :adapter, 'que'
+          setting :concurrency, 2
+        end
+      end
+    end
+
+    specify 'loads setting values from __END__ defined as TOML instructions' do
+      config = config_klass.new
+
+      expect(config.settings.user).to eq('0exp')
+      expect(config.settings.queue.adapter).to eq('sidekiq')
+      expect(config.settings.queue.concurrency).to eq(25)
+    end
+
+    specify 'foramt of __END__ data can be inferred automatically' do
+      config = Qonfig::DataSet.build do
+        values_file :self
+
+        setting :user
+        setting :queue do
+          setting :adapter
+          setting :concurrency
+        end
+      end
+
+      expect(config.settings.user).to eq('0exp')
+      expect(config.settings.queue.adapter).to eq('sidekiq')
+      expect(config.settings.queue.concurrency).to eq(25)
+    end
+
+    specify 'fails when __END__ data has extra keys' do
+      expect do
+        Qonfig::DataSet.build { values_file :self }
+      end.to raise_error(Qonfig::UnknownSettingError)
+
+      expect do
+        Qonfig::DataSet.build do
+          values_file :self
+
+          setting :user
+          setting :queue do
+            setting :adapter
+            setting :concurrency
+          end
+        end
+      end.not_to raise_error
+    end
+  end
+
+  describe 'Instance method' do
+    let(:config_klass) do
+      Class.new(Qonfig::DataSet) do
+        setting :user, 'D@iVeR'
+        setting :queue do
+          setting :adapter, 'que'
+          setting :concurrency, 2
+        end
+      end
+    end
+
+    specify 'loads setting values from __END__ defined as TOML instructions' do
+      config = config_klass.new
+
+      expect(config.settings.user).to eq('D@iVeR')
+      expect(config.settings.queue.adapter).to eq('que')
+      expect(config.settings.queue.concurrency).to eq(2)
+
+      config.load_from_self(format: :toml)
+
+      expect(config.settings.user).to eq('0exp')
+      expect(config.settings.queue.adapter).to eq('sidekiq')
+      expect(config.settings.queue.concurrency).to eq(25)
+    end
+
+    specify 'format of __END__ data can be inferred automatically' do
+      config = config_klass.new
+      config.load_from_self
+
+      expect(config.settings.user).to eq('0exp')
+      expect(config.settings.queue.adapter).to eq('sidekiq')
+      expect(config.settings.queue.concurrency).to eq(25)
+    end
+
+    specify 'reloading process returns original values' do
+      config = config_klass.new
+      config.load_from_self
+      config.reload!
+
+      expect(config.settings.user).to eq('D@iVeR')
+      expect(config.settings.queue.adapter).to eq('que')
+      expect(config.settings.queue.concurrency).to eq(2)
+    end
+
+    specify 'fails when __END__ data has extra keys' do
+      config = Qonfig::DataSet.build {}
+      expect { config.load_from_self }.to raise_error(Qonfig::UnknownSettingError)
+
+      config = Qonfig::DataSet.build do
+        setting :user
+        setting :queue do
+          setting :adapter
+          setting :concurrency
+        end
+      end
+
+      expect { config.load_from_self }.not_to raise_error
+    end
+  end
+end
+
+__END__
+user = '0exp'
+[queue]
+  adapter = 'sidekiq'
+  concurrency = 25

data/spec/features/plugins/toml/load_setting_values_from_file/load_toml_from_self/with_incorrect_end_data_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+# rubocop:disable Layout/LineLength
+describe 'Plugins(toml): .values_file / #load_from_self (with incorrect __END__ data)', plugin: :toml do
+  describe 'DSL macros' do
+    let(:config_klass) do
+      Class.new(Qonfig::DataSet) do
+        values_file :self, format: :toml
+        setting :user, 'D@iVeR'
+      end
+    end
+
+    specify 'fails with corresponding error' do
+      expect { config_klass.new }.to raise_error(Qonfig::TOMLLoaderParseError)
+    end
+  end
+
+  describe 'Instance method' do
+    let(:config) do
+      Qonfig::DataSet.build { setting :user, 'D@iVeR' }
+    end
+
+    specify 'fails with corresponding error' do
+      expect { config.load_from_self(format: :toml) }.to raise_error(Qonfig::TOMLLoaderParseError)
+      expect(config.settings.user).to eq('D@iVeR')
+    end
+  end
+end
+# rubocop:enable Layout/LineLength
+
+__END__
+
+user = '0exp'
+asdf|"ASD"

data/spec/features/plugins/toml/load_setting_values_from_file/load_toml_from_self/without_end_data_spec.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): .values_file / #load_from_self (without __END__ data)', plugin: :toml do
+  describe 'DSL macros' do
+    context 'strict behavior' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) do
+          values_file :self, format: :toml, strict: true
+          setting :user, 'D@iVeR'
+        end
+      end
+
+      specify 'fails with Qonfig::SelfDataNotFoundError' do
+        expect { config_klass.new }.to raise_error(Qonfig::SelfDataNotFoundError)
+      end
+    end
+
+    context 'non-strict behavior (default)' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) do
+          values_file :self, format: :toml
+          setting :user, 'D@iVeR'
+        end
+      end
+
+      specify 'config instantiation works well :)' do
+        config = nil
+        expect { config = config_klass.new }.not_to raise_error
+        expect(config.settings.user).to eq('D@iVeR')
+      end
+    end
+  end
+
+  describe 'Instance method' do
+    context 'strict behavior (default)' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) { setting :user, 'D@iVeR' }
+      end
+
+      specify 'fails with Qonfig::SelfDataNotFoundError' do
+        config = config_klass.new
+
+        expect do
+          config.load_from_self(format: :toml, strict: true)
+        end.to raise_error(Qonfig::SelfDataNotFoundError)
+      end
+    end
+
+    context 'non-strict behavior' do
+      let(:config_klass) do
+        Class.new(Qonfig::DataSet) { setting :user, 'D@iVeR' }
+      end
+
+      specify 'no errors :)' do
+        config = config_klass.new
+
+        expect do
+          config.load_from_self(format: :toml, strict: false)
+        end.not_to raise_error
+
+        expect(config.settings.user).to eq('D@iVeR')
+      end
+    end
+  end
+end

data/spec/features/plugins/toml/load_setting_values_from_file/shared_behavior_spec.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+describe 'Plugin(:toml) .values_file / #load_from_file (shared behavior)', plugin: :toml do
+  describe 'unsupported format failures' do
+    describe 'DSL macros' do
+      specify 'fails on unsupported format' do
+        expect do
+          Qonfig::DataSet.build do
+            values_file :self
+          end
+        end.to raise_error(Qonfig::DynamicLoaderParseError)
+      end
+    end
+
+    describe 'Instance method' do
+      specify 'fails on unsupported format' do
+        expect do
+          Qonfig::DataSet.build.load_from_self
+        end.to raise_error(Qonfig::DynamicLoaderParseError)
+      end
+    end
+  end
+end
+
+__END__
+
+user: 0exp
+ASDF|"asSDF"
+[test]
+<xml>
+  <data>
+    <key>123</key>
+  </data>
+</xml>

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+describe 'Plugins(toml): Save to .toml (TOML)', plugin: :toml do
+  describe 'saving' do
+    let(:config_file_name) { "#{SecureRandom.uuid}.yml" }
+    let(:config_file_path) { SpecSupport.artifact_path(config_file_name) }
+    let(:config_klass) do
+      Class.new(Qonfig::DataSet) do
+        setting :sentry do
+          setting :user, 'D@iVeR'
+          setting :callback, -> { 'loaded' }
+        end
+
+        setting :server_port, 123
+        setting :cost, 123.456
+        setting :enabled, true
+
+        setting :sub_configurations, [
+          { 'server' => 'google',   'ping' => false },
+          { 'server' => 'shoklude', 'ping' => true  }
+        ]
+      end
+    end
+    let(:config) { config_klass.new }
+
+    before do
+      config.save_to_toml(path: config_file_path) do |value|
+        value.is_a?(Proc) ? value.call : value
+      end
+    end
+
+    specify 'correctly represents config as YAML' do
+      file_data = File.read(config_file_path)
+
+      expect(file_data).to eq(<<~TOML.strip << "\n")
+        cost = 123.456
+        enabled = true
+        server_port = 123
+        [sentry]
+        callback = "loaded"
+        user = "D@iVeR"
+        [[sub_configurations]]
+        ping = false
+        server = "google"
+        [[sub_configurations]]
+        ping = true
+        server = "shoklude"
+      TOML
+    end
+
+    specify 'rewrites existing file' do
+      config_a = Class.new(Qonfig::DataSet) do
+        setting :kek, 'kek'
+      end.new
+
+      config_b = Class.new(Qonfig::DataSet) do
+        setting :pek, 'pek'
+      end.new
+
+      # first save (initial write)
+      config_a.save_to_toml(path: config_file_path)
+      file_data = File.read(config_file_path) # NOTE: initial path
+      expect(file_data).to eq(<<~TOML.strip << "\n")
+        kek = "kek"
+      TOML
+
+      # subsequent save (rewrite)
+      config_b.save_to_toml(path: config_file_path)
+      file_data = File.read(config_file_path) # NOTE: same path
+      expect(file_data).to eq(<<~TOML.strip << "\n")
+        pek = "pek"
+      TOML
+    end
+  end
+
+  describe 'data representation' do
+    let(:config_file_name) { "#{SecureRandom.uuid}.yml" }
+    let(:config_file_path) { SpecSupport.artifact_path(config_file_name) }
+
+    context 'config with supported toml types' do
+      let(:config) do
+        Class.new(Qonfig::DataSet) do
+          setting :true_boolean, true
+          setting :false_boolean, false
+          setting :empty_object, {}
+          setting :filled_object, { a: 1, b: nil, 'c' => true, d: '1', e: false }
+          setting :null_data, nil
+          setting :float_value, 123.456
+          setting :collection, [%w[1 2], [3, 4], [true, false], []]
+          setting :time, Time.utc(2031, 0o5, 27, 0o7, 32, 0)
+        end.new
+      end
+
+      specify 'correctly represents YAML data types' do
+        # NOTE: step 1) save config
+        config.save_to_toml(path: config_file_path)
+
+        # NOTE: step 2) read saved file
+        file_data = File.read(config_file_path)
+
+        expect(file_data).to eq(<<~TOML.strip << "\n")
+          collection = [["1", "2"], [3, 4], [true, false], []]
+          false_boolean = false
+          float_value = 123.456
+          time = 2031-05-27T07:32:00Z
+          true_boolean = true
+          [empty_object]
+          [filled_object]
+          a = 1
+          c = true
+          d = "1"
+          e = false
+        TOML
+      end
+
+      specify 'support for Pathname in filepath' do
+        config.save_to_toml(path: Pathname.new(config_file_path))
+
+        file_data = File.read(config_file_path)
+
+        expect(file_data).to eq(<<~TOML.strip << "\n")
+          collection = [["1", "2"], [3, 4], [true, false], []]
+          false_boolean = false
+          float_value = 123.456
+          time = 2031-05-27T07:32:00Z
+          true_boolean = true
+          [empty_object]
+          [filled_object]
+          a = 1
+          c = true
+          d = "1"
+          e = false
+        TOML
+      end
+    end
+
+    context 'config with unsupported toml types' do
+      let(:config) do
+        Class.new(Qonfig::DataSet) do
+          setting :collection, [[3, 4], %w[6 4], nil]
+        end.new
+      end
+
+      specify 'fails with parser error' do
+        expect { config.save_to_toml(path: config_file_path) }.to raise_error(::TomlRB::ParseError)
+      end
+    end
+  end
+end