rails_sql_prettifier 5.0.5 → 6.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba0aedcc17d28557a7bb000e0ed40a926c68d49607336640caa0d1b7fdb8def5
-  data.tar.gz: b062509b0ad5b03095d5e5ac8ae8555c463c345e67dc115cab59cc3c1bf4ee43
+  metadata.gz: dc8698d2cb6da1287057ee6d57f4fa1d494efa19bcc013157012d0a055176243
+  data.tar.gz: 6e41b147fd207cc2ad6afcd48508b1ebb0e6cf183d5d3829b61fffff71e1ed30
 SHA512:
-  metadata.gz: 48be6e8685ae50b452e3793fa8e05e594debbf08a7b501c57de0a97805104d8afbb8f543366e73e539e28b837c6e86af9a8434d0e7e9b9f249a52853cdc0f092
-  data.tar.gz: 6e1aa511179a91313381fa05f16ebc71aef8710a32a580b6d472afce4022aecae99627394e23cdfe392603269843e54a78cbdb7f1d37a083dd7e4d3c5f720b2f
+  metadata.gz: 4b2da81bae482d9269ae444ceb7c58b73c0d769755b45d2455656169c117bfe22a18ec0288989689479c385afa5c86f00ae826f3c477d5b987e04e3da97acdcf
+  data.tar.gz: 6030b09100f99471a4874b4f30ccea42184a76eda6f6a7d8a1cb89233498f2b403766ef14981fdfaef15cca1413cdbeb9e5f17fb31e91e07729d779dd609a470

data/.ruby-gemset

@@ -1 +1 @@
-rails_sql_prettifier_ar_5
+rails_sql_prettifier_ar_6_0

data/CHANGELOG.md

@@ -1,18 +1,6 @@
-# 5.0.5
-* pg_adapter_with_nicesql setting will not be set to action for protected_env
-* niceql version set to ~> 0.6 (fixed https://github.com/alekseyl/niceql/issues/16 !)
+# 6.0.2
 
-#5.0.4
-* fixed issue [#20](https://github.com/alekseyl/niceql/issues/20)
-* adding support for multiple ruby versions testing using docker-compose
-
-# 5.0.3
-* active record versioning is properly aligned now
-
-# 5.0.2
-* Fixed issue with Niceql.configure not configuring anything + test covered
-
-# 5.0.0
-
-* This a active record prior to 6.0 version compatible niceql integration 
-  ( main difference is StatementInvalid initialization, starting version 6 it has named param sql: for original query ) 
+* 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 )
+  

data/README.md

@@ -1,12 +1,7 @@
 # RailsSQLPrettifier
 
-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 )
+This is an ActiveRecord integration for a niceql gem.
+Niceql is a small, nice, simple and zero dependency solution for SQL prettifying for Ruby. 
 
 Any reasonable suggestions are welcome. 
 
@@ -28,13 +23,10 @@ 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', '~> X.X.X'
+gem 'rails_sql_prettifier'
 ```
 
 And then execute:
@@ -51,14 +43,12 @@ Or install it yourself as:
 
 ```ruby
 Niceql.configure do |c|
-  # Setting pg_adapter_with_nicesql to true will APPLY formatting SQL queries
+  # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
   # before execution. Formatted SQL will lead to much better SQL-query debugging and much more clearer error messages 
   # if you are using Postgresql as a data source. 
+  # BUT do not use it in production until https://github.com/alekseyl/niceql/issues/16 is resolved 
   # 
-  # BUT even though https://github.com/alekseyl/niceql/issues/16 is resolved, 
-  # there could be other potentially uncovered bugs so its better not to
-  # adjust pg_adapter in production, currently there is an additional blocker for that module ProtectedEnv
-  # its will not allow patching PGAdapter for other than test/development envs 
+  # You can adjust pg_adapter in production but do it at your own risk!
   # 
   # If you need to debug SQL queries in production use exec_niceql
   # 
@@ -105,7 +95,7 @@ end
   # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
   Model.scope.to_niceql
   
-  # will run prettified sql and hence will properly prettify PG errors if scope runs with any 
+  # prettify PG errors if scope runs with any 
   Model.scope_with_err.exec_niceql 
 ```
 
@@ -159,10 +149,7 @@ 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/lib/rails_sql_prettifier/version.rb

@@ -1,3 +1,3 @@
 module RailsSQLPrettifier
-  VERSION = '5.0.5'
+  VERSION = '6.0.2'
 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,13 +28,11 @@ module RailsSQLPrettifier
   end
 
   module AbstractAdapterLogPrettifier
-    private
-    def log( sql, *args, **kwargs, &block )
+    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, **kwargs, &block )
+      super( formatted_sql, *args, &block )
     end
   end
 
@@ -46,7 +44,7 @@ module RailsSQLPrettifier
     end
   end
 
-  module NiceQLConfigExt
+  module ARNiceQLConfig
     extend ActiveSupport::Concern
 
     included do
@@ -66,26 +64,17 @@ module RailsSQLPrettifier
       self.prettify_active_record_log_output = false
       self.prettify_pg_errors = ar_using_pg_adapter?
     end
-  end
-
-  module NiceqlExt
-    def configure
-      super
 
-      if config.pg_adapter_with_nicesql && defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) && !protected_env?
-        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL)
-      end
+    module ClassMethods
+      def configure
+        super
 
-      ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier ) if config.prettify_active_record_log_output
+        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL) if config.pg_adapter_with_nicesql
 
-      ::ActiveRecord::StatementInvalid.include( RailsSQLPrettifier::ErrorExt ) if config.prettify_pg_errors && config.ar_using_pg_adapter?
-    end
-  end
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier ) if config.prettify_active_record_log_output
 
-  module ProtectedEnv
-    def protected_env?
-      ActiveRecord::Base.connection.migration_context.protected_environment? ||
-        defined?(Rails) && !(Rails.env.test? || Rails.env.development?)
+        ::ActiveRecord::StatementInvalid.include( Niceql::ErrorExt ) if config.prettify_pg_errors && config.ar_using_pg_adapter?
+      end
     end
   end
 
@@ -93,9 +82,5 @@ module RailsSQLPrettifier
    ::Arel::TreeManager,
    ::Arel::Nodes::Node].each { |klass| klass.send(:include, ArExtentions) }
 
-  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 )
-  Niceql.extend(ProtectedEnv)
+  NiceQLConfig.include( ARNiceQLConfig )
 end

data/rails_sql_prettifier.gemspec

@@ -31,19 +31,15 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.4'
-  spec.add_dependency "niceql", '~> 0.6'
+  spec.add_dependency "niceql", '~> 0.5'
 
-  spec.add_dependency "activerecord", "< 6.0"
+  spec.add_development_dependency "activerecord", '>= 6.0', '< 6.1'
 
   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: 5.0.5
+  version: 6.0.2
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-17 00:00:00.000000000 Z
+date: 2022-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceql
@@ -16,28 +16,34 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.6'
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-  type: :runtime
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -80,20 +86,6 @@ 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
@@ -136,34 +128,6 @@ 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
@@ -171,21 +135,17 @@ 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,40 +0,0 @@
-exit
-ActiveRecord::Base.connection_config[:adapter]
-ActiveRecord::Base.connection_config.adapter
-ActiveRecord::Base.connection_config
-c
-ActiveRecord.version <= Gem::Version.new(5)
-c
-ActiveRecord.version 
-exit
-ActiveRecord.version 
-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/Dockerfile

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

@@ -1,20 +0,0 @@
-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/docker-compose.yml

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