whoop 1.0.4 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a9b6642d169f36ac114748f02515b804646a7981f244475c41fa053456d93c08
-  data.tar.gz: ca2a36f9da6922d998189ea808bd3976684e3cf2919fb7c4ed9672408591fce7
+  metadata.gz: 814754659e61a2179b1a09406e77e18a475ae3a5d7ffed0da3cc53eb1f3ec59f
+  data.tar.gz: bb96421ebb0a670af446b4c8312f9f847722576f8c52f1f41240d04974c8569c
 SHA512:
-  metadata.gz: eee07b43704595c415ec3eb4e36cf5ea2b9215982d22f7f5f1d0e7e9565c408dbaa4e41f43385c79c8089f1740907c2c21d8a2bcd9b5d74f64f103433774446a
-  data.tar.gz: 4865c548afe2113e7218ebde457eea291f9152c3bcecae84d684581e4ad9c397b6af965668623d4f581a571062881759d5681a6475cb570f04d9571f224b8eed
+  metadata.gz: a49ee4bf201f1239cb3dfbe829af37c4040a3925ada3af4312e1e18d9344803946052bfb1528eacc11580f5fc6e1fde0dfe2a343f2ccf651b47e010fec448b13
+  data.tar.gz: ea69570c36ff100d9a0bda28938e3f4ecc234f4a043e7c0426371c30ee7f07bfd5119a778e34bd034f902fbee833356d60bf2752d6b9aa08ee87228a48218381

data/Gemfile.lock

@@ -1,9 +1,10 @@
 PATH
   remote: .
   specs:
-    whoop (1.0.2)
+    whoop (1.2.0)
       activerecord (>= 6.1.4)
       activesupport (>= 6.1.4)
+      amazing_print
       anbt-sql-formatter
       colorize
       rouge
@@ -11,16 +12,17 @@ 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)
       tzinfo (~> 2.0)
+    amazing_print (1.5.0)
     anbt-sql-formatter (0.1.0)
     ast (2.4.2)
     bump (0.10.0)
@@ -31,25 +33,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 +60,63 @@ 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
+  arm64-darwin-22
   x86_64-linux
 
 DEPENDENCIES
@@ -127,4 +132,4 @@ DEPENDENCIES
   whoop!
 
 BUNDLED WITH
-   2.3.22
+   2.4.9

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

@@ -0,0 +1,25 @@
+# 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."
+
+    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/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/formatters/sql_formatter.rb

@@ -92,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.4"
+  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.0.4
+  version: 1.2.0
 platform: ruby
 authors:
 - Eric Berry
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-04-10 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
@@ -222,12 +236,13 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- 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
@@ -235,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
@@ -250,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