whoop 1.2.0 → 1.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 814754659e61a2179b1a09406e77e18a475ae3a5d7ffed0da3cc53eb1f3ec59f
-  data.tar.gz: bb96421ebb0a670af446b4c8312f9f847722576f8c52f1f41240d04974c8569c
+  metadata.gz: b291c7f848acd58ddae598855d1c2782277ee9da307868db273497e908964636
+  data.tar.gz: a3fa8fe8b1a749893b8fe87b36ccac5732d7cde30bd1e6def15f90c83a9c534e
 SHA512:
-  metadata.gz: a49ee4bf201f1239cb3dfbe829af37c4040a3925ada3af4312e1e18d9344803946052bfb1528eacc11580f5fc6e1fde0dfe2a343f2ccf651b47e010fec448b13
-  data.tar.gz: ea69570c36ff100d9a0bda28938e3f4ecc234f4a043e7c0426371c30ee7f07bfd5119a778e34bd034f902fbee833356d60bf2752d6b9aa08ee87228a48218381
+  metadata.gz: 61bfc9e8af8a082dc18be22535c19619ef39a3ac98222cf2951cbd3ec9723a3de021718b42ea134f99a051b81984f10e117d1674810074715fad7e10f35c2f58
+  data.tar.gz: bd545734157a5ac01cb11e67cfb913fc501081d0fdd7d5f7e84da9976672dd1a2733c26d09855d9b371acbaa1a5fbc7bfe78f99d223227839528430f5f1f7978

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    whoop (1.2.0)
+    whoop (1.3.0)
       activerecord (>= 6.1.4)
       activesupport (>= 6.1.4)
       amazing_print
       anbt-sql-formatter
       colorize
       rouge
+      semantic_logger
 
 GEM
   remote: https://rubygems.org/
@@ -26,7 +27,6 @@ GEM
     anbt-sql-formatter (0.1.0)
     ast (2.4.2)
     bump (0.10.0)
-    byebug (11.1.3)
     codecov (0.6.0)
       simplecov (>= 0.15, < 0.22)
     coderay (1.1.3)
@@ -55,9 +55,6 @@ GEM
     pry (0.14.2)
       coderay (~> 1.1)
       method_source (~> 1.0)
-    pry-byebug (3.10.1)
-      byebug (~> 11.0)
-      pry (>= 0.13, < 0.15)
     rainbow (3.1.1)
     rake (13.0.6)
     rbs (2.8.4)
@@ -93,6 +90,8 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.13.0)
+    semantic_logger (4.15.0)
+      concurrent-ruby (~> 1.0)
     simplecov (0.21.2)
       docile (~> 1.1)
       simplecov-html (~> 0.11)
@@ -117,13 +116,14 @@ GEM
 
 PLATFORMS
   arm64-darwin-22
+  arm64-darwin-23
   x86_64-linux
 
 DEPENDENCIES
   bump
   codecov
   magic_frozen_string_literal
-  pry-byebug
+  pry
   rake
   rspec
   simplecov

data/README.md

@@ -36,6 +36,7 @@ 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 = SemanticLogger["WHOOP"]
   # config.logger = nil # uses `puts`
 
   config.level = :debug
@@ -63,6 +64,7 @@ You can pass any options into the `whoop` method to change the output.
 - `caller_depth` - the depth of the caller to use for the source (default: 0)
 - `explain` - whether to run `EXPLAIN` on the SQL query (default: false)
 - `context` - a hash of key/value pairs to include in the output
+- `tags` - an array of tags to include in the output
 
 ## Examples
 

data/lib/whoop/version.rb

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

data/lib/whoop.rb

@@ -3,6 +3,8 @@
 require "active_support"
 require "colorize"
 require "rouge"
+require "semantic_logger"
+
 require_relative "whoop/version"
 require_relative "whoop/formatters/json_formatter"
 require_relative "whoop/formatters/pretty_formatter"
@@ -40,9 +42,10 @@ module Whoop
     # @param [String] pattern - the pattern to use for the line (e.g. '-')
     # @param [Integer] count - the number of times to repeat the pattern per line (e.g. 80)
     # @param [Symbol] color - the color to use for the line (e.g. :red)
-    # @param [Symbol] format - the format to use for the message (one of :json, :sql, :plain, :pretty (default))
+    # @param [Symbol] format - the format to use for the message (one of :json, :sql, :plain, :semantic, :pretty (default))
     # @param [Integer] caller_depth - the depth of the caller to use for the source (default: 0)
     # @param [Boolean] explain - whether to explain the SQL query (default: false)
+    # @param [Array<String, Symbol>] tags - Any tags you'd like to include in the log
     # @param [Hash] context - Any additional context you'd like to include in the log
     def whoop(
       label = nil,
@@ -52,14 +55,35 @@ module Whoop
       format: :pretty,
       caller_depth: 0,
       explain: false,
+      tags: [],
       context: nil
     )
+      message = block_given? ? yield : label
+
+      if Whoop.logger.is_a?(SemanticLogger::Logger)
+        context ||= {}
+
+        if tags.length > 0
+          Whoop.logger.tagged(*tags) do
+            Whoop.logger.send(Whoop.level.to_sym, message, **context)
+          end
+        else
+          Whoop.logger.send(Whoop.level.to_sym, message, **context)
+        end
+
+        return
+      end
+
+      if tags.length > 0
+        context ||= {}
+        context[:tags] = tags
+      end
+
       logger_method = detect_logger_method
       color_method = detect_color_method(color)
       formatter_method = detect_formatter_method(format, colorize: color.present?, explain: explain)
-
-      line = pattern * count
       caller_path = clean_caller_path(caller[caller_depth])
+      line = pattern * count
       caller_path_line = [color_method.call(INDENT), "source:".colorize(:light_black).underline, caller_path].join(" ")
       timestamp_line = [color_method.call(INDENT), "timestamp:".colorize(:light_black).underline, Time.now].join(" ")
 
@@ -72,38 +96,23 @@ module Whoop
           []
         end
 
-      if block_given?
-        result = yield
-        top_line =
-          if label.present? && label.is_a?(String)
-            wrapped_line(label.to_s, pattern: pattern, count: count)
-          else
-            pattern * count
-          end
-        result.tap do
-          logger_method.call color_method.call "\n\n#{TOP_LINE_CHAR}#{top_line}"
-          logger_method.call timestamp_line
-          logger_method.call caller_path_line
-          context_lines.each { |l| logger_method.call l }
-          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
-        tap do
-          logger_method.call color_method.call "\n\n#{TOP_LINE_CHAR}#{line}"
-          logger_method.call timestamp_line
-          logger_method.call caller_path_line
-          context_lines.each { |l| logger_method.call l }
-          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"
+      top_line =
+        if label.present? && label.is_a?(String)
+          wrapped_line(label.to_s, pattern: pattern, count: count)
+        else
+          pattern * count
         end
-      end
+
+      logger_method.call color_method.call top_line
+      logger_method.call color_method.call "\n\n#{TOP_LINE_CHAR}#{top_line}"
+      logger_method.call timestamp_line
+      logger_method.call caller_path_line
+      context_lines.each { |l| logger_method.call l }
+      logger_method.call ""
+      logger_method.call formatter_method.call(message)
+      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
 
     private
@@ -140,9 +149,11 @@ module Whoop
     end
 
     # Return the format method to use
-    # @param [Symbol] format
+    # @param [Symbol] format - one of :json, :sql, :pretty, :semantic, :plain
+    # @param [Hash] context - the context provided
+    # @param [Boolean] explain - if format is sql, execute the explain on the query
     # @return [Method] format method
-    def detect_formatter_method(format, colorize: false, explain: false)
+    def detect_formatter_method(format, context: {}, colorize: false, explain: false)
       case format.to_sym
       when :json
         ->(message) { Whoop::Formatters::JsonFormatter.format(message, colorize: colorize) }
@@ -150,6 +161,8 @@ module Whoop
         ->(message) { Whoop::Formatters::SqlFormatter.format(message, colorize: colorize, explain: explain) }
       when :pretty
         ->(message) { Whoop::Formatters::PrettyFormatter.format(message) }
+      when :semantic
+        ->(message, context = {}) { Whoop::Formatters::PrettyFormatter.format(message, **context) }
       else
         ->(message) { message }
       end

data/sig/whoop.rbs

@@ -29,12 +29,14 @@ module Whoop
     # 
     # _@param_ `color` — - the color to use for the line (e.g. :red)
     # 
-    # _@param_ `format` — - the format to use for the message (one of :json, :sql, :plain, :pretty (default))
+    # _@param_ `format` — - the format to use for the message (one of :json, :sql, :plain, :semantic, :pretty (default))
     # 
     # _@param_ `caller_depth` — - the depth of the caller to use for the source (default: 0)
     # 
     # _@param_ `explain` — - whether to explain the SQL query (default: false)
     # 
+    # _@param_ `tags` — - Any tags you'd like to include in the log
+    # 
     # _@param_ `context` — - Any additional context you'd like to include in the log
     def whoop: (
                  ?String? label,
@@ -44,6 +46,7 @@ module Whoop
                  ?format: Symbol,
                  ?caller_depth: Integer,
                  ?explain: bool,
+                 ?tags: ::Array[(String | Symbol)],
                  ?context: ::Hash[untyped, untyped]?
                ) -> untyped
 
@@ -65,13 +68,21 @@ module Whoop
     def detect_logger_method: () -> Method
 
     # sord omit - no YARD type given for "colorize:", using untyped
-    # sord omit - no YARD type given for "explain:", using untyped
     # Return the format method to use
     # 
-    # _@param_ `format`
+    # _@param_ `format` — - one of :json, :sql, :pretty, :semantic, :plain
+    # 
+    # _@param_ `context` — - the context provided
+    # 
+    # _@param_ `explain` — - if format is sql, execute the explain on the query
     # 
     # _@return_ — format method
-    def detect_formatter_method: (Symbol format, ?colorize: untyped, ?explain: untyped) -> Method
+    def detect_formatter_method: (
+                                   Symbol format,
+                                   ?context: ::Hash[untyped, untyped],
+                                   ?colorize: untyped,
+                                   ?explain: bool
+                                 ) -> Method
 
     # sord omit - no YARD type given for "format", using untyped
     # sord omit - no YARD type given for "color_method", using untyped
@@ -89,6 +100,52 @@ module Whoop
     def wrapped_line: (String label, ?count: Integer, ?pattern: String) -> String
   end
 
+  module Constants
+    class ICONS
+      CHECKMARK: untyped
+      TIMES: untyped
+      PLUS: untyped
+      MINUS: untyped
+    end
+
+    class COLORS
+      BLACK: untyped
+      RED: untyped
+      GREEN: untyped
+      YELLOW: untyped
+      BLUE: untyped
+      MAGENTA: untyped
+      CYAN: untyped
+      WHITE: untyped
+      DEFAULT: untyped
+      LIGHT_BLACK: untyped
+      LIGHT_RED: untyped
+      LIGHT_GREEN: untyped
+      LIGHT_YELLOW: untyped
+      LIGHT_BLUE: untyped
+      LIGHT_MAGENTA: untyped
+      LIGHT_CYAN: untyped
+      LIGHT_WHITE: untyped
+    end
+
+    class MODES
+      DEFAULT: untyped
+      BOLD: untyped
+      DIM: untyped
+      ITALIC: untyped
+      UNDERLINE: untyped
+      BLINK: untyped
+      BLINK_SLOW: untyped
+      BLINK_FAST: untyped
+      INVERT: untyped
+      HIDE: untyped
+      STRIKE: untyped
+      DOUBLE_UNDERLINE: untyped
+      REVEAL: untyped
+      OVERLINED: untyped
+    end
+  end
+
   module Formatters
     module SqlFormatter
       PATTERNS_TO_PRESERVE: untyped

data/whoop.gemspec

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require_relative "lib/whoop/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "whoop"
+  spec.version = Whoop::VERSION
+  spec.authors = ["Eric Berry"]
+  spec.email = ["eric@berry.sh"]
+
+  spec.summary = "A simple gem to help you whoop your logs into shape."
+  spec.description = spec.summary
+  spec.homepage = "https://github.com/coderberry/whoop"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = spec.homepage
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord", ">= 6.1.4"
+  spec.add_dependency "activesupport", ">= 6.1.4"
+  spec.add_dependency "amazing_print"
+  spec.add_dependency "anbt-sql-formatter"
+  spec.add_dependency "colorize"
+  spec.add_dependency "rouge"
+  spec.add_dependency "semantic_logger"
+
+  spec.add_development_dependency "magic_frozen_string_literal"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "standard"
+  spec.add_development_dependency "bump"
+  spec.add_development_dependency "sord"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "codecov"
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whoop
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Eric Berry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-07-10 00:00:00.000000000 Z
+date: 2024-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -38,6 +38,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 6.1.4
+- !ruby/object:Gem::Dependency
+  name: amazing_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: anbt-sql-formatter
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: amazing_print
+  name: semantic_logger
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +123,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -243,6 +257,7 @@ files:
 - lib/whoop/formatters/sql_formatter.rb
 - lib/whoop/version.rb
 - sig/whoop.rbs
+- whoop.gemspec
 homepage: https://github.com/coderberry/whoop
 licenses:
 - MIT
@@ -265,7 +280,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.14
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A simple gem to help you whoop your logs into shape.