qig 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e8273358c4ab9ad0e950da9bcd3bfd960478765fecbb846f2aa56959a6d00a4
-  data.tar.gz: 63fcfe26d488d3aaefa6b83aafd9a9d60f572f40d2b75aec1c0054c55b082fb4
+  metadata.gz: baaf3d2d15ea2c35ff975d3b1f373b307269ca866faed4363ffc5648320c415f
+  data.tar.gz: 195d83a355ddcf760fd66afb6e3e791b0571d48f01190c9e15fd5b890b83b937
 SHA512:
-  metadata.gz: 4a10bd2f7bca3953c74385c3704846c92380eddd7f6524dea68f5abd81a9bdcc37281b3e5e4b1a9c7adfa77113d781dbe3ab699119cd6fe461913c478ba49448
-  data.tar.gz: 9881a37fdd709fbc51329bf1c15c254ac2c1fffcd4c5e504025268209ab94641df0da7a898a97dda12355961c6f61f30ae67a18912bc7add1c4c01d7c53ce3a8
+  metadata.gz: 1124ac020d0e6ad9c8b6be999d8d25c1b1423e5482bcab1c24d832724d566e7783ad1c8780cf7dbf2e84b41e68bc92652896ec1d94f88ef903da267447d2d273
+  data.tar.gz: 946766e1e920e92226c5994efb64a435da1c42dbe132b26116bf3065f9f1f77c3d2612eaeb812fa8cda5d9318ea432cf4ed3ba61daeda00e19c322f951a7e4b0

data/.rubocop.yml

@@ -1,5 +1,12 @@
 AllCops:
   TargetRubyVersion: 2.6
+  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,26 @@
+# 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

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.3)
+    qig (0.2.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,19 @@
 # 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
+- [x] qig into structs
+- [x] qig into OpenStructs
 - [ ] qig into CSV::Tables
 - [ ] qig into CSV::Rows
 - [x] value iteration over arrays
-- [ ] value iteration over hashes
+- [x] value iteration over hashes
 - [ ] 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.3'
+  VERSION = '0.2.0'
 end

data/lib/qig.rb

@@ -2,39 +2,45 @@
 
 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
 
-  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)
+      head, *rest = path
+      case head
+      when nil
+        subject
+      when []
+        subject = subject&.values if subject.is_a? Hash
+        collection_qig(subject, *rest)
+      else
+        unit_qig(subject&.[](head), *rest)
+      end
     end
-  end
-
-  def self.collection_qig(subjects, *path)
-    return subjects if subjects.empty?
 
-    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 collection_qig(subjects, *path)
+      head, *rest = path
+      case head
+      when 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?
+      else
+        collection_qig(subjects.map { |e| e.nil? ? e : e[head] }, *rest)
+      end
     end
   end
 end

data/qig.gemspec

@@ -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.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Xiao Fan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-13 00:00:00.000000000 Z
+date: 2022-01-14 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
@@ -39,6 +40,7 @@ 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/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 post_install_message: 
 rdoc_options: []
 require_paths: