querier 0.1.1 → 0.3.2

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.
Files changed (4) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -0
  3. data/lib/querier.rb +93 -83
  4. metadata +4 -4
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: b9b2cf6f8f3a3f4aa087c68f85753ddcca380e076a165d0abef3fe750815630a
4
- data.tar.gz: b8825c18fae966fbcdc54dd33a799c108efa7c5cebb4c46336c53093cb03bd1d
3
+ metadata.gz: 87c48d900c8bc55a2f243a7b6f5f0a6a09934111a97b2a1473a8085fe3812419
4
+ data.tar.gz: 22b6a63a4ab9026812b9b64e1e82acbd4da724598d3064598c17713cd4fca1bd
5
5
  SHA512:
6
- metadata.gz: 84affb4d1704196d94de6dfbefb66795dc68636ddbfdf0fd6131a7b925313954642032d052d756124bff9e6a04a38b3a0a0917fc50d923c7d85d0cd9cd571a37
7
- data.tar.gz: e4ff00606711107491de8ea7f9e7066786136859da62f2fdc3ff1b1f27e7a8ef4e85d7918c1fc9fa8962c840ecf71961f9c8464748a5ad1f39ba862f063d3cf7
6
+ metadata.gz: f7bae86825831e8cc9356cb77aea20b212646e4018d036a24f3ca09b4a35ad35aefab4f6ae40d52ca332815ef04996f6814a0e87da4e6485e0794cbf53d3c8fd
7
+ data.tar.gz: feb4ed977acae65a211e801abf6a19dd6adcd8206ccb41098580af74f98f0b1c70ea16bbc40b3647a4a6b9193a6ed872726250196bda9ad43e1c393b32cf0cd4
data/README.md CHANGED
@@ -1,6 +1,7 @@
1
1
  # querier
2
2
 
3
3
  # class UserQuerier < Querier
4
+ @active_record_class = ApplicationRecord
4
5
  def initialize user_name:, active:
5
6
  @query_template = "SELECT * FROM users WHERE name = ${user_name} AND active = ${active}"
6
7
  super
data/lib/querier.rb CHANGED
@@ -1,83 +1,93 @@
1
- class Querier
2
- PARAM_NAME_INDEX = 0
3
- PARAM_VALUE_INDEX = 1
4
-
5
- attr_reader :query_execution_count, :query_template, :query_params
6
-
7
- def initialize(**template_query_params)
8
- @query_execution_count = 0
9
- @query_params = template_query_params.dup
10
- end
11
-
12
- def execute
13
- @query_execution_count += 1
14
- @execution_cached_result = ActiveRecord::Base.connection.select_all(fill_query_params(query_template: @query_template,
15
- query_params: @query_params)).map(&:symbolize_keys!)
16
- end
17
-
18
- def cached_result(format: :hash)
19
- raise 'query not executed yet' if @query_execution_count.eql?(0)
20
-
21
- case format
22
- when :hash
23
- @execution_cached_result
24
- when :open_struct
25
- hash_to_open_struct(dataset: @execution_cached_result)
26
- else
27
- raise 'invalid value type'
28
- end
29
- end
30
-
31
- def structured_results
32
- hash_to_open_struct(dataset: execute)
33
- end
34
-
35
- def to_sql
36
- fill_query_params(query_template: @query_template, query_params: @query_params)
37
- end
38
-
39
- def to_file
40
- file_name = "querier #{Time.now.strftime '[%d-%m-%Y]-[%Hh %Mm %Ss]'}.sql"
41
- File.open("tmp/#{file_name}", 'w') { |f| f << to_sql }
42
- end
43
-
44
- def field_group_and_count(field_name:, sort_element_index: nil, reverse_sort: true)
45
- count_result = cached_results(format: :open_struct).group_by(&field_name).map { |k, v| [k, v.count] }
46
-
47
- unless sort_element_index.nil?
48
- count_result = count_result.sort_by { |el| el[sort_element_index] }
49
- count_result.reverse! if reverse_sort.eql? true
50
- end
51
-
52
- count_result
53
- end
54
-
55
- private
56
-
57
- def hash_to_open_struct(dataset:)
58
- dataset.map { |record| OpenStruct.new(record.symbolize_keys!) }
59
- end
60
-
61
- def get_param_value(raw_query_param:, quotefy_param: true)
62
- # where's String#quote when we need it?
63
- raw_query_param.instance_of?(String) && quotefy_param ? "'#{raw_query_param.to_s}'" : raw_query_param.to_s
64
- end
65
-
66
- def fill_query_params(query_template:, query_params:)
67
- query = query_template.dup
68
-
69
- query_params.each do |query_param|
70
- query_param_name = query_param[PARAM_NAME_INDEX].to_s
71
-
72
- query.gsub!(/\${#{query_param_name}}/,
73
- get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
74
- quotefy_param: true))
75
-
76
- query.gsub!(/\${#{query_param_name}\/no_quote}/,
77
- get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
78
- quotefy_param: false))
79
- end
80
-
81
- query
82
- end
83
- end
1
+ require 'active_record'
2
+
3
+ class Querier
4
+ PARAM_NAME_INDEX = 0
5
+ PARAM_VALUE_INDEX = 1
6
+
7
+ @active_record_class = ActiveRecord::Base
8
+ # based on rubocop's tips at: https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/ClassVars
9
+ # solution here: https://www.ruby-lang.org/en/documentation/faq/8/
10
+ class << self
11
+ attr_accessor :active_record_class
12
+ end
13
+
14
+ attr_reader :query_execution_count, :query_template, :query_params
15
+
16
+ def initialize(template_query_params = {})
17
+ @active_record_class = self.class.active_record_class || self.class.superclass.active_record_class
18
+ @query_execution_count = 0
19
+ @query_params = template_query_params
20
+ end
21
+
22
+ def execute
23
+ @query_execution_count += 1
24
+ @execution_cached_result = @active_record_class.connection.select_all(fill_query_params(query_template: @query_template,
25
+ query_params: @query_params)).map(&:symbolize_keys!)
26
+ end
27
+
28
+ def cached_result(format: :hash)
29
+ raise 'query not executed yet' if @query_execution_count.eql?(0)
30
+
31
+ case format
32
+ when :hash
33
+ @execution_cached_result
34
+ when :open_struct
35
+ hash_to_open_struct(dataset: @execution_cached_result)
36
+ else
37
+ raise 'invalid value type'
38
+ end
39
+ end
40
+
41
+ def structured_results
42
+ hash_to_open_struct(dataset: execute)
43
+ end
44
+
45
+ def to_sql
46
+ fill_query_params(query_template: @query_template, query_params: @query_params)
47
+ end
48
+
49
+ def to_file
50
+ file_name = "querier #{Time.now.strftime '[%d-%m-%Y]-[%Hh %Mm %Ss]'}.sql"
51
+ File.write "tmp/#{file_name}", to_sql
52
+ end
53
+
54
+ def field_group_and_count(field_name:, sort_element_index: nil, reverse_sort: true)
55
+ count_result = cached_result(format: :open_struct).group_by(&field_name).map { |k, v| [k, v.count] }
56
+
57
+ unless sort_element_index.nil?
58
+ count_result = count_result.sort_by { |el| el[sort_element_index] }
59
+ count_result.reverse! if reverse_sort.eql? true
60
+ end
61
+
62
+ count_result
63
+ end
64
+
65
+ private
66
+
67
+ def hash_to_open_struct(dataset:)
68
+ dataset.map { |record| OpenStruct.new(record.symbolize_keys!) }
69
+ end
70
+
71
+ def get_param_value(raw_query_param:, quotefy_param: true)
72
+ # where's String#quote when we need it?
73
+ raw_query_param.instance_of?(String) && quotefy_param ? "'#{raw_query_param.to_s}'" : raw_query_param.to_s
74
+ end
75
+
76
+ def fill_query_params(query_template:, query_params:)
77
+ query = query_template
78
+
79
+ query_params.each_pair do |query_param|
80
+ query_param_name = query_param[PARAM_NAME_INDEX].to_s
81
+
82
+ query.gsub!(/\${#{query_param_name}}/,
83
+ get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
84
+ quotefy_param: true))
85
+
86
+ query.gsub!(/\${#{query_param_name}\/no_quote}/,
87
+ get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
88
+ quotefy_param: false))
89
+ end
90
+
91
+ query
92
+ end
93
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: querier
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.1
4
+ version: 0.3.2
5
5
  platform: ruby
6
6
  authors:
7
7
  - Gedean Dias
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2020-12-28 00:00:00.000000000 Z
11
+ date: 2021-08-30 00:00:00.000000000 Z
12
12
  dependencies: []
13
13
  description: Active Record queries with variable number of params
14
14
  email: gedean.dias@gmail.com
@@ -30,14 +30,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
30
30
  requirements:
31
31
  - - ">="
32
32
  - !ruby/object:Gem::Version
33
- version: 2.7.0
33
+ version: 3.0.2
34
34
  required_rubygems_version: !ruby/object:Gem::Requirement
35
35
  requirements:
36
36
  - - ">="
37
37
  - !ruby/object:Gem::Version
38
38
  version: '0'
39
39
  requirements: []
40
- rubygems_version: 3.2.3
40
+ rubygems_version: 3.2.27
41
41
  signing_key:
42
42
  specification_version: 4
43
43
  summary: Active Record Querier