rails_sql_prettifier 7.0.3 → 7.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e25116da08165fe68232d88629379f8e8cb48c503ad73926119d1906ee0a45d6
-  data.tar.gz: 3efe5e251b908df04d3e551c2a7318405cbd9392d818652db85cd73165fa4a9f
+  metadata.gz: 178b6c12be831f4a33836aea1ce14e8f6490420f687de6cba3545b8363a71bb6
+  data.tar.gz: fc2c6e85fc32dfa3bcc941acf31c229c401cf35458e285f2ef161ee76b22f79b
 SHA512:
-  metadata.gz: 78ea21d51cd7cad7b59599979a9529f7ca4173709b758b3ab4eecf2aea49e53644d7399ee303ef42d0789454a88abec6a422b9ec6b6108bc1251e15fb6216d18
-  data.tar.gz: 1958bdd7757d0d51d4b54e3d8eef556c4b42f7a18ac914677c7f8130c76c86a40627c8c251bbdbe9a6394c1f224b4aa53401d9968410fec49c89098354887153
+  metadata.gz: c5be4b4ecc5dcc39e495313cd859b41ee30ef21f2cc99508ec5c339b35ea2886afff4f7e0404d9a1b137fef41df1b7faf82f3d23bbe98c2e6bdb282512340a27
+  data.tar.gz: 558975a592a45895d2f64d6867a80c04658109dff8d32480f8502ff97a7b46e78fd0d3d598bde331f9385ddc2bd8161a0bef574c3374719c6a2a8cfed4a64bc7

data/.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"

data/.github/workflows/ci.yml

@@ -0,0 +1,23 @@
+name: CI
+
+on: [push, pull_request]
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7", "3.0", "3.1", "3.2", "3.3"]
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        bundler-cache: true # 'bundle install' and cache gems
+        ruby-version: ${{ matrix.ruby }}
+    - name: Run tests
+      run: service postgresql start && bundle exec rake test

data/.github/workflows/rubocop.yml

@@ -0,0 +1,17 @@
+name: RuboCop
+
+on: [push, pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7
+        bundler-cache: true # 'bundle install' and cache
+    - name: Run RuboCop
+      run: bundle exec rubocop --parallel

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 7.0.5
+* Fixed tests 
+* Restructured code properly
+* Fixed issue with exec_niceql over relation with error, now error will be prettified properly 
+
+# 7.0.4
+* 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 !)
+
 #7.0.3
 * fixed issue [#20](https://github.com/alekseyl/niceql/issues/20)
 * adding support for multiple ruby versions testing using docker-compose

data/Dockerfile

@@ -5,13 +5,13 @@ 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
+    apt-get update && apt-get -y install postgresql postgresql-client-14
 
-RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/$(ls /etc/postgresql)/main/pg_hba.conf' && \
     service postgresql start && \
     psql -U postgres -c 'CREATE DATABASE "niceql-test"'
 
-RUN  gem install bundler
+RUN  gem install bundler -v 2.4.22
 
 COPY lib/rails_sql_prettifier/version.rb /app/lib/rails_sql_prettifier/version.rb
 COPY rails_sql_prettifier.gemspec /app/

data/Dockerfile_30

@@ -5,13 +5,13 @@ 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
+    apt-get update && apt-get -y install postgresql postgresql-client-14
 
-RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/14/main/pg_hba.conf' && \
+RUN sh -c 'echo "local   all             all                                     trust" > /etc/postgresql/$(ls /etc/postgresql)/main/pg_hba.conf' && \
     service postgresql start && \
     psql -U postgres -c 'CREATE DATABASE "niceql-test"'
 
-RUN  gem install bundler
+RUN  gem install bundler -v 2.4.22
 
 COPY lib/rails_sql_prettifier/version.rb /app/lib/rails_sql_prettifier/version.rb
 COPY rails_sql_prettifier.gemspec /app/

data/README.md

@@ -51,12 +51,14 @@ Or install it yourself as:
 
 ```ruby
 Niceql.configure do |c|
-  # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
+  # Setting pg_adapter_with_nicesql to true will APPLY 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 
   # 
-  # You can adjust pg_adapter in production but do it at your own risk!
+  # 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 
   # 
   # If you need to debug SQL queries in production use exec_niceql
   # 
@@ -101,7 +103,7 @@ end
   # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
   Model.scope.to_niceql
   
-  # prettify PG errors if scope runs with any 
+  # will run prettified sql and hence will properly prettify PG errors if scope runs with any 
   Model.scope_with_err.exec_niceql 
 ```
 

data/lib/generators/templates/niceql_initializer.rb

@@ -1,5 +1,5 @@
 Niceql.configure do |c|
-  # You can adjust pg_adapter in prooduction at your own risk!
+  # You can adjust pg_adapter in production at your own risk!
   # If you need it in production use exec_niceql
   # default: false
   # c.pg_adapter_with_nicesql = Rails.env.development?
@@ -8,4 +8,4 @@ Niceql.configure do |c|
   # c.indentation_base = 2
   # c.open_bracket_is_newliner = false
   # c.prettify_active_record_log_output = false
-end
+end

data/lib/rails_sql_prettifier/abstract_adapter_log_prettifier.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RailsSQLPrettifier
+  module AbstractAdapterLogPrettifier
+    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, **kwargs, &block )
+    end
+  end
+end

data/lib/rails_sql_prettifier/ar_extensions.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module RailsSQLPrettifier
+
+  module ArExtentions
+    def exec_niceql(reraise = false)
+      connection.execute( to_niceql )
+    rescue => e
+      puts Niceql::Prettifier.prettify_pg_err( e.message, to_niceql )
+      raise if reraise
+    end
+
+    def to_niceql
+      Niceql::Prettifier.prettify_sql(to_sql, false)
+    end
+
+    def niceql( colorize = true )
+      puts Niceql::Prettifier.prettify_sql( to_sql, colorize )
+    end
+  end
+end

data/lib/rails_sql_prettifier/nice_ql_config_ext.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module RailsSQLPrettifier
+  module NiceQLConfigExt
+    extend ActiveSupport::Concern
+
+    included do
+      attr_accessor :pg_adapter_with_nicesql,
+                    :prettify_active_record_log_output,
+                    :prettify_pg_errors
+
+      # we need to use a prepend otherwise it's not preceding Niceql.configure in a lookup chain
+      Niceql.singleton_class.prepend(Configure)
+    end
+
+    def ar_using_pg_adapter?
+      ActiveRecord::Base.connection_db_config.adapter == 'postgresql'
+    end
+
+    def initialize
+      super
+      self.pg_adapter_with_nicesql = false
+      self.prettify_active_record_log_output = false
+      self.prettify_pg_errors = ar_using_pg_adapter?
+    end
+
+    module Configure
+      def configure
+        super
+
+        if config.pg_adapter_with_nicesql &&
+          defined?(::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter) && !protected_env?
+
+          ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include(PostgresAdapterNiceQL)
+        end
+
+        ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend(AbstractAdapterLogPrettifier) if config.prettify_active_record_log_output
+
+        ::ActiveRecord::StatementInvalid.include(NiceqlError) if config.prettify_pg_errors && config.ar_using_pg_adapter?
+      end
+    end
+  end
+
+end

data/lib/rails_sql_prettifier/niceql_error.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+module RailsSQLPrettifier
+  module NiceqlError
+    def to_s
+      # older rails version do not provide sql as a standalone query, instead they
+      # deliver joined message, and try(:sql) will set prettify_err with nil in that case
+      Niceql.config.prettify_pg_errors ? Niceql::Prettifier.prettify_err(super, try(:sql) ) : super
+    end
+  end
+end

data/lib/rails_sql_prettifier/postgres_adapter_nice_ql.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module RailsSQLPrettifier
+  module PostgresAdapterNiceQL
+    def exec_query(sql, *args, **kwargs, &block)
+      # replacing sql with prettified sql, that's all
+      super( Niceql::Prettifier.prettify_sql(sql, false), *args, **kwargs, &block )
+    end
+  end
+end

data/lib/rails_sql_prettifier/protected_env.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module RailsSQLPrettifier
+
+  module ProtectedEnv
+    def protected_env?
+      ActiveRecord::Base.connection.migration_context.protected_environment? ||
+        defined?(Rails) && !(Rails.env.test? || Rails.env.development?)
+    end
+  end
+end

data/lib/rails_sql_prettifier/version.rb

@@ -1,3 +1,3 @@
 module RailsSQLPrettifier
-  VERSION = '7.0.3'
+  VERSION = '7.0.5'
 end

data/lib/rails_sql_prettifier.rb

@@ -1,92 +1,19 @@
 require "rails_sql_prettifier/version"
+require "rails_sql_prettifier/abstract_adapter_log_prettifier"
+require "rails_sql_prettifier/ar_extensions"
+require "rails_sql_prettifier/niceql_error"
+require "rails_sql_prettifier/nice_ql_config_ext"
+require "rails_sql_prettifier/postgres_adapter_nice_ql"
+require "rails_sql_prettifier/protected_env"
+
 require 'active_record'
 require "niceql"
 
-
 module RailsSQLPrettifier
+  ::ActiveRecord::Relation.include ArExtentions
+  ::Arel::TreeManager.include      ArExtentions
+  ::Arel::Nodes::Node.include      ArExtentions
 
-  module ArExtentions
-    def exec_niceql
-      connection.execute( to_niceql )
-    end
-
-    def to_niceql
-      Niceql::Prettifier.prettify_sql(to_sql, false)
-    end
-
-    def niceql( colorize = true )
-      puts Niceql::Prettifier.prettify_sql( to_sql, colorize )
-    end
-
-  end
-
-  module PostgresAdapterNiceQL
-    def exec_query(sql, name = "SQL", binds = [], prepare: false)
-      # replacing sql with prettified sql, thats all
-      super( Niceql::Prettifier.prettify_sql(sql, false), name, binds, prepare: prepare )
-    end
-  end
-
-  module AbstractAdapterLogPrettifier
-    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, **kwargs, &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 ? Niceql::Prettifier.prettify_err(super, try(:sql) ) : super
-    end
-  end
-
-  module NiceQLConfigExt
-    extend ActiveSupport::Concern
-
-    included do
-      attr_accessor :pg_adapter_with_nicesql,
-                    :prettify_active_record_log_output,
-                    :prettify_pg_errors
-    end
-
-    def ar_using_pg_adapter?
-      ActiveRecord::Base.connection_db_config.adapter == 'postgresql'
-    end
-
-    def initialize
-      super
-      self.pg_adapter_with_nicesql = false
-      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 )
-        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include( PostgresAdapterNiceQL)
-      end
-
-      ::ActiveRecord::ConnectionAdapters::AbstractAdapter.prepend( AbstractAdapterLogPrettifier ) if config.prettify_active_record_log_output
-
-      ::ActiveRecord::StatementInvalid.include( RailsSQLPrettifier::ErrorExt ) if config.prettify_pg_errors && config.ar_using_pg_adapter?
-    end
-  end
-
-  [::ActiveRecord::Relation,
-   ::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::NiceQLConfig.include(NiceQLConfigExt)
+  Niceql.extend(ProtectedEnv)
 end

data/rails_sql_prettifier.gemspec

@@ -30,9 +30,10 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.4'
-  spec.add_dependency "niceql", '~> 0.5'
-  spec.add_dependency "activerecord", '>= 7'
+  # for rails 7 you cannot use ruby below 2.7
+  spec.required_ruby_version = '>= 2.7'
+  spec.add_dependency "niceql", '~> 0.6'
+  spec.add_dependency "activerecord", '>= 7', '< 8'
 
   spec.add_development_dependency "bundler", ">= 1"
   spec.add_development_dependency "rake", ">= 12.3.3"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rails_sql_prettifier
 version: !ruby/object:Gem::Version
-  version: 7.0.3
+  version: 7.0.5
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-19 00:00:00.000000000 Z
+date: 2025-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: niceql
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.5'
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -31,6 +31,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -38,6 +41,9 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '7'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -171,10 +177,12 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".ruby-gemset"
 - ".ruby-version"
-- ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
 - Dockerfile_30
@@ -193,6 +201,12 @@ files:
 - lib/generators/niceql/install_generator.rb
 - lib/generators/templates/niceql_initializer.rb
 - lib/rails_sql_prettifier.rb
+- lib/rails_sql_prettifier/abstract_adapter_log_prettifier.rb
+- lib/rails_sql_prettifier/ar_extensions.rb
+- lib/rails_sql_prettifier/nice_ql_config_ext.rb
+- lib/rails_sql_prettifier/niceql_error.rb
+- lib/rails_sql_prettifier/postgres_adapter_nice_ql.rb
+- lib/rails_sql_prettifier/protected_env.rb
 - lib/rails_sql_prettifier/version.rb
 - rails_sql_prettifier.gemspec
 - to_niceql.png
@@ -209,14 +223,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.4
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: This is an ActiveRecord integration for the SQL prettifier gem niceql.

data/.travis.yml

@@ -1,7 +0,0 @@
-sudo: false
-language: ruby
-rvm:
-  - 2.4
-  - 2.5
-  - 2.3
-  - 2.6