whoop 1.0.1 → 1.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8a3377a8066ffe3e56b4c0bda3edb7763d54397116e73fb10dcfeca91c16b49f
-  data.tar.gz: cba013c48234104ebe5d955ecc5d838f19146985b9592297fb2b6c81725144f2
+  metadata.gz: e87afc662b392a97fb44f20ec959efbd381c610d79632078feb9fca40f2591c9
+  data.tar.gz: 4710ad20b1dd68ee4215b964767ccb4ad82a863dfa720c6569735be37b03e89d
 SHA512:
-  metadata.gz: 75b4c83644abbe37fc838020c324090ab233c9ccdc46c114025959a91cd7fb46c5fbfef363ce763f71c55f3f18adf3431f098d33ef768c6ecf21676bf34a1a27
-  data.tar.gz: e6dbb3c9e707b29f8feab0eb244d78561ae015ece90eb0c49d100c8987d10dce4035e846c43cffdc73a52905e6000ce90dbcda8b912fecaaf232dd47b29a0ad1
+  metadata.gz: 636d9da4424c22bda6c608a69b2bf4e4685b04698a2c960dbafcd479cc4cfe4129512b59bda6055a90745b3be534be31e9f195481353ead1707b9bc468575e1c
+  data.tar.gz: af6eb8555456810f4d3c9a63a06b7f6337c6abd63ea004907618752465435c82f9c6857c7f95e7ff8a8d50646fc01e5c8709ed0091c1f8f8f793bf35dd75b668

data/Gemfile.lock

@@ -1,9 +1,9 @@
 PATH
   remote: .
   specs:
-    whoop (1.0.1)
-      activerecord
-      activesupport
+    whoop (1.0.3)
+      activerecord (>= 6.1.4)
+      activesupport (>= 6.1.4)
       anbt-sql-formatter
       colorize
       rouge
@@ -25,12 +25,15 @@ GEM
     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)
     colorize (0.8.1)
     commander (4.6.0)
       highline (~> 2.0.0)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
+    docile (1.4.0)
     highline (2.0.3)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
@@ -86,6 +89,11 @@ GEM
       rubocop (>= 1.7.0, < 2.0)
       rubocop-ast (>= 0.4.0)
     ruby-progressbar (1.11.0)
+    simplecov (0.16.1)
+      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)
       commander (~> 4.5)
@@ -104,13 +112,16 @@ GEM
 
 PLATFORMS
   arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bump
+  codecov
   magic_frozen_string_literal
   pry-byebug
   rake
   rspec
+  simplecov
   sord
   standard
   whoop!

data/README.md

@@ -1,8 +1,9 @@
 # Whoop
 
 [![Gem Version](https://badge.fury.io/rb/whoop.svg)](https://badge.fury.io/rb/whoop)
+[![Contribute](https://img.shields.io/badge/Contribute%20with-Gitpod-908a85?logo=gitpod)](https://gitpod.io/#https://github.com/coderberry/whoop)
 [![Maintainability](https://api.codeclimate.com/v1/badges/1ffd27fe59383a4ff52b/maintainability)](https://codeclimate.com/github/coderberry/whoop/maintainability)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/1ffd27fe59383a4ff52b/test_coverage)](https://codeclimate.com/github/coderberry/whoop/test_coverage)
+[![codecov](https://codecov.io/gh/coderberry/whoop/branch/main/graph/badge.svg?token=E906B6SEKD)](https://codecov.io/gh/coderberry/whoop)
 [![Tests](https://github.com/coderberry/whoop/actions/workflows/tests.yml/badge.svg)](https://github.com/coderberry/whoop/actions/workflows/tests.yml)
 [![CodeQL](https://github.com/coderberry/whoop/actions/workflows/codeql-analysis.yml/badge.svg)](https://github.com/coderberry/whoop/actions/workflows/codeql-analysis.yml)
 [![StandardRB](https://github.com/coderberry/whoop/actions/workflows/standardrb.yml/badge.svg)](https://github.com/coderberry/whoop/actions/workflows/standardrb.yml)
@@ -13,6 +14,8 @@
 
 Whoop is a Ruby logging library with built-in formatting and colorization.
 
+To try **whoop** within your browser, visit the [whoop playground](https://replit.com/@coderberry/whoop-playground).
+
 ## Installation
 
 Install the gem and add to the application's Gemfile by executing:
@@ -34,7 +37,7 @@ Whoop.setup do |config|
   # config.logger = ActiveSupport::Logger.new("log/#{Rails.env}.log")
   # config.logger = ActiveSupport::Logger.new($stdout)
   # config.logger = nil # uses `puts`
-  
+
   config.level = :debug
   # config.level = :info
   # config.level = :warn
@@ -50,11 +53,189 @@ The `whoop` method is accessible from any object. See specs for more examples.
 whoop "Hello, World!"
 ```
 
-### Formatters
-TODO
+You can pass any options into the `whoop` method to change the output.
+
+- `label` (first argument) - Either the object or title if a block is passed (see below)
+- `pattern` - String character to use for the line (default is `-`)
+- `count` - the number of times to repeat the pattern per line (e.g. 80)
+- `color` - the color to use for the line (e.g. :red)
+- `format` - the format to use for the message (one of `:json`, `:sql`, `:plain`)
+- `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
+
+## Examples
+
+```ruby
+whoop "Hello"
+
+# log/debug.log
+# ┏--------------------------------------------------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:12
+#
+# Hello
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
+```ruby
+whoop("My Label", color: :green) { "Hello" }
+
+# log/debug.log (the colors don't appear in markdown)
+# ┏------------------------------------ My Label ------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:26
+#
+# Hello
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
+```ruby
+whoop({hello: "world"}, format: :json, color: false)
+
+# ┏--------------------------------------------------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:39
+#
+# {
+#   "hello": "world"
+# }
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
+```ruby
+whoop("This message includes context", color: false, context: {user: "Eric", ip_address: "127.0.0.1"})
+
+# ┏--------------------------------------------------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:39
+# ┆ user: Eric
+# ┆ ip_address: 127.0.0.1
+#
+# This message includes context
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
+```ruby
+sql = 'SELECT emp_id, first_name,last_name,dept_id,mgr_id, ' +
+      'WIDTH_BUCKET(department_id,20,40,10) "Exists in Dept" ' +
+      'FROM emp WHERE mgr_id < 300 ORDER BY "Exists in Dept"'
+
+whoop(sql, format: :sql)
+
+# ┏--------------------------------------------------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:52
+#
+# SELECT
+#     emp_id
+#     ,first_name
+#     ,last_name
+#     ,dept_id
+#     ,mgr_id
+#     ,WIDTH_BUCKET (
+#       department_id
+#       ,20
+#       ,40
+#       ,10
+#     ) "Exists in Dept"
+#   FROM
+#     emp
+#   WHERE
+#     mgr_id < 300
+#   ORDER BY
+#     "Exists in Dept"
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
+#### Auto-explain SQL queries
+
+In addition to formatting the SQL query, you can also ask whoop to perform an
+`explain` on the query by using the `explain: true` argument.
+
+Example (using the Example 1 sample plan from explain.dalibo.com):
+
+```ruby
+sql = <<~SQL
+    SELECT rel_users_exams.user_username AS rel_users_exams_user_username,
+             rel_users_exams.exam_id AS rel_users_exams_exam_id,
+             rel_users_exams.started_at AS rel_users_exams_started_at,
+             rel_users_exams.finished_at AS rel_users_exams_finished_at,
+             exam_1.id AS exam_1_id,
+             exam_1.title AS exam_1_title,
+             exam_1.date_from AS exam_1_date_from,
+             exam_1.date_to AS exam_1_date_to,
+             exam_1.created AS exam_1_created,
+             exam_1.created_by_ AS exam_1_created_by_,
+             exam_1.duration AS exam_1_duration,
+             exam_1.success_threshold AS exam_1_success_threshold,
+             exam_1.published AS exam_1_published
+    FROM rel_users_exams LEFT OUTER
+    JOIN exam AS exam_1
+        ON exam_1.id = rel_users_exams.exam_id
+    WHERE 1 = rel_users_exams.exam_id;
+SQL
+
+whoop("SQL with Explain", format: :sql, explain: true) { sql }
+
+# ┏-------------------------------- SQL with Explain --------------------------------
+# ┆ timestamp: 2022-09-26 14:50:11 -0600
+# ┆ source: (irb):23:in `<top (required)>'
+#
+# sql:
+#
+# SELECT
+#     rel_users_exams.user_username AS rel_users_exams_user_username
+#     ,rel_users_exams.exam_id AS rel_users_exams_exam_id
+#     ,rel_users_exams.started_at AS rel_users_exams_started_at
+#     ,rel_users_exams.finished_at AS rel_users_exams_finished_at
+#     ,exam_1.id AS exam_1_id
+#     ,exam_1.title AS exam_1_title
+#     ,exam_1.date_from AS exam_1_date_from
+#     ,exam_1.date_to AS exam_1_date_to
+#     ,exam_1.created AS exam_1_created
+#     ,exam_1.created_by_ AS exam_1_created_by_
+#     ,exam_1.duration AS exam_1_duration
+#     ,exam_1.success_threshold AS exam_1_success_threshold
+#     ,exam_1.published AS exam_1_published
+#   FROM
+#     rel_users_exams LEFT OUTER JOIN exam AS exam_1
+#       ON exam_1.id = rel_users_exams.exam_id
+#   WHERE
+#     1 = rel_users_exams.exam_id
+# ;
+#
+# query plan:
+#
+# Nested Loop Left Join  (cost=11.95..28.52 rows=5 width=157) (actual time=0.010..0.010 rows=0 loops=1)
+#   Output: rel_users_exams.user_username, rel_users_exams.exam_id, rel_users_exams.started_at, rel_users_exams.finished_at, exam_1.id, exam_1.title, exam_1.date_from, exam_1.date_to, exam_1.created, exam_1.created_by_, exam_1.duration, exam_1.success_threshold, exam_1.published
+#   Inner Unique: true
+#   Join Filter: (exam_1.id = rel_users_exams.exam_id)
+#   Buffers: shared hit=1
+#   ->  Bitmap Heap Scan on public.rel_users_exams  (cost=11.80..20.27 rows=5 width=52) (actual time=0.009..0.009 rows=0 loops=1)
+#         Output: rel_users_exams.user_username, rel_users_exams.exam_id, rel_users_exams.started_at, rel_users_exams.finished_at
+#         Recheck Cond: (1 = rel_users_exams.exam_id)
+#         Buffers: shared hit=1
+#         ->  Bitmap Index Scan on rel_users_exams_pkey  (cost=0.00..11.80 rows=5 width=0) (actual time=0.005..0.005 rows=0 loops=1)
+#               Index Cond: (1 = rel_users_exams.exam_id)
+#               Buffers: shared hit=1
+#   ->  Materialize  (cost=0.15..8.17 rows=1 width=105) (never executed)
+#         Output: exam_1.id, exam_1.title, exam_1.date_from, exam_1.date_to, exam_1.created, exam_1.created_by_, exam_1.duration, exam_1.success_threshold, exam_1.published
+#         ->  Index Scan using exam_pkey on public.exam exam_1  (cost=0.15..8.17 rows=1 width=105) (never executed)
+#               Output: exam_1.id, exam_1.title, exam_1.date_from, exam_1.date_to, exam_1.created, exam_1.created_by_, exam_1.duration,
+# exam_1.success_threshold, exam_1.published
+#               Index Cond: (exam_1.id = 1)
+# Planning Time: 1.110 ms
+# Execution Time: 0.170 ms
+# 
+# ┗--------------------------------------------------------------------------------
+```
 
-### Colors
-TODO
 
 ## Development
 

data/Rakefile

@@ -22,6 +22,7 @@ end
 
 task publish: :build do
   system "gem push #{GEM_NAME}-#{GEM_VERSION}.gem"
+  system "gem push --key github --host https://rubygems.pkg.github.com/coderberry #{GEM_NAME}-#{GEM_VERSION}.gem"
 end
 
 task :clean do

data/lib/whoop/version.rb

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

data/lib/whoop.rb

@@ -30,6 +30,9 @@ module Whoop
     FORMATS = %i[plain json sql].freeze
     PATTERN = "-"
     COUNT = 80
+    INDENT = "┆"
+    TOP_LINE_CHAR = "┏"
+    BOTTOM_LINE_CHAR = "┗"
 
     # Log the message to the logger
     # @param [String] label (optional) - the label or object to log
@@ -39,15 +42,34 @@ module Whoop
     # @param [Symbol] format - the format to use for the message (one of :json, :sql, :plain)
     # @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)
-    def whoop(label = nil, pattern: PATTERN, count: COUNT, color: :default, format: :plain, caller_depth: 0, explain: false)
+    # @param [Hash] context - Any additional context you'd like to include in the log
+    def whoop(
+      label = nil,
+      pattern: PATTERN,
+      count: COUNT,
+      color: :default,
+      format: :plain,
+      caller_depth: 0,
+      explain: false,
+      context: nil
+    )
       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])
-      caller_path_line = ["source:".colorize(:light_black).underline, caller_path].join(" ")
-      timestamp_line = ["timestamp:".colorize(:light_black).underline, Time.now].join(" ")
+      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(" ")
+
+      context_lines =
+        if context.is_a?(Hash) && context.keys.length > 0
+          context.map do |k, v|
+            [color_method.call(INDENT), "#{k}:".colorize(:light_black).underline, v].join(" ")
+          end
+        else
+          []
+        end
 
       if block_given?
         result = yield
@@ -58,21 +80,25 @@ module Whoop
             pattern * count
           end
         result.tap do
-          logger_method.call color_method.call "\n\n#{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(result)
-          logger_method.call color_method.call "#{line}\n\n"
+          logger_method.call ""
+          logger_method.call color_method.call "#{BOTTOM_LINE_CHAR}#{line}\n\n"
         end
       else
         tap do
-          logger_method.call color_method.call "\n\n#{line}"
+          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 color_method.call "#{line}\n\n"
+          logger_method.call ""
+          logger_method.call color_method.call "#{BOTTOM_LINE_CHAR}#{line}\n\n"
         end
       end
     end

data/sig/whoop.rbs

@@ -5,17 +5,18 @@
 module Whoop
   VERSION: untyped
 
-  # sord warn - Whoop::Configuration wasn't able to be resolved to a constant in this project
+  # sord omit - no YARD return type given, using untyped
   # Configure the logger
-  # 
-  # _@return_ — The configuration object
-  def self.setup: () -> Whoop::Configuration
+  def self.setup: () -> untyped
 
   module Main
     COLORS: untyped
     FORMATS: untyped
     PATTERN: untyped
     COUNT: untyped
+    INDENT: untyped
+    TOP_LINE_CHAR: untyped
+    BOTTOM_LINE_CHAR: untyped
 
     # sord omit - no YARD return type given, using untyped
     # Log the message to the logger
@@ -33,6 +34,8 @@ module Whoop
     # _@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_ `context` — - Any additional context you'd like to include in the log
     def whoop: (
                  ?String? label,
                  ?pattern: String,
@@ -40,7 +43,8 @@ module Whoop
                  ?color: Symbol,
                  ?format: Symbol,
                  ?caller_depth: Integer,
-                 ?explain: bool
+                 ?explain: bool,
+                 ?context: ::Hash[untyped, untyped]?
                ) -> untyped
 
     # Remove the Rails.root from the caller path

data/whoop.gemspec

@@ -0,0 +1,47 @@
+# 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 "anbt-sql-formatter"
+  spec.add_dependency "colorize"
+  spec.add_dependency "rouge"
+
+  spec.add_development_dependency "magic_frozen_string_literal"
+  spec.add_development_dependency "pry-byebug"
+  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.0.1
+  version: 1.0.3
 platform: ruby
 authors:
 - Eric Berry
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-23 00:00:00.000000000 Z
+date: 2022-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 6.1.4
 - !ruby/object:Gem::Dependency
   name: anbt-sql-formatter
   requirement: !ruby/object:Gem::Requirement
@@ -178,6 +178,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: codecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A simple gem to help you whoop your logs into shape.
 email:
 - eric@berry.sh
@@ -194,17 +222,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- cc-test-reporter
 - lib/whoop.rb
 - lib/whoop/formatters/json_formatter.rb
 - lib/whoop/formatters/sql_formatter.rb
 - lib/whoop/version.rb
 - sig/whoop.rbs
+- whoop.gemspec
 homepage: https://github.com/coderberry/whoop
 licenses:
 - MIT
 metadata:
-  allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/coderberry/whoop
   source_code_uri: https://github.com/coderberry/whoop
   changelog_uri: https://github.com/coderberry/whoop