Cleanup

- Add sourcefile extractor
- Repair ability to include multiple representations
- Round up, shape up, and get ready for tests on virtual machines.

.gitignore

@@ -2,5 +2,5 @@
 dist
 cover
 .coverage
-user
+stage
 shared

pyblish_starter/api.py

@@ -34,7 +34,7 @@
 )
 
 from .lib import (
-    format_user_dir,
+    format_staging_dir,
     format_shared_dir,
     format_version,
 
@@ -57,7 +57,7 @@
 
     "deregister_plugins",
 
-    "format_user_dir",
+    "format_staging_dir",
     "format_shared_dir",
     "format_version",
 

pyblish_starter/lib.py

@@ -33,8 +33,8 @@ def format_shared_dir(root):
     return os.path.join(root, "shared")
 
 
-def format_user_dir(root, name):
-    dirname = os.path.join(root, "user", time(), name)
+def format_staging_dir(root, name):
+    dirname = os.path.join(root, "stage", time(), name)
     return dirname
 
 

pyblish_starter/maya/lib.py

@@ -1,49 +1,6 @@
 from maya import cmds, mel
 
 
-def hierarchy_from_string(hierarchy):
-    parents = {}
-
-    for line in hierarchy.split("\n"):
-        if not line:
-            continue
-
-        name = line.strip()
-        padding = len(line[:-len(name)])
-        parents[padding] = name
-
-        name = cmds.createNode("transform", name=name)
-
-        for parent in sorted(parents):
-            if parent < padding:
-                cmds.parent(name, parents[parent])
-                break
-
-    # Return assembly
-    return parents[0]
-
-
-def outmesh(shape, name=None):
-    """Construct a new shape with a connection to source.inMesh
-
-    Arguments:
-        shape (str): Long name of source shape
-        name (str, optional): Default "outMesh1"
-
-    Returns:
-        transform of new shape
-
-    """
-
-    outmesh = cmds.createNode("mesh")
-    cmds.connectAttr(shape + ".outMesh", outmesh + ".inMesh")
-    outmesh = cmds.listRelatives(outmesh, parent=True)[0]
-    outmesh = cmds.rename(outmesh, name or "outMesh1")
-    cmds.sets(outmesh, addElement="initialShadingGroup")
-
-    return outmesh
-
-
 def export_alembic(nodes, file, frame_range=None, uv_write=True):
     """Wrap native MEL command with limited set of arguments
 

pyblish_starter/maya/pipeline.py

@@ -5,7 +5,7 @@
 from .. import pipeline
 from ..vendor.Qt import QtWidgets, QtGui, QtCore
 
-from maya import cmds, mel
+from maya import cmds
 
 from . import lib
 
@@ -113,7 +113,8 @@ def load(asset, version=-1):
     try:
         representation = next(
             rep for rep in version["representations"]
-            if rep["format"] in supported_formats
+            if rep["format"] in supported_formats and
+            rep["path"] != "{dirname}/source{format}"
         )
 
     except StopIteration:
@@ -168,8 +169,6 @@ def create(name, family):
 
     assert item is not None, "{0} is not a valid family".format(family)
 
-    print("%s + %s" % (pipeline.registered_data(), item.get("data", [])))
-
     data = pipeline.registered_data() + item.get("data", [])
 
     # Convert to dictionary
@@ -193,12 +192,8 @@ def create(name, family):
             raise KeyError("Invalid dynamic property: %s" % e)
 
     lib.imprint(instance, data)
-
     cmds.select(instance, noExpand=True)
 
-    # Display instance attributes to user
-    # mel.eval("updateEditorToggleCheckboxes; copyAEWindow;")
-
     return instance
 
 
@@ -223,6 +218,7 @@ def containerise(name, nodes, version):
         ("author", version["author"]),
         ("loader", self.__name__),
         ("time", version["time"]),
+        ("version", version["version"]),
         ("source", version["source"]),
         ("comment", version.get("comment", ""))
     ]

pyblish_starter/plugins/extract_animation.py

@@ -26,7 +26,7 @@ def process(self, instance):
         cmds.loadPlugin("AbcExport.mll", quiet=True)
 
         self.log.info("Extracting animation..")
-        dirname = api.format_user_dir(
+        dirname = api.format_staging_dir(
             root=instance.context.data["workspaceDir"],
             name=instance.data["name"])
 
@@ -46,9 +46,10 @@ def process(self, instance):
         )
 
         # Store reference for integration
-        instance.data.update({
-            "userDir": dirname,
-            "filename": filename,
-        })
+        if "files" not in instance.data:
+            instance.data["files"] = list()
+
+        instance.data["files"].append(filename)
+        instance.data["stagingDir"] = dirname
 
         self.log.info("Extracted {instance} to {dirname}".format(**locals()))

pyblish_starter/plugins/extract_model.py

@@ -21,7 +21,7 @@ def process(self, instance):
         from pyblish_starter import api
         from pyblish_maya import maintained_selection
 
-        dirname = api.format_user_dir(
+        dirname = api.format_staging_dir(
             root=instance.context.data["workspaceDir"],
             name=instance.data["name"])
 
@@ -50,9 +50,10 @@ def process(self, instance):
                       constructionHistory=False)
 
         # Store reference for integration
-        instance.data.update({
-            "userDir": dirname,
-            "filename": filename,
-        })
+        if "files" not in instance.data:
+            instance.data["files"] = list()
+
+        instance.data["files"].append(filename)
+        instance.data["stagingDir"] = dirname
 
         self.log.info("Extracted {instance} to {path}".format(**locals()))

pyblish_starter/plugins/extract_rig.py

@@ -21,7 +21,7 @@ def process(self, instance):
         from pyblish_starter import api
         from pyblish_maya import maintained_selection
 
-        dirname = api.format_user_dir(
+        dirname = api.format_staging_dir(
             root=instance.context.data["workspaceDir"],
             name=instance.data["name"])
 
@@ -46,9 +46,10 @@ def process(self, instance):
                       constructionHistory=True)
 
         # Store reference for integration
-        instance.data.update({
-            "userDir": dirname,
-            "filename": filename,
-        })
+        if "files" not in instance.data:
+            instance.data["files"] = list()
+
+        instance.data["files"].append(filename)
+        instance.data["stagingDir"] = dirname
 
         self.log.info("Extracted {instance} to {path}".format(**locals()))

pyblish_starter/plugins/extract_source.py

@@ -0,0 +1,50 @@
+import pyblish.api
+
+
+class ExtractStarterSource(pyblish.api.InstancePlugin):
+    """Extract copy of working file at time of publish"""
+
+    label = "Starter Source"
+    order = pyblish.api.ExtractorOrder
+    hosts = ["maya"]
+    families = [
+        "starter.model",
+        "starter.rig",
+        "starter.animation",
+    ]
+
+    def process(self, instance):
+        import os
+        from maya import cmds
+        from pyblish_starter import api
+
+        dirname = api.format_staging_dir(
+            root=instance.context.data["workspaceDir"],
+            name=instance.data["name"])
+
+        try:
+            os.makedirs(dirname)
+        except OSError:
+            pass
+
+        filename = "source.ma"
+
+        path = os.path.join(dirname, filename)
+
+        # Perform extraction
+        self.log.info("Performing extraction..")
+        cmds.file(path,
+                  force=True,
+                  typ="mayaAscii",
+                  exportAll=True,
+                  preserveReferences=False,
+                  constructionHistory=True)
+
+        # Store reference for integration
+        if "files" not in instance.data:
+            instance.data["files"] = list()
+
+        instance.data["files"].append(filename)
+        instance.data["stagingDir"] = dirname
+
+        self.log.info("Extracted {instance} to {path}".format(**locals()))

pyblish_starter/plugins/integrate_asset.py

@@ -62,10 +62,10 @@ def process(self, instance):
         #       ^
         #       |
         #
-        userdir = instance.data.get("userDir")
-        assert userdir, (
+        stagingdir = instance.data.get("stagingDir")
+        assert stagingdir, (
             "Incomplete instance \"%s\": "
-            "Missing reference to user directory."
+            "Missing reference to staging area."
             % instance
         )
 
@@ -91,11 +91,12 @@ def process(self, instance):
         # |         |
         # |_________|
         #
-        fname = os.path.join(userdir, ".metadata.json")
+        fname = os.path.join(stagingdir, ".metadata.json")
 
         try:
             with open(fname) as f:
                 metadata = json.load(f)
+
         except IOError:
             metadata = {
                 "schema": "pyblish-starter:version-1.0",
@@ -108,21 +109,24 @@ def process(self, instance):
                 "author": context.data["user"],
 
                 # Collected by pyblish-maya
-                "source": os.path.relpath(
-                    context.data["currentFile"],
-                    api.root()
+                "source": os.path.join(
+                    "{root}",
+                    os.path.relpath(
+                        context.data["currentFile"],
+                        api.root()
+                    )
                 ),
             }
 
-        filename = instance.data["filename"]
-        name, ext = os.path.splitext(filename)
-        metadata["representations"].append(
-            {
-                "schema": "pyblish-starter:representation-1.0",
-                "format": ext,
-                "path": "{dirname}/%s{format}" % name
-            }
-        )
+        for filename in instance.data.get("files", list()):
+            name, ext = os.path.splitext(filename)
+            metadata["representations"].append(
+                {
+                    "schema": "pyblish-starter:representation-1.0",
+                    "format": ext,
+                    "path": "{dirname}/%s{format}" % name
+                }
+            )
 
         # Write to disk
         #          _
@@ -141,7 +145,7 @@ def process(self, instance):
         # this way, if validation fails, the data can be
         # inspected by hand from within the user directory.
         api.schema.validate(metadata, "version")
-        shutil.copytree(userdir, versiondir)
+        shutil.copytree(stagingdir, versiondir)
 
         self.log.info("Successfully integrated \"%s\" to \"%s\"" % (
             instance, versiondir))

pyblish_starter/tools/loader/app.py

@@ -1,5 +1,4 @@
 import sys
-import contextlib
 
 from ...vendor.Qt import QtWidgets, QtCore
 from ... import api