tty-config 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 55d72fde5f6fbfded2c40705454c4d3cb9b92b5c
+  data.tar.gz: 5dc7c64fe76b97427b8b62141a64d3ac34faf948
+SHA512:
+  metadata.gz: 1076327953cebbfae39402c5c3fcb61049c7299be02903628442f8eaf8dc2c4ca1d1b8d1515bc627373fc382ea22c7f7389fe2655b06993612a8e6e0cea794e2
+  data.tar.gz: 9ee8ed6258b9eb4cd319068ef227af4f4a8bfc5bb168308d0cf193849bcc5556ae3debdcd57a5fef49250ee106303c9779d8d5c35a78ee296f5ddc5476a3892e

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/Gemfile.lock
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,23 @@
+---
+language: ruby
+sudo: false
+cache: bundler
+before_install: "gem update bundler"
+script: "bundle exec rake ci"
+rvm:
+  - 2.0.0
+  - 2.1.10
+  - 2.2.8
+  - 2.3.6
+  - 2.4.3
+  - 2.5.0
+  - ruby-head
+  - jruby-9000
+  - jruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+  fast_finish: true
+branches:
+  only: master

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Change log
+
+## [v0.1.0] - 2018-04-14
+
+* Initial implementation and release
+
+[v0.1.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [email]. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,16 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :test do
+  gem 'benchmark-ips', '~> 2.7.2'
+  gem 'simplecov', '~> 0.14.1'
+  gem 'coveralls', '~> 0.8.21'
+end
+
+group :metrics do
+  gem 'yard',      '~> 0.9.12'
+  gem 'yardstick', '~> 0.9.9'
+end

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Piotr Murach
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,407 @@
+# TTY::Config [![Gitter](https://badges.gitter.im/Join%20Chat.svg)][gitter]
+
+[![Gem Version](https://badge.fury.io/rb/tty-config.svg)][gem]
+[![Build Status](https://secure.travis-ci.org/piotrmurach/tty-config.svg?branch=master)][travis]
+[![Build status](https://ci.appveyor.com/api/projects/status/2383i0dn3hlw9cnn?svg=true)][appveyor]
+[![Maintainability](https://api.codeclimate.com/v1/badges/dfac05073e1549e9dbb6/maintainability)][codeclimate]
+[![Coverage Status](https://coveralls.io/repos/github/piotrmurach/tty-config/badge.svg)][coverage]
+[![Inline docs](http://inch-ci.org/github/piotrmurach/tty-config.svg?branch=master)][inchpages]
+
+[gitter]: https://gitter.im/piotrmurach/tty
+[gem]: http://badge.fury.io/rb/tty-config
+[travis]: http://travis-ci.org/piotrmurach/tty-config
+[appveyor]: https://ci.appveyor.com/project/piotrmurach/tty-config
+[codeclimate]: https://codeclimate.com/github/piotrmurach/tty-config/maintainability
+[coverage]: https://coveralls.io/github/piotrmurach/tty-config
+[inchpages]: http://inch-ci.org/github/piotrmurach/tty-config
+
+> Define, read and write any Ruby app configurations with a penchant for terminal clients.
+
+**TTY::Config** provides app configuration component for [TTY](https://github.com/piotrmurach/tty) toolkit.
+
+## Features
+
+* Read & write configurations in YAML, JSON, TOML formats
+* Simple interface for setting and fetching values for deeply nested keys
+* Merging of configuration options from other hashes
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'tty-config'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install tty-config
+
+## Contents
+
+* [1. Usage](#1-usage)
+* [2. Interface](#2-interface)
+  * [2.1 set](#21-set)
+  * [2.2 set_if_empty](#22-set_if_empty)
+  * [2.3 fetch](#23-fetch)
+  * [2.4 merge](#24-merge)
+  * [2.5 coerce](#25-coerce)
+  * [2.6 append](#26-append)
+  * [2.7 remove](#27-remove)
+  * [2.8 delete](#28-delete)
+  * [2.9 filename=](#29-filename)
+  * [2.10 extname=](#210-extname)
+  * [2.11 append_path](#211-append_path)
+  * [2.12 prepend_path](#212-prepend_path)
+  * [2.13 read](#213-read)
+  * [2.14 write](#214-write)
+  * [2.15 persisted?](#215-persisted)
+
+## 1. Usage
+
+Initialize the configuration and provide the name:
+
+```ruby
+config = TTY::Config.new
+config.filename = 'investments'
+```
+
+then configure values for different nested keys with `set` and `append`:
+
+```ruby
+config.set(:settings, :base, value: 'USD')
+config.set(:settings, :color, value: true)
+config.set(:coins, value: ['BTC'])
+
+config.append('ETH', 'TRX', 'DASH', to: :coins)
+```
+
+get any value by using `fetch`:
+
+```ruby
+config.fetch(:settings, :base)
+# => 'USD'
+
+config.fetch(:coins)
+# => ['BTC', 'ETH', 'TRX', 'DASH']
+```
+
+and `write` configration out to `investments.yml`:
+
+```ruby
+config.write
+# =>
+# ---
+# settings:
+#   base: USD
+#   color: true
+# coins:
+#  - BTC
+#  - ETH
+#  - TRX
+#  - DASH
+```
+
+and then to read an `investments.yml` file, you need to provide the locations to search in:
+
+```ruby
+config.append_path Dir.pwd
+config.append_path Dir.home
+```
+
+Finally, read in configuration back again:
+
+```ruby
+config.read
+```
+
+## 2. Interface
+
+### 2.1 set
+
+To set configuration setting use `set` method. It accepts any number of keys and value by either using `:value` keyword argument or passing a block:
+
+```ruby
+config.set(:base, value: 'USD')
+config.set(:base) { 'USD' }
+```
+
+The block version of specifying a value will mean that the value is evaluated every time its being read.
+
+You can also specify deeply nested configuration settings by passing sequence of keys:
+
+```ruby
+config.set :settings, :base, value: 'USD'
+```
+
+is equivalent to:
+
+```ruby
+config.set 'settings.base', value: 'USD'
+```
+
+Internally all configuration settings are stored as string keys for ease of working with configuration files and command line application's inputs.
+
+### 2.2 set_if_empty
+
+To set a configuration setting only if it hasn't been set before use `set_if_empty`:
+
+```ruby
+config.set_if_empty :base, value: 'USD'
+```
+
+Similar to `set` it allows you to specify arbitrary sequence of keys followed by a key value or block:
+
+```ruby
+config.set_if_empty :settings, :base, value: 'USD'
+```
+
+### 2.3 fetch
+
+To get a configuration setting use `fetch`, which can accept default value either with a `:default` keyword or a block that will be lazy evaluated:
+
+```ruby
+config.fetch(:base, default: 'USD')
+config.fetch(:base) { 'USD' }
+```
+
+Similar to `set` operation, `fetch` allows you to retrieve deeply nested values:
+
+```ruby
+config.fetch(:settings, :base) # => USD
+```
+
+is equivalent to:
+
+```ruby
+config.fetch('settings.base')
+```
+
+`fetch` has indifferent access so you can mix string and symbol keys, all the following examples retrieve the value:
+
+```ruby
+config.fetch(:settings, :base)
+config.fetch('settings', 'base')
+config.fetch(:settings', 'base')
+config.fetch('settings', :base)
+```
+
+### 2.4 merge
+
+To merge in other configuration settings as hash use `merge`:
+
+```ruby
+config.set(:a, :b, value: 1)
+config.set(:a, :c, value: 2)
+
+config.merge({'a' => {'c' => 3, 'd' => 4}})
+
+config.fetch(:a, :c) # => 3
+config.fetch(:a, :d) # => 4
+```
+
+Internally all configuration settings are stored as string keys for ease of working with file values and command line applications inputs.
+
+### 2.5 coerce
+
+You can initialize configuration based on a hash, with all the keys converted to symbols:
+
+```ruby
+hash = {"settings" => {"base" => "USD", "exchange" => "CCCAGG"}}
+config = TTY::Config.coerce(hash)
+config.to_h
+# =>
+# {settings: {base: "USD", exchange: "CCCAGG"}}
+```
+
+### 2.6 append
+
+To append arbitrary number of values to a value under a given key use `append`:
+
+```ruby
+config.set(:coins) { ["BTC"] }
+
+config.append("ETH", "TRX", to: :coins)
+# =>
+# {coins: ["BTC", "ETH", "TRX"]}
+```
+
+You can also append values to deeply nested keys:
+
+```ruby
+config.set(:settings, :bases, value: ["USD"])
+
+config.append("EUR", "GBP", to: [:settings, :bases])
+# =>
+# {settings: {bases: ["USD", "EUR", "GBP"]}}
+```
+
+### 2.7 remove
+
+Use `remove` to remove a set of values from a key.
+
+```ruby
+config.set(:coins, value: ["BTC", "TRX", "ETH", "DASH"])
+
+config.remove("TRX", "DASH", from: :coins)
+# =>
+# ["BTC", "ETH"]
+```
+
+If the key is nested the `:from` accepts an array:
+
+```ruby
+config.set(:holdings, :coins, value: ["BTC", "TRX", "ETH", "DASH"])
+
+config.remove("TRX", "DASH", from: [:holdings, :coins])
+# =>
+# ["BTC", "ETH"]
+```
+
+### 2.8 delete
+
+To completely delete a value and corresponding key use `delete`:
+
+```ruby
+config.set(:base, "USD")
+config.delete(:base)
+# =>
+# "USD"
+```
+
+You can also delete deeply nested keys and their values:
+
+```ruby
+config.set(:settings, :base, "USD")
+config.delete(:settings, :base)
+# =>
+# "USD"
+```
+
+### 2.9 filename=
+
+By default, **TTY::Config** searches for `config` named configuration file. To change this use `filename=` method without the extension name:
+
+```ruby
+config.filename = 'investments'
+```
+
+Then any supported extensions will be search for such as `.yml`, `.json` and `.toml`.
+
+### 2.10 extname=
+
+By default '.yml' extension is used to write configuration out to a file but you can change that with `extname=`:
+
+```ruby
+config.extname = '.toml'
+```
+
+### 2.11 append_path
+
+You need to tell the **TTY::Config** where to search for configuration files. To search multiple paths for a configuration file use `append_path` or `prepend_path` methods.
+
+For example, if you want to search through `/etc` directory first, then user home directory and then current directory do:
+
+```ruby
+config.append_path("/etc/")   # look in /etc directory
+config.append_path(Dir.home)  # look in user's home directory
+config.append_path(Dir.pwd)   # look in current working directory
+```
+
+None of these paths are required, but you should provide at least one path if you wish to read configuration file.
+
+### 2.12 prepend_path
+
+The `prepend_path` allows you to add configuration search paths that should be searched first.
+
+```ruby
+config.append_path(Dir.pwd)   # look in current working directory second
+config.prepend_path(Dir.home) # look in user's home directory first
+```
+
+### 2.13 read
+
+There are two ways for reading configuration files and both use the `read` method.
+
+First one, searches through provided locations to find configuration file and read it. Therefore, you need to specify at least one search path that contains the configuration file.
+
+```ruby
+config.append_path(Dir.pwd)       # look in current working directory
+config.filename = 'investments'   # file to search for
+```
+
+Find and read the configuration file:
+
+```ruby
+config.read
+```
+
+However, you can also specify directly the file to read without setting up any search paths or filenames:
+
+```ruby
+config.read('./investments.toml')
+```
+
+### 2.14 write
+
+By default **TTY::Config**, persists configuration file in the current working directory with a `config.yml` name. However, you can change that by specifying the filename and extension type:
+
+```ruby
+config.filename = 'investments'
+config.extname = '.toml'
+```
+
+To write current configuration to a file, you can either specified direct location path and filename:
+
+```ruby
+config.write('./investments.toml')
+```
+
+Or, specify location paths to be searched for already existing configuration to overwrite:
+
+```ruby
+config.append_path(Dir.pwd)  # search current working directory
+
+config.write
+```
+
+To create configuration file regardless whether it exists or not, use `:force` flag:
+
+```ruby
+config.write(force: true)                        # overwrite any found config file
+config.write('./investments.toml', force: true)  # overwrite specific config file
+```
+
+### 2.15 persisted?
+
+To check if a configuration file exists within the configured search paths use `persisted?` method:
+
+```ruby
+config.persisted? # => true
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/tty-config. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Tty::Config project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/piotrmurach/tty-config/blob/master/CODE_OF_CONDUCT.md).
+
+## Copyright
+
+Copyright (c) 2018 Piotr Murach. See LICENSE for further details.

data/Rakefile

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

data/appveyor.yml

@@ -0,0 +1,23 @@
+---
+install:
+  - SET PATH=C:\Ruby%ruby_version%\bin;%PATH%
+  - ruby --version
+  - gem --version
+  - bundle install
+build: off
+test_script:
+  - bundle exec rake ci
+environment:
+  matrix:
+    - ruby_version: "200"
+    - ruby_version: "200-x64"
+    - ruby_version: "21"
+    - ruby_version: "21-x64"
+    - ruby_version: "22"
+    - ruby_version: "22-x64"
+    - ruby_version: "23"
+    - ruby_version: "23-x64"
+    - ruby_version: "24"
+    - ruby_version: "24-x64"
+    - ruby_version: "25"
+    - ruby_version: "25-x64"

data/bin/console

@@ -0,0 +1,14 @@
+#!/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

@@ -0,0 +1,8 @@
+#!/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/lib/tty-config.rb

@@ -0,0 +1 @@
+require_relative 'tty/config'

data/lib/tty/config.rb

@@ -0,0 +1,408 @@
+# frozen_string_literal: true
+
+require 'pathname'
+
+require_relative 'config/version'
+
+module TTY
+  class Config
+    # Error raised when key fails validation
+    ReadError = Class.new(StandardError)
+    # Error raised when issues writing configuration to a file
+    WriteError = Class.new(StandardError)
+    # Erorrr raised when setting unknown file extension
+    UnsupportedExtError = Class.new(StandardError)
+
+    def self.coerce(hash, &block)
+      new(normalize_hash(hash), &block)
+    end
+
+    # Convert string keys via method
+    #
+    # @api private
+    def self.normalize_hash(hash, method = :to_sym)
+      hash.reduce({}) do |acc, (key, val)|
+        value = val.is_a?(::Hash) ? normalize_hash(val, method) : val
+        acc[key.public_send(method)] = value
+        acc
+      end
+    end
+
+    # A collection of config paths
+    # @api public
+    attr_reader :location_paths
+
+    # The key delimiter used for specifying deeply nested keys
+    # @api public
+    attr_reader :key_delim
+
+    # The name of the configuration file without extension
+    # @api public
+    attr_accessor :filename
+
+    # The name of the configuration file extension
+    # @api public
+    attr_reader :extname
+
+    def initialize(settings = {})
+      @location_paths = []
+      @settings = settings
+      @validators = {}
+      @filename = 'config'
+      @extname = '.yml'
+      @extensions = ['.yaml', '.yml', '.json', '.toml']
+      @key_delim = '.'
+
+      yield(self) if block_given?
+    end
+
+    # Set extension name
+    #
+    # @raise [TTY::Config::UnsupportedExtError]
+    #
+    # api public
+    def extname=(name)
+      unless @extensions.include?(name)
+        raise UnsupportedExtError, "Config file format `#{name}` is not supported."
+      end
+      @extname = name
+    end
+
+    # Add path to locations to search in
+    #
+    # @api public
+    def append_path(path)
+      @location_paths << path
+    end
+
+    # Insert location path at the begining
+    #
+    # @api public
+    def prepend_path(path)
+      @location_paths.unshift(path)
+    end
+
+    # Set a value for a composite key and overrides any existing keys.
+    # Keys are case-insensitive
+    #
+    # @api public
+    def set(*keys, value: nil, &block)
+      assert_either_value_or_block(value, block)
+      keys = convert_to_keys(keys)
+
+      deepest_setting = deep_set(@settings, *keys[0...-1])
+      deepest_setting[keys.last] = block || value
+      deepest_setting[keys.last]
+    end
+
+    # Set a value for a composite key if not present already
+    #
+    # @param [Array[String|Symbol]] keys
+    #   the keys to set value for
+    #
+    # @api public
+    def set_if_empty(*keys, value: nil, &block)
+      return unless deep_find(@settings, keys.last.to_s).nil?
+      block ? set(*keys, &block) : set(*keys, value: value)
+    end
+
+    # Fetch value under a composite key
+    #
+    # @param [Array[String|Symbol]] keys
+    #   the keys to get value at
+    # @param [Object] default
+    #
+    # @api public
+    def fetch(*keys, default: nil, &block)
+      keys = convert_to_keys(keys)
+      value = deep_fetch(@settings, *keys)
+      value = block || default if value.nil?
+      while callable_without_params?(value)
+        value = value.call
+      end
+      value
+    end
+
+    # Merge in other configuration settings
+    #
+    # @param [Hash[Object]] other_settings
+    #
+    # @api public
+    def merge(other_settings)
+      @settings = deep_merge(@settings, other_settings)
+    end
+
+    # Append values to an already existing nested key
+    #
+    # @param [Array[String|Symbol]] values
+    #   the values to append
+    #
+    # @api public
+    def append(*values, to: nil)
+      keys = Array(to)
+      set(*keys, value: Array(fetch(*keys)) + values)
+    end
+
+    # Remove a set of values from a nested key
+    #
+    # @param [Array[String|Symbol]] keys
+    #   the keys for a value removal
+    #
+    # @api public
+    def remove(*values, from: nil)
+      keys = Array(from)
+      set(*keys, value: Array(fetch(*keys)) - values)
+    end
+
+    # Delete a value from a nested key
+    #
+    # @param [Array[String|Symbol]] keys
+    #   the keys for a value deletion
+    #
+    # @api public
+    def delete(*keys)
+      keys = convert_to_keys(keys)
+      deep_delete(*keys, @settings)
+    end
+
+    # @api private
+    def find_file
+      @location_paths.each do |location_path|
+        path = search_in_path(location_path)
+        return path if path
+      end
+      nil
+    end
+    alias source_file find_file
+
+    # Check if configuration file exists
+    #
+    # @return [Boolean]
+    #
+    # @api public
+    def persisted?
+      !find_file.nil?
+    end
+
+    # Find and read a configuration file.
+    #
+    # If the file doesn't exist or if there is an error loading it
+    # the TTY::Config::ReadError will be raised.
+    #
+    # @param [String] file
+    #   the path to the configuration file to be read
+    #
+    # @raise [TTY::Config::ReadError]
+    #
+    # @api public
+    def read(file = find_file)
+      if file.nil?
+        raise ReadError, "No file found to read configuration from!"
+      elsif !::File.exist?(file)
+        raise ReadError, "Configuration file `#{file}` does not exist!"
+      end
+
+      merge(unmarshal(file))
+    end
+
+    # Write current configuration to a file.
+    #
+    # @param [String] file
+    #   the path to a file
+    #
+    # @api public
+    def write(file = find_file, force: false)
+      if file && ::File.exist?(file)
+        if !force
+          raise WriteError, "File `#{file}` already exists. " \
+                            "Use :force option to overwrite."
+        elsif !::File.writable?(file)
+          raise WriteError, "Cannot write to #{file}."
+        end
+      end
+
+      if file.nil?
+        dir = @location_paths.empty? ? Dir.pwd : @location_paths.first
+        file = ::File.join(dir, "#{filename}#{@extname}")
+      end
+
+      marshal(file, @settings)
+    end
+
+    # Current configuration
+    #
+    # @api public
+    def to_hash
+      @settings.dup
+    end
+    alias to_h to_hash
+
+    private
+
+    def callable_without_params?(object)
+      object.respond_to?(:call) &&
+        (!object.respond_to?(:arity) || object.arity.zero?)
+    end
+
+    def assert_either_value_or_block(value, block)
+      return if value.nil? || block.nil?
+      raise ArgumentError, "Can't set both value and block"
+    end
+
+    # Set value under deeply nested keys
+    #
+    # The scan starts with the top level key and follows
+    # a sequence of keys. In case where intermediate keys do
+    # not exist, a new hash is created.
+    #
+    # @param [Hash] settings
+    #
+    # @param [Array[Object]]
+    #   the keys to nest
+    #
+    # @api private
+    def deep_set(settings, *keys)
+      return settings if keys.empty?
+      key, *rest = *keys
+      value = settings[key]
+
+      if value.nil? && rest.empty?
+        settings[key] = {}
+      elsif value.nil? && !rest.empty?
+        settings[key] = {}
+        deep_set(settings[key], *rest)
+      else # nested hash value present
+        settings[key] = value
+        deep_set(settings[key], *rest)
+      end
+    end
+
+    def deep_find(settings, key, found = nil)
+      if settings.respond_to?(:key?) && settings.key?(key)
+        settings[key]
+      elsif settings.is_a?(Enumerable)
+        settings.each { |obj| found = deep_find(obj, key) }
+        found
+      end
+    end
+
+    def convert_to_keys(keys)
+      first_key = keys[0]
+      if first_key.to_s.include?(key_delim)
+        first_key.split(key_delim)
+      else
+        keys.map(&:to_s)
+      end
+    end
+
+    # Fetch value under deeply nested keys with indiffernt key access
+    #
+    # @param [Hash] settings
+    #
+    # @param [Array[Object]] keys
+    #
+    # @api private
+    def deep_fetch(settings, *keys)
+      key, *rest = keys
+      value = settings.fetch(key.to_s, settings[key.to_sym])
+      if value.nil? || rest.empty?
+        value
+      else
+        deep_fetch(value, *rest)
+      end
+    end
+
+    # @api private
+    def deep_merge(this_hash, other_hash,  &block)
+      this_hash.merge(other_hash) do |key, this_val, other_val|
+        if this_val.is_a?(::Hash) && other_val.is_a?(::Hash)
+          deep_merge(this_val, other_val, &block)
+        elsif block_given?
+          block[key, this_val, other_val]
+        else
+          other_val
+        end
+      end
+    end
+
+    # @api private
+    def deep_delete(*keys, settings)
+      key, *rest = keys
+      value = settings[key]
+      if !value.nil? && value.is_a?(::Hash)
+        deep_delete(*rest, value)
+      elsif !value.nil?
+        settings.delete(key)
+      end
+    end
+
+    # @api private
+    def search_in_path(path)
+      path = Pathname.new(path)
+      @extensions.each do |ext|
+        if ::File.exist?(path.join("#{filename}#{ext}").to_s)
+          return path.join("#{filename}#{ext}").to_s
+        end
+      end
+      nil
+    end
+
+    # @api private
+    def unmarshal(file)
+      ext = ::File.extname(file)
+      self.extname = ext
+      self.filename = ::File.basename(file, ext)
+      gem_name = nil
+
+      case ext
+      when '.yaml', '.yml'
+        require 'yaml'
+        if YAML.respond_to?(:safe_load)
+          YAML.safe_load(File.read(file))
+        else
+          YAML.load(File.read(file))
+        end
+      when '.json'
+        require 'json'
+        JSON.parse(File.read(file))
+      when '.toml'
+        gem_name = 'toml'
+        require 'toml'
+        TOML.load(::File.read(file))
+      else
+        raise ReadError, "Config file format `#{ext}` is not supported."
+      end
+    rescue LoadError
+      puts "Please install `#{gem_name}`"
+      raise ReadError, "Gem `#{gem_name}` is missing. Please install it " \
+                       "to read #{ext} configuration format."
+    end
+
+    # @api private
+    def marshal(file, data)
+      ext = ::File.extname(file)
+      self.extname = ext
+      self.filename = ::File.basename(file, ext)
+      gem_name = nil
+
+      case ext
+      when '.yaml', '.yml'
+        require 'yaml'
+        ::File.write(file, YAML.dump(self.class.normalize_hash(data, :to_s)))
+      when '.json'
+        require 'json'
+        ::File.write(file, JSON.pretty_generate(data))
+      when '.toml'
+        gem_name = 'toml'
+        require 'toml'
+        ::File.write(file, TOML::Generator.new(data).body)
+      else
+        raise WriteError, "Config file format `#{ext}` is not supported."
+      end
+    rescue LoadError
+      puts "Please install `#{gem_name}`"
+      raise ReadError, "Gem `#{gem_name}` is missing. Please install it " \
+                       "to read #{ext} configuration format."
+    end
+  end # Config
+end # TTY

data/lib/tty/config/version.rb

@@ -0,0 +1,5 @@
+module TTY
+  class Config
+    VERSION = "0.1.0".freeze
+  end
+end

data/tasks/console.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Load gem inside irb console'
+task :console do
+  require 'irb'
+  require 'irb/completion'
+  require File.join(__FILE__, '../../lib/tty-config')
+  ARGV.clear
+  IRB.start
+end
+task c: %w[ console ]

data/tasks/coverage.rake

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+desc 'Measure code coverage'
+task :coverage do
+  begin
+    original, ENV['COVERAGE'] = ENV['COVERAGE'], 'true'
+    Rake::Task['spec'].invoke
+  ensure
+    ENV['COVERAGE'] = original
+  end
+end

data/tasks/spec.rake

@@ -0,0 +1,29 @@
+# encoding: utf-8
+
+begin
+  require 'rspec/core/rake_task'
+
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |task|
+    task.pattern = 'spec/{unit,integration}{,/*/**}/*_spec.rb'
+  end
+
+  namespace :spec do
+    desc 'Run unit specs'
+    RSpec::Core::RakeTask.new(:unit) do |task|
+      task.pattern = 'spec/unit{,/*/**}/*_spec.rb'
+    end
+
+    desc 'Run integration specs'
+    RSpec::Core::RakeTask.new(:integration) do |task|
+      task.pattern = 'spec/integration{,/*/**}/*_spec.rb'
+    end
+  end
+
+rescue LoadError
+  %w[spec spec:unit spec:integration].each do |name|
+    task name do
+      $stderr.puts "In order to run #{name}, do `gem install rspec`"
+    end
+  end
+end

data/tty-config.gemspec

@@ -0,0 +1,29 @@
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "tty/config/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "tty-config"
+  spec.version       = TTY::Config::VERSION
+  spec.authors       = ["Piotr Murach"]
+  spec.email         = [""]
+
+  spec.summary       = %q{Define, read and write any Ruby app configurations with a penchant for terminal clients.}
+  spec.description   = %q{Define, read and write any Ruby app configurations with a penchant for terminal clients.}
+  spec.homepage      = "https://piotrmurach.github.io/tty"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "toml", "~> 0.2.0"
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: tty-config
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Piotr Murach
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-04-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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: 0.2.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+description: Define, read and write any Ruby app configurations with a penchant for
+  terminal clients.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- appveyor.yml
+- bin/console
+- bin/setup
+- lib/tty-config.rb
+- lib/tty/config.rb
+- lib/tty/config/version.rb
+- tasks/console.rake
+- tasks/coverage.rake
+- tasks/spec.rake
+- tty-config.gemspec
+homepage: https://piotrmurach.github.io/tty
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Define, read and write any Ruby app configurations with a penchant for terminal
+  clients.
+test_files: []