querier 0.0.6 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fcc33d6a1dadd37a5731224a5ae632d86df0a90bacad5cc0795023b337c099d
-  data.tar.gz: 27825d9168d18d5f08ceb206ccfe863694f38795e455b8fd4f3e286256219fcc
+  metadata.gz: b9b2cf6f8f3a3f4aa087c68f85753ddcca380e076a165d0abef3fe750815630a
+  data.tar.gz: b8825c18fae966fbcdc54dd33a799c108efa7c5cebb4c46336c53093cb03bd1d
 SHA512:
-  metadata.gz: 1e807dcf2db351b1b79a3c1c9fd2db8da1e3cab636d31b9792949fd1b3b8f6158a8f7baf65bfcd1b37373fb321866fe088b50d4c838244bf3922f7d737d17797
-  data.tar.gz: 1f0bdd06785eb2286c1ab243a2b040a79f5e91f397d4cd29072a2d4937ddf7c25a4653c74d9e5cdbee8a55cc0a17a9045dd9b036f7c133ce70783a20db532821
+  metadata.gz: 84affb4d1704196d94de6dfbefb66795dc68636ddbfdf0fd6131a7b925313954642032d052d756124bff9e6a04a38b3a0a0917fc50d923c7d85d0cd9cd571a37
+  data.tar.gz: e4ff00606711107491de8ea7f9e7066786136859da62f2fdc3ff1b1f27e7a8ef4e85d7918c1fc9fa8962c840ecf71961f9c8464748a5ad1f39ba862f063d3cf7

data/README.md

@@ -1,22 +1,10 @@
 # querier
 
 # class UserQuerier < Querier
-    QUERY_TEMPLATE = <<-END_OF_QUERY_TEMPLATE
-
-SELECT
-  *
-FROM
-  users
-WHERE
-  name = {?user_name}
-  AND active = {?active}
-
-  END_OF_QUERY_TEMPLATE
-
     def initialize user_name:, active:
-        @query_template = QUERY_TEMPLATE
+        @query_template = "SELECT * FROM users WHERE name = ${user_name} AND active = ${active}"
         super
     end
 end
 
-# UserQuerier.new(user_name: 'foo', active: true).execute
+# UserQuerier.new(user_name: 'foo', active: true).execute

data/lib/querier.rb

@@ -1,61 +1,83 @@
-class Querier
-  PARAM_NAME_INDEX = 0
-  PARAM_VALUE_INDEX = 1
-
-  attr_reader :query_template, :query_params
-  
-  def initialize **template_query_params
-    @query_params = template_query_params.dup
-  end
-
-  def execute
-    ActiveRecord::Base.connection.select_all fill_query_params(query_template: @query_template, query_params: @query_params)
-  end   
-
-  def structured_results
-    query_results = self.execute
-    structured_results = [] 
-    query_results.each {|query_result| structured_results << OpenStruct.new(query_result.symbolize_keys!)}
-    structured_results
-  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 << self.to_sql}
-  end
-
-  def field_group_and_count field_name:, sort_element_index: nil, reverse_sort: true
-    count_result = @cached_results.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 get_param_value raw_query_param
-    # where's String#quote when we need it?
-    raw_query_param.class.eql?(String) ? "'#{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_param_value = get_param_value(query_param[PARAM_VALUE_INDEX])
-
-      query.gsub! /{\?#{query_param_name}}/, query_param_value
-    end
-
-    query
-  end
-end
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querier
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.1
 platform: ruby
 authors:
 - Gedean Dias
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-01-21 00:00:00.000000000 Z
+date: 2020-12-28 00:00:00.000000000 Z
 dependencies: []
 description: Active Record queries with variable number of params
 email: gedean.dias@gmail.com
@@ -22,7 +22,7 @@ homepage: https://github.com/gedean/querier
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -30,16 +30,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.0.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.2.3
+signing_key:
 specification_version: 4
 summary: Active Record Querier
 test_files: []