diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..0fedf1f --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to making participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +further defined and clarified by project maintainers. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported by contacting the project team at conduct@loadsys.com. All +complaints will be reviewed and investigated and will result in a response that +is deemed necessary and appropriate to the circumstances. The project team is +obligated to maintain confidentiality with regard to the reporter of an incident. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +members of the project's leadership. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, +available at [http://contributor-covenant.org/version/1/4][version] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/README.md b/README.md index 6c2d724..149617d 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,17 @@ Sets a `creator_id` and `modifier_id` on records during save using the logged in $ composer require loadsys/cakephp-creatormodifier:~1.0 ```` +In your `config/bootstrap.php` file, add: + +```php +Plugin::load('CreatorModifier', ['bootstrap' => false, 'routes' => false]); +``` + +OR + +```php +bin/cake plugin load CreatorModifier +``` ## Usage @@ -56,6 +67,10 @@ $this->addBehavior('CreatorModifier.CreatorModifier', [ ## Contributing +### Code of Conduct + +This project has adopted the Contributor Covenant as its [code of conduct](CODE_OF_CONDUCT.md). All contributors are expected to adhere to this code. [Translations are available](http://contributor-covenant.org/). + ### Reporting Issues Please use [GitHub Isuses](https://github.com/loadsys/CakePHP-CreatorModifier/issues) for listing any known defects or issues. @@ -64,6 +79,23 @@ Please use [GitHub Isuses](https://github.com/loadsys/CakePHP-CreatorModifier/is When developing this plugin, please fork and issue a PR for any new development. +Set up a working copy: +```shell +$ git clone git@github.com:YOUR_USERNAME/CakePHP-CreatorModifier.git +$ cd CakePHP-CreatorModifier/ +$ composer install +$ vendor/bin/phpcs --config-set installed_paths vendor/loadsys/loadsys_codesniffer,vendor/cakephp/cakephp-codesniffer +``` + +Make your changes: +```shell +$ git checkout -b your-topic-branch +# (Make your changes. Write some tests.) +$ vendor/bin/phpunit +$ vendor/bin/phpcs -p --extensions=php --standard=Loadsys ./src ./tests +``` + +Then commit and push your changes to your fork, and open a pull request. ## License @@ -72,4 +104,4 @@ When developing this plugin, please fork and issue a PR for any new development. ## Copyright -[Loadsys Web Strategies](http://www.loadsys.com) 2015 +[Loadsys Web Strategies](http://www.loadsys.com) 2016 diff --git a/tests/Fixture/UsersFixture.php b/tests/Fixture/UsersFixture.php index 14ece5c..9dea8b2 100644 --- a/tests/Fixture/UsersFixture.php +++ b/tests/Fixture/UsersFixture.php @@ -26,7 +26,7 @@ class UsersFixture extends TestFixture { ], '_options' => [ 'engine' => 'InnoDB', - 'collation' => 'utf8_general_ci' + 'collation' => 'utf8_general_ci', ], ]; // @codingStandardsIgnoreEnd @@ -43,7 +43,7 @@ class UsersFixture extends TestFixture { 'created' => '2014-09-02 16:45:55', 'creator_id' => '799763fd-32bc-11e4-9e39-080027506c76', 'modified' => '2014-09-02 16:45:55', - 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76' + 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76', ], [ 'id' => '799763fd-32bc-11e4-9e39-080027506c76', @@ -51,7 +51,7 @@ class UsersFixture extends TestFixture { 'created' => '2014-09-02 16:45:55', 'creator_id' => '799763fd-32bc-11e4-9e39-080027506c76', 'modified' => '2014-09-02 16:45:55', - 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76' + 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76', ], [ 'id' => '74708ed9-33b1-11e4-9e39-080027506c76', @@ -59,7 +59,7 @@ class UsersFixture extends TestFixture { 'created' => '2014-09-02 16:45:55', 'creator_id' => '799763fd-32bc-11e4-9e39-080027506c76', 'modified' => '2014-09-02 16:45:55', - 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76' + 'modifier_id' => '799763fd-32bc-11e4-9e39-080027506c76', ], ]; } diff --git a/tests/TestCase/Model/Behavior/CreatorModifierBehaviorTest.php b/tests/TestCase/Model/Behavior/CreatorModifierBehaviorTest.php index 0785b6e..258cfe6 100644 --- a/tests/TestCase/Model/Behavior/CreatorModifierBehaviorTest.php +++ b/tests/TestCase/Model/Behavior/CreatorModifierBehaviorTest.php @@ -53,7 +53,7 @@ public function setUp() { */ public function testImplementedEventsDefault() { $expected = [ - 'Model.beforeSave' => 'handleEvent' + 'Model.beforeSave' => 'handleEvent', ]; $this->assertEquals($expected, $this->Behavior->implementedEvents()); } @@ -69,7 +69,7 @@ public function testImplementedEventsCustom() { $this->Behavior = new CreatorModifierBehavior($table, $settings); $expected = [ - 'Something.special' => 'handleEvent' + 'Something.special' => 'handleEvent', ]; $this->assertEquals($expected, $this->Behavior->implementedEvents()); } @@ -259,8 +259,8 @@ public function testCreatedOrModifiedNoop() { 'events' => [ 'Model.beforeSave' => [ 'created' => 'new', - ] - ] + ], + ], ]; $this->Behavior = $this->getMock(