glob 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fde0d275a3a9a027d30178a5975f94d947c9fa50a184349365d7e2f7cf0c33f8
-  data.tar.gz: d69da7126314e270b9be1ed063a75027fe38e9a899633eb5dfe6ad2be974728e
+  metadata.gz: 1e44b2144da5a2fe785364209c7b4bce46a0e19768fe287b41cc8d8a7283e215
+  data.tar.gz: 774e63f4cafa984899b85599200de72785c7c2fa44a80c30ed11923495501ed6
 SHA512:
-  metadata.gz: b2d6c9bcd1926c173326a2f10bc7fddaf2adeb906cf784ddc2d41484f3396481571df1af8ee08aa383a883f5f40da949e3bfbd6ba2fe0d9b1ea6f7ae080e6c2a
-  data.tar.gz: a87b5a59497738eff53ff8e8c8765b645e849e1f2c39981ef3fde1eaef7d70dec34c9e762157c4a08308d5c37e5d18f7d5465106a8bfc5e778c3c014d5c4328e
+  metadata.gz: b52d46a9740468309250ceaadaae156db7b99eb5709a64bc36a66211a49ed37a4f7beeecce000fb4075c488651075e2f462291792b5629b441580902772d4818
+  data.tar.gz: 91046b7420418420fd507a9f09cc44f6dc50080011c81a5491af01276cecda296f6155ae4321156c294c6365be9fded1cbbb0a32e59e454857e24f923aef9f71

data/.rubocop.yml

@@ -9,3 +9,7 @@ Metrics/BlockLength:
   Exclude:
     - test/**/*_test.rb
     - glob.gemspec
+
+Metrics/ClassLength:
+  Exclude:
+    - test/**/*_test.rb

data/CHANGELOG.md

@@ -2,4 +2,9 @@
 
 ## Unreleased
 
+- Allow rejecting patterns like `!*.activerecord`.
+- New API.
+
+## v0.1.0
+
 - Initial release

data/Gemfile.lock

@@ -1,13 +1,15 @@
 PATH
   remote: .
   specs:
-    glob (0.0.0)
+    glob (0.1.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.0)
+    docile (1.3.2)
     jaro_winkler (1.5.4)
+    json (2.3.0)
     minitest (5.13.0)
     minitest-utils (0.4.6)
       minitest
@@ -25,6 +27,11 @@ GEM
       unicode-display_width (>= 1.4.0, < 1.7)
     rubocop-fnando (0.0.3)
     ruby-progressbar (1.10.1)
+    simplecov (0.17.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
     unicode-display_width (1.6.0)
 
 PLATFORMS
@@ -38,6 +45,7 @@ DEPENDENCIES
   rake
   rubocop
   rubocop-fnando
+  simplecov
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -23,6 +23,13 @@ Or install it yourself as:
 
 ## Usage
 
+There are two types of paths: `include` and `exclude`.
+
+- The `include` path adds that node to the new hash.
+- The `exclude` path is the one started by `!`, and will prevent that path from being added.
+
+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.
+
 ```ruby
 glob = Glob.new(
   site: {
@@ -38,12 +45,12 @@ glob = Glob.new(
   }
 )
 
-result = glob.query("*.settings.*")
+glob << "*.settings.*"
 
-result.paths
+glob.paths
 #=> ["site.settings.name", "site.settings.url", "user.settings.name"]
 
-result.to_h
+glob.to_h
 #=> {
 #=>   site: {
 #=>     settings: {
@@ -60,9 +67,6 @@ result.to_h
 
 Notice that the return result will have symbolized keys.
 
-If you're planning to do one-off searches, then you can use
-`Glob.query(target, paths)` instead.
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "glob"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/glob.gemspec

@@ -35,4 +35,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rubocop"
   spec.add_development_dependency "rubocop-fnando"
+  spec.add_development_dependency "simplecov"
 end

data/lib/glob.rb

@@ -2,15 +2,18 @@
 
 require "glob/map"
 require "glob/query"
-require "glob/result"
+require "glob/matcher"
+require "glob/symbolize_keys"
 require "glob/version"
 
 module Glob
-  def self.new(target)
-    Query.new(target)
+  def self.filter(target, paths = ["*"])
+    glob = new(target)
+    paths.each {|path| glob.filter(path) }
+    glob.to_h
   end
 
-  def self.query(target, query)
-    Query.new(target).query(query)
+  def self.new(target)
+    Query.new(target)
   end
 end

data/lib/glob/matcher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Glob
+  class Matcher
+    attr_reader :path, :regex
+
+    def initialize(path)
+      @path = path
+      @reject = path.start_with?("!")
+
+      pattern = Regexp.escape(path.gsub(/^!/, "")).gsub(/\\\*/, "[^.]+")
+      @regex = Regexp.new("^#{pattern}")
+    end
+
+    def match?(other)
+      other.match?(regex)
+    end
+
+    def include?
+      !reject?
+    end
+
+    def reject?
+      @reject
+    end
+  end
+end

data/lib/glob/query.rb

@@ -2,18 +2,54 @@
 
 module Glob
   class Query
+    attr_reader :matchers
+
     def initialize(target)
       @target = target
+      @matchers = []
+    end
+
+    def <<(path)
+      matchers << Matcher.new(path)
     end
+    alias filter <<
 
-    def query(search)
-      map = Map.call(@target)
-      pattern = Regexp.escape(search).gsub(/\\\*/, "[^.]+")
-      regex = Regexp.new("^#{pattern}")
+    def to_h
+      symbolized_target = SymbolizeKeys.call(@target)
+
+      paths.each_with_object({}) do |path, buffer|
+        segments = path.split(".").map(&:to_sym)
+        value = symbolized_target.dig(*segments)
+        set_path_value(segments, buffer, value)
+      end
+    end
+    alias to_hash to_h
 
-      matches = map.select {|path| path.match?(regex) }
+    def paths
+      matches = map.map do |path|
+        results = matchers.select {|matcher| matcher.match?(path) }
+        [path, results]
+      end
+
+      matches
+        .select {|(_, results)| results.compact.last&.include? }
+        .map {|(path)| path }
+        .sort
+    end
+
+    private def map
+      @map ||= Map.call(@target)
+    end
 
-      Result.new(paths: matches, target: @target)
+    private def set_path_value(segments, target, value)
+      while (segment = segments.shift)
+        if segments.empty?
+          target[segment] = value
+        else
+          target[segment] ||= {}
+          target = target[segment]
+        end
+      end
     end
   end
 end

data/lib/glob/symbolize_keys.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Glob
+  module SymbolizeKeys
+    def self.call(target)
+      case target
+      when Hash
+        target.each_with_object({}) do |(key, value), buffer|
+          buffer[key.to_sym] = SymbolizeKeys.call(value)
+        end
+      when Array
+        target.map {|item| SymbolizeKeys.call(item) }
+      else
+        target
+      end
+    end
+  end
+end

data/lib/glob/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: glob
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Nando Vieira
@@ -94,6 +94,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Create a list of hash paths that match a given pattern. You can also
   generate a hash with only the matching paths.
 email:
@@ -114,11 +128,14 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- bin/console
+- bin/setup
 - glob.gemspec
 - lib/glob.rb
 - lib/glob/map.rb
+- lib/glob/matcher.rb
 - lib/glob/query.rb
-- lib/glob/result.rb
+- lib/glob/symbolize_keys.rb
 - lib/glob/version.rb
 homepage: https://github.com/fnando/glob
 licenses:

data/lib/glob/result.rb

@@ -1,48 +0,0 @@
-# frozen_string_literal: true
-
-module Glob
-  class Result
-    def initialize(target:, paths:)
-      @target = target
-      @paths = paths
-    end
-
-    def paths
-      @paths.dup
-    end
-
-    def to_hash
-      target = symbolize_keys(@target)
-
-      @paths.each_with_object({}) do |path, buffer|
-        segments = path.split(".").map(&:to_sym)
-        value = target.dig(*segments)
-        set_path_value(segments, buffer, value)
-      end
-    end
-
-    def symbolize_keys(target)
-      case target
-      when Hash
-        target.each_with_object({}) do |(key, value), buffer|
-          buffer[key.to_sym] = symbolize_keys(value)
-        end
-      when Array
-        target.map {|item| symbolize_keys(item) }
-      else
-        target
-      end
-    end
-
-    def set_path_value(segments, target, value)
-      while (segment = segments.shift)
-        if segments.empty?
-          target[segment] = value
-        else
-          target[segment] ||= {}
-          target = target[segment]
-        end
-      end
-    end
-  end
-end