whoop 1.0.3 → 1.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87afc662b392a97fb44f20ec959efbd381c610d79632078feb9fca40f2591c9
-  data.tar.gz: 4710ad20b1dd68ee4215b964767ccb4ad82a863dfa720c6569735be37b03e89d
+  metadata.gz: a9b6642d169f36ac114748f02515b804646a7981f244475c41fa053456d93c08
+  data.tar.gz: ca2a36f9da6922d998189ea808bd3976684e3cf2919fb7c4ed9672408591fce7
 SHA512:
-  metadata.gz: 636d9da4424c22bda6c608a69b2bf4e4685b04698a2c960dbafcd479cc4cfe4129512b59bda6055a90745b3be534be31e9f195481353ead1707b9bc468575e1c
-  data.tar.gz: af6eb8555456810f4d3c9a63a06b7f6337c6abd63ea004907618752465435c82f9c6857c7f95e7ff8a8d50646fc01e5c8709ed0091c1f8f8f793bf35dd75b668
+  metadata.gz: eee07b43704595c415ec3eb4e36cf5ea2b9215982d22f7f5f1d0e7e9565c408dbaa4e41f43385c79c8089f1740907c2c21d8a2bcd9b5d74f64f103433774446a
+  data.tar.gz: 4865c548afe2113e7218ebde457eea291f9152c3bcecae84d684581e4ad9c397b6af965668623d4f581a571062881759d5681a6475cb570f04d9571f224b8eed

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whoop (1.0.3)
+    whoop (1.0.2)
       activerecord (>= 6.1.4)
       activesupport (>= 6.1.4)
       anbt-sql-formatter

data/lib/whoop/formatters/sql_formatter.rb

@@ -6,6 +6,33 @@ require "active_record"
 module Whoop
   module Formatters
     module SqlFormatter
+      # Hash of patterns to preserve in the SQL. The key is the expected pattern,
+      # the value is the pattern after it has been "broken" by anbt formatting.
+      # Instances of the value are replaced by the key.
+      # Patterns are jsonb column operators from https://www.postgresql.org/docs/15/functions-json.html
+      PATTERNS_TO_PRESERVE = {
+        # jsonb operators without surrounding spaces
+        # IE, the first one replaces " : : " with "::"
+        "::" => /\s?: :\s?/,
+        "->>" => /\s?- > >\s?/,
+        "->" => /\s?- >\s?/,
+        "#>>" => /\s?# > >\s?/,
+        "#>" => /\s?# >\s?/,
+
+        # jsonb operators with surrounding spaces
+        # IE, the first one replaces " @ > " with " @> "
+        " @> " => /\s?@ >\s?/,
+        " <@ " => /\s?< @\s?/,
+        " ?| " => /\s?\? \|\s?/,
+        " ?& " => /\s?\? &\s?/,
+        " || " => /\s?\| \|\s?/,
+        " #- " => /\s?# -\s?/,
+
+        # Additional broken patterns
+        "[" => /\[\s?/,
+        "]" => /\s?\]/
+      }
+
       # Format the SQL query
       # @param [String] sql The SQL query
       # @param [Boolean] colorize - colorize the SQL query (default: false)
@@ -39,8 +66,20 @@ module Whoop
       def self.generate_pretty_sql(sql)
         rule = AnbtSql::Rule.new
         rule.indent_string = "  "
+
         formatter = AnbtSql::Formatter.new(rule)
-        formatter.format(sql.dup)
+        formatted_string = formatter.format(sql.dup)
+
+        # Anbt injects additional spaces into joined symbols.
+        # This removes them by generating the "broken" collection
+        # of symbols, and replacing them with the original.
+        PATTERNS_TO_PRESERVE.each do |correct_pattern, incorrect_pattern|
+          next unless incorrect_pattern.match?(formatted_string)
+
+          formatted_string.gsub!(incorrect_pattern, correct_pattern)
+        end
+
+        formatted_string
       end
 
       # Execute the `EXPLAIN` query

data/lib/whoop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whoop
-  VERSION = "1.0.3"
+  VERSION = "1.0.4"
 end

data/lib/whoop.rb

@@ -87,6 +87,7 @@ module Whoop
           logger_method.call ""
           logger_method.call formatter_method.call(result)
           logger_method.call ""
+          display_invalid_format_message(format, color_method, logger_method)
           logger_method.call color_method.call "#{BOTTOM_LINE_CHAR}#{line}\n\n"
         end
       else
@@ -98,6 +99,7 @@ module Whoop
           logger_method.call ""
           logger_method.call formatter_method.call(label)
           logger_method.call ""
+          display_invalid_format_message(format, color_method, logger_method)
           logger_method.call color_method.call "#{BOTTOM_LINE_CHAR}#{line}\n\n"
         end
       end
@@ -150,6 +152,13 @@ module Whoop
       end
     end
 
+    def display_invalid_format_message(format, color_method, logger_method)
+      return if FORMATS.include?(format)
+
+      invalid_format_line = [color_method.call(INDENT), "note:".colorize(:blue).underline, "Unsupported format used. Available formats: #{FORMATS.to_sentence}"].join(" ")
+      logger_method.call invalid_format_line
+    end
+
     # Return the line with the label centered in it
     # @param [String] label
     # @param [Integer] count

data/sig/whoop.rbs

@@ -73,6 +73,12 @@ module Whoop
     # _@return_ — format method
     def detect_formatter_method: (Symbol format, ?colorize: untyped, ?explain: untyped) -> Method
 
+    # sord omit - no YARD type given for "format", using untyped
+    # sord omit - no YARD type given for "color_method", using untyped
+    # sord omit - no YARD type given for "logger_method", using untyped
+    # sord omit - no YARD return type given, using untyped
+    def display_invalid_format_message: (untyped format, untyped color_method, untyped logger_method) -> untyped
+
     # Return the line with the label centered in it
     # 
     # _@param_ `label`
@@ -85,6 +91,8 @@ module Whoop
 
   module Formatters
     module SqlFormatter
+      PATTERNS_TO_PRESERVE: untyped
+
       # Format the SQL query
       # 
       # _@param_ `sql` — The SQL query

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whoop
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.0.4
 platform: ruby
 authors:
 - Eric Berry
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2023-04-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -235,7 +235,7 @@ metadata:
   homepage_uri: https://github.com/coderberry/whoop
   source_code_uri: https://github.com/coderberry/whoop
   changelog_uri: https://github.com/coderberry/whoop
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -250,8 +250,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.4.6
+signing_key: 
 specification_version: 4
 summary: A simple gem to help you whoop your logs into shape.
 test_files: []