simple-sql 0.4.28 → 0.4.29

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0d15e3cf80cc7d5cf308b674a55712a02878e45d1b25b7771248dc020f930d80
-  data.tar.gz: 258e8a8f695c80a4b630431371689162607aa08d204aea15333f3ad1687565c7
+  metadata.gz: 2f70bf7c7bf33282cf573be0fe9371aab9839a7a2fb6e4b3266827871e667575
+  data.tar.gz: 5d857fdc4905fb3e5d40b6f51c1e978b4f92b3d7db30a133266d1c0daa72ce63
 SHA512:
-  metadata.gz: ee750f741f4bffce5bba59eb938b9fd4ff21854c1ffa1d3b506814a83659a640de508c77cacaf18ca7124f2c3deb684fd3fad239c3337c808b9cf162a770e85c
-  data.tar.gz: 4f31769ed4cb0a30b18e2864a224d0c87b772439bd6ca3660a44f427b8d0568633a3104931c523dc26160a314a58d814eba71e87b0b1d98b0dec55420ecfed4c
+  metadata.gz: 4626339a32bbad1585a8a50b746a55f939ecaf5f671d8b2511b4261446221c8a0be1ef9d2bcfd6193fef5427b3e0a7544af1c25362edca54c8e298f8bfb9d186
+  data.tar.gz: 994ddacac8809d15605e6a336699135d7c40361bdf6d7e9e667d618889e92f444b249cb228bf5e84d411762900c74651167d6c65ee6168b41c527baaca1f6bc0

data/.rubocop.yml

@@ -10,7 +10,7 @@ AllCops:
     - 'Rakefile'
 
 Metrics/LineLength:
-  Max: 120
+  Max: 140
 
 Metrics/MethodLength:
   Max: 20
@@ -72,3 +72,7 @@ Style/IfUnlessModifier:
 
 Style/PerlBackrefs:
   Enabled: false
+
+Style/TrailingUnderscoreVariable:
+  Enabled: false
+  

data/config/console-init.rb

@@ -1 +1,3 @@
+# rubocop:disable Naming/FileName
+
 # This file is loaded when running bin/console.

data/lib/simple/sql/config.rb

@@ -1,6 +1,7 @@
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/CyclomaticComplexity
 # rubocop:disable Metrics/PerceivedComplexity
+# rubocop:disable Layout/AlignHash
 
 # private
 module Simple::SQL::Config

data/lib/simple/sql/connection_adapter.rb

@@ -12,7 +12,7 @@ module Simple::SQL::ConnectionAdapter
   # arguments - since the pg client does not support this - but it allows to
   # run multiple sql statements separated by ";"
   def exec(sql)
-    Logging.yield_logged sql do
+    Logging.with_logged_query sql do
       raw_connection.exec sql
     end
   end
@@ -33,6 +33,7 @@ module Simple::SQL::ConnectionAdapter
 
   def all(sql, *args, into: nil, &block)
     raise ArgumentError, "all no longer support blocks, use each instead." if block
+
     rows = []
     my_pg_source_oid = nil
 
@@ -67,6 +68,7 @@ module Simple::SQL::ConnectionAdapter
   # Runs a query and prints the results via "table_print"
   def print(sql, *args, into: nil)
     raise ArgumentError, "You cannot call Simple::SQL.print with into: #{into.inspect}" unless into.nil?
+
     require "table_print"
     records = all sql, *args, into: Hash
     tp records
@@ -117,7 +119,7 @@ module Simple::SQL::ConnectionAdapter
       sql = sql_or_scope
     end
 
-    Logging.yield_logged sql, *args do
+    Logging.with_logged_query sql, *args do
       raw_connection.exec_params(sql, Encoder.encode_args(raw_connection, args))
     end
   end

data/lib/simple/sql/duplicate.rb

@@ -55,6 +55,7 @@ module Simple
           unless value.is_a?(Fragment)
             raise ArgumentError, "Pass in override values via SQL.fragment (for #{value.inspect})"
           end
+
           hsh.update key.to_s => value.to_sql
         end
       end

data/lib/simple/sql/formatting.rb

@@ -0,0 +1,60 @@
+module Simple
+  module SQL
+    module Formatting
+      extend self
+
+      def format(sql, *args)
+        sql = format_sql(sql)
+
+        return sql if args.empty?
+
+        args = args.map(&:inspect).join(", ")
+        sql += " w/args: #{args}"
+        sql = sql[0, 98] + "..." if sql.length > 100
+        sql
+      end
+
+      def pretty_format(sql, *args)
+        sql = if use_pg_format?
+                pg_format_sql(sql)
+              else
+                format_sql(sql)
+              end
+
+        args = args.map(&:inspect).join(", ")
+        "#{sql} w/args: #{args}"
+      end
+
+      private
+
+      def format_sql(sql)
+        sql.gsub(/\s*\n\s*/, " ").gsub(/(\A\s+)|(\s+\z)/, "")
+      end
+
+      require "open3"
+
+      def use_pg_format?
+        return @use_pg_format unless @use_pg_format.nil?
+
+        `which pg_format`
+        if $?.exitstatus == 0
+          @use_pg_format = true
+        else
+          Simple::SQL.logger.warn "[sql] simple-sql can use pg_format for logging queries. Please see https://github.com/darold/pgFormatter"
+          @use_pg_format = false
+        end
+      end
+
+      PG_FORMAT_ARGS = "--function-case 2 --maxlength 15000 --nocomment --spaces 2 --keyword-case 2 --no-comma-end"
+
+      def pg_format_sql(sql)
+        stdin, stdout, _ = Open3.popen2("pg_format #{PG_FORMAT_ARGS} -")
+        stdin.print sql
+        stdin.close
+        formatted = stdout.read
+        stdout.close
+        formatted
+      end
+    end
+  end
+end

data/lib/simple/sql/helpers/decoder.rb

@@ -6,6 +6,7 @@ module Simple::SQL::Helpers::Decoder
 
   # rubocop:disable Metrics/AbcSize
   # rubocop:disable Metrics/CyclomaticComplexity
+  # rubocop:disable Naming/UncommunicativeMethodParamName
   def decode_value(type, s)
     case type
     when :unknown                       then s
@@ -31,7 +32,6 @@ module Simple::SQL::Helpers::Decoder
   end
   # rubocop:enable Metrics/AbcSize
   # rubocop:enable Metrics/CyclomaticComplexity
-  # rubocop:enable Metrics/MethodLength
 
   require "pg_array_parser"
   extend PgArrayParser

data/lib/simple/sql/helpers/immutable.rb

@@ -14,6 +14,7 @@ class Simple::SQL::Helpers::Immutable
     case object
     when Array
       raise ArgumentError, "Object nested too deep (or inner loop?)" if max_depth < 0
+
       object.map { |obj| create obj, max_depth - 1 }
     when Hash
       new(object)
@@ -65,6 +66,8 @@ end
 
 if $PROGRAM_NAME == __FILE__
 
+  # rubocop:disable Metrics/AbcSize
+
   require "test-unit"
 
   class Simple::SQL::Helpers::Immutable::TestCase < Test::Unit::TestCase
@@ -146,5 +149,4 @@ if $PROGRAM_NAME == __FILE__
     end
   end
 
-  # rubocop:enable Style/ClassAndModuleChildren
 end

data/lib/simple/sql/insert.rb

@@ -1,5 +1,7 @@
 # rubocop:disable Metrics/AbcSize
 # rubocop:disable Metrics/LineLength
+# rubocop:disable Layout/AlignHash
+
 module Simple
   module SQL
     #

data/lib/simple/sql/logging.rb

@@ -1,3 +1,7 @@
+# rubocop:disable Metrics/AbcSize
+
+require_relative "formatting"
+
 module Simple
   module SQL
     module Logging
@@ -25,7 +29,10 @@ module Simple
           return logger if logger
         end
 
-        # returns a stderr_logger
+        stderr_logger
+      end
+
+      def stderr_logger
         @stderr_logger ||= begin
           logger = Logger.new(STDERR)
           logger.level = Logger::INFO
@@ -38,25 +45,67 @@ module Simple
       extend Forwardable
       delegate [:debug, :info, :warn, :error, :fatal] => :logger
 
-      def yield_logged(sql, *args, &_block)
+      def slow_query_treshold
+        @slow_query_treshold
+      end
+
+      def slow_query_treshold=(slow_query_treshold)
+        expect! slow_query_treshold > 0
+        @slow_query_treshold = slow_query_treshold
+      end
+
+      def with_logged_query(sql, *args, &_block)
         r0 = Time.now
         rv = yield
-        realtime = Time.now - r0
-        debug "[sql] %.3f secs: %s" % [realtime, format_query(sql, *args)]
+        runtime = Time.now - r0
+
+        logger.debug do
+          "[sql] %.3f secs: %s" % [runtime, Formatting.format(sql, *args)]
+        end
+
+        if slow_query_treshold && runtime > slow_query_treshold
+          log_slow_query(sql, *args, runtime: runtime)
+        end
+
         rv
       rescue StandardError => e
-        realtime = Time.now - r0
-        warn "[sql] %.3f secs: %s:\n\tfailed with error %s" % [realtime, format_query(sql, *args), e.message]
+        runtime = Time.now - r0
+        logger.warn do
+          "[sql] %.3f secs: %s:\n\tfailed with error %s" % [runtime, Formatting.format(sql, *args), e.message]
+        end
+
         raise
       end
 
       private
 
-      def format_query(sql, *args)
-        sql = sql.gsub(/\s*\n\s*/, " ").gsub(/(\A\s+)|(\s+\z)/, "")
-        return sql if args.empty?
-        args = args.map(&:inspect).join(", ")
-        sql + " w/args: #{args}"
+      Formatting = ::Simple::SQL::Formatting
+
+      def log_slow_query(sql, *args, runtime:)
+        # Do not try to analyze an EXPLAIN query. This prevents endless recursion here
+        # (and, in general, would not be useful anyways.)
+        return if sql =~ /^EXPLAIN /
+
+        log_multiple_lines ::Logger::WARN, prefix: "[sql-slow]" do
+          formatted_query = Formatting.pretty_format(sql, *args)
+          query_plan = ::Simple::SQL.all "EXPLAIN ANALYZE #{sql}", *args
+
+          <<~MSG
+            === slow query detected: (#{'%.3f secs' % runtime}) ===================================================================================
+            #{formatted_query}
+            --- query plan: -------------------------------------------------------------------
+            #{query_plan.join("\n")}
+            ===================================================================================
+          MSG
+        end
+      end
+
+      def log_multiple_lines(level, str = nil, prefix:)
+        logger.log(level) do
+          str = yield if str.nil?
+          str = str.gsub("\n", "\n#{prefix} ") if prefix
+          str
+        end
       end
     end
   end

data/lib/simple/sql/reflection.rb

@@ -41,7 +41,7 @@ module Simple
           SELECT table_schema || '.' || table_name AS name, *
           FROM information_schema.tables
           WHERE table_schema=$1
-          SQL
+        SQL
         records_by_attr(recs, :name)
       end
 

data/lib/simple/sql/result/association_loader.rb

@@ -2,6 +2,7 @@
 # rubocop:disable Metrics/MethodLength
 # rubocop:disable Metrics/ParameterLists
 # rubocop:disable Style/GuardClause
+# rubocop:disable Naming/UncommunicativeMethodParamName
 
 require "active_support/core_ext/string/inflections"
 
@@ -164,6 +165,7 @@ module ::Simple::SQL::Result::AssociationLoader # :nodoc:
       if order_by || limit
         raise ArgumentError, "#{association.inspect} is a singular association, w/o support for order_by: and limit:"
       end
+
       preload_belongs_to records, relation, as: as
     else
       preload_has_one_or_many records, relation, as: as, order_by: order_by, limit: limit

data/lib/simple/sql/result/records.rb

@@ -1,4 +1,4 @@
-# xrubocop:disable Metrics/ParameterLists
+# rubocop:disable Naming/UncommunicativeMethodParamName
 
 require_relative "association_loader"
 require "simple/sql/reflection"

data/lib/simple/sql/scope/order.rb

@@ -1,5 +1,3 @@
-
-
 class Simple::SQL::Scope
   def order_by(sql_fragment)
     duplicate.send(:order_by!, sql_fragment)

data/lib/simple/sql/version.rb

@@ -1,5 +1,5 @@
 module Simple
   module SQL
-    VERSION = "0.4.28"
+    VERSION = "0.4.29"
   end
 end

data/simple-sql.gemspec

@@ -38,7 +38,7 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'pg', '0.20'
   gem.add_development_dependency 'rake', '~> 11'
   gem.add_development_dependency 'rspec', '~> 3.7'
-  gem.add_development_dependency 'rubocop', '~> 0.52.1'
+  gem.add_development_dependency 'rubocop', '~> 0.61.1'
   gem.add_development_dependency 'database_cleaner', '~> 1'
   gem.add_development_dependency 'simplecov', '~> 0'
   gem.add_development_dependency 'awesome_print', '~> 0'

data/vendor/.gitignore

@@ -0,0 +1 @@
+pgFormatter-3.1

data/vendor/Makefile

@@ -0,0 +1,4 @@
+pgFormatter-3.1:
+	curl -L -O https://github.com/darold/pgFormatter/archive/v3.1.tar.gz
+	tar xvfz v3.1.tar.gz
+	cd pgFormatter-3.1 && perl Makefile.PL && make && sudo make install

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simple-sql
 version: !ruby/object:Gem::Version
-  version: 0.4.28
+  version: 0.4.29
 platform: ruby
 authors:
 - radiospiel
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-21 00:00:00.000000000 Z
+date: 2018-12-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pg_array_parser
@@ -115,14 +115,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.61.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.52.1
+        version: 0.61.1
 - !ruby/object:Gem::Dependency
   name: database_cleaner
   requirement: !ruby/object:Gem::Requirement
@@ -203,6 +203,7 @@ files:
 - lib/simple/sql/connection.rb
 - lib/simple/sql/connection_adapter.rb
 - lib/simple/sql/duplicate.rb
+- lib/simple/sql/formatting.rb
 - lib/simple/sql/helpers.rb
 - lib/simple/sql/helpers/decoder.rb
 - lib/simple/sql/helpers/encoder.rb
@@ -245,6 +246,8 @@ files:
 - spec/support/004_simplecov.rb
 - spec/support/model/user.rb
 - tasks/release.rake
+- vendor/.gitignore
+- vendor/Makefile
 homepage: http://github.com/radiospiel/simple-sql
 licenses: []
 metadata: {}