tty-config 0.2.0 → 0.3.0

data/lib/tty/config/version.rb

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 module TTY
   class Config
-    VERSION = "0.2.0".freeze
+    VERSION = "0.3.0"
   end
 end

data/spec/spec_helper.rb

@@ -0,0 +1,54 @@
+if ENV['COVERAGE'] || ENV['TRAVIS']
+  require 'simplecov'
+  require 'coveralls'
+
+  SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
+    SimpleCov::Formatter::HTMLFormatter,
+    Coveralls::SimpleCov::Formatter
+  ]
+
+  SimpleCov.start do
+    command_name 'spec'
+    add_filter 'spec'
+  end
+end
+
+require "bundler/setup"
+require "tty/config"
+
+module TestHelpers
+  module Paths
+    def gem_root
+      File.expand_path(File.join(File.dirname(__FILE__), ".."))
+    end
+
+    def dir_path(*args)
+      path = File.join(gem_root, *args)
+      FileUtils.mkdir_p(path) unless ::File.exist?(path)
+      File.realpath(path)
+    end
+
+    def tmp_path(*args)
+      File.join(dir_path('tmp'), *args)
+    end
+
+    def fixtures_path(*args)
+      File.join(dir_path('spec/fixtures'), *args)
+    end
+
+    def within_dir(target, &block)
+      ::Dir.chdir(target, &block)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include(TestHelpers::Paths)
+  config.disable_monkey_patching!
+  config.after(:example, type: :cli) do
+    FileUtils.rm_rf(tmp_path)
+  end
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+end

data/spec/unit/alias_setting_spec.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Config, '#alias_setting' do
+  it "aliases setting key" do
+    config = TTY::Config.new
+    config.set :foo, value: :baz
+
+    config.alias_setting :foo, to: :bar
+
+    expect(config.fetch(:foo)).to eq(:baz)
+    expect(config.fetch(:bar)).to eq(:baz)
+  end
+
+  it "aliases nested key to flat key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, :baz) { 12 }
+
+    config.alias_setting(:foo, :bar, :baz, to: :flat_foo)
+
+    expect(config.fetch(:foo, :bar, :baz)).to eq(12)
+    expect(config.fetch(:flat_foo)).to eq(12)
+  end
+
+  it "aliases nested key as a string to flat key" do
+    config = TTY::Config.new
+    config.set('foo.bar.baz') { 12 }
+
+    config.alias_setting(:foo, :bar, :baz, to: :flat_foo)
+
+    expect(config.fetch(:foo, :bar, :baz)).to eq(12)
+    expect(config.fetch(:flat_foo)).to eq(12)
+  end
+
+  it "aliases nested key to nested key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, :baz) { 12 }
+
+    config.alias_setting(:foo, :bar, :baz, to: [:bee, :bop])
+
+    expect(config.fetch(:foo, :bar, :baz)).to eq(12)
+    expect(config.fetch(:bee, :bop)).to eq(12)
+  end
+
+  it "fails to alias to already existing key" do
+    config = TTY::Config.new
+    config.set(:foo, value: 1)
+    config.set(:bar, value: 2)
+
+    expect {
+      config.alias_setting(:foo, to: :bar)
+    }.to raise_error(ArgumentError, "Setting already exists with an alias ':bar'")
+  end
+
+  it "fails to alias to already existing key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, value: 1)
+    config.set(:baz, :woo, value: 2)
+
+    expect {
+      config.alias_setting(:foo, :bar, to: [:baz, :woo])
+    }.to raise_error(ArgumentError, "Setting already exists with an alias ':baz, :woo'")
+  end
+
+  it "fails to alias to matching key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, value: 1)
+
+    expect {
+      config.alias_setting(:foo, :bar, to: [:foo, :bar])
+    }.to raise_error(ArgumentError, "Alias matches setting key")
+  end
+end

data/spec/unit/append_spec.rb

@@ -0,0 +1,26 @@
+RSpec.describe TTY::Config, '#append' do
+  it "returns appended values" do
+    config = TTY::Config.new
+    values = config.append(:foo, :bar, to: :values)
+
+    expect(values).to eq([:foo, :bar])
+    expect(config.fetch(:values)).to eq([:foo, :bar])
+  end
+
+  it "appends values to already existing key" do
+    config = TTY::Config.new
+    config.set(:values) { :foo }
+    values = config.append(:bar, :baz, to: :values)
+
+    expect(config.fetch(:values)).to eq([:foo, :bar, :baz])
+    expect(values).to eq([:foo, :bar, :baz])
+  end
+
+  it "appends values to nested key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar) { 1 }
+    values = config.append(2,3, to: [:foo, :bar])
+    expect(values).to eq([1,2,3])
+    expect(config.fetch(:foo, :bar)).to eq([1,2,3])
+  end
+end

data/spec/unit/autoload_env_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Config, '#autoload_env' do
+  it "autoloads env variables" do
+    allow(ENV).to receive(:[]).with('HOST').and_return('localhost')
+    config = TTY::Config.new
+    expect(config.fetch(:host)).to eq(nil)
+
+    config.autoload_env
+
+    expect(config.fetch(:host)).to eq('localhost')
+  end
+
+  it "autoloads env variables with prefix" do
+    allow(ENV).to receive(:[]).with('MYTOOL_HOST').and_return('localhost')
+    config = TTY::Config.new
+    config.env_prefix = 'mytool'
+
+    expect(config.fetch(:host)).to eq(nil)
+
+    config.autoload_env
+
+    expect(config.fetch(:host)).to eq('localhost')
+  end
+
+  it "prioritises set over env vars" do
+    allow(ENV).to receive(:[]).with('HOST').and_return('localhost')
+    config = TTY::Config.new
+    config.autoload_env
+
+    config.set(:host, value: 'myhost')
+
+    expect(config.fetch(:host)).to eq('myhost')
+  end
+
+  it "prioritises env vars over defaults when a keyword" do
+    allow(ENV).to receive(:[]).with('PORT').and_return('7727')
+    config = TTY::Config.new
+
+    config.autoload_env
+
+    expect(config.fetch(:port, default: '3000')).to eq('7727')
+  end
+
+  it "prioritises env vars over defaults when block" do
+    allow(ENV).to receive(:[]).with('PORT').and_return('7727')
+    config = TTY::Config.new
+
+    config.autoload_env
+
+    expect(config.fetch(:port) {'3000' }).to eq('7727')
+  end
+
+  it "prioritises present configuration over env vars" do
+    allow(ENV).to receive(:[]).with('PORT').and_return('7727')
+    config = TTY::Config.new(port: '3000')
+
+    config.autoload_env
+
+    expect(config.fetch(:port)).to eq('3000')
+  end
+end

data/spec/unit/delete_spec.rb

@@ -0,0 +1,22 @@
+RSpec.describe TTY::Config, '#delete' do
+  it "deletes the value" do
+    config = TTY::Config.new
+    config.set(:foo, value: 2)
+    expect(config.delete(:foo)).to eq(2)
+    expect(config.fetch(:foo)).to eq(nil)
+  end
+
+  it "deletes the value under deeply nested key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, :baz) { 2 }
+    expect(config.delete(:foo, :bar, :baz).call).to eq(2)
+    expect(config.fetch(:foo, :bar, :baz)).to eq(nil)
+  end
+
+  it "deletes innermost key with array value" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, value: [1,2,3])
+    expect(config.delete(:foo, :bar)).to eq([1,2,3])
+    expect(config.fetch(:foo, :bar)).to eq(nil)
+  end
+end

data/spec/unit/exist_spec.rb

@@ -0,0 +1,24 @@
+RSpec.describe TTY::Config, '#exist?', type: :cli do
+  it "checks if configuration file exists" do
+    config = TTY::Config.new
+    config.append_path(tmp_path)
+
+    expect(config.exist?).to eq(false)
+
+    config.write(tmp_path('investments.yml'))
+
+    expect(config.exist?).to eq(true)
+  end
+
+  it "checks if a file without extension is present" do
+    config = TTY::Config.new
+    config.append_path tmp_path
+
+    expect(config.exist?).to eq(false)
+
+    config.write(tmp_path('investments'), format: :yml)
+
+    expect(config.exist?).to eq(true)
+    expect(config.persisted?).to eq(true)
+  end
+end

data/spec/unit/fetch_spec.rb

@@ -0,0 +1,45 @@
+RSpec.describe TTY::Config do
+  it "fetches default if no value" do
+    config = TTY::Config.new
+    expect(config.fetch(:foo, default: :bar)).to eq(:bar)
+  end
+
+  it "fetches default proc value" do
+    config = TTY::Config.new
+    expect(config.fetch(:foo, default: -> { :bar })).to eq(:bar)
+  end
+
+  it "fetches deeply nested proc value" do
+    config = TTY::Config.new
+    expect(config.fetch(:foo, default: -> { -> { :bar }})).to eq(:bar)
+  end
+
+  it "fetches default as block" do
+    config = TTY::Config.new
+    expect(config.fetch(:foo) { :bar }).to eq(:bar)
+  end
+
+  it "fetches default as block for deeply nested missing key" do
+    config = TTY::Config.new
+    expect(config.fetch(:foo, :bar, :baz) { 2 }).to eq(2)
+  end
+
+  it "fetches value for deeply nested key" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, :baz, value: 2)
+    expect(config.fetch(:foo, :bar, :baz)).to eq(2)
+  end
+
+  it "fetches value as string delimited by . for deeply nested key" do
+    config = TTY::Config.new
+    config.set('foo', 'bar', 'baz') { 2 }
+    expect(config.fetch("foo.bar.baz")).to eq(2)
+  end
+
+  it "fetches key with indifferent access" do
+    config = TTY::Config.new
+    config.set(:foo, :bar, :baz, value: 2)
+
+    expect(config.fetch('foo', :bar, 'baz')).to eq(2)
+  end
+end

data/spec/unit/generate_spec.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+RSpec.describe TTY::Config, '#generate' do
+  it "generate config content" do
+    conf = {
+      'int'   => 1,
+      'false' => false,
+      'str'   => 'hello',
+      'array' => [1,2,3],
+      'deep_array' =>  [
+        {foo: 1},
+        {bar: 2}
+      ],
+      'section' => {
+        'value' => 1,
+        'empty' => nil,
+        'array' => [1,2,3]
+      },
+      "empty" => { },
+      'nil'   => nil,
+    }
+
+    content = TTY::Config.generate(conf)
+
+    expect(content).to eq <<-EOS
+array = 1,2,3
+false = false
+int = 1
+str = hello
+
+[deep_array]
+foo = 1
+bar = 2
+
+[section]
+value = 1
+array = 1,2,3
+    EOS
+  end
+
+  it "generate config content with custom separator" do
+    conf = {
+      'str'   => 'hello',
+      'array' => [1,2,3],
+      'deep_array' =>  [
+        {foo: 1},
+        {bar: 2}
+      ],
+      'section' => {
+        'value' => 1,
+        'array' => [1,2,3]
+      }
+    }
+
+    content = TTY::Config.generate(conf, separator: ':')
+
+    expect(content).to eq <<-EOS
+array : 1,2,3
+str : hello
+
+[deep_array]
+foo : 1
+bar : 2
+
+[section]
+value : 1
+array : 1,2,3
+    EOS
+  end
+end

data/spec/unit/merge_spec.rb

@@ -0,0 +1,13 @@
+RSpec.describe TTY::Config, '#merge' do
+  it "merges nested hash" do
+    config = TTY::Config.new
+    config.set(:a, :b, value: 1)
+    config.set(:a, :c, value: 2)
+
+    config.merge({'a' => {'c' => 3, 'd' => 4}})
+
+    expect(config.fetch(:a, :b)).to eq(1)
+    expect(config.fetch(:a, :c)).to eq(3)
+    expect(config.fetch(:a, :d)).to eq(4)
+  end
+end

data/spec/unit/new_spec.rb

@@ -0,0 +1,6 @@
+RSpec.describe TTY::Config, '#new' do
+  it "sets settings through initialization" do
+    config = TTY::Config.new(foo: "bar")
+    expect(config.fetch(:foo)).to eq("bar")
+  end
+end

data/spec/unit/normalize_hash_spec.rb

@@ -0,0 +1,21 @@
+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

@@ -0,0 +1,109 @@
+RSpec.describe TTY::Config, '#read' do
+  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