From 6a6fbe6c1b5f663ad7adf6a66d16c354214f9d57 Mon Sep 17 00:00:00 2001 From: Wojtek Kosior Date: Tue, 16 Nov 2021 15:49:47 +0100 Subject: fix debian packaging --- example_content/hello/bye.js | 7 - example_content/hello/cc0.txt | 121 ------------ example_content/hello/hello.js | 7 - example_content/hello/index.json | 299 ------------------------------ example_content/hello/message.js | 8 - setup.py | 15 +- src/pydrilla/development_config.json | 24 --- src/pydrilla/pydrilla.py | 7 +- src/test/development_config.json | 25 +++ src/test/example_content/hello/bye.js | 7 + src/test/example_content/hello/cc0.txt | 121 ++++++++++++ src/test/example_content/hello/hello.js | 7 + src/test/example_content/hello/index.json | 299 ++++++++++++++++++++++++++++++ src/test/example_content/hello/message.js | 8 + src/test/test_pydrilla.py | 6 +- 15 files changed, 487 insertions(+), 474 deletions(-) delete mode 100644 example_content/hello/bye.js delete mode 100644 example_content/hello/cc0.txt delete mode 100644 example_content/hello/hello.js delete mode 100644 example_content/hello/index.json delete mode 100644 example_content/hello/message.js delete mode 100644 src/pydrilla/development_config.json create mode 100644 src/test/development_config.json create mode 100644 src/test/example_content/hello/bye.js create mode 100644 src/test/example_content/hello/cc0.txt create mode 100644 src/test/example_content/hello/hello.js create mode 100644 src/test/example_content/hello/index.json create mode 100644 src/test/example_content/hello/message.js diff --git a/example_content/hello/bye.js b/example_content/hello/bye.js deleted file mode 100644 index e6fd70c..0000000 --- a/example_content/hello/bye.js +++ /dev/null @@ -1,7 +0,0 @@ -// SPDX-License-Identifier: CC0-1.0 - -// Copyright (C) 2021 Wojtek Kosior -// -// Available under the terms of Creative Commons Zero v1.0 Universal. - -console.log(bye_message + "apple!"); diff --git a/example_content/hello/cc0.txt b/example_content/hello/cc0.txt deleted file mode 100644 index 0e259d4..0000000 --- a/example_content/hello/cc0.txt +++ /dev/null @@ -1,121 +0,0 @@ -Creative Commons Legal Code - -CC0 1.0 Universal - - CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE - LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN - ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS - INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES - REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS - PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM - THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED - HEREUNDER. - -Statement of Purpose - -The laws of most jurisdictions throughout the world automatically confer -exclusive Copyright and Related Rights (defined below) upon the creator -and subsequent owner(s) (each and all, an "owner") of an original work of -authorship and/or a database (each, a "Work"). - -Certain owners wish to permanently relinquish those rights to a Work for -the purpose of contributing to a commons of creative, cultural and -scientific works ("Commons") that the public can reliably and without fear -of later claims of infringement build upon, modify, incorporate in other -works, reuse and redistribute as freely as possible in any form whatsoever -and for any purposes, including without limitation commercial purposes. -These owners may contribute to the Commons to promote the ideal of a free -culture and the further production of creative, cultural and scientific -works, or to gain reputation or greater distribution for their Work in -part through the use and efforts of others. - -For these and/or other purposes and motivations, and without any -expectation of additional consideration or compensation, the person -associating CC0 with a Work (the "Affirmer"), to the extent that he or she -is an owner of Copyright and Related Rights in the Work, voluntarily -elects to apply CC0 to the Work and publicly distribute the Work under its -terms, with knowledge of his or her Copyright and Related Rights in the -Work and the meaning and intended legal effect of CC0 on those rights. - -1. Copyright and Related Rights. A Work made available under CC0 may be -protected by copyright and related or neighboring rights ("Copyright and -Related Rights"). Copyright and Related Rights include, but are not -limited to, the following: - - i. the right to reproduce, adapt, distribute, perform, display, - communicate, and translate a Work; - ii. moral rights retained by the original author(s) and/or performer(s); -iii. publicity and privacy rights pertaining to a person's image or - likeness depicted in a Work; - iv. rights protecting against unfair competition in regards to a Work, - subject to the limitations in paragraph 4(a), below; - v. rights protecting the extraction, dissemination, use and reuse of data - in a Work; - vi. database rights (such as those arising under Directive 96/9/EC of the - European Parliament and of the Council of 11 March 1996 on the legal - protection of databases, and under any national implementation - thereof, including any amended or successor version of such - directive); and -vii. other similar, equivalent or corresponding rights throughout the - world based on applicable law or treaty, and any national - implementations thereof. - -2. Waiver. To the greatest extent permitted by, but not in contravention -of, applicable law, Affirmer hereby overtly, fully, permanently, -irrevocably and unconditionally waives, abandons, and surrenders all of -Affirmer's Copyright and Related Rights and associated claims and causes -of action, whether now known or unknown (including existing as well as -future claims and causes of action), in the Work (i) in all territories -worldwide, (ii) for the maximum duration provided by applicable law or -treaty (including future time extensions), (iii) in any current or future -medium and for any number of copies, and (iv) for any purpose whatsoever, -including without limitation commercial, advertising or promotional -purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each -member of the public at large and to the detriment of Affirmer's heirs and -successors, fully intending that such Waiver shall not be subject to -revocation, rescission, cancellation, termination, or any other legal or -equitable action to disrupt the quiet enjoyment of the Work by the public -as contemplated by Affirmer's express Statement of Purpose. - -3. Public License Fallback. Should any part of the Waiver for any reason -be judged legally invalid or ineffective under applicable law, then the -Waiver shall be preserved to the maximum extent permitted taking into -account Affirmer's express Statement of Purpose. In addition, to the -extent the Waiver is so judged Affirmer hereby grants to each affected -person a royalty-free, non transferable, non sublicensable, non exclusive, -irrevocable and unconditional license to exercise Affirmer's Copyright and -Related Rights in the Work (i) in all territories worldwide, (ii) for the -maximum duration provided by applicable law or treaty (including future -time extensions), (iii) in any current or future medium and for any number -of copies, and (iv) for any purpose whatsoever, including without -limitation commercial, advertising or promotional purposes (the -"License"). The License shall be deemed effective as of the date CC0 was -applied by Affirmer to the Work. Should any part of the License for any -reason be judged legally invalid or ineffective under applicable law, such -partial invalidity or ineffectiveness shall not invalidate the remainder -of the License, and in such case Affirmer hereby affirms that he or she -will not (i) exercise any of his or her remaining Copyright and Related -Rights in the Work or (ii) assert any associated claims and causes of -action with respect to the Work, in either case contrary to Affirmer's -express Statement of Purpose. - -4. Limitations and Disclaimers. - - a. No trademark or patent rights held by Affirmer are waived, abandoned, - surrendered, licensed or otherwise affected by this document. - b. Affirmer offers the Work as-is and makes no representations or - warranties of any kind concerning the Work, express, implied, - statutory or otherwise, including without limitation warranties of - title, merchantability, fitness for a particular purpose, non - infringement, or the absence of latent or other defects, accuracy, or - the present or absence of errors, whether or not discoverable, all to - the greatest extent permissible under applicable law. - c. Affirmer disclaims responsibility for clearing rights of other persons - that may apply to the Work or any use thereof, including without - limitation any person's Copyright and Related Rights in the Work. - Further, Affirmer disclaims responsibility for obtaining any necessary - consents, permissions or other rights required for any use of the - Work. - d. Affirmer understands and acknowledges that Creative Commons is not a - party to this document and has no duty or obligation with respect to - this CC0 or use of the Work. diff --git a/example_content/hello/hello.js b/example_content/hello/hello.js deleted file mode 100644 index d87ea7f..0000000 --- a/example_content/hello/hello.js +++ /dev/null @@ -1,7 +0,0 @@ -// SPDX-License-Identifier: CC0-1.0 - -// Copyright (C) 2021 Wojtek Kosior -// -// Available under the terms of Creative Commons Zero v1.0 Universal. - -console.log(hello_message + "apple!"); diff --git a/example_content/hello/index.json b/example_content/hello/index.json deleted file mode 100644 index 34f5eba..0000000 --- a/example_content/hello/index.json +++ /dev/null @@ -1,299 +0,0 @@ -// SPDX-License-Identifier: CC0-1.0 - -// Copyright (C) 2021 Wojtek Kosior -// Available under the terms of Creative Commons Zero v1.0 Universal. - -// This is an example index.json file describing Hydrilla site content. As you -// can see, for storing site content information Hydrilla utilizes JSON with an -// additional extension in the form of '//' comments support. Hydrilla shall -// look into each direct subdirectory of the content directory passed to it -// (via a cofig file option). If such subsirectory contains an index.json file, -// Hydrilla shall process it. - -// An index.json file conveys definitions of site resources, pattern->payload -// mappings and licenses thereof. The definitions may reference files under -// index.json's containing directory, using relative paths. This is how scripts, -// license texts, etc. are included. Unix paths (using '/' as separator) are -// assumed. It is not allowed for an index.json file to reference files outside -// its directory. - -// Certain objects are allowed to contain a "comment" field. Although '//' -// comments can be used in index.json files, they will be stripped when the file -// is processed. If a comment should be included in the JSON definitions served -// by Hydrilla API, it should be put in a "comment" field of the proper object. - -// Various kinds of objects contain version information. Version is always an -// array of integers, with major version number being the first array item. When -// applicable, a version is accompanied by a revision field which contains a -// positive integer. If versions specified by arrays of different length need to -// be compared, the shorter array gets padded with zeroes on the right. This -// means that for example version 1.3 could be given as both [1, 3] and -// [1, 3, 0, 0] (aka 1.3.0.0) and either would mean the same. - -{ - // Once our json schema changes, this version will change. Our software will - // be able to handle both current and older formats thanks to this - // information present in every index.json file. Different schema versions - // are always incompatible (e.g. a Hydrilla instance that understands schema - // version 0.2.0.0 will not understand version 0.2.0.1). Schemas that are - // backwards-compatible will be denoted by a different revision. - // We will try to make schema version match the version of Hydrilla software - // that introduced it. - "schema_version": [0, 2], - "schema_revision": 1, - - // Copyright of this json file. It's a list of copyright holder information - // objects. Alternatively, "auto" can be used to make Hydrilla attempt to - // extract copyright info from the comment at the beginning of the file. - "copyright": [ - // There can be multiple entries, one for each co-holder of the - // copyright. - { - // There can also be multiple years, like ["2021","2023-2024"]. - "years": ["2021"], - // Name of the copyright holder. Depending on the situation it can - // be just the first name, name+surname, a company name, a - // pseudonym, etc. - "holder": "Wojtek Kosior" - } - ], - - // License of this json file. Identifier has to be known to Hydrilla. Can - // be defined either in the same or another index.json file as a "license" - // item. It is possible to specify license combinations, like: - // [["Expat", "and", "Apache-2.0"], "or", "GPL-3.0-only"] - // Alternatively, "auto" can be used to make Hydrilla attempt to extract - // copyright info from this file's SPDX license identifier. - "licenses": "CC0-1.0", - - // Where this software/work initially comes from. In some cases (i.e. when - // the developer of content is also the one who packages it for Hydrilla) - // this might be the same as "package_url". - "upstream_url": "https://git.koszko.org/pydrilla/tree/example_content/hello", - - // Where sources for the packaging of this content can be found. - "package_url": "https://git.koszko.org/pydrilla/tree/example_content/hello", - - // Additional "comment" field can be used if needed. - // "comment": "" - - // List of actual site resources, pattern->payload mappings and licenses. - // Each of them is represented by an object. Meta-sites and replacement site - // interfaces will also belong here once they get implemented. - "definitions": [ - { - // Value of "type" can currently be one of: "resource", "license" - // and "mapping". The one we have here, "resource", defines a list - // of injectable scripts that can be used as a payload or as a - // dependency of another "resource". In the future CSS style sheets - // and WASM modules will also be composite parts of a "resource" as - // scripts are now. - "type": "resource", - - // Used when referring to this resource in "dependencies" list of - // another resource or in "payload" field of a mapping. Should - // be consize and can only use a restricted set of characters. It - // has to match: [-0-9a-zA-Z] - "identifier": "helloapple", - - // "long_name" should be used to specify a user-friendly alternative - // to an identifier. It should generally not collide with a long - // name of some resource with a different uuid and also shouldn't - // change in-between versions of the same resource, although - // exceptions to both rules might be considered. Long name is - // allowed to contain arbitrary unicode characters (within reason!). - "long_name": "Hello Apple", - - // Different versions (e.g. 1.0 and 1.3) of the same resource can be - // defined in separate index.json files. This makes it easy to - // accidently cause an identifier clash. To help detect it, we - // require that each resource has a uuid associated with it. Attempt - // to define multiple resources with the same identifier and - // different uuids will result in an error being reported. Defining - // multiple resources with different identifiers and the same uuid - // is disallowed for now (it may be later permitted if we consider - // it good for some use-case). - "uuid": "a6754dcb-58d8-4b7a-a245-24fd7ad4cd68", - - // Version should match the upstream version of the resource (e.g. a - // version of javascript library). Revision number starts as 1 for - // each new resource version and gets incremented by 1 each time a - // modification to the packaging of this version is done. Hydrilla - // will allow multiple definitions of the same resource to load, as - // long as their versions differ. Thanks to the "version" and - // "revision" fields, clients will know they have to update certain - // resource after it has been updated. If multiple definitions of - // the same version of given resource are provided, an error is - // generated (even if those definitions differ by revision number). - "version": [2021, 11, 10], - "revision": 1, - - // A short, meaningful description of what the resource is and/or - // what it does. - "description": "greets an apple", - - // If needed, a "comment" field can be added to provide some - // additional information. - // "comment": "this resource something something", - - // One should specify the copyright and licensing terms of the - // entire package. The format is the same as when specifying these - // for the index.json file, except "auto" cannot be used. - "copyright": [{"years": ["2021"], "holder": "Wojtek Kosior"}], - "licenses": "CC0-1.0", - - // Resource's "dependencies" array shall contain names of other - // resources that (in case of scripts at least) should get evaluated - // on a page before this resource's own scripts. - "dependencies": ["hello-message"], - - // Array of javascript files that belong to this resource. - "scripts": [ - { - // Script name. It should also be a valid file path. - "name": "hello.js", - // Copyright and license info of a script file can be - // specified using the same format as in the case of the - // index.json file itself. If "copyright" or "license" is - // not provided, Hydrilla assumes it to be the same as the - // value specified for the resource itself. - "copyright": "auto", - "licenses": "auto" - }, { - "name": "bye.js" - } - ] - }, { - "type": "resource", - "identifier": "hello-message", - "long_name": "Hello Message", - "uuid": "1ec36229-298c-4b35-8105-c4f2e1b9811e", - "version": [2021, 11, 10], - "revision": 2, - "description": "define messages for saying hello and bye", - "copyright": [{"years": ["2021"], "holder": "Wojtek Kosior"}], - "licenses": "CC0-1.0", - // If "dependencies" is empty, it can also be omitted. - // "dependencies": [], - "scripts": [{"name": "message.js"}] - }, { - "type": "mapping", - - // Has similar function to resource's identifier. Should be consize - // and can only use a restricted set of characters. It has to match: - // [-0-9a-zA-Z] - // It can be the same as some resource identifier (those are - // different entities and are treated separately). - "identifier": "helloapple", - - // "long name" and "uuid" have the same meaning as in the case of - // resources. Uuids of a resource and a mapping can technically be - // the same, but it is recommended to avoid even this kind of - // repetition. - "long_name": "Hello Apple", - "uuid": "54d23bba-472e-42f5-9194-eaa24c0e3ee7", - - // "version" differs from its counterpart in resource in that it has - // no accompanying revision number. - "version": [2021, 11, 10], - - // A short, meaningful description of what the mapping does. - "description": "causes apple to get greeted on Hydrillabugs issue tracker", - - // A comment, if necessary. - // "comment": "blah blah because bleh" - - // The "payloads" array specifies, which payloads are to be - // applied to which URLs. - "payloads": [ - { - // Should be a valid Haketilo URL pattern. - "pattern": "https://hydrillabugs.koszko.org/***", - // Should be the name of an existing resource. The resource - // may, but doesn't have to, be defined in the same - // index.json file. - "payload": "helloapple" - }, - // More associations may follow. - { - "pattern": "https://hachettebugs.koszko.org/***", - "payload": "helloapple" - } - ] - }, { - "type": "license", - - // Will be used to refer to this license in other places. Should - // match the SPDX identifier if possible (despite that, please use - // "Expat" instead of "MIT" where possible). Unlike other definition - // types, "license" does not allow uuids to be used to avoid license - // id clashes. Any attempt to define multiple licenses with the same - // id will result in an error being reported. - "identifier": "CC0-1.0", - - // This long name must also be unique among all license definitions. - "long_name": "Creative Commons Zero v1.0 Universal", - - // We don't use "version" in license definitions. We do, however, - // use "revision" to indicate changes to the packaging of a license. - // Revision should be increased by 1 at each such change. - "revision": 2, - - "legal_text": [ - // Legal text can be available in multiple forms. Usually just - // plain .txt file is enough, though. - { - // "format" should match an agreed-upon MIME type if - // possible. - "format": "text/plain", - // Value of "file" should be a path relative to the - // directory of index.json file. - "file": "cc0.txt" - } - // If a markdown version of CC0 was provided, we could add this: - // { - // "format": "text/markdown", - // "file": "cc0.md" - // } - ] - - // If needed, a "comment" field can be added to clarify something. - // For example, when definind "Expat" license we could add: - // - // "comment": "Expat license is the most common form of the license often called \"MIT\". Many other forms of \"MIT\" license exist. Here the name \"Expat\" is used to avoid ambiguity." - - // If applicable, a "notice" can be included. It shall then be a - // path (relative to index.json) to a plain text file with that - // notice. - // - // "notice": "license-notice.txt" - // - // This is needed for example in case of GNU licenses (both with and - // without exceptions). For example, - // "GPL-3.0-or-later-with-html-exception" could have the following - // in its notice file: - // - // This program is free software: you can redistribute it and/or - // modify it under the terms of the GNU General Public License as - // published by the Free Software Foundation, either version 3 of - // the License, or (at your option) any later version. - // - // This program is distributed in the hope that it will be useful, - // but WITHOUT ANY WARRANTY; without even the implied warranty of - // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - // GNU General Public License for more details. - // - // As a special exception to the GPL, any HTML file which merely - // makes function calls to this code, and for that purpose - // includes it by reference shall be deemed a separate work for - // copyright law purposes. If you modify this code, you may extend - // this exception to your version of the code, but you are not - // obligated to do so. If you do not wish to do so, delete this - // exception statement from your version. - // - // You should have received a copy of the GNU General Public License - // along with this program. If not, see - // . - } - ] -} diff --git a/example_content/hello/message.js b/example_content/hello/message.js deleted file mode 100644 index da5966d..0000000 --- a/example_content/hello/message.js +++ /dev/null @@ -1,8 +0,0 @@ -// SPDX-License-Identifier: CC0-1.0 - -// Copyright (C) 2021 Wojtek Kosior -// -// Available under the terms of Creative Commons Zero v1.0 Universal. - -var hello_message = "hello, " -var bye_message = "bye, " diff --git a/setup.py b/setup.py index 4f87ecc..28d9ca5 100755 --- a/setup.py +++ b/setup.py @@ -21,14 +21,21 @@ from setuptools import setup, find_packages import sys import pathlib +def files_find(package_path, subpath, rglob): + package_path = pathlib.Path(package_path) + for path in (package_path / subpath).rglob(rglob): + if not path.is_dir(): + yield str(path.relative_to(package_path)) + settings = {} settings['version'] = '0.2' settings['app_package_name'] = 'pydrilla' settings['project_root'] = pathlib.Path(__file__).resolve().parent packages_root = settings['project_root'] / 'src' main_package_dir = packages_root / settings['app_package_name'] +test_dir = packages_root / 'test' settings['locales_dir'] = main_package_dir / 'locales' -settings['config_path'] = main_package_dir / 'development_config.json' +settings['config_path'] = test_dir / 'development_config.json' sys.path.insert(0, str(packages_root)) import test @@ -63,8 +70,10 @@ setup( 'test': ['pytest'], }, package_data={ - 'pydrilla': ['config.json', *helper.locale_files_relative()], - 'test': [] + 'pydrilla': ['config.json', *helper.locale_files_relative(), + *files_find(main_package_dir, 'templates', '*.html')], + 'test': [*files_find(packages_root / 'test', 'example_content', '*'), + 'development_config.json'] }, cmdclass=helper.commands() # project_urls={ diff --git a/src/pydrilla/development_config.json b/src/pydrilla/development_config.json deleted file mode 100644 index 1660edb..0000000 --- a/src/pydrilla/development_config.json +++ /dev/null @@ -1,24 +0,0 @@ -// SPDX-License-Identifier: CC0-1.0 - -// Hydrilla development config file. -// -// Copyright (C) 2021 Wojtek Kosior -// -// Available under the terms of Creative Commons Zero v1.0 Universal. - -// this config is meant to be used in development environment; -// unlike config.json, it shall not be included in distribution -{ - "content_dir": "./example_content", - - // Except files from content_dir to be served there (used to redirect - // clients). - "static_resource_uri": "http://localhost:8000/", - - // Make Pydrilla error out on any warning - "werror": true - - // With the below we can make Pydrilla look for missing content items in - // another instance instead of just erroring/warning. - // ,"hydrilla_parent": "https://api.hachette-hydrilla.org/0.2/" -} diff --git a/src/pydrilla/pydrilla.py b/src/pydrilla/pydrilla.py index 239267e..2c4ad0d 100644 --- a/src/pydrilla/pydrilla.py +++ b/src/pydrilla/pydrilla.py @@ -541,7 +541,6 @@ def load_content_from_subdir(subdir_path, source_name, content): content.process_index(index, source_name) def load_content(path): - path = pathlib.Path(path) if not path.is_dir(): raise ValueError(_('content_dir_path_not_dir')) @@ -586,8 +585,12 @@ def create_app(config_path=(here / 'config.json'), flask_config={}): app._pydrilla_werror = config.get('werror', False) if 'hydrilla_parent' in config: raise MyNotImplError('hydrilla_parent', config_path.name) + + content_dir = pathlib.Path(config['content_dir']) + if not content_dir.is_absolute(): + content_dir = config_path.parent / content_dir with app.app_context(): - app._pydrilla_content = load_content(config['content_dir']) + app._pydrilla_content = load_content(content_dir.resolve()) app.register_blueprint(bp) diff --git a/src/test/development_config.json b/src/test/development_config.json new file mode 100644 index 0000000..5998918 --- /dev/null +++ b/src/test/development_config.json @@ -0,0 +1,25 @@ +// SPDX-License-Identifier: CC0-1.0 + +// Hydrilla development config file. +// +// Copyright (C) 2021 Wojtek Kosior +// +// Available under the terms of Creative Commons Zero v1.0 Universal. + +// this config is meant to be used in development environment; +// unlike config.json, it shall not be included in distribution +{ + // Relative paths now get resolved from config's containing direcotry. + "content_dir": "./example_content", + + // Except files from content_dir to be served there (used to redirect + // clients). + "static_resource_uri": "http://localhost:8000/", + + // Make Pydrilla error out on any warning + "werror": true + + // With the below we can make Pydrilla look for missing content items in + // another instance instead of just erroring/warning. + // ,"hydrilla_parent": "https://api.hachette-hydrilla.org/0.2/" +} diff --git a/src/test/example_content/hello/bye.js b/src/test/example_content/hello/bye.js new file mode 100644 index 0000000..e6fd70c --- /dev/null +++ b/src/test/example_content/hello/bye.js @@ -0,0 +1,7 @@ +// SPDX-License-Identifier: CC0-1.0 + +// Copyright (C) 2021 Wojtek Kosior +// +// Available under the terms of Creative Commons Zero v1.0 Universal. + +console.log(bye_message + "apple!"); diff --git a/src/test/example_content/hello/cc0.txt b/src/test/example_content/hello/cc0.txt new file mode 100644 index 0000000..0e259d4 --- /dev/null +++ b/src/test/example_content/hello/cc0.txt @@ -0,0 +1,121 @@ +Creative Commons Legal Code + +CC0 1.0 Universal + + CREATIVE COMMONS CORPORATION IS NOT A LAW FIRM AND DOES NOT PROVIDE + LEGAL SERVICES. DISTRIBUTION OF THIS DOCUMENT DOES NOT CREATE AN + ATTORNEY-CLIENT RELATIONSHIP. CREATIVE COMMONS PROVIDES THIS + INFORMATION ON AN "AS-IS" BASIS. CREATIVE COMMONS MAKES NO WARRANTIES + REGARDING THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS + PROVIDED HEREUNDER, AND DISCLAIMS LIABILITY FOR DAMAGES RESULTING FROM + THE USE OF THIS DOCUMENT OR THE INFORMATION OR WORKS PROVIDED + HEREUNDER. + +Statement of Purpose + +The laws of most jurisdictions throughout the world automatically confer +exclusive Copyright and Related Rights (defined below) upon the creator +and subsequent owner(s) (each and all, an "owner") of an original work of +authorship and/or a database (each, a "Work"). + +Certain owners wish to permanently relinquish those rights to a Work for +the purpose of contributing to a commons of creative, cultural and +scientific works ("Commons") that the public can reliably and without fear +of later claims of infringement build upon, modify, incorporate in other +works, reuse and redistribute as freely as possible in any form whatsoever +and for any purposes, including without limitation commercial purposes. +These owners may contribute to the Commons to promote the ideal of a free +culture and the further production of creative, cultural and scientific +works, or to gain reputation or greater distribution for their Work in +part through the use and efforts of others. + +For these and/or other purposes and motivations, and without any +expectation of additional consideration or compensation, the person +associating CC0 with a Work (the "Affirmer"), to the extent that he or she +is an owner of Copyright and Related Rights in the Work, voluntarily +elects to apply CC0 to the Work and publicly distribute the Work under its +terms, with knowledge of his or her Copyright and Related Rights in the +Work and the meaning and intended legal effect of CC0 on those rights. + +1. Copyright and Related Rights. A Work made available under CC0 may be +protected by copyright and related or neighboring rights ("Copyright and +Related Rights"). Copyright and Related Rights include, but are not +limited to, the following: + + i. the right to reproduce, adapt, distribute, perform, display, + communicate, and translate a Work; + ii. moral rights retained by the original author(s) and/or performer(s); +iii. publicity and privacy rights pertaining to a person's image or + likeness depicted in a Work; + iv. rights protecting against unfair competition in regards to a Work, + subject to the limitations in paragraph 4(a), below; + v. rights protecting the extraction, dissemination, use and reuse of data + in a Work; + vi. database rights (such as those arising under Directive 96/9/EC of the + European Parliament and of the Council of 11 March 1996 on the legal + protection of databases, and under any national implementation + thereof, including any amended or successor version of such + directive); and +vii. other similar, equivalent or corresponding rights throughout the + world based on applicable law or treaty, and any national + implementations thereof. + +2. Waiver. To the greatest extent permitted by, but not in contravention +of, applicable law, Affirmer hereby overtly, fully, permanently, +irrevocably and unconditionally waives, abandons, and surrenders all of +Affirmer's Copyright and Related Rights and associated claims and causes +of action, whether now known or unknown (including existing as well as +future claims and causes of action), in the Work (i) in all territories +worldwide, (ii) for the maximum duration provided by applicable law or +treaty (including future time extensions), (iii) in any current or future +medium and for any number of copies, and (iv) for any purpose whatsoever, +including without limitation commercial, advertising or promotional +purposes (the "Waiver"). Affirmer makes the Waiver for the benefit of each +member of the public at large and to the detriment of Affirmer's heirs and +successors, fully intending that such Waiver shall not be subject to +revocation, rescission, cancellation, termination, or any other legal or +equitable action to disrupt the quiet enjoyment of the Work by the public +as contemplated by Affirmer's express Statement of Purpose. + +3. Public License Fallback. Should any part of the Waiver for any reason +be judged legally invalid or ineffective under applicable law, then the +Waiver shall be preserved to the maximum extent permitted taking into +account Affirmer's express Statement of Purpose. In addition, to the +extent the Waiver is so judged Affirmer hereby grants to each affected +person a royalty-free, non transferable, non sublicensable, non exclusive, +irrevocable and unconditional license to exercise Affirmer's Copyright and +Related Rights in the Work (i) in all territories worldwide, (ii) for the +maximum duration provided by applicable law or treaty (including future +time extensions), (iii) in any current or future medium and for any number +of copies, and (iv) for any purpose whatsoever, including without +limitation commercial, advertising or promotional purposes (the +"License"). The License shall be deemed effective as of the date CC0 was +applied by Affirmer to the Work. Should any part of the License for any +reason be judged legally invalid or ineffective under applicable law, such +partial invalidity or ineffectiveness shall not invalidate the remainder +of the License, and in such case Affirmer hereby affirms that he or she +will not (i) exercise any of his or her remaining Copyright and Related +Rights in the Work or (ii) assert any associated claims and causes of +action with respect to the Work, in either case contrary to Affirmer's +express Statement of Purpose. + +4. Limitations and Disclaimers. + + a. No trademark or patent rights held by Affirmer are waived, abandoned, + surrendered, licensed or otherwise affected by this document. + b. Affirmer offers the Work as-is and makes no representations or + warranties of any kind concerning the Work, express, implied, + statutory or otherwise, including without limitation warranties of + title, merchantability, fitness for a particular purpose, non + infringement, or the absence of latent or other defects, accuracy, or + the present or absence of errors, whether or not discoverable, all to + the greatest extent permissible under applicable law. + c. Affirmer disclaims responsibility for clearing rights of other persons + that may apply to the Work or any use thereof, including without + limitation any person's Copyright and Related Rights in the Work. + Further, Affirmer disclaims responsibility for obtaining any necessary + consents, permissions or other rights required for any use of the + Work. + d. Affirmer understands and acknowledges that Creative Commons is not a + party to this document and has no duty or obligation with respect to + this CC0 or use of the Work. diff --git a/src/test/example_content/hello/hello.js b/src/test/example_content/hello/hello.js new file mode 100644 index 0000000..d87ea7f --- /dev/null +++ b/src/test/example_content/hello/hello.js @@ -0,0 +1,7 @@ +// SPDX-License-Identifier: CC0-1.0 + +// Copyright (C) 2021 Wojtek Kosior +// +// Available under the terms of Creative Commons Zero v1.0 Universal. + +console.log(hello_message + "apple!"); diff --git a/src/test/example_content/hello/index.json b/src/test/example_content/hello/index.json new file mode 100644 index 0000000..34f5eba --- /dev/null +++ b/src/test/example_content/hello/index.json @@ -0,0 +1,299 @@ +// SPDX-License-Identifier: CC0-1.0 + +// Copyright (C) 2021 Wojtek Kosior +// Available under the terms of Creative Commons Zero v1.0 Universal. + +// This is an example index.json file describing Hydrilla site content. As you +// can see, for storing site content information Hydrilla utilizes JSON with an +// additional extension in the form of '//' comments support. Hydrilla shall +// look into each direct subdirectory of the content directory passed to it +// (via a cofig file option). If such subsirectory contains an index.json file, +// Hydrilla shall process it. + +// An index.json file conveys definitions of site resources, pattern->payload +// mappings and licenses thereof. The definitions may reference files under +// index.json's containing directory, using relative paths. This is how scripts, +// license texts, etc. are included. Unix paths (using '/' as separator) are +// assumed. It is not allowed for an index.json file to reference files outside +// its directory. + +// Certain objects are allowed to contain a "comment" field. Although '//' +// comments can be used in index.json files, they will be stripped when the file +// is processed. If a comment should be included in the JSON definitions served +// by Hydrilla API, it should be put in a "comment" field of the proper object. + +// Various kinds of objects contain version information. Version is always an +// array of integers, with major version number being the first array item. When +// applicable, a version is accompanied by a revision field which contains a +// positive integer. If versions specified by arrays of different length need to +// be compared, the shorter array gets padded with zeroes on the right. This +// means that for example version 1.3 could be given as both [1, 3] and +// [1, 3, 0, 0] (aka 1.3.0.0) and either would mean the same. + +{ + // Once our json schema changes, this version will change. Our software will + // be able to handle both current and older formats thanks to this + // information present in every index.json file. Different schema versions + // are always incompatible (e.g. a Hydrilla instance that understands schema + // version 0.2.0.0 will not understand version 0.2.0.1). Schemas that are + // backwards-compatible will be denoted by a different revision. + // We will try to make schema version match the version of Hydrilla software + // that introduced it. + "schema_version": [0, 2], + "schema_revision": 1, + + // Copyright of this json file. It's a list of copyright holder information + // objects. Alternatively, "auto" can be used to make Hydrilla attempt to + // extract copyright info from the comment at the beginning of the file. + "copyright": [ + // There can be multiple entries, one for each co-holder of the + // copyright. + { + // There can also be multiple years, like ["2021","2023-2024"]. + "years": ["2021"], + // Name of the copyright holder. Depending on the situation it can + // be just the first name, name+surname, a company name, a + // pseudonym, etc. + "holder": "Wojtek Kosior" + } + ], + + // License of this json file. Identifier has to be known to Hydrilla. Can + // be defined either in the same or another index.json file as a "license" + // item. It is possible to specify license combinations, like: + // [["Expat", "and", "Apache-2.0"], "or", "GPL-3.0-only"] + // Alternatively, "auto" can be used to make Hydrilla attempt to extract + // copyright info from this file's SPDX license identifier. + "licenses": "CC0-1.0", + + // Where this software/work initially comes from. In some cases (i.e. when + // the developer of content is also the one who packages it for Hydrilla) + // this might be the same as "package_url". + "upstream_url": "https://git.koszko.org/pydrilla/tree/example_content/hello", + + // Where sources for the packaging of this content can be found. + "package_url": "https://git.koszko.org/pydrilla/tree/example_content/hello", + + // Additional "comment" field can be used if needed. + // "comment": "" + + // List of actual site resources, pattern->payload mappings and licenses. + // Each of them is represented by an object. Meta-sites and replacement site + // interfaces will also belong here once they get implemented. + "definitions": [ + { + // Value of "type" can currently be one of: "resource", "license" + // and "mapping". The one we have here, "resource", defines a list + // of injectable scripts that can be used as a payload or as a + // dependency of another "resource". In the future CSS style sheets + // and WASM modules will also be composite parts of a "resource" as + // scripts are now. + "type": "resource", + + // Used when referring to this resource in "dependencies" list of + // another resource or in "payload" field of a mapping. Should + // be consize and can only use a restricted set of characters. It + // has to match: [-0-9a-zA-Z] + "identifier": "helloapple", + + // "long_name" should be used to specify a user-friendly alternative + // to an identifier. It should generally not collide with a long + // name of some resource with a different uuid and also shouldn't + // change in-between versions of the same resource, although + // exceptions to both rules might be considered. Long name is + // allowed to contain arbitrary unicode characters (within reason!). + "long_name": "Hello Apple", + + // Different versions (e.g. 1.0 and 1.3) of the same resource can be + // defined in separate index.json files. This makes it easy to + // accidently cause an identifier clash. To help detect it, we + // require that each resource has a uuid associated with it. Attempt + // to define multiple resources with the same identifier and + // different uuids will result in an error being reported. Defining + // multiple resources with different identifiers and the same uuid + // is disallowed for now (it may be later permitted if we consider + // it good for some use-case). + "uuid": "a6754dcb-58d8-4b7a-a245-24fd7ad4cd68", + + // Version should match the upstream version of the resource (e.g. a + // version of javascript library). Revision number starts as 1 for + // each new resource version and gets incremented by 1 each time a + // modification to the packaging of this version is done. Hydrilla + // will allow multiple definitions of the same resource to load, as + // long as their versions differ. Thanks to the "version" and + // "revision" fields, clients will know they have to update certain + // resource after it has been updated. If multiple definitions of + // the same version of given resource are provided, an error is + // generated (even if those definitions differ by revision number). + "version": [2021, 11, 10], + "revision": 1, + + // A short, meaningful description of what the resource is and/or + // what it does. + "description": "greets an apple", + + // If needed, a "comment" field can be added to provide some + // additional information. + // "comment": "this resource something something", + + // One should specify the copyright and licensing terms of the + // entire package. The format is the same as when specifying these + // for the index.json file, except "auto" cannot be used. + "copyright": [{"years": ["2021"], "holder": "Wojtek Kosior"}], + "licenses": "CC0-1.0", + + // Resource's "dependencies" array shall contain names of other + // resources that (in case of scripts at least) should get evaluated + // on a page before this resource's own scripts. + "dependencies": ["hello-message"], + + // Array of javascript files that belong to this resource. + "scripts": [ + { + // Script name. It should also be a valid file path. + "name": "hello.js", + // Copyright and license info of a script file can be + // specified using the same format as in the case of the + // index.json file itself. If "copyright" or "license" is + // not provided, Hydrilla assumes it to be the same as the + // value specified for the resource itself. + "copyright": "auto", + "licenses": "auto" + }, { + "name": "bye.js" + } + ] + }, { + "type": "resource", + "identifier": "hello-message", + "long_name": "Hello Message", + "uuid": "1ec36229-298c-4b35-8105-c4f2e1b9811e", + "version": [2021, 11, 10], + "revision": 2, + "description": "define messages for saying hello and bye", + "copyright": [{"years": ["2021"], "holder": "Wojtek Kosior"}], + "licenses": "CC0-1.0", + // If "dependencies" is empty, it can also be omitted. + // "dependencies": [], + "scripts": [{"name": "message.js"}] + }, { + "type": "mapping", + + // Has similar function to resource's identifier. Should be consize + // and can only use a restricted set of characters. It has to match: + // [-0-9a-zA-Z] + // It can be the same as some resource identifier (those are + // different entities and are treated separately). + "identifier": "helloapple", + + // "long name" and "uuid" have the same meaning as in the case of + // resources. Uuids of a resource and a mapping can technically be + // the same, but it is recommended to avoid even this kind of + // repetition. + "long_name": "Hello Apple", + "uuid": "54d23bba-472e-42f5-9194-eaa24c0e3ee7", + + // "version" differs from its counterpart in resource in that it has + // no accompanying revision number. + "version": [2021, 11, 10], + + // A short, meaningful description of what the mapping does. + "description": "causes apple to get greeted on Hydrillabugs issue tracker", + + // A comment, if necessary. + // "comment": "blah blah because bleh" + + // The "payloads" array specifies, which payloads are to be + // applied to which URLs. + "payloads": [ + { + // Should be a valid Haketilo URL pattern. + "pattern": "https://hydrillabugs.koszko.org/***", + // Should be the name of an existing resource. The resource + // may, but doesn't have to, be defined in the same + // index.json file. + "payload": "helloapple" + }, + // More associations may follow. + { + "pattern": "https://hachettebugs.koszko.org/***", + "payload": "helloapple" + } + ] + }, { + "type": "license", + + // Will be used to refer to this license in other places. Should + // match the SPDX identifier if possible (despite that, please use + // "Expat" instead of "MIT" where possible). Unlike other definition + // types, "license" does not allow uuids to be used to avoid license + // id clashes. Any attempt to define multiple licenses with the same + // id will result in an error being reported. + "identifier": "CC0-1.0", + + // This long name must also be unique among all license definitions. + "long_name": "Creative Commons Zero v1.0 Universal", + + // We don't use "version" in license definitions. We do, however, + // use "revision" to indicate changes to the packaging of a license. + // Revision should be increased by 1 at each such change. + "revision": 2, + + "legal_text": [ + // Legal text can be available in multiple forms. Usually just + // plain .txt file is enough, though. + { + // "format" should match an agreed-upon MIME type if + // possible. + "format": "text/plain", + // Value of "file" should be a path relative to the + // directory of index.json file. + "file": "cc0.txt" + } + // If a markdown version of CC0 was provided, we could add this: + // { + // "format": "text/markdown", + // "file": "cc0.md" + // } + ] + + // If needed, a "comment" field can be added to clarify something. + // For example, when definind "Expat" license we could add: + // + // "comment": "Expat license is the most common form of the license often called \"MIT\". Many other forms of \"MIT\" license exist. Here the name \"Expat\" is used to avoid ambiguity." + + // If applicable, a "notice" can be included. It shall then be a + // path (relative to index.json) to a plain text file with that + // notice. + // + // "notice": "license-notice.txt" + // + // This is needed for example in case of GNU licenses (both with and + // without exceptions). For example, + // "GPL-3.0-or-later-with-html-exception" could have the following + // in its notice file: + // + // This program is free software: you can redistribute it and/or + // modify it under the terms of the GNU General Public License as + // published by the Free Software Foundation, either version 3 of + // the License, or (at your option) any later version. + // + // This program is distributed in the hope that it will be useful, + // but WITHOUT ANY WARRANTY; without even the implied warranty of + // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + // GNU General Public License for more details. + // + // As a special exception to the GPL, any HTML file which merely + // makes function calls to this code, and for that purpose + // includes it by reference shall be deemed a separate work for + // copyright law purposes. If you modify this code, you may extend + // this exception to your version of the code, but you are not + // obligated to do so. If you do not wish to do so, delete this + // exception statement from your version. + // + // You should have received a copy of the GNU General Public License + // along with this program. If not, see + // . + } + ] +} diff --git a/src/test/example_content/hello/message.js b/src/test/example_content/hello/message.js new file mode 100644 index 0000000..da5966d --- /dev/null +++ b/src/test/example_content/hello/message.js @@ -0,0 +1,8 @@ +// SPDX-License-Identifier: CC0-1.0 + +// Copyright (C) 2021 Wojtek Kosior +// +// Available under the terms of Creative Commons Zero v1.0 Universal. + +var hello_message = "hello, " +var bye_message = "bye, " diff --git a/src/test/test_pydrilla.py b/src/test/test_pydrilla.py index 07c580a..ed98f13 100644 --- a/src/test/test_pydrilla.py +++ b/src/test/test_pydrilla.py @@ -33,9 +33,9 @@ import json from pydrilla import pydrilla, create_app -test_dir = Path(__file__).resolve().parent -pydrilla_dir = Path(pydrilla.__file__).resolve().parent -test_config_path = pydrilla_dir / 'development_config.json' +test_dir = Path(__file__).resolve().parent +packages_dir = test_dir.parent +test_config_path = test_dir / 'development_config.json' @pytest.fixture def client(): -- cgit v1.2.3