Make transform work

about

@@ -1,19 +1,115 @@
 #!/bin/bash
 #
-# Copyright (c) 2015 nexB Inc. http://www.nexb.com/ - All rights reserved.
+# Copyright (c) 2018 nexB Inc. http://www.nexb.com/ - All rights reserved.
 #
 
-# cd to the root directory
-ABOUT_ROOT_DIR="$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
-cd "$ABOUT_ROOT_DIR"
+# A minimal shell wrapper to the CLI entry point of AboutCode
 
-CONFIGURED_PYTHON=$ABOUT_ROOT_DIR/bin/python
 
-if [ ! -f "$CONFIGURED_PYTHON" ]; then
-    echo "* Configuring AboutCode ..."
-    source $ABOUT_ROOT_DIR/configure
-fi
+###################################################################################
+# from https://raw.githubusercontent.com/mkropat/sh-realpath/58c03982cfd8accbcf0c4426a4adf0f120a8b2bb/realpath.sh
+# realpath emulation for portability on *nix
+# this allow running scancode from aribtrary locations and from symlinks
+#
+# Copyright (c) 2014 Michael Kropat
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in
+# all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+# THE SOFTWARE.
+
+realpath() {
+    canonicalize_path "$(resolve_symlinks "$1")"
+}
+
+resolve_symlinks() {
+    _resolve_symlinks "$1"
+}
+
+_resolve_symlinks() {
+    _assert_no_path_cycles "$@" || return
+
+    local dir_context path
+    path=$(readlink -- "$1")
+    if [ $? -eq 0 ]; then
+        dir_context=$(dirname -- "$1")
+        _resolve_symlinks "$(_prepend_dir_context_if_necessary "$dir_context" "$path")" "$@"
+    else
+        printf '%s\n' "$1"
+    fi
+}
+
+_prepend_dir_context_if_necessary() {
+    if [ "$1" = . ]; then
+        printf '%s\n' "$2"
+    else
+        _prepend_path_if_relative "$1" "$2"
+    fi
+}
+
+_prepend_path_if_relative() {
+    case "$2" in
+        /* ) printf '%s\n' "$2" ;;
+         * ) printf '%s\n' "$1/$2" ;;
+    esac
+}
 
-source $ABOUT_ROOT_DIR/bin/activate
+_assert_no_path_cycles() {
+    local target path
+
+    target=$1
+    shift
+
+    for path in "$@"; do
+        if [ "$path" = "$target" ]; then
+            return 1
+        fi
+    done
+}
+
+canonicalize_path() {
+    if [ -d "$1" ]; then
+        _canonicalize_dir_path "$1"
+    else
+        _canonicalize_file_path "$1"
+    fi
+}
+
+_canonicalize_dir_path() {
+    (cd "$1" 2>/dev/null && pwd -P)
+}
+
+_canonicalize_file_path() {
+    local dir file
+    dir=$(dirname -- "$1")
+    file=$(basename -- "$1")
+    (cd "$dir" 2>/dev/null && printf '%s/%s\n' "$(pwd -P)" "$file")
+}
+
+###################################################################################
+# Now run AboutCode "about" proper
+
+ABOUTCODE_BIN="$( realpath "${BASH_SOURCE[0]}" )"
+ABOUTCODE_ROOT_DIR="$( cd "$( dirname "${ABOUTCODE_BIN}" )" && pwd )"
+
+
+ABOUTCODE_CONFIGURED_PYTHON="$ABOUTCODE_ROOT_DIR/bin/python"
+if [ ! -f "$ABOUTCODE_CONFIGURED_PYTHON" ]; then
+    echo "* Configuring AboutCode for first use..."
+    CONFIGURE_QUIET=1 "$ABOUTCODE_ROOT_DIR/configure" etc/conf
+fi
 
-$ABOUT_ROOT_DIR/bin/about "$@"
+"$ABOUTCODE_ROOT_DIR/bin/about" "$@"

about.ABOUT

@@ -2,8 +2,6 @@ about_resource: .
 name: AboutCode-toolkit
 about_resource_path: .
 
-version: 3.0.0.dev6
-
 description: |
     AboutCode Toolkit is a tool to process ABOUT files. An ABOUT file
     provides a simple way to document the provenance (origin and license)
@@ -12,9 +10,12 @@ description: |
 
 homepage_url: http://www.nexb.com/community.html
 
-license: apache-2.0
-license_name: Apache 2.0
-license_file: apache-2.0.LICENSE
+license_expression: apache-2.0
+licenses:
+    - key: apache-2.0
+      name: Apache 2.0
+      file: apache-2.0.LICENSE
+
 copyright: Copyright (c) 2013-2017 nexB Inc.
 
 notice_file: NOTICE

appveyor.yml

@@ -8,9 +8,3 @@ build: off
 test_script:
     - set
     - py.test -vvs tests
-
-on_success:
-  - "python etc/scripts/irc-notify.py aboutcode [{project_name}:{branch}] {short_commit}: \"{message}\" ({author}) {color_green}Succeeded,Details: {build_url},Commit: {commit_url}"
-
-on_failure:
-  - "python etc/scripts/irc-notify.py aboutcode [{project_name}:{branch}] {short_commit}: \"{message}\" ({author}) {color_red}Failed,Details: {build_url},Commit: {commit_url}"

configure

@@ -25,4 +25,8 @@ if [[ "$PYTHON_EXE" == "" ]]; then
     PYTHON_EXE=python
 fi
 
+
 $PYTHON_EXE "$CONFIGURE_ROOT_DIR/etc/configure.py" $CFG_CMD_LINE_ARGS
+if [ -f "$CONFIGURE_ROOT_DIR/bin/activate" ]; then
+    source $CONFIGURE_ROOT_DIR/bin/activate
+fi

configure.bat

@@ -18,7 +18,6 @@ set ABOUT_ROOT_DIR=%~dp0
 @rem there is a space at the end of the set SCANCODE_CLI_ARGS=  line ... 
 @rem NEVER remove this!
 @rem otherwise, this script and scancode do not work.  
-
 set ABOUT_CLI_ARGS= 
 @rem Collect/Slurp all command line arguments in a variable
 :collectarg
@@ -42,7 +41,7 @@ if not exist "c:\python27\python.exe" (
     echo(
     echo On Windows, AboutCode requires Python 2.7.x 32 bits to be installed first.
     echo(
-    echo Please download and install Python 2.7 ^(Windows x86 MSI installer^) version 2.7.10.
+    echo Please download and install Python 2.7 ^(Windows x86 MSI installer^) version 2.7.15.
     echo Install Python on the c: drive and use all default installer options.
     echo Do NOT install Python v3 or any 64 bits edition.
     echo Instead download Python from this url and see the README.rst file for more details:

etc/configure.py

@@ -126,14 +126,22 @@ def clean(root_dir):
     Remove cleanable directories and files in root_dir.
     """
     print('* Cleaning ...')
-    cleanable = '''build bin lib Lib include Include Scripts local
-                   django_background_task.log
-                   develop-eggs eggs parts .installed.cfg
-                   .Python
-                   .cache
-                   pip-selfcheck.json
-                   '''.split()
-
+    cleanable = '''
+        __pycache__
+        .pytest_cache
+        build
+        bin
+        lib
+        Lib
+        include
+        Include
+        Scripts
+        local
+        .eggs
+        .cache
+        pip-selfcheck.json
+        src/aboutcode_toolkit.egg-info
+    '''.split()
     # also clean __pycache__ if any
     cleanable.extend(find_pycache(root_dir))
 

setup.cfg

@@ -5,7 +5,7 @@ universal = 1
 license_file = NOTICE
 
 [aliases]
-release = clean --all sdist --formats=bztar,zip bdist_wheel 
+release = clean --all sdist bdist_wheel 
 
 [tool:pytest]
 norecursedirs =

setup.py

@@ -24,15 +24,15 @@ def read(*names, **kwargs):
 
 setup(
     name='aboutcode-toolkit',
-    version='3.4.0.pre1',
+    version='4.0.0.pre1',
     license='Apache-2.0',
     description=(
         'AboutCode-toolkit is a tool to document the provenance (origin and license) of '
         'third-party software using small text files. '
         'Collect inventories, generate attribution documentation.'
     ),
     long_description=(
-        'AttributeCode provides a simple way to document the'
+        'AboutCode toolkit provides a simple way to document the'
         'provenance (i.e. origin and license) of software components that'
         'you use in your project. This documentation is stored in *.ABOUT'
         'files, side-by-side with the documented code.'
@@ -79,13 +79,15 @@ def read(*names, **kwargs):
 
         'boolean.py >= 3.5, < 4.0',
         'license_expression >= 0.94, < 1.0',
+
+        'attrs',
     ],
     extras_require={
         ":python_version < '3.6'": ['backports.csv'],
     },
     entry_points={
         'console_scripts': [
-            'about=attributecode.cmd:about',
+            'about=aboutcode.cmd:about',
         ]
     },
 )

src/attributecode/__init__.py → src/aboutcode/__init__.py

@@ -18,22 +18,23 @@
 from __future__ import print_function
 from __future__ import unicode_literals
 
-from collections import namedtuple
-import logging
+from collections import OrderedDict
 import os
 
+import attr
+import saneyaml
+
 try:
     # Python 2
     unicode  # NOQA
 except NameError:  # pragma: nocover
     # Python 3
     unicode = str  # NOQA
 
-import saneyaml
 
-__version__ = '3.4.0.pre1'
+__version__ = '4.0.0.pre1'
 
-__about_spec_version__ = '3.1'
+__about_spec_version__ = '4.0'
 
 __copyright__ = """
 Copyright (c) 2013-2018 nexB Inc. All rights reserved. http://dejacode.org
@@ -49,63 +50,62 @@
 """
 
 
-class Error(namedtuple('Error', ['severity', 'message'])):
-    """
-    An Error data with a severity and message.
-    """
-    def __new__(self, severity, message):
-        if message:
-            if isinstance(message, unicode):
-                message = self._clean_string(message)
-            else:
-                message = self._clean_string(unicode(repr(message), encoding='utf-8'))
-                message = message.strip('"')
-
-        return super(Error, self).__new__(
-            Error, severity, message)
+def message_converter(value):
+    if value:
+        if isinstance(value, unicode):
+            value = clean_string(value)
+        else:
+            value = clean_string(unicode(repr(value), encoding='utf-8'))
+            value = value.strip('"')
+    return value
 
-    def __repr__(self, *args, **kwargs):
-        sev, msg = self._get_values()
-        return 'Error(%(sev)s,  %(msg)s)' % locals()
 
-    def __eq__(self, other):
-        return repr(self) == repr(other)
+@attr.attributes(repr=False)
+class Error(object):
+    """
+    An Error data with a severity and message and an optional path attribute.
+    """
+    severity = attr.attrib()
+    message = attr.attrib(converter=message_converter)
+    # relative POSIX path of the ABOUT file
+    path = attr.attrib(default=None)  # , repr=False)
 
-    def _get_values(self):
+    def __repr__(self):
         sev = severities[self.severity]
-        msg = self._clean_string(repr(self.message))
-        return sev, msg
+        msg = clean_string(repr(self.message))
+        return 'Error(%(sev)s, %(msg)s)' % locals()
 
     def render(self):
-        sev, msg = self._get_values()
+        sev = severities[self.severity]
+        msg = clean_string(repr(self.message))
         return '%(sev)s: %(msg)s' % locals()
 
     def to_dict(self, *args, **kwargs):
         """
         Return an ordered dict of self.
         """
-        return self._asdict()
+        return attr.asdict(self, dict_factory=OrderedDict)
 
-    @staticmethod
-    def _clean_string(s):
-        """
-        Return a cleaned string for `s`, stripping eventual "u" prefixes
-        from unicode representations.
-        """
-        if not s:
-            return s
-        if s.startswith(('u"', "u'")):
-            s = s.lstrip('u')
-        s = s.replace('[u"', '["')
-        s = s.replace("[u'", "['")
-        s = s.replace("(u'", "('")
-        s = s.replace("(u'", "('")
-        s = s.replace("{u'", "{'")
-        s = s.replace("{u'", "{'")
-        s = s.replace(" u'", " '")
-        s = s.replace(" u'", " '")
-        s = s.replace("\\\\", "\\")
+
+def clean_string(s):
+    """
+    Return a cleaned string for `s`, stripping eventual "u" prefixes
+    from unicode representations.
+    """
+    if not s:
         return s
+    if s.startswith(('u"', "u'")):
+        s = s.lstrip('u')
+    s = s.replace('[u"', '["')
+    s = s.replace("[u'", "['")
+    s = s.replace("(u'", "('")
+    s = s.replace("(u'", "('")
+    s = s.replace("{u'", "{'")
+    s = s.replace("{u'", "{'")
+    s = s.replace(" u'", " '")
+    s = s.replace(" u'", " '")
+    s = s.replace("\\\\", "\\")
+    return s
 
 
 # modeled after the logging levels