Initial commit

Author: avstudnitz

.codeclimate.yml

@@ -0,0 +1,22 @@
+---
+engines:
+  duplication:
+    enabled: true
+  fixme:
+    enabled: true
+  phpmd:
+    enabled: true
+    checks:
+      CleanCode/StaticAccess:
+        enabled: false
+  phan:
+    enabled: true
+    config:
+      file_extensions: "php"
+      ignore-undeclared: true
+ratings:
+  paths:
+  - "**.php"
+exclude_paths:
+- tests/
+- vendor/

.gitattributes

@@ -0,0 +1,12 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and build files with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/tests              export-ignore
+/phpcs.xml          export-ignore
+/phpstan.neon       export-ignore
+/.codeclimate.yml   export-ignore
+/grumphp.yml        export-ignore

.gitignore

@@ -0,0 +1,5 @@
+.idea
+/vendor
+/composer.lock
+/tests/phpunit.xml
+.phpunit.result.cache

.scrutinizer.yml

@@ -0,0 +1,24 @@
+filter:
+  excluded_paths:
+    - 'tests/*'
+
+build:
+  environment:
+    php: 7.3
+  tests:
+    override:
+      - true
+  nodes:
+    analysis:
+      dependencies:
+        after:
+          - vendor/bin/phpcs --config-set installed_paths ../../magento/magento-coding-standard/ # Scrutinizer does not run composer scripts
+      tests:
+        override:
+          - php-scrutinizer-run
+          - phpcs-run
+
+tools:
+  external_code_coverage:
+    runs: 2          # Scrutinizer will wait for two code coverage submissions (unit and integration test suites)
+    timeout: 2400    # Timeout in seconds.

.travis.yml

@@ -0,0 +1,39 @@
+os: linux
+dist: xenial
+group: edge
+services:
+  - mysql
+addons:
+  apt:
+    packages:
+      - postfix
+  hosts:
+    - magento2.travis
+language: php
+:travis-jobs
+env:
+  global:
+    - COMPOSER_BIN_DIR=~/bin
+    - COMPOSER_PACKAGE_NAME=:vendor/:package
+cache:
+  apt: true
+  directories:
+    - $HOME/.composer/cache
+before_install:
+  - |
+    [[ $TEST_SUITE == "unit" ]] || (
+    curl -O https://artifacts.elastic.co/downloads/elasticsearch/elasticsearch-7.6.2-amd64.deb
+    sudo dpkg -i --force-confnew elasticsearch-7.6.2-amd64.deb
+    sudo chown -R elasticsearch:elasticsearch /etc/default/elasticsearch
+    sudo service elasticsearch restart
+    )
+before_script:
+  - |
+    sleep 10
+    [[ $COVERAGE == "true" ]] || phpenv config-rm xdebug.ini
+    ./.travis/before_script.sh
+script: phpunit -c magento2/dev/tests/$TEST_SUITE `[[ $COVERAGE == "true" ]] && echo "--coverage-text --coverage-clover=/tmp/coverage.clover"`
+after_script:
+  - |
+    [[ $COVERAGE == "true" ]] && wget https://scrutinizer-ci.com/ocular.phar
+    [[ $COVERAGE == "true" ]] && php ocular.phar code-coverage:upload --format=php-clover /tmp/coverage.clover

.travis/before_script.sh

@@ -0,0 +1,68 @@
+#!/usr/bin/env bash
+
+set -ex
+trap '>&2 echo Error: Command \`$BASH_COMMAND\` on line $LINENO failed with exit code $?' ERR
+
+# mock mail
+sudo service postfix stop
+echo # print a newline
+smtp-sink -d "%d.%H.%M.%S" localhost:2500 1000 &
+echo 'sendmail_path = "/usr/sbin/sendmail -t -i "' > ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/sendmail.ini
+
+# adjust memory limit
+echo 'memory_limit = -1' >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini
+phpenv rehash;
+
+composer selfupdate
+
+# clone main magento github repository
+git clone --branch $MAGENTO_VERSION --depth=1 https://github.com/magento/magento2
+
+# install Magento
+cd magento2
+
+# add composer package under test, composer require will trigger update/install
+composer config minimum-stability dev
+composer config repositories.travis_to_test git https://github.com/${TRAVIS_REPO_SLUG}.git
+if [ ! -z $TRAVIS_TAG  ]
+then
+    composer require ${COMPOSER_PACKAGE_NAME}:${TRAVIS_TAG}
+elif [ ! -z $TRAVIS_PULL_REQUEST_BRANCH ]
+then
+    # For pull requests, use the remote repository
+    composer config repositories.travis_to_test git https://github.com/${TRAVIS_PULL_REQUEST_SLUG}.git
+    composer require ${COMPOSER_PACKAGE_NAME}:dev-${TRAVIS_PULL_REQUEST_BRANCH}\#${TRAVIS_PULL_REQUEST_SHA}
+else
+    composer require ${COMPOSER_PACKAGE_NAME}:dev-${TRAVIS_BRANCH}\#${TRAVIS_COMMIT}
+fi
+
+# Add tests/src to autoload-dev on project level
+php -r '$composer_json = json_decode(file_get_contents("composer.json"), true);
+$composer_json["autoload-dev"]["psr-4"][":module-namespace\\:module-name\\"] = "vendor/:vendor/:package/src";
+file_put_contents("composer.json", json_encode($composer_json));'
+composer dumpautoload
+
+# prepare for test suite
+case $TEST_SUITE in
+    integration)
+        cp vendor/$COMPOSER_PACKAGE_NAME/tests/integration/phpunit.xml.dist dev/tests/integration/phpunit.xml
+
+        cd dev/tests/integration
+
+        # create database and move db config into place
+        mysql -uroot -e '
+            SET @@global.sql_mode = NO_ENGINE_SUBSTITUTION;
+            CREATE DATABASE magento_integration_tests;
+        '
+        cp etc/install-config-mysql.php.dist etc/install-config-mysql.php
+        # Remove AMQP configuration
+        sed -i '/amqp/d' etc/install-config-mysql.php
+        # Remove default root password
+        sed -i 's/123123q//' etc/install-config-mysql.php
+
+        cd ../../..
+    ;;
+    unit)
+        cp vendor/$COMPOSER_PACKAGE_NAME/tests/unit/phpunit.xml.dist dev/tests/unit/phpunit.xml
+    ;;
+esac

CHANGELOG.md

@@ -0,0 +1,11 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
+and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+### Added
+### Changed
+### Removed
+### Fixed

CONTRIBUTING.md

@@ -0,0 +1,64 @@
+# Contributing to :module-namespace_:module-name
+We love your input! We want to make contributing to this project as easy and transparent as possible, whether it's:
+
+- Reporting a bug
+- Discussing the current state of the code
+- Submitting a fix
+- Proposing new features
+- Becoming a maintainer
+
+## We Develop with Github
+We use github to host code, to track issues and feature requests, as well as accept pull requests.
+
+## We Use [Github Flow](https://guides.github.com/introduction/flow/index.html), So All Code Changes Happen Through Pull Requests
+Pull requests are the best way to propose changes to the codebase (we use [Github Flow](https://guides.github.com/introduction/flow/index.html)). We actively welcome your pull requests:
+
+1. Fork the repo and create your branch from `master`.
+2. If you've added code that should be tested, add tests.
+3. If you've changed APIs, update the documentation.
+4. Ensure the test suite passes.
+5. Make sure your code lints.
+6. Issue that pull request!
+
+## Any contributions you make will be under the MIT Software License
+In short, when you submit code changes, your submissions are understood to be under the same [MIT License](http://choosealicense.com/licenses/mit/) that covers the project. Feel free to contact the maintainers if that's a concern.
+
+## Report bugs using Github's [issues](https://github.com/:vendor/:package/issues)
+We use GitHub issues to track public bugs. Report a bug by [opening a new issue](https://github.com/:vendor/:package/issues/new); it's that easy!
+
+## Write bug reports with detail, background, and sample code
+[This is an example](http://stackoverflow.com/q/12488905/180626) of a bug report I wrote, and I think it's not a bad model. Here's [another example from Craig Hockenberry](http://www.openradar.me/11905408), an app developer whom I greatly respect.
+
+**Great Bug Reports** tend to have:
+
+- A quick summary and/or background
+- Steps to reproduce
+  - Be specific!
+  - Give sample code if you can. [My stackoverflow question](http://stackoverflow.com/q/12488905/180626) includes sample code that *anyone* with a base R setup can run to reproduce what I was seeing
+- What you expected would happen
+- What actually happens
+- Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)
+
+People *love* thorough bug reports. I'm not even kidding.
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+## License
+By contributing, you agree that your contributions will be licensed under its MIT License.
+
+## References
+This document was adapted from the open-source contribution guidelines for [Facebook's Draft](https://github.com/facebook/draft-js/blob/a9316a723f9e918afde44dea68b5f9f39b7d9b00/CONTRIBUTING.md) with additions from [ThePhpLeague Template](https://github.com/thephpleague/skeleton)

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) :year :company
+
+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.

README.md

@@ -0,0 +1,105 @@
+# ![/>](./dev/favicon.png) integer_net Magento 2 Module Template
+
+This is a GitHub template.
+
+**Create your module now with the "use this template" button:**
+
+[![Use this template](dev/use-this-template.png)](https://github.com/integer-net/magento2-module-template/generate)
+
+After that, clone it on your machine and run `/dev/init` for automatic configuration. For more information, see [dev/README.md](dev/README.md)
+
+<div align="center"><img src="https://www.integer-net.de/wp-content/uploads/2012/11/firmenprofil.jpg" alt="Waschbär Approved Module" /></div>
+
+---
+
+<!-- TEMPLATE -->
+
+# :module-namespace_:module-name Magento Module
+<div align="center">
+
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+![Supported Magento Versions][ico-compatibility]
+
+[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
+[![Quality Score][ico-code-quality]][link-code-quality]
+[![Maintainability][ico-maintainability]][link-maintainability]
+</div>
+
+---
+
+:description
+
+## Installation
+
+1. Install it into your Magento 2 project with composer:
+    ```
+    composer require :vendor/:package
+    ```
+
+2. Enable module
+    ```
+    bin/magento setup:upgrade
+    ```
+
+## Configuration
+
+## Usage
+
+## Changelog
+
+Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## Testing
+
+### Unit Tests
+
+```
+vendor/bin/phpunit tests/unit
+```
+
+### Magento Integration Tests
+
+0. Configure test database in `dev/tests/integration/etc/install-config-mysql.php`. [Read more in the Magento docs.](https://devdocs.magento.com/guides/v2.4/test/integration/integration_test_execution.html) 
+
+1. Copy `tests/integration/phpunit.xml.dist` from the package to `dev/tests/integration/phpunit.xml` in your Magento installation.
+
+2. In that directory, run
+    ``` bash
+    ../../../vendor/bin/phpunit
+    ```
+
+
+## Security
+
+If you discover any security related issues, please email :author-email instead of using the issue tracker.
+
+## Credits
+
+- [:author-name][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE) for more information.
+
+[ico-version]: https://img.shields.io/packagist/v/:vendor/:package.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/:vendor/:package/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/:vendor/:package?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/:vendor/:package.svg?style=flat-square
+[ico-maintainability]: https://img.shields.io/codeclimate/maintainability/:vendor/:package?style=flat-square
+[ico-compatibility]: https://img.shields.io/badge/magento-:version-badge-brightgreen.svg?logo=magento&longCache=true&style=flat-square
+
+[link-packagist]: https://packagist.org/packages/:vendor/:package
+[link-travis]: https://travis-ci.org/:vendor/:package
+[link-scrutinizer]: https://scrutinizer-ci.com/g/:vendor/:package/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/:vendor/:package
+[link-maintainability]: https://codeclimate.com/github/:vendor/:package
+[link-author]: https://github.com/:author-github
+[link-contributors]: ../../contributors