Merge pull request #454 from kazuki43zoo/gh-452

Add sample(test) using TemplateFilePathProvider

Author: kazuki43zoo

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/main/java/sample/mybatis/SampleFreeMarkerApplication.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -41,6 +41,7 @@ public SampleFreeMarkerApplication(CityMapper cityMapper) {
   @SuppressWarnings("squid:S106")
   public void run(String... args) {
     System.out.println(this.cityMapper.findByState("CA"));
+    System.out.println(this.cityMapper.findByCountry("JP"));
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/main/java/sample/mybatis/mapper/CityMapper.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import org.apache.ibatis.annotations.Mapper;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;
+import org.apache.ibatis.annotations.SelectProvider;
+import org.mybatis.scripting.freemarker.support.TemplateFilePathProvider;
 import sample.mybatis.domain.City;
 
 /**
@@ -29,9 +31,12 @@ public interface CityMapper {
   @Select("select id, name, state, country from city where id = <@p name='id'/>")
   City findById(@Param("id") Long id);
 
-  @Select("/mappers/CityMapper-findByState.ftl")
+  @Select("CityMapper-findByState.ftl")
   City findByState(@Param("state") String state);
 
   City findByName(@Param("name") String name);
 
+  @SelectProvider(TemplateFilePathProvider.class)
+  City findByCountry(@Param("country") String country);
+
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/main/resources/application.properties

@@ -1,5 +1,5 @@
 #
-#    Copyright 2015-2019 the original author or authors.
+#    Copyright 2015-2020 the original author or authors.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -19,3 +19,7 @@ logging.level.sample.mybatis.mapper=TRACE
 
 mybatis.mapper-locations=classpath*:/mappers/*.xml
 mybatis.type-aliases-package=sample.mybatis.domain
+
+mybatis.scripting-language-driver.freemarker.template-file.base-dir=mappers/
+mybatis.scripting-language-driver.freemarker.template-file.path-provider.includes-package-path=false
+mybatis.scripting-language-driver.freemarker.template-file.path-provider.separate-directory-per-mapper=false

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/main/resources/data.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2015-2019 the original author or authors.
+--    Copyright 2015-2020 the original author or authors.
 --
 --    Licensed under the Apache License, Version 2.0 (the "License");
 --    you may not use this file except in compliance with the License.
@@ -15,3 +15,4 @@
 --
 
 insert into city (name, state, country) values ('San Francisco', 'CA', 'US');
+insert into city (name, state, country) values ('Tokyo', '13', 'JP');

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/main/resources/mappers/CityMapper-findByCountry.ftl

@@ -0,0 +1,23 @@
+<#--
+
+       Copyright 2015-2020 the original author or authors.
+
+       Licensed under the Apache License, Version 2.0 (the "License");
+       you may not use this file except in compliance with the License.
+       You may obtain a copy of the License at
+
+          http://www.apache.org/licenses/LICENSE-2.0
+
+       Unless required by applicable law or agreed to in writing, software
+       distributed under the License is distributed on an "AS IS" BASIS,
+       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+       See the License for the specific language governing permissions and
+       limitations under the License.
+
+-->
+select
+  id, name, state, country
+from
+  city
+where
+  country = <@p name="country"/>

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/test/java/sample/mybatis/SampleMybatisApplicationMainTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@ void test(OutputCapture outputCapture) {
     SampleFreeMarkerApplication.main(new String[] {});
     String output = outputCapture.toString();
     assertThat(output).contains("1,San Francisco,CA,US");
+    assertThat(output).contains("2,Tokyo,13,JP");
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/test/java/sample/mybatis/SampleMybatisApplicationTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ class SampleMybatisApplicationTest {
   void test(OutputCapture outputCapture) {
     String output = outputCapture.toString();
     assertThat(output).contains("1,San Francisco,CA,US");
+    assertThat(output).contains("2,Tokyo,13,JP");
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-freemarker/src/test/java/sample/mybatis/mapper/CityMapperTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -61,4 +61,13 @@ void findByName() {
     assertThat(city.getCountry()).isEqualTo("US");
   }
 
+  @Test
+  void findByCountry() {
+    City city = cityMapper.findByCountry("JP");
+    assertThat(city.getId()).isEqualTo(2);
+    assertThat(city.getName()).isEqualTo("Tokyo");
+    assertThat(city.getState()).isEqualTo("13");
+    assertThat(city.getCountry()).isEqualTo("JP");
+  }
+
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/main/java/sample/mybatis/SampleThymeleafApplication.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -41,6 +41,7 @@ public SampleThymeleafApplication(CityMapper cityMapper) {
   @SuppressWarnings("squid:S106")
   public void run(String... args) {
     System.out.println(this.cityMapper.findByState("CA"));
+    System.out.println(this.cityMapper.findByCountry("JP"));
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/main/java/sample/mybatis/mapper/CityMapper.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -18,6 +18,8 @@
 import org.apache.ibatis.annotations.Mapper;
 import org.apache.ibatis.annotations.Param;
 import org.apache.ibatis.annotations.Select;
+import org.apache.ibatis.annotations.SelectProvider;
+import org.mybatis.scripting.thymeleaf.support.TemplateFilePathProvider;
 import sample.mybatis.domain.City;
 
 /**
@@ -29,9 +31,12 @@ public interface CityMapper {
   @Select("select id, name, state, country from city where id = /*[# mb:p='id']*/ 1 /*[/]*/")
   City findById(@Param("id") Long id);
 
-  @Select("/mappers/CityMapper-findByState.sql")
+  @Select("CityMapper-findByState.sql")
   City findByState(@Param("state") String state);
 
   City findByName(@Param("name") String name);
 
+  @SelectProvider(TemplateFilePathProvider.class)
+  City findByCountry(@Param("country") String country);
+
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/main/resources/application.properties

@@ -1,5 +1,5 @@
 #
-#    Copyright 2015-2019 the original author or authors.
+#    Copyright 2015-2020 the original author or authors.
 #
 #    Licensed under the Apache License, Version 2.0 (the "License");
 #    you may not use this file except in compliance with the License.
@@ -19,3 +19,7 @@ logging.level.sample.mybatis.mapper=TRACE
 
 mybatis.mapper-locations=classpath*:/mappers/*.xml
 mybatis.type-aliases-package=sample.mybatis.domain
+
+mybatis.scripting-language-driver.thymeleaf.template-file.base-dir=mappers/
+mybatis.scripting-language-driver.thymeleaf.template-file.path-provider.includes-package-path=false
+mybatis.scripting-language-driver.thymeleaf.template-file.path-provider.separate-directory-per-mapper=false

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/main/resources/data.sql

@@ -1,5 +1,5 @@
 --
---    Copyright 2015-2019 the original author or authors.
+--    Copyright 2015-2020 the original author or authors.
 --
 --    Licensed under the Apache License, Version 2.0 (the "License");
 --    you may not use this file except in compliance with the License.
@@ -15,3 +15,4 @@
 --
 
 insert into city (name, state, country) values ('San Francisco', 'CA', 'US');
+insert into city (name, state, country) values ('Tokyo', '13', 'JP');

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/main/resources/mappers/CityMapper-findByCountry.sql

@@ -0,0 +1,22 @@
+--
+--    Copyright 2015-2020 the original author or authors.
+--
+--    Licensed under the Apache License, Version 2.0 (the "License");
+--    you may not use this file except in compliance with the License.
+--    You may obtain a copy of the License at
+--
+--       http://www.apache.org/licenses/LICENSE-2.0
+--
+--    Unless required by applicable law or agreed to in writing, software
+--    distributed under the License is distributed on an "AS IS" BASIS,
+--    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+--    See the License for the specific language governing permissions and
+--    limitations under the License.
+--
+
+select
+  id, name, state, country
+from
+  city
+where
+  country = /*[# mb:p="country"]*/ 'US' /*[/]*/

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/test/java/sample/mybatis/SampleMybatisApplicationMainTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -32,6 +32,7 @@ void test(OutputCapture outputCapture) {
     SampleThymeleafApplication.main(new String[] {});
     String output = outputCapture.toString();
     assertThat(output).contains("1,San Francisco,CA,US");
+    assertThat(output).contains("2,Tokyo,13,JP");
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/test/java/sample/mybatis/SampleMybatisApplicationTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -34,6 +34,7 @@ class SampleMybatisApplicationTest {
   void test(OutputCapture outputCapture) {
     String output = outputCapture.toString();
     assertThat(output).contains("1,San Francisco,CA,US");
+    assertThat(output).contains("2,Tokyo,13,JP");
   }
 
 }

mybatis-spring-boot-samples/mybatis-spring-boot-sample-thymeleaf/src/test/java/sample/mybatis/mapper/CityMapperTest.java

@@ -1,5 +1,5 @@
 /**
- *    Copyright 2015-2019 the original author or authors.
+ *    Copyright 2015-2020 the original author or authors.
  *
  *    Licensed under the Apache License, Version 2.0 (the "License");
  *    you may not use this file except in compliance with the License.
@@ -61,4 +61,13 @@ void findByName() {
     assertThat(city.getCountry()).isEqualTo("US");
   }
 
+  @Test
+  void findByCountry() {
+    City city = cityMapper.findByCountry("JP");
+    assertThat(city.getId()).isEqualTo(2);
+    assertThat(city.getName()).isEqualTo("Tokyo");
+    assertThat(city.getState()).isEqualTo("13");
+    assertThat(city.getCountry()).isEqualTo("JP");
+  }
+
 }