rails_sql_prettifier 5.0.2 → 5.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f8842037718631f257e8e3c15d07abcb6f745887704bc075e09848c6aeb549b
-  data.tar.gz: d84ac4beb2eee2af5f0f2def3c6d2634c9b1da0250333772070f1ca98683c549
+  metadata.gz: ba0aedcc17d28557a7bb000e0ed40a926c68d49607336640caa0d1b7fdb8def5
+  data.tar.gz: b062509b0ad5b03095d5e5ac8ae8555c463c345e67dc115cab59cc3c1bf4ee43
 SHA512:
-  metadata.gz: 1e88b6463876d5faabd76b84436815dc8266860c2176d18878c2d1b17dec4f096937ca686225be75373fd6d975ade38a60059dce7825c9ddd0f072bb8ce876a4
-  data.tar.gz: 5efaae946cd2e6859640cbf400400b2ba209085decaa82b60634eb3be622e99dadff2c4b4fbe0a914caf5b90f259158cde0102df9a92f082c84d0368caf1b602
+  metadata.gz: 48be6e8685ae50b452e3793fa8e05e594debbf08a7b501c57de0a97805104d8afbb8f543366e73e539e28b837c6e86af9a8434d0e7e9b9f249a52853cdc0f092
+  data.tar.gz: 6e1aa511179a91313381fa05f16ebc71aef8710a32a580b6d472afce4022aecae99627394e23cdfe392603269843e54a78cbdb7f1d37a083dd7e4d3c5f720b2f

data/CHANGELOG.md

@@ -1,4 +1,15 @@
-# 5.0.1
+# 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 !)
+
+#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

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

@@ -2,8 +2,11 @@
 
 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 is an extraction from niceql version 0.4.x. Its separated by different ActiveRecord versions, previous it had some version logic branching e.t.c. 
-but that is hard to maintain and test, and also breaking the idea of niceql to be dependentless solution, so now niceql is a completely railsfree solution yeay!
+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. 
 
@@ -31,7 +34,7 @@ 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:
@@ -48,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
   # 
@@ -100,7 +105,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 
 ```
 
@@ -154,7 +159,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

@@ -3,8 +3,17 @@ version: "3.7"
 services:
   test:
     build: .
-    image: niceql
-    command: service postgresql start && rake test
+    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'
 

data/lib/rails_sql_prettifier/version.rb

@@ -1,3 +1,3 @@
 module RailsSQLPrettifier
-  VERSION = '5.0.2'
+  VERSION = '5.0.5'
 end

data/lib/rails_sql_prettifier.rb

@@ -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
 
@@ -70,8 +72,8 @@ module RailsSQLPrettifier
     def configure
       super
 
-      if config.pg_adapter_with_nicesql && defined?( ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter )
-        ::ActiveRecord::ConnectionAdapters::PostgreSQLAdapter.include( PostgresAdapterNiceQL)
+      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
@@ -80,6 +82,13 @@ module RailsSQLPrettifier
     end
   end
 
+  module ProtectedEnv
+    def protected_env?
+      ActiveRecord::Base.connection.migration_context.protected_environment? ||
+        defined?(Rails) && !(Rails.env.test? || Rails.env.development?)
+    end
+  end
+
   [::ActiveRecord::Relation,
    ::Arel::TreeManager,
    ::Arel::Nodes::Node].each { |klass| klass.send(:include, ArExtentions) }
@@ -88,4 +97,5 @@ module RailsSQLPrettifier
 
   # 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)
 end

data/rails_sql_prettifier.gemspec

@@ -31,18 +31,19 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.required_ruby_version = '>= 2.4'
-  spec.add_dependency "niceql", '~> 0.5'
+  spec.add_dependency "niceql", '~> 0.6'
 
-  spec.add_development_dependency "activerecord", "< 6.0"
+  spec.add_dependency "activerecord", "< 6.0"
 
   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.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.2
+  version: 5.0.5
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-08 00:00:00.000000000 Z
+date: 2022-09-17 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,7 +31,7 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6.0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -80,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
@@ -142,14 +156,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.1'
+        version: '0.2'
 description: 'This is an ActiveRecord integration for the SQL prettifier gem niceql. '
 email:
 - leshchuk@gmail.com
@@ -164,6 +178,7 @@ files:
 - ".travis.yml"
 - CHANGELOG.md
 - Dockerfile
+- Dockerfile_30
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -202,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
+rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
 summary: This is an ActiveRecord integration for the SQL prettifier gem niceql.