rails_sql_prettifier 5.0.1 → 6.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e054a55678b35786fd255abe2842a3b4b795e5ffbb5e0ea570888c05c6abaea6
-  data.tar.gz: ba6cba10e835b079e364347eba883c63106164f20ebf7dfb7406270f657b1edd
+  metadata.gz: b61bd785fc014de67c05ebea9dfb6004c19522ecdbaecd223a8dc59cf3c717d6
+  data.tar.gz: d192a000935de406e55c4c6119bdd4286176b40a2f7473b7443d584c02187767
 SHA512:
-  metadata.gz: d01423c703f5425635c41f3bed89622b17e9860eb8322ded8de75c1bf348fd305382f0d7ae98b8d201f7494f6cac92fab959fe6475367bd782e4248889875135
-  data.tar.gz: 51695da6649ff7907d152f6a0a3105536def401640b4d2f076a0da8758a5bdccc6aa01fd1395c44777b1eef73a860eeae53d93bb32ffa54dd58e12f63e1443b3
+  metadata.gz: 3d85372a2cae35a3d590f7632c7e579b7b7595a7a680ceaffcfb4170bcce561ad12701669f85f7e3c29e2e52fca99fcc126982ecb8e412d6e20ca7a506c4cdc1
+  data.tar.gz: f885d1b7fcff14a35098d05c7802040e16233a4c21601c3299d56618219ab9255b3d794148c7a98d9222d786ed8d154bcc735c39f621494092448f5e25ec21c7

data/.gitignore

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

data/.ruby-gemset

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

data/CHANGELOG.md

@@ -1,4 +1,12 @@
-# 5.0.0
+# 6.0.4
+* Now AR is a dependency not a development dependency
 
-* This a activer 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 ) 
+# 6.0.3
+* Fixed issue with Niceql.configure not configuring anything + test covered
+
+#6.0.2
+
+* 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/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 = '5.0.1'
+  VERSION = '6.0.4'
 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
@@ -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

@@ -31,16 +31,17 @@ Gem::Specification.new do |spec|
   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_dependency "niceql", '~> 0.5'
+  spec.add_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 "differ"
-  spec.add_development_dependency "pry-byebug"
-  spec.add_development_dependency "benchmark-ips"
-  spec.add_development_dependency 'sqlite3'
+  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,43 +1,49 @@
 --- !ruby/object:Gem::Specification
 name: rails_sql_prettifier
 version: !ruby/object:Gem::Version
-  version: 5.0.1
+  version: 6.0.4
 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
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.1
+        version: '0.5'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '6.0'
-  type: :development
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+  type: :runtime
   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
@@ -84,58 +90,72 @@ dependencies:
   name: differ
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.9'
 - !ruby/object:Gem::Dependency
-  name: benchmark-ips
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        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'
+        version: '0.1'
 description: 'This is an ActiveRecord integration for the SQL prettifier gem niceql. '
 email:
 - leshchuk@gmail.com
@@ -143,18 +163,19 @@ 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

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