rails_sql_prettifier 5.0.0

data/lib/generators/niceql/install_generator.rb

@@ -0,0 +1,14 @@
+module Niceql
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../../templates", __FILE__)
+      desc "Creates Niceql initializer for your application"
+
+      def copy_initializer
+        template "niceql_initializer.rb", "config/initializers/niceql.rb"
+
+        puts "Install complete!"
+      end
+    end
+  end
+end

data/lib/generators/templates/niceql_initializer.rb

@@ -0,0 +1,11 @@
+Niceql.configure do |c|
+  # You can adjust pg_adapter in prooduction at your own risk!
+  # If you need it in production use exec_niceql
+  # default: false
+  # c.pg_adapter_with_nicesql = Rails.env.development?
+
+  # this are default settings, change it to your project needs
+  # c.indentation_base = 2
+  # c.open_bracket_is_newliner = false
+  # c.prettify_active_record_log_output = false
+end

data/lib/rails_sql_prettifier/version.rb

@@ -0,0 +1,3 @@
+module RailsSQLPrettifier
+  VERSION = '5.0.0'
+end

data/lib/rails_sql_prettifier.rb

@@ -0,0 +1,89 @@
+require "rails_sql_prettifier/version"
+require 'active_record'
+require "niceql"
+
+module RailsSQLPrettifier
+  include Niceql
+
+  module ArExtentions
+    def exec_niceql
+      connection.execute( to_niceql )
+    end
+
+    def to_niceql
+      Niceql::Prettifier.prettify_sql(to_sql, false)
+    end
+
+    def niceql( colorize = true )
+      puts Niceql::Prettifier.prettify_sql( to_sql, colorize )
+    end
+
+  end
+
+  module PostgresAdapterNiceQL
+    def exec_query(sql, name = "SQL", binds = [], prepare: false)
+      # replacing sql with prettified sql, thats all
+      super( Niceql::Prettifier.prettify_sql(sql, false), name, binds, prepare: prepare )
+    end
+  end
+
+  module AbstractAdapterLogPrettifier
+    def log( sql, *args, &block )
+      # \n need to be placed because AR log will start with action description + time info.
+      # rescue sql - just to be sure Prettifier wouldn't break production
+      formatted_sql = "\n" + Niceql::Prettifier.prettify_sql(sql) rescue sql
+      super( formatted_sql, *args, &block )
+    end
+  end
+
+  module ErrorExt
+    def to_s
+      # older rails version do not provide sql as a standalone query, instead they
+      # deliver joined message
+      Niceql.config.prettify_pg_errors ? Niceql::Prettifier.prettify_err(super, try(:sql) ) : super
+    end
+  end
+
+  module ARNiceQLConfig
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :pg_adapter_with_nicesql,
+                    :prettify_active_record_log_output,
+                    :prettify_pg_errors
+    end
+
+
+    def ar_using_pg_adapter?
+      adapter = ActiveRecord::Base.try(:connection_db_config).try(:adapter) ||
+        ActiveRecord::Base.try(:connection_config)&.with_indifferent_access&.dig(:adapter)
+
+      adapter == 'postgresql'
+    end
+
+    def initialize
+      super
+      self.pg_adapter_with_nicesql = false
+      self.prettify_active_record_log_output = false
+      self.prettify_pg_errors = ar_using_pg_adapter?
+    end
+
+    module ClassMethods
+      def configure
+        super
+
+        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL) if config.pg_adapter_with_nicesql
+
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier ) if config.prettify_active_record_log_output
+
+        ::ActiveRecord::StatementInvalid.include( Niceql::ErrorExt ) if config.prettify_pg_errors && config.ar_using_pg_adapter?
+      end
+    end
+  end
+
+  [::ActiveRecord::Relation,
+   ::Arel::TreeManager,
+   ::Arel::Nodes::Node].each { |klass| klass.send(:include, ArExtentions) }
+
+  NiceQLConfig.include( ARNiceQLConfig )
+end

data/rails_sql_prettifier.gemspec

@@ -0,0 +1,46 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "rails_sql_prettifier/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rails_sql_prettifier"
+  spec.version       = RailsSQLPrettifier::VERSION
+  spec.authors       = ["alekseyl"]
+  spec.email         = ["leshchuk@gmail.com"]
+
+  spec.summary       = %q{This is an ActiveRecord integration for the SQL prettifier gem niceql. }
+  spec.description   = %q{This is an ActiveRecord integration for the SQL prettifier gem niceql. }
+  spec.homepage      = "https://github.com/alekseyl/rails_sql_prettifier"
+  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.required_ruby_version = '>= 2.4'
+  spec.add_dependency "niceql", '>= 0.5.1'
+
+  spec.add_development_dependency "activerecord", "< 6.0"
+
+  spec.add_development_dependency "bundler", ">= 1"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "minitest", "~> 5.0"
+
+  spec.add_development_dependency "differ"
+  spec.add_development_dependency "pry-byebug"
+  spec.add_development_dependency "benchmark-ips"
+  spec.add_development_dependency 'sqlite3'
+end

metadata

@@ -0,0 +1,193 @@
+--- !ruby/object:Gem::Specification
+name: rails_sql_prettifier
+version: !ruby/object:Gem::Version
+  version: 5.0.0
+platform: ruby
+authors:
+- alekseyl
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: niceql
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.5.1
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !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'
+- !ruby/object:Gem::Dependency
+  name: differ
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: benchmark-ips
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 'This is an ActiveRecord integration for the SQL prettifier gem niceql. '
+email:
+- leshchuk@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".byebug_history"
+- ".gitignore"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- err_now.png
+- err_was.png
+- lib/benchmark/cat.rb
+- lib/benchmark/gsub.rb
+- lib/benchmark/txt
+- lib/generators/niceql/install_generator.rb
+- lib/generators/templates/niceql_initializer.rb
+- lib/rails_sql_prettifier.rb
+- lib/rails_sql_prettifier/version.rb
+- rails_sql_prettifier.gemspec
+- to_niceql.png
+homepage: https://github.com/alekseyl/rails_sql_prettifier
+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: '2.4'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.4
+signing_key:
+specification_version: 4
+summary: This is an ActiveRecord integration for the SQL prettifier gem niceql.
+test_files: []