querier 0.0.9 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd47eff36c3f752f277ce56bcd18635ef34f9a79d7765fdd91b56ae20f06444d
-  data.tar.gz: 6f95ffd91d3e52181eeb33ddc2f0fd3a444035365542f774c7b9ad8c923962e7
+  metadata.gz: de1729ce8cc885a52a8a5892e79d2a4e4008b48d95d5a821c2f985bc5925abf9
+  data.tar.gz: 0db5814a6b46ecd4d73f766763d1f82347c2fecf3075c0f1c3218d6870b4cfa9
 SHA512:
-  metadata.gz: 5a861883fac193952c33733c58ed2701d7424ad22196618d199fdd7a469075d0689196baa2cea9d0c3e5ac212ba99a252aff9d2670cdc4a382da4d844839615f
-  data.tar.gz: 343f454ff2489dea937cc6906c262d214383efb2b63d774a1e0f240b113691d04805f3f0e9656e50d1b539e35933a550bfe3af35e303bcb7d2cbfce8cf706df0
+  metadata.gz: b3384fe46ceb0cbfbd19e15caa51d4e8bb14e77e2565d4db001f773d6fb2d8ac1a88f53ede1527f150ae3d916a50d41e7ac7aed789ca59f72b58a9f0f1871c8f
+  data.tar.gz: 343e400b47d07e0e8e55be4b025fbca6c3e672e01ece56ab3bd6c13061eb9e1597d27dfe70c36ebeb17904efcc2676a4ee7f90ffc921f1f63b9799755f5af88d

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,77 +2,90 @@ 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.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.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 = 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_param_name = query_param[PARAM_NAME_INDEX].to_s
 
-      query.gsub! /{\?#{query_param_name}}/, get_param_value(query_param[PARAM_VALUE_INDEX], true)
-      query.gsub! /{\?#{query_param_name}\/no_quote}/, get_param_value(query_param[PARAM_VALUE_INDEX], false)
+      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
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: querier
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.2.1
 platform: ruby
 authors:
 - Gedean Dias
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2021-08-14 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.7
-signing_key: 
+rubygems_version: 3.2.25
+signing_key:
 specification_version: 4
 summary: Active Record Querier
 test_files: []