configly 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 88518ba064e0d9c3ce7c18929d93a5ad371954ee9b176a12f63aba62e8ab6f77
+  data.tar.gz: 0c53aa36ac509b6794f030c6e35663dc619af2d7ca8ce94437ec3b2a1d127fc1
+SHA512:
+  metadata.gz: a50da64eadde0eef9a2bc2d2e8ba3fae64dfa4326bc36533d6ae6c0932796b5026fd28270634de7799f3c9e821a4b34f0775eea8c7baf15b165c6b32be228f16
+  data.tar.gz: e30f2c68e9f938c0fc54ea0b962e6f68b614ccddb0750a2b56617dc2f0bc2b1f3811a6f128a2c04da93029e1f4e0e44ab33e938526bf80498c0933aa81da3cf4

data/README.md

@@ -0,0 +1,168 @@
+Configly - Minimal Settings Library
+==================================================
+
+[![Gem Version](https://badge.fury.io/rb/configly.svg)](https://badge.fury.io/rb/configly)
+
+Configly is a lightweight ruby Hash object with dot notation access.
+
+It is designed for loading and using YAML configuration files.
+
+---
+
+Installation
+--------------------------------------------------
+
+    $ gem install configly
+
+
+Usage
+--------------------------------------------------
+
+### Initialization
+
+Initialize a Configly object from Hash:
+
+```ruby
+# Initialize from hash
+require 'configly'
+hash = {server: {host: 'localhost', port: 3000}}
+configly = hash.to_configly
+```
+
+or by loading one or more YAML files:
+
+```ruby
+# Initialize by merging in YAML files
+config = Configly.new
+config << 'spec/fixtures/settings.yml'
+puts config.imported.settings.also
+#=> work
+```
+
+You can append additional YAML files by using either `#<<` or `#load`. 
+The '.yml' extension is optional.
+
+In addition, you may load YAML files to nested keys:
+
+```ruby
+# Loading nested YAMLs
+config = Configly.new
+config << 'spec/fixtures/settings'
+
+p config.imported.settings
+#=> {:also=>"work"}
+
+config.nested.settings.load 'spec/fixtures/settings'
+
+p config.nested.settings
+#=> {:imported=>{:settings=>{:also=>"work"}}}
+```
+
+Configly objects inherit from Hash:
+
+```ruby
+puts configly.is_a? Configly  #=> true
+puts configly.is_a? Hash      #=> true
+```
+
+### Dot notation read access
+
+Read values using dot notation:
+
+```ruby
+# Dot notation access
+puts configly.server.host
+#=> localhost
+```
+
+Reading nonexistent deep values will not raise an error:
+
+```ruby
+# Deep dot notation access
+p configly.some.deeply.nested_value
+#=> {}
+```
+
+To check if a key exists, use `?`
+
+```ruby
+# Check if a key exists
+p configly.some.deeply.nested_value?
+#=> false
+
+p configly.server.port?
+#=> true
+```
+
+To get the value or `nil` if it does not exist, use `!`:
+
+
+```ruby
+# Get value or nil
+p configly.some.deeply.nested_value!
+#=> nil
+
+p configly.server.port!
+#=> 3000
+```
+
+
+### Dot notation write access
+
+Writing values is just as easy:
+
+```ruby
+# Dot notation write access
+configly.production.server.port = 4000
+puts configly.production.server.port
+#=> 4000
+```
+
+Arrays with hashes as values, will also work (as the nested hashes will be
+coerced into Configly objects):
+
+```ruby
+# Arrays of hashes
+configly.servers = [
+  { host: 'prod1.example.com', port: 3000 },
+  { host: 'prod2.example.com', port: 4000 },
+]
+
+puts configly.servers.first.host
+#=> prod1.example.com
+
+puts configly.servers.first.is_a? Configly
+#=> true
+```
+
+### Array-like access
+
+Configly allows read/write access using the usual array/hash syntax `#[]` using
+either a string a symbol key:
+
+```ruby
+# Array access
+puts configly.server.port     #=> 3000
+puts configly.server[:port]   #=> 3000
+puts configly.server['port']  #=> 3000
+
+configly.server[:port] = 4000
+puts configly.server.port     #=> 4000
+```
+
+
+Limitations
+--------------------------------------------------
+
+Due to the fact that Configly is inheriting from Hash, and using 
+`method_missing` to allow dot notation access, your settings hashes cannot
+use keys that are defined as methods in the Hash object. 
+
+When this case is identified, a `KeyError` will be raised.
+
+```ruby
+# Reserved keys
+configly.api.key = '53cr3t'
+#=> #<KeyError: Reserved key: key>
+```
+

data/lib/configly.rb

@@ -0,0 +1,71 @@
+require 'yaml'
+require 'erb'
+require 'configly/extensions/hash'
+
+class Configly < Hash
+  def []=(key, value)
+    raise KeyError.new("Reserved key: #{key}") if respond_to? key
+    super key.to_sym, coerce_value(value)
+  end
+
+  def [](key)
+    super key.to_sym
+  end
+
+  def <<(source)
+    source = "#{source}.yml" unless source =~ /\.ya?ml$/
+    content = File.read source
+    content = YAML.load(ERB.new(content).result).to_configly
+
+    merge! content if content
+  end
+  alias_method :load, :<<
+
+  def method_missing(method, *args, &block)
+    key = method
+    string_key = key.to_s
+    return self[key] if has_key? key
+
+    suffix = nil
+
+    if string_key.end_with? *['=', '!', '?']
+      suffix = string_key[-1]
+      key = string_key[0..-2].to_sym
+    end
+
+    case suffix
+    when "="
+      val = args.first
+      val = val.to_configly if val.is_a? Hash
+      self[key] = val
+
+    when "?"
+      has_key?(key) and !(self[key].is_a?(Configly) and self[key].empty?)
+
+    when "!"
+      (has_key?(key) and !(self[key].is_a?(Configly) and self[key].empty?)) ? 
+        self[key] : nil
+
+    else
+      self[key] = self.class.new
+
+    end
+
+  end
+
+protected
+
+  def coerce_value(value)
+    case value
+    when Configly
+      value
+    when Hash
+      value = value.to_configly
+    when Array
+      value.map { |v| coerce_value v }
+    else
+      value
+    end
+  end
+
+end

data/lib/configly/extensions/hash.rb

@@ -0,0 +1,9 @@
+class Hash
+  def to_configly
+    return self if self.is_a? Configly
+
+    configly = Configly.new
+    each { |key, val| configly[key] = val }
+    configly
+  end
+end

data/lib/configly/version.rb

@@ -0,0 +1,3 @@
+class Configly < Hash
+  VERSION = '0.1.0'
+end

metadata

@@ -0,0 +1,46 @@
+--- !ruby/object:Gem::Specification
+name: configly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Danny Ben Shitrit
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-10-14 00:00:00.000000000 Z
+dependencies: []
+description: Minimal, lightweight, multi-YAML settings
+email: db@dannyben.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- lib/configly.rb
+- lib/configly/extensions/hash.rb
+- lib/configly/version.rb
+homepage: https://github.com/dannyben/configly
+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.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.4
+signing_key: 
+specification_version: 4
+summary: Minimal, lightweight, multi-YAML settings
+test_files: []