qig 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 292d057f6d955c48f359653bfacee7ccdc90185efa7bfa36dc206174e851d4ce
-  data.tar.gz: 6da1eed1a718565ebb32e24db46653f14db85a0e9481a6c85e18098bc24dde70
+  metadata.gz: f92505d2904e0032d3fcd5b33f03540a7ce8d09080bc50a534ede7e2daecf686
+  data.tar.gz: 16caa89894a03819be080591bd729b89ddfb743712122fff401b18e2e2ba0ae9
 SHA512:
-  metadata.gz: 92e236a404eec68a4a58d02a76b054e2c269519339e01f5762602a247d20dfaf9e115dea42e05823be9d48a36cad2cd35dc36dce7bc68743dd86f83b09ce9e0a
-  data.tar.gz: 4bef37ce773fb8b8872a645dbe1f2ab7dbc90671e994bb7b12c8b5f4484072b6a0168438a801975d24f8a59d934398328b3062cb2f13f59359e26fb4c342acfc
+  metadata.gz: ab2d2ace58c87bc6117a20d9ca2e6b1d329398cd5ce895fb2f206abb5f66a06782b4f8d3d48716719e2a67f7091f6e938aebc9bc7e329652782583952b82533a
+  data.tar.gz: 9362297e8f6feb6a9f390302ae7d12093877fdd3215f5894b366a05b41330093479b027745b6579ff546bba4f27a79f539d5f985ed89c1a87c07d663acdbe9c7

data/.rubocop.yml

@@ -1,5 +1,12 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
+  NewCops: enable
 
 Layout/LineLength:
   Max: 120
+
+Metrics/BlockLength:
+  IgnoredMethods: ['describe', 'context']
+
+Style/DocumentationMethod:
+  Enabled: true

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/CHANGELOG.md

@@ -1,3 +1,48 @@
+# 0.3.0 (January 24, 2022)
+
+## BREAKING CHANGES
+
+- drop ruby 2.6 support, because Ruby 2.6 will be EOL in 2 months, and Ruby 2.7 pattern matching syntax makes
+  command parsing cases *much* easier to maintain, keeping the main switching logic a single-level `case`
+
+## Features
+
+- method invocation syntax (e.g. for filtering)
+- quoting syntax to use operators as literal keys
+- reboxing operator or value collection operator, inverse of the value iteration operator
+
+## Documentation
+
+- Reorganize and explain literate specs
+- Specs for dig conformance
+
+## Fixes
+
+- On invalid access to struct, return nil, for better conformance to Struct#dig. Previously this raised error.
+
+# 0.2.0 (January 14, 2022)
+
+## Features
+
+- Value iteration(`[]` over hashes)
+
+## Documentation
+
+- Initial yard documentation on method and module
+- Document and spec that we can qig into Structs and OpenStructs
+
+# 0.1.3 (January 13, 2022)
+
+## Documentation
+
+- fix changelog uri (again)
+
+# 0.1.2 (January 13, 2022)
+
+## Documentation
+
+- fix changelog uri
+
 # 0.1.1 (January 13, 2022)
 
 ## Documentation
@@ -10,4 +55,4 @@
 ## Features
 
 - Ability to qig into arrays and hashes
-- Value iteration (`[]`) over arrays
+- Value iteration (`[]`) over arrays

data/Gemfile

@@ -5,10 +5,11 @@ source 'https://rubygems.org'
 # Specify your gem's dependencies in qig.gemspec
 gemspec
 
+gem 'pry', '~> 0.14.1'
 gem 'rake', '~> 13.0'
-
 gem 'rspec', '~> 3.0'
-
+gem 'rspec_junit_formatter', '~> 0.5.1'
 gem 'rubocop', '~> 1.21'
-
-gem "pry", "~> 0.14.1"
+gem 'rubocop-rake', '~> 0.6.0'
+gem 'rubocop-rspec', '~> 2.7'
+gem 'yard', '~> 0.9.27'

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qig (0.1.1)
+    qig (0.3.0)
 
 GEM
   remote: https://rubygems.org/
@@ -33,6 +33,8 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.3)
+    rspec_junit_formatter (0.5.1)
+      rspec-core (>= 2, < 4, != 2.12.0)
     rubocop (1.24.1)
       parallel (~> 1.10)
       parser (>= 3.0.0.0)
@@ -44,8 +46,15 @@ GEM
       unicode-display_width (>= 1.4.0, < 3.0)
     rubocop-ast (1.15.1)
       parser (>= 3.0.1.1)
+    rubocop-rake (0.6.0)
+      rubocop (~> 1.0)
+    rubocop-rspec (2.7.0)
+      rubocop (~> 1.19)
     ruby-progressbar (1.11.0)
     unicode-display_width (2.1.0)
+    webrick (1.7.0)
+    yard (0.9.27)
+      webrick (~> 1.7.0)
 
 PLATFORMS
   x86_64-linux
@@ -55,7 +64,11 @@ DEPENDENCIES
   qig!
   rake (~> 13.0)
   rspec (~> 3.0)
+  rspec_junit_formatter (~> 0.5.1)
   rubocop (~> 1.21)
+  rubocop-rake (~> 0.6.0)
+  rubocop-rspec (~> 2.7)
+  yard (~> 0.9.27)
 
 BUNDLED WITH
    2.3.4

data/README.md

@@ -1,16 +1,23 @@
 # Qig
 
+[![Gem Version](https://badge.fury.io/rb/qig.svg)](https://badge.fury.io/rb/qig)
+[![CircleCI](https://circleci.com/gh/NAR8789/qig-ruby/tree/main.svg?style=shield)](https://circleci.com/gh/NAR8789/qig-ruby/tree/main)
+
 qig is dig extended with jq's "value iterator" `[]` operator.
 
 ## Features
 
-- [x] qig into arrays and hashes
-- [ ] qig into structs
-- [ ] qig into OpenStructs
-- [ ] qig into CSV::Tables
-- [ ] qig into CSV::Rows
-- [x] value iteration over arrays
-- [ ] value iteration over hashes
+- [x] compatible with dig
+  - [x] qig into arrays and hashes
+  - [x] qig into structs
+  - [x] qig into OpenStructs
+  - [x] qig into CSV::Tables
+  - [x] qig into CSV::Rows
+- [x] nifty jq extensions
+  - [x] value iteration over arrays
+  - [x] value iteration over hashes
+- [x] invoke ruby methods during inside the filter chain
+- [x] value collect: `[[]]`, inverse of the `[]` operator. Collect streamed values back into an array
 - [ ] option to monkey patch this for more dig-like `subject.qig(*path)` syntax
 
 ## Installation

data/bin/console

@@ -7,5 +7,5 @@ require 'qig'
 # 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.
 
-require "pry"
+require 'pry'
 Pry.start

data/lib/qig/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Qig
-  VERSION = '0.1.1'
+  VERSION = '0.3.0'
 end

data/lib/qig.rb

@@ -2,39 +2,88 @@
 
 require_relative 'qig/version'
 
+# Combining the powers of `dig` and `jq`.
+# Qig is dig extended with jq's value iteration `[]` operator.
 module Qig
-  def self.qig(*args)
-    unit_qig(*args)
-  end
+  class << self
+    # @param subject [Array, Hash, #[]] `subject` to be qug into.
+    # @param path [Array<String, Symbol, Array, Object>] retrieval path to apply to `subject`
+    #
+    # @return [Object, Array<Object>] the value(s) of `subject` located at `path`
+    def qig(subject, *path)
+      unit_qig(subject, *path)
+    end
+
+    # "values" as in jq's "value iterator".
+    #
+    # Coerce to array by taking the .values. Intuitively, get all possible values of `arrayish[x]`.
+    #
+    # @param arrayish [Array, Hash, #values, Object] array or hash or other to coerce to values
+    # @return [Array, Array, Array, Object] array of coerced values
+    def values(arrayish)
+      arrayish.respond_to?(:values) ? arrayish.values : arrayish
+    end
 
-  def self.unit_qig(subject, *path)
-    return subject if subject.nil?
+    private
 
-    head, *rest = path
-    case head
-    when nil
-      subject
-    when []
-      collection_qig(subject, *rest)
-      # hmm... what should happen if I [] on something not an array?
-    else
-      unit_qig(subject[head], *rest)
+    def unit_qig(subject, *path) # rubocop:disable Metrics/MethodLength
+      head, *rest = path
+      case head
+      in nil
+        subject
+      in []
+        collection_qig(values(subject), *rest)
+      in [[]]
+        unit_qig([subject], *rest)
+      in ['', key]
+        unit_qig(step(subject, key), *rest)
+      in [[method, [*args], block]]
+        unit_qig(subject.public_send(method, *args, &block), *rest)
+      in [[method, [*args]]]
+        unit_qig(subject.public_send(method, *args), *rest)
+      in [[method]]
+        unit_qig(subject.public_send(method), *rest)
+      in [method, *]
+        raise ArgumentError, 'stream method invocation not applicable in unit context'
+      else
+        unit_qig(step(subject, head), *rest)
+      end
     end
-  end
 
-  def self.collection_qig(subjects, *path)
-    return subjects if subjects.empty?
+    def collection_qig(subjects, *path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
+      head, *rest = path
+      case head
+      in nil
+        subjects
+      in []
+        collection_qig(subjects.map(&method(:values)).flatten(1), *rest)
+      in [[]]
+        unit_qig(subjects, *rest)
+      in ['', key]
+        collection_qig(subjects.map { |s| step(s, key) }, *rest)
+      in [[method, [*args], block]]
+        collection_qig(subjects.map { |s| s.public_send(method, *args, &block) }, *rest)
+      in [[method, [*args]]]
+        collection_qig(subjects.map { |s| s.public_send(method, *args) }, *rest)
+      in [[method]]
+        collection_qig(subjects.map { |s| s.public_send(method) }, *rest)
+      in [method, [*args], block]
+        collection_qig(subjects.public_send(method, *args, &block), *rest)
+      in [method, [*args]]
+        collection_qig(subjects.public_send(method, *args), *rest)
+      in [method]
+        collection_qig(subjects.public_send(method), *rest)
+      else
+        collection_qig(subjects.map { |s| step(s, head) }, *rest)
+      end
+    end
 
-    head, *rest = path
-    case head
-    when nil
-      subjects
-    when []
-      collection_qig(subjects.flatten(1), *rest)
-      # not sure this is quite jq-compliant... [] refuses to iterate over atoms, but flatten will just preserve them.
-      # maybe more in the spirit of `dig` though?
-    else
-      collection_qig(subjects.map { |e| e.nil? ? e : e[head] }, *rest)
+    def step(subject, key)
+      subject&.[](key)
+    rescue NameError, IndexError
+      # Struct's [] is strict and raises on missing key.
+      # TODO: more efficient / prettier way of doing this. How does struct itself implement dig?
+      nil
     end
   end
 end

data/qig.gemspec

@@ -12,11 +12,11 @@ Gem::Specification.new do |spec|
   # spec.description = "TODO: Write a longer description or delete this line."
   spec.homepage = 'https://github.com/NAR8789/qig-ruby'
   spec.license = 'MIT'
-  spec.required_ruby_version = '>= 2.6.0'
+  spec.required_ruby_version = '>= 2.7.0'
 
   spec.metadata['homepage_uri'] = spec.homepage
   spec.metadata['source_code_uri'] = spec.homepage
-  spec.metadata['changelog_uri'] = "#{spec.homepage}/CHANGELOG.txt"
+  spec.metadata['changelog_uri'] = "#{spec.homepage}/blob/main/CHANGELOG.md"
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
@@ -34,4 +34,5 @@ Gem::Specification.new do |spec|
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html
+  spec.metadata['rubygems_mfa_required'] = 'true'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qig
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Xiao Fan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -19,6 +19,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- ".yardopts"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -38,7 +39,8 @@ licenses:
 metadata:
   homepage_uri: https://github.com/NAR8789/qig-ruby
   source_code_uri: https://github.com/NAR8789/qig-ruby
-  changelog_uri: https://github.com/NAR8789/qig-ruby/CHANGELOG.txt
+  changelog_uri: https://github.com/NAR8789/qig-ruby/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -47,7 +49,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.6.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="