tty-config 0.3.2 → 0.4.0

data/spec/unit/normalize_hash_spec.rb

@@ -1,21 +0,0 @@
-RSpec.describe TTY::Config, '#normalize_hash' do
-  it "normalizes keys via method to symbols" do
-    hash = {
-      "settings" => {
-        "base" => "USD",
-        "color" => true,
-        "exchange" => "CCCAGG"
-      },
-      "coins" => ["BTC", "ETH", "TRX", "DASH"]
-    }
-
-    expect(TTY::Config.normalize_hash(hash)).to eq({
-      settings: {
-        base: "USD",
-        color: true,
-        exchange: "CCCAGG"
-      },
-      coins: ["BTC", "ETH", "TRX", "DASH"]
-    })
-  end
-end

data/spec/unit/read_spec.rb

@@ -1,118 +0,0 @@
-RSpec.describe TTY::Config, '#read' do
-  it "read from an empty file" do
-    file = fixtures_path('empty.yml')
-    config = TTY::Config.new
-
-    config.read(file)
-
-    expect(config.to_hash).to eq({})
-  end
-
-  it "reads from a specified file" do
-    file = fixtures_path('investments.yml')
-    config = TTY::Config.new
-
-    config.read(file)
-
-    expect(config.fetch(:settings, :base)).to eq('USD')
-  end
-
-  it "searched for a file to read from" do
-    config = TTY::Config.new
-    config.filename = 'investments'
-    config.append_path(fixtures_path)
-
-    config.read
-
-    expect(config.fetch(:settings, :base)).to eq('USD')
-  end
-
-  it "reads from a specified file and merges with defaults" do
-    file = fixtures_path('investments.yml')
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'EUR')
-    config.set(:settings, :top, value: 50)
-
-    config.read(file)
-
-    expect(config.fetch(:settings, :base)).to eq('USD')
-    expect(config.fetch(:settings, :exchange)).to eq('CCCAGG')
-    expect(config.fetch(:settings, :top)).to eq(50)
-  end
-
-  it "reads a json format" do
-    file = fixtures_path('investments.json')
-    config = TTY::Config.new
-
-    config.read(file)
-
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.json')
-    expect(config.fetch(:settings, :base)).to eq('USD')
-    expect(config.fetch(:coins)).to eq(["BTC", "ETH", "TRX", "DASH"])
-  end
-
-  it "reads a toml format" do
-    file = fixtures_path('investments.toml')
-    config = TTY::Config.new
-
-    config.read(file)
-
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.toml')
-    expect(config.fetch(:settings, :base)).to eq('USD')
-    expect(config.fetch(:coins)).to eq(["BTC", "ETH", "TRX", "DASH"])
-  end
-
-  it "reads an ini format" do
-    file = fixtures_path('investments.ini')
-    config = TTY::Config.new
-
-    config.read(file)
-
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.ini')
-    expect(config.fetch(:settings, :base)).to eq('USD')
-    expect(config.fetch(:coins).split(',')).to eq(["BTC", "ETH", "TRX", "DASH"])
-  end
-
-  it "reads custom format" do
-    file = fixtures_path('.env')
-    config = TTY::Config.new
-
-    config.read(file, format: :ini)
-
-    expect(config.filename).to eq('.env')
-    expect(config.extname).to eq('')
-    expect(config.fetch(:settings, :base)).to eq('USD')
-    expect(config.fetch(:coins).split(',')).to eq(["BTC", "ETH", "TRX", "DASH"])
-  end
-
-  it "fails to find a file to read" do
-    config = TTY::Config.new
-    expect {
-      config.read
-    }.to raise_error(TTY::Config::ReadError,
-                    "No file found to read configuration from!")
-  end
-
-  it "fails to read a file" do
-    config = TTY::Config.new
-    file = fixtures_path('unknown.yml')
-
-    expect {
-      config.read(file)
-    }.to raise_error(TTY::Config::ReadError,
-                    "Configuration file `#{file}` does not exist!")
-  end
-
-  it "fails to load dependency for reading file format" do
-    config = TTY::Config.new
-    file = fixtures_path('investments.yml')
-    allow(config).to receive(:require).with('yaml').and_raise(LoadError)
-
-    expect {
-      config.read(file)
-    }.to raise_error(TTY::Config::ReadError, "Gem `yaml` is missing. Please install it to read .yml configuration format.")
-  end
-end

data/spec/unit/remove_spec.rb

@@ -1,16 +0,0 @@
-RSpec.describe TTY::Config, '#remove' do
-  it "removes a value from a key" do
-    config = TTY::Config.new
-    config.set(:values) { [:foo, :bar] }
-    values = config.remove(:bar, from: :values)
-    expect(values).to eq([:foo])
-    expect(config.fetch(:values)).to eq([:foo])
-  end
-
-  it "removes multiple values from a nested key" do
-    config = TTY::Config.new
-    config.set(:foo, :bar, :baz) { [1,2,3,4] }
-    config.remove(2,4, from: [:foo, :bar, :baz])
-    expect(config.fetch(:foo, :bar, :baz)).to eq([1,3])
-  end
-end

data/spec/unit/set_from_env_spec.rb

@@ -1,78 +0,0 @@
-# frozen_string_literal: true
-
-RSpec.describe TTY::Config, '#set_from_env' do
-  it "fetches env variables" do
-    allow(ENV).to receive(:[]).with('HOST').and_return('localhost')
-    allow(ENV).to receive(:[]).with('PORT').and_return('7727')
-
-    config = TTY::Config.new
-    config.set_from_env(:host)
-    config.set_from_env(:port)
-
-    expect(config.fetch(:host)).to eq('localhost')
-    expect(config.fetch(:port)).to eq('7727')
-  end
-
-  it "fetches multipart env variables" do
-    allow(ENV).to receive(:[]).with('FOO_BAR_BAZ').and_return('1')
-    config = TTY::Config.new
-    config.set_from_env(:foo_bar_baz)
-
-    expect(config.fetch(:foo_bar_baz)).to eq('1')
-  end
-
-  it "prefixes env variables" do
-    allow(ENV).to receive(:[]).with('MYTOOL_HOST').and_return('localhost')
-    allow(ENV).to receive(:[]).with('MYTOOL_PORT').and_return('7727')
-
-    config = TTY::Config.new
-    config.env_prefix = 'mytool'
-    config.set_from_env(:host)
-    config.set_from_env(:port)
-
-    expect(config.fetch(:host)).to eq('localhost')
-    expect(config.fetch(:port)).to eq('7727')
-  end
-
-  it "allows to set env vars for deeply nested keys" do
-    allow(ENV).to receive(:[]).with('HOST').and_return('localhost')
-
-    config = TTY::Config.new
-    config.set_from_env(:foo, :bar) { "HOST" }
-
-    expect(config.fetch(:foo, :bar)).to eq('localhost')
-  end
-
-  it "allows to set env vars with prefix for deeply nested keys" do
-    allow(ENV).to receive(:[]).with('MYTOOL_HOST').and_return('localhost')
-
-    config = TTY::Config.new
-    config.env_prefix = 'mytool'
-    config.set_from_env(:foo, :bar) { "HOST" }
-
-    expect(config.fetch(:foo, :bar)).to eq('localhost')
-  end
-
-  it "allows to set env vars for deeply nested keys as string" do
-    allow(ENV).to receive(:[]).with('HOST').and_return('localhost')
-
-    config = TTY::Config.new
-    config.set_from_env('foo.bar') { "HOST" }
-
-    expect(config.fetch(:foo, :bar)).to eq('localhost')
-  end
-
-  it "fails if env var is not specified for deeply nested keys as string" do
-    config = TTY::Config.new
-    expect {
-      config.set_from_env('foo.bar')
-    }.to raise_error(ArgumentError, 'Need to set env var in block')
-  end
-
-  it "fails if env var is not specified for deeply nested keys" do
-    config = TTY::Config.new
-    expect {
-      config.set_from_env(:foo, :bar)
-    }.to raise_error(ArgumentError, 'Need to set env var in block')
-  end
-end

data/spec/unit/set_if_empty_spec.rb

@@ -1,26 +0,0 @@
-RSpec.describe TTY::Config, '#set_if_empty' do
-  it "sets value for empty" do
-    config = TTY::Config.new
-    config.set_if_empty(:foo, value: :bar)
-    expect(config.fetch(:foo)).to eq(:bar)
-  end
-
-  it "sets value for empty deeply nested key" do
-    config = TTY::Config.new({foo: {}})
-    config.set_if_empty(:foo, :bar, :baz, value: 2)
-    expect(config.fetch(:foo, :bar, :baz)).to eq(2)
-  end
-
-  it "sets value for a nested key as string delimited by dot" do
-    config = TTY::Config.new
-    config.set_if_empty("foo.bar.baz", value: 1)
-    expect(config.fetch('foo', 'bar', 'baz')).to eq(1)
-  end
-
-  it "doesn't override existing value" do
-    config = TTY::Config.new
-    config.set(:foo, value: 1)
-    config.set_if_empty(:foo, value: 2)
-    expect(config.fetch(:foo)).to eq(1)
-  end
-end

data/spec/unit/set_spec.rb

@@ -1,62 +0,0 @@
-RSpec.describe TTY::Config, '#set' do
-  it "sets value" do
-    config = TTY::Config.new
-    config.set(:foo, value: :bar)
-    expect(config.fetch(:foo)).to eq(:bar)
-  end
-
-  it "sets value as block" do
-    config = TTY::Config.new
-    config.set(:foo) { "bar" }
-    expect(config.fetch(:foo)).to eq("bar")
-  end
-
-  it "sets value for deep ensted key" do
-    config = TTY::Config.new
-    value = config.set(:foo, :bar, :baz, value: 2)
-    expect(value).to eq(2)
-    expect(config.fetch(:foo, :bar, :baz)).to eq(2)
-  end
-
-  it "sets value as block for deep ensted key" do
-    config = TTY::Config.new
-    value = config.set(:foo, :bar, :baz) { 2 }
-    expect(value.call).to eq(2)
-    expect(config.fetch(:foo, :bar, :baz)).to eq(2)
-  end
-
-  it "sets value for deep nested string key delimited by ." do
-    config = TTY::Config.new
-    value = config.set("foo.bar.baz", value: 2)
-    expect(value).to eq(2)
-    expect(config.fetch('foo', 'bar', 'baz')).to eq(2)
-  end
-
-  it "sets value as block for deep nested string key delimited by ." do
-    config = TTY::Config.new
-    value = config.set("foo.bar.baz") { 2 }
-    expect(value.call).to eq(2)
-    expect(config.fetch('foo', 'bar', 'baz')).to eq(2)
-  end
-
-  it "overrides existing value" do
-    config = TTY::Config.new({foo: {bar: 1}})
-    expect(config.fetch(:foo, :bar)).to eq(1)
-    config.set(:foo, :bar) { 2 }
-    expect(config.fetch(:foo, :bar)).to eq(2)
-  end
-
-  it "raises an exception when value & block provided" do
-    config = TTY::Config.new
-    expect {
-      config.set(:foo, value: :bar) { :baz }
-    }.to raise_error(ArgumentError, "Can't set both value and block")
-  end
-
-  it "raises an exception when no value or block provided" do
-    config = TTY::Config.new
-    expect {
-      config.set(:foo, :bar, 2)
-    }.to raise_error(ArgumentError, "Need to set either value or block")
-  end
-end

data/spec/unit/validate_spec.rb

@@ -1,76 +0,0 @@
-RSpec.describe TTY::Config, '#validate' do
-  let(:validation) {
-    -> (key, value) do
-      unless value.is_a?(Integer)
-        raise TTY::Config::ValidationError, "Failed validation for key=#{key}"
-      end
-    end
-  }
-
-  it "validates string value successfully" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    config.set(:foo, :bar, value: 2)
-    expect(config.fetch(:foo, :bar)).to eq(2)
-  end
-
-  it "validates a proc value successfully" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    config.set(:foo, :bar, value: -> { 2 })
-    expect(config.fetch(:foo, :bar)).to eq(2)
-  end
-
-  it "validates a block value successfully" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    config.set(:foo, :bar) { 2 }
-    expect(config.fetch(:foo, :bar)).to eq(2)
-  end
-
-  it "raises an error when set value fails validation" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    expect {
-      config.set(:foo, :bar, value: '2')
-    }.to raise_error(TTY::Config::ValidationError,
-                    'Failed validation for key=foo.bar')
-  end
-
-  it "raises an error when set value as a proc fails validation" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    config.set(:foo, :bar, value: -> { '2' })
-    expect {
-      config.fetch(:foo, :bar)
-    }.to raise_error(TTY::Config::ValidationError,
-                     'Failed validation for key=foo.bar')
-  end
-
-  it "raises an eror when ste value as a block fails validation" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar, &validation)
-    config.set(:foo, :bar) { '2' }
-    expect {
-      config.fetch(:foo, :bar)
-    }.to raise_error(TTY::Config::ValidationError,
-                     'Failed validation for key=foo.bar')
-  end
-
-  it "applies multiple validations" do
-    config = TTY::Config.new
-    config.validate(:foo, :bar) do |key, val|
-      unless val.is_a?(Integer)
-        raise TTY::Config::ValidationError, 'Not integer'
-      end
-    end
-    config.validate(:foo, :bar) do |key, val|
-      unless val > 100
-        raise TTY::Config::ValidationError , 'Value out of range'
-      end
-    end
-    expect {
-      config.set(:foo, :bar, value: 99)
-    }.to raise_error(TTY::Config::ValidationError, 'Value out of range')
-  end
-end

data/spec/unit/write_spec.rb

@@ -1,197 +0,0 @@
-RSpec.describe TTY::Config, '#write', type: :cli do
-  it "writes configuration to a specified file" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: ['BTC', 'TRX', 'DASH'])
-    file = tmp_path('config.yml')
-
-    config.write(file)
-
-    expect(::File.read(file)).to eq <<-EOS
----
-settings:
-  base: USD
-  exchange: CCCAGG
-coins:
-- BTC
-- TRX
-- DASH
-    EOS
-  end
-
-  it "writes by default to the current directory" do
-    config = TTY::Config.new
-    config.set('settings', 'base', value: 'USD')
-    config.set('settings', 'exchange', value: 'CCCAGG')
-    config.set('coins', value: ['BTC', 'TRX', 'DASH'])
-
-    config.write
-
-    file = dir_path('config.yml')
-    expect(::File.read(file)).to eq <<-EOS
----
-settings:
-  base: USD
-  exchange: CCCAGG
-coins:
-- BTC
-- TRX
-- DASH
-    EOS
-    FileUtils.rm_rf(file)
-  end
-
-  it "doesn't override already existing file" do
-    config = TTY::Config.new
-    config.set('settings', 'base', value: 'USD')
-    file = tmp_path('config.yml')
-
-    config.write(file)
-
-    expect {
-      config.write(file)
-    }.to raise_error(TTY::Config::WriteError,
-      "File `#{file}` already exists. Use :force option to overwrite.")
-  end
-
-  it "allows to overwrite already existing file" do
-    config = TTY::Config.new
-    config.set('settings', 'base', value: 'USD')
-    file = tmp_path('config.yml')
-
-    config.write(file)
-
-    config.write(file, force: true)
-  end
-
-  it "writes json format" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: ['BTC', 'TRX', 'DASH'])
-    file = tmp_path('config.json')
-
-    config.write(file)
-
-    expect(config.extname).to eq('.json')
-    expect(::File.read(file)).to eq <<-EOS.chomp
-{
-  "settings": {
-    "base": "USD",
-    "exchange": "CCCAGG"
-  },
-  "coins": [
-    "BTC",
-    "TRX",
-    "DASH"
-  ]
-}
-EOS
-  end
-
-  it "writes toml format and assigns default filename and extension" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: ['BTC', 'TRX', 'DASH'])
-    file = tmp_path('investments.toml')
-
-    config.write(file)
-
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.toml')
-    expect(::File.read(file)).to eq <<-EOS
-coins = ["BTC","TRX","DASH"]
-
-[settings]
-base = "USD"
-exchange = "CCCAGG"
-EOS
-  end
-
-  it "allows to change default file extension" do
-    config = TTY::Config.new
-    config.filename = 'investments'
-    config.extname = '.toml'
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: ['BTC', 'TRX', 'DASH'])
-
-    config.write
-
-    file = dir_path('investments.toml')
-    expect(::File.read(file)).to eq <<-EOS
-coins = ["BTC","TRX","DASH"]
-
-[settings]
-base = "USD"
-exchange = "CCCAGG"
-EOS
-    FileUtils.rm_rf(file)
-  end
-
-  it "writes ini format and assigns default filename and extension" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: "BTC,TRX,DASH")
-    file = tmp_path('investments.ini')
-
-    config.write(file)
-
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.ini')
-    expect(::File.read(file)).to eq <<-EOS
-coins = BTC,TRX,DASH
-
-[settings]
-base = USD
-exchange = CCCAGG
-EOS
-  end
-
-  it "writes custom format with custom file extension" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    config.set(:settings, :exchange, value: 'CCCAGG')
-    config.set(:coins, value: ['BTC', 'TRX', 'DASH'])
-    file = tmp_path('investments.conf')
-
-    config.write(file, format: :yaml)
-    expect(config.filename).to eq('investments')
-    expect(config.extname).to eq('.conf')
-    expect(::File.read(file)).to eq <<-EOS
----
-settings:
-  base: USD
-  exchange: CCCAGG
-coins:
-- BTC
-- TRX
-- DASH
-EOS
-  end
-
-  it "cannot write unknown file format" do
-    config = TTY::Config.new
-    config.set(:settings, :base, value: 'USD')
-    file = tmp_path('config.txt')
-
-    expect {
-      config.write(file)
-    }.to raise_error(TTY::Config::UnsupportedExtError,
-                    "Config file format `.txt` is not supported.")
-  end
-
-  it "fails to load dependency for writing file format" do
-    config = TTY::Config.new
-    file = tmp_path('investments.yml')
-    allow(config).to receive(:require).with('yaml').and_raise(LoadError)
-    stub_const("YAML", double(dump: 'ok'))
-
-    expect {
-      config.write(file)
-    }.to raise_error(TTY::Config::WriteError, "Gem `yaml` is missing. Please install it to read .yml configuration format.")
-  end
-end