whoop 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 83de2300eaec2004c4bc867fef14a91689222018eee43b12fab6b9a29d425e5a
-  data.tar.gz: 0c3c9b1d21fede7bccf827a73e8c6c3d11b6ddeb6837a4444d664687c03583f7
+  metadata.gz: 8a3377a8066ffe3e56b4c0bda3edb7763d54397116e73fb10dcfeca91c16b49f
+  data.tar.gz: cba013c48234104ebe5d955ecc5d838f19146985b9592297fb2b6c81725144f2
 SHA512:
-  metadata.gz: 65ad2d5801a70c8d1dec7d7291bfa0c1fef3d2d181e6a1abb75ab41a8e9dd3e0b3550a2a51ddc58880c541838c2b6f603532a134bbbfe8ee633e66103aef0cbb
-  data.tar.gz: 3a1662b1192c5d1828ff8a7cb7bdf5914b4e4fc1313dd23ccf38e9460cd5c8e8187e1c6a3fe695c2e3552ef04b654cb3effdc28794731f12364c3c078c25772e
+  metadata.gz: 75b4c83644abbe37fc838020c324090ab233c9ccdc46c114025959a91cd7fb46c5fbfef363ce763f71c55f3f18adf3431f098d33ef768c6ecf21676bf34a1a27
+  data.tar.gz: e6dbb3c9e707b29f8feab0eb244d78561ae015ece90eb0c49d100c8987d10dce4035e846c43cffdc73a52905e6000ce90dbcda8b912fecaaf232dd47b29a0ad1

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    whoop (1.0.0)
+    whoop (1.0.1)
+      activerecord
       activesupport
       anbt-sql-formatter
       colorize
@@ -10,6 +11,11 @@ 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)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 1.6, < 2)

data/README.md

@@ -64,7 +64,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/whoop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/whoop/blob/main/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/coderberry/whoop. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/coderberry/whoop/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -72,7 +72,7 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Whoop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/whoop/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the Whoop project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/coderberry/whoop/blob/main/CODE_OF_CONDUCT.md).
 
 ## Attribution
 

data/Rakefile

@@ -4,7 +4,26 @@ require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
+GEM_NAME = "whoop"
+GEM_VERSION = Whoop::VERSION
 
 require "standard/rake"
+require "bump/tasks"
 
 task default: %i[spec standard]
+
+task :build do
+  system "gem build #{GEM_NAME}.gemspec"
+end
+
+task install: :build do
+  system "gem install #{GEM_NAME}-#{GEM_VERSION}.gem"
+end
+
+task publish: :build do
+  system "gem push #{GEM_NAME}-#{GEM_VERSION}.gem"
+end
+
+task :clean do
+  system "rm *.gem"
+end

data/lib/whoop/formatters/json_formatter.rb

@@ -15,7 +15,11 @@ module Whoop
 
         formatter = Rouge::Formatters::TerminalTruecolor.new
         lexer = Rouge::Lexers::JSON.new
-        formatter.format(lexer.lex(pretty_json))
+
+        [
+          "json:\n\n".colorize(:light_black).underline,
+          formatter.format(lexer.lex(pretty_json))
+        ].join
       end
     end
   end

data/lib/whoop/formatters/sql_formatter.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "anbt-sql-formatter/formatter"
+require "active_record"
 
 module Whoop
   module Formatters
@@ -16,15 +17,47 @@ module Whoop
 
         formatter = Rouge::Formatters::TerminalTruecolor.new
         lexer = Rouge::Lexers::SQL.new
-        formatter.format(lexer.lex(pretty_sql))
+
+        formatted_sql = formatter.format(lexer.lex(pretty_sql))
+        return formatted_sql unless explain
+
+        raw_explain = exec_explain(sql)
+        formatted_explain = formatter.format(lexer.lex(raw_explain))
+
+        [
+          "sql:\n\n".colorize(:light_black).underline,
+          formatted_sql,
+          "\n\n",
+          "query plan:\n\n".colorize(:light_black).underline,
+          formatted_explain
+        ].join
       end
 
+      # Generate a pretty SQL query
+      # @param [String] sql The SQL query
+      # @return [String] The formatted SQL query
       def self.generate_pretty_sql(sql)
         rule = AnbtSql::Rule.new
         rule.indent_string = "  "
         formatter = AnbtSql::Formatter.new(rule)
         formatter.format(sql.dup)
       end
+
+      # Execute the `EXPLAIN` query
+      # @param [String] sql The SQL query
+      # @return [String] The formatted query plan
+      def self.exec_explain(sql)
+        result = ActiveRecord::Base.connection.exec_query("EXPLAIN #{sql}")
+        lines = result.rows.map(&:first)
+
+        pretty_explain = []
+        pretty_explain += lines.map { |line| " #{line}" }
+        nrows = result.rows.length
+        rows_label = nrows == 1 ? "row" : "rows"
+        pretty_explain << "\n(#{nrows} #{rows_label})"
+
+        pretty_explain.join("\n")
+      end
     end
   end
 end

data/lib/whoop/version.rb

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

data/lib/whoop.rb

@@ -19,6 +19,8 @@ module Whoop
   mattr_accessor :level
   @@level = :debug
 
+  # Configure the logger
+  # @yield [Whoop::Configuration] The configuration object
   def self.setup
     yield(self)
   end

data/sig/whoop.rbs

@@ -5,8 +5,11 @@
 module Whoop
   VERSION: untyped
 
-  # sord omit - no YARD return type given, using untyped
-  def self.setup: () ?{ (Whoop _self) -> void } -> untyped
+  # sord warn - Whoop::Configuration wasn't able to be resolved to a constant in this project
+  # Configure the logger
+  # 
+  # _@return_ — The configuration object
+  def self.setup: () -> Whoop::Configuration
 
   module Main
     COLORS: untyped
@@ -89,9 +92,19 @@ module Whoop
       # _@return_ — The formatted SQL query
       def self.format: (String sql, ?colorize: bool, ?explain: bool) -> String
 
-      # sord omit - no YARD type given for "sql", using untyped
-      # sord omit - no YARD return type given, using untyped
-      def self.generate_pretty_sql: (untyped sql) -> untyped
+      # Generate a pretty SQL query
+      # 
+      # _@param_ `sql` — The SQL query
+      # 
+      # _@return_ — The formatted SQL query
+      def self.generate_pretty_sql: (String sql) -> String
+
+      # Execute the `EXPLAIN` query
+      # 
+      # _@param_ `sql` — The SQL query
+      # 
+      # _@return_ — The formatted query plan
+      def self.exec_explain: (String sql) -> String
     end
 
     module JsonFormatter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: whoop
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Eric Berry
@@ -10,6 +10,20 @@ bindir: exe
 cert_chain: []
 date: 2022-09-23 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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: activesupport
   requirement: !ruby/object:Gem::Requirement
@@ -186,7 +200,6 @@ files:
 - lib/whoop/formatters/sql_formatter.rb
 - lib/whoop/version.rb
 - sig/whoop.rbs
-- whoop.gemspec
 homepage: https://github.com/coderberry/whoop
 licenses:
 - MIT

data/whoop.gemspec

@@ -1,46 +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["allowed_push_host"] = "https://rubygems.org"
-
-  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 "activesupport"
-  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"
-end