Merge pull request #376 from JrGoodle/plugins

Add example plugin

clowder/clowder/clowder_controller.py

@@ -12,6 +12,7 @@
 from termcolor import cprint
 
 from clowder.error.clowder_yaml_error import ClowderYAMLError
+from clowder.model.defaults import Defaults
 from clowder.model.group import Group
 from clowder.model.source import Source
 from clowder.yaml.loading import load_yaml
@@ -120,11 +121,9 @@ def get_yaml(self):
         :rtype: dict
         """
 
-        groups_yaml = [g.get_yaml() for g in self.groups]
-        sources_yaml = [s.get_yaml() for s in self.sources]
-        return {'defaults': self.defaults,
-                'sources': sources_yaml,
-                'groups': groups_yaml}
+        return {'defaults': self.defaults.get_yaml(),
+                'sources': [s.get_yaml() for s in self.sources],
+                'groups': [g.get_yaml() for g in self.groups]}
 
     def get_yaml_resolved(self):
         """Return python object representation for resolved yaml
@@ -133,20 +132,15 @@ def get_yaml_resolved(self):
         :rtype: dict
         """
 
-        groups_yaml = [g.get_yaml_resolved() for g in self.groups]
-        sources_yaml = [s.get_yaml() for s in self.sources]
-        return {'defaults': self.defaults,
-                'sources': sources_yaml,
-                'groups': groups_yaml}
+        return {'defaults': self.defaults.get_yaml(),
+                'sources': [s.get_yaml() for s in self.sources],
+                'groups': [g.get_yaml_resolved() for g in self.groups]}
 
     def _load_yaml(self):
         """Load clowder.yaml"""
         try:
             yaml = load_yaml(self.root_directory)
-            self.defaults = yaml['defaults']
-            if 'depth' not in self.defaults:
-                self.defaults['depth'] = 0
-
+            self.defaults = Defaults(yaml['defaults'])
             self.sources = [Source(s) for s in yaml['sources']]
             for group in yaml['groups']:
                 self.groups.append(Group(self.root_directory, group, self.defaults, self.sources))

clowder/clowder/clowder_repo.py

@@ -170,7 +170,7 @@ def link(self, version=None):
             yaml_file = os.path.join(self.root_directory, relative_path)
 
         if not os.path.isfile(yaml_file):
-            print(path_output + " doesn't seem to exist\n")
+            print('\n' + path_output + " doesn't seem to exist\n")
             sys.exit(1)
 
         yaml_symlink = os.path.join(self.root_directory, 'clowder.yaml')

clowder/clowder/model/defaults.py

@@ -0,0 +1,52 @@
+# -*- coding: utf-8 -*-
+"""Representation of clowder.yaml defaults
+
+.. codeauthor:: Joe Decapo <joe@polka.cat>
+
+"""
+
+
+class Defaults(object):
+    """clowder.yaml Defaults model class
+
+    :ivar str ref: Default ref
+    :ivar str remote: Default remote name
+    :ivar str source: Default source name
+    :ivar str protocol: Default git protocol
+    :ivar int depth: Default depth
+    :ivar bool recursive: Default recursive value
+    :ivar str timestamp_author: Default timestamp author
+    """
+
+    def __init__(self, defaults):
+        """Defaults __init__
+
+        :param dict defaults: Parsed YAML python object for defaults
+        """
+
+        self.ref = defaults["ref"]
+        self.protocol = defaults["protocol"]
+        self.remote = defaults["remote"]
+        self.source = defaults["source"]
+        self.depth = defaults.get("depth", 0)
+        self.recursive = defaults.get("recursive", False)
+        self.timestamp_author = defaults.get("timestamp_author", None)
+
+    def get_yaml(self):
+        """Return python object representation for saving yaml
+
+        :return: YAML python object
+        :rtype: dict
+        """
+
+        defaults = {'ref': self.ref,
+                    'recursive': self.recursive,
+                    'remote': self.remote,
+                    'source': self.source,
+                    'depth': self.depth,
+                    'protocol': self.protocol}
+
+        if self.timestamp_author:
+            defaults['timestamp_author'] = self.timestamp_author
+
+        return defaults

clowder/clowder/model/fork.py

@@ -24,7 +24,7 @@ class Fork(object):
 
     :ivar str name: Project name
     :ivar str path: Project relative path
-    :ivar Fork fork: Project's associated Fork
+    :ivar str remote_name: Git remote name
     """
 
     def __init__(self, fork, root_directory, path, source):

clowder/clowder/model/group.py

@@ -31,17 +31,17 @@ def __init__(self, root_directory, group, defaults, sources):
 
         :param str root_directory: Root directory of clowder projects
         :param dict group: Parsed YAML python object for group
-        :param dict defaults: Parsed YAML python object for defaults
+        :param Defaults defaults: Defaults instance
         :param list[Source] sources: List of Source instances
         """
 
         self.name = group['name']
-        self.depth = group.get('depth', defaults['depth'])
-        self.recursive = group.get('recursive', defaults.get('recursive', False))
-        self.timestamp_author = group.get('timestamp_author', defaults.get('timestamp_author', None))
-        self.ref = group.get('ref', defaults['ref'])
-        self.remote_name = group.get('remote', defaults['remote'])
-        source_name = group.get('source', defaults['source'])
+        self.depth = group.get('depth', defaults.depth)
+        self.recursive = group.get('recursive', defaults.recursive)
+        self.timestamp_author = group.get('timestamp_author', defaults.timestamp_author)
+        self.ref = group.get('ref', defaults.ref)
+        self.remote_name = group.get('remote', defaults.remote)
+        source_name = group.get('source', defaults.source)
 
         for source in sources:
             if source.name == source_name: