Merge pull request #14 from UseMuffin/cake-3

Cake 3

Author: ADmad

.travis.yml

@@ -1,18 +1,19 @@
 language: php
 
 php:
-  - 5.4
-  - 5.5
   - 5.6
-  - 7
+  - 7.2
+  - 7.3
 
-sudo: false
+services:
+  - mysql
+  - postgresql
 
 env:
   matrix:
-    - DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
-    - DB=pgsql db_dsn='postgres://postgres@127.0.0.1/cakephp_test'
     - DB=sqlite db_dsn='sqlite:///:memory:'
+    - DB=mysql db_dsn='mysql://root@127.0.0.1/cakephp_test?init[]=SET sql_mode = "STRICT_TRANS_TABLES,NO_ZERO_IN_DATE,NO_ZERO_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"'
+    - DB=pgsql db_dsn='postgres://postgres@127.0.0.1/cakephp_test'
 
   global:
     - DEFAULT=1
@@ -21,33 +22,31 @@ matrix:
   fast_finish: true
 
   include:
-    - php: 5.4
+    - php: 7.3
       env: PHPCS=1 DEFAULT=0
 
-    - php: 7
-      env: COVERALLS=1 DEFAULT=0 DB=mysql db_dsn='mysql://travis@0.0.0.0/cakephp_test'
+    - php: 5.6
+      env: PREFER_LOWEST=1
 
 before_script:
-  - sh -c "if [ '$COVERALLS' != '1' ]; then phpenv config-rm xdebug.ini; fi"
-
-  - composer self-update
-  - composer install --prefer-dist --no-interaction
+  - if [[ $TRAVIS_PHP_VERSION != 7.2 ]]; then phpenv config-rm xdebug.ini; fi
 
-  - sh -c "if [ '$DB' = 'mysql' ]; then mysql -e 'CREATE DATABASE cakephp_test;'; fi"
-  - sh -c "if [ '$DB' = 'pgsql' ]; then psql -c 'CREATE DATABASE cakephp_test;' -U postgres; fi"
+  - if [[ $PREFER_LOWEST != 1 ]]; then composer install --no-interaction; fi
+  - if [[ $PREFER_LOWEST == 1 ]]; then composer update --no-interaction --prefer-lowest --prefer-stable; fi
 
-  - sh -c "if [ '$PHPCS' = '1' ]; then composer require cakephp/cakephp-codesniffer:dev-master; fi"
+  - if [[ $DB == 'mysql' ]]; then mysql -e 'CREATE DATABASE cakephp_test;'; fi
+  - if [[ $DB == 'pgsql' ]]; then psql -c 'CREATE DATABASE cakephp_test;' -U postgres; fi
 
-  - sh -c "if [ '$COVERALLS' = '1' ]; then composer require --dev satooshi/php-coveralls:dev-master; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then mkdir -p build/logs; fi"
+  - if [[ $PHPCS == '1' ]]; then composer require cakephp/cakephp-codesniffer:^3.0; fi
 
 script:
-  - sh -c "if [ '$DEFAULT' = '1' ]; then ./vendor/bin/phpunit; fi"
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION == 7.2 ]]; then vendor/bin/phpunit --coverage-clover=clover.xml; fi
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION != 7.2 ]]; then vendor/bin/phpunit; fi
 
-  - sh -c "if [ '$PHPCS' = '1' ]; then ./vendor/bin/phpcs -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi"
+  - if [[ $PHPCS == 1 ]]; then vendor/bin/phpcs -p --extensions=php --standard=vendor/cakephp/cakephp-codesniffer/CakePHP ./src ./tests; fi
 
-  - sh -c "if [ '$COVERALLS' = '1' ]; then ./vendor/bin/phpunit --coverage-clover build/logs/clover.xml; fi"
-  - sh -c "if [ '$COVERALLS' = '1' ]; then vendor/bin/coveralls -v; fi"
+after_success:
+  - if [[ $DEFAULT == 1 && $TRAVIS_PHP_VERSION == 7.2 ]]; then bash <(curl -s https://codecov.io/bash); fi
 
 notifications:
   email: false

README.md

@@ -1,36 +1,26 @@
 # Obfuscate
 
 [![Build Status](https://img.shields.io/travis/UseMuffin/Obfuscate/master.svg?style=flat-square)](https://travis-ci.org/UseMuffin/Obfuscate)
-[![Coverage](https://img.shields.io/coveralls/UseMuffin/Obfuscate/master.svg?style=flat-square)](https://coveralls.io/r/UseMuffin/Obfuscate)
+[![Coverage](https://img.shields.io/codecov/c/github/UseMuffin/Obfuscate.svg?style=flat-square)](https://codecov.io/github/UseMuffin/Obfuscate)
 [![Total Downloads](https://img.shields.io/packagist/dt/muffin/obfuscate.svg?style=flat-square)](https://packagist.org/packages/muffin/obfuscate)
 [![License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat-square)](LICENSE)
 
-Primary key obfuscation for CakePHP 3 using HashIds, Optimus, Tiny and/or custom obfuscation strategies.
-
-## Requirements
-
-- CakePHP 3.0+
+Primary key obfuscation for CakePHP using HashIds, Optimus, Tiny and/or custom obfuscation strategies.
 
 ## Installation
 
 Install the plugin using [Composer](https://getcomposer.org):
 
 ```
-composer require muffin/obfuscate:1.0.x-dev
+composer require muffin/obfuscate
 ```
 
-You then need to load the plugin by either running this shell command:
+Load the plugin by either running this console command:
 
 ```
 bin/cake plugin load Muffin/Obfuscate
 ```
 
-or by manually adding the following line to ``config/bootstrap.php``:
-
-```php
-Plugin::load('Muffin/Obfuscate');
-```
-
 Lastly, composer install (any combination of) the obfuscation libraries you
 want to use in your application:
 

composer.json

@@ -1,6 +1,6 @@
 {
     "name": "muffin/obfuscate",
-    "description": "CakePHP 3 support for ID obfuscation",
+    "description": "CakePHP support for ID obfuscation",
     "type": "cakephp-plugin",
     "keywords": [
         "cakephp",
@@ -31,13 +31,14 @@
         "source": "https://github.com/usemuffin/obfuscate"
     },
     "require": {
+        "cakephp/orm": "^3.5"
     },
     "require-dev": {
-        "cakephp/cakephp": "~3.0",
-        "phpunit/phpunit": "<6.0",
-        "zackkitzmiller/tiny": "1.2.0",
-        "jenssegers/optimus": "0.2.0",
-        "hashids/hashids": "1.0.5"
+        "cakephp/cakephp": "^3.5",
+        "phpunit/phpunit": "^5.7.14|^6.0",
+        "zackkitzmiller/tiny": "^1.2",
+        "jenssegers/optimus": "^0.2",
+        "hashids/hashids": "^1.0.5"
     },
     "suggest": {
         "zackkitzmiller/tiny": "A reversible base62 ID obfuscater",
@@ -53,10 +54,5 @@
         "psr-4": {
             "Muffin\\Obfuscate\\Test\\": "tests"
         }
-    },
-    "extra": {
-        "branch-alias": {
-            "dev-master": "1.0.x-dev"
-        }
     }
 }

src/Model/Behavior/ObfuscateBehavior.php

@@ -24,7 +24,7 @@ class ObfuscateBehavior extends Behavior
         'strategy' => null,
         'implementedFinders' => [
             'obfuscated' => 'findObfuscated',
-            'obfuscate' => 'findObfuscate'
+            'obfuscate' => 'findObfuscate',
         ],
         'implementedMethods' => [
             'obfuscate' => 'obfuscate',
@@ -50,7 +50,8 @@ public function initialize(array $config)
      */
     public function verifyConfig()
     {
-        if (!$strategy = $this->config('strategy')) {
+        $strategy = $this->getConfig('strategy');
+        if (!$strategy) {
             throw new Exception('Missing required obfuscation strategy.');
         }
 
@@ -73,9 +74,9 @@ public function verifyConfig()
      */
     public function afterSave(Event $event, EntityInterface $entity, ArrayObject $options)
     {
-        $pk = $this->_table->primaryKey();
+        $pk = $this->_table->getPrimaryKey();
         $entity->set($pk, $this->obfuscate($entity->{$pk}));
-        $entity->dirty($pk, false);
+        $entity->setDirty($pk, false);
     }
 
     /**
@@ -94,8 +95,9 @@ public function beforeFind(Event $event, Query $query, ArrayObject $options, $pr
         }
 
         $query->traverseExpressions(function ($expression) {
-            $pk = $this->_table->primaryKey();
-            if (method_exists($expression, 'getField')
+            $pk = $this->_table->getPrimaryKey();
+            if (
+                method_exists($expression, 'getField')
                 && in_array($expression->getField(), [$pk, $this->_table->aliasField($pk)])
             ) {
                 $expression->setValue($this->elucidate($expression->getValue()));
@@ -105,8 +107,8 @@ public function beforeFind(Event $event, Query $query, ArrayObject $options, $pr
         });
 
         foreach ($this->_table->associations() as $association) {
-            if ($association->target()->hasBehavior('Obfuscate') && 'all' === $association->finder()) {
-                $association->finder('obfuscate');
+            if ($association->getTarget()->hasBehavior('Obfuscate') && $association->getFinder() === 'all') {
+                $association->setFinder('obfuscate');
             }
         }
     }
@@ -136,7 +138,7 @@ public function findObfuscate(Query $query, array $options)
 
         $query->formatResults(function ($results) {
             return $results->map(function ($row) {
-                $pk = $this->_table->primaryKey();
+                $pk = $this->_table->getPrimaryKey();
                 $row[$pk] = $this->obfuscate($row[$pk]);
 
                 return $row;
@@ -175,6 +177,6 @@ public function elucidate($str)
      */
     public function strategy()
     {
-        return $this->config('strategy');
+        return $this->getConfig('strategy');
     }
 }

tests/Fixture/ArticlesFixture.php

@@ -18,7 +18,7 @@ class ArticlesFixture extends TestFixture
         'title' => ['type' => 'string', 'null' => false],
         'created' => ['type' => 'datetime', 'null' => true],
         'modified' => ['type' => 'datetime', 'null' => true],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**

tests/Fixture/ArticlesTagsFixture.php

@@ -16,7 +16,7 @@ class ArticlesTagsFixture extends TestFixture
         'id' => ['type' => 'integer'],
         'obfuscate_article_id' => ['type' => 'integer'],
         'tag_id' => ['type' => 'integer'],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**

tests/Fixture/AuthorsFixture.php

@@ -17,7 +17,7 @@ class AuthorsFixture extends TestFixture
         'name' => ['type' => 'string', 'null' => false],
         'created' => ['type' => 'datetime', 'null' => true],
         'modified' => ['type' => 'datetime', 'null' => true],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**

tests/Fixture/CommentsFixture.php

@@ -18,7 +18,7 @@ class CommentsFixture extends TestFixture
         'title' => ['type' => 'string', 'null' => false],
         'created' => ['type' => 'datetime', 'null' => true],
         'modified' => ['type' => 'datetime', 'null' => true],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**

tests/Fixture/TagsFixture.php

@@ -17,7 +17,7 @@ class TagsFixture extends TestFixture
         'name' => ['type' => 'string', 'null' => false],
         'created' => ['type' => 'datetime', 'null' => true],
         'modified' => ['type' => 'datetime', 'null' => true],
-        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]]
+        '_constraints' => ['primary' => ['type' => 'primary', 'columns' => ['id']]],
     ];
 
     /**

tests/TestCase/Model/Behavior/ObfuscateBehaviorTest.php

@@ -50,7 +50,7 @@ public function setUp()
         $this->Articles->belongsToMany('Muffin/Obfuscate.Tags', [
             'foreignKey' => 'obfuscate_article_id',
             'joinTable' => 'obfuscate_articles_tags',
-            'through' => TableRegistry::get('Muffin/Obfuscate.ArticlesTags', ['table' => 'obfuscate_articles_tags'])
+            'through' => TableRegistry::get('Muffin/Obfuscate.ArticlesTags', ['table' => 'obfuscate_articles_tags']),
         ]);
 
         $this->Obfuscate = $this->Articles->behaviors()->Obfuscate;
@@ -76,7 +76,7 @@ public function testAfterSave()
         $entity = new Entity(['id' => 5, 'title' => 'foo']);
         $this->Articles->save($entity);
         $this->assertEquals('E', $entity['id']);
-        $this->assertFalse($entity->dirty('id'));
+        $this->assertFalse($entity->isDirty('id'));
     }
 
     /**
@@ -86,9 +86,9 @@ public function testAfterSave()
     public function testFindObfuscate()
     {
         $result = $this->Articles->find('obfuscate')->contain([
-            $this->Authors->alias(),
-            $this->Comments->alias(),
-            $this->Tags->alias(),
+            $this->Authors->getAlias(),
+            $this->Comments->getAlias(),
+            $this->Tags->getAlias(),
         ])->first();
 
         $this->assertEquals('S', $result['author']['id']);
@@ -104,9 +104,9 @@ public function testFindObfuscate()
     public function testFindWithoutObfuscate()
     {
         $result = $this->Articles->find()->contain([
-            $this->Authors->alias(),
-            $this->Comments->alias(),
-            $this->Tags->alias(),
+            $this->Authors->getAlias(),
+            $this->Comments->getAlias(),
+            $this->Tags->getAlias(),
         ])->first();
 
         $this->assertEquals('1', $result['author']['id']);
@@ -148,8 +148,4 @@ public function testElucidate()
     {
         $this->assertEquals(1, $this->Articles->elucidate('S'));
     }
-
-    public function testStrategy()
-    {
-    }
 }