querier 0.1.1 → 0.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b9b2cf6f8f3a3f4aa087c68f85753ddcca380e076a165d0abef3fe750815630a
-  data.tar.gz: b8825c18fae966fbcdc54dd33a799c108efa7c5cebb4c46336c53093cb03bd1d
+  metadata.gz: 87c48d900c8bc55a2f243a7b6f5f0a6a09934111a97b2a1473a8085fe3812419
+  data.tar.gz: 22b6a63a4ab9026812b9b64e1e82acbd4da724598d3064598c17713cd4fca1bd
 SHA512:
-  metadata.gz: 84affb4d1704196d94de6dfbefb66795dc68636ddbfdf0fd6131a7b925313954642032d052d756124bff9e6a04a38b3a0a0917fc50d923c7d85d0cd9cd571a37
-  data.tar.gz: e4ff00606711107491de8ea7f9e7066786136859da62f2fdc3ff1b1f27e7a8ef4e85d7918c1fc9fa8962c840ecf71961f9c8464748a5ad1f39ba862f063d3cf7
+  metadata.gz: f7bae86825831e8cc9356cb77aea20b212646e4018d036a24f3ca09b4a35ad35aefab4f6ae40d52ca332815ef04996f6814a0e87da4e6485e0794cbf53d3c8fd
+  data.tar.gz: feb4ed977acae65a211e801abf6a19dd6adcd8206ccb41098580af74f98f0b1c70ea16bbc40b3647a4a6b9193a6ed872726250196bda9ad43e1c393b32cf0cd4

data/README.md

@@ -1,6 +1,7 @@
 # querier
 
 # class UserQuerier < Querier
+    @active_record_class = ApplicationRecord
     def initialize user_name:, active:
         @query_template = "SELECT * FROM users WHERE name = ${user_name} AND active = ${active}"
         super

data/lib/querier.rb

@@ -1,83 +1,93 @@
-class Querier
-  PARAM_NAME_INDEX = 0
-  PARAM_VALUE_INDEX = 1
-
-  attr_reader :query_execution_count, :query_template, :query_params
-
-  def initialize(**template_query_params)
-    @query_execution_count = 0
-    @query_params = template_query_params.dup
-  end
-
-  def execute
-    @query_execution_count += 1
-    @execution_cached_result = ActiveRecord::Base.connection.select_all(fill_query_params(query_template: @query_template,
-                                                                                          query_params: @query_params)).map(&:symbolize_keys!)
-  end
-
-  def cached_result(format: :hash)
-    raise 'query not executed yet' if @query_execution_count.eql?(0)
-
-    case format
-    when :hash
-      @execution_cached_result
-    when :open_struct
-      hash_to_open_struct(dataset: @execution_cached_result)
-    else
-      raise 'invalid value type'
-    end
-  end
-
-  def structured_results
-    hash_to_open_struct(dataset: execute)
-  end
-
-  def to_sql
-    fill_query_params(query_template: @query_template, query_params: @query_params)
-  end
-
-  def to_file
-    file_name = "querier #{Time.now.strftime '[%d-%m-%Y]-[%Hh %Mm %Ss]'}.sql"
-    File.open("tmp/#{file_name}", 'w') { |f| f << to_sql }
-  end
-
-  def field_group_and_count(field_name:, sort_element_index: nil, reverse_sort: true)
-    count_result = cached_results(format: :open_struct).group_by(&field_name).map { |k, v| [k, v.count] }
-
-    unless sort_element_index.nil?
-      count_result = count_result.sort_by { |el| el[sort_element_index] }
-      count_result.reverse! if reverse_sort.eql? true
-    end
-
-    count_result
-  end
-
-  private
-
-  def hash_to_open_struct(dataset:)
-    dataset.map { |record| OpenStruct.new(record.symbolize_keys!) }
-  end
-
-  def get_param_value(raw_query_param:, quotefy_param: true)
-    # where's String#quote when we need it?
-    raw_query_param.instance_of?(String) && quotefy_param ? "'#{raw_query_param.to_s}'" : raw_query_param.to_s
-  end
-
-  def fill_query_params(query_template:, query_params:)
-    query = query_template.dup
-
-    query_params.each do |query_param|
-      query_param_name = query_param[PARAM_NAME_INDEX].to_s
-
-      query.gsub!(/\${#{query_param_name}}/,
-                  get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX], 
-                                  quotefy_param: true))
-
-      query.gsub!(/\${#{query_param_name}\/no_quote}/,
-                  get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
-                                  quotefy_param: false))
-    end
-
-    query
-  end
-end
+require 'active_record'
+
+class Querier
+  PARAM_NAME_INDEX = 0
+  PARAM_VALUE_INDEX = 1
+
+  @active_record_class = ActiveRecord::Base
+  # based on rubocop's tips at: https://www.rubydoc.info/gems/rubocop/RuboCop/Cop/Style/ClassVars
+  # solution here: https://www.ruby-lang.org/en/documentation/faq/8/
+  class << self
+    attr_accessor :active_record_class
+  end
+
+  attr_reader :query_execution_count, :query_template, :query_params
+
+  def initialize(template_query_params = {})
+    @active_record_class = self.class.active_record_class || self.class.superclass.active_record_class
+    @query_execution_count = 0
+    @query_params = template_query_params
+  end
+
+  def execute
+    @query_execution_count += 1
+    @execution_cached_result = @active_record_class.connection.select_all(fill_query_params(query_template: @query_template,
+                                                                                         query_params: @query_params)).map(&:symbolize_keys!)
+  end
+
+  def cached_result(format: :hash)
+    raise 'query not executed yet' if @query_execution_count.eql?(0)
+
+    case format
+    when :hash
+      @execution_cached_result
+    when :open_struct
+      hash_to_open_struct(dataset: @execution_cached_result)
+    else
+      raise 'invalid value type'
+    end
+  end
+
+  def structured_results
+    hash_to_open_struct(dataset: execute)
+  end
+
+  def to_sql
+    fill_query_params(query_template: @query_template, query_params: @query_params)
+  end
+
+  def to_file
+    file_name = "querier #{Time.now.strftime '[%d-%m-%Y]-[%Hh %Mm %Ss]'}.sql"
+    File.write "tmp/#{file_name}", to_sql
+  end
+
+  def field_group_and_count(field_name:, sort_element_index: nil, reverse_sort: true)
+    count_result = cached_result(format: :open_struct).group_by(&field_name).map { |k, v| [k, v.count] }
+
+    unless sort_element_index.nil?
+      count_result = count_result.sort_by { |el| el[sort_element_index] }
+      count_result.reverse! if reverse_sort.eql? true
+    end
+
+    count_result
+  end
+
+  private
+
+  def hash_to_open_struct(dataset:)
+    dataset.map { |record| OpenStruct.new(record.symbolize_keys!) }
+  end
+
+  def get_param_value(raw_query_param:, quotefy_param: true)
+    # where's String#quote when we need it?
+    raw_query_param.instance_of?(String) && quotefy_param ? "'#{raw_query_param.to_s}'" : raw_query_param.to_s
+  end
+
+  def fill_query_params(query_template:, query_params:)
+    query = query_template
+
+    query_params.each_pair do |query_param|
+      query_param_name = query_param[PARAM_NAME_INDEX].to_s
+
+      query.gsub!(/\${#{query_param_name}}/,
+                  get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX], 
+                                  quotefy_param: true))
+
+      query.gsub!(/\${#{query_param_name}\/no_quote}/,
+                  get_param_value(raw_query_param: query_param[PARAM_VALUE_INDEX],
+                                  quotefy_param: false))
+    end
+
+    query
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querier
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.3.2
 platform: ruby
 authors:
 - Gedean Dias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-28 00:00:00.000000000 Z
+date: 2021-08-30 00:00:00.000000000 Z
 dependencies: []
 description: Active Record queries with variable number of params
 email: gedean.dias@gmail.com
@@ -30,14 +30,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.2
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
 summary: Active Record Querier