diff --git a/dbFunctionInvoker-plugin/LICENSE b/dbFunctionInvoker-plugin/LICENSE new file mode 100644 index 0000000..57bc88a --- /dev/null +++ b/dbFunctionInvoker-plugin/LICENSE @@ -0,0 +1,202 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + 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. + diff --git a/dbFunctionInvoker-plugin/NOTICE b/dbFunctionInvoker-plugin/NOTICE new file mode 100644 index 0000000..d184f50 --- /dev/null +++ b/dbFunctionInvoker-plugin/NOTICE @@ -0,0 +1,6 @@ +This product includes software developed by the MyBatis team +The MyBatis data mapper framework (http://blog.mybatis.org/) + +This product includes software developed by the MyBatis generator team +MyBatis Generator (MBG) code generator for MyBatis and iBATIS (http://mybatis.github.io/generator/). + diff --git a/dbFunctionInvoker-plugin/README b/dbFunctionInvoker-plugin/README new file mode 100644 index 0000000..9a65f18 --- /dev/null +++ b/dbFunctionInvoker-plugin/README @@ -0,0 +1,191 @@ +Copyright 2014 Mahiar Mody. + +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. + + + + +Created by: Mahiar Mody + +This is the ReadMe file for the MyBatis Generator Database Function Invoker Plugin + +Contents: + +1. THE DATABASE FUNCTION INVOKER PLUGIN JAR FILE NAME AND LOCATION IN THE BINARY DISTRIBUTION ARCHIVE +2. DEPENDENCIES +3. PLUGIN USAGE +4. STRUCTURE OF THE DATABASE FUNCTION INVOKER PLUGIN PROJECT +5. TO BUILD AND TEST THE DATABASE FUNCTION INVOKER PLUGIN FROM SOURCE + + + +1. THE DATABASE FUNCTION INVOKER PLUGIN JAR FILE NAME AND LOCATION IN THE BINARY DISTRIBUTION ARCHIVE +====================================================================================================== +DbFunctionInvoker-1.0.0.jar is the only file needed to add Db Function Invocation +support to the MyBatis Generator Tool (JAR file). Extract it from the lib directory in the +mbg-plugin-DbFunctionInvoker-1.0.0-binary.zip or mbg-plugin-DbFunctionInvoker-1.0.0-binary.tar.gz, +add it to the classpath of your project, along with the MyBatis Generator's JAR file. + + + +2. DEPENDENCIES +================ +There are no dependencies beyond the JRE and the MyBatis Generator Tool (JAR file) itself. +JRE 6.0 or above is required to use this plugin. + +To build and test this plugin from source, in addition to the above-mentioned dependencies, +the HSQLDB dependency is required to create the test case database and test case tables. +Furthermore, this plugin is developed using Maven and consequently Maven also needs to be +installed on your computer. + + + + + +3. PLUGIN USAGE +================ +Please refer to the plugin's Java Doc API for a detailed description on how to +use this plugin. The Java Doc API can be found in the docs directory of the +mbg-plugin-DbFunctionInvoker-1.0.0-binary.zip and +mbg-plugin-DbFunctionInvoker-1.0.0-binary.tar.gz, archives. + +For convenience the above-mentioned javadocs are also compressed into a jar archive +named DbFunctionInvoker-1.0.0-javadoc.jar that is located in the lib dirctory of the +mbg-plugin-DbFunctionInvoker-1.0.0-binary.zip and +mbg-plugin-DbFunctionInvoker-1.0.0-binary.tar.gz, archives. + +To use this plugin, add the DbFunctionInvoker-1.0.0.jar to the classpath of your project, +along with the MyBatis Generator's JAR file, in order to add database function invocations +to the generated SQL Mapper XML files. The DbFunctionInvoker-1.0.0.jar file is located +in the lib directory of the mbg-plugin-DbFunctionInvoker-1.0.0-binary.zip and +mbg-plugin-DbFunctionInvoker-1.0.0-binary.tar.gz, archives. + + + + + + +4. STRUCTURE OF THE DATABASE FUNCTION INVOKER PLUGIN PROJECT +============================================================= + +Project install directory +--------------------------- +The entire project is rooted at (installed in) the directory named dbFunctionInvoker-plugin. + + +The Project submodules +------------------------ +This project is divided into two submodules named dbFunctionInvoker and dbFunctionInvokerTests. + +The dbFunctionInvoker submodule contains the database function invoker plugin source code, the +database function invoker plugin documentation (in the source code itself as JavaDoc comments), +and the maven assembly descriptor files (in the assembly directory) required to created +the final plugin binary and source distributions. + +The dbFunctionInvokerTests submodule contains the database function invoker plugin JUnit test +case source code, along with the corresponding test resources. +The SQL Mapper XML files that are to be tested for the presense of database function invocations +by the JUnit test cases cannot exist in this submodule, because these SQL Mapper files are only +dynamically generated when the MyBatis Generator is run, based upon the underlying database +table structures. + + + + + + +5. TO BUILD AND TEST THE DATABASE FUNCTION INVOKER PLUGIN FROM SOURCE +====================================================================== + +The Database Function Invoker Plugin is developed using Maven. Hence, to build this plugin from +source you'll need to have Maven installed on your computer. + +Copy the dbFunctionInvoker-plugin directory recursively to any directory of your choice. +Next, move into the dbFunctionInvoker-plugin directory just copied and give the command: + +mvn clean install + +That's it. + + +How this plugin build works +---------------------------- + +A. +The submodule dbFunctionInvoker is the first to be built. + +B. +The dbFunctionInvoker submodule build includes compiling all the Database Function Invoker plugin +source files, compiled for jdk version 1.6, followed by the creation of the Database Function Invoker +plugin JAR file, and the Java Docs for this plugin. During the "package" phase, the Database Function +Invoker plugin source and binary distribution archives are created. +During the final "install" phase the Database Function Invoker plugin JAR file is copied to the +local maven repository usually named: ".m2". + +C. +The submodule dbFunctionInvokerTests is built next. The following steps pertain to the building +of the dbFunctionInvokerTests submodule. + +D. +First, when the "generate-sources" phase of the Maven default lifecycle, is invoked +for the dbFunctionInvokerTests submodule, the HSQLDB is started in server mode as an +in-memory database, in the background. HSQLDB is used as the database for testing this plugin. + +E. +Next, in the "generate-sources" phase, after the HSQLDB is started, the Database Function Invoker +plugin test tables are created and filled with data. The SQL script responsible for creating and +filling the test tables is located in: +dbFunctionInvokerTests/src/main/resources/sqlScript/SetupDbTestScripts.sql + +F. +Next, in the "generate-sources" phase, the MyBatis Generator is invoked to generated the MyBatis +Artifacts (Java model class, Java client classes, and SQL Mapper XML files) by introspecting the +test table structure created in the previous step. These auto-generated SQL Mapper XML files +are to be tested for the presense of database function invocations. To the Maven MyBatis Generator plugin, +the other dbFunctionInvoker submodule is specified as a dependency, so that the MyBatis Generator plugin +knows how to inject the auto-generated SQL Mapper XML files with database function invocations. +The XML configuration file required the MyBatis Generator to introspect the tables is located at: +dbFunctionInvokerTests/src/main/resources/mbgConfig/MyBatisGeneratorConfig.xml +MyBatis Generator creates the artifacts at location: +dbFunctionInvokerTests/target/generated-sources/mybatis-generator + +G. +Next, when the "compile" phase is invoked, the MyBatis Generator generated artifacts +are compiled using jdk 1.6. + +H. +Next, when the "test-compile" phase is invoked, the JUnit test cases developed for testing +this plugin are compiled using jdk 1.6. + +I. +Next, when the "test" phase is invoked, the compiled JUnit test cases are run against +the SQL Mapper XML files to test for the presense or absense of +the appropriate database function invocations. Running of the JUnit tests involves +using MyBatis hence the MyBatis dependency is needed here (not the MyBatis Generator +dependency). To run, MyBatis requires an XML configuration file. This configuration +file is located at: +dbFunctionInvokerTests/src/test/resources/mybatis-config.xml + +J. +Next, in the "test" phase, after the JUnit tests are run, the HSQLDB server is +gracefully shutdown. + +K. +Next, when the "package" phase is invoked, the JUnit tests are packaged in a JAR +archive. The JUnit test JAR is of no importance and hence is to be ignored. + +L. +Finally, when the "install" phase is invoked, all the JAR files are copied to +the local repository generally named ".m2". + + diff --git a/dbFunctionInvoker-plugin/dbFunctionInvokerTests/pom.xml b/dbFunctionInvoker-plugin/dbFunctionInvokerTests/pom.xml index 5894bb8..a700eb0 100644 --- a/dbFunctionInvoker-plugin/dbFunctionInvokerTests/pom.xml +++ b/dbFunctionInvoker-plugin/dbFunctionInvokerTests/pom.xml @@ -80,7 +80,7 @@ a project dependency. --> ${project.groupId} - dbFunctionInvoker + DbFunctionInvoker ${project.version} @@ -267,7 +267,7 @@ ${project.groupId} - dbFunctionInvoker + DbFunctionInvoker ${project.version} runtime