niceql 0.1.25 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b460b8c53129e07c90a14ebf63de07534d07bda56e8b563df2570659d597163
-  data.tar.gz: 63c4c608e1ae3c087ff4f3e8099a6ad3f3352a13498cfd9d54ca551fd8284c0b
+  metadata.gz: 286318425292a968afb8fd83fc05d8067bb03432bdf120ab3412a23119cc4128
+  data.tar.gz: 1a694bab19fb2281ad3e6b013b4527db6233d55885641eb2b2c76d513309b979
 SHA512:
-  metadata.gz: c71dc21142f026ce021836437215fe92b87451b64c58cf1b9c6aa492e5c8a1e2186b97f6e1e9f114cf074cdae9f36d3e381863eebd5dd7e5e4a88c4483299056
-  data.tar.gz: 60986d42e844edcda1f6a66b83d3edc1b311078a463c15d321ea3e9218f33252764bb2391a7f598fbcbffc6e9cc4af97c6862a072b4b357ff11afd14680830e1
+  metadata.gz: 7398eac94842f0f457e7323603ec21ecdae146b9ceccc84e7191f0d2d4539b8de4447f1fa33206c124bc39b5572d1df8eb054d469ea3f39b929cf6b717367d83
+  data.tar.gz: f9f4da9487a41a117f08c20416dac9ba8146597301a40c62d162b44013460337ed7015e2674b05d679488b7b6fe7ea9420ae36a244f90c21203eb872b7f0412c

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.5", "2.6", "2.7", "3.0", "3.1"]
+
+    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: 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/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-shopify: rubocop.yml

data/CHANGELOG.md

@@ -1,3 +1,49 @@
+# 0.6.1
+* github CI added ( PR: https://github.com/alekseyl/niceql/pull/22 many thnx to @petergoldstein )
+* issue fixed https://github.com/alekseyl/niceql/issues/23
+* dropped support for 2.4 ( transform_keys is missing, and I'm too lazy to backward reimplement it you can do PR if needed )
+
+# 0.6.0
+* Huge core-logic refactoring and simplification
+* dollar signed literals/strings added
+* strings literals issue https://github.com/alekseyl/niceql/issues/16 fixed
+* strings literals colorized properly
+* comments are bold and greyed now. 
+* code now is rubocoped with shopify rules
+
+# 0.5.1
+* No features just some code refactoring
+
+# 0.5.0
+* BREAKING CHANGE! ActiveRecord compatibility extracted to the rails_sql_prettifier gem! 
+  If you need niceql funcitonality with rails / active_record plz include rails_sql_prettifier has a 
+  a versioning aligned to the active_record versions and has same DSL for ActiveRecord the niceql was providing prior.  
+
+# 0.4.1
+* description update 
+
+# 0.4.0
+* merged PR https://github.com/alekseyl/niceql/pull/19, now Arel is also extended with niceql methods!!
+* test and better niceql comparisons assertion
+* tests were trialed against rails 4.2 and some additional conditions were added for later cases
+
+# 0.3.0 
+* ruby forced to >= 2.4
+* String match extension no longer needed 
+* fixed issue with missing HINT and DETAIL string ( https://github.com/alekseyl/niceql/issues/18 )
+* both new and old activerecord StatementInvalid formats supported
+* major prettify_pg_err refactoring ( much cleaner code now )
+
+# 0.2.0
+* Fix to issue https://github.com/alekseyl/niceql/pull/17#issuecomment-924278172. ActiveRecord base config is no longer a hash, 
+so it does not have dig method, hence it's breaking the ar_using_pg_adapter? method. 
+* active_record added as development dependency :( for proper testing cover. 
+
+# 0.1.30
+* ActiveRecord pg check for config now will try both connection_db_config and connection_config for adapter verification 
+* prettify_pg_errors will not be set to true if ActiveRecord adapter is not using pg, i.e. ar_using_pg_adapter? is false. 
+* rake dev dependency bumped according to security issues
+
 # 0.1.24/25
 
 * No features, just strict ruby dependency for >= 2.3,

data/Gemfile

@@ -1,6 +1,8 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in niceql.gemspec
 gemspec

data/README.md

@@ -1,10 +1,16 @@
 # Niceql
 
-This is a small, nice, simple and dependentless solution for SQL prettifiyng for Ruby. 
+**ATTENTION: After ver 0.5.0 the ActiveRecord integration is provided via standalone gem: [rails_sql_prettifier](https://github.com/alekseyl/rails_sql_prettifier)!**
+
+This is a small, nice, simple and zero dependency solution for SQL prettifying for Ruby. 
 It can be used in an irb console without any dependencies ( run bin/console and look for examples ).
 
-Any reasonable suggestions on formatting/coloring are welcome
+Any reasonable suggestions are welcome. 
+
+**Please pay attention: even though issue https://github.com/alekseyl/niceql/issues/16 is resolved 
+ still potentially UPDATE or INSERT request might corrupt your data, please don't patch pg_adapter on production!**
 
+ 
 ## Before/After 
 ### SQL prettifier: 
 ![alt text](https://github.com/alekseyl/niceql/raw/master/to_niceql.png "To_niceql")
@@ -41,9 +47,11 @@ Or install it yourself as:
 ```ruby
 Niceql.configure do |c|
   # Setting pg_adapter_with_nicesql to true will force formatting SQL queries
-  # before executing them, this will lead to better SQL-query debugging and much more clearer error messages 
+  # 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.  
-  # You can adjust pg_adapter in prooduction but do it at your own risk!
+  # 
+  # Adjusting pg_adapter in production is strongly discouraged! 
+  # 
   # If you need to debug SQL queries in production use exec_niceql
   # default: false
   # uncomment next string to enable in development
@@ -53,7 +61,7 @@ Niceql.configure do |c|
   # default: false
   # c.prettify_active_record_log_output = true
   
-  # now error prettifying is configurable
+  # Error prettifying is also configurable
   # default: defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
   # c.prettify_pg_errors = defined? ::ActiveRecord::Base && ActiveRecord::Base.configurations[Rails.env]['adapter'] == 'postgresql'
   
@@ -79,10 +87,10 @@ end
 
 ## Usage
 
-### With ActiveRecord
+### With ActiveRecord ( you need rails_sql_prettifier for that! )
 
 ```ruby
-  # puts colorized ( or not if you are willing so ) to_niceql ( you need to call puts otherwise to_niceql looks ugly  )
+  # puts colorized and formatted corresponding SQL query
   Model.scope.niceql
   
   # only formatting without colorization, you can run output of to_niceql as a SQL query in connection.execute  
@@ -107,23 +115,23 @@ end
     #=>
     #=>  SELECT * 
     #=>  FROM table
-   
-   
-
+    
 
-   # rails combines err with query, so don't forget to do it yourself:
-   puts Niceql::Prettifier.prettify_pg_err( "#{pg_err_output}\n#{sql_query}" )
+   puts Niceql::Prettifier.prettify_pg_err( pg_err_output, sql_query )
    
    # to get real nice result you should execute prettified version (i.e. execute( prettified_sql ) !) of query on your DB! 
    # otherwise you will not get such a nice output
-    puts Niceql::Prettifier.prettify_pg_err(<<~ERR )
+    raw_sql = <<~SQL
+     SELECT err 
+     FROM ( VALUES(1), (2) )
+     ORDER BY 1
+    SQL
+
+    puts Niceql::Prettifier.prettify_pg_err(<<~ERR, raw_sql )
         ERROR:  VALUES in FROM must have an alias
         LINE 2:  FROM ( VALUES(1), (2) )
                       ^
         HINT:  For example, FROM (VALUES ...) [AS] foo.
-         SELECT err 
-         FROM ( VALUES(1), (2) )
-         ORDER BY 1
     ERR
        
     

data/Rakefile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 require "rake/testtask"
 
@@ -7,4 +9,4 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
-task :default => :test
+task default: :test

data/bin/console

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "bundler/setup"
 require "niceql"

data/lib/generators/niceql/install_generator.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Niceql
   module Generators
     class InstallGenerator < Rails::Generators::Base
@@ -5,10 +7,10 @@ module Niceql
       desc "Creates Niceql initializer for your application"
 
       def copy_initializer
-        template "niceql_initializer.rb", "config/initializers/niceql.rb"
+        template("niceql_initializer.rb", "config/initializers/niceql.rb")
 
         puts "Install complete!"
       end
     end
   end
-end
+end

data/lib/generators/templates/niceql_initializer.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Niceql.configure do |c|
   # You can adjust pg_adapter in prooduction at your own risk!
   # If you need it in production use exec_niceql
@@ -8,4 +10,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/niceql/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Niceql
-  VERSION = "0.1.25"
+  VERSION = "0.6.1"
 end