rails_sql_prettifier 6.1.1 → 7.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 459c1f20e82eb14b0130418cb1161272383ae9f9f902164100b2a4d81bbabb9c
-  data.tar.gz: db5ee936e31bd470ac74940b2fa086e4a1aec84004cb05971c6434e8f5cb2ea1
+  metadata.gz: e25116da08165fe68232d88629379f8e8cb48c503ad73926119d1906ee0a45d6
+  data.tar.gz: 3efe5e251b908df04d3e551c2a7318405cbd9392d818652db85cd73165fa4a9f
 SHA512:
-  metadata.gz: a159e5b627abaa4ac80c70092668aad54f11f871c13a57e83585e38851d2f522273653d79871b2b087d1bce83de00c9119b6b2d7c28b60d7b75c8b13b1e3dde1
-  data.tar.gz: 4feabc414ccf282a7462c44527514449735b8bcdf9b2b84afe3b873735176cecbe1dcc40dfa6745b67af114391a1a38808cc3658bae4e45e8b242267932e32ce
+  metadata.gz: 78ea21d51cd7cad7b59599979a9529f7ca4173709b758b3ab4eecf2aea49e53644d7399ee303ef42d0789454a88abec6a422b9ec6b6108bc1251e15fb6216d18
+  data.tar.gz: 1958bdd7757d0d51d4b54e3d8eef556c4b42f7a18ac914677c7f8130c76c86a40627c8c251bbdbe9a6394c1f224b4aa53401d9968410fec49c89098354887153

data/.gitignore

@@ -8,4 +8,5 @@
 /spec/reports/
 /tmp/
 /inspectionProfiles/
-.idea
+.idea
+.byebug_history

data/.ruby-gemset

@@ -1 +1 @@
-rails_sql_prettifier_ar_6
+rails_sql_prettifier

data/CHANGELOG.md

@@ -1,8 +1,9 @@
-# 6.1.0
+#7.0.3
+* fixed issue [#20](https://github.com/alekseyl/niceql/issues/20)
+* adding support for multiple ruby versions testing using docker-compose
 
-* This a active record prior to 7.0 version and >= 6.1 compatible niceql integration 
-  ar < 6.0: 
-  * StatementInvalid initialization, starting version 6 it has named param sql: for original query )
-  
-  ar <= 6.1: 
-  * Starting from 6.1 connection_db_config used as standalone object instead of connection_config
+#7.0.2
+* active record versioning is properly aligned now 
+
+#7.0.0
+* current master branch 

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/Dockerfile_30

@@ -0,0 +1,20 @@
+FROM ruby:3.0.3-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 implementations 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:
@@ -86,8 +94,6 @@ end
 
 ## Usage
 
-### With ActiveRecord
-
 ```ruby
   # puts colorized and formatted corresponding SQL query
   Model.scope.niceql
@@ -149,7 +155,10 @@ end
 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.
 
-## 
+## Testing
+```bash
+docker-compose up
+```
 
 ## Contributing
 

data/docker-compose.yml

@@ -0,0 +1,18 @@
+version: "3.7"
+
+services:
+  test:
+    build: .
+    image: niceql
+    command: /bin/bash -c 'service postgresql start && rake test'
+    volumes:
+      - '.:/app'
+
+  test_3_0:
+    build:
+      context: .
+      dockerfile: Dockerfile_30
+    image: niceql_3_0
+    command: /bin/bash -c 'service postgresql start && rake test'
+    volumes:
+      - '.:/app'

data/lib/rails_sql_prettifier/version.rb

@@ -1,3 +1,3 @@
 module RailsSQLPrettifier
-  VERSION = '6.1.1'
+  VERSION = '7.0.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
@@ -28,11 +28,13 @@ module RailsSQLPrettifier
   end
 
   module AbstractAdapterLogPrettifier
-    def log( sql, *args, &block )
+    private
+    def log( sql, *args, **kwargs, &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 )
+
+      super( formatted_sql, *args, **kwargs, &block )
     end
   end
 
@@ -44,7 +46,7 @@ module RailsSQLPrettifier
     end
   end
 
-  module ARNiceQLConfig
+  module NiceQLConfigExt
     extend ActiveSupport::Concern
 
     included do
@@ -53,7 +55,6 @@ module RailsSQLPrettifier
                     :prettify_pg_errors
     end
 
-
     def ar_using_pg_adapter?
       ActiveRecord::Base.connection_db_config.adapter == 'postgresql'
     end
@@ -64,17 +65,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 +85,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,14 +32,17 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.4'
   spec.add_dependency "niceql", '~> 0.5'
-
-  spec.add_development_dependency "activerecord", '>= 6.1', '< 7'
+  spec.add_dependency "activerecord", '>= 7'
 
   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 "awesome_print"
   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.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_sql_prettifier
 version: !ruby/object:Gem::Version
-  version: 6.1.1
+  version: 7.0.3
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceql
@@ -29,19 +29,13 @@ dependencies:
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
-      - !ruby/object:Gem::Version
-        version: '6.1'
-    - - "<"
       - !ruby/object:Gem::Version
         version: '7'
 - !ruby/object:Gem::Dependency
@@ -86,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: differ
   requirement: !ruby/object:Gem::Requirement
@@ -128,6 +136,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.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
 description: 'This is an ActiveRecord integration for the SQL prettifier gem niceql. '
 email:
 - leshchuk@gmail.com
@@ -135,18 +171,20 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".byebug_history"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- Dockerfile
+- Dockerfile_30
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
 - bin/console
 - bin/setup
+- docker-compose.yml
 - err_now.png
 - err_was.png
 - lib/benchmark/cat.rb

data/.byebug_history

@@ -1,34 +0,0 @@
-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