querier 0.0.10 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f15f96f79aea614fe9eec3fa44a8ed7c6f51009c4bdb6ee18316aef6577b41f9
-  data.tar.gz: e4d5d7abe1357c899a4f6e45fa407a3fedc831779aa5af1b999dd51917986cb0
+  metadata.gz: 0ec1f9125483e0166d0996f231ff42f06a9ac5e7cc2da9b2e0d31ea9c62947f4
+  data.tar.gz: 8866efc382250a6d3e3a3a6e76cf164f31786c8c2dc42a838afe89339e8025fc
 SHA512:
-  metadata.gz: 0baf3ced087fa4a9a5c1525fa0b8ae4076290a8d8af8d9be5257d83c610becf469fba2624e73ea3689d78a20cf28df811830c67bfba89198b8e148c421e4e33c
-  data.tar.gz: eeae2b170e2268b7569f8aaa531de5e7a49a702ad99746c32c8269c2cc0679ecd4e5d054c9a189e00ab1270faa1d3762c76efcc761c1a5c0510d8a0ecd41acbe
+  metadata.gz: 2e84803fd02bc35e4f94f7ffadaeadf89fdf6235bb0f4c4cb6c6c3b6f857dc391bc1bef6b316cd1f37e1a854c6021cc83d82670130d0a6c9fa43ea75865b8ba6
+  data.tar.gz: a1b0d4fa64e0d1d14c01fdf297b5868bd5e50eb4bf104f6cd63c54711f10ec7279f59c49ec2f2df7fe9a4fcf12c193b711fac0e86028db1faf29a5865f715ccd

data/README.md

@@ -1,22 +1,11 @@
 # querier
 
 # class UserQuerier < Querier
-    QUERY_TEMPLATE = <<-END_OF_QUERY_TEMPLATE
-
-SELECT
-  *
-FROM
-  users
-WHERE
-  name = {?user_name}
-  AND active = {?active}
-
-  END_OF_QUERY_TEMPLATE
-
+    @active_record_class = ApplicationRecord
     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

@@ -2,71 +2,79 @@ 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
+
+  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 = ActiveRecord::Base.connection.select_all(fill_query_params(query_template: @query_template, query_params: @query_params))
-    @execution_cached_result = execution_cached_result.map! { |record| record.symbolize_keys! }
-  end   
+    @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
+  def cached_result(format: :hash)
     raise 'query not executed yet' if @query_execution_count.eql?(0)
-    
-    case format.to_s
-      when 'hash' 
-        @execution_cached_result
-      when 'open_struct'
-          hash_to_open_struct(dataset: @execution_cached_result)
-      else
-          raise 'invalid value type'
+
+    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: self.execute
-  end  
+    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 << self.to_sql}
+    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 = self.cached_results(format: :open_struct).group_by(&field_name).map {|k, v| [k, v.count]}
-    
+  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 = count_result.sort_by { |el| el[sort_element_index] }
       count_result.reverse! if reverse_sort.eql? true
     end
-    
+
     count_result
-  end    
+  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
+  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.class.eql?(String) && quotefy_param ? "'#{raw_query_param.to_s}'" : raw_query_param.to_s
+    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:
+  def fill_query_params(query_template:, query_params:)
     query = query_template.dup
-    
-    query_params.each do |query_param|
+
+    query_params.each_pair do |query_param|
       query_param_name = query_param[PARAM_NAME_INDEX].to_s
 
       query.gsub!(/\${#{query_param_name}}/,
@@ -80,4 +88,4 @@ class Querier
 
     query
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querier
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.3.0
 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.26
 signing_key:
 specification_version: 4
 summary: Active Record Querier