rails_sql_prettifier 6.0.2 → 6.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc8698d2cb6da1287057ee6d57f4fa1d494efa19bcc013157012d0a055176243
-  data.tar.gz: 6e41b147fd207cc2ad6afcd48508b1ebb0e6cf183d5d3829b61fffff71e1ed30
+  metadata.gz: 27c2c94ce703f039972dc6a71d7141875b70fbe8ee4c069ca6c0fd0e0a61c8b0
+  data.tar.gz: d4065bbe16258c466c12906f636a606477f35659a10c71ec504a0044d672b24b
 SHA512:
-  metadata.gz: 4b2da81bae482d9269ae444ceb7c58b73c0d769755b45d2455656169c117bfe22a18ec0288989689479c385afa5c86f00ae826f3c477d5b987e04e3da97acdcf
-  data.tar.gz: 6030b09100f99471a4874b4f30ccea42184a76eda6f6a7d8a1cb89233498f2b403766ef14981fdfaef15cca1413cdbeb9e5f17fb31e91e07729d779dd609a470
+  metadata.gz: cfa6e69b57fdf10fbc5508031805423683947bbbd3c7f68cb4c749db131a6e45dc2e58f653fd59c92244cb6e93b42fd277fd63c7451a902814de16b57f1576b0
+  data.tar.gz: 1fc269b0db15097276a0c73dbe7e96f4e796983a4eded9025db72d08f97aeb06929b5ed61759144f598a2bc29682f25c65cffbef9d47c16e93318ab55b488b2a

data/.byebug_history

@@ -0,0 +1,34 @@
+exit
+ActiveRecord::Base.connection_db_config.adapter
+ActiveRecord::Base.connection_db_config.adpter
+ActiveRecord::Base.connection_db_config
+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/.ruby-gemset

@@ -1 +1 @@
-rails_sql_prettifier_ar_6_0
+rails_sql_prettifier_ar_6

data/CHANGELOG.md

@@ -1,6 +1,11 @@
-# 6.0.2
+# 6.1.3
+* Now AR is a dependency not a development dependency 
+
+# 6.1.0
 
 * This a active record prior to 7.0 version and >= 6.1 compatible niceql integration 
   ar < 6.0 breaking change: 
-  * StatementInvalid initialization has a breaking change: starting version 6 it has named param sql: for original query )
+  * StatementInvalid initialization ahs a breaking change: starting version 6 it has named param sql: for original query )
   
+  ar <= 6.1: 
+  * Starting from 6.1 connection_db_config method replaced connection_config which was a hash

data/Dockerfile

@@ -0,0 +1,20 @@
+FROM ruby:2.7.5-bullseye
+
+WORKDIR /app
+RUN  apt-get update && apt-get -y install lsb-release
+#
+RUN wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | apt-key add - && \
+    sh -c 'echo "deb http://apt.postgresql.org/pub/repos/apt $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list' && \
+    apt-get update && apt-get -y install postgresql postgresql-client-12
+
+RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+    service postgresql start && \
+    psql -U postgres -c 'CREATE DATABASE "niceql-test"'
+
+RUN  gem install bundler
+
+COPY lib/rails_sql_prettifier/version.rb /app/lib/rails_sql_prettifier/version.rb
+COPY rails_sql_prettifier.gemspec /app/
+COPY Gemfil* /app/
+#
+RUN bundle install

data/README.md

@@ -1,7 +1,12 @@
 # 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. 
+This is an ActiveRecord integration for a niceql gem ( niceql is a small, nice, simple and zero dependency solution for the SQL prettifying in ruby ).
+
+This gem started as a code extraction from niceql version 0.4.x. 
+
+It has versioning aligned to the ActiveRecord versions, niceql prior to 0.5 version had hardcoded logic branches based on ActiveRecord versioning. 
+
+That is hard to maintain and hard to test, and also coupling with AR is breaking the original idea of the niceql to be a dependentless solution, so now the niceql is a completely railsfree gem yeay! ( It still has some some checks related to AR implemetations in the error prettifying methods. It will be completely decoupled in the future )
 
 Any reasonable suggestions are welcome. 
 
@@ -23,10 +28,13 @@ after:
 
 ## Installation
 
+rails_sql_prettifier, has several version compatible with different active_record versions, so pay attention to the right versioning
+if whenever you specify versions manually.   
+
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rails_sql_prettifier'
+gem 'rails_sql_prettifier', '~> X.X.X'
 ```
 
 And then execute:

data/docker-compose.yml

@@ -0,0 +1,10 @@
+version: "3.7"
+
+services:
+  test:
+    build: .
+    image: niceql
+    command: service postgresql start && rake test
+    volumes:
+      - '.:/app'
+

data/lib/rails_sql_prettifier/version.rb

@@ -1,3 +1,3 @@
 module RailsSQLPrettifier
-  VERSION = '6.0.2'
+  VERSION = '6.1.3'
 end

data/lib/rails_sql_prettifier.rb

@@ -2,8 +2,8 @@ require "rails_sql_prettifier/version"
 require 'active_record'
 require "niceql"
 
+
 module RailsSQLPrettifier
-  include Niceql
 
   module ArExtentions
     def exec_niceql
@@ -44,7 +44,7 @@ module RailsSQLPrettifier
     end
   end
 
-  module ARNiceQLConfig
+  module NiceQLConfigExt
     extend ActiveSupport::Concern
 
     included do
@@ -55,7 +55,7 @@ module RailsSQLPrettifier
 
 
     def ar_using_pg_adapter?
-      ActiveRecord::Base.try(:connection_config)&.with_indifferent_access&.dig(:adapter) == 'postgresql'
+      ActiveRecord::Base.connection_db_config.adapter == 'postgresql'
     end
 
     def initialize
@@ -64,17 +64,19 @@ module RailsSQLPrettifier
       self.prettify_active_record_log_output = false
       self.prettify_pg_errors = ar_using_pg_adapter?
     end
+  end
 
-    module ClassMethods
-      def configure
-        super
+  module NiceqlExt
+    def configure
+      super
 
-        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL) if config.pg_adapter_with_nicesql
+      if config.pg_adapter_with_nicesql && defined?( ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter )
+        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include( PostgresAdapterNiceQL)
+      end
 
-        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier ) if config.prettify_active_record_log_output
+      ::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
+      ::ActiveRecord::StatementInvalid.include( RailsSQLPrettifier::ErrorExt ) if config.prettify_pg_errors && config.ar_using_pg_adapter?
     end
   end
 
@@ -82,5 +84,8 @@ module RailsSQLPrettifier
    ::Arel::TreeManager,
    ::Arel::Nodes::Node].each { |klass| klass.send(:include, ArExtentions) }
 
-  NiceQLConfig.include( ARNiceQLConfig )
+  Niceql::NiceQLConfig.include( NiceQLConfigExt )
+
+  # we need to use a prepend otherwise it's not preceding Niceql.configure in a lookup chain
+  Niceql.singleton_class.prepend( NiceqlExt )
 end

data/rails_sql_prettifier.gemspec

@@ -32,8 +32,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
   spec.add_dependency "niceql", '~> 0.5'
-
-  spec.add_development_dependency "activerecord", '>= 6.0', '< 6.1'
+  spec.add_dependency "activerecord", '>= 6.1', '< 7'
 
   spec.add_development_dependency "bundler", ">= 1"
   spec.add_development_dependency "rake", ">= 12.3.3"
@@ -42,4 +41,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "differ", '~> 0.1'
   spec.add_development_dependency "pry-byebug", '~> 3.9'
   spec.add_development_dependency 'sqlite3', '~> 1'
+  spec.add_development_dependency 'pg', '~> 1'
+
+  spec.add_development_dependency 'stubberry', '~> 0.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_sql_prettifier
 version: !ruby/object:Gem::Version
-  version: 6.0.2
+  version: 6.1.3
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceql
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
-  type: :development
+        version: '7'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '6.1'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '6.1'
+        version: '7'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +128,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1'
+- !ruby/object:Gem::Dependency
+  name: pg
+  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: stubberry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
 description: 'This is an ActiveRecord integration for the SQL prettifier gem niceql. '
 email:
 - leshchuk@gmail.com
@@ -135,17 +163,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".byebug_history"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - err_now.png
 - err_was.png
 - lib/benchmark/cat.rb