rails_sql_prettifier 5.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fd1acaf8f6f82312ccb1422330645c2365b3e4f93c9874da2645c62866310836
+  data.tar.gz: bad3c23c4af4d0d3d3d8200f2ae38309df6cc332e92ab6466713f1956ee91739
+SHA512:
+  metadata.gz: 3b16a4ee0ba376dc3f7ae3e3d2eaec46bd08cdda2e525b4a59be827e82ae5c161d90fd236e418bb226a8cca54aaebf6e5e590161fa529f52c25e0f025db27e42
+  data.tar.gz: ab755ea34ed0bc3c910ee02895a94a35c7a1f4de4d123188f66985a9cd68950f8d708cdc3ba8d5cf7a590403b8e77c4186ebae44ecc31d5e1fcc8cc0dca63836

data/.byebug_history

@@ -0,0 +1,36 @@
+c
+ActiveRecord.version <= Gem::Version.new(5)
+c
+ActiveRecord.version 
+exit
+ActiveRecord.version 
+c
+exit
+si.sql
+si
+c
+sql_body
+n
+s
+original_sql_query
+err
+s
+up
+s
+up
+s
+up
+s
+super
+try(:sql)
+Niceql.config.prettify_pg_errors
+c
+exit
+err_template
+ si.to_s
+exit
+ err_caret_line
+err_quote_caret_offset
+c
+ err.lines[1].index( '...' ).to_i
+err_caret_line

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/inspectionProfiles/
+.idea

data/.ruby-gemset

@@ -0,0 +1 @@
+rails_sql_prettifier_ar_5

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/.travis.yml

@@ -0,0 +1,7 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4
+  - 2.5
+  - 2.3
+  - 2.6

data/Gemfile

@@ -0,0 +1,5 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 alekseyl
+
+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,160 @@
+# RailsSQLPrettifier
+
+This is an ActiveRecord integration for a niceql gem.
+Niceql is a small, nice, simple and zero dependency solution for SQL prettifying for Ruby. 
+
+Any reasonable suggestions are welcome. 
+
+**Please pay attention: until issue https://github.com/alekseyl/niceql/issues/16 is resolved any UPDATE or INSERT request might corrupt your data, don't use on production!**
+
+ 
+## Before/After 
+### SQL prettifier: 
+![alt text](https://github.com/alekseyl/niceql/raw/master/to_niceql.png "To_niceql")
+
+### PG errors prettifier 
+
+before: 
+![alt text](https://github.com/alekseyl/niceql/raw/master/err_was.png "To_niceql")
+
+after:
+![alt text](https://github.com/alekseyl/niceql/raw/master/err_now.png "To_niceql")
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rails_sql_prettifier'
+```
+
+And then execute:
+
+    $ bundle
+    # if you are using rails, you may want to install niceql config:
+    rails g niceql:install 
+
+Or install it yourself as:
+
+    $ gem install niceql
+
+## Configuration
+
+```ruby
+Niceql.configure do |c|
+  # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
+  # before execution. Formatted SQL will lead to much better SQL-query debugging and much more clearer error messages 
+  # if you are using Postgresql as a data source. 
+  # BUT do not use it in production until https://github.com/alekseyl/niceql/issues/16 is resolved 
+  # 
+  # You can adjust pg_adapter in production but do it at your own risk!
+  # 
+  # If you need to debug SQL queries in production use exec_niceql
+  # 
+  # default value for pg_adapter_with_nicesql: false
+  # uncomment next string to enable in development
+  # c.pg_adapter_with_nicesql = Rails.env.development?
+  
+  # uncomment next string if you want to log prettified SQL inside ActiveRecord logging. 
+  # default: false
+  # c.prettify_active_record_log_output = true
+  
+  # Error prettifying is also configurable
+  # default: defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+  # c.prettify_pg_errors = defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+  
+  # spaces count for one indentation, default is 2
+  c.indentation_base = 2
+  
+  # setting open_bracket_is_newliner to true will start opening brackets '(' with nested subqueries from new line 
+  # i.e. SELECT * FROM ( SELECT * FROM tags ) tags; will transform to: 
+  # SELECT * 
+  # FROM 
+  # ( 
+ #    SELECT * FROM tags 
+ #  ) tags;
+ # when open_bracket_is_newliner is false: 
+  # SELECT * 
+  # FROM ( 
+ #   SELECT * FROM tags 
+ # ) tags; 
+ # default: false
+  c.open_bracket_is_newliner = false
+end
+```
+
+## Usage
+
+### With ActiveRecord
+
+```ruby
+  # puts colorized and formatted corresponding SQL query
+  Model.scope.niceql
+  
+  # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
+  Model.scope.to_niceql
+  
+  # prettify PG errors if scope runs with any 
+  Model.scope_with_err.exec_niceql 
+```
+
+### Raw usage of niceql
+
+```ruby
+   
+    puts Niceql::Prettifier.prettify_sql("SELECT * FROM ( VALUES(1), (2) ) AS tmp")
+    #=>  SELECT * 
+    #=>  FROM ( VALUES(1), (2) ) AS tmp
+    
+    puts Niceql::Prettifier.prettify_multiple("SELECT * FROM ( VALUES(1), (2) ) AS tmp; SELECT * FROM table")
+    
+    #=>  SELECT * 
+    #=>  FROM ( VALUES(1), (2) ) AS tmp;
+    #=>
+    #=>  SELECT * 
+    #=>  FROM table
+    
+
+   puts Niceql::Prettifier.prettify_pg_err( pg_err_output, sql_query )
+   
+   # to get real nice result you should execute prettified version (i.e. execute( prettified_sql ) !) of query on your DB! 
+   # otherwise you will not get such a nice output
+    raw_sql = <<~SQL
+     SELECT err 
+     FROM ( VALUES(1), (2) )
+     ORDER BY 1
+    SQL
+
+    puts Niceql::Prettifier.prettify_pg_err(<<~ERR, raw_sql )
+        ERROR:  VALUES in FROM must have an alias
+        LINE 2:  FROM ( VALUES(1), (2) )
+                      ^
+        HINT:  For example, FROM (VALUES ...) [AS] foo.
+    ERR
+       
+    
+    # ERROR:  VALUES in FROM must have an alias
+    # LINE 2:  FROM ( VALUES(1), (2) )
+    #               ^
+    #     HINT:  For example, FROM (VALUES ...) [AS] foo.
+    #     SELECT err
+    #     FROM ( VALUES(1), (2) )
+    #          ^
+    #     ORDER BY 1
+
+```
+
+## Customizing colors
+If your console support more colors or different schemes, or if you prefer different colorization, then you can override ColorizeString methods. 
+Current colors were selected with dark and white console themes in mind, so a niceql colorization works good for dark, and good enough for white.
+
+## 
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/alekseyl/niceql.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "rails_sql_prettifier"
+
+# 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/benchmark/cat.rb

@@ -0,0 +1,34 @@
+require 'benchmark/ips'
+
+# 2 + 1 = 3 object
+def slow_plus
+  'foo' + 'bar'
+end
+
+# 2 + 1 = 3 object
+def slow_concat
+  'foo'.concat 'bar'
+end
+
+# 2 + 1 = 3 object
+def slow_append
+  'foo' << 'bar'
+end
+
+# 1 object
+def fast
+  'foo' 'bar'
+end
+
+def fast_interpolation
+  "#{'foo'}#{'bar'}"
+end
+
+Benchmark.ips do |x|
+  x.report('String#+')                 { slow_plus }
+  x.report('String#concat')            { slow_concat }
+  x.report('String#append')            { slow_append }
+  x.report('"foo" "bar"')              { fast }
+  x.report('"#{\'foo\'}#{\'bar\'}"')   { fast_interpolation }
+  x.compare!
+end

data/lib/benchmark/gsub.rb

@@ -0,0 +1,34 @@
+require 'benchmark/ips'
+
+# 2 + 1 = 3 object
+def slow_plus
+  'foo' + 'bar'
+end
+
+# 2 + 1 = 3 object
+def slow_concat
+  'foo'.concat 'bar'
+end
+
+# 2 + 1 = 3 object
+def slow_append
+  'foo' << 'bar'
+end
+
+# 1 object
+def fast
+  'foo' 'bar'
+end
+
+def fast_interpolation
+  "#{'foo'}#{'bar'}"
+end
+
+Benchmark.ips do |x|
+  x.report('String#+')                 { slow_plus }
+  x.report('String#concat')            { slow_concat }
+  x.report('String#append')            { slow_append }
+  x.report('"foo" "bar"')              { fast }
+  x.report('"#{\'foo\'}#{\'bar\'}"')   { fast_interpolation }
+  x.compare!
+end