qig 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: baaf3d2d15ea2c35ff975d3b1f373b307269ca866faed4363ffc5648320c415f
-  data.tar.gz: 195d83a355ddcf760fd66afb6e3e791b0571d48f01190c9e15fd5b890b83b937
+  metadata.gz: f92505d2904e0032d3fcd5b33f03540a7ce8d09080bc50a534ede7e2daecf686
+  data.tar.gz: 16caa89894a03819be080591bd729b89ddfb743712122fff401b18e2e2ba0ae9
 SHA512:
-  metadata.gz: 1124ac020d0e6ad9c8b6be999d8d25c1b1423e5482bcab1c24d832724d566e7783ad1c8780cf7dbf2e84b41e68bc92652896ec1d94f88ef903da267447d2d273
-  data.tar.gz: 946766e1e920e92226c5994efb64a435da1c42dbe132b26116bf3065f9f1f77c3d2612eaeb812fa8cda5d9318ea432cf4ed3ba61daeda00e19c322f951a7e4b0
+  metadata.gz: ab2d2ace58c87bc6117a20d9ca2e6b1d329398cd5ce895fb2f206abb5f66a06782b4f8d3d48716719e2a67f7091f6e938aebc9bc7e329652782583952b82533a
+  data.tar.gz: 9362297e8f6feb6a9f390302ae7d12093877fdd3215f5894b366a05b41330093479b027745b6579ff546bba4f27a79f539d5f985ed89c1a87c07d663acdbe9c7

data/.rubocop.yml

@@ -1,5 +1,5 @@
 AllCops:
-  TargetRubyVersion: 2.6
+  TargetRubyVersion: 2.7
   NewCops: enable
 
 Layout/LineLength:

data/CHANGELOG.md

@@ -1,3 +1,25 @@
+# 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
@@ -33,4 +55,4 @@
 ## Features
 
 - Ability to qig into arrays and hashes
-- Value iteration (`[]`) over arrays
+- Value iteration (`[]`) over arrays

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    qig (0.2.0)
+    qig (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -7,13 +7,17 @@ qig is dig extended with jq's "value iterator" `[]` operator.
 
 ## Features
 
-- [x] qig into arrays and hashes
-- [x] qig into structs
-- [x] qig into OpenStructs
-- [ ] qig into CSV::Tables
-- [ ] qig into CSV::Rows
-- [x] value iteration over arrays
-- [x] 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/lib/qig/version.rb

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

data/lib/qig.rb

@@ -14,33 +14,76 @@ module Qig
       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
+
     private
 
-    def unit_qig(subject, *path)
+    def unit_qig(subject, *path) # rubocop:disable Metrics/MethodLength
       head, *rest = path
       case head
-      when nil
+      in nil
         subject
-      when []
-        subject = subject&.values if subject.is_a? Hash
-        collection_qig(subject, *rest)
+      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(subject&.[](head), *rest)
+        unit_qig(step(subject, head), *rest)
       end
     end
 
-    def collection_qig(subjects, *path)
+    def collection_qig(subjects, *path) # rubocop:disable Metrics/AbcSize, Metrics/MethodLength
       head, *rest = path
       case head
-      when nil
+      in nil
         subjects
-      when []
-        collection_qig(subjects.map { |s| s.is_a?(Hash) ? s.values : s }.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?
+      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 { |e| e.nil? ? e : e[head] }, *rest)
+        collection_qig(subjects.map { |s| step(s, head) }, *rest)
       end
     end
+
+    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,7 +12,7 @@ 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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: qig
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Xiao Fan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-14 00:00:00.000000000 Z
+date: 2022-01-24 00:00:00.000000000 Z
 dependencies: []
 description: 
 email:
@@ -49,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:
   - - ">="