From 433dc87d6735a6c3db48e35a72d72f2ccb308c4f Mon Sep 17 00:00:00 2001 From: Joni Eskelinen Date: Mon, 20 May 2019 13:00:27 +0300 Subject: [PATCH] Update docs --- .editorconfig | 2 +- .gitignore | 16 +++++++++--- .scrutinizer.yml | 30 ++++++++++++++-------- .travis.yml | 4 +-- LICENSE | 2 +- README.md | 20 +++++++-------- composer.json | 66 ++++++++++++++++++++++++------------------------ phpunit.xml.dist | 52 ++++++++++++++++++-------------------- 8 files changed, 103 insertions(+), 89 deletions(-) diff --git a/.editorconfig b/.editorconfig index 0a4d7c6..a59b091 100644 --- a/.editorconfig +++ b/.editorconfig @@ -2,5 +2,5 @@ tab_width = 4 end_of_line = lf -[*.{php}] +[*.{php,json,xml.dist}] indent_style = space diff --git a/.gitignore b/.gitignore index a8aa02b..58dbe73 100644 --- a/.gitignore +++ b/.gitignore @@ -1,15 +1,23 @@ -# eclipse project files +# Eclipse project files /.settings/ /.buildpath /.project /.pydevproject -# build +# VS Code +/.vscode + +# build files /build/ +/.*.cache -# composer +# Composer /vendor/ /composer.lock +# non-dist files +/phpunit.xml +/.php_cs + # sandbox -/demo/ +/demo/ \ No newline at end of file diff --git a/.scrutinizer.yml b/.scrutinizer.yml index 37fad01..71e53d5 100644 --- a/.scrutinizer.yml +++ b/.scrutinizer.yml @@ -1,17 +1,27 @@ build: + nodes: + analysis: + tests: + override: + - php-scrutinizer-run + tests-and-coverage: + requires: + - node: analysis + tests: + override: + - command: vendor/bin/phpunit + coverage: + format: clover + file: build/logs/clover.xml environment: php: - version: 7.0.20 - tests: - override: - - command: vendor/bin/phpunit - coverage: - format: php-clover - file: build/logs/clover.xml + version: 7.0 +filter: + excluded_paths: + - test/ + dependency_paths: + - vendor/ checks: php: code_rating: true duplication: false -filter: - excluded_paths: - - test/ \ No newline at end of file diff --git a/.travis.yml b/.travis.yml index e8d22dc..76c05c2 100644 --- a/.travis.yml +++ b/.travis.yml @@ -6,6 +6,6 @@ php: - "7.3" before_script: - "composer install" - - "composer require satooshi/php-coveralls" + - "composer require php-coveralls/php-coveralls" after_success: - - "travis_retry php vendor/bin/coveralls -v" + - "travis_retry php vendor/bin/php-coveralls -v" diff --git a/LICENSE b/LICENSE index 5cd24d0..146b5cf 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016-2017 Joni Eskelinen +Copyright (c) 2016-2019 Joni Eskelinen Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index b6ef5e8..73688f1 100644 --- a/README.md +++ b/README.md @@ -1,14 +1,14 @@ -[![Build Status](https://travis-ci.org/sop/crypto-bridge.svg?branch=master)](https://travis-ci.org/sop/crypto-bridge) -[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sop/crypto-bridge/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/sop/crypto-bridge/?branch=master) -[![Coverage Status](https://coveralls.io/repos/github/sop/crypto-bridge/badge.svg?branch=master)](https://coveralls.io/github/sop/crypto-bridge?branch=master) -[![License](https://poser.pugx.org/sop/crypto-bridge/license)](https://github.com/sop/crypto-bridge/blob/master/LICENSE) - # CryptoBridge +[![Build Status](https://travis-ci.org/sop/crypto-bridge.svg?branch=php70)](https://travis-ci.org/sop/crypto-bridge) +[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/sop/crypto-bridge/badges/quality-score.png?b=php70)](https://scrutinizer-ci.com/g/sop/crypto-bridge/?branch=php70) +[![Coverage Status](https://coveralls.io/repos/github/sop/crypto-bridge/badge.svg?branch=php70)](https://coveralls.io/github/sop/crypto-bridge?branch=php70) +[![License](https://poser.pugx.org/sop/crypto-bridge/license)](https://github.com/sop/crypto-bridge/blob/php70/LICENSE) + A PHP library providing cryptography support for various PKCS applications. -Defines an interface with encrypt / decrypt and -signature signing / verification methods. +Defines an interface with encrypt / decrypt and signature +signing / verification methods. Currently only OpenSSL backend is supported. Key and algorithm information is passed in ASN.1 types implemented in @@ -16,9 +16,9 @@ Key and algorithm information is passed in ASN.1 types implemented in ## Requirements -- PHP >=7.0 -- openssl -- [sop/crypto-types](https://github.com/sop/crypto-types) +- PHP >=7.0 +- openssl +- [sop/crypto-types](https://github.com/sop/crypto-types) ## Installation diff --git a/composer.json b/composer.json index 5e2307c..4be1baa 100644 --- a/composer.json +++ b/composer.json @@ -1,35 +1,35 @@ { - "name": "sop/crypto-bridge", - "description": "A PHP library providing cryptography support for various PKCS applications.", - "homepage": "https://github.com/sop/crypto-bridge", - "license": "MIT", - "type": "library", - "keywords": [ - "pkcs", - "cryptography", - "encrypt", - "decrypt", - "sign", - "verify" - ], - "authors": [ - { - "name": "Joni Eskelinen", - "email": "jonieske@gmail.com", - "role": "Developer" - } - ], - "require": { - "php": ">=7.0", - "ext-openssl": "*", - "sop/crypto-types": "^0.2.0" - }, - "require-dev": { - "phpunit/phpunit": "^6.4" - }, - "autoload": { - "psr-4": { - "Sop\\CryptoBridge\\" : "lib/CryptoBridge" - } - } + "name": "sop/crypto-bridge", + "description": "A PHP library providing cryptography support for various PKCS applications.", + "homepage": "https://github.com/sop/crypto-bridge", + "license": "MIT", + "type": "library", + "keywords": [ + "pkcs", + "cryptography", + "encrypt", + "decrypt", + "sign", + "verify" + ], + "authors": [ + { + "name": "Joni Eskelinen", + "email": "jonieske@gmail.com", + "role": "Developer" + } + ], + "require": { + "php": ">=7.0", + "ext-openssl": "*", + "sop/crypto-types": "^0.2.0" + }, + "require-dev": { + "phpunit/phpunit": "^6.5" + }, + "autoload": { + "psr-4": { + "Sop\\CryptoBridge\\": "lib/CryptoBridge" + } + } } \ No newline at end of file diff --git a/phpunit.xml.dist b/phpunit.xml.dist index f17fbe6..72f7f2d 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -1,30 +1,26 @@ - - - - test/unit - - - - - lib - - - - - - + + + + test/unit + + + + + lib + + + + + + \ No newline at end of file