anbt-sql-formatter 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 533c8ba946b0b41bb3e9b56631b9e4fcbf7fd8e643b6c0875c1a3d1b2f8f25c8
-  data.tar.gz: e74a08b3d979b1cab4d998533c8ed6167cfe703ee75288da4e45d31c25e91d41
+  metadata.gz: c4680b59adee7c6d2e6bcb649d73b095d3bbcd3d102f8517d50acefc89dfe089
+  data.tar.gz: dac35873e1d94941ec19156d2738fe75c1b0e156e2357cc1a10e263157c253c6
 SHA512:
-  metadata.gz: cfd6fdc3fc8621957778f559464c7ab863cc5665b0ec084cbf755010ee6fd1699e7f3ad1952bc85d43d6d1fb233eb1b49858935d3c67fe1a7f4b9c4b8c20e476
-  data.tar.gz: 9b8ddfe422d4fb89f381751c95517ab8252a9abd6a915df228886deffec4d478c95f9983a356d681ac12ea8eb035cdb21424816074d4980547897a03c5328e7d
+  metadata.gz: 52692fbb602a719f52a13077bd72b7a4c8d065ba484c6fbd141f928ad3987364dd3517c6fd7d66f9283acee8ecf8fd7033d2df467ffe6a5e0aa4f9e401b7cc6d
+  data.tar.gz: dcc161a7b754fd3937dfa8c799950aba2ea88a1db9990f38fb4e51ff6cb69e6c07ce619bd4843dba358e93f31d3787ba231ca076fbbdcd0216b224628f802b18

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 0.0.7 (2018-08-11)
+
+No breaking changes.
+
+## Feattues
+
+- New configuration parameter `Rule#in_values_num`
+  for controlling number of values in IN clause per line.
+
+
 # 0.0.6 (2018-03-31)
 
 No breaking changes.

data/bin/anbt-sql-formatter

@@ -5,13 +5,8 @@ begin
   require "anbt-sql-formatter/formatter"
 rescue LoadError
   $LOAD_PATH << File.expand_path(
-                                 File.join(
-                                           __FILE__,
-                                           "..",
-                                           "..",
-                                           "lib"
-                                           )
-                                 )
+    File.join(__FILE__, "..", "..", "lib")
+  )
   require "anbt-sql-formatter/formatter"
 end
 
@@ -36,7 +31,6 @@ def main
     rule.function_names << func_name.upcase
   }
 
-  #rule.indentString = "('-')"
   rule.indent_string = "    "
   
   formatter = AnbtSql::Formatter.new(rule)

data/lib/anbt-sql-formatter/formatter.rb

@@ -3,6 +3,7 @@
 require "anbt-sql-formatter/rule"
 require "anbt-sql-formatter/parser"
 require "anbt-sql-formatter/exception"
+require "anbt-sql-formatter/in_values_checker"
 require "anbt-sql-formatter/helper" # Stack
 
 
@@ -16,7 +17,7 @@ class AnbtSql
     def initialize(rule)
       @rule = rule
       @parser = AnbtSql::Parser.new(@rule)
-      
+
       # 丸カッコが関数のものかどうかを記憶
       @function_bracket = Stack.new
     end
@@ -52,7 +53,7 @@ class AnbtSql
         if sql_str.end_with?("\n")
           is_sql_ends_with_new_line = true
         end
-        
+
         tokens = @parser.parse(sql_str)
 
         statements = split_to_statements(tokens)
@@ -74,12 +75,12 @@ class AnbtSql
       end
     end
 
-    
+
     def modify_keyword_case(tokens)
       # SQLキーワードは大文字とする。or ...
       tokens.each{ |token|
         next if token._type != AnbtSql::TokenConstants::KEYWORD
-        
+
         case @rule.keyword
         when AnbtSql::Rule::KEYWORD_NONE
           ;
@@ -91,7 +92,7 @@ class AnbtSql
       }
     end
 
-    
+
     ##
     # .
     #  ["(", "+", ")"] => ["(+)"]
@@ -101,7 +102,7 @@ class AnbtSql
       while index < tokens.size - 2
         if (tokens[index    ].string == "(" &&
             tokens[index + 1].string == "+" &&
-            tokens[index + 2].string == ")") 
+            tokens[index + 2].string == ")")
           tokens[index].string = "(+)"
           ArrayUtil.remove(tokens, index + 1)
           ArrayUtil.remove(tokens, index + 1)
@@ -142,21 +143,21 @@ class AnbtSql
         token = ArrayUtil.get(tokens, index    )
 
         if (prev._type  != AnbtSql::TokenConstants::SPACE &&
-            token._type != AnbtSql::TokenConstants::SPACE) 
+            token._type != AnbtSql::TokenConstants::SPACE)
           # カンマの後にはスペース入れない
           if not @rule.space_after_comma
             if prev.string == ","
               index += 1 ; next
             end
           end
-          
+
           # 関数名の後ろにはスペースは入れない
           # no space after function name
           if (@rule.function?(prev.string) &&
               token.string == "(")
             index += 1 ; next
           end
-          
+
           ArrayUtil.add(tokens, index,
                      AnbtSql::Token.new(AnbtSql::TokenConstants::SPACE, " ")
                      )
@@ -164,8 +165,8 @@ class AnbtSql
         index += 1
       end
     end
-    
-    
+
+
     def format_list_main_loop(tokens)
       # インデントを整える。
       indent = 0
@@ -176,13 +177,14 @@ class AnbtSql
                                   " ")
 
       encounter_between = false
+      in_values_checker = nil
 
       index = 0
       # Length of tokens changes in loop!
       while index < tokens.size
         token = ArrayUtil.get(tokens, index)
-        
-        if token._type == AnbtSql::TokenConstants::SYMBOL # ****
+
+        if token._type == AnbtSql::TokenConstants::SYMBOL
 
           # indentを１つ増やし、'('のあとで改行。
           if token.string == "("
@@ -196,18 +198,23 @@ class AnbtSql
             indent = (bracket_indent.pop()).to_i
             index += insert_return_and_indent(tokens, index, indent)
             @function_bracket.pop()
-            
+
             # ','の前で改行
           elsif token.string == ","
-            index += insert_return_and_indent(tokens, index, indent, "x")
+            if in_values_checker.nil? || in_values_checker.check()
+              index += insert_return_and_indent(tokens, index, indent, "x")
+            end
 
           elsif token.string == ";"
             # 2005.07.26 Tosiki Iga とりあえずセミコロンでSQL文がつぶれないように改良
             indent = 0
             index += insert_return_and_indent(tokens, index, indent)
           end
-          
-        elsif token._type == AnbtSql::TokenConstants::KEYWORD # ****
+
+        elsif token._type == AnbtSql::TokenConstants::KEYWORD
+          in_values_checker = nil if in_values_checker
+
+          in_values_checker = AnbtSql::InValuesChecker.new(@rule) if equals_ignore_case(token.string, "IN")
 
           # indentを２つ増やし、キーワードの後ろで改行
           if (equals_ignore_case(token.string, "DELETE") ||
@@ -254,7 +261,7 @@ class AnbtSql
           # キーワードの前で改行。indentを強制的に０にする。
           if (equals_ignore_case(token.string, "UNION"    ) ||
               equals_ignore_case(token.string, "INTERSECT") ||
-              equals_ignore_case(token.string, "EXCEPT"   )   ) 
+              equals_ignore_case(token.string, "EXCEPT"   )   )
             indent -= 2
             index += insert_return_and_indent(tokens, index    , indent)
             index += insert_return_and_indent(tokens, index + 1, indent)
@@ -272,7 +279,7 @@ class AnbtSql
             encounter_between = false
           end
 
-        elsif (token._type == AnbtSql::TokenConstants::COMMENT) # ****
+        elsif (token._type == AnbtSql::TokenConstants::COMMENT)
 
           if token.string.start_with?("/*")
             # マルチラインコメントの後に改行を入れる。
@@ -282,12 +289,12 @@ class AnbtSql
           end
         end
         prev = token
-        
+
         index += 1
       end
     end
-    
-    
+
+
     #  before: [..., "(", space, "X", space, ")", ...]
     #  after:  [..., "(X)", ...]
     # ただし、これでは "(X)" という一つの symbol トークンになってしまう。
@@ -295,7 +302,7 @@ class AnbtSql
     # せっかくなので symbol/X/symbol と分けたい。
     def special_treatment_for_parenthesis_with_one_element(tokens)
       (tokens.size - 1).downto(4).each{|index|
-        next if (index >= tokens.size()) 
+        next if (index >= tokens.size())
 
         t0 = ArrayUtil.get(tokens, index    )
         t1 = ArrayUtil.get(tokens, index - 1)
@@ -305,7 +312,7 @@ class AnbtSql
 
         if (equals_ignore_case(t4.string      , "(") &&
             equals_ignore_case(t3.string.strip, "" ) &&
-            equals_ignore_case(t1.string.strip, "" ) && 
+            equals_ignore_case(t1.string.strip, "" ) &&
             equals_ignore_case(t0.string      , ")")   )
           t4.string = t4.string + t2.string + t0.string
           ArrayUtil.remove(tokens, index    )
@@ -316,7 +323,7 @@ class AnbtSql
       }
     end
 
-    
+
     def format_list(tokens)
       return [] if tokens.empty?
 
@@ -328,7 +335,7 @@ class AnbtSql
         ArrayUtil.remove(tokens, 0)
       end
       return [] if tokens.empty?
-      
+
       token = ArrayUtil.get(tokens, tokens.size() - 1)
       if token._type == AnbtSql::TokenConstants::SPACE
         ArrayUtil.remove(tokens, tokens.size() - 1)
@@ -357,11 +364,11 @@ class AnbtSql
       # 関数内では改行は挿入しない
       # No linefeed in function.
       return 0 if (@function_bracket.include?(true))
-      
+
       begin
         # 挿入する文字列を作成する。
         s = "\n"
-        
+
         # インデントをつける。
         indent = 0 if indent < 0 ## Java版と異なる
         s += @rule.indent_string * indent
@@ -397,6 +404,6 @@ class AnbtSql
       rescue => e
         raise e
       end
-    end                               
+    end
   end
 end

data/lib/anbt-sql-formatter/in_values_checker.rb

@@ -0,0 +1,32 @@
+class AnbtSql
+  class InValuesChecker
+    def initialize(rule)
+      if rule.in_values_num.nil?
+        @mode = :default
+      elsif rule.in_values_num == AnbtSql::Rule::ONELINE_IN_VALUES_NUM
+        @mode = :oneline
+        @num = rule.in_values_num
+      else
+        @mode = :compact
+        @num = rule.in_values_num
+        @counter = 0
+      end
+    end
+
+    def check
+      if @mode == :default
+        true
+      elsif @mode == :oneline
+        false
+      else
+        @counter += 1
+        if @counter == @num
+          @counter = 0
+          true
+        else
+          false
+        end
+      end
+    end
+  end
+end

data/lib/anbt-sql-formatter/rule.rb

@@ -32,15 +32,24 @@ class AnbtSql
     attr_accessor :kw_nl_x
     attr_accessor :kw_nl_x_plus1_indent
 
+    # Limit number of values per line in IN clause to this value.
+    #
+    # nil:: one value per line (default)
+    # n (>=2):: n values per line
+    # ONELINE_IN_VALUES_NUM:: all values in one line
+    attr_accessor :in_values_num
+
     # キーワードの変換規則: 何もしない
     KEYWORD_NONE = 0
 
     # キーワードの変換規則: 大文字にする
     KEYWORD_UPPER_CASE = 1
-    
+
     # キーワードの変換規則: 小文字にする
     KEYWORD_LOWER_CASE = 2
 
+    # IN の値を一行表示する場合の in_values_num 値
+    ONELINE_IN_VALUES_NUM = 0
 
     def initialize
       # キーワードの変換規則.
@@ -51,7 +60,7 @@ class AnbtSql
       @indent_string = "    "
 
       @space_after_comma = false
-      
+
       # __foo
       # ____KW
       @kw_plus1_indent_x_nl = %w(INSERT INTO CREATE DROP TRUNCATE TABLE CASE)
@@ -65,12 +74,12 @@ class AnbtSql
       # __foo
       # ____KW
       @kw_nl_x_plus1_indent = %w(ON USING)
-      
+
       # __foo
       # __KW
       @kw_nl_x = %w(OR THEN ELSE)
       # @kw_nl_x = %w(OR WHEN ELSE)
-      
+
       @kw_multi_words = ["ORDER BY", "GROUP BY"]
 
       # 関数の名前。
@@ -117,7 +126,7 @@ class AnbtSql
           return true
         end
       end
-      
+
       return false
     end
   end

data/lib/anbt-sql-formatter/version.rb

@@ -1,7 +1,7 @@
 module Anbt
   module Sql
     module Formatter
-      VERSION = "0.0.6"
+      VERSION = "0.0.7"
     end
   end
 end

data/test/test_in_values.rb

@@ -0,0 +1,193 @@
+# -*- coding: utf-8 -*-
+
+require File.join(File.expand_path(File.dirname(__FILE__)), "helper")
+
+require "anbt-sql-formatter/formatter"
+
+class TestAnbtSqlInValues < Test::Unit::TestCase
+  def test_format_without_in_values_num
+    rule = base_rule
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "without in_values_num setting"
+    sql = "select * from users where id in (" + (1...30).to_a.join(",") + ")"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      1
+      ,2
+      ,3
+      ,4
+      ,5
+      ,6
+      ,7
+      ,8
+      ,9
+      ,10
+      ,11
+      ,12
+      ,13
+      ,14
+      ,15
+      ,16
+      ,17
+      ,18
+      ,19
+      ,20
+      ,21
+      ,22
+      ,23
+      ,24
+      ,25
+      ,26
+      ,27
+      ,28
+      ,29
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  def test_format_num_in_values
+    rule = base_rule
+    rule.in_values_num = 10
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "num in values"
+    sql = "select * from users where id in (" + (1...100).to_a.join(",") + ")"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      1 ,2 ,3 ,4 ,5 ,6 ,7 ,8 ,9 ,10
+      ,11 ,12 ,13 ,14 ,15 ,16 ,17 ,18 ,19 ,20
+      ,21 ,22 ,23 ,24 ,25 ,26 ,27 ,28 ,29 ,30
+      ,31 ,32 ,33 ,34 ,35 ,36 ,37 ,38 ,39 ,40
+      ,41 ,42 ,43 ,44 ,45 ,46 ,47 ,48 ,49 ,50
+      ,51 ,52 ,53 ,54 ,55 ,56 ,57 ,58 ,59 ,60
+      ,61 ,62 ,63 ,64 ,65 ,66 ,67 ,68 ,69 ,70
+      ,71 ,72 ,73 ,74 ,75 ,76 ,77 ,78 ,79 ,80
+      ,81 ,82 ,83 ,84 ,85 ,86 ,87 ,88 ,89 ,90
+      ,91 ,92 ,93 ,94 ,95 ,96 ,97 ,98 ,99
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  def test_format_str_in_values
+    rule = base_rule
+    rule.in_values_num = 10
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "str in values"
+    sql = "select * from users where id in (" + (1...100).map { |i| "'#{i}'"  }.join(",") + ")"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      '1' ,'2' ,'3' ,'4' ,'5' ,'6' ,'7' ,'8' ,'9' ,'10'
+      ,'11' ,'12' ,'13' ,'14' ,'15' ,'16' ,'17' ,'18' ,'19' ,'20'
+      ,'21' ,'22' ,'23' ,'24' ,'25' ,'26' ,'27' ,'28' ,'29' ,'30'
+      ,'31' ,'32' ,'33' ,'34' ,'35' ,'36' ,'37' ,'38' ,'39' ,'40'
+      ,'41' ,'42' ,'43' ,'44' ,'45' ,'46' ,'47' ,'48' ,'49' ,'50'
+      ,'51' ,'52' ,'53' ,'54' ,'55' ,'56' ,'57' ,'58' ,'59' ,'60'
+      ,'61' ,'62' ,'63' ,'64' ,'65' ,'66' ,'67' ,'68' ,'69' ,'70'
+      ,'71' ,'72' ,'73' ,'74' ,'75' ,'76' ,'77' ,'78' ,'79' ,'80'
+      ,'81' ,'82' ,'83' ,'84' ,'85' ,'86' ,'87' ,'88' ,'89' ,'90'
+      ,'91' ,'92' ,'93' ,'94' ,'95' ,'96' ,'97' ,'98' ,'99'
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  def test_format_oneline_in_values
+    rule = base_rule
+    rule.in_values_num = AnbtSql::Rule::ONELINE_IN_VALUES_NUM
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "oneline in values"
+    sql = "select * from users where id in (" + (1...50).to_a.join(",") + ")"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      1 ,2 ,3 ,4 ,5 ,6 ,7 ,8 ,9 ,10 ,11 ,12 ,13 ,14 ,15 ,16 ,17 ,18 ,19 ,20 ,21 ,22 ,23 ,24 ,25 ,26 ,27 ,28 ,29 ,30 ,31 ,32 ,33 ,34 ,35 ,36 ,37 ,38 ,39 ,40 ,41 ,42 ,43 ,44 ,45 ,46 ,47 ,48 ,49
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  def test_format_with_space_after_comma
+    rule = base_rule
+    rule.in_values_num = 10
+    rule.space_after_comma = true
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "num in values"
+    sql = "select * from users where id in (" + (1...100).to_a.join(",") + ")"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      1 , 2 , 3 , 4 , 5 , 6 , 7 , 8 , 9 , 10
+      , 11 , 12 , 13 , 14 , 15 , 16 , 17 , 18 , 19 , 20
+      , 21 , 22 , 23 , 24 , 25 , 26 , 27 , 28 , 29 , 30
+      , 31 , 32 , 33 , 34 , 35 , 36 , 37 , 38 , 39 , 40
+      , 41 , 42 , 43 , 44 , 45 , 46 , 47 , 48 , 49 , 50
+      , 51 , 52 , 53 , 54 , 55 , 56 , 57 , 58 , 59 , 60
+      , 61 , 62 , 63 , 64 , 65 , 66 , 67 , 68 , 69 , 70
+      , 71 , 72 , 73 , 74 , 75 , 76 , 77 , 78 , 79 , 80
+      , 81 , 82 , 83 , 84 , 85 , 86 , 87 , 88 , 89 , 90
+      , 91 , 92 , 93 , 94 , 95 , 96 , 97 , 98 , 99
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  def test_format_ignore_in_values_compact_when_select
+    rule = base_rule
+    rule.in_values_num = AnbtSql::Rule::ONELINE_IN_VALUES_NUM
+    @fmt = AnbtSql::Formatter.new(rule)
+    msg = "num in values"
+    sql = "select * from users where id in (select user_id from admins)"
+    expected = <<EOS
+SELECT
+    *
+  FROM
+    users
+  WHERE
+    id IN (
+      SELECT
+          user_id
+        FROM
+          admins
+    )
+EOS
+
+     assert_equals(msg, expected.strip, @fmt.format(sql))
+  end
+
+  private
+
+  def base_rule
+    rule = AnbtSql::Rule.new
+    rule.indent_string = "  "
+    rule
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: anbt-sql-formatter
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - sonota88
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-03-31 00:00:00.000000000 Z
+date: 2018-08-11 00:00:00.000000000 Z
 dependencies: []
 description: A tool for SQL formatting written in Ruby. Ruby port of Blanco SQL Formatter.
 email:
@@ -30,6 +30,7 @@ files:
 - lib/anbt-sql-formatter/exception.rb
 - lib/anbt-sql-formatter/formatter.rb
 - lib/anbt-sql-formatter/helper.rb
+- lib/anbt-sql-formatter/in_values_checker.rb
 - lib/anbt-sql-formatter/parser.rb
 - lib/anbt-sql-formatter/rule.rb
 - lib/anbt-sql-formatter/token.rb
@@ -44,6 +45,7 @@ files:
 - test/test_coarse-tokenizer.rb
 - test/test_formatter.rb
 - test/test_helper.rb
+- test/test_in_values.rb
 - test/test_parser.rb
 - test/test_rule.rb
 - uninstall.rb