glob 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1364c317c2dde1a64f6f201956383cd023185d64349b101e8d167326701cc4fa
-  data.tar.gz: 76c07526698da02bb9792d29f3bafaa170fe03750f5bd335f7f80efb06114167
+  metadata.gz: 45093c60b816f8216b7f61ecf9a87d682ebed8e355812d5f182d951f5573fa50
+  data.tar.gz: 7cbeef3c989d6b06217a127ef54fca2e04dc0e26f60fb0bca27fdc69a4cc24ed
 SHA512:
-  metadata.gz: 4fcc6b11d949bb8e941794c39b6e83efc39c7fd94be7d51a2314d3b50cd7afe680448759cd28c6abe17f4f8566ba5ff31332c0806a014b1c1f4fa8a490117332
-  data.tar.gz: 5a15abeb7a6a9845fb00563f4b7ef5a53e0d432ca92f6fc239315ba38bd76fa84e1f68f9128c3aeec94834df1a2a94b50d32b3e929021af004fe1fbaab32d256
+  metadata.gz: d0fa710b8631ec0b85e9d86fb55fb666e82a709946b9209621e7da54cf41c6417056daeeba007b1b977b239e79cb86261f1af9eebe30d00b8e1926cee05f9af2
+  data.tar.gz: cb099c539ea6b9317ed8622a22c9eddd1bf25ca5ca058eb1b9a5d328aa63924c10ac825c5fcc8c3a63d4c962de1c31109d31fb03fa59412851552a531f41fbb9

data/CHANGELOG.md

@@ -11,6 +11,19 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## v0.4.0 - 2022-12-05
+
+- [Changed] `Glob::Query` has been renamed to `Glob::Object`.
+- [Added] Allow adding new keys with `glob.set(path, value)`.
+
+## v0.3.1 - 2022-09-01
+
+- [Fixed] Handle keys with dots properly by using `\\.` as a escape sequence.
+
+## v0.3.0 - 2022-08-01
+
+- [Added] Patterns can have groups like in `{a,b}.*`.
+
 ## v0.2.2 - 2022-02-01
 
 - [Fixed] Properly handle numeric keys.

data/README.md

@@ -72,6 +72,61 @@ glob.to_h
 
 Notice that the return result will have symbolized keys.
 
+If the key contain dots, then the result will use `\\.` as the escape sequence.
+Similarly, you need to escape keys with dots when filtering results.
+
+```ruby
+glob = Glob.new(
+  formats: {
+    ".txt" => "Text",
+    ".json" => "JSON",
+    ".rb" => "Ruby"
+  }
+)
+
+glob << "*"
+
+glob.paths
+#=> ["formats.\\.json", "formats.\\.rb", "formats.\\.txt"]
+
+glob.to_h
+#=> {:formats=>{:".json"=>"JSON", :".rb"=>"Ruby", :".txt"=>"Text"}}
+
+# Remove all existing matchers
+glob.matchers.clear
+
+glob << "formats.\\.rb"
+
+glob.paths
+#=> ["formats.\\.rb"]
+
+glob.to_h
+#=> {:formats=>{:".rb"=>"Ruby"}}
+```
+
+You can set new keys by using `.set(path, value)`:
+
+```ruby
+glob = Glob.new
+glob << "*"
+glob.set "a.b.c", "hello"
+
+glob.to_h
+#=> {:a=>{:b=>{:c=>"hello"}}}
+
+glob.paths
+#=> ["a.b.c"]
+
+# The non-hash value will be replaced in case the new path overlaps it
+glob.set "a.b.c.d.e", "hello"
+
+glob.to_h
+#=> {:a=>{:b=>{:c=>{:d=>{:e=>"hello"}}}}}
+
+glob.paths
+#=> ["a.b.c.d.e"]
+```
+
 ## Maintainer
 
 - [Nando Vieira](https://github.com/fnando)

data/lib/glob/map.rb

@@ -7,21 +7,24 @@ module Glob
     end
 
     def initialize(target)
-      @keys = []
       @target = target
     end
 
     def call
       @target
-        .map {|(key, value)| compute(value, key) }
+        .map {|(key, value)| compute(value, escape(key)) }
         .flatten
         .sort
     end
 
+    private def escape(key)
+      key.to_s.gsub(".", "\\.")
+    end
+
     private def compute(value, path)
       if value.is_a?(Hash)
         value.map do |key, other_value|
-          compute(other_value, "#{path}.#{key}")
+          compute(other_value, "#{path}.#{escape(key)}")
         end
       else
         path.to_s

data/lib/glob/{query.rb → object.rb}

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 module Glob
-  class Query
+  class Object
+    PATH_SPLIT_RE = /(?<!\\)\./.freeze
+
     attr_reader :matchers
 
     def initialize(target)
@@ -18,13 +20,20 @@ module Glob
       symbolized_target = SymbolizeKeys.call(@target)
 
       paths.each_with_object({}) do |path, buffer|
-        segments = path.split(".").map(&:to_sym)
+        segments = path.split(PATH_SPLIT_RE).map {|key| unescape(key).to_sym }
         value = symbolized_target.dig(*segments)
         set_path_value(segments, buffer, value)
       end
     end
     alias to_hash to_h
 
+    def set(path, value)
+      set_path_value(path.split(PATH_SPLIT_RE), @target, value)
+      @map = Map.call(@target)
+
+      nil
+    end
+
     def paths
       matches = map.map do |path|
         results = matchers.select {|matcher| matcher.match?(path) } # rubocop:disable Style/SelectByRegexp
@@ -41,12 +50,19 @@ module Glob
       @map ||= Map.call(@target)
     end
 
+    private def unescape(key)
+      key.to_s.gsub(/\\\./, ".")
+    end
+
     private def set_path_value(segments, target, value)
+      segments = segments.dup.map(&:to_sym)
+
       while (segment = segments.shift)
         if segments.empty?
           target[segment] = value
         else
           target[segment] ||= {}
+          target[segment] = {} unless target[segment].is_a?(Hash)
           target = target[segment]
         end
       end

data/lib/glob/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Glob
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/lib/glob.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
 
-require "glob/map"
-require "glob/query"
-require "glob/matcher"
-require "glob/symbolize_keys"
-require "glob/version"
+require_relative "glob/map"
+require_relative "glob/object"
+require_relative "glob/matcher"
+require_relative "glob/symbolize_keys"
+require_relative "glob/version"
 
 module Glob
   def self.filter(target, paths = ["*"])
@@ -13,7 +13,7 @@ module Glob
     glob.to_h
   end
 
-  def self.new(target)
-    Query.new(target)
+  def self.new(target = {})
+    Object.new(target)
   end
 end

data/test/glob_test.rb

@@ -220,4 +220,60 @@ class GlobTest < Minitest::Test
 
     assert_equal expected, glob.paths
   end
+
+  test "with keys that contain dots" do
+    data = {
+      "keys.with.dots" => "dots",
+      node: {
+        "more.keys.with.dots" => "more dots"
+      }
+    }
+
+    glob = Glob.new(data)
+
+    glob << "*"
+
+    assert_equal %w[keys\\.with\\.dots node.more\\.keys\\.with\\.dots],
+                 glob.paths
+    assert_equal Glob::SymbolizeKeys.call(data), glob.to_h
+
+    assert_equal ({node: {"more.keys.with.dots": "more dots"}}),
+                 Glob.filter(data, ["node.more\\.keys\\.with\\.dots"])
+  end
+
+  test "sorts set when setting new keys" do
+    data = {d: "d", a: "a", b: "b"}
+
+    glob = Glob.new(data)
+    glob << "*"
+
+    assert_equal({a: "a", b: "b", d: "d"}, glob.to_h)
+
+    glob.set("c", "c")
+    glob.set("e.b1.b2.b3", "e---b")
+    glob.set("e.a1.a2.a3", "e---a")
+
+    expected = {
+      a: "a", b: "b", c: "c", d: "d",
+      e: {a1: {a2: {a3: "e---a"}}, b1: {b2: {b3: "e---b"}}}
+    }
+
+    assert_equal(expected, glob.to_h)
+    assert_equal ["a", "b", "c", "d", "e.a1.a2.a3", "e.b1.b2.b3"], glob.paths
+  end
+
+  test "replaces existing node when setting a new path" do
+    glob = Glob.new(a: 1, b: {b1: {b2: 2}})
+    glob << "*"
+    glob.set("a.a1.a2", 4)
+    glob.set("b.b1.b2.b3", {b4: 5})
+
+    expected = {
+      a: {a1: {a2: 4}},
+      b: {b1: {b2: {b3: {b4: 5}}}}
+    }
+
+    assert_equal expected, glob.to_h
+    assert_equal ["a.a1.a2", "b.b1.b2.b3.b4"], glob.paths
+  end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glob
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-12-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -138,7 +138,7 @@ files:
 - lib/glob.rb
 - lib/glob/map.rb
 - lib/glob/matcher.rb
-- lib/glob/query.rb
+- lib/glob/object.rb
 - lib/glob/symbolize_keys.rb
 - lib/glob/version.rb
 - test/glob/map_test.rb
@@ -152,10 +152,10 @@ metadata:
   rubygems_mfa_required: 'true'
   homepage_uri: https://github.com/fnando/glob
   bug_tracker_uri: https://github.com/fnando/glob/issues
-  source_code_uri: https://github.com/fnando/glob/tree/v0.3.0
-  changelog_uri: https://github.com/fnando/glob/tree/v0.3.0/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/glob/tree/v0.3.0/README.md
-  license_uri: https://github.com/fnando/glob/tree/v0.3.0/LICENSE.md
+  source_code_uri: https://github.com/fnando/glob/tree/v0.4.0
+  changelog_uri: https://github.com/fnando/glob/tree/v0.4.0/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/glob/tree/v0.4.0/README.md
+  license_uri: https://github.com/fnando/glob/tree/v0.4.0/LICENSE.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -171,7 +171,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: Create a list of hash paths that match a given pattern. You can also generate