Optimized the options and implemented the reserved_case option (#6)

* 予約語のみ大文字に変換するオプションを追加。
▽変更内容
　・README（英語、日本語）
　・プログラム本体（init.py, api.py, config.py, filters.py）
　・Sublime向け対応としてPreferences.sublime-settingsを改修

* オプション構成の最適化を実施。

* コード修正に伴い、Readmeも修正。

* Readmeを修正。

* sublimeプラグイン実行時に不具合があったので修正。

* Change the default settings of the reserved words option to ANSI SQL(SQL:2011).

* Added the 'nochange' option.

* Updated the readme files based on the functional update which I made before.

* Deleted the blank line.

* Changed the default setting of the "uf_case". The default will be "upper"

* Added a code to manage backward compatibility.

* - fixed the problem with the execution timing of backward compatible code
- fixed the problem that the `uf_reserved_words` setting refers only to the user setting

* update readme

Author: Shun7

Preferences.sublime-settings

@@ -1,7 +1,12 @@
 {
     "uf_tab_size": 4,
     "uf_translate_tabs_to_spaces": true,
-    "uf_uppercase": true,
+    "uf_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    // You have to set [uf_case]option, 
+    // when you set [uf_reserved_case]option below.
+    // The applocation does not accept the reserved_case option individually.
+    "uf_reserved_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    "uf_reserved_words":"ABS,ALL,ALLOCATE,ALTER,AND,ANY,ARE,ARRAY,ARRAY_AGG,ARRAY_MAX_CARDINALITY,AS,ASENSITIVE,ASYMMETRIC,AT,ATOMIC,AUTHORIZATION,AVG,BEGIN,BEGIN_FRAME,BEGIN_PARTITION,BETWEEN,BIGINT,BINARY,BLOB,BOOLEAN,BOTH,BY,CALL,CALLED,CARDINALITY,CASCADED,CASE,CAST,CEIL,CEILING,CHAR,CHARACTER,CHARACTER_LENGTH,CHAR_LENGTH,CHECK,CLOB,CLOSE,COALESCE,COLLATE,COLLECT,COLUMN,COMMIT,CONDITION,CONNECT,CONSTRAINT,CONTAINS,CONVERT,CORR,CORRESPONDING,COUNT,COVAR_POP,COVAR_SAMP,CREATE,CROSS,CUBE,CUME_DIST,CURRENT,CURRENT_CATALOG,CURRENT_DATE,CURRENT_DEFAULT_TRANSFORM_GROUP,CURRENT_PATH,CURRENT_ROLE,CURRENT_ROW,CURRENT_SCHEMA,CURRENT_TIME,CURRENT_TIMESTAMP,CURRENT_TRANSFORM_GROUP_FOR_TYPE,CURRENT_USER,CURSOR,CYCLE,DATALINK,DATE,DAY,DEALLOCATE,DEC,DECIMAL,DECLARE,DEFAULT,DELETE,DENSE_RANK,DEREF,DESCRIBE,DETERMINISTIC,DISCONNECT,DISTINCT,DLNEWCOPY,DLPREVIOUSCOPY,DLURLCOMPLETE,DLURLCOMPLETEONLY,DLURLCOMPLETEWRITE,DLURLPATH,DLURLPATHONLY,DLURLPATHWRITE,DLURLSCHEME,DLURLSERVER,DLVALUE,DOUBLE,DROP,DYNAMIC,EACH,ELEMENT,ELSE,END,END-EXEC,END_FRAME,END_PARTITION,EQUALS,ESCAPE,EVERY,EXCEPT,EXEC,EXECUTE,EXISTS,EXP,EXTERNAL,EXTRACT,FALSE,FETCH,FILTER,FIRST_VALUE,FLOAT,FLOOR,FOR,FOREIGN,FRAME_ROW,FREE,FROM,FULL,FUNCTION,FUSION,GET,GLOBAL,GRANT,GROUP,GROUPING,GROUPS,HAVING,HOLD,HOUR,IDENTITY,IMPORT,IN,INDICATOR,INNER,INOUT,INSENSITIVE,INSERT,INT,INTEGER,INTERSECT,INTERSECTION,INTERVAL,INTO,IS,JOIN,LAG,LANGUAGE,LARGE,LAST_VALUE,LATERAL,LEAD,LEADING,LEFT,LIKE,LIKE_REGEX,LN,LOCAL,LOCALTIME,LOCALTIMESTAMP,LOWER,MATCH,MAX,MEMBER,MERGE,METHOD,MIN,MINUTE,MOD,MODIFIES,MODULE,MONTH,MULTISET,NATIONAL,NATURAL,NCHAR,NCLOB,NEW,NO,NONE,NORMALIZE,NOT,NTH_VALUE,NTILE,NULL,NULLIF,NUMERIC,OCCURRENCES_REGEX,OCTET_LENGTH,OF,OFFSET,OLD,ON,ONLY,OPEN,OR,ORDER,OUT,OUTER,OVER,OVERLAPS,OVERLAY,PARAMETER,PARTITION,PERCENT,PERCENTILE_CONT,PERCENTILE_DISC,PERCENT_RANK,PERIOD,PORTION,POSITION,POSITION_REGEX,POWER,PRECEDES,PRECISION,PREPARE,PRIMARY,PROCEDURE,RANGE,RANK,READS,REAL,RECURSIVE,REF,REFERENCES,REFERENCING,REGR_AVGX,REGR_AVGY,REGR_COUNT,REGR_INTERCEPT,REGR_R2,REGR_SLOPE,REGR_SXX,REGR_SXY,REGR_SYY,RELEASE,RESULT,RETURN,RETURNS,REVOKE,RIGHT,ROLLBACK,ROLLUP,ROW,ROWS,ROW_NUMBER,SAVEPOINT,SCOPE,SCROLL,SEARCH,SECOND,SELECT,SENSITIVE,SESSION_USER,SET,SIMILAR,SMALLINT,SOME,SPECIFIC,SPECIFICTYPE,SQL,SQLEXCEPTION,SQLSTATE,SQLWARNING,SQRT,START,STATIC,STDDEV_POP,STDDEV_SAMP,SUBMULTISET,SUBSTRING,SUBSTRING_REGEX,SUCCEEDS,SUM,SYMMETRIC,SYSTEM,SYSTEM_TIME,SYSTEM_USER,TABLE,TABLESAMPLE,THEN,TIME,TIMESTAMP,TIMEZONE_HOUR,TIMEZONE_MINUTE,TO,TRAILING,TRANSLATE,TRANSLATE_REGEX,TRANSLATION,TREAT,TRIGGER,TRIM,TRIM_ARRAY,TRUE,TRUNCATE,UESCAPE,UNION,UNIQUE,UNKNOWN,UNNEST,UPDATE,UPPER,USER,USING,VALUE,VALUES,VALUE_OF,VARBINARY,VARCHAR,VARYING,VAR_POP,VAR_SAMP,VERSIONING,WHEN,WHENEVER,WHERE,WIDTH_BUCKET,WINDOW,WITH,WITHIN,WITHOUT,XML,XMLAGG,XMLATTRIBUTES,XMLBINARY,XMLCAST,XMLCOMMENT,XMLCONCAT,XMLDOCUMENT,XMLELEMENT,XMLEXISTS,XMLFOREST,XMLITERATE,XMLNAMESPACES,XMLPARSE,XMLPI,XMLQUERY,XMLSERIALIZE,XMLTABLE,XMLTEXT,XMLVALIDATE,YEAR",
     "uf_comment_syntax": "uroboroSQL", // "uroboroSQL" or "doma2"
     "uf_escapesequence_u005c": false,
     "uf_save_on_format": false,

Readme.ja.md

@@ -1,7 +1,9 @@
-uroboroSQL Formatter
+Sublime uroboroSQL Formatter
 ====================
 
-uroboroSQL Formatterは、エンタープライズシステムで用いられることの多い、  
+[![Package Control](https://img.shields.io/packagecontrol/dt/uroboroSQL%20Formatter.svg)](https://packagecontrol.io/packages/uroboroSQL%20Formatter)
+
+Sublime uroboroSQL Formatterは、エンタープライズシステムで用いられることの多い、  
 非常に長いSQL(1K step以上)でも見やすく保守性の高いスタイルへフォーマットするための  
 Sublime Text 3のプラグインです。
 
@@ -25,7 +27,7 @@ WHERE 1 = 1
   AND MI.ARRIVAL_DATE = '2016-12-01' -- 入荷日
 ```
 
-#### uroboroSQL Formatterの場合
+#### Sublime uroboroSQL Formatterの場合
 
 ```sql
 SELECT
@@ -62,7 +64,9 @@ Settings
 {
     "uf_tab_size": 4,
     "uf_translate_tabs_to_spaces": true,
-    "uf_uppercase": true,
+    "uf_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    "uf_reserved_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    "uf_reserved_words":"SELECT, FROM, WHERE, CREATE" // Put commas to separate reserved words
     "uf_comment_syntax": "uroboroSQL", // "uroboroSQL" or "doma2"
     "uf_escapesequence_u005c": false,
     "uf_save_on_format": true,
@@ -74,18 +78,22 @@ Settings
 	-	フォーマット後のインデントのタブサイズを指定します。4つを推奨します。
 -	uf_translate_tabs_to_spaces
 	-	フォーマット後のインデントをタブにするかスペースにするかを指定します。trueにすることでスペースになります。
-- uf_uppercase
-  - 予約語と識別子を大文字に変換する場合はtrueを指定します。
-- uf_comment_syntax
-  - コメントのシンタックス形式を指定します。
-  - 「uroboroSQL」または「doma2」の指定が可能です。
-    - 通常のSQLの場合は、どちらを指定してもかまいません。
-- uf_escapesequence_u005c
-  - SQL内でエスケープシーケンスをバックスラッシュで指定している場合にtrueを指定します。
-- uf_save_on_format
-  - ファイル保存時に自動的にフォーマットする場合にtrueを指定します。
-- uf_save_on_format_extensions
-  - フォーマットするファイルの拡張子をリストで指定します。
+-	uf_case
+	-	全ての文字（予約語と識別子等全て）を指定のケース（大文字、小文字、文頭大文字、変換しない）に変換する時に使用する。
+-	uf_reserved_case
+	-	予約語を指定のケース（大文字、小文字、文頭大文字）に変換する時に使用する。なお、"nochange"オプションを指定した場合は予約語に限ったケース変換はせず、全てのケースを「uf_case」に従って変換する。
+-	uf_reserved_words
+	-	予約語のみをケース変換したい場合は、「uf_reserved_case」に指定のケース（upper, lower, capitalize or nochange）を設定するとともに、当項目に予約語のリストをカンマ区切りで指定します。
+-	uf_comment_syntax
+	-	コメントのシンタックス形式を指定します。
+	-	「uroboroSQL」または「doma2」の指定が可能です。
+		-	通常のSQLの場合は、どちらを指定してもかまいません。
+-	uf_escapesequence_u005c
+	-	SQL内でエスケープシーケンスをバックスラッシュで指定している場合にtrueを指定します。
+-	uf_save_on_format
+	-	ファイル保存時に自動的にフォーマットする場合にtrueを指定します。
+-	uf_save_on_format_extensions
+	-	フォーマットするファイルの拡張子をリストで指定します。
 
 
 License
@@ -95,4 +103,4 @@ License
 
 ---
 
-Copyright 2017 by Future Architect.
+Copyright 2018 by Future Architect.

Readme.md

@@ -1,7 +1,9 @@
-uroboroSQL Formatter
+Sublime uroboroSQL Formatter
 ====================
 
-UroboroSQL Formatter is often used in enterprise systems, For formatting to a highly maintainable style even for very long SQL (1 K step or more) It is a plug-in of Sublime Text 3.
+[![Package Control](https://img.shields.io/packagecontrol/dt/uroboroSQL%20Formatter.svg)](https://packagecontrol.io/packages/uroboroSQL%20Formatter)
+
+Sublime uroboroSQL Formatter is often used in enterprise systems, For formatting to a highly maintainable style even for very long SQL (1 K step or more) It is a plug-in of Sublime Text 3.
 
 In particular, in countries where English is not their mother tongue, such as Japan, comments may be included in SELECT clauses. In that case, we will align the vertical position of the AS clause and the comment, pursuing the viewability which can be said as artistic anymore, This was developed to realize this automatically.
 
@@ -10,32 +12,32 @@ for Japanese, [Readme.ja.md](Readme.ja.md)
 #### In case of general formatter
 
 ```sql
-SELECT MI.MAKER_CD AS ITEM_MAKER_CD -- メーカーコード
+SELECT MI.MAKER_CD AS ITEM_MAKER_CD -- maker code
 ,
-       MI.BRAND_CD AS ITEM_BRAND_CD -- ブランドコード
+       MI.BRAND_CD AS ITEM_BRAND_CD -- brand code
 ,
-       MI.ITEM_CD AS ITEM_CD -- 商品コード
+       MI.ITEM_CD AS ITEM_CD -- item code
 ,
-       MI.CATEGORY AS ITEM_CATEGORY -- 商品カテゴリ
-FROM M_ITEM MI -- 商品マスタ
+       MI.CATEGORY AS ITEM_CATEGORY -- item category
+FROM M_ITEM MI -- item master
 
 WHERE 1 = 1
-  AND MI.ARRIVAL_DATE = '2016-12-01' -- 入荷日
+  AND MI.ARRIVAL_DATE = '2016-12-01' -- arrival date
 ```
 
-#### In case of uroboroSQL Formatter
+#### In case of Sublime uroboroSQL Formatter
 
 ```sql
 SELECT
-    MI.MAKER_CD AS  ITEM_MAKER_CD   -- メーカーコード
-,   MI.BRAND_CD AS  ITEM_BRAND_CD   -- ブランドコード
-,   MI.ITEM_CD  AS  ITEM_CD         -- 商品コード
-,   MI.CATEGORY AS  ITEM_CATEGORY   -- 商品カテゴリ
+    MI.MAKER_CD AS  ITEM_MAKER_CD   -- maker code
+,   MI.BRAND_CD AS  ITEM_BRAND_CD   -- brand code
+,   MI.ITEM_CD  AS  ITEM_CD         -- item code
+,   MI.CATEGORY AS  ITEM_CATEGORY   -- item category
 FROM
-    M_ITEM  MI  -- 商品マスタ
+    M_ITEM  MI  -- item master
 WHERE
     1               =   1
-AND MI.ARRIVAL_DATE =   '2016-12-01'    -- 入荷日
+AND MI.ARRIVAL_DATE =   '2016-12-01'    -- arrival date
 
 ```
 
@@ -60,7 +62,9 @@ Settings
 {
     "uf_tab_size": 4,
     "uf_translate_tabs_to_spaces": true,
-    "uf_uppercase": true,
+    "uf_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    "uf_reserved_case": "upper", // "upper" or "lower" or "capitalize" or "nochange"
+    "uf_reserved_words":"SELECT, FROM, WHERE, CREATE" // Put commas to separate reserved words
     "uf_comment_syntax": "uroboroSQL", // "uroboroSQL" or "doma2"
     "uf_escapesequence_u005c": false,
     "uf_save_on_format": true,
@@ -72,18 +76,22 @@ Settings
 	-	Specify the tab size of the indent after formatting. We recommend 4.
 -	uf_translate_tabs_to_spaces
 	-	Specify whether the indent after formatting is tab or space. It becomes a space by setting it to true.
-- uf_uppercase
-  - If you want to convert a reserved word and identifier to uppercase specifies true.
-- uf_comment_syntax
-  - It specifies the comment syntax format.
-  - You can specify the "uroboroSQL" or "doma2".
-    - In the case of normal SQL, you can specify either.
-- uf_escapesequence_u005c
-  - If you have specified the escape sequence with a backslash in the SQL to specify the true.
-- uf_save_on_format
-  - Specify true when formatting automatically when saving files.
-- uf_save_on_format_extensions
-  - Specify the extension of the file to be formatted in a list.
+-	uf_case
+	-	If you want to convert all words to a specific case, set "upper", "lower", "capitalize". If the "nochange" option is selected, the word cases will not be changed from the original.
+-	uf_reserved_case
+	-	If you want to convert reserved words to a specific case, set "upper", "lower" or "capitalize". If the "nochange" option is selected, it will not change the cases of resered words and they will be changed based on the "uf_case" setting.
+-	uf_reserved_words
+	-	If you want to convert only reserved words to a specific case, please input reserved words sepalated by a comma. (The input is not case sensitive. So you can input reserved words in any case.)
+-	uf_comment_syntax
+	-	It specifies the comment syntax format.
+	-	You can specify the "uroboroSQL" or "doma2".
+		-	In the case of normal SQL, you can specify either.
+-	uf_escapesequence_u005c
+	-	If you have specified the escape sequence with a backslash in the SQL to specify the true.
+-	uf_save_on_format
+	-	Specify true when formatting automatically when saving files.
+-	uf_save_on_format_extensions
+	-	Specify the extension of the file to be formatted in a list.
 
 License
 -------
@@ -92,4 +100,4 @@ License
 
 ---
 
-Copyright 2017 by Future Architect.
+Copyright 2018 by Future Architect.

uroborosqlfmt/__init__.py

@@ -77,9 +77,12 @@ def format_sql(sql, local_config = config.LocalConfig()):
     stack = sqlparse.engine.FilterStack()
     stack.enable_grouping()
 
-    if local_config.uppercase:
-        stack.preprocess.append(sqlparse.filters.KeywordCaseFilter())
-        stack.preprocess.append(sqlparse.filters.IdentifierCaseFilter())
+    if local_config.case != None:
+        stack.preprocess.append(sqlparse.filters.KeywordCaseFilter(local_config.case))
+        stack.preprocess.append(sqlparse.filters.IdentifierCaseFilter(local_config.case))
+
+    if local_config.reserved_case != None:
+        stack.preprocess.append(filters.ReservedWordCaseFilter(local_config))
 
     stack.stmtprocess.append(filters.GroupFilter())
     stack.stmtprocess.append(filters.LineDescriptionLineCommentFilter(local_config))

uroborosqlfmt/api.py

@@ -141,10 +141,17 @@ def _parse_args(test_args=None):
         choices=['file', 'directory'], \
         help='format target. default "file"', \
         )
-
-    parser.add_argument('-N', '--nochange_case', \
-        action='store_true', \
-        help='UPPERCASE off.', \
+    parser.add_argument('-a', '--case', \
+        action='store', \
+        default=None, \
+        type=str, \
+        choices=['upper', 'lower', 'capitalize'], \
+        )
+    parser.add_argument('-e', '--reserved_case', \
+        action='store', \
+        default=None, \
+        type=str, \
+        choices=['upper', 'lower', 'capitalize'], \
         )
     parser.add_argument('-B', '--escapesequence_u005c', \
         action='store_true', \
@@ -157,6 +164,12 @@ def _parse_args(test_args=None):
         choices=['uroborosql', 'doma2', 'uroboro', 'doma'], \
         help='SQL comment out syntax type.', \
         )
+    parser.add_argument('-r', '--reserved_words_file_path', \
+        action='store', \
+        default=None, \
+        type=str, \
+        help='input reserved words file path.', \
+        )
 
     return parser.parse_args(test_args)
 
@@ -171,16 +184,20 @@ def __execute():
     args = _parse_args()
 
     mode = args.mode
-    nochange_case = args.nochange_case
+    case = args.case
+    reserved_case = args.reserved_case
     escapesequence_u005c = args.escapesequence_u005c
     comment_syntax = args.comment_syntax
     input_path = args.input_path
     output_path = args.output_path
+    reserved_words_file_path = args.reserved_words_file_path
     local_config = LocalConfig()
 
-    set_uppercase(local_config, not nochange_case)
+    set_case(local_config, case)
+    set_reserved_case(local_config, reserved_case)
     set_escapesequence_u005c(escapesequence_u005c)
     set_comment_syntax(local_config, comment_syntax)
+    set_reserved_words(local_config, reserved_words_file_path)
 
     """
     The application requires either "file" or "directory"
@@ -199,8 +216,18 @@ def __execute():
     print("=====           End          =====")
 
 
-def set_uppercase(local_config, uppercase):
-    local_config.set_uppercase(uppercase)
+def set_case(local_config, case):
+    local_config.set_case(case)
+
+
+def set_reserved_case(local_config, reserved_case):
+    if local_config.case == None and local_config.reserved_case != None:
+        print ("You have to set [case(-a)]option, "\
+               "when you set [reserved_case(-e)]option.\n" \
+               "The applocation does not accept the reserved_case option individually.")
+        sys.exit("Application quitting...")
+    else:
+        local_config.set_reserved_case(reserved_case)
 
 
 def set_escapesequence_u005c(escapesequence_u005c):
@@ -215,5 +242,28 @@ def set_comment_syntax(local_config, comment_syntax):
     else:
         sys.exit()
 
+
+def set_reserved_words(local_config, reserved_words_file):
+    if reserved_words_file is not None:
+        try:
+            f = open(reserved_words_file, 'r')
+            lines = f.readlines()
+            f.close()
+        except IOError:
+            print("File I/O error: %s" % reserved_words_file)
+            print("Please check the file path.")
+            sys.exit("Application quitting...")
+        except:
+            print ("Unexpected error:", sys.exc_info()[0])
+            sys.exit("Application quitting...")
+        else:
+            reserved_words = []
+
+            for line in lines:
+                reserved_words.append(line.rstrip('\n').lower())  # Eliminate newline code.
+
+            local_config.set_input_reserved_words(reserved_words)
+
+
 if __name__ == "__main__":
     __execute()

uroborosqlfmt/config.py

@@ -16,18 +16,28 @@ def set_escape_sequence_u005c(self, escape_sequence):
 
 class LocalConfig(object):
 
-    __slots__ = ('comment_syntax', 'uppercase')
+    __slots__ = ('comment_syntax', 'case', 'reserved_case','input_reserved_words')
 
     def __init__(self):
         self.comment_syntax = UroboroSqlCommentSyntax()
-        self.uppercase = True
+        self.case = None
+        self.reserved_case = None
+        self.input_reserved_words = None
 
     def set_commentsyntax(self, comment_syntax):
         self.comment_syntax = comment_syntax
         return self
 
-    def set_uppercase(self, uppercase):
-        self.uppercase = uppercase
+    def set_case(self, case):
+        self.case = case
+        return self
+
+    def set_reserved_case(self, reserved_case):
+        self.reserved_case = reserved_case
+        return self
+
+    def set_input_reserved_words(self, input_reserved_words):
+        self.input_reserved_words = input_reserved_words
         return self