tty-config 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 55d72fde5f6fbfded2c40705454c4d3cb9b92b5c
-  data.tar.gz: 5dc7c64fe76b97427b8b62141a64d3ac34faf948
+  metadata.gz: b7d2891f50d6ec7735ddf4c68e811d2b9726d5f1
+  data.tar.gz: a4c6a91a265b84c849aa7be416eb0062d9253ff7
 SHA512:
-  metadata.gz: 1076327953cebbfae39402c5c3fcb61049c7299be02903628442f8eaf8dc2c4ca1d1b8d1515bc627373fc382ea22c7f7389fe2655b06993612a8e6e0cea794e2
-  data.tar.gz: 9ee8ed6258b9eb4cd319068ef227af4f4a8bfc5bb168308d0cf193849bcc5556ae3debdcd57a5fef49250ee106303c9779d8d5c35a78ee296f5ddc5476a3892e
+  metadata.gz: 2f735b5c715194df5873b78bee19062392effc855f712659ab3fc07cd6c87737eedcc79fbce15362ecbe473df226090a3d76c00c1438f0f522c265f742141c50
+  data.tar.gz: 282c1817e5c73f18bf1be3c0b2c32d41d142a22a894ab5c528901bdfda0a573cbda9cfe74961b92dfe63ee91e89d89f2e06649cd4c208c7e85db47e226dd2ce5

data/CHANGELOG.md

@@ -1,7 +1,16 @@
 # Change log
 
+## [v0.2.0] - 2018-05-07
+
+### Added
+* Add ability to validate values for arbitrarily nested keys
+
+### Changed
+* Change to ensure that either value or block is provided when setting a value
+
 ## [v0.1.0] - 2018-04-14
 
 * Initial implementation and release
 
-[v0.1.0]: https://github.com/piotrmurach/tty-markdown/compare/v0.1.0
+[v0.2.0]: https://github.com/piotrmurach/tty-config/compare/v0.1.0...v0.2.0
+[v0.1.0]: https://github.com/piotrmurach/tty-config/compare/v0.1.0

data/README.md

@@ -44,6 +44,7 @@ Or install it yourself as:
 ## Contents
 
 * [1. Usage](#1-usage)
+  * [1.1 app](#11-app)
 * [2. Interface](#2-interface)
   * [2.1 set](#21-set)
   * [2.2 set_if_empty](#22-set_if_empty)
@@ -53,13 +54,14 @@ Or install it yourself as:
   * [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)
+  * [2.9 validate](#29-validate)
+  * [2.10 filename=](#210-filename)
+  * [2.11 extname=](#211-extname)
+  * [2.12 append_path](#212-append_path)
+  * [2.13 prepend_path](#213-prepend_path)
+  * [2.14 read](#214-read)
+  * [2.15 write](#215-write)
+  * [2.16 persisted?](#216-persisted)
 
 ## 1. Usage
 
@@ -119,6 +121,28 @@ Finally, read in configuration back again:
 config.read
 ```
 
+### 1.1 app
+
+An example of an application configuration:
+
+```ruby
+class App
+  attr_reader :config
+
+  def initialize
+    @config = TTY::Config.new
+    @config.filename = 'investments'
+    @config.extname = '.toml'
+    @config.append_path Dir.pwd
+    @config.append_path Dir.home
+  end
+
+  def self.config
+    @config ||= self.class.new.config
+  end
+end
+```
+
 ## 2. Interface
 
 ### 2.1 set
@@ -282,7 +306,36 @@ config.delete(:settings, :base)
 # "USD"
 ```
 
-### 2.9 filename=
+### 2.9 validate
+
+To ensure consistency of the data, you can validate values being set at arbitrarily deep keys using `validate` method, that takes an arbitrarily nested key as its argument and a validation block.
+
+```ruby
+config.validate(:settings, :base) do |key, value|
+  if value.length != 3
+    raise TTY::Config::ValidationError, "Currency code needs to be 3 chars long."
+  end
+end
+```
+
+You can assign multiple validations for a given key and each of them will be run in the order they were registered when checking a value.
+
+When setting value all the validaitons will be run:
+
+```ruby
+config.set(:settings, :base, value: 'PL')
+# raises TTY::Config::ValidationError, 'Currency code needs to be 3 chars long.'
+```
+
+If the value s provided as a proc or a block then the validation will be delayed until the value is actually read:
+
+```ruby
+config.set(:settings, :base) { 'PL' }
+config.fetch(:settings, :base)
+# raises TTY::Config::ValidationError, 'Currency code needs to be 3 chars long.'
+```
+
+### 2.10 filename=
 
 By default, **TTY::Config** searches for `config` named configuration file. To change this use `filename=` method without the extension name:
 
@@ -292,7 +345,7 @@ config.filename = 'investments'
 
 Then any supported extensions will be search for such as `.yml`, `.json` and `.toml`.
 
-### 2.10 extname=
+### 2.11 extname=
 
 By default '.yml' extension is used to write configuration out to a file but you can change that with `extname=`:
 
@@ -300,7 +353,7 @@ By default '.yml' extension is used to write configuration out to a file but you
 config.extname = '.toml'
 ```
 
-### 2.11 append_path
+### 2.12 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.
 
@@ -314,7 +367,7 @@ 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
+### 2.13 prepend_path
 
 The `prepend_path` allows you to add configuration search paths that should be searched first.
 
@@ -323,7 +376,7 @@ 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
+### 2.14 read
 
 There are two ways for reading configuration files and both use the `read` method.
 
@@ -346,7 +399,7 @@ However, you can also specify directly the file to read without setting up any s
 config.read('./investments.toml')
 ```
 
-### 2.14 write
+### 2.15 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:
 
@@ -376,7 +429,7 @@ config.write(force: true)                        # overwrite any found config fi
 config.write('./investments.toml', force: true)  # overwrite specific config file
 ```
 
-### 2.15 persisted?
+### 2.16 persisted?
 
 To check if a configuration file exists within the configured search paths use `persisted?` method:
 

data/lib/tty/config.rb

@@ -12,6 +12,8 @@ module TTY
     WriteError = Class.new(StandardError)
     # Erorrr raised when setting unknown file extension
     UnsupportedExtError = Class.new(StandardError)
+    # Error raised when validation assertion fails
+    ValidationError = Class.new(StandardError)
 
     def self.coerce(hash, &block)
       new(normalize_hash(hash), &block)
@@ -44,6 +46,10 @@ module TTY
     # @api public
     attr_reader :extname
 
+    # The validations for this configuration
+    # @api public
+    attr_reader :validators
+
     def initialize(settings = {})
       @location_paths = []
       @settings = settings
@@ -88,10 +94,21 @@ module TTY
     # @api public
     def set(*keys, value: nil, &block)
       assert_either_value_or_block(value, block)
+
       keys = convert_to_keys(keys)
+      key = flatten_keys(keys)
+      value_to_eval = block || value
+
+      if validators.key?(key)
+        if callable_without_params?(value_to_eval)
+          value_to_eval = delay_validation(key, value_to_eval)
+        else
+          assert_valid(key, value)
+        end
+      end
 
       deepest_setting = deep_set(@settings, *keys[0...-1])
-      deepest_setting[keys.last] = block || value
+      deepest_setting[keys.last] = value_to_eval
       deepest_setting[keys.last]
     end
 
@@ -165,6 +182,36 @@ module TTY
       deep_delete(*keys, @settings)
     end
 
+    # Register validation for a nested key
+    #
+    # @api public
+    def validate(*keys, &validator)
+      key = flatten_keys(keys)
+      values = validators[key] || []
+      values << validator
+      validators[key] = values
+    end
+
+    # Check if key passes all registered validations
+    #
+    # @api private
+    def assert_valid(key, value)
+      validators[key].each do |validator|
+        validator.call(key, value)
+      end
+    end
+
+    # Delay key validation
+    #
+    # @api private
+    def delay_validation(key, callback)
+      -> do
+        val = callback.()
+        assert_valid(key, val)
+        val
+      end
+    end
+
     # @api private
     def find_file
       @location_paths.each do |location_path|
@@ -245,8 +292,11 @@ module TTY
     end
 
     def assert_either_value_or_block(value, block)
-      return if value.nil? || block.nil?
-      raise ArgumentError, "Can't set both value and block"
+      if value.nil? && block.nil?
+        raise ArgumentError, "Need to set either value or block"
+      elsif !(value.nil? || block.nil?)
+        raise ArgumentError, "Can't set both value and block"
+      end
     end
 
     # Set value under deeply nested keys
@@ -295,6 +345,15 @@ module TTY
       end
     end
 
+    def flatten_keys(keys)
+      first_key = keys[0]
+      if first_key.to_s.include?(key_delim)
+        first_key
+      else
+        keys.join(key_delim)
+      end
+    end
+
     # Fetch value under deeply nested keys with indiffernt key access
     #
     # @param [Hash] settings

data/lib/tty/config/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tty-config
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Piotr Murach
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-04-14 00:00:00.000000000 Z
+date: 2018-05-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler