whoop 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81bf8fe803a7a41184c6bf4600abc8059665bbc040d621b3cc39235915d0c80a
-  data.tar.gz: 54f408ce9613144520e6b318af06353d61e997a3891e4c315e712da1b6208159
+  metadata.gz: 814754659e61a2179b1a09406e77e18a475ae3a5d7ffed0da3cc53eb1f3ec59f
+  data.tar.gz: bb96421ebb0a670af446b4c8312f9f847722576f8c52f1f41240d04974c8569c
 SHA512:
-  metadata.gz: b6be592483ea7056091c04733bba3d5c6642f1b28aa52ef2837d07db13c8c555157fce39effb6055c2c3473c2d536db546eebb52e001fcff81837641c02fe5fe
-  data.tar.gz: fbad092eb0aca584c4668df1b1682d948d6b67104e14763b3f884019efdf1ba79b6ee6b2c51290defc9dbee4f4c41d01147c5f88c20c2eda27424d21e96816ae
+  metadata.gz: a49ee4bf201f1239cb3dfbe829af37c4040a3925ada3af4312e1e18d9344803946052bfb1528eacc11580f5fc6e1fde0dfe2a343f2ccf651b47e010fec448b13
+  data.tar.gz: ea69570c36ff100d9a0bda28938e3f4ecc234f4a043e7c0426371c30ee7f07bfd5119a778e34bd034f902fbee833356d60bf2752d6b9aa08ee87228a48218381

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    whoop (1.1.0)
+    whoop (1.2.0)
       activerecord (>= 6.1.4)
       activesupport (>= 6.1.4)
+      amazing_print
       anbt-sql-formatter
       colorize
       rouge
@@ -21,6 +22,7 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    amazing_print (1.5.0)
     anbt-sql-formatter (0.1.0)
     ast (2.4.2)
     bump (0.10.0)
@@ -114,6 +116,7 @@ GEM
     yard (0.9.34)
 
 PLATFORMS
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -59,7 +59,7 @@ You can pass any options into the `whoop` method to change the output.
 - `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`)
+- `format` - the format to use for the message (one of `:json`, `:sql`, `:plain`, `:pretty`)
 - `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
@@ -106,6 +106,23 @@ whoop({hello: "world"}, format: :json, color: false)
 # ┗--------------------------------------------------------------------------------
 ```
 
+```ruby
+user = User.first # or some object
+whoop(user, format: :pretty)
+
+# ┏--------------------------------------------------------------------------------
+# ┆ timestamp: 2022-09-26 14:28:06 -0600
+# ┆ source: /spec/whoop_spec.rb:39
+#
+# User {
+#         :id => 1,
+#       :name => "Eric",
+#   :location => "Utah"
+# }
+# 
+# ┗--------------------------------------------------------------------------------
+```
+
 ```ruby
 whoop("This message includes context", color: false, context: {user: "Eric", ip_address: "127.0.0.1"})
 

data/lib/generators/whoop/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 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."

data/lib/whoop/formatters/pretty_formatter.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "amazing_print"
+
+module Whoop
+  module Formatters
+    module PrettyFormatter
+      # Format the message using AwesomePrint
+      # @param [String] message The object/class/message
+      # @return [String] The formatted message
+      def self.format(message)
+        message.ai
+      end
+    end
+  end
+end

data/lib/whoop/version.rb

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

data/lib/whoop.rb

@@ -5,6 +5,7 @@ require "colorize"
 require "rouge"
 require_relative "whoop/version"
 require_relative "whoop/formatters/json_formatter"
+require_relative "whoop/formatters/pretty_formatter"
 require_relative "whoop/formatters/sql_formatter"
 
 # Whoop.setup do |config|
@@ -27,7 +28,7 @@ module Whoop
 
   module Main
     COLORS = %i[black red green yellow blue magenta cyan white light_black light_red light_green light_yellow light_blue light_magenta light_cyan light_white default].freeze
-    FORMATS = %i[plain json sql].freeze
+    FORMATS = %i[plain pretty json sql].freeze
     PATTERN = "-"
     COUNT = 80
     INDENT = "┆"
@@ -39,7 +40,7 @@ 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)
+    # @param [Symbol] format - the format to use for the message (one of :json, :sql, :plain, :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 [Hash] context - Any additional context you'd like to include in the log
@@ -48,7 +49,7 @@ module Whoop
       pattern: PATTERN,
       count: COUNT,
       color: :default,
-      format: :plain,
+      format: :pretty,
       caller_depth: 0,
       explain: false,
       context: nil
@@ -147,6 +148,8 @@ module Whoop
         ->(message) { Whoop::Formatters::JsonFormatter.format(message, colorize: colorize) }
       when :sql
         ->(message) { Whoop::Formatters::SqlFormatter.format(message, colorize: colorize, explain: explain) }
+      when :pretty
+        ->(message) { Whoop::Formatters::PrettyFormatter.format(message) }
       else
         ->(message) { message }
       end

data/sig/whoop.rbs

@@ -29,7 +29,7 @@ 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)
+    # _@param_ `format` — - the format to use for the message (one of :json, :sql, :plain, :pretty (default))
     # 
     # _@param_ `caller_depth` — - the depth of the caller to use for the source (default: 0)
     # 
@@ -129,5 +129,19 @@ module Whoop
       # _@return_ — The formatted SQL query
       def self.format: (String message, ?colorize: bool) -> String
     end
+
+    module PrettyFormatter
+      # Format the message using AwesomePrint
+      # 
+      # _@param_ `message` — The object/class/message
+      # 
+      # _@return_ — The formatted message
+      def self.format: (String message) -> String
+    end
+  end
+
+  class InstallGenerator < Rails::Generators::Base
+    # sord omit - no YARD return type given, using untyped
+    def install: () -> untyped
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: whoop
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Berry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-18 00:00:00.000000000 Z
+date: 2023-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -80,6 +80,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !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: magic_frozen_string_literal
   requirement: !ruby/object:Gem::Requirement
@@ -225,10 +239,10 @@ files:
 - lib/generators/whoop/install_generator.rb
 - lib/whoop.rb
 - lib/whoop/formatters/json_formatter.rb
+- lib/whoop/formatters/pretty_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
@@ -236,7 +250,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
@@ -251,8 +265,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
-signing_key: 
+rubygems_version: 3.4.14
+signing_key:
 specification_version: 4
 summary: A simple gem to help you whoop your logs into shape.
 test_files: []

data/whoop.gemspec

@@ -1,47 +0,0 @@
-# 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