Add a "--clone" option to "stg branch"
[stgit] / stgit / stack.py
index cd7677b..8b7c296 100644 (file)
@@ -64,13 +64,13 @@ def __clean_comments(f):
     f.seek(0); f.truncate()
     f.writelines(lines)
 
-def edit_file(series, string, comment, show_patch = True):
+def edit_file(series, line, comment, show_patch = True):
     fname = '.stgit.msg'
-    tmpl = os.path.join(git.base_dir, 'patchdescr.tmpl')
+    tmpl = os.path.join(git.get_base_dir(), 'patchdescr.tmpl')
 
     f = file(fname, 'w+')
-    if string:
-        print >> f, string
+    if line:
+        print >> f, line
     elif os.path.isfile(tmpl):
         print >> f, file(tmpl).read().rstrip()
     else:
@@ -108,12 +108,12 @@ def edit_file(series, string, comment, show_patch = True):
 
     __clean_comments(f)
     f.seek(0)
-    string = f.read()
+    result = f.read()
 
     f.close()
     os.remove(fname)
 
-    return string
+    return result
 
 #
 # Classes
@@ -150,18 +150,18 @@ class Patch:
     def __get_field(self, name, multiline = False):
         id_file = os.path.join(self.__dir, name)
         if os.path.isfile(id_file):
-            string = read_string(id_file, multiline)
-            if string == '':
+            line = read_string(id_file, multiline)
+            if line == '':
                 return None
             else:
-                return string
+                return line
         else:
             return None
 
-    def __set_field(self, name, string, multiline = False):
+    def __set_field(self, name, value, multiline = False):
         fname = os.path.join(self.__dir, name)
-        if string and string != '':
-            write_string(fname, string, multiline)
+        if value and value != '':
+            write_string(fname, value, multiline)
         elif os.path.isfile(fname):
             os.remove(fname)
 
@@ -171,14 +171,14 @@ class Patch:
     def get_bottom(self):
         return self.__get_field('bottom')
 
-    def set_bottom(self, string, backup = False):
+    def set_bottom(self, value, backup = False):
         if backup:
             curr = self.__get_field('bottom')
-            if curr != string:
+            if curr != value:
                 self.__set_field('bottom.old', curr)
             else:
                 self.__set_field('bottom.old', None)
-        self.__set_field('bottom', string)
+        self.__set_field('bottom', value)
 
     def get_old_top(self):
         return self.__get_field('top.old')
@@ -186,14 +186,14 @@ class Patch:
     def get_top(self):
         return self.__get_field('top')
 
-    def set_top(self, string, backup = False):
+    def set_top(self, value, backup = False):
         if backup:
             curr = self.__get_field('top')
-            if curr != string:
+            if curr != value:
                 self.__set_field('top.old', curr)
             else:
                 self.__set_field('top.old', None)
-        self.__set_field('top', string)
+        self.__set_field('top', value)
 
     def restore_old_boundaries(self):
         bottom = self.__get_field('bottom.old')
@@ -209,46 +209,46 @@ class Patch:
     def get_description(self):
         return self.__get_field('description', True)
 
-    def set_description(self, string):
-        self.__set_field('description', string, True)
+    def set_description(self, line):
+        self.__set_field('description', line, True)
 
     def get_authname(self):
         return self.__get_field('authname')
 
-    def set_authname(self, string):
-        if not string and config.has_option('stgit', 'authname'):
-            string = config.get('stgit', 'authname')
-        self.__set_field('authname', string)
+    def set_authname(self, name):
+        if not name and config.has_option('stgit', 'authname'):
+            name = config.get('stgit', 'authname')
+        self.__set_field('authname', name)
 
     def get_authemail(self):
         return self.__get_field('authemail')
 
-    def set_authemail(self, string):
-        if not string and config.has_option('stgit', 'authemail'):
-            string = config.get('stgit', 'authemail')
-        self.__set_field('authemail', string)
+    def set_authemail(self, address):
+        if not address and config.has_option('stgit', 'authemail'):
+            address = config.get('stgit', 'authemail')
+        self.__set_field('authemail', address)
 
     def get_authdate(self):
         return self.__get_field('authdate')
 
-    def set_authdate(self, string):
-        self.__set_field('authdate', string)
+    def set_authdate(self, authdate):
+        self.__set_field('authdate', authdate)
 
     def get_commname(self):
         return self.__get_field('commname')
 
-    def set_commname(self, string):
-        if not string and config.has_option('stgit', 'commname'):
-            string = config.get('stgit', 'commname')
-        self.__set_field('commname', string)
+    def set_commname(self, name):
+        if not name and config.has_option('stgit', 'commname'):
+            name = config.get('stgit', 'commname')
+        self.__set_field('commname', name)
 
     def get_commemail(self):
         return self.__get_field('commemail')
 
-    def set_commemail(self, string):
-        if not string and config.has_option('stgit', 'commemail'):
-            string = config.get('stgit', 'commemail')
-        self.__set_field('commemail', string)
+    def set_commemail(self, address):
+        if not address and config.has_option('stgit', 'commemail'):
+            address = config.get('stgit', 'commemail')
+        self.__set_field('commemail', address)
 
 
 class Series:
@@ -263,9 +263,10 @@ class Series:
             self.__name = git.get_head_file()
 
         if self.__name:
-            self.__patch_dir = os.path.join(git.base_dir, 'patches',
+            base_dir = git.get_base_dir()
+            self.__patch_dir = os.path.join(base_dir, 'patches',
                                             self.__name)
-            self.__base_file = os.path.join(git.base_dir, 'refs', 'bases',
+            self.__base_file = os.path.join(base_dir, 'refs', 'bases',
                                             self.__name)
             self.__applied_file = os.path.join(self.__patch_dir, 'applied')
             self.__unapplied_file = os.path.join(self.__patch_dir, 'unapplied')
@@ -378,12 +379,17 @@ class Series:
             return True
         return git.get_head() == Patch(crt, self.__patch_dir).get_top()
 
+    def is_initialised(self):
+        """Checks if series is already initialised
+        """
+        return os.path.isdir(self.__patch_dir)
+
     def init(self):
         """Initialises the stgit series
         """
-        bases_dir = os.path.join(git.base_dir, 'refs', 'bases')
+        bases_dir = os.path.join(git.get_base_dir(), 'refs', 'bases')
 
-        if os.path.isdir(self.__patch_dir):
+        if self.is_initialised():
             raise StackException, self.__patch_dir + ' already exists'
         os.makedirs(self.__patch_dir)
 
@@ -395,32 +401,77 @@ class Series:
         create_empty_file(self.__descr_file)
         self.__begin_stack_check()
 
+    def rename(self, to_name):
+        """Renames a series
+        """
+        to_stack = Series(to_name)
+
+        if to_stack.is_initialised():
+            raise StackException, '"%s" already exists' % to_stack.get_branch()
+        if os.path.exists(to_stack.__base_file):
+            os.remove(to_stack.__base_file)
+
+        git.rename_branch(self.__name, to_name)
+
+        if os.path.isdir(self.__patch_dir):
+            os.rename(self.__patch_dir, to_stack.__patch_dir)
+        if os.path.exists(self.__base_file):
+            os.rename(self.__base_file, to_stack.__base_file)
+
+        self.__init__(to_name)
+
+    def clone(self, target_series):
+        """Clones a series
+        """
+        base = read_string(self.get_base_file())
+        git.create_branch(target_series, tree_id = base)
+        Series(target_series).init()
+        new_series = Series(target_series)
+
+        # generate an artificial description file
+        write_string(new_series.__descr_file, 'clone of "%s"' % self.__name)
+
+        # clone self's entire series as unapplied patches
+        patches = self.get_applied() + self.get_unapplied()
+        patches.reverse()
+        for p in patches:
+            patch = self.get_patch(p)
+            new_series.new_patch(p, message = patch.get_description(),
+                                 can_edit = False, unapplied = True,
+                                 bottom = patch.get_bottom(),
+                                 top = patch.get_top(),
+                                 author_name = patch.get_authname(),
+                                 author_email = patch.get_authemail(),
+                                 author_date = patch.get_authdate())
+
+        # fast forward the cloned series to self's top
+        new_series.forward_patches(self.get_applied())
+
     def delete(self, force = False):
         """Deletes an stgit series
         """
-        if os.path.isdir(self.__patch_dir):
+        if self.is_initialised():
             patches = self.get_unapplied() + self.get_applied()
             if not force and patches:
                 raise StackException, \
                       'Cannot delete: the series still contains patches'
-            patches.reverse()
             for p in patches:
-                self.delete_patch(p)
+                Patch(p, self.__patch_dir).delete()
 
-            if os.path.isfile(self.__applied_file):
+            if os.path.exists(self.__applied_file):
                 os.remove(self.__applied_file)
-            if os.path.isfile(self.__unapplied_file):
+            if os.path.exists(self.__unapplied_file):
                 os.remove(self.__unapplied_file)
-            if os.path.isfile(self.__current_file):
+            if os.path.exists(self.__current_file):
                 os.remove(self.__current_file)
-            if os.path.isfile(self.__descr_file):
+            if os.path.exists(self.__descr_file):
                 os.remove(self.__descr_file)
             if not os.listdir(self.__patch_dir):
                 os.rmdir(self.__patch_dir)
             else:
                 print 'Series directory %s is not empty.' % self.__name
 
-        if os.path.isfile(self.__base_file):
+        if os.path.exists(self.__base_file):
             os.remove(self.__base_file)
 
     def refresh_patch(self, message = None, edit = False, show_patch = False,
@@ -611,6 +662,9 @@ class Series:
             forwarded+=1
             unapplied.remove(name)
 
+        if forwarded == 0:
+            return 0
+
         git.switch(top)
 
         append_strings(self.__applied_file, names[0:forwarded])
@@ -752,6 +806,9 @@ class Series:
         applied = self.get_applied()
         unapplied = self.get_unapplied()
 
+        if oldname == newname:
+            raise StackException, '"To" name and "from" name are the same'
+
         if newname in applied or newname in unapplied:
             raise StackException, 'Patch "%s" already exists' % newname