Package name project settings refactor (#13)

* Added initialize documentation

* Package prefix and name are now one property in settings

* Example project value change

* Changed example extension in README

Author: johnttompkins

.coveragerc

@@ -2,4 +2,4 @@
 branch = True
 
 [report]
-fail_under = 62
+fail_under = 65

README.rst

@@ -25,7 +25,6 @@ the Python Package Index (PyPI). It requires Python 3.
 
     pip3 install uluru-cli
 
-
 Command: project-settings
 ^^^^^^^^^^^^^^^^^^^^^^^^^
 
@@ -38,6 +37,20 @@ To output the default project settings for a given language, use the
         --language java \
         --output project.yaml
 
+Command: initialize
+^^^^^^^^^^^^^^^^^^^
+
+To create project files such as build files and autocomplete for your specific language and IDE,
+use the ``initialize`` command. An output directory an be set with the optional ``output-directory`` argument
+(Defaults to the current directory). You can customize certain, language-specific project settings, otherwise the
+default settings are used.
+
+.. code-block:: bash
+
+    uluru-cli initialize \
+        --language java \
+        --project-settings examples/java_project.yaml
+
 Command: generate
 ^^^^^^^^^^^^^^^^^
 
@@ -50,7 +63,8 @@ are used.
     uluru-cli generate \
         examples/aws-kinesis-stream.yaml \
         --language java \
-        --project-settings examples/java_project.json
+        --project-settings examples/java_project.yaml \
+        --output-directory projects/resource-provider/
 
 Plugin system
 -------------

examples/java_project.yaml

@@ -1,5 +1,5 @@
 # User-provided project settings override the default project settings
-packageNamePrefix: org.my.package
+packageName: com.example.ResourceProviderExample
 Client:
   Client: com.amazonaws.services.kinesis.AmazonKinesis
   Builder: com.amazonaws.services.kinesis.AmazonKinesisClientBuilder

uluru/filters.py

@@ -153,3 +153,26 @@ def modified_from_action_type(action_type):
     if action_type == "write":
         return "true"
     return "false"
+
+
+@register_filter
+def package_prefix(full_package_name):
+    """Returns the package prefix from the package name specified.
+
+    :exc:`ValueError` is raised if the package name format is invalid.
+
+    >>> package_prefix('com.example.test')
+    'com.example'
+    >>> package_prefix('example.test')
+    'example'
+    >>> package_prefix('com.example.this.isa.test')
+    'com.example.this.isa'
+    >>> package_prefix('exampletest')
+    Traceback (most recent call last):
+    ...
+    ValueError: Package name 'exampletest' is invalid
+    """
+    package_segments = full_package_name.rpartition(".")
+    if package_segments[0]:
+        return package_segments[0]
+    raise ValueError("Package name '{}' is invalid".format(full_package_name))

uluru/languages/java/codegen.py

@@ -33,14 +33,16 @@ def generate(self, resource_def, project_settings):
         output_directory = Path(project_settings["output_directory"]).resolve(
             strict=True
         )
-        package_name_prefix = project_settings["packageNamePrefix"]
+        project_settings["packageNamePrefix"] = self.env.filters["package_prefix"](
+            project_settings["packageName"]
+        )
 
         project_settings.setdefault("Client", {})
         java_client_keys = ["Client", "Builder", "ResourceModel"]
         for key in java_client_keys:
             project_settings["Client"].setdefault(key, key.upper())
 
-        project_directory = package_name_prefix.split(".")
+        project_directory = project_settings["packageNamePrefix"].split(".")
 
         source_directory = output_directory.joinpath("src", *project_directory)
         test_directory = output_directory.joinpath("tst", *project_directory)

uluru/languages/java/data/project_defaults.yaml

@@ -1,4 +1,3 @@
 # User-provided project settings are merged with the default project settings
 # and override the defaults.
-packageName: ResourceProviderExample
-packageNamePrefix: com.example
+packageName: com.example.ResourceProviderExample

uluru/languages/java/data/project_schema.json

@@ -4,13 +4,9 @@
   "description": "Uluru project settings schema for Java codegen projects",
   "type": "object",
   "properties": {
-    "packageNamePrefix": {
-      "type": "string",
-      "pattern": "([a-z0-9._]{3,128})"
-    },
     "packageName": {
       "type": "string",
-      "pattern": "([a-z0-9_]{3,128})"
+      "pattern": "(([a-z0-9]+)\\.)+[a-z0-9]+"
     },
     "Client": {
       "type": "object",

uluru/languages/java/templates/maven/pom.xml

@@ -4,8 +4,8 @@
          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
     <modelVersion>4.0.0</modelVersion>
 
-    <groupId>{{ packageNamePrefix }}</groupId>
-    <artifactId>{{ packageName }}</artifactId>
+    <groupId>{{ packageName | package_prefix}}</groupId>
+    <artifactId>{{ packageName | java_class_name }}</artifactId>
     <version>1.0</version>
     <dependencies>
         <dependency>

uluru/languages/java/tests/test_java.py

@@ -42,9 +42,9 @@ def test_initialize_maven(plugin, project_settings):
     pom_tree = ET.parse(str(project_settings["output_directory"] / "pom.xml"))
     ns = {"maven": "http://maven.apache.org/POM/4.0.0"}
     package_name_prefix = pom_tree.find("maven:groupId", ns)
-    assert package_name_prefix.text == project_settings["packageNamePrefix"]
+    assert package_name_prefix.text == "com.example"
     package_name = pom_tree.find("maven:artifactId", ns)
-    assert package_name.text == project_settings["packageName"]
+    assert package_name.text == "ResourceProviderExample"
 
 
 def test_initialize_intellij(plugin, project_settings):