q_hash 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 45090f151f081e5c9c4d6a744d745736f7a652a68d777886b87a0750fb8a4995
-  data.tar.gz: 98a176a62849a2ba100a63c779ec2e4d815f699071dd6ecb0f91e5914a788c95
+  metadata.gz: 4b5ef11c5099019641fbe1de713e1be087f9775f58571cb87a1554ad0155956e
+  data.tar.gz: 4ddad57fda9b5b8ffdf078cf432ed1b5ebf960928be1058341a54ae567ad43f0
 SHA512:
-  metadata.gz: 4512ee4a037ca7fc5dd0cca860d5ac35a8afdda22e76a99ef5a6b07c1dd8beb379edaf3c40664bc91badadf4e13ccc00b25d590b1941bad44b825fe6b164aa24
-  data.tar.gz: a85e3d75b37ac15d953ce2e624597278b7c3df57906dc5eb88241d44d28216d87191905e00309add8201a3a7590e61d724cf226797574ad572dc7c04125141f2
+  metadata.gz: edc0f7958090f8cb5720385622759bdc840c88d348c4c9fc519f4496f264d2dc8b15ca2fe952f7da9441a21bf1ba30eec667d53554a9bd9d5170b917ff232e81
+  data.tar.gz: 13fb94e70543d0a5dfe64add5cefdab276d906df332e48386a78933dabd1dd04f52f1960118e5d0da1a7e9e228ef82c7387d437248de56a2db04fd13932aa674

data/.github/workflows/main.yml

@@ -16,5 +16,9 @@ jobs:
         with:
           ruby-version: ${{ matrix.ruby }}
           bundler-cache: true
-      - name: Run the default task
-        run: bundle exec rake
+      - name: Linter
+        run: bundle exec rake standard
+      - name: Test
+        run: bundle exec rake spec
+      - name: Type Check
+        run: bundle exec rake steep

data/Gemfile

@@ -5,10 +5,16 @@ source "https://rubygems.org"
 # Specify your gem's dependencies in q_hash.gemspec
 gemspec
 
+gem "activesupport", "< 7.0"
+
 gem "rake", "~> 13.0"
 
+gem "rbs"
+
 gem "rspec", "~> 3.0"
 
+gem "simplecov"
+
 gem "standard"
 
-gem "simplecov"
+gem "steep"

data/Gemfile.lock

@@ -1,20 +1,39 @@
 PATH
   remote: .
   specs:
-    q_hash (0.1.2)
+    q_hash (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.6)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     ast (2.4.2)
+    concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     docile (1.4.0)
+    ffi (1.15.5)
+    i18n (1.10.0)
+      concurrent-ruby (~> 1.0)
+    language_server-protocol (3.16.0.3)
+    listen (3.7.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    minitest (5.15.0)
     parallel (1.22.1)
-    parser (3.1.1.0)
+    parser (3.1.2.0)
       ast (~> 2.4.1)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.3.0)
+    rb-fsevent (0.11.1)
+    rb-inotify (0.10.1)
+      ffi (~> 1.0)
+    rbs (2.5.0)
+    regexp_parser (2.4.0)
     rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
@@ -29,16 +48,16 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
-    rubocop (1.26.1)
+    rubocop (1.29.1)
       parallel (~> 1.10)
       parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
-      rexml
-      rubocop-ast (>= 1.16.0, < 2.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.17.0, < 2.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.16.0)
+    rubocop-ast (1.18.0)
       parser (>= 3.1.1.0)
     rubocop-performance (1.13.3)
       rubocop (>= 1.7.0, < 2.0)
@@ -50,21 +69,38 @@ GEM
       simplecov_json_formatter (~> 0.1)
     simplecov-html (0.12.3)
     simplecov_json_formatter (0.1.4)
-    standard (1.9.1)
-      rubocop (= 1.26.1)
+    standard (1.12.1)
+      rubocop (= 1.29.1)
       rubocop-performance (= 1.13.3)
+    steep (1.0.0)
+      activesupport (>= 5.1)
+      language_server-protocol (>= 3.15, < 4.0)
+      listen (~> 3.0)
+      parallel (>= 1.0.0)
+      parser (>= 3.0)
+      rainbow (>= 2.2.2, < 4.0)
+      rbs (>= 2.3.2)
+      terminal-table (>= 2, < 4)
+    terminal-table (3.0.2)
+      unicode-display_width (>= 1.1.1, < 3)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
     unicode-display_width (2.1.0)
+    zeitwerk (2.5.4)
 
 PLATFORMS
   x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES
+  activesupport (< 7.0)
   q_hash!
   rake (~> 13.0)
+  rbs
   rspec (~> 3.0)
   simplecov
   standard
+  steep
 
 BUNDLED WITH
    2.3.11

data/README.md

@@ -1,10 +1,37 @@
 # QHash - [ActiveRecord](https://github.com/rails/rails/tree/main/activerecord) style query interface for Hash
 
 [![Ruby](https://github.com/AkihikoITOH/q_hash/actions/workflows/main.yml/badge.svg)](https://github.com/AkihikoITOH/q_hash/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/q_hash.svg)](https://badge.fury.io/rb/q_hash)
 [![Maintainability](https://api.codeclimate.com/v1/badges/21e195471cca64af0366/maintainability)](https://codeclimate.com/github/AkihikoITOH/q_hash/maintainability)
 
 QHash lets you query array of hashes with ActiveRecord-like interface.
 
+## What's the point?
+
+We often do something like
+
+```ruby
+users.select do |user|
+  (dob = user.dig(:personal_data, :date_of_birth)) &&
+    dob > Date.new(1990, 1, 1) &&
+    user.dig(:address, :country) == "Germany" &&
+    user.dig(:address, :city) == "Hamburg"
+end
+```
+
+which can quickly become hard to read.
+
+QHash provides syntax sugar that would allow you to do
+
+```ruby
+users.where(
+  personal_data: {
+    date_of_birth: ->(dob) { dob > Date.new(1990, 1, 1) }
+  },
+  address: {country: "Germany", city: "Hamburg"}
+)
+```
+
 ## Installation
 
 Add this line to your application's Gemfile:

data/Rakefile

@@ -7,4 +7,7 @@ RSpec::Core::RakeTask.new(:spec)
 
 require "standard/rake"
 
-task default: %i[standard spec]
+task default: %i[standard spec steep]
+task :steep do
+  sh "bundle exec steep check"
+end

data/Steepfile

@@ -0,0 +1,7 @@
+target :lib do
+  signature "sig"
+
+  check "lib"
+
+  configure_code_diagnostics(Steep::Diagnostic::Ruby.strict)
+end

data/bin/release

@@ -0,0 +1,16 @@
+#!/usr/bin/env sh
+
+GEM_VERSION=$(ruby -e '$LOAD_PATH << File.join(File.dirname(__FILE__), "lib"); require "q_hash"; print QHash::VERSION')
+
+gem build q_hash.gemspec
+
+if [ ! -d "pkg" ]; then
+  mkdir pkg
+fi
+
+mv q_hash-$GEM_VERSION.gem pkg/q_hash-$GEM_VERSION.gem
+
+git tag -m "Release $GEM_VERSION" -a v$GEM_VERSION HEAD
+git push origin --tags
+
+gem push pkg/q_hash-$GEM_VERSION.gem

data/lib/q_hash.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 class QHash
-  VERSION = "0.1.2"
+  VERSION = "0.2.0"
 
   class Error < StandardError; end
 
@@ -13,18 +13,17 @@ class QHash
     @data = data
   end
 
-  def find_by(conditions)
-    data.find do |hash|
-      conditions.all? { |key, value| query(hash, key, value) }
-    end
+  def find_by(**conditions)
+    data.find { |record| apply_conditions(record, conditions) }
   end
 
-  def find_by!(conditions)
-    find_by(conditions) || raise(RecordNotFound)
+  def find_by!(**conditions)
+    find_by(**conditions) || raise(RecordNotFound)
   end
 
-  def where(conditions)
-    self.class.new(filter_by_conditions(conditions))
+  def where(**conditions)
+    result = data.select { |record| apply_conditions(record, conditions) }
+    self.class.new(result)
   end
 
   def each(&block)
@@ -37,30 +36,24 @@ class QHash
 
   private
 
-  def filter_by_conditions(conditions)
-    data.select do |hash|
-      conditions.all? { |key, value| query(hash, key, value) }
-    end
+  attr_reader :data
+
+  def apply_conditions(record, conditions)
+    conditions.all? { |query_key, query_value| query(record, query_key, query_value) }
   end
 
   def query(record, key, value)
-    return false if record[key].nil?
+    return false unless record.key?(key)
 
     case value
     when Proc
       value.call(record[key])
     when Hash
-      value.all? { |nested_key, nested_value| query(record[key], nested_key, nested_value) }
+      value.all? { |nested_query_key, nested_query_value| query(record[key], nested_query_key, nested_query_value) }
     when Array
       value.include?(record[key])
     else
-      record[key] == value
+      value == record[key]
     end
   end
-
-  def top_level_keys
-    @top_level_keys ||= array_of_hashes.flat_map(&:keys).uniq
-  end
-
-  attr_reader :data, :filtered_data
 end

data/sig/q_hash.rbs

@@ -0,0 +1,18 @@
+# See the writing guide of rbs: https://github.com/ruby/rbs#guides
+class QHash
+  VERSION: String
+
+  Error: StandardError
+  RecordNotFound: StandardError
+
+  def initialize: (Array[Hash[Symbol, untyped]]) -> void
+  def find_by: (**Hash[Symbol, untyped]) -> Hash[Symbol, untyped]?
+  def find_by!: (**Hash[Symbol, untyped]) -> Hash[Symbol, untyped]?
+  def where: (**Hash[Symbol, untyped]) -> QHash
+  def each: () { (Hash[Symbol, untyped]) -> void } -> void
+  def inspect: () -> Array[Hash[Symbol, untyped]]
+
+  private attr_reader data: Array[Hash[Symbol, untyped]]
+  private def apply_conditions: (Hash[Symbol, untyped], Hash[Symbol, untyped]) -> bool
+  private def query: (Hash[Symbol, untyped], Symbol, untyped) -> bool
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: q_hash
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Akihiko Ito
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-04-09 00:00:00.000000000 Z
+date: 2022-05-22 00:00:00.000000000 Z
 dependencies: []
 description: QHash lets you query array of hashes with ActiveRecord-like interface
 email:
@@ -28,10 +28,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- Steepfile
 - bin/console
+- bin/release
 - bin/setup
 - lib/q_hash.rb
 - q_hash.gemspec
+- sig/q_hash.rbs
 homepage: https://github.com/AkihikoITOH/q_hash
 licenses:
 - MIT