first commit

LICENSE

@@ -0,0 +1,201 @@
+                                 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.

README.md

@@ -0,0 +1,111 @@
+# Rubik
+Rubik工具链是一套解决Android平台组件化的综合方案，提供gradle project之间的路由通讯能力，以及对gradle project的组件定义、版本控制、maven发布、aar/jar与源码之间的切换以及组件的自由组合等能力。
+
+Rubik工具链由两部分组成：
+* Rubik Router ：即Rubik的函数级路由能力，与一般的页面路由不同，Rubik Router允许把Uri及参数，导航到工程内部，任意的一个公开的JVM语言（Java/Kotlin）函数的执行上，以便于更灵活的进行gradle project之间不基于代码调用的通讯。
+* Rubik 工具链 ：提供组件上下文的定义、版本控制、maven发布、aar/jar与源码之间的切换等能力，包括4个gradle plugin:
+    + rubik-config：
+        -contexts.gradle提全局组件定义
+    + rubik-context：
+        - 提供task，生成中间代码，并把中间代码打包成context.jar ,按版本号发布到maven
+        - 提供task，把业务代码按flavor、版本号编译成aar (包括代码、资源、内置SDK)发布到maven
+        - 通过contexts.gradle中的定义，为组件所在子工程自动添加其他context-lib的依赖
+    + rubik-root：
+        - 给壳工程提供pick context能力，根据flavor、版本号筛选要打包进apk的业务组件
+        - 提供组件的源码工程和aar切换的能力
+    + rubik-test:
+        - 给壳工程提供单元测试环境
+
+## 快速开始
+1.创建一个用于组装组件的android app gradle project，作为"壳工程"（如测试代码中的root_app）
+2.创建一个或多个作为组件的android lib gradle project，作为"组件工程"(如测试代码中的component_a、component_b)
+3.为最外层工程添加rubik-config插件，并增加组件配置信息：
+```
+rubik {
+	component { // 第一个组件
+	    uri "app://com.component-a"  // 组件的Uri
+	    dependencies {    // 组件需要依赖的其他组件
+            uri ("baidu://component-b" ) { 
+                    version "0.1.1"  // 依赖其他组件的版本信息
+            }
+            uri( … ) 
+	    }
+	    source {    // 定义默认来源，如不需切换源码和aar，可以只声明project或maven
+            project (":component_a") 
+        }
+    }
+	context { … }  //第二个组件
+} 
+```
+4.在一个组件工程内定义一个路由路径，作为组件暴露给其他组件的接口：
+    * 通过RRoute注解声明函数路由
+```
+@RRoute(path = "user") 
+fun getUser(id : Int, name : String) : User? { 
+    …
+}
+```
+5.在另一个组件工程内调用其他组件的路由接口：
+   * 通过Kotlin DSL：
+```
+navigate {
+	uri = "app://business.account/user"
+	query {
+	        "id" with 400
+	        "name" with "cuizhe01" 
+	}
+    result<User?> { user -> 
+    // 通过泛型指定接收数据类型，多次异步返回时，可以用多个result接收
+        …
+    }
+} 
+```
+
+   * 通过自动生成的镜像函数：
+```
+UserContext.user(400, "cuizhe01" ) { user ->
+    …
+}
+```
+6.在壳工程中使用添加rubik-root插件，并在build.gradle中指定壳工程最终要将哪些组件，以哪种方式打包到最终的编译产物之中：
+```
+rubik {	
+    packing {
+        projectMode { // projectMode，通过工程打包组件的源码
+            uri ("app://business.account/user")
+            uri ("app://business.account/file")
+        }
+        mavenMode { // mavenMode，通过maven打包组件的aar
+            uri ("app://business.account/download") {
+                version "0.2.0" 
+            }
+        }
+    }
+} 
+```
+## 测试
+* rubik-test插件，给当前工程的androidTest variant添加全部可pick组件的context.jar依赖，便于写测试用例。
+```
+@RunWith(AndroidJUnit4::class)
+class RouterTestCase {
+    @Before
+    fun init() {
+        Rubik.init()
+    } // 初始化Rubik
+    @Test
+    fun usePerview() {
+        PerviewContext.preViewVideo(path : String) { success ->
+                log("preViewVideo success:${success}")
+        } // 测试用例
+    }
+ … // 继续写测试用例
+ }
+
+```
+
+## 如何贡献
+请用Kotlin语言编写，所有注明动机的合理改动提交都会被接收。
+
+
+## 讨论
+百度如流讨论群：5425804

build.gradle

@@ -0,0 +1,64 @@
+// Top-level build file where you can add configuration options common to all sub-projects/modules.
+apply plugin: 'rubik'
+
+buildscript {
+    ext {
+        rubik_tmp_lib_dir = uri('./rubik_libs_repository').path
+//        rubik_tmp_lib_dir_mode = false  // default: false
+
+        rubik_maven_repository = "http://xxxxxx/repository/releases/"
+        rubik_maven_username = "xxx"
+        rubik_maven_password = "xxx"
+        rubik_maven_local_repository = uri('./rubik_maven_local_repository').path
+
+        rubik_use_reset_compiler = true // default: false
+
+//        rubik_publish_context_lib_source = true // default: true
+
+//        rubik_kapt_version = "com.rubik:kapt:xxx"   //  @see version.gradle in this demo
+//        rubik_router_version = "com.rubik:router:xxx"   //  @see version.gradle in this demo
+//        rubik_plugins_version = "com.rubik:plugins:xxx"   //  @see version.gradle in this demo
+
+//        rubik_kapt_source_folder = "generated/source/kaptKotlin"
+
+//        rubik_clean_before_task = false  // default: true
+
+//        rubik_auto_generate_aggregate = true   // default: false
+
+//        rubik_extension_name = "rk"
+
+//        rubik_auto_apply_root_plugin = false   // default: true
+
+        rubik_auto_apply_test_plugin = true    // default: false
+
+        rubik_config_file_dirs = [uri('./demo').path]
+
+//        modules_snapshot_enable = true   // default: false
+        modules_snapshot_maven_default_group_id = "com.mars.module.demo"
+//        modules_snapshot_local_mode = false   // default: true
+//        modules_snapshot_local_no_maven_mode = true   // default: false
+
+    }
+
+    apply from: 'versions.gradle'
+
+    addRepos(repositories)
+
+    dependencies {
+        classpath "com.android.tools.build:gradle:$agbt_version"
+        classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
+
+        classpath rubik_plugins_version
+        classpath deps.ktnail.plugins
+    }
+}
+
+allprojects {
+    addRepos(repositories)
+}
+
+task clean(type: Delete) {
+    delete rootProject.buildDir
+}
+
+apply from: 'version-tasks.gradle'