Merge lp:~mvo/pkgme/add-debian-copyright-template into lp:pkgme

[Michael Vogt]

Add a skeleton debian/copyright and allow backends to control some values.

This adds a debian/copyright template/skeleton.

[James Westby (james-w)]

Hi,

This looks pretty close.

22 +class UpstreamAuthor(InfoElement):

You can just use Maintainer for that I think?

79 +Upstream-Contact: $homepage

$homepage is optional, so making it only appear if it is set would be good. Also, I wonder
if $homepage or $maintainer is better there, or a fallback between them. I don't really
care though.

Thanks,

James

[Michael Vogt (mvo)]

Thanks! Setting to needs-fixing as tests are missing, but good to know that the direction seems to be sensible.

review: Needs Fixing

[lp:~mvo/pkgme/add-debian-copyright-template]

118. By Michael Vogt on 2012-07-05

use maintainer instead of UpstreamAuthor as we assume that by default they will be the same and its trivial to change debian/copyright if needed

119. By Michael Vogt on 2012-07-05

pkgme/tests/test_package_files.py: improve test

120. By Michael Vogt on 2012-07-05

yet copyright year as well

121. By Michael Vogt on 2012-07-05

include link to known licenses

[Michael Vogt (mvo)]

Thanks for your feedback, I improved this a bit now and would appreciate your feedback.

review: Needs Resubmitting

[James Westby (james-w)]

Hi mvo,

I think this looks good now.

Thanks,

James

review: Approve

=== modified file 'pkgme/info_elements.py'
--- pkgme/info_elements.py	2012-06-04 16:40:24 +0000
+++ pkgme/info_elements.py	2012-07-05 14:18:19 +0000
@@ -332,3 +332,16 @@
 
     name = 'icon'
     description = "The name of the icon.  Used in desktop files."
+
+
+class License(InfoElement):
+
+    name = 'license'
+    default = 'unknown'
+    description = """The license of the files in the package. 
+
+    Note that this will only apply for "simple" cases where there
+    is just a single license type. Otherwise it will just write
+    a default copyright template that the user needs to fill in.
+    """
+

=== modified file 'pkgme/package_files.py'
--- pkgme/package_files.py	2012-06-01 15:27:15 +0000
+++ pkgme/package_files.py	2012-07-05 14:18:19 +0000
@@ -21,6 +21,7 @@
     ExtraFilesFromPaths,
     Homepage,
     Icon,
+    License,
     Maintainer,
     PackageName,
     Section,
@@ -172,9 +173,18 @@
 default_package_file_group.add_file_cls(Rules)
 
 
-class Copyright(DebianPackageFile):
-
-    filename = "copyright"
+class Copyright(DebianPackageFile, TemplatePackageFile):
+
+    # See http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+
+    elements = [
+        PackageName,
+        License,
+        Homepage,
+        Maintainer,
+        ]
+    filename = 'copyright'
+    template = 'copyright'
 
 
 default_package_file_group.add_file_cls(Copyright)
@@ -260,3 +270,5 @@
     @property
     def path(self):
         return '%s.desktop' % (self.values[PackageName.name],)
+
+

=== added file 'pkgme/templates/copyright'
--- pkgme/templates/copyright	1970-01-01 00:00:00 +0000
+++ pkgme/templates/copyright	2012-07-05 14:18:19 +0000
@@ -0,0 +1,18 @@
+#import datetime
+#set $year = datetime.datetime.now().year
+Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: $package_name
+Upstream-Contact: $maintainer
+
+Files: *
+Copyright: $year $maintainer
+License: $license
+#import os.path
+#set $path = os.path.join("/usr/share/common-licenses", $license)
+#if os.path.exists($path)
+ The full text of the can be found in the file '$path'.
+#end if
+
+Files: debian/*
+Copyright: $year The friendly pkgme.net robot
+License: public-domain

=== modified file 'pkgme/tests/test_package_files.py'
--- pkgme/tests/test_package_files.py	2012-06-07 11:29:02 +0000
+++ pkgme/tests/test_package_files.py	2012-07-05 14:18:19 +0000
@@ -1,3 +1,4 @@
+import datetime
 import json
 import os
 
@@ -20,6 +21,7 @@
     Homepage,
     Icon,
     InfoElement,
+    License,
     Maintainer,
     PackageName,
     Section,
@@ -216,15 +218,34 @@
 
     cls = Copyright
 
+    def get_default_args(self):
+        return { PackageName.name: "somepackage",
+                 Maintainer.name: "Random Guy <[e-mail]>",
+                 License.name: 'BSD',
+               }
+
     def test_path(self):
         package_file = self.get_object()
         self.assertEqual(
             os.path.join(DEBIAN_DIR, "copyright"), package_file.path)
 
-    def test_contents_empty(self):
-        # TODO: something useful in the copyright file
+    def test_copyright_valid(self):
         package_file = self.get_object()
-        self.assertEqual("", package_file.get_contents())
+        self.assertEqual(package_file.get_contents(),
+"""Format: http://www.debian.org/doc/packaging-manuals/copyright-format/1.0/
+Upstream-Name: somepackage
+Upstream-Contact: Random Guy <[e-mail]>
+
+Files: *
+Copyright: %(year)s Random Guy <[e-mail]>
+License: BSD
+ The full text of the can be found in the file '/usr/share/common-licenses/BSD'.
+
+Files: debian/*
+Copyright: %(year)s The friendly pkgme.net robot
+License: public-domain
+""" % { 'year' : datetime.datetime.now().year, 
+      })
 
     def test_overwrite(self):
         package_file = self.get_object()