anbt-sql-formatter 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 06d3d110d976d89ae531994e7a2e504028deb41c7e0576ad977445dd12a40e97
-  data.tar.gz: 07754a3a2b3169853345b4ead8f2290f0b4279bd913359b637c2e2d87994cb80
+  metadata.gz: 0bd065b8b98fe3a87257b39677bd7ed0fc78233173c0a1f1e99792cec2e9868f
+  data.tar.gz: 999857541e0547429abb974f830fbba8ff0c31ae2284b89bfd840353e3029786
 SHA512:
-  metadata.gz: 760fa7076565da7636d4dd0659a7ac7f6651e61e50860b7b61cb1fdeac45a0d7836a0c3a3b832bc32b4eb8bcd939eff2e37135b0508822f028f72c4a5753ecd6
-  data.tar.gz: 3deda4f2457c216382e8c64d9343af513e60d762af57ab39f047a3b282756833ea7542b45d309375fa34f17ef4a5421ac57aee08c1c7439c94d6dcefed7c03cc
+  metadata.gz: fc5d07dc5eb05cc96c250e865bf36f2ae7b8e11457b3850d112b75925a00ccb93f498b1fc389288de875d77292b7139464227f35fa7db56fb602498ffe07e623
+  data.tar.gz: 276dc243eeaeab0ee353017e1f7d1bbcf6ec3e11e8b295f5a93331d4b5786f68a6725abe1ca89c81f72a53da821f318aeebde04ed2aa9eb205cfb497f256debe

data/.gitignore

@@ -5,3 +5,6 @@ pkg/*
 
 # Emacs
 *~
+
+# Bundler
+/vendor/bundle/

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+# 0.1.1 (2025-01-12)
+
+No breaking changes.
+
+## Improvements
+
+- Avoid mutative string manipulation (coarse-tokenizer.rb: tokenize)
+  - Prevents frozen literal warnings in Ruby 3.4 (Issue #17)
+- Update comments (PR #14)
+- Some small fixes, cleanups, formatting improvements
+
+
 # 0.1.0 (2018-12-16)
 
 ## Breaking changes

data/anbt-sql-formatter.gemspec

@@ -21,4 +21,6 @@ Gem::Specification.new do |s|
   # specify any dependencies here; for example:
   # s.add_development_dependency "rspec"
   # s.add_runtime_dependency "rest-client"
+
+  s.add_development_dependency "test-unit", "~> 3.6.2"
 end

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

@@ -38,8 +38,7 @@ These are exclusive:
 =end
 
   def tokenize(str)
-    @str = str
-    @str.gsub!("\r\n", "\n")
+    @str = str.gsub("\r\n", "\n")
     out_of_quote_single   = true
     out_of_quote_double   = true
     out_of_comment_single = true
@@ -51,36 +50,36 @@ These are exclusive:
 
     while @str.size > 0
 
-      if /\A(")/ =~ str && out_of_quote_double &&
+      if /\A(")/ =~ @str && out_of_quote_double &&
           out_of_quote_single && out_of_comment_single && out_of_comment_multi
         ## begin double quote
 
         length = $1.size
         shift_token(length, :plain, :quote_double, :start)
         out_of_quote_double = false
-        
-      elsif /\A(")/ =~ str && !(out_of_quote_double) &&
+
+      elsif /\A(")/ =~ @str && !(out_of_quote_double) &&
           out_of_quote_single && out_of_comment_single && out_of_comment_multi
         ## end double quote
-         
+
         length = $1.size
-        if /\A(".")/ =~ str ## schema.table
+        if /\A(".")/ =~ @str ## schema.table
           shift_to_buf(3)
-        elsif /\A("")/ =~ str ## escaped double quote
+        elsif /\A("")/ =~ @str ## escaped double quote
           shift_to_buf(2)
         else
           shift_token(length, :quote_double, :plain, :end)
           out_of_quote_double = true
         end
 
-      elsif /\A(')/ =~ str && out_of_quote_single &&
+      elsif /\A(')/ =~ @str && out_of_quote_single &&
           out_of_quote_double && out_of_comment_single && out_of_comment_multi
         ## begin single quote
-        
+
         length = $1.size
         shift_token(length, :plain, :quote_single, :start)
         out_of_quote_single = false
-      elsif /\A(')/ =~ str && !(out_of_quote_single) &&
+      elsif /\A(')/ =~ @str && !(out_of_quote_single) &&
           out_of_quote_double && out_of_comment_single && out_of_comment_multi
         ## end single quote
 
@@ -88,49 +87,49 @@ These are exclusive:
         if /\A('')/ =~ @str ## escaped single quote
           shift_to_buf(2)
         else
-        shift_token(length, :quote_single, :plain, :end)
+          shift_token(length, :quote_single, :plain, :end)
           out_of_quote_single = true
         end
-        
-      elsif /\A(#{@comment_single_start})/ =~ str && out_of_comment_single &&
+
+      elsif /\A(#{@comment_single_start})/ =~ @str && out_of_comment_single &&
          out_of_quote_single && out_of_quote_double && out_of_comment_multi
         ## begin single line comment
-        
+
         length = $1.size
         shift_token(length, :plain, :comment_single, :start)
         out_of_comment_single = false
 
-      elsif /\A(\n)/ =~ str && !(out_of_comment_single) &&
+      elsif /\A(\n)/ =~ @str && !(out_of_comment_single) &&
           out_of_quote_single && out_of_quote_double && out_of_comment_multi
         ## end single line comment
-       
+
         length = $1.size
         shift_token(length, :comment_single, :plain, :end)
         out_of_comment_single = true
 
-      elsif /\A(#{@comment_multi_start})/ =~ str &&
+      elsif /\A(#{@comment_multi_start})/ =~ @str &&
           out_of_quote_single && out_of_quote_double && out_of_comment_single && out_of_comment_multi
         ## begin multi line comment
-        
+
         length = $1.size
         shift_token(length, :plain, :comment_multi, :start)
         out_of_comment_multi = false
 
-      elsif /\A(#{@comment_multi_end})/ =~ str &&
+      elsif /\A(#{@comment_multi_end})/ =~ @str &&
           out_of_quote_single && out_of_quote_double && out_of_comment_single && !(out_of_comment_multi)
         ## end multi line comment
-        
+
         length = $1.size
         shift_token(length, :comment_multi, :plain, :end)
         out_of_comment_multi = true
 
-      elsif /\A\\/ =~ str
+      elsif /\A\\/ =~ @str
         ## escape char
         shift_to_buf(2)
 
       else
         shift_to_buf(1)
-        
+
       end
     end
     @result << CoarseToken.new(@mode, @buf+@str) if (@buf+@str).size > 0
@@ -140,11 +139,11 @@ These are exclusive:
 
 
   def shift_to_buf(n)
-    @buf << @str[0...n]
-    @str[0...n] = ""
+    @buf += @str[0...n]
+    @str = @str[n..]
   end
-  
-  
+
+
   def shift_token(length, type, mode, flag)
     case flag
     when :start
@@ -157,7 +156,7 @@ These are exclusive:
       raise "must not happen"
     end
 
-    @str[0..(length-1)] = ""
+    @str = @str[length..]
     @mode = mode
   end
 end

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

@@ -6,7 +6,7 @@ AnbtSqlFormatter: SQL整形ツール. SQL文を決められたルールに従い
 フォーマットを実施するためには、入力されるSQLがSQL文として妥当であることが前提条件となります。
 
 このクラスが準拠するSQL整形のルールについては、下記URLを参照ください。
-http://homepage2.nifty.com/igat/igapyon/diary/2005/ig050613.html
+https://www.igapyon.jp/igapyon/diary/2005/ig050613.html
 
 このクラスには ANSI SQLの予約語一覧が蓄えられます。
 

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

@@ -98,7 +98,7 @@ class AnbtSql
           is_next_char_space = false
           if @pos + 1 < @before.size &&
             space?(char_at(@before, @pos+1))
-              is_next_char_space = true
+            is_next_char_space = true
           end
 
           if not is_next_char_space

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

@@ -8,7 +8,7 @@ AnbtSqlFormatter: SQL整形ツール. SQL文を決められたルールに従い
 フォーマットを実施するためには、入力されるSQLがSQL文として妥当であることが前提条件となります。
 
 このクラスが準拠するSQL整形のルールについては、下記URLを参照ください。
-http://homepage2.nifty.com/igat/igapyon/diary/2005/ig050613.html
+https://www.igapyon.jp/igapyon/diary/2005/ig050613.html
 
 このクラスは SQLの変換規則を表します。
 

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

@@ -48,9 +48,9 @@ class AnbtSql
 
     #
     # このバリューオブジェクトの文字列表現を取得する。
-    # 
+    #
     # オブジェクトのシャロー範囲でしか to_s されない点に注意。
-    # 
+    #
     # @return:: バリューオブジェクトの文字列表現。
     #
     def to_s

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

@@ -1,7 +1,7 @@
 module Anbt
   module Sql
     module Formatter
-      VERSION = "0.1.0"
+      VERSION = "0.1.1"
     end
   end
 end

data/misc/anbt-sql-formatter-customize-example

@@ -8,7 +8,7 @@ require "anbt-sql-formatter/formatter"
 =begin
 rule のプロパティを修正するだけではなく
 さらに踏み込んでカスタマイズしたい場合は
-formatter.rb 内の AnbtSql::Formatter#format_list_main_loop 
+formatter.rb 内の AnbtSql::Formatter#format_list_main_loop
 などをオーバーライドすると良いでしょう。
 
 Ruby に詳しくない場合は「Ruby オープンクラス」
@@ -39,7 +39,7 @@ if $0 == __FILE__
 
   # キーワードを大文字・小文字に変換しない
   rule.keyword = AnbtSql::Rule::KEYWORD_NONE
-  
+
   # 複数単語のキーワードを登録
   rule.kw_multi_words << "INNER JOIN"
   rule.kw_nl_x << "INNER JOIN"
@@ -50,7 +50,7 @@ if $0 == __FILE__
   rule.kw_nl_x << "WHEN"
 
   # User defined additional functions:
-  # ユーザ定義関数の追加: 
+  # ユーザ定義関数の追加:
   %w(count sum substr date).each{|func_name|
     rule.function_names << func_name.upcase
   }
@@ -58,7 +58,7 @@ if $0 == __FILE__
   #rule.indent_string = "    "
   #rule.indent_string = "('-')"
   rule.indent_string = "|   "
-  
+
   formatter = AnbtSql::Formatter.new(rule)
   result = formatter.format(src)
   print result

data/test/test_coarse-tokenizer.rb

@@ -21,7 +21,7 @@ class TestCoarseTokenizer < Test::Unit::TestCase
     }.join("\n")
   end
 
-  
+
   def test_shift_to_buf
     @tok.buf = ""
     @tok.str = "abcdefg"
@@ -52,14 +52,14 @@ class TestCoarseTokenizer < Test::Unit::TestCase
     @tok.result = []
     @tok.buf = "'ABC"
     @tok.str = "'def"
-    
+
     @tok.shift_token(1, :comment, :plain, :end)
     assert_equals( msg,  :comment, @tok.result.last._type)
     assert_equals( msg,  "'ABC'", @tok.result.last.string)
     assert_equals( msg,  "", @tok.buf)
     assert_equals( msg,  "def", @tok.str)
   end
-  
+
 
   def test_tokenize_1
     assert_equals(
@@ -327,7 +327,7 @@ class TestCoarseTokenizer < Test::Unit::TestCase
       )))
     )
   end
-  
+
 
   def test_comment_in_string_1
     assert_equals(
@@ -392,7 +392,7 @@ class TestCoarseTokenizer < Test::Unit::TestCase
       )))
     )
   end
-  
+
 
   def test_string_escape_1
     assert_equals(