tiny_dot 2.3.2 → 3.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d79073c7292e31f88919b88dcf146c42118d81e94a2e94a3bfe7712b22124bd
-  data.tar.gz: 59dff524acb74dc64ed050e2cc50ed4bd889199656782968326a5ec135ee0a9c
+  metadata.gz: f31f44aa3ecf2c601378a248041012313341a63f75db817baa6df5d82be0151e
+  data.tar.gz: 1787bff26e5ba21dfab2f696aa33bd4f17e0b35100073963db99e348e09081bc
 SHA512:
-  metadata.gz: 1dfd42dfc4bc8bf15f94a5198c80124394b6a9302c70c731b9de69acad6fb57fc22706eda6a144932bb6c11bf200f21402d5886fa8c97f98a94da25bb285dcaf
-  data.tar.gz: 7cd0fdf624c556b0993ca411a5824b5aae0f0fe453b20980b76d1a14410d125403e703eff9cec35abfbdf342bae9e90f2aea287c526c4a61227c9e08536ee019
+  metadata.gz: 9ec17f00dde5f6a9df6c7a8cb431b4bc3a349a5f84c8ffba1cbcea6b720ec1764cd635183132d6590e71e34ad49c84417b6c051bda6220bd44cb12dc7031c230
+  data.tar.gz: 25e0fc3511f15e829a886cfb9c29d7fce6d891c2af8d1032ba39fc5a062da8efbe8d6224d5091ad4923f700fae51ab64ff59974dcb89bdaca820e210b6a08c8c

data/lib/tiny_dot.rb

@@ -1,95 +1,79 @@
-require 'yaml'
-require 'json'
+require 'psych'
+require 'oj'
 
-# this class gives you read-only access to Hases, JSON, and YAML files using
-# dot notation. it makes clever use of #method_missing to allow you to do the
-# following:
+# The TinyDot module provides methods for converting data from different
+# formats (environment variables, YAML, JSON and Hashes) into a nested Struct.
+# This allows for easy access to the data using dot notation.
 #
-#   > t = TinyDot.new({ 'foo' => { 'bar' => 'baz' }})
-#   > t.foo                                               # returns another instance of TinyDot
-#  => #<TinyDot:0x0201243 @data={ 'bar' => 'baz' }>
-#   > t.foo!                                              # ! returns the value under the chain of keys
-#  => { 'bar' => 'baz' }
+# The `from_env` method converts the current environment variables into a
+# Struct.
 #
-# ... in other words, it gives you a convenient dot notation syntax for
-# accessing nested hashes. you can chain calls to this and you'll get a new
-# object that's essentially a #dig into the top-level hash.
+# The `from_yaml` method takes a string containing YAML data and converts it
+# into a Struct.
 #
-# if you add '!' to the last method in a chain it will return the value under
-# that key.
+# The `from_json` method takes a string containing JSON data and converts it
+# into a Struct.
 #
-# finally, you can use dot syntax as deep as you want, and if there's no key at
-# that level you'll just get `nil' back:
+# The `from_hash` method takes a Hash and converts it into a Struct. It really
+# just calls the `_hash_to_struct` method.
 #
-#   > t.foo.bar.baz.whatever.as.deep.as.you.want
-#  => nil
+# The `_hash_to_struct` is a private method that is used by the other methods
+# to convert the data from a hash into a Struct. It handles nested data by
+# recursively calling itself when it encounters a Hash or an array within the
+# data.
 #
-# ... which is sort of safe navigation operator-like without the safe
-# navigation operator
-class TinyDot
-  # returns a TinyDot instance from the ENV constant
-  def self.from_env
-    TinyDot.new(ENV)
-  end
-
-  # returns a TinyDot instance after parsing the YAML in the named filename
-  def self.from_yaml_file(filename, permitted_classes: [])
-    TinyDot.new(YAML.safe_load_file(filename, permitted_classes: permitted_classes))
-  end
-
-  # returns a TinyDot instance after parsing the JSON in the named filename
-  def self.from_json_file(filename)
-    TinyDot.new(JSON.parse(IO.read(filename)))
-  end
+# The `_to_attr_friendly_symbols` is a private method that is used to convert
+# keys in the hash to symbols that can be used as attributes in a Struct. It
+# replaces spaces and dashes with underscores and converts the keys to symbols.
+#
+# Please note that the JSON and YAML are required to be passed as String.
+#
+# Because this module constructs a series of nested Structs from Hash-like
+# inputs, it means you can read/write data pretty easily:
+#
+#   > s = TinyDot.from_json(<some deeply nested JSON>)
+#  => <struct ... >
+#   > s.foo.bar.baz
+#  => 5
+#   > s.foo.bar.baz = 99
+#   < s.foo.bar.baz
+#  => 99
+module TinyDot
+  class << self
+    def from_env
+      _hash_to_struct(ENV.to_h)
+    end
 
-  # returns a TinyDot instance after parsing the JSON in the string
-  def self.from_json_string(s)
-    TinyDot.new(JSON.parse(s))
-  end
+    def from_yaml(yaml_string)
+      yaml = Psych.load(yaml_string)
+      _hash_to_struct(yaml)
+    end
 
-  # give it a Hash and it'll give you dot notation over it
-  def initialize(hash={})
-    @data = hash
-  end
+    def self.from_json(json_string)
+      json = Oj.load(json_string)
+      _hash_to_struct(json)
+    end
 
-  def method_missing(m, *args)
-    val = args.first
-    ms = m.to_s
+    def self.from_hash(hash)
+      _hash_to_struct(json)
+    end
 
-    case @data
-    when Hash
-      if ms.end_with?('!')
-        @data[ms[0..-2]]
-      elsif ms.end_with?('=')
-        @data[m[0..-2]] = val
+    def _hash_to_struct(hash)
+      case hash
+      when Hash
+        struct = ::Struct.new(*_to_attr_friendly_symbols(hash.keys))
+        struct.new(*hash.values.map { |v| _hash_to_struct(v) })
+      when Array
+        hash.map { |v| _hash_to_struct(v) }
       else
-        if @data.has_key?(ms)
-          TinyDot.new(@data[ms])
-        else
-          TinyDot.new({})
-        end
+        hash
       end
-    else
-      TinyDot.new({})
     end
-  end
-
-  def ==(other)
-    @data == other.to_hash
-  end
 
-  def to_json
-    @data.to_json
-  end
-
-  # NOTE: this returns the raw hash inside of the TinyDot instance, which means
-  # if you modify anything here you're modifying the internal data in this
-  # TinyDot instance
-  def to_hash
-    @data
-  end
-
-  def to_yaml
-    @data.to_yaml
+    def _to_attr_friendly_symbols(keys)
+      keys
+        .map{|k| k.gsub(/[-\s]/, '_') }
+        .map(&:to_sym)
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: tiny_dot
 version: !ruby/object:Gem::Version
-  version: 2.3.2
+  version: 3.0.1
 platform: ruby
 authors:
 - Jeff Lunt
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-26 00:00:00.000000000 Z
+date: 2023-01-27 00:00:00.000000000 Z
 dependencies: []
 description: a tiny read/write dot notation wrapper for Hash, JSON, YAML, and ENV
 email: jefflunt@gmail.com