glob 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fde0d275a3a9a027d30178a5975f94d947c9fa50a184349365d7e2f7cf0c33f8
+  data.tar.gz: d69da7126314e270b9be1ed063a75027fe38e9a899633eb5dfe6ad2be974728e
+SHA512:
+  metadata.gz: b2d6c9bcd1926c173326a2f10bc7fddaf2adeb906cf784ddc2d41484f3396481571df1af8ee08aa383a883f5f40da949e3bfbd6ba2fe0d9b1ea6f7ae080e6c2a
+  data.tar.gz: a87b5a59497738eff53ff8e8c8765b645e849e1f2c39981ef3fde1eaef7d70dec34c9e762157c4a08308d5c37e5d18f7d5465106a8bfc5e778c3c014d5c4328e

data/.github/FUNDING.yml

@@ -0,0 +1,2 @@
+---
+custom: ["https://www.paypal.me/nandovieira/🍕"]

data/.github/workflows/tests.yml

@@ -0,0 +1,47 @@
+---
+name: tests
+
+on: [push]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone repo
+        uses: actions/checkout@v1
+
+      - name: Ruby cache
+        uses: actions/cache@v1
+        id: cache
+        with:
+          path: ~/local/rubies
+          key: ruby-2.6.5
+
+      - name: Rubygems cache
+        uses: actions/cache@v1
+        with:
+          path: vendor/bundle
+          key: ${{ runner.os }}-gem-${{ hashFiles('**/Gemfile.lock') }}
+          restore-keys: ${{ runner.os }}-gem-
+
+      - name: Install ruby
+        uses: clupprich/ruby-build-action@master
+        id: ruby
+        with:
+          ruby-version: 2.6.5
+          cache-available: ${{ steps.cache.outputs.cache-hit == 'true' }}
+
+      - name: Bundle install
+        run: |
+          gem install bundler
+          bundle config path vendor/bundle
+          bundle install --jobs 4 --retry 3
+
+      - name: Run ruby tests
+        run: |
+          bundle exec rake
+
+      - name: Run lint
+        run: |
+          bundle exec rubocop

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rubocop.yml

@@ -0,0 +1,11 @@
+---
+inherit_gem:
+  rubocop-fnando: .rubocop.yml
+
+AllCops:
+  TargetRubyVersion: 2.6
+
+Metrics/BlockLength:
+  Exclude:
+    - test/**/*_test.rb
+    - glob.gemspec

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 2.0.2

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## Unreleased
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at me@fnando.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in glob.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,43 @@
+PATH
+  remote: .
+  specs:
+    glob (0.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.0)
+    jaro_winkler (1.5.4)
+    minitest (5.13.0)
+    minitest-utils (0.4.6)
+      minitest
+    parallel (1.19.1)
+    parser (2.6.5.0)
+      ast (~> 2.4.0)
+    rainbow (3.0.0)
+    rake (13.0.1)
+    rubocop (0.77.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    rubocop-fnando (0.0.3)
+    ruby-progressbar (1.10.1)
+    unicode-display_width (1.6.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  glob!
+  minitest
+  minitest-utils
+  rake
+  rubocop
+  rubocop-fnando
+
+BUNDLED WITH
+   2.0.2

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Nando Vieira
+
+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,82 @@
+# Glob
+
+[![](https://github.com/fnando/glob/workflows/tests/badge.svg)](https://github.com/fnando/glob/actions?query=workflow%3Atests)
+
+Create a list of hash paths that match a given pattern. You can also generate
+a hash with only the matching paths.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "glob"
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install glob
+
+## Usage
+
+```ruby
+glob = Glob.new(
+  site: {
+    settings: {
+      name: "Site name",
+      url: "https://example.com"
+    }
+  },
+  user: {
+    settings: {
+      name: "User name"
+    }
+  }
+)
+
+result = glob.query("*.settings.*")
+
+result.paths
+#=> ["site.settings.name", "site.settings.url", "user.settings.name"]
+
+result.to_h
+#=> {
+#=>   site: {
+#=>     settings: {
+#=>       name: "Site name"
+#=>     }
+#=>   },
+#=>   user: {
+#=>     settings: {
+#=>       name: "User name"
+#=>     }
+#=>   }
+#=> }
+```
+
+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.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/fnando/glob. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Glob project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/fnando/glob/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task default: :test

data/glob.gemspec

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "./lib/glob/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "glob"
+  spec.version       = Glob::VERSION
+  spec.authors       = ["Nando Vieira"]
+  spec.email         = ["me@fnando.com"]
+
+  spec.summary       = [
+    "Create a list of hash paths that match a given pattern.",
+    "You can also generate a hash with only the matching paths."
+  ].join(" ")
+  spec.description   = spec.summary
+  spec.homepage      = "https://github.com/fnando/glob"
+  spec.license       = "MIT"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/fnando/glob"
+  spec.metadata["changelog_uri"] = "https://github.com/fnando/glob"
+
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`
+      .split("\x0")
+      .reject {|f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) {|f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-utils"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "rubocop-fnando"
+end

data/lib/glob.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "glob/map"
+require "glob/query"
+require "glob/result"
+require "glob/version"
+
+module Glob
+  def self.new(target)
+    Query.new(target)
+  end
+
+  def self.query(target, query)
+    Query.new(target).query(query)
+  end
+end

data/lib/glob/map.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Glob
+  class Map
+    def self.call(target)
+      new(target).call
+    end
+
+    def initialize(target)
+      @keys = []
+      @target = target
+    end
+
+    def call
+      @target
+        .map {|(key, value)| compute(value, key) }
+        .flatten
+        .sort
+    end
+
+    private def compute(value, path)
+      if value.is_a?(Hash)
+        value.map do |key, other_value|
+          compute(other_value, "#{path}.#{key}")
+        end
+      else
+        path.to_s
+      end
+    end
+  end
+end

data/lib/glob/query.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Glob
+  class Query
+    def initialize(target)
+      @target = target
+    end
+
+    def query(search)
+      map = Map.call(@target)
+      pattern = Regexp.escape(search).gsub(/\\\*/, "[^.]+")
+      regex = Regexp.new("^#{pattern}")
+
+      matches = map.select {|path| path.match?(regex) }
+
+      Result.new(paths: matches, target: @target)
+    end
+  end
+end

data/lib/glob/result.rb

@@ -0,0 +1,48 @@
+# 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

data/lib/glob/version.rb

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

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification
+name: glob
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nando Vieira
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2019-12-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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'
+- !ruby/object:Gem::Dependency
+  name: minitest-utils
+  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'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-fnando
+  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:
+- me@fnando.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/FUNDING.yml"
+- ".github/workflows/tests.yml"
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- glob.gemspec
+- lib/glob.rb
+- lib/glob/map.rb
+- lib/glob/query.rb
+- lib/glob/result.rb
+- lib/glob/version.rb
+homepage: https://github.com/fnando/glob
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/fnando/glob
+  source_code_uri: https://github.com/fnando/glob
+  changelog_uri: https://github.com/fnando/glob
+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: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Create a list of hash paths that match a given pattern. You can also generate
+  a hash with only the matching paths.
+test_files: []