whoop 1.0.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e87afc662b392a97fb44f20ec959efbd381c610d79632078feb9fca40f2591c9
-  data.tar.gz: 4710ad20b1dd68ee4215b964767ccb4ad82a863dfa720c6569735be37b03e89d
+  metadata.gz: 81bf8fe803a7a41184c6bf4600abc8059665bbc040d621b3cc39235915d0c80a
+  data.tar.gz: 54f408ce9613144520e6b318af06353d61e997a3891e4c315e712da1b6208159
 SHA512:
-  metadata.gz: 636d9da4424c22bda6c608a69b2bf4e4685b04698a2c960dbafcd479cc4cfe4129512b59bda6055a90745b3be534be31e9f195481353ead1707b9bc468575e1c
-  data.tar.gz: af6eb8555456810f4d3c9a63a06b7f6337c6abd63ea004907618752465435c82f9c6857c7f95e7ff8a8d50646fc01e5c8709ed0091c1f8f8f793bf35dd75b668
+  metadata.gz: b6be592483ea7056091c04733bba3d5c6642f1b28aa52ef2837d07db13c8c555157fce39effb6055c2c3473c2d536db546eebb52e001fcff81837641c02fe5fe
+  data.tar.gz: fbad092eb0aca584c4668df1b1682d948d6b67104e14763b3f884019efdf1ba79b6ee6b2c51290defc9dbee4f4c41d01147c5f88c20c2eda27424d21e96816ae

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    whoop (1.0.3)
+    whoop (1.1.0)
       activerecord (>= 6.1.4)
       activesupport (>= 6.1.4)
       anbt-sql-formatter
@@ -11,12 +11,12 @@ PATH
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (7.0.4)
-      activesupport (= 7.0.4)
-    activerecord (7.0.4)
-      activemodel (= 7.0.4)
-      activesupport (= 7.0.4)
-    activesupport (7.0.4)
+    activemodel (7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activerecord (7.0.4.3)
+      activemodel (= 7.0.4.3)
+      activesupport (= 7.0.4.3)
+    activesupport (7.0.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
@@ -31,25 +31,26 @@ GEM
     colorize (0.8.1)
     commander (4.6.0)
       highline (~> 2.0.0)
-    concurrent-ruby (1.1.10)
+    concurrent-ruby (1.2.2)
     diff-lcs (1.5.0)
     docile (1.4.0)
     highline (2.0.3)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
-    json (2.6.2)
+    json (2.6.3)
+    language_server-protocol (3.17.0.3)
     magic_frozen_string_literal (1.2.0)
     method_source (1.0.0)
-    minitest (5.16.3)
+    minitest (5.18.0)
     parallel (1.22.1)
     parlour (5.0.0)
       commander (~> 4.5)
       parser
       rainbow (~> 3.0)
       sorbet-runtime (>= 0.5)
-    parser (3.1.2.1)
+    parser (3.2.2.0)
       ast (~> 2.4.1)
-    pry (0.14.1)
+    pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
     pry-byebug (3.10.1)
@@ -57,61 +58,62 @@ GEM
       pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
-    regexp_parser (2.5.0)
+    rbs (2.8.4)
+    regexp_parser (2.8.0)
     rexml (3.2.5)
-    rouge (4.0.0)
-    rspec (3.11.0)
-      rspec-core (~> 3.11.0)
-      rspec-expectations (~> 3.11.0)
-      rspec-mocks (~> 3.11.0)
-    rspec-core (3.11.0)
-      rspec-support (~> 3.11.0)
-    rspec-expectations (3.11.0)
+    rouge (4.1.0)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.1)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-mocks (3.11.1)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.11.0)
-    rspec-support (3.11.0)
-    rubocop (1.35.1)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.48.1)
       json (~> 2.3)
       parallel (~> 1.10)
-      parser (>= 3.1.2.1)
+      parser (>= 3.2.0.0)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8, < 3.0)
       rexml (>= 3.2.5, < 4.0)
-      rubocop-ast (>= 1.20.1, < 2.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 3.0)
-    rubocop-ast (1.21.0)
-      parser (>= 3.1.1.0)
-    rubocop-performance (1.14.3)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-performance (1.16.0)
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
-    ruby-progressbar (1.11.0)
-    simplecov (0.16.1)
+    ruby-progressbar (1.13.0)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
-    sorbet-runtime (0.5.10455)
-    sord (4.0.0)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    sorbet-runtime (0.5.10784)
+    sord (5.0.0)
       commander (~> 4.5)
       parlour (~> 5.0)
+      rbs (~> 2.0)
       sorbet-runtime
       yard
-    standard (1.16.1)
-      rubocop (= 1.35.1)
-      rubocop-performance (= 1.14.3)
-    tzinfo (2.0.5)
+    standard (1.26.0)
+      language_server-protocol (~> 3.17.0.2)
+      rubocop (~> 1.48.1)
+      rubocop-performance (~> 1.16.0)
+    tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
-    unicode-display_width (2.3.0)
-    webrick (1.7.0)
-    yard (0.9.28)
-      webrick (~> 1.7.0)
+    unicode-display_width (2.4.2)
+    yard (0.9.34)
 
 PLATFORMS
-  arm64-darwin-21
   x86_64-linux
 
 DEPENDENCIES
@@ -127,4 +129,4 @@ DEPENDENCIES
   whoop!
 
 BUNDLED WITH
-   2.3.22
+   2.4.9

data/lib/generators/whoop/install_generator.rb

@@ -0,0 +1,23 @@
+module Whoop
+  class InstallGenerator < Rails::Generators::Base
+    desc "This generator creates an initializer file for the Whoop gem at config/initializers/whoop.rb, with default settings."
+
+    def install
+      file_contents = <<~TEXT
+        Whoop.setup do |config|
+          config.logger = ActiveSupport::Logger.new("log/debug.log")
+          # config.logger = ActiveSupport::Logger.new("log/\#{Rails.env}.log")
+          # config.logger = ActiveSupport::Logger.new($stdout)
+          # config.logger = nil # uses `puts`
+
+          config.level = :debug # or :info, :warn, :error
+          # config.level = :info
+          # config.level = :warn
+          # config.level = :error
+        end
+      TEXT
+
+      create_file "config/initializers/whoop.rb", file_contents
+    end
+  end
+end

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
@@ -53,7 +92,7 @@ module Whoop
         pretty_explain = []
         pretty_explain += lines.map { |line| " #{line}" }
         nrows = result.rows.length
-        rows_label = nrows == 1 ? "row" : "rows"
+        rows_label = (nrows == 1) ? "row" : "rows"
         pretty_explain << "\n(#{nrows} #{rows_label})"
 
         pretty_explain.join("\n")

data/lib/whoop/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Whoop
-  VERSION = "1.0.3"
+  VERSION = "1.1.0"
 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.1.0
 platform: ruby
 authors:
 - Eric Berry
-autorequire:
+autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-10-03 00:00:00.000000000 Z
+date: 2023-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -222,6 +222,7 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/whoop/install_generator.rb
 - lib/whoop.rb
 - lib/whoop/formatters/json_formatter.rb
 - lib/whoop/formatters/sql_formatter.rb
@@ -235,7 +236,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 +251,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: []