ar_pretty_sql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: bf0035acb3f3a16f52bab63c891c8677afaacb1bae30168cc907edf2afa35109
+  data.tar.gz: 579f0610275fab6de4b315b9939941dd49f586d4392abd9f90e0291b1c292d87
+SHA512:
+  metadata.gz: 0f0afc932b6d9f33b8c4b53b4d7af089a2ca2d0cb5bd8b2ce5d6d04639295a1285dd75af9e01d4ae70b289e4e502c7cdee5cfec89293ad528fdf8d478a984b3d
+  data.tar.gz: 8ed3d244dfe85e23deba4adb3a5227dfa7e5941151efef9ef7c810e4ecb17119dcc746518320a1d5d7438e446074ef4d07a70c8d4e02cc9b32e21d7981090cf9

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in ar_pretty_sql.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    ar_pretty_sql (0.1.0)
+      anbt-sql-formatter (~> 0.1)
+      rouge (~> 3.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    anbt-sql-formatter (0.1.0)
+    diff-lcs (1.4.4)
+    rake (13.0.6)
+    rouge (3.28.0)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ar_pretty_sql!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Joseph Johansen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,93 @@
+# ArPrettySql
+
+Inspect the SQL behind your Active Record queries, in a human-friendly manner.
+
+```SQL
+[1] pry(main)> User.where(first_name: "Geoff").order(id: :asc).limit(10).pp
+SELECT
+        "users" . *
+    FROM
+        "users"
+    WHERE
+        "users"."first_name" = 'Geoff'
+    ORDER BY
+        "users"."id" ASC LIMIT 10
+=> nil
+```
+
+### Features
+
+- Syntax highlighting
+- Indentation and line breaks
+- Customisable colour schemes
+- Support for extended SQL function highlighting
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :development, :test do
+  gem 'ar_pretty_sql'
+end
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ar_pretty_sql
+
+## Usage
+
+```ruby
+relation = User.where(age: 50)
+
+relation.to_pretty_sql # generates a pretty string
+relation.pp # same as `puts relation.to_pretty_sql`
+```
+
+Both of the methods can accept one-off options:
+
+```ruby
+relation.to_pretty_sql(color: false)
+```
+
+Configuration can also be set globally:
+
+```ruby
+# config/initializers/ar_pretty_sql.rb
+
+ArPrettySql.configure do |config|
+  # enable syntax highlighting for the output (also accepts `colour`)
+  config.colour = true
+  # prettify the SQL output
+  config.format = true
+  # the colour theme to use for highlighting the SQL output (provided `color` is true)
+  config.theme =  Rouge::Themes::Colorful.new
+  # extra SQL functions you want to provide highlighting for
+  config.addition_sql_functions += %w[jsonb_build_object]
+  # keyword case (:upper, :lower, :unchanged)
+  config.keyword_case = :upper
+end
+```
+
+- These same options can all be passed in as one-offs as keyword arguments.
+- Colour themes are provided by [rouge](https://github.com/rouge-ruby/rouge) - see their docs for
+  more options.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/johansenja/ar_pretty_sql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/ar_pretty_sql.gemspec

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative "lib/ar_pretty_sql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ar_pretty_sql"
+  spec.version       = ArPrettySql::VERSION
+  spec.authors       = ["Joseph Johansen"]
+  spec.email         = ["joe@stotles.com"]
+
+  spec.summary       = "Debug your active record queries fast"
+  spec.description   = "This is a debugging tool to inspect your Active Record queries in a developer-friendly way"
+  spec.homepage      = "https://github.com/johansenja/ar_pretty_sql"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.4.0")
+
+  spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_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(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "rouge", "~> 3.2"
+  spec.add_dependency "anbt-sql-formatter", "~> 0.1"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "ar_pretty_sql"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ar_pretty_sql/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ArPrettySql
+  VERSION = "0.1.0"
+end

data/lib/ar_pretty_sql.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "ostruct"
+require "rouge"
+require "anbt-sql-formatter/formatter"
+
+require_relative "ar_pretty_sql/version"
+
+module ArPrettySql
+  Config = OpenStruct.new(
+    # the colour theme to use for highlighting the SQL output (provided `color` is true)
+    theme: Rouge::Themes::Colorful.new,
+    # enable syntax highlighting for the output (also accepts `colour`)
+    color: true,
+    # prettify the SQL output
+    format: true,
+    # extra SQL functions you want to provide highlighting for
+    additional_sql_functions: %w[count sum substr date],
+    # keyword case (:upper, :lower, :unchanged)
+    keyword_case: :upper,
+  )
+
+  def self.configure
+    yield Config
+  end
+
+  module InstanceMethods
+    def to_pretty_sql(**options)
+      conf = ArPrettySql::Config.to_h.merge! options
+
+      result = to_sql.dup
+
+      if conf[:format]
+        rule = AnbtSql::Rule.new
+
+        rule.keyword = case conf[:keyword_case].to_sym
+                       when :upper then AnbtSql::Rule::KEYWORD_UPPER_CASE
+                       when :lower then AnbtSql::Rule::KEYWORD_LOWER_CASE
+                       when :unchanged then AnbtSql::Rule::KEYWORD_NONE
+                       end
+
+        conf[:additional_sql_functions]&.each do |func_name|
+          rule.function_names << func_name.upcase
+        end
+
+        formatter = AnbtSql::Formatter.new(rule)
+        result = formatter.format(result)
+      end
+
+      if conf[:color] || conf[:colour]
+        lexer = Rouge::Lexers::SQL.new
+        formatter = Rouge::Formatters::Terminal256.new(conf[:theme])
+        result = formatter.format(lexer.lex(result))
+      end
+
+      result
+    end
+
+    def pp(**options)
+      puts to_pretty_sql(**options)
+    end
+  end
+end
+
+if Object.const_defined? "ActiveRecord::Relation"
+  ActiveRecord::Relation.prepend(ArPrettySql::InstanceMethods)
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: ar_pretty_sql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joseph Johansen
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-04-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rouge
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: anbt-sql-formatter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+description: This is a debugging tool to inspect your Active Record queries in a developer-friendly
+  way
+email:
+- joe@stotles.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- ar_pretty_sql.gemspec
+- bin/console
+- bin/setup
+- lib/ar_pretty_sql.rb
+- lib/ar_pretty_sql/version.rb
+homepage: https://github.com/johansenja/ar_pretty_sql
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://github.com/johansenja/ar_pretty_sql
+  source_code_uri: https://github.com/johansenja/ar_pretty_sql
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key:
+specification_version: 4
+summary: Debug your active record queries fast
+test_files: []