logical_query_parser 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +33 -3
- data/CHANGELOG.md +4 -0
- data/README.md +16 -0
- data/lib/logical_query_parser/assoc_resolver.rb +15 -0
- data/lib/logical_query_parser/db_adapters/mysql.rb +21 -0
- data/lib/logical_query_parser/db_adapters/pg.rb +18 -0
- data/lib/logical_query_parser/db_adapters/sqlite.rb +20 -0
- data/lib/logical_query_parser/db_adapters.rb +23 -0
- data/lib/logical_query_parser/nodes/active_record.rb +27 -1
- data/lib/logical_query_parser/version.rb +1 -1
- data/logical_query_parser.gemspec +2 -0
- metadata +34 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: e80750af0cc17abd6ddfb2ad99f6a178fabfc452f4effed9c2e858c68ebcbfad
|
|
4
|
+
data.tar.gz: 58d4b168c2ce192614ce80df6c53f207ae840d8b066d1d5f33c0cb4c68b5e1c8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 390e044f807ef44f03555e57cd8532cece3a2fbf7361f76cb7dcc4ad95e3adf89434f2326487bfac1b75601cf12bbbb7d20c62bc59d99afe7c18aae0885238da
|
|
7
|
+
data.tar.gz: 794a14a747c4472c85186dcdc1dca09a47d9e5b96550c7131e2c83f956f69ace20c2b41a71ba843992474c6ea0da38825fa49772020ee36971f27f1cf374462d
|
data/.github/workflows/ci.yml
CHANGED
|
@@ -5,11 +5,32 @@ on: [push, pull_request]
|
|
|
5
5
|
jobs:
|
|
6
6
|
test:
|
|
7
7
|
runs-on: ubuntu-24.04
|
|
8
|
+
services:
|
|
9
|
+
postgres:
|
|
10
|
+
image: postgres:15
|
|
11
|
+
env:
|
|
12
|
+
POSTGRES_USER: postgres
|
|
13
|
+
POSTGRES_PASSWORD: postgres
|
|
14
|
+
POSTGRES_DB: lqp_test
|
|
15
|
+
ports:
|
|
16
|
+
- 5432:5432
|
|
17
|
+
options: --health-cmd "pg_isready -h 127.0.0.1 -U postgres -d lqp_test" --health-interval 10s --health-timeout 5s --health-retries 5
|
|
18
|
+
mysql:
|
|
19
|
+
image: mysql:5.7
|
|
20
|
+
env:
|
|
21
|
+
MYSQL_ALLOW_EMPTY_PASSWORD: 'yes'
|
|
22
|
+
MYSQL_DATABASE: lqp_test
|
|
23
|
+
MYSQL_USER: mysql
|
|
24
|
+
MYSQL_PASSWORD: mysql
|
|
25
|
+
ports:
|
|
26
|
+
- 3306:3306
|
|
27
|
+
options: --health-cmd "mysqladmin ping -h 127.0.0.1 --silent" --health-interval 20s --health-timeout 10s --health-retries 10
|
|
8
28
|
strategy:
|
|
9
29
|
fail-fast: false
|
|
10
30
|
matrix:
|
|
11
31
|
ruby: ['3.0', 3.1, 3.2, 3.3, 3.4, '4.0']
|
|
12
32
|
gemfile: ['rails70', 'rails71', 'rails72', 'rails80', 'rails81']
|
|
33
|
+
database: ['sqlite', 'mysql', 'postgresql']
|
|
13
34
|
exclude:
|
|
14
35
|
- ruby: 3.0
|
|
15
36
|
gemfile: rails72
|
|
@@ -22,7 +43,7 @@ jobs:
|
|
|
22
43
|
- ruby: 3.1
|
|
23
44
|
gemfile: rails81
|
|
24
45
|
|
|
25
|
-
name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}
|
|
46
|
+
name: ruby ${{ matrix.ruby }}, ${{ matrix.gemfile }}, ${{ matrix.database }}
|
|
26
47
|
|
|
27
48
|
env:
|
|
28
49
|
BUNDLE_GEMFILE: gemfiles/${{ matrix.gemfile }}.gemfile
|
|
@@ -36,6 +57,15 @@ jobs:
|
|
|
36
57
|
- name: Bundle list
|
|
37
58
|
run: |
|
|
38
59
|
bundle list
|
|
39
|
-
- name:
|
|
60
|
+
- name: Test for sqlite
|
|
61
|
+
if: matrix.database == 'sqlite'
|
|
40
62
|
run: |
|
|
41
|
-
bundle exec rspec
|
|
63
|
+
DEBUG=1 bundle exec rspec
|
|
64
|
+
- name: Test for postgresql
|
|
65
|
+
if: matrix.database == 'postgresql'
|
|
66
|
+
run: |
|
|
67
|
+
DEBUG=1 DATABASE_URL=postgresql://postgres:postgres@127.0.0.1:5432/lqp_test bundle exec rspec
|
|
68
|
+
- name: Test for mysql
|
|
69
|
+
if: matrix.database == 'mysql'
|
|
70
|
+
run: |
|
|
71
|
+
DEBUG=1 DATABASE_URL=mysql2://mysql:mysql@127.0.0.1:3306/lqp_test bundle exec rspec
|
data/CHANGELOG.md
CHANGED
data/README.md
CHANGED
|
@@ -131,6 +131,22 @@ LogicalQueryParser.search("a AND b", Doc.all, :c1, tags: [:c2, doc: [:c3]]).to_s
|
|
|
131
131
|
# (("docs"."c1" LIKE '%b%' OR "tags"."c2" LIKE '%b%') OR "docs_tags"."c3" LIKE '%b%'))
|
|
132
132
|
```
|
|
133
133
|
|
|
134
|
+
#### JSON paths
|
|
135
|
+
|
|
136
|
+
Specify multiple JSON keys with an array. Use nested hashes for nested paths:
|
|
137
|
+
|
|
138
|
+
```ruby
|
|
139
|
+
LogicalQueryParser.search('a AND b', Doc.all, data: [:key1, :key2]).to_sql
|
|
140
|
+
# SELECT "docs".* FROM "docs"
|
|
141
|
+
# WHERE ((CAST(JSON_EXTRACT("docs"."data", '$."key1"') AS TEXT) LIKE '%a%' OR CAST(JSON_EXTRACT("docs"."data", '$."key2"') AS TEXT) LIKE '%a%') AND
|
|
142
|
+
# (CAST(JSON_EXTRACT("docs"."data", '$."key1"') AS TEXT) LIKE '%b%' OR CAST(JSON_EXTRACT("docs"."data", '$."key2"') AS TEXT) LIKE '%b%'))
|
|
143
|
+
|
|
144
|
+
LogicalQueryParser.search('a AND b', Doc.all, data: [key1: :key2]).to_sql
|
|
145
|
+
# SELECT "docs".* FROM "docs"
|
|
146
|
+
# WHERE ((CAST(JSON_EXTRACT("docs"."data", '$."key1"."key2"') AS TEXT) LIKE '%a%') AND
|
|
147
|
+
# (CAST(JSON_EXTRACT("docs"."data", '$."key1"."key2"') AS TEXT) LIKE '%b%'))
|
|
148
|
+
```
|
|
149
|
+
|
|
134
150
|
## Contributing
|
|
135
151
|
|
|
136
152
|
Bug reports and pull requests are welcome on GitHub at https://github.com/kanety/logical_query_parser.
|
|
@@ -41,6 +41,8 @@ module LogicalQueryParser
|
|
|
41
41
|
node.children ||= []
|
|
42
42
|
node.children << child
|
|
43
43
|
resolve_assocs(reflection.klass, child, nested_column_or_assoc_hash)
|
|
44
|
+
elsif current_klass.columns_hash.key?(assoc_name.to_s)
|
|
45
|
+
node.columns += resolve_json_paths(assoc_name, nested_column_or_assoc_hash)
|
|
44
46
|
end
|
|
45
47
|
end
|
|
46
48
|
else
|
|
@@ -49,5 +51,18 @@ module LogicalQueryParser
|
|
|
49
51
|
end
|
|
50
52
|
end
|
|
51
53
|
end
|
|
54
|
+
|
|
55
|
+
def resolve_json_paths(column, options, keys = [])
|
|
56
|
+
case options
|
|
57
|
+
when Array
|
|
58
|
+
options.flat_map { |option| resolve_json_paths(column, option, keys) }
|
|
59
|
+
when Hash
|
|
60
|
+
options.flat_map do |key, nested_options|
|
|
61
|
+
resolve_json_paths(column, nested_options, keys + [key])
|
|
62
|
+
end
|
|
63
|
+
when String, Symbol
|
|
64
|
+
[{ column => keys + [options] }]
|
|
65
|
+
end
|
|
66
|
+
end
|
|
52
67
|
end
|
|
53
68
|
end
|
|
@@ -0,0 +1,21 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'json'
|
|
4
|
+
|
|
5
|
+
module LogicalQueryParser
|
|
6
|
+
module DbAdapters
|
|
7
|
+
module Mysql
|
|
8
|
+
class << self
|
|
9
|
+
def cast_to_text(arel)
|
|
10
|
+
Arel::Nodes::NamedFunction.new('CAST', [arel.as('CHAR')])
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def json_extract(arel, key)
|
|
14
|
+
json_path = '$' + key.map { |key| ".#{key.to_json}" }.join
|
|
15
|
+
json_extract = Arel::Nodes::NamedFunction.new('JSON_EXTRACT', [arel, Arel::Nodes.build_quoted(json_path)])
|
|
16
|
+
Arel::Nodes::NamedFunction.new('JSON_UNQUOTE', [json_extract])
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module LogicalQueryParser
|
|
4
|
+
module DbAdapters
|
|
5
|
+
module Pg
|
|
6
|
+
class << self
|
|
7
|
+
def cast_to_text(arel)
|
|
8
|
+
Arel::Nodes::NamedFunction.new('CAST', [arel.as('TEXT')])
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
def json_extract(arel, keys)
|
|
12
|
+
args = [arel] + keys.map { |key| Arel::Nodes.build_quoted(key) }
|
|
13
|
+
Arel::Nodes::NamedFunction.new('jsonb_extract_path_text', args)
|
|
14
|
+
end
|
|
15
|
+
end
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
require 'json'
|
|
4
|
+
|
|
5
|
+
module LogicalQueryParser
|
|
6
|
+
module DbAdapters
|
|
7
|
+
module Sqlite
|
|
8
|
+
class << self
|
|
9
|
+
def cast_to_text(arel)
|
|
10
|
+
Arel::Nodes::NamedFunction.new('CAST', [arel.as('TEXT')])
|
|
11
|
+
end
|
|
12
|
+
|
|
13
|
+
def json_extract(arel, keys)
|
|
14
|
+
json_path = '$' + keys.map { |key| ".#{key.to_json}" }.join
|
|
15
|
+
Arel::Nodes::NamedFunction.new('JSON_EXTRACT', [arel, Arel::Nodes.build_quoted(json_path)])
|
|
16
|
+
end
|
|
17
|
+
end
|
|
18
|
+
end
|
|
19
|
+
end
|
|
20
|
+
end
|
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module LogicalQueryParser
|
|
4
|
+
module DbAdapters
|
|
5
|
+
class << self
|
|
6
|
+
def resolve(connection)
|
|
7
|
+
case connection.adapter_name
|
|
8
|
+
when 'PostgreSQL', 'PostGIS'
|
|
9
|
+
require 'logical_query_parser/db_adapters/pg'
|
|
10
|
+
DbAdapters::Pg
|
|
11
|
+
when 'Mysql2', 'Trilogy'
|
|
12
|
+
require 'logical_query_parser/db_adapters/mysql'
|
|
13
|
+
DbAdapters::Mysql
|
|
14
|
+
when 'SQLite'
|
|
15
|
+
require 'logical_query_parser/db_adapters/sqlite'
|
|
16
|
+
DbAdapters::Sqlite
|
|
17
|
+
else
|
|
18
|
+
raise NotImplementedError, "Unsupported adapter: #{connection.adapter_name}"
|
|
19
|
+
end
|
|
20
|
+
end
|
|
21
|
+
end
|
|
22
|
+
end
|
|
23
|
+
end
|
|
@@ -1,5 +1,7 @@
|
|
|
1
1
|
# frozen_string_literal: true
|
|
2
2
|
|
|
3
|
+
require 'logical_query_parser/db_adapters'
|
|
4
|
+
|
|
3
5
|
module LogicalQueryParser
|
|
4
6
|
module ExpNode
|
|
5
7
|
def to_sql(params = {})
|
|
@@ -94,10 +96,34 @@ module LogicalQueryParser
|
|
|
94
96
|
assocs = [root] + root.descendants
|
|
95
97
|
assocs.flat_map do |assoc|
|
|
96
98
|
assoc.columns.map do |column|
|
|
97
|
-
|
|
99
|
+
if column.is_a?(Hash)
|
|
100
|
+
json_column, keys = column.first
|
|
101
|
+
arel = build_json_arel(assoc, json_column, keys)
|
|
102
|
+
else
|
|
103
|
+
arel = build_text_arel(assoc, column)
|
|
104
|
+
end
|
|
105
|
+
arel.send(operator, Arel.sql(assoc.klass.connection.quote("%#{text}%")))
|
|
98
106
|
end
|
|
99
107
|
end
|
|
100
108
|
end
|
|
109
|
+
|
|
110
|
+
def build_text_arel(assoc, column)
|
|
111
|
+
connection = assoc.klass.connection
|
|
112
|
+
arel = assoc.arel_table[column]
|
|
113
|
+
arel = DbAdapters.resolve(connection).cast_to_text(arel) unless text_column?(assoc, column)
|
|
114
|
+
arel
|
|
115
|
+
end
|
|
116
|
+
|
|
117
|
+
def build_json_arel(assoc, column, keys)
|
|
118
|
+
connection = assoc.klass.connection
|
|
119
|
+
arel = assoc.arel_table[column]
|
|
120
|
+
adapter = DbAdapters.resolve(connection)
|
|
121
|
+
adapter.cast_to_text(adapter.json_extract(arel, keys))
|
|
122
|
+
end
|
|
123
|
+
|
|
124
|
+
def text_column?(assoc, column)
|
|
125
|
+
[:string, :text].include?(assoc.klass.columns_hash[column.to_s].type)
|
|
126
|
+
end
|
|
101
127
|
end
|
|
102
128
|
|
|
103
129
|
class << self
|
|
@@ -25,6 +25,8 @@ Gem::Specification.new do |spec|
|
|
|
25
25
|
|
|
26
26
|
spec.add_development_dependency "activerecord", ">= 7.0"
|
|
27
27
|
spec.add_development_dependency "sqlite3"
|
|
28
|
+
spec.add_development_dependency "mysql2"
|
|
29
|
+
spec.add_development_dependency "pg"
|
|
28
30
|
spec.add_development_dependency "bundler"
|
|
29
31
|
spec.add_development_dependency "irb"
|
|
30
32
|
spec.add_development_dependency "rake"
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: logical_query_parser
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.7.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Yoshikazu Kaneta
|
|
@@ -51,6 +51,34 @@ dependencies:
|
|
|
51
51
|
- - ">="
|
|
52
52
|
- !ruby/object:Gem::Version
|
|
53
53
|
version: '0'
|
|
54
|
+
- !ruby/object:Gem::Dependency
|
|
55
|
+
name: mysql2
|
|
56
|
+
requirement: !ruby/object:Gem::Requirement
|
|
57
|
+
requirements:
|
|
58
|
+
- - ">="
|
|
59
|
+
- !ruby/object:Gem::Version
|
|
60
|
+
version: '0'
|
|
61
|
+
type: :development
|
|
62
|
+
prerelease: false
|
|
63
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
64
|
+
requirements:
|
|
65
|
+
- - ">="
|
|
66
|
+
- !ruby/object:Gem::Version
|
|
67
|
+
version: '0'
|
|
68
|
+
- !ruby/object:Gem::Dependency
|
|
69
|
+
name: pg
|
|
70
|
+
requirement: !ruby/object:Gem::Requirement
|
|
71
|
+
requirements:
|
|
72
|
+
- - ">="
|
|
73
|
+
- !ruby/object:Gem::Version
|
|
74
|
+
version: '0'
|
|
75
|
+
type: :development
|
|
76
|
+
prerelease: false
|
|
77
|
+
version_requirements: !ruby/object:Gem::Requirement
|
|
78
|
+
requirements:
|
|
79
|
+
- - ">="
|
|
80
|
+
- !ruby/object:Gem::Version
|
|
81
|
+
version: '0'
|
|
54
82
|
- !ruby/object:Gem::Dependency
|
|
55
83
|
name: bundler
|
|
56
84
|
requirement: !ruby/object:Gem::Requirement
|
|
@@ -149,6 +177,10 @@ files:
|
|
|
149
177
|
- lib/logical_query_parser.treetop
|
|
150
178
|
- lib/logical_query_parser/assoc_node.rb
|
|
151
179
|
- lib/logical_query_parser/assoc_resolver.rb
|
|
180
|
+
- lib/logical_query_parser/db_adapters.rb
|
|
181
|
+
- lib/logical_query_parser/db_adapters/mysql.rb
|
|
182
|
+
- lib/logical_query_parser/db_adapters/pg.rb
|
|
183
|
+
- lib/logical_query_parser/db_adapters/sqlite.rb
|
|
152
184
|
- lib/logical_query_parser/nodes/active_record.rb
|
|
153
185
|
- lib/logical_query_parser/nodes/base.rb
|
|
154
186
|
- lib/logical_query_parser/version.rb
|
|
@@ -171,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
|
171
203
|
- !ruby/object:Gem::Version
|
|
172
204
|
version: '0'
|
|
173
205
|
requirements: []
|
|
174
|
-
rubygems_version:
|
|
206
|
+
rubygems_version: 4.0.20
|
|
175
207
|
specification_version: 4
|
|
176
208
|
summary: A parser for a logical query string.
|
|
177
209
|
test_files: []
|