Remove duplicate models and update docstrings

Signed-off-by: Ayan Sinha Mahapatra <ayansmahapatra@gmail.com>

Author: AyanSinhaMahapatra

src/packagedcode/__init__.py

@@ -20,6 +20,7 @@
 from packagedcode import freebsd
 from packagedcode import golang
 from packagedcode import haxe
+from packagedcode import jar_manifest
 from packagedcode import maven
 from packagedcode import models
 from packagedcode import msi
@@ -43,10 +44,11 @@
     debian.DebianPackage,
 
     models.JavaJar,
+    jar_manifest.JavaManifest,
     models.JavaEar,
     models.JavaWar,
     maven.MavenPomPackage,
-    models.IvyJar,
+    jar_manifest.IvyJar,
     models.JBossSar,
     models.Axis2Mar,
 

src/packagedcode/jar_manifest.py

@@ -14,7 +14,7 @@
 from commoncode.fileutils import as_posixpath
 from packagedcode.utils import normalize_vcs_url
 from packagedcode.maven import parse_scm_connection
-from packagedcode.models import Package
+from packagedcode import models
 
 
 """
@@ -28,19 +28,13 @@
 
 
 @attr.s()
-class JavaArchive(Package):
-    file_patterns = ('META-INF/MANIFEST.MF',)
-    extensions = ('.jar', '.war', '.ear')
+class JavaArchive(models.Package):
+
     filetypes = ('java archive ', 'zip archive',)
     mimetypes = ('application/java-archive', 'application/zip',)
     default_type = 'jar'
     default_primary_language = 'Java'
 
-    @classmethod
-    def recognize(cls, location):
-        if is_manifest(location):
-            yield parse_manifest(location)
-
     @classmethod
     def get_package_root(cls, manifest_resource, codebase):
         if manifest_resource.path.lower().endswith('meta-inf/manifest.mf'):
@@ -50,11 +44,29 @@ def get_package_root(cls, manifest_resource, codebase):
             return manifest_resource
 
 
-def is_manifest(location):
-    """
-    Return Trye if the file at location is a Manifest.
-    """
-    return as_posixpath(location).lower().endswith('meta-inf/manifest.mf')
+@attr.s()
+class IvyJar(JavaArchive, models.PackageManifest):
+    file_patterns = ('ivy.xml',)
+    default_type = 'ivy'
+    default_primary_language = 'Java'
+
+
+@attr.s()
+class JavaManifest(JavaArchive, models.PackageManifest):
+    file_patterns = ('META-INF/MANIFEST.MF',)
+    extensions = ('.jar', '.war', '.ear')
+
+    @classmethod
+    def get_manifest_data(cls, location):
+        if cls.is_manifest(location):
+            yield parse_manifest(location)
+
+    @classmethod
+    def is_manifest(cls, location):
+        """
+        Return Trye if the file at location is a Manifest.
+        """
+        return as_posixpath(location).lower().endswith('meta-inf/manifest.mf')
 
 
 def parse_manifest(location):

src/packagedcode/models.py

@@ -50,6 +50,7 @@
 - in manifest file proper (such as a Maven POM, NPM package.json and many others)
 - in binaries (such as an Elf or LKM, Windows PE or RPM header).
 - in code (JavaDoc tags or Python __copyright__ magic)
+
 There are collectively named "manifests" in ScanCode.
 
 We handle package information at two levels:
@@ -60,25 +61,26 @@
 
 The second requires the first to be computed.
 
-Class Hierarchy:
-
-Base Classes: (Classes to be inherited)
+These are case classes to extend:
 
 - Package:
-    Base Data class with package data
+    Base class with shared package attributes and methods.
 - PackageManifest:
-    Mixin class with manifest specific data and methods
+    Mixin class that represents a specific package manifest file.
 - PackageInstance:
-    Mixin class with package instance specific data and methods
-
-- Package Ecosystem: (Classes which would have object instances)
-
-- EcosystemPackage(Package):
-    A class with ecosystem specific data (and data specific methods)
-- EcosystemPackageManifest(EcosystemPackage, PackageManifest):
-    A class that overides and implements package manifest methods for that ecosystem
-- EcosystemPackageInstance(EcosystemPackage, PackageInstance):
-    A class that overrides and implements package instance methods for that ecosystem
+    Mixin class that represents a package that's constructed from one or more
+    package manifests. It also tracks package files.
+
+Here is an example of the classes that would need to exist to support a new fictitious
+package type or ecosystem `dummy`.
+
+- DummyPackage(Package):
+    This class provides type wide defaults and basic implementation for type specific methods.
+- DummyManifest(DummyPackage, PackageManifest):
+    This class provides methods to recognize and parse a package manifest file format.
+- DummyPackageInstance(DummyPackage, PackageInstance):
+    This class provides methods to create package instances for one or more manifests and to
+    collect package file paths.
 """
 
 SCANCODE_DEBUG_PACKAGE_API = os.environ.get('SCANCODE_DEBUG_PACKAGE_API', False)
@@ -685,7 +687,8 @@ class PackageManifest:
     """
     A mixin for package manifest that can be recognized.
 
-    Subclasses must extend a Package subclass for a given ecosystem.
+    When creating a new package manifest, a class should be created that extends
+    both PackageManifest and Package.
     """
 
     # class-level attributes used to recognize a package
@@ -828,25 +831,6 @@ class JBossSar(Package, PackageManifest):
     default_primary_language = 'Java'
 
 
-@attr.s()
-class IvyJar(JavaJar):
-    file_patterns = ('ivy.xml',)
-    default_type = 'ivy'
-    default_primary_language = 'Java'
-
-
-# FIXME: move to bower.py
-@attr.s()
-class BowerPackage(Package, PackageManifest):
-    file_patterns = ('bower.json',)
-    default_type = 'bower'
-    default_primary_language = 'JavaScript'
-
-    @classmethod
-    def get_package_root(cls, manifest_resource, codebase):
-        return manifest_resource.parent(codebase)
-
-
 @attr.s()
 class MeteorPackage(Package, PackageManifest):
     file_patterns = ('package.js',)

src/packagedcode/recognize.py

@@ -54,45 +54,47 @@ def recognize_package_manifests(location):
 
     recognized_package_manifests = []
     for package_manifest_type in PACKAGE_MANIFEST_TYPES:
-        if package_manifest_type.is_manifest(location):
-            try:
-                for recognized in package_manifest_type.recognize(location):
-                    if TRACE:
-                        logger_debug(
-                            'recognize_package_manifests: metafile matching: recognized:',
-                            recognized,
-                        )
-                    if recognized and not recognized.license_expression:
-                        # compute and set a normalized license expression
-                        try:
-                            recognized.license_expression = recognized.compute_normalized_license()
-                        except Exception:
-                            if SCANCODE_DEBUG_PACKAGE_API:
-                                raise
-                            recognized.license_expression = 'unknown'
-
-                        if TRACE:
-                            logger_debug(
-                                'recognize_package_manifests: recognized.license_expression:',
-                                recognized.license_expression
-                            )
-                    recognized_package_manifests.append(recognized)
-                return recognized_package_manifests
-
-            except NotImplementedError:
-                # build a plain package if recognize is not yet implemented
-                recognized = package_manifest_type()
+        if not package_manifest_type.is_manifest(location):
+            continue
+
+        try:
+            for recognized in package_manifest_type.recognize(location):
                 if TRACE:
                     logger_debug(
-                        'recognize_package_manifests: NotImplementedError: recognized', recognized
+                        'recognize_package_manifests: metafile matching: recognized:',
+                        recognized,
                     )
+                if recognized and not recognized.license_expression:
+                    # compute and set a normalized license expression
+                    try:
+                        recognized.license_expression = recognized.compute_normalized_license()
+                    except Exception:
+                        if SCANCODE_DEBUG_PACKAGE_API:
+                            raise
+                        recognized.license_expression = 'unknown'
 
+                    if TRACE:
+                        logger_debug(
+                            'recognize_package_manifests: recognized.license_expression:',
+                            recognized.license_expression
+                        )
                 recognized_package_manifests.append(recognized)
+            return recognized_package_manifests
 
-                if SCANCODE_DEBUG_PACKAGE_API:
-                    raise
+        except NotImplementedError:
+            # build a plain package if recognize is not yet implemented
+            recognized = package_manifest_type()
+            if TRACE:
+                logger_debug(
+                    'recognize_package_manifests: NotImplementedError: recognized', recognized
+                )
 
-            return recognized_package_manifests
+            recognized_package_manifests.append(recognized)
+
+            if SCANCODE_DEBUG_PACKAGE_API:
+                raise
+
+        return recognized_package_manifests
 
         if TRACE: logger_debug(
             'recognize_package_manifests: no match for type:', package_manifest_type

tests/packagedcode/data/plugin/help.txt

@@ -202,9 +202,8 @@ Package: iso
 
 --------------------------------------------
 Package: ivy
-  class: packagedcode.models:IvyJar
+  class: packagedcode.jar_manifest:IvyJar
   file_patterns: ivy.xml
-  extensions: .jar
   filetypes: java archive , zip archive
 
 --------------------------------------------
@@ -214,6 +213,13 @@ Package: jar
   extensions: .jar
   filetypes: java archive , zip archive
 
+--------------------------------------------
+Package: jar
+  class: packagedcode.jar_manifest:JavaManifest
+  file_patterns: META-INF/MANIFEST.MF
+  extensions: .jar, .war, .ear
+  filetypes: java archive , zip archive
+
 --------------------------------------------
 Package: jboss
   class: packagedcode.models:JBossSar