config-hash 0.5.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c7f537363101a24d151beb368c314f42bc796eb78ae656b35653ca2499674ed3
+  data.tar.gz: 8c8ff79e58f1801c8e930beb1edf645b9d7761ca98c9a76b043af37a3e12ba65
+SHA512:
+  metadata.gz: 326d2911fe5917de0b68c5041e82cd70a80deb2b4bff3c506185d19075105129039a8125e7fa7089068c374b56061df508697877f805a62d501f5011f7a9c7aa
+  data.tar.gz: a43d76d8d41c52e002328d3484a8b77aa48eac43e3068f3eaaf967c66ab2d164917e617bf069fafdf25531f0c60560572430b48617c8e9e99f81dfa162f0a3d7

data/.ruby-version

@@ -0,0 +1 @@
+2.5.0

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Steve Shreeve
+
+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,75 @@
+# config-hash
+
+`config-hash` is a Ruby gem that provides a safe, homoiconic, Ruby hash supporting dot notation.
+
+## Examples
+
+```ruby
+# basic config
+config.age = 33
+
+# you can use the dotenv gem to populate ENV values
+config.database = {
+  database: "movies",
+  adapter:  "mysql2",
+  host:     ENV["DB_HOST"],
+  username: ENV["DB_USER"],
+}
+
+# some nesting of values
+config.school = {
+  teachers: {
+    veterans: %w[ William Peggy Thomas ],
+    upstarts: ["Connor", "Amber", "Bob" ],
+    unsure: {
+      hired: ["Trey"],
+      processing: ["Mike", "Larry", "Tina"],
+    }
+  }
+}
+
+# ==[ Add comments, functions, and data right in the config file ]==
+
+# proc to create grouping hash
+grouper = proc do |str|
+  str.split("\n").inject({}) do |obj, row|
+    row = row.split("#", 2)[0].split(/[,|]/).map(&:strip)
+    row.each {|col| obj[col] = row[0]} if row.size > 1
+    obj
+  end
+end
+
+# supply some data to group
+config.foods = grouper[<<-end]
+  meat|chicken,beef,salmon # ,pork
+  dairy|milk,cheese,ice cream
+  # junk|candy,monster,burrito
+  dessert|cake,pie,brownies
+end
+
+# the above yields:
+# config.foods = {
+#   "meat"      => "meat",
+#   "chicken"   => "meat",
+#   "beef"      => "meat",
+#   "salmon"    => "meat",
+#   "dairy"     => "dairy",
+#   "milk"      => "dairy",
+#   "cheese"    => "dairy",
+#   "ice cream" => "dairy",
+#   "dessert"   => "dessert",
+#   "cake"      => "dessert",
+#   "pie"       => "dessert",
+#   "brownies"  => "dessert",
+# }
+
+# this allows the following:
+config.foods.cake # => "dessert"
+config.foods.mean # => "meal"
+config["foods.milk"] # => "dairy"
+config["foods.jerky"] # => nil
+```
+
+## License
+
+This software is licensed under terms of the MIT License.

data/config-hash.gemspec

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+Gem::Specification.new do |s|
+  s.name        = "config-hash"
+  s.version     = "0.5.0"
+  s.author      = "Steve Shreeve"
+  s.email       = "steve.shreeve@gmail.com"
+  s.summary     = "A safe, homoiconic, Ruby hash supporting dot notation"
+  s.description = "This gem makes it easy to work with configuration data."
+  s.homepage    = "https://github.com/shreeve/config-hash"
+  s.license     = "MIT"
+  s.files       = `git ls-files`.split("\n") - %w[.gitignore]
+end

data/lib/config-hash.rb

@@ -0,0 +1,119 @@
+Encoding.default_external = "UTF-8"
+
+class Hash
+  def -@
+    NormalHash.new.merge!(self)
+  end
+  def +@
+    ConfigHash.new(self)
+  end
+end
+
+class NormalHash < Hash
+end
+
+class ConfigHash < Hash
+  SEPARATORS = %r|[./]|
+
+  def self.load(path="config.rb", var="config")
+    path = File.expand_path(path)
+    eval <<-"end", binding, path, 0
+      #{var} ||= new
+      #{IO.read(path, encoding: 'utf-8') if File.exists?(path)}
+      #{var}
+    end
+  end
+
+  def initialize(hash=nil)
+    super()
+    merge!(hash) if hash
+  end
+
+  def import(root, glob)
+    root = File.expand_path(root)
+    pref = root.size + 1
+    Dir[File.join(root, glob)].each do |path|
+      keys = File.dirname(path[pref..-1])
+      data = ConfigHash.load(path)
+      self[keys] = data
+    end
+    self
+  end
+
+  def [](key)
+    key = key.to_s
+    if !key?(key) && key =~ SEPARATORS
+      val = self
+      key.split(SEPARATORS).each do |tag|
+        if !val.instance_of?(self.class)
+          return super(key)
+        elsif val.key?(tag)
+          val = val[tag]
+        elsif tag == "*" && val.size == 1
+          val = val[val.keys.first]
+        else
+          return super(key)
+        end
+      end
+      val
+    else
+      super(key)
+    end
+  end
+
+  def []=(key, val)
+    our = self.class
+    key = key.to_s
+    val = our.new(val) if val.instance_of?(Hash)
+    if val.instance_of?(NormalHash)
+      super(key, val)
+    elsif key =~ SEPARATORS
+      all = key.split(SEPARATORS)
+      key = all.pop
+      top = all.inject(self) do |top, tag|
+        if top.key?(tag) && (try = top[tag]).instance_of?(our)
+          top = try
+        else
+          top = top[tag] = our.new
+        end
+      end
+      top[key] = val
+    else
+      super(key, val)
+    end
+  end
+
+  alias store []=
+
+  def key?(key)
+    super(key.to_s)
+  end
+
+  def merge!(other_hash)
+    raise ArgumentError unless Hash === other_hash
+    other_hash.each do |k, v|
+      if block_given? && key?(k)
+        self[k] = yield(k, self[k], v)
+      else
+        self[k] = v
+      end
+    end
+    self
+  end
+
+  alias update merge!
+
+  def to_hash
+    Hash[self]
+  end
+
+  def method_missing(sym, *args, &block)
+    if sym =~ /=$/
+      self[$`] = args.first
+    elsif args.empty? # or... key?(sym)
+      self[sym]
+    else
+      super
+    end
+  end
+end

metadata

@@ -0,0 +1,49 @@
+--- !ruby/object:Gem::Specification
+name: config-hash
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Steve Shreeve
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-05-25 00:00:00.000000000 Z
+dependencies: []
+description: This gem makes it easy to work with configuration data.
+email: steve.shreeve@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".ruby-version"
+- Gemfile
+- LICENSE
+- README.md
+- config-hash.gemspec
+- lib/config-hash.rb
+homepage: https://github.com/shreeve/config-hash
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: A safe, homoiconic, Ruby hash supporting dot notation
+test_files: []