niceql 0.4.1 → 0.6.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dd33b2edcd3a477068b38011e5030f5ebc261ffce8990f359754d01b556ac2f
-  data.tar.gz: ccbd8f33db8b50fe447e43fa08b875a9e6ca6e80a9de6179a823bd81df8df52c
+  metadata.gz: 286318425292a968afb8fd83fc05d8067bb03432bdf120ab3412a23119cc4128
+  data.tar.gz: 1a694bab19fb2281ad3e6b013b4527db6233d55885641eb2b2c76d513309b979
 SHA512:
-  metadata.gz: 6584d6c7f9b7d53cd9726b1bdd21808df7f1a271b35c06b151dd747f33eb133897e559afbca2650659ad52c82acaed33c52785e90d8b8f9722e5490c639508fd
-  data.tar.gz: b0f3fc0eac42a2fb94ca60a79366d10c80e41e0baf89343853572a6679d558727ce22ce6364c5719cd8998544fa75c2153a7e633cb213f67e7f0c7041a1a3ddf
+  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,24 @@
+# 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 
 

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,11 +1,14 @@
 # Niceql
 
+**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 are welcome. 
 
-**Please pay attention: untill issue https://github.com/alekseyl/niceql/issues/16 is resolved any UPDATE or INSERT request might corrupt your data, don't use on production!**
+**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 
@@ -47,7 +50,7 @@ Niceql.configure do |c|
   # 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 production 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
@@ -84,7 +87,7 @@ end
 
 ## Usage
 
-### With ActiveRecord
+### With ActiveRecord ( you need rails_sql_prettifier for that! )
 
 ```ruby
   # puts colorized and formatted corresponding SQL query

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.4.1'
+  VERSION = "0.6.1"
 end