enumpath 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2cf0161d7c4e4278f7ab3dec41b2bd1e0c3e3afbabc4ea320bfc6f58a9d635ac
-  data.tar.gz: 4b294f03b8dc9872092aa77aa457f3b7bf8916b62874bcf4770401ff3a38e93d
+  metadata.gz: 369ec833e0f348946ea91ec684b9cccbc3e53a5bc7bae96e45b262a0988d8631
+  data.tar.gz: d73ff78feb24cb35c16ed43b0a7d3e8772bcfcd65b56a7a9a273341541b1eca6
 SHA512:
-  metadata.gz: 724900c6f9277499b34159095e1ffcb6aa0ce05b30435d09c4c3f619338429eb1619dc17650014f40719f01b7def732e2afcb9657840976040ca4a36f34ab5ac
-  data.tar.gz: ea2d09f726d6ea6f3b212314886d1d041bb4e6d807154846008362dc754f977d8a301aff202f9fc723fadebe749a5d464a73304e4157a5f994ca5ce39da7ddfd
+  metadata.gz: cbb24d41e81f8c4673e765e28e9dbea07c3fa41a3745357369fea4430f0c83a6d3cbb3eb942784c4177060ad9fe9ddcad4c0ddfcf87ba4eb6cb1854a33775b84
+  data.tar.gz: 785fb0a118331ba56750117c50c85126c3f5846ba1e403b6376b9fdaf2102267e06e54614f3c0b45eafd34a28295690b0d14357c1ad41f22433b5cc903914f8e

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve Enumpath
+title: ''
+labels: ''
+assignees: chrisbloom7
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for Enumpath
+title: ''
+labels: ''
+assignees: chrisbloom7
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/workflows/greetings.yml

@@ -0,0 +1,13 @@
+name: Greetings
+
+on: [pull_request, issues]
+
+jobs:
+  greeting:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/first-interaction@v1
+      with:
+        repo-token: ${{ secrets.GITHUB_TOKEN }}
+        # issue-message: 'TODO: Message that will be displayed on users'' first issue'
+        pr-message: 'Thanks for being interested in improving Enumpath! We welcome all kinds of contributions. There are a couple of things you should know before contributing to this repository, so be sure to [read our contributing guide](https://github.com/chrisbloom7/enumpath/blob/master/CONTRIBUTING.md) while awaiting feedback.'

data/.github/workflows/rubocop-analysis.yml

@@ -0,0 +1,47 @@
+# pulled from repo
+name: "Rubocop"
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ master ]
+  schedule:
+    - cron: '15 23 * * 6'
+
+jobs:
+  rubocop:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v2
+
+    # If running on a self-hosted runner, check it meets the requirements
+    # listed at https://github.com/ruby/setup-ruby#using-self-hosted-runners
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.6
+
+    # This step is not necessary if you add the gem to your Gemfile
+    - name: Install Code Scanning integration
+      run: bundle add code-scanning-rubocop --version 0.3.0 --skip-install
+
+    - name: Install dependencies
+      run: bundle install
+
+    - name: Rubocop run
+      run: |
+        bash -c "
+          bundle exec rubocop --enable-pending-cops --require code_scanning --format CodeScanning::SarifFormatter -o rubocop.sarif
+          [[ $? -ne 2 ]]
+        "
+
+    - name: Upload Sarif output
+      uses: github/codeql-action/upload-sarif@v1
+      with:
+        sarif_file: rubocop.sarif

data/.github/workflows/ruby.yml

@@ -0,0 +1,35 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with Rake
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: Ruby
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+    # To automatically get bug fixes and new Ruby versions for ruby/setup-ruby,
+    # change this to (see https://github.com/ruby/setup-ruby#versioning):
+    # uses: ruby/setup-ruby@v1
+      uses: ruby/setup-ruby@473e4d8fe5dd94ee328fdfca9f8c9c7afc9dae5e
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.rubocop.yml

@@ -0,0 +1,12 @@
+AllCops:
+  DisplayStyleGuide: true
+
+Metrics/BlockLength:
+  Exclude:
+  - 'enumpath.gemspec'
+  - '**/*.rake'
+  - 'spec/**/*.rb'
+
+Layout/LineLength:
+  IgnoreCopDirectives: true
+  Max: 120

data/CONTRIBUTING.md

@@ -1,18 +1,18 @@
 # Contributing
 
-Thanks for being interested in our project! We welcome [all kinds of contributions](https://opensource.guide/how-to-contribute/). There are a few things you should know before contributing to this repository:
+Thanks for being interested in improving Enumpath! We welcome [all kinds of contributions][how-to-contribute]. There are a couple of things you should know before contributing to this repository:
 
-1. All contributors must agree to our Contributor License Agreement before any merge requests will be accepted.
-2. Please first discuss the change you wish to make via issue, email, or any other method with the owners of this repository before making a change.
-3. Please note we have a code of conduct, please follow it in all your interactions with the project.
+1. Unless your changes are related to an existing issue, please first open a new issue to discuss the changes you wish to make.
+2. Please note we have a [code of conduct](#code-of-conduct), please follow it in all your interactions with the project.
+3. Code quality is important to us! Please be prepared to to address all code quality comments, whether from a CI tool like Hound or directly from our maintainers, before we can accept your changes.
 
 ## Pull Request Process
 
 1. Fork the repo.
 2. Make sure the tests pass before you begin working.
-3. Make your changes, with new passing tests. Follow the [Ruby Style Guide](https://github.com/rubocop-hq/ruby-style-guide).
-4. Push to your fork. Write a [good commit message](https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
-5. Submit a [good pull request](https://blog.github.com/2015-01-21-how-to-write-the-perfect-pull-request/).
+3. Make your changes, with new passing tests. Follow the [Ruby Style Guide][ruby-style-guide].
+4. Push to your fork using a [good commit message][a-note-about-git-commit-messages].
+5. Submit a [good pull request][how-to-write-the-perfect-pull-request] from your fork to our project.
 6. Others will give constructive feedback. This is a time for discussion and improvements, and making the necessary changes will be required before we can merge the contribution.
 
 ## Code of Conduct
@@ -72,7 +72,7 @@ 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 [INSERT EMAIL ADDRESS]. All
+reported by contacting the project team at [chrisbloom7/enumpath][enumpath-gh]. 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.
@@ -87,5 +87,10 @@ members of the project's leadership.
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
 available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
 
+[a-note-about-git-commit-messages]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[enumpath-gh]: https://github.com/chrisbloom7/enumpath
 [homepage]: https://www.contributor-covenant.org
+[how-to-contribute]: https://opensource.guide/how-to-contribute/
+[how-to-write-the-perfect-pull-request]: https://blog.github.com/2015-01-21-how-to-write-the-perfect-pull-request/
+[ruby-style-guide]: https://github.com/rubocop-hq/ruby-style-guide
 [version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,6 +1,8 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in enumpath.gemspec
 gemspec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    enumpath (0.1.1)
+    enumpath (0.1.2)
       mini_cache (~> 1.1.0)
       to_regexp (~> 0.2.1)
 
@@ -11,7 +11,7 @@ GEM
     benchmark-perf (0.2.1)
     byebug (10.0.2)
     coderay (1.1.2)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     method_source (0.9.0)
     mini_cache (1.1.0)
     null-logger (0.1.5)
@@ -21,36 +21,41 @@ GEM
     pry-byebug (3.6.0)
       byebug (~> 10.0)
       pry (~> 0.10)
-    rake (12.3.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
     rspec-benchmark (0.3.0)
       benchmark-perf (~> 0.2.0)
       rspec (>= 3.0.0, < 4.0.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.1)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rspec_junit_formatter (0.4.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     to_regexp (0.2.1)
+    yard (0.9.26)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.1)
   enumpath!
   null-logger (~> 0.1)
   pry-byebug (~> 3.6)
   rake (~> 12.3)
   rspec (~> 3.8)
   rspec-benchmark (~> 0.3.0)
+  rspec_junit_formatter (~> 0.4)
+  yard (~> 0.9.26)
 
 BUNDLED WITH
-   1.16.3
+   2.2.15

data/README.md

@@ -1,4 +1,4 @@
-# Enumpath
+# Enumpath [![Build Status][ci-image]][ci] [![Gem Version][version-image]][version] [![Reviewed by Hound][hound-badge-image]][hound]
 
 A JSONPath-compatible library for safely navigating nested Ruby objects using path expressions.
 
@@ -51,14 +51,14 @@ Or install it yourself as:
 Enumpath exposes a simple interface via `Enumpath.apply` that takes a path and an enumerable.
 
 ```ruby
-party = { food: %w(pizza tacos) }
+party = { food: %w[pizza tacos] }
 Enumpath.apply('food.0', party) # => ["pizza"]
 ```
 
 The result of `Enumpath.apply` is an array of values that were extracted according to the path. Technically it's an instance of `Enumpath::Results` which is an Array-like object that allows you to chain further calls to `.apply` like this:
 
 ```ruby
-party = { food: %w(pizza tacos) }
+party = { food: %w[pizza tacos] }
 results = Enumpath.apply('food.*', party) # => ["pizza", "tacos"]
 results.apply("[?(@ == 'pizza')]") # => ["pizza"]
 ```
@@ -66,7 +66,7 @@ results.apply("[?(@ == 'pizza')]") # => ["pizza"]
 In the event that the path doesn't match anything, an empty results set is returned:
 
 ```ruby
-party = { food: %w(pizza tacos) }
+party = { food: %w[pizza tacos] }
 Enumpath.apply("drinks.*", party) # => []
 ```
 
@@ -102,10 +102,10 @@ Child operators match on an index, key, member, or property of the enumerable. I
 
 ```
 Car = Struct.new(:color, :transmition, :owners)
-hiundai = Car.new('blue', :automatic, [{ name: 'Bill' }, { name: 'Ted' }])
+hyundai = Car.new('blue', :automatic, [{ name: 'Bill' }, { name: 'Ted' }])
 subaru = Car.new('gold', :standard, [{ name: 'Kate' }])
 jeep = Car.new('black', :automatic, [])
-garages = [{ 'cars' => [hiundai, subaru] }, { 'cars' => [jeep] }]
+garages = [{ 'cars' => [hyundai, subaru] }, { 'cars' => [jeep] }]
 Enumpath.apply('1', garages) # => [{"cars"=>[#<struct Car color="black", transmition=:automatic, owners=[]>]}]
 Enumpath.apply('0.cars.-1', garages) # => [#<struct Car color="gold", transmition=:standard, owners=[{:name=>"Kate"}]>]
 Enumpath.apply('1.cars.0.owners.length', garages) # => [0]
@@ -373,7 +373,7 @@ Enumpath.apply("$..*", store_info)
 By default, Enumpath returns the values that match the path expression. Like the original JSONPath implementation, Enumpath also supports returning path results instead of values. This can be useful for collecting static paths from dynamic paths.
 
 ```ruby
-party = { food: %w(pizza tacos) }
+party = { food: %w[pizza tacos] }
 Enumpath.apply("food.*", party, result_type: :path) # => ["$['food'][0]", "$['food'][1]"]
 ```
 
@@ -446,7 +446,7 @@ To save a little bit of time on consecutive calls Enumpath caches the normalized
 
 3. The original implementations of JSONPath allowed unchecked evaluation of filter and subscript expressions. Enumpath limits those expressions to a reasonable subset of operations as detailed in the [Operator Reference](#operator-reference) section and uses `public_send` rather than `eval` to resolve expressions as necessary.
 
-4. The original JSONPath spec did not include support for using logical operators to chain expressions in filter expression operators. This addition was inspired by [Gergely Brautigam's](https://skarlso.github.io/2017/05/28/replace-eval-with-object-send-and-a-parser/) work on [joshbuddy/jsonpath](https://github.com/joshbuddy/jsonpath)
+4. The original JSONPath spec did not include support for using logical operators to chain expressions in filter expression operators. This addition was inspired by [Gergely Brautigam's][replace-eval-with-object-send-and-a-parser] work on [joshbuddy/jsonpath][jsonpath-gh]
 
 ## Requirements
 
@@ -458,35 +458,49 @@ After checking out the repo, run `bin/setup` to install dependencies. Then, run
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at [https://github.com/youearnedit/enumpath](). Please read [CONTRIBUTING.md]() for details on our code of conduct, and the process for submitting pull requests to us.
+Bug reports and pull requests are welcome on GitHub at [chrisbloom7/enumpath][enumpath-gh]. Please read [CONTRIBUTING.md]() for details on our code of conduct, and the process for submitting pull requests to us.
 
 ## Versioning
 
-We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags](https://github.com/youearnedit/enumpath/tags) on this repository.
+We use [SemVer][semver] for versioning. For the versions available, see the [tags][tags] on this repository.
 
 ## Authors
 
-- [Chris Bloom](https://github.com/chrisbloom7) - YouEarnedIt
+- [Chris Bloom][chris-bloom-gh]
 
-See also the list of [contributors](https://github.com/youearnedit/enumpath/graphs/contributors) who participated in this project.
+See also the list of [contributors][contributors] who participated in this project.
 
 ## License
 
-Copyright 2018 YouEarnedIt.com
-
 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
 
-[www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
+[www.apache.org/licenses/LICENSE-2.0][apache-license-2-0]
 
 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
 
 ## Acknowledgements
 
-This project is maintained by the Engineering team at [YouEarnedIt](http://youearnedit.com), an employee engagement and performance metrics platform, headquartered in Austin, TX.
+This project originated from an internal project at [YouEarnedIt][youearnedit], an employee engagement and performance metrics platform, headquartered in Austin, TX.
 
 Enumpath is based on [Stefan Goessner's JSONPath spec][jsonpath], and was inspired by several similar libraries:
 
-- [nickcharlton/keypath-ruby](https://github.com/nickcharlton/keypath-ruby)
-- [joshbuddy/jsonpath](https://github.com/joshbuddy/jsonpath)
-
+- [nickcharlton/keypath-ruby][keypath-ruby]
+- [joshbuddy/jsonpath][jsonpath-gh]
+
+[apache-license-2-0]: http://www.apache.org/licenses/LICENSE-2.0
+[chris-bloom-gh]: https://github.com/chrisbloom7
+[ci]: https://circleci.com/gh/chrisbloom7/enumpath
+[ci-image]: https://circleci.com/gh/chrisbloom7/enumpath.svg?style=svg
+[contributors]: https://github.com/chrisbloom7/enumpath/graphs/contributors
+[enumpath-gh]: https://github.com/chrisbloom7/enumpath
+[hound]: https://houndci.com
+[hound-badge-image]: https://img.shields.io/badge/Reviewed_by-Hound-8E64B0.svg
 [jsonpath]: http://goessner.net/articles/JsonPath/
+[jsonpath-gh]: https://github.com/joshbuddy/jsonpath
+[keypath-ruby]: https://github.com/nickcharlton/keypath-ruby
+[replace-eval-with-object-send-and-a-parser]: https://skarlso.github.io/2017/05/28/replace-eval-with-object-send-and-a-parser/
+[semver]: http://semver.org/
+[tags]: https://github.com/chrisbloom7/enumpath/tags
+[version]: https://badge.fury.io/rb/enumpath
+[version-image]: https://badge.fury.io/rb/enumpath.svg
+[youearnedit]: http://youearnedit.com

data/Rakefile

@@ -1,10 +1,12 @@
-require "bundler/gem_tasks"
-require "rspec/core/rake_task"
-require "yard"
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'yard'
 
 RSpec::Core::RakeTask.new(:spec)
 
-task :default => :spec
+task default: :spec
 
 YARD::Rake::YardocTask.new do |t|
   t.options = ['--no-private', '-', 'LICENSE']