querier 0.2.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b665dcde0c37b483e764ddcf1d30221ba9c4b34f478533e6fb911aaf11a81996
-  data.tar.gz: 4bd3bb6e6e3cc430b257ac9b408629440b8249ad642c1db89a6f9ece21d671f3
+  metadata.gz: 03d97150ee77685d381ebb876ae14ff305c3d69af0d64acc7b37340c9aa43581
+  data.tar.gz: 22d2b0f0605663a12105c8e4e98447fa8fbe3106f606d05b6fc7dea740e7a725
 SHA512:
-  metadata.gz: 5e0fc946d4e39bc164ffeda2bd762c4e3bddc4f769363d9590e4dc08a6a7379b3f3e27f5516b93baaea2a8c8216ac2808946096a0f48a28b847246d8a73d1da7
-  data.tar.gz: 3af81af98208e77a0f9360de68a5d15cd45e153613aaa5e1654157bcf4ea4ccf77977c80d1e30b22259db96eabff5d13bc6b66a843c4cbbcb210ad114ac905c6
+  metadata.gz: eda402af270f074d728d12d9ed2c0df757f44bcdfba4c8053ff06ca8480776de20088128a3a7dd6b428b9f3902ceaa6cc4790e35a81a95d8ffd0570e0c8833cd
+  data.tar.gz: 85045af2ce676784cf34a338d8dfbfc6cf7d9f10b4392053c7b908e7c80f1ae66986ac64b47ca71a695d7f7bcc4993095a6e91d718a68c0a5cc5c57436f4717b

data/README.md

@@ -1,10 +1,13 @@
-# querier
+# Active Record Querier
 
-# class UserQuerier < Querier
-    def initialize user_name:, active:
-        @query_template = "SELECT * FROM users WHERE name = ${user_name} AND active = ${active}"
-        super
-    end
-end
+> class UserQuerier < Querier
+> > @active_record_class = ApplicationRecord  
+def initialize user_name:, active:  
+> > > @query_template = "SELECT * FROM users WHERE   name = ${user_name} AND active = ${active/no_quote}"  
+super
+> > 
+> > end
+> > 
+> end
 
-# UserQuerier.new(user_name: 'foo', active: true).execute
+> UserQuerier.new(user_name: 'foo', active: true).select_all.to_struct

data/lib/querier.rb

@@ -1,91 +1,64 @@
-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.dup
-  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.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, :query_template, :query_params
+
+  def initialize(template_query_params = {})
+    @active_record_class = self.class.active_record_class || self.class.superclass.active_record_class
+    @query_params = template_query_params
+    @query = fill_query_params
+  end
+
+  def execute
+    @active_record_class.connection.execute(@query)
+  end
+
+  def select_all
+    result = @active_record_class.connection.select_all(@query)
+
+    def result.as_hash
+      map(&:symbolize_keys!)
+    end
+
+    def result.as_struct
+      map { |record| OpenStruct.new(record) }
+    end
+
+    result
+  end
+
+  private
+
+  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 = @query_template.dup
+
+    @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

data/lib/querier_bkp.rb

@@ -0,0 +1,93 @@
+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.2.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Gedean Dias
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-05 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies: []
 description: Active Record queries with variable number of params
 email: gedean.dias@gmail.com
@@ -18,6 +18,7 @@ extra_rdoc_files: []
 files:
 - README.md
 - lib/querier.rb
+- lib/querier_bkp.rb
 homepage: https://github.com/gedean/querier
 licenses:
 - MIT
@@ -30,14 +31,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.15
+rubygems_version: 3.2.27
 signing_key:
 specification_version: 4
 summary: Active Record Querier