Add PR to the default templates (kyuridenamida#117)

kmyk · kyuridenamida · commit d694ff1a3d7e · 2019-03-06T02:01:08.000+09:00
* kyuridenamida#113 Add PR to the default templates * Fix the sentence of PR based on the review comment kyuridenamida#117 (comment)
diff --git a/atcodertools/codegen/template_engine.py b/atcodertools/codegen/template_engine.py
@@ -4,6 +4,8 @@
 
 from jinja2 import Environment
 
+from atcodertools.release_management.version import __version__
+
 
 def _substitute(s, reps):
     # http://stackoverflow.com/questions/36739667/python-templates-for-generating-python-code-with-proper-multiline-indentation
@@ -25,6 +27,13 @@ def _substitute(s, reps):
 
 
 def render(template, **kwargs):
+    # TODO: refactoring: this should not be here.
+    # TODO: refactoring: the URL should be imported from other module
+    kwargs['atcodertools'] = {
+        'version': __version__,
+        'url': 'https://github.com/kyuridenamida/atcoder-tools',
+    }
+
     if "${" in template:
         # If the template is old, render with the old engine.
         # This logic is for backward compatibility
diff --git a/atcodertools/tools/templates/default_template.cpp b/atcodertools/tools/templates/default_template.cpp
@@ -17,6 +17,7 @@ void solve({{ formal_arguments }}){
 }
 {% endif %}
 
+// Generated by {{ atcodertools.version }} {{ atcodertools.url }}  (tips: You use the default template now. You can remove this line by using your custom template)
 int main(){
     {% if prediction_success %}
     {{input_part}}
@@ -25,4 +26,4 @@ int main(){
     // Failed to predict input format
     {% endif %}
     return 0;
-}
+}
diff --git a/atcodertools/tools/templates/default_template.java b/atcodertools/tools/templates/default_template.java
@@ -12,6 +12,7 @@ class Main {
     static final String NO = "{{ no_str }}";
     {% endif %}
 
+    // Generated by {{ atcodertools.version }} {{ atcodertools.url }}  (tips: You use the default template now. You can remove this line by using your custom template)
     public static void main(String[] args) throws Exception {
         final Scanner sc = new Scanner(System.in);
         {% if prediction_success %}
diff --git a/atcodertools/tools/templates/default_template.py b/atcodertools/tools/templates/default_template.py
@@ -19,6 +19,7 @@ def solve({{ formal_arguments }}):
 
 {% endif %}
 
+# Generated by {{ atcodertools.version }} {{ atcodertools.url }}  (tips: You use the default template now. You can remove this line by using your custom template)
 def main():
     {% if prediction_success %}
     def iterate_tokens():
diff --git a/atcodertools/tools/templates/default_template.rs b/atcodertools/tools/templates/default_template.rs
@@ -16,6 +16,7 @@ fn solve({{ formal_arguments }}) {
 }
 {% endif %}
 
+// Generated by {{ atcodertools.version }} {{ atcodertools.url }}  (tips: You use the default template now. You can remove this line by using your custom template)
 fn main() {
     {% if prediction_success %}
     {{input_part}}
diff --git a/tests/resources/test_codegen/test_default_code_generators_and_templates/cpp/expected_default_generated_code.cpp b/tests/resources/test_codegen/test_default_code_generators_and_templates/cpp/expected_default_generated_code.cpp
@@ -9,6 +9,7 @@ void solve(long long N, long long M, std::vector<std::vector<std::string>> H, st
 
 }
 
+// Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools  (tips: You use the default template now. You can remove this line by using your custom template)
 int main(){
     long long N;
     scanf("%lld",&N);
diff --git a/tests/resources/test_codegen/test_default_code_generators_and_templates/java/expected_default_generated_code.java b/tests/resources/test_codegen/test_default_code_generators_and_templates/java/expected_default_generated_code.java
@@ -6,6 +6,7 @@ class Main {
     static final String YES = "yes";
     static final String NO = "NO";
 
+    // Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools  (tips: You use the default template now. You can remove this line by using your custom template)
     public static void main(String[] args) throws Exception {
         final Scanner sc = new Scanner(System.in);
         long N;
diff --git a/tests/resources/test_codegen/test_default_code_generators_and_templates/python/expected_default_generated_code.py b/tests/resources/test_codegen/test_default_code_generators_and_templates/python/expected_default_generated_code.py
@@ -9,6 +9,7 @@ def solve(N: int, M: int, H: "List[List[str]]", A: "List[int]", B: "List[float]"
     return
 
 
+# Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools  (tips: You use the default template now. You can remove this line by using your custom template)
 def main():
     def iterate_tokens():
         for line in sys.stdin:
diff --git a/tests/resources/test_codegen/test_default_code_generators_and_templates/rust/expected_default_generated_code.rs b/tests/resources/test_codegen/test_default_code_generators_and_templates/rust/expected_default_generated_code.rs
@@ -8,6 +8,7 @@ fn solve(N: i64, M: i64, H: Vec<Vec<String>>, A: Vec<i64>, B: Vec<f64>, Q: i64,
 
 }
 
+// Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools  (tips: You use the default template now. You can remove this line by using your custom template)
 fn main() {
     let con = read_string();
     let mut scanner = Scanner::new(&con);

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ fn solve({{ formal_arguments }}) {`
`16`	`16`	`}`
`17`	`17`	`{% endif %}`
`18`	`18`
	`19`	`+// Generated by {{ atcodertools.version }} {{ atcodertools.url }} (tips: You use the default template now. You can remove this line by using your custom template)`
`19`	`20`	`fn main() {`
`20`	`21`	`{% if prediction_success %}`
`21`	`22`	`{{input_part}}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ void solve(long long N, long long M, std::vector<std::vector<std::string>> H, st`
`9`	`9`
`10`	`10`	`}`
`11`	`11`
	`12`	`+// Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools (tips: You use the default template now. You can remove this line by using your custom template)`
`12`	`13`	`int main(){`
`13`	`14`	`long long N;`
`14`	`15`	`scanf("%lld",&N);`
Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@ fn solve(N: i64, M: i64, H: Vec<Vec<String>>, A: Vec<i64>, B: Vec<f64>, Q: i64,`
`8`	`8`
`9`	`9`	`}`
`10`	`10`
	`11`	`+// Generated by 1.1.2 https://github.com/kyuridenamida/atcoder-tools (tips: You use the default template now. You can remove this line by using your custom template)`
`11`	`12`	`fn main() {`
`12`	`13`	`let con = read_string();`
`13`	`14`	`let mut scanner = Scanner::new(&con);`