glob 0.2.1 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0e77de6e0858513911147e0f12aa486639c9b136943067b23b2c43ee0106a6e
-  data.tar.gz: 0e4ad98905f43a9aa30aecb71c2092e259c4b4575ecd005175c43f204cfbac36
+  metadata.gz: daa19b4757ede88d7bc2ff99732f6e0a42b33608fbbef748c21c18f73a01538c
+  data.tar.gz: c8ee66c99f7ce11218ff7fc4031ad0a53e8fe7afb9eaa0de8b9220be92c88690
 SHA512:
-  metadata.gz: 43feeab757c719fc13ccfe23731a01ca9ef3fd76ae46e839889e085591c161cd8d6ecc53d3757948b8d3d2d69ea00f8f53052b3c3bb7648d02c0022c2421ae63
-  data.tar.gz: 2d1ee931681b2c5c0dd5b626ed5ef86de36b99efe7b550c33cdd3390d4e715c005a4f8b67a93db1149ec35185d73e1fcc02b47b4a7b77920fdea788c99f8447f
+  metadata.gz: 56d9f2f4ba26236f4ce29c51a806c6a158c5576222ab2ccc7d801423a6be0ae759ef2b8db21f465d03de2f97aac4b2b7de0a21dcc9d35ceaa74397e720783014
+  data.tar.gz: 8ebc481895cc295261e1914b690ccd4b3807419564c833e258a9efccabf8f2ead910e599007e663227821ca7d03ced3dae9dc491608c832f8e0886956dce579a

data/.github/workflows/ruby-tests.yml

@@ -24,9 +24,9 @@ jobs:
           - Gemfile
 
     steps:
-      - uses: actions/checkout@v2.4.0
+      - uses: actions/checkout@v3
 
-      - uses: actions/cache@v2
+      - uses: actions/cache@v3
         with:
           path: vendor/bundle
           key: >

data/CHANGELOG.md

@@ -11,6 +11,18 @@ Prefix your message with one of the following:
 - [Security] in case of vulnerabilities.
 -->
 
+## 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.
+
 ## v0.2.1 - 2022-01-13
 
 - [Changed] .gem package now include tests files.

data/README.md

@@ -28,6 +28,9 @@ There are two types of paths: `include` and `exclude`.
 - The `exclude` path is the one started by `!`, and will prevent that path from
   being added.
 
+Rules may also have groups. Let's say you want to target `en.*` and `pt.*`; you
+case set `{en,pt}.*` rather than having two separate rules.
+
 The latest rules have more precedence; that means that if you have the rule
 `*.messages.*`, then add a following rule as `!*.messages.bye`, all
 `*.messages.*` but `*.messages.bye` will be included.
@@ -69,6 +72,38 @@ glob.to_h
 
 Notice that the return result will have symbolized keys.
 
+If the contains 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"}}
+```
+
 ## Maintainer
 
 - [Nando Vieira](https://github.com/fnando)

data/lib/glob/map.rb

@@ -13,15 +13,19 @@ module Glob
 
     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/matcher.rb

@@ -8,7 +8,9 @@ module Glob
       @path = path
       @reject = path.start_with?("!")
 
-      pattern = Regexp.escape(path.gsub(/^!/, "")).gsub(/\\\*/, "[^.]+")
+      pattern = Regexp.escape(path.gsub(/^!/, ""))
+                      .gsub(/(\\{.*?\\})/) {|match| process_group(match) }
+                      .gsub(/\\\*/, "[^.]+")
       @regex = Regexp.new("^#{pattern}")
     end
 
@@ -23,5 +25,11 @@ module Glob
     def reject?
       @reject
     end
+
+    def process_group(group)
+      group = group.gsub(/[{}\\]/, "").split(",").join("|")
+
+      "(#{group})"
+    end
   end
 end

data/lib/glob/query.rb

@@ -18,7 +18,7 @@ module Glob
       symbolized_target = SymbolizeKeys.call(@target)
 
       paths.each_with_object({}) do |path, buffer|
-        segments = path.split(".").map(&:to_sym)
+        segments = path.split(/(?<!\\)\./).map {|key| unescape(key).to_sym }
         value = symbolized_target.dig(*segments)
         set_path_value(segments, buffer, value)
       end
@@ -41,6 +41,10 @@ module Glob
       @map ||= Map.call(@target)
     end
 
+    private def unescape(key)
+      key.to_s.gsub(/\\\./, ".")
+    end
+
     private def set_path_value(segments, target, value)
       while (segment = segments.shift)
         if segments.empty?

data/lib/glob/symbolize_keys.rb

@@ -6,7 +6,7 @@ module Glob
       case target
       when Hash
         target.each_with_object({}) do |(key, value), buffer|
-          buffer[key.to_sym] = SymbolizeKeys.call(value)
+          buffer[key.to_s.to_sym] = SymbolizeKeys.call(value)
         end
       when Array
         target.map {|item| SymbolizeKeys.call(item) }

data/lib/glob/version.rb

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

data/test/glob/symbolize_keys_test.rb

@@ -4,8 +4,8 @@ require "test_helper"
 
 class SymbolizeKeysTest < Minitest::Test
   test "symbolizes hash" do
-    input = {"a" => {"b" => 1}}
-    expected = {a: {b: 1}}
+    input = {"a" => {"b" => 1}, 42 => "the answer"}
+    expected = {a: {b: 1}, "42": "the answer"}
     actual = Glob::SymbolizeKeys.call(input)
 
     assert_equal expected, actual

data/test/glob_test.rb

@@ -189,4 +189,55 @@ class GlobTest < Minitest::Test
 
     assert_equal expected, actual
   end
+
+  test "using groups as root key" do
+    glob = Glob.new(
+      pt: {hello: "Olá!"},
+      en: {hello: "Hello!"},
+      es: {hello: "¡Hola!"}
+    )
+
+    glob << "{pt,en}.*"
+
+    assert_equal ["en.hello", "pt.hello"], glob.paths
+  end
+
+  test "using groups in mixed positions" do
+    glob = Glob.new(
+      pt: {messages: {hello: "Olá!", goodbye: "Tchau!"}},
+      en: {messages: {hello: "Hello!", goodbye: "Goodbye!"}},
+      es: {messages: {hello: "¡Hola!", goodbye: "¡Adios!"}}
+    )
+
+    glob << "{pt,en}.messages.{hello,goodbye}"
+
+    expected = [
+      "en.messages.goodbye",
+      "en.messages.hello",
+      "pt.messages.goodbye",
+      "pt.messages.hello"
+    ]
+
+    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
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: glob
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - Nando Vieira
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-09-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
@@ -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.2.1
-  changelog_uri: https://github.com/fnando/glob/tree/v0.2.1/CHANGELOG.md
-  documentation_uri: https://github.com/fnando/glob/tree/v0.2.1/README.md
-  license_uri: https://github.com/fnando/glob/tree/v0.2.1/LICENSE.md
+  source_code_uri: https://github.com/fnando/glob/tree/v0.3.1
+  changelog_uri: https://github.com/fnando/glob/tree/v0.3.1/CHANGELOG.md
+  documentation_uri: https://github.com/fnando/glob/tree/v0.3.1/README.md
+  license_uri: https://github.com/fnando/glob/tree/v0.3.1/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.3
+rubygems_version: 3.3.7
 signing_key:
 specification_version: 4
 summary: Create a list of hash paths that match a given pattern. You can also generate