niceql 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd33b2edcd3a477068b38011e5030f5ebc261ffce8990f359754d01b556ac2f
-  data.tar.gz: ccbd8f33db8b50fe447e43fa08b875a9e6ca6e80a9de6179a823bd81df8df52c
+  metadata.gz: 61e17e9e56ddebb633c9ff0051e0fc400842f030a9d89236d484107dbf55389d
+  data.tar.gz: a80a5c8720b2da17f44e37e56a4543360e1424fad18c67d869ca466bbe19c0e0
 SHA512:
-  metadata.gz: 6584d6c7f9b7d53cd9726b1bdd21808df7f1a271b35c06b151dd747f33eb133897e559afbca2650659ad52c82acaed33c52785e90d8b8f9722e5490c639508fd
-  data.tar.gz: b0f3fc0eac42a2fb94ca60a79366d10c80e41e0baf89343853572a6679d558727ce22ce6364c5719cd8998544fa75c2153a7e633cb213f67e7f0c7041a1a3ddf
+  metadata.gz: 83302f8bff5ec7942338b93ec77739948606a34a85480e38ee19b16785391081d99865b6f31dd86ede787aef17061d0918bb8c77cb3eb84aa2bca3030bce30a2
+  data.tar.gz: 3ab3a19673a3e6d47d1d344c38bb42717526ca84e39a999c7933a15cfbaf07a361c6b7789089f3bc4c0dcb224d2d596050141ee460c5c6d3a532ea240505450a

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.5.0
+* BREAKING CHANGE! ActiveRecord compatibility extracted to the rails_sql_prettifier gem! 
+  If you need niceql funcitonality with rails / active_record plz include rails_sql_prettifier has a 
+  a versioning aligned to the active_record versions and has same DSL for AR niceql provide prior.  
+
 # 0.4.1
 * description update 
 

data/README.md

@@ -1,5 +1,7 @@
 # Niceql
 
+ATTENTION: Since ver 0.5.0 the ActiveRecord integration will be provided via standalone gem: [rails_sql_prettifier](https://github.com/alekseyl/rails_sql_prettifier)!
+
 This is a small, nice, simple and zero dependency solution for SQL prettifying for Ruby. 
 It can be used in an irb console without any dependencies ( run bin/console and look for examples ).
 

data/lib/niceql/version.rb

@@ -1,3 +1,3 @@
 module Niceql
-  VERSION = '0.4.1'
+  VERSION = '0.5.0'
 end

data/lib/niceql.rb

@@ -17,21 +17,6 @@ module Niceql
     end
   end
 
-  module ArExtentions
-    def exec_niceql
-      connection.execute( to_niceql )
-    end
-
-    def to_niceql
-      Prettifier.prettify_sql(to_sql, false)
-    end
-
-    def niceql( colorize = true )
-      puts Prettifier.prettify_sql( to_sql, colorize )
-    end
-
-  end
-
   module Prettifier
     INLINE_VERBS = %w(WITH ASC (IN\s) COALESCE AS WHEN THEN ELSE END AND UNION ALL ON DISTINCT INTERSECT EXCEPT EXISTS NOT COUNT ROUND CAST).join('| ')
     NEW_LINE_VERBS = 'SELECT|FROM|WHERE|CASE|ORDER BY|LIMIT|GROUP BY|(RIGHT |LEFT )*(INNER |OUTER )*JOIN( LATERAL)*|HAVING|OFFSET|UPDATE'
@@ -202,7 +187,7 @@ module Niceql
       def extract_err_caret_line( err_address_line, err_line, sql_body, err )
         # LINE could be quoted ( both sides and sometimes only from one ):
         # "LINE 1: ...t_id\" = $13 AND \"products\".\"carrier_id\" = $14 AND \"product_t...\n",
-        err_quote = (err_address_line.match(/\.\.\.(.+)\.\.\./) || err_address_line.match(/\.\.\.(.+)/) ).try(:[], 1)
+        err_quote = (err_address_line.match(/\.\.\.(.+)\.\.\./) || err_address_line.match(/\.\.\.(.+)/) )&.send(:[], 1)
 
         # line[2] is original err caret line i.e.: '      ^'
         # err_address_line[/LINE \d+:/].length+1..-1 - is a position from error quote begin
@@ -224,76 +209,17 @@ module Niceql
     end
   end
 
-  module PostgresAdapterNiceQL
-    def exec_query(sql, name = "SQL", binds = [], prepare: false)
-      # replacing sql with prettified sql, thats all
-      super( 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" + 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 ? Prettifier.prettify_err(super, try(:sql) ) : super
-    end
-  end
-
   class NiceQLConfig
-    def ar_using_pg_adapter?
-      return false unless defined?(::ActiveRecord::Base)
-
-      adapter = ActiveRecord::Base.try(:connection_db_config).try(:adapter) ||
-        ActiveRecord::Base.try(:connection_config)&.with_indifferent_access&.dig(:adapter)
-
-      adapter == 'postgresql'
-    end
-
-    attr_accessor :pg_adapter_with_nicesql,
-                  :indentation_base,
-                  :open_bracket_is_newliner,
-                  :prettify_active_record_log_output,
-                  :prettify_pg_errors
-
+    attr_accessor :indentation_base, :open_bracket_is_newliner
 
     def initialize
-      self.pg_adapter_with_nicesql = false
       self.indentation_base = 2
       self.open_bracket_is_newliner = false
-      self.prettify_active_record_log_output = false
-      self.prettify_pg_errors = ar_using_pg_adapter?
     end
   end
 
-  def self.configure
-    yield( config )
-
-    return unless defined? ::ActiveRecord::Base
+  def self.configure; yield( config ) end
 
-    ::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
-
-  def self.config
-    @config ||= NiceQLConfig.new
-  end
-
-  if defined? ::ActiveRecord
-    [::ActiveRecord::Relation,
-     ::Arel::TreeManager,
-     ::Arel::Nodes::Node].each { |klass| klass.send(:include, ArExtentions) }
-  end
+  def self.config; @config ||= NiceQLConfig.new end
 
 end

data/niceql.gemspec

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["leshchuk@gmail.com"]
 
   spec.summary       = %q{This is a simple and nice gem for SQL prettifying and formatting. Niceql splits, indent and colorize SQL query and PG errors if any. }
-  spec.description   = %q{This is a simple and nice gem for SQL prettifying and formatting. Niceql splits, indent and colorize SQL query and PG errors if any. Could be used as a standalone gem without any dependencies. Seamless ActiveRecord integration. }
+  spec.description   = %q{This is a simple and nice gem for SQL prettifying and formatting. Niceql splits, indent and colorize SQL query and PG errors if any. Could be used as a standalone gem without any dependencies. Seamless ActiveRecord integration via rails_sql_prettifier gem. }
   spec.homepage      = "https://github.com/alekseyl/niceql"
   spec.license       = "MIT"
 
@@ -31,7 +31,6 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.4'
-  spec.add_development_dependency "activerecord", ">= 6.1"
 
   spec.add_development_dependency "bundler", ">= 1"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: niceql
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-11-02 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: activerecord
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -124,7 +110,8 @@ dependencies:
         version: '0'
 description: 'This is a simple and nice gem for SQL prettifying and formatting. Niceql
   splits, indent and colorize SQL query and PG errors if any. Could be used as a standalone
-  gem without any dependencies. Seamless ActiveRecord integration. '
+  gem without any dependencies. Seamless ActiveRecord integration via rails_sql_prettifier
+  gem. '
 email:
 - leshchuk@gmail.com
 executables: []