niceql 0.6.0 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '0339306d10ce7dc5085193472b48e3570c0746078e9facdc8c21c75983ca075d'
-  data.tar.gz: 79b513131cbc2ccc1afb4275e749e10078dcba15ed6fc05647b8877f3d149a3d
+  metadata.gz: f62d4429294ec7ef47e564052b2f5707db818fbb38509bcfc77fdcdc4bb0351f
+  data.tar.gz: bfd07f10dc1b7bd99ce81e727eb3afb23bf34dc00fdf2ccf2fcfa9257cb26727
 SHA512:
-  metadata.gz: 7383d5b1b5c737fb8da4c877d5d96ca119081b53dc07377af216eda7a07276f480e98e70f6a30d887cee5d0f6df3b1e2762b907de0cc960870a10bd58fe5ad9c
-  data.tar.gz: 29ad243cab8a66210070cf43b3072e4977b6fc1ed56fae41cfe9bba27de4b185fb80a76516ae498c0ef5c844f165ad15caac4001b243d6c3185bf3c873cfdd33
+  metadata.gz: 4985d9e128475c93ac6dced329409fc2c6c544de35e6216e723f7d3fbc5baf94584e375d5991fb707f219b57e6129f78d410be24866b1f8e91b79ba5d5f65df7
+  data.tar.gz: 7bd016c10244cb5cbb6197e6add3973c47471c7b59f539d0285ca6c5bff04e351df1fbf2c8f77ea2aff4854adca5ec47d6dd1c0666eaec15caf38a854b411a17

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", "3.2", "3.3", "3.4"]
+
+    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/CHANGELOG.md

@@ -1,3 +1,12 @@
+# 0.6.2
+* github CI added 3.2, 3.3, 3.4 to matrix
+* fixed: https://github.com/alekseyl/niceql/issues/25
+
+# 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

data/README.md

@@ -5,11 +5,7 @@
 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: 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!**
-
+Any reasonable suggestions are welcome.
  
 ## Before/After 
 ### SQL prettifier: 

data/lib/niceql/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Niceql
-  VERSION = "0.6.0"
+  VERSION = "0.6.2"
 end

data/lib/niceql.rb

@@ -6,24 +6,26 @@ require "forwardable"
 
 module Niceql
   module StringColorize
-    def self.colorize_keyword(str)
-      # yellow ANSI color
-      "\e[0;33;49m#{str}\e[0m"
-    end
+    class << self
+      def colorize_keyword(str)
+        # yellow ANSI color
+        "\e[0;33;49m#{str}\e[0m"
+      end
 
-    def self.colorize_str(str)
-      # cyan ANSI color
-      "\e[0;36;49m#{str}\e[0m"
-    end
+      def colorize_str(str)
+        # cyan ANSI color
+        "\e[0;36;49m#{str}\e[0m"
+      end
 
-    def self.colorize_err(err)
-      # red ANSI color
-      "\e[0;31;49m#{err}\e[0m"
-    end
+      def colorize_err(err)
+        # red ANSI color
+        "\e[0;31;49m#{err}\e[0m"
+      end
 
-    def self.colorize_comment(comment)
-      # bright black bold ANSI color
-      "\e[0;90;1;49m#{comment}\e[0m"
+      def colorize_comment(comment)
+        # bright black bold ANSI color
+        "\e[0;90;1;49m#{comment}\e[0m"
+      end
     end
   end
 
@@ -31,7 +33,8 @@ module Niceql
     # ?= -- should be present but without being added to MatchData
     AFTER_KEYWORD_SPACE = '(?=\s{1})'
     JOIN_KEYWORDS = '(RIGHT\s+|LEFT\s+){0,1}(INNER\s+|OUTER\s+){0,1}JOIN(\s+LATERAL){0,1}'
-    INLINE_KEYWORDS = "WITH|ASC|COALESCE|AS|WHEN|THEN|ELSE|END|AND|UNION|ALL|ON|DISTINCT|INTERSECT|EXCEPT|EXISTS|NOT|COUNT|ROUND|CAST|IN"
+    INLINE_KEYWORDS = "WITH|ASC|COALESCE|AS|WHEN|THEN|ELSE|END|AND|UNION|ALL|ON|DISTINCT|"\
+      "INTERSECT|EXCEPT|EXISTS|NOT|COUNT|ROUND|CAST|IN"
     NEW_LINE_KEYWORDS = "SELECT|FROM|WHERE|CASE|ORDER BY|LIMIT|GROUP BY|HAVING|OFFSET|UPDATE|SET|#{JOIN_KEYWORDS}"
 
     POSSIBLE_INLINER = /(ORDER BY|CASE)/
@@ -94,7 +97,11 @@ module Niceql
         sql_start_line_num = 3 if err.lines.length <= 3
         # error not always contains HINT
         sql_start_line_num ||= err.lines[3][/(HINT|DETAIL)/] ? 4 : 3
-        sql_body_lines = sql_start_line_num < err.lines.length ? err.lines[sql_start_line_num..-1] : original_sql_query&.lines
+        sql_body_lines = if sql_start_line_num < err.lines.length
+          err.lines[sql_start_line_num..-1]
+        else
+          original_sql_query&.lines
+        end
 
         # this means original query is missing so it's nothing to prettify
         return err unless sql_body_lines
@@ -164,7 +171,8 @@ module Niceql
     # 1. Split the original query onto the query part + literals + comments
     #   a. find all potential dollar-signed separators
     #   b. prepare full literal extractor regex
-    # 2. Find and separate all literals and comments into mutable/format-able types and immutable  ( see the typing and formatting rules below )
+    # 2. Find and separate all literals and comments into mutable/format-able types
+    #    and immutable  ( see the typing and formatting rules below )
     # 3. Replace all literals and comments with uniq ids on the original query to get the parametrized query
     # 4. Format parametrized query alongside with mutable/format-able comments and literals
     #   a. clear space characters: replace all \s+ to \s, remove all "\n" e.t.c
@@ -228,7 +236,11 @@ module Niceql
       end
 
       def prettified_sql
-        @parametrized_sql % @guids_to_content.transform_keys(&:to_sym)
+        # sprintf or % interpolation will throw an error with standalone '%', but
+        # % is a legit operand: https://github.com/alekseyl/niceql/issues/25
+        # so it should be escaped via doubling, the easiest way is to do it twice,
+        # doubling every %, and then restoring single % for the combination of %%{
+        @parametrized_sql.gsub("%", "%%").gsub("%%{", "%{") % @guids_to_content.transform_keys(&:to_sym)
       end
 
       private
@@ -246,7 +258,8 @@ module Niceql
           post_match_str = Regexp.last_match.post_match
 
           if ["SELECT", "UPDATE", "INSERT"].include?(matched_part)
-            indent += config.indentation_base if !config.open_bracket_is_newliner || brackets.last.nil? || brackets.last[:nested]
+            indent_block = !config.open_bracket_is_newliner || brackets.last.nil? || brackets.last[:nested]
+            indent += config.indentation_base if indent_block
             brackets.last[:nested] = true if brackets.last
             add_new_line = !first_keyword
           elsif matched_part == "("
@@ -334,6 +347,8 @@ module Niceql
       # when comment ending with newline followed by a keyword we should remove double newlines
       def clear_extra_newline_after_comments
         newlined_comments = @literals_and_comments_types.select { |k,| new_line_ending_comment?(k) }
+        return if newlined_comments.empty?
+
         parametrized_sql.gsub!(/(#{newlined_comments.keys.join("}\n|")}}\n)/, &:chop)
       end
 
@@ -446,11 +461,13 @@ module Niceql
     end
   end
 
-  def self.configure
-    yield(config)
-  end
+  class << self
+    def configure
+      yield(config)
+    end
 
-  def self.config
-    @config ||= NiceQLConfig.new
+    def config
+      @config ||= NiceQLConfig.new
+    end
   end
 end

data/niceql.gemspec

@@ -36,13 +36,13 @@ 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.required_ruby_version = ">= 2.5"
 
   spec.add_development_dependency("awesome_print")
   spec.add_development_dependency("bundler", ">= 1")
   spec.add_development_dependency("minitest", "~> 5.0")
   spec.add_development_dependency("rake", ">= 12.3.3")
-  spec.add_development_dependency("rubocop-shopify", "~> 2.0.0")
+  spec.add_development_dependency("rubocop-shopify", "~> 2.0")
 
   spec.add_development_dependency("benchmark-ips")
   spec.add_development_dependency("differ")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: niceql
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.2
 platform: ruby
 authors:
 - alekseyl
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-09-16 00:00:00.000000000 Z
+date: 2025-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: awesome_print
@@ -72,14 +72,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -146,9 +146,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/dependabot.yml"
+- ".github/workflows/ci.yml"
+- ".github/workflows/rubocop.yml"
 - ".gitignore"
 - ".rubocop.yml"
-- ".travis.yml"
 - CHANGELOG.md
 - Gemfile
 - LICENSE.txt
@@ -177,14 +179,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.4'
+      version: '2.5'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.9
+rubygems_version: 3.3.26
 signing_key:
 specification_version: 4
 summary: This is a simple and nice gem for SQL prettifying and formatting. Niceql

data/.travis.yml

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