occams-record 1.0.0.rc10 → 1.0.0.rc11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0cdafe04c023de8a937ebef5fb1c274459e11b10c06f7fec38cf5632b93c969
-  data.tar.gz: f98a82b06655ddaf71bcc68f171b3aa077b08f64bdfca9f35725e8fe2ad0c4f3
+  metadata.gz: a507ce21c11a7303250948fdcb29fdf9e6422968609b4915bfcd6800dfe7789c
+  data.tar.gz: b4fab3a88d28a742fed134800dde46c2919e400f04e93d427871dff349e36e76
 SHA512:
-  metadata.gz: dfe0c1a6f0c18be9e37c17b5928a4911e62615cc95e5399b3d181b75d769bdf803c13823773d285daab4602f526c397d15f3d0f9dfa62fa9970539e07028a9e7
-  data.tar.gz: e606aee2bae1577a3d77649979efa76c32b30b40614d0bbd4acb5f19ea1f453c16175e466a9afbad6997112c1cb12a64b6b890dd929cafbee039d2e1cbdb665d
+  metadata.gz: df7f2eb7c4f0181c8ad6d0f6b8a9d9c40bc23132578768dece1cd13fbc064b42db32678908a5701eb5493955035fb7bef9fae0cabc236e041dde4213f9594191
+  data.tar.gz: ac478403eb241853853465c1002f3ba804cbe0bb942f3379a42c0df5252852f1f959f3a9d7082d110536d92171d853656c8c273a724ff33f0274960d78d107c3

data/README.md

@@ -1,4 +1,4 @@
-### Occams Record [![Build Status](https://travis-ci.org/jhollinger/occams-record.svg?branch=master)](https://travis-ci.org/jhollinger/occams-record)
+# Occams Record [![Build Status](https://travis-ci.org/jhollinger/occams-record.svg?branch=master)](https://travis-ci.org/jhollinger/occams-record)
 
 > Do not multiply entities beyond necessity. -- Occam's Razor
 
@@ -259,3 +259,11 @@ bundle exec rake test
 ```
 
 Look inside `Gemfile` to see all testable versions.
+
+# License
+
+MIT License. See LICENSE for details.
+
+# Copyright
+
+Copywrite (c) 2019 Jordan Hollinger.

data/lib/occams-record.rb

@@ -1,6 +1,7 @@
 require 'active_record'
 require 'occams-record/version'
 require 'occams-record/merge'
+require 'occams-record/measureable'
 require 'occams-record/eager_loaders'
 require 'occams-record/results/results'
 require 'occams-record/results/row'

data/lib/occams-record/eager_loaders/ad_hoc_base.rb

@@ -35,11 +35,11 @@ module OccamsRecord
       # @param rows [Array<OccamsRecord::Results::Row>] Array of rows used to calculate the query.
       # @param query_logger [Array<String>]
       #
-      def run(rows, query_logger: nil)
+      def run(rows, query_logger: nil, measurements: nil)
         fkey_binds = calc_fkey_binds rows
         assoc = if fkey_binds.any? { |_, vals| vals.any? }
                   binds = @binds.merge(fkey_binds)
-                  RawQuery.new(@sql, binds, use: @use, eager_loaders: @eager_loaders, query_logger: query_logger).run
+                  RawQuery.new(@sql, binds, use: @use, eager_loaders: @eager_loaders, query_logger: query_logger, measurements: measurements).run
                 else
                   []
                 end

data/lib/occams-record/eager_loaders/base.rb

@@ -33,9 +33,9 @@ module OccamsRecord
       # @param rows [Array<OccamsRecord::Results::Row>] Array of rows used to calculate the query.
       # @param query_logger [Array<String>]
       #
-      def run(rows, query_logger: nil)
+      def run(rows, query_logger: nil, measurements: nil)
         query(rows) { |*args|
-          assoc_rows = args[0] ? Query.new(args[0], use: @use, eager_loaders: @eager_loaders, query_logger: query_logger).run : []
+          assoc_rows = args[0] ? Query.new(args[0], use: @use, eager_loaders: @eager_loaders, query_logger: query_logger, measurements: measurements).run : []
           merge! assoc_rows, rows, *args[1..-1]
         }
         nil

data/lib/occams-record/eager_loaders/context.rb

@@ -103,10 +103,10 @@ module OccamsRecord
       # @param rows [Array<ActiveRecord::Base>] the parent rows to load child rows into
       # @param query_logger [Array] optional query logger
       #
-      def run!(rows, query_logger: nil)
+      def run!(rows, query_logger: nil, measurements: nil)
         raise "Cannot run eager loaders when @model has not been set!" if @dynamic_loaders.any? and @model.nil?
         @loaders.each { |loader|
-          loader.run(rows, query_logger: query_logger)
+          loader.run(rows, query_logger: query_logger, measurements: measurements)
         }
         nil
       end

data/lib/occams-record/eager_loaders/polymorphic_belongs_to.rb

@@ -31,11 +31,11 @@ module OccamsRecord
       # @param rows [Array<OccamsRecord::Results::Row>] Array of rows used to calculate the query.
       # @param query_logger [Array<String>]
       #
-      def run(rows, query_logger: nil)
+      def run(rows, query_logger: nil, measurements: nil)
         query(rows) { |scope|
           eager_loaders = @eager_loaders.dup
           eager_loaders.model = scope.klass
-          assoc_rows = Query.new(scope, use: @use, eager_loaders: eager_loaders, query_logger: query_logger).run
+          assoc_rows = Query.new(scope, use: @use, eager_loaders: eager_loaders, query_logger: query_logger, measurements: measurements).run
           merge! assoc_rows, rows
         }
         nil

data/lib/occams-record/eager_loaders/through.rb

@@ -36,8 +36,8 @@ module OccamsRecord
         @loader.name
       end
 
-      def run(rows, query_logger: nil)
-        @loader.run(rows, query_logger: query_logger)
+      def run(rows, query_logger: nil, measurements: nil)
+        @loader.run(rows, query_logger: query_logger, measurements: measurements)
         attr_set = "#{name}="
         rows.each do |row|
           row.send(attr_set, reduce(row))

data/lib/occams-record/measureable.rb

@@ -0,0 +1,63 @@
+module OccamsRecord
+  Measurements = Struct.new(:total_time, :queries)
+  Measurement = Struct.new(:table_name, :sql, :time)
+
+  #
+  # Measure the time each query takes. Useful for figuring out which query is the slow one when you're doing a bunch of eager loads.
+  #
+  # orders = OccamsRecord.
+  #   query(Order.all).
+  #   eager_load(:customer).
+  #   ...
+  #   measure { |x|
+  #     puts "Total time: #{x.total_time} sec"
+  #     x.queries.each { |q|
+  #       puts "Table: #{q.table_name} (#{q.time} sec)"
+  #       puts q.sql
+  #     }
+  #   }.
+  #   run
+  #
+  module Measureable
+    #
+    # Track the run time of each query, and the total run time of everything combined.
+    #
+    # @yield [OccamsRecord::Measurements]
+    # @return self
+    #
+    def measure(&block)
+      @measurements ||= []
+      @measurement_results_block = block
+      self
+    end
+
+    private
+
+    def measure?
+      !@measurements.nil?
+    end
+
+    def measure!(table_name, sql)
+      result = nil
+      time = Benchmark.realtime { result = yield }
+      @measurements << Measurement.new(table_name, sql, time)
+      result
+    end
+
+    def record_start_time!
+      @start_time = Time.now if top_level_measurer?
+    end
+
+    def yield_measurements!
+      if top_level_measurer?
+        total_time = Time.now - @start_time
+        measurements = Measurements.new(total_time, @measurements.sort_by(&:time))
+        @measurement_results_block.call(measurements)
+      end
+    end
+
+    def top_level_measurer?
+      defined?(@measurement_results_block) && !@measurement_results_block.nil?
+    end
+  end
+end

data/lib/occams-record/query.rb

@@ -39,6 +39,7 @@ module OccamsRecord
     include Batches
     include EagerLoaders::Builder
     include Enumerable
+    include Measureable
 
     #
     # Initialize a new query.
@@ -47,13 +48,14 @@ module OccamsRecord
     # @param use [Array<Module>] optional Module to include in the result class (single or array)
     # @param query_logger [Array] (optional) an array into which all queries will be inserted for logging/debug purposes
     # @param eager_loaders [OccamsRecord::EagerLoaders::Context]
+    # @param measurements [Array]
     #
-    def initialize(scope, use: nil, eager_loaders: nil, query_logger: nil)
+    def initialize(scope, use: nil, eager_loaders: nil, query_logger: nil, measurements: nil)
       @model = scope.klass
       @scope = scope
       @eager_loaders = eager_loaders || EagerLoaders::Context.new(@model)
       @use = use
-      @query_logger = query_logger
+      @query_logger, @measurements = query_logger, measurements
     end
 
     #
@@ -93,10 +95,18 @@ module OccamsRecord
     def run
       sql = block_given? ? yield(scope).to_sql : scope.to_sql
       @query_logger << sql if @query_logger
-      result = model.connection.exec_query sql
+      result = if measure?
+                 record_start_time!
+                 measure!(model.table_name, sql) {
+                   model.connection.exec_query sql
+                 }
+               else
+                 model.connection.exec_query sql
+               end
       row_class = OccamsRecord::Results.klass(result.columns, result.column_types, @eager_loaders.names, model: model, modules: @use)
       rows = result.rows.map { |row| row_class.new row }
-      @eager_loaders.run!(rows, query_logger: @query_logger)
+      @eager_loaders.run!(rows, query_logger: @query_logger, measurements: @measurements)
+      yield_measurements!
       rows
     end
 

data/lib/occams-record/raw_query.rb

@@ -53,6 +53,7 @@ module OccamsRecord
     include Batches
     include EagerLoaders::Builder
     include Enumerable
+    include Measureable
 
     #
     # Initialize a new query.
@@ -62,13 +63,14 @@ module OccamsRecord
     # @param use [Array<Module>] optional Module to include in the result class (single or array)
     # @param eager_loaders [OccamsRecord::EagerLoaders::Context]
     # @param query_logger [Array] (optional) an array into which all queries will be inserted for logging/debug purposes
+    # @param measurements [Array]
     #
-    def initialize(sql, binds, use: nil, eager_loaders: nil, query_logger: nil)
+    def initialize(sql, binds, use: nil, eager_loaders: nil, query_logger: nil, measurements: nil)
       @sql = sql
       @binds = binds
       @use = use
       @eager_loaders = eager_loaders || EagerLoaders::Context.new
-      @query_logger = query_logger
+      @query_logger, @measurements = query_logger, measurements
       @conn = @eager_loaders.model&.connection || ActiveRecord::Base.connection
     end
 
@@ -95,10 +97,18 @@ module OccamsRecord
     def run
       _escaped_sql = escaped_sql
       @query_logger << _escaped_sql if @query_logger
-      result = @conn.exec_query _escaped_sql
+      result = if measure?
+                 record_start_time!
+                 measure!(table_name, _escaped_sql) {
+                   @conn.exec_query _escaped_sql
+                 }
+               else
+                 @conn.exec_query _escaped_sql
+               end
       row_class = OccamsRecord::Results.klass(result.columns, result.column_types, @eager_loaders.names, model: @eager_loaders.model, modules: @use)
       rows = result.rows.map { |row| row_class.new row }
-      @eager_loaders.run!(rows, query_logger: @query_logger)
+      @eager_loaders.run!(rows, query_logger: @query_logger, measurements: @measurements)
+      yield_measurements!
       rows
     end
 
@@ -123,6 +133,7 @@ module OccamsRecord
 
     # Returns the SQL as a String with all variables escaped
     def escaped_sql
+      return sql if binds.empty?
       sql % binds.reduce({}) { |a, (col, val)|
         a[col.to_sym] = if val.is_a? Array
                           val.map { |x| @conn.quote x }.join(', ')
@@ -133,6 +144,10 @@ module OccamsRecord
       }
     end
 
+    def table_name
+      @sql.match(/\s+FROM\s+"?(\w+)"?/i)&.captures&.first
+    end
+
     #
     # Returns an Enumerator that yields batches of records, of size "of".
     # The SQL string must include 'LIMIT %{batch_limit} OFFSET %{batch_offset}'.

data/lib/occams-record/version.rb

@@ -3,5 +3,5 @@
 #
 module OccamsRecord
   # Library version
-  VERSION = '1.0.0.rc10'.freeze
+  VERSION = '1.0.0.rc11'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: occams-record
 version: !ruby/object:Gem::Version
-  version: 1.0.0.rc10
+  version: 1.0.0.rc11
 platform: ruby
 authors:
 - Jordan Hollinger
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-31 00:00:00.000000000 Z
+date: 2019-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -54,6 +54,7 @@ files:
 - lib/occams-record/eager_loaders/polymorphic_belongs_to.rb
 - lib/occams-record/eager_loaders/through.rb
 - lib/occams-record/errors.rb
+- lib/occams-record/measureable.rb
 - lib/occams-record/merge.rb
 - lib/occams-record/query.rb
 - lib/occams-record/raw_query.rb