niceql 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 7f43c7e4d45b26a700c72420b528e162d26814bd
+  data.tar.gz: e634c50d9336928faf6730428098752269ae6de9
+SHA512:
+  metadata.gz: a6467d75c04de184e7adfd2972753e94237b96e14b7d952f18c8939982dfba353c4f17281492878c9a04edd957d14b60ef8dd2649a91c0fa1a76df0ee1144fec
+  data.tar.gz: dd708fe3bc10676735fb4a9a821366fb3206d04e4f8402bc2433db155a5eff25aa63bd2ffea7b8a71fe509de0c2600f44aa2dc3dbf090ab4723d61796ec22118

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.4

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in niceql.gemspec
+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,102 @@
+# Niceql
+
+This is small, nice, simple and dependentless solution for SQL prettifiyng for Ruby. 
+It can be used in irb console without any dependencies ( run ./console from bin and look for examples ).
+
+Any reasonable suggestions on formatting/coloring are welcome
+
+## 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 'niceql'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install niceql
+
+## Usage
+
+### With ActiveRecord
+
+```ruby
+  # prettify to_sql 
+  Model.scope.to_niceql
+  
+  # prettify PG errors 
+  Model.scope_with_err.explain_err 
+```
+
+### Without ActiveRecord
+
+```ruby
+   puts Niceql::Prettifier.prettify_sql("SELECT * FROM ( VALUES(1), (2) ) AS tmp")
+   
+   # see colors in irb %) 
+   #=>  SELECT * 
+   #=>  FROM ( VALUES(1), (2) ) AS tmp
+
+   # rails combines err with query, so don't forget to do it yourself 
+   # to get real nice result you should execute on your DB prettified_sql! 
+   # otherwise you will not get such a nice output
+   
+   puts Niceql::Prettifier.prettify_pg_err(<<-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
+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
+
+```
+## Limitations
+
+Right now it detect only uppercase verbs with simple indentation and parsing options. 
+Also if your console support more colors or different schemes, or you prefer different colorization you can override ColorizeString 
+methods. Current color are selected with dark and white console themes in mind, so it works good for dark, and good enough for white.
+
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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 tags, 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/[USERNAME]/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 "niceql"
+
+# 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/niceql.rb

@@ -0,0 +1,103 @@
+require "niceql/version"
+
+module Niceql
+  module StringColorize
+    def self.colorize_verb( str)
+      #yellow ANSI color
+      "\e[0;33;49m#{str}\e[0m"
+    end
+    def self.colorize_str(str)
+      #cyan ANSI color
+      "\e[0;36;49m#{str}\e[0m"
+    end
+    def self.colorize_err(err)
+      #red ANSI color
+      "\e[0;31;49m#{err}\e[0m"
+    end
+  end
+
+  module ArExtentions
+    def explain_err
+      begin
+        connection.execute( "EXPLAIN #{Prettifier.prettify_sql(to_sql, false)}" )
+      rescue StandardError => e
+        puts Prettifier.prettify_err(e )
+      end
+    end
+
+    def to_niceql( colorize = true )
+      puts Prettifier.prettify_sql( to_sql, colorize )
+    end
+  end
+
+  module Prettifier
+    INLINE_VERBS = %w(ASC IN AS WHEN THEN ELSE END AND UNION ALL WITH ON DISTINCT INTERSECT EXCEPT EXISTS NOT).join('| ')
+    NEW_LINE_VERBS = 'SELECT|FROM|WHERE|CASE|ORDER BY|LIMIT|GROUP BY|WITH|LEFT JOIN|RIGHT JOIN|JOIN|HAVING|OFFSET'
+    VERBS = "#{INLINE_VERBS}|#{NEW_LINE_VERBS}"
+    STRINGS = /("[^"]+")|('[^']+')/
+    BRACKETS = '[\(\)]'
+
+    def self.prettify_err(err)
+      if ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
+        prettify_pg_err( err.to_s )
+      else
+        puts err
+      end
+    end
+
+
+    def self.prettify_pg_err(err)
+      err_line_num = err[/LINE \d+/][5..-1].to_i
+      start_sql_line = err.lines[3][/HINT/] ? 4 : 3
+      err_body = err.lines[start_sql_line..-1]
+      err_line = StringColorize.colorize_err( err_body[err_line_num-1] )
+
+      err_body = err_body.join.gsub(/#{VERBS}/ ) { |verb| StringColorize.colorize_verb(verb) }
+      err_body = err_body.gsub(STRINGS){ |str| StringColorize.colorize_str(str) }
+
+      err_body = err_body.lines
+      err_body[err_line_num-1]= err_line
+      err_body.insert( err_line_num, StringColorize.colorize_err( err.lines[2][err.lines[1][/LINE \d+:/].length+1..-1] ) )
+      puts err.lines[0..start_sql_line-1].join + err_body.join
+    end
+
+    def self.prettify_sql( sql, colorize = true )
+      indent = 0
+      parentness = []
+
+      sql = sql.gsub(STRINGS){ |str| StringColorize.colorize_str(str) } if colorize
+
+      sql.gsub( /(#{VERBS}|#{BRACKETS})/) do |verb|
+        add_new_line = false
+        if 'SELECT' == verb
+          indent += 1
+          parentness.last[:nested] = true if parentness.last
+          add_new_line = true
+        elsif verb == '('
+          parentness << { nested: false }
+          indent += 1
+        elsif verb == ')'
+          # this also covers case when right bracket is used without corresponding left one
+          add_new_line = parentness.last.nil? || parentness.last[:nested]
+          indent -= add_new_line ? 2 : 1
+          indent = 0 if indent < 0
+          parentness.pop
+        elsif verb == 'ORDER BY'
+          # in postgres ORDER BY can be used in aggregation function this will keep it
+          # inline with its agg function
+          add_new_line = parentness.last.nil? || parentness.last[:nested]
+        else
+          add_new_line = verb[/(#{INLINE_VERBS})/].nil?
+        end
+        verb = StringColorize.colorize_verb(verb) if !['(', ')'].include?(verb) && colorize
+
+        add_new_line ? "\n#{' ' * indent}" + verb : verb
+      end
+    end
+  end
+
+  if defined? ::ActiveRecord::Base
+    ::ActiveRecord::Base.extend ArExtentions
+    [::ActiveRecord::Relation, ::ActiveRecord::Associations::CollectionProxy].each { |klass| klass.send(:include, ArExtentions) }
+  end
+end

data/lib/niceql/version.rb

@@ -0,0 +1,3 @@
+module Niceql
+  VERSION = "0.1.0"
+end

data/niceql.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "niceql/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "niceql"
+  spec.version       = Niceql::VERSION
+  spec.authors       = ["alekseyl"]
+  spec.email         = ["leshchuk@gmail.com"]
+
+  spec.summary       = %q{This is simple and nice sql prettifier, it splits, indent and colorize SQL query and PG errors if any }
+  spec.description   = %q{This is simple and nice sql prettifier, it splits, indent and colorize SQL query and PG error if any }
+  spec.homepage      = "https://github.com/alekseyl/niceql"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+end

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: niceql
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- alekseyl
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-09-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: 'This is simple and nice sql prettifier, it splits, indent and colorize
+  SQL query and PG error if any '
+email:
+- leshchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- err_now.png
+- err_was.png
+- lib/niceql.rb
+- lib/niceql/version.rb
+- niceql.gemspec
+- to_niceql.png
+homepage: https://github.com/alekseyl/niceql
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: This is simple and nice sql prettifier, it splits, indent and colorize SQL
+  query and PG errors if any
+test_files: []