tty-config 0.3.1 → 0.5.1

data/lib/tty-config.rb

@@ -1 +1 @@
-require_relative 'tty/config'
+require_relative "tty/config"

metadata

@@ -1,129 +1,139 @@
 --- !ruby/object:Gem::Specification
 name: tty-config
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.5.1
 platform: ruby
 authors:
 - Piotr Murach
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2019-01-24 00:00:00.000000000 Z
+date: 2022-02-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: inifile
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: java-properties
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0.3'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: toml
+  name: rhcl
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '0.1'
 - !ruby/object:Gem::Dependency
-  name: inifile
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: toml
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
-description: Define, read and write any Ruby app configurations with a penchant for
-  terminal clients.
+        version: '0.2'
+description: A highly customisable application configuration interface for building
+  terminal tools. It supports many file formats such as YAML, JSON, TOML, INI, HCL
+  and Java Properties.
 email:
-- ''
+- piotr@piotrmurach.com
 executables: []
 extensions: []
-extra_rdoc_files: []
+extra_rdoc_files:
+- README.md
+- CHANGELOG.md
+- LICENSE.txt
 files:
 - CHANGELOG.md
 - LICENSE.txt
 - README.md
-- Rakefile
-- bin/console
-- bin/setup
 - lib/tty-config.rb
 - lib/tty/config.rb
+- lib/tty/config/dependency_loader.rb
+- lib/tty/config/generator.rb
+- lib/tty/config/marshaller.rb
+- lib/tty/config/marshaller_registry.rb
+- lib/tty/config/marshallers.rb
+- lib/tty/config/marshallers/hcl_marshaller.rb
+- lib/tty/config/marshallers/ini_marshaller.rb
+- lib/tty/config/marshallers/java_props_marshaller.rb
+- lib/tty/config/marshallers/json_marshaller.rb
+- lib/tty/config/marshallers/toml_marshaller.rb
+- lib/tty/config/marshallers/yaml_marshaller.rb
 - lib/tty/config/version.rb
-- spec/spec_helper.rb
-- spec/unit/alias_setting_spec.rb
-- spec/unit/append_spec.rb
-- spec/unit/autoload_env_spec.rb
-- spec/unit/delete_spec.rb
-- spec/unit/exist_spec.rb
-- spec/unit/fetch_spec.rb
-- spec/unit/generate_spec.rb
-- spec/unit/merge_spec.rb
-- spec/unit/new_spec.rb
-- spec/unit/normalize_hash_spec.rb
-- spec/unit/read_spec.rb
-- spec/unit/remove_spec.rb
-- spec/unit/set_from_env_spec.rb
-- spec/unit/set_if_empty_spec.rb
-- spec/unit/set_spec.rb
-- spec/unit/validate_spec.rb
-- spec/unit/write_spec.rb
-- tasks/console.rake
-- tasks/coverage.rake
-- tasks/spec.rake
-- tty-config.gemspec
-homepage: https://piotrmurach.github.io/tty
+homepage: https://ttytoolkit.org
 licenses:
 - MIT
-metadata: {}
-post_install_message: 
+metadata:
+  allowed_push_host: https://rubygems.org
+  bug_tracker_uri: https://github.com/piotrmurach/tty-config/issues
+  changelog_uri: https://github.com/piotrmurach/tty-config/blob/master/CHANGELOG.md
+  documentation_uri: https://www.rubydoc.info/gems/tty-config
+  homepage_uri: https://ttytoolkit.org
+  source_code_uri: https://github.com/piotrmurach/tty-config
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -138,10 +148,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.3
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
-summary: Define, read and write any Ruby app configurations with a penchant for terminal
-  clients.
+summary: A highly customisable application configuration interface for building terminal
+  tools.
 test_files: []

data/Rakefile

@@ -1,8 +0,0 @@
-require "bundler/gem_tasks"
-
-FileList['tasks/**/*.rake'].each(&method(:import))
-
-desc 'Run all specs'
-task ci: %w[ spec ]
-
-task default: :spec

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "tty/config"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start(__FILE__)

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here

data/spec/spec_helper.rb

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

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

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

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

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

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

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

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

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

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

@@ -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