refactor Common/GPM namespace for more unified approach to installed vs remote packages

system/src/Grav/Common/GPM/AbstractCollection.php

@@ -1,19 +1,19 @@
 <?php
-namespace Grav\Common\GPM\Local;
+namespace Grav\Common\GPM;
 
 use Grav\Common\GravTrait;
 use Grav\Common\Iterator;
 
-class Collection extends Iterator
-{
+abstract class AbstractCollection extends Iterator {
+
     use GravTrait;
 
     public function toJson()
     {
         $items = [];
 
-        foreach ($this->items as $name => $theme) {
-            $items[$name] = $theme->toArray();
+        foreach ($this->items as $name => $package) {
+            $items[$name] = $package->toArray();
         }
 
         return json_encode($items);
@@ -23,8 +23,8 @@ class Collection extends Iterator
     {
         $items = [];
 
-        foreach ($this->items as $name => $theme) {
-            $items[$name] = $theme->toArray();
+        foreach ($this->items as $name => $package) {
+            $items[$name] = $package->toArray();
         }
 
         return $items;

system/src/Grav/Common/GPM/Common/AbstractPackageCollection.php

@@ -0,0 +1,34 @@
+<?php
+namespace Grav\Common\GPM\Common;
+
+use Grav\Common\GravTrait;
+use Grav\Common\Iterator;
+
+abstract class AbstractPackageCollection extends Iterator {
+
+    use GravTrait;
+
+    protected $type;
+
+    public function toJson()
+    {
+        $items = [];
+
+        foreach ($this->items as $name => $package) {
+            $items[$name] = $package->toArray();
+        }
+
+        return json_encode($items);
+    }
+
+    public function toArray()
+    {
+        $items = [];
+
+        foreach ($this->items as $name => $package) {
+            $items[$name] = $package->toArray();
+        }
+
+        return $items;
+    }
+}

system/src/Grav/Common/GPM/Common/CachedCollection.php

@@ -0,0 +1,21 @@
+<?php
+namespace Grav\Common\GPM\Common;
+
+use Grav\Common\Iterator;
+
+class CachedCollection extends Iterator {
+
+    protected static $cache;
+
+    public function __construct($items)
+    {
+        // local cache to speed things up
+        if (!isset(self::$cache[get_called_class().__METHOD__])) {
+            self::$cache[get_called_class().__METHOD__] = $items;
+        }
+
+        foreach (self::$cache[get_called_class().__METHOD__] as $name => $item) {
+            $this->append([$name => $item]);
+        }
+    }
+}

system/src/Grav/Common/GPM/Common/Package.php

@@ -0,0 +1,42 @@
+<?php
+namespace Grav\Common\GPM\Common;
+
+use Grav\Common\Data\Data;
+
+class Package {
+
+    protected $data;
+
+    public function __construct(Data $package, $type = null) {
+        $this->data = $package;
+
+        if ($type) {
+            $this->data->set('package_type', $type);
+        }
+    }
+
+    public function getData() {
+        return $this->data;
+    }
+
+    public function __get($key) {
+        return $this->data->get($key);
+    }
+
+    public function __isset($key) {
+        return isset($this->data->$key);
+    }
+
+    public function __toString() {
+        return $this->toJson();
+    }
+
+    public function toJson() {
+        return $this->data->toJson();
+    }
+
+    public function toArray() {
+        return $this->data->toArray();
+    }
+
+}

system/src/Grav/Common/GPM/Local/AbstractPackageCollection.php

@@ -0,0 +1,16 @@
+<?php
+
+namespace Grav\Common\GPM\Local;
+
+use Grav\Common\GPM\Common\AbstractPackageCollection as BaseCollection;
+use Grav\Common\GPM\Local\Package;
+
+abstract class AbstractPackageCollection extends BaseCollection {
+
+    public function __construct($items)
+    {
+        foreach ($items as $name => $data) {
+            $this->items[$name] = new Package($data, $this->type);
+        }
+    }
+}

system/src/Grav/Common/GPM/Local/Package.php

@@ -2,39 +2,24 @@
 namespace Grav\Common\GPM\Local;
 
 use Grav\Common\Data\Data;
+use Grav\Common\GPM\Common\Package as BasePackage;
 
-/**
- * Class Package
- * @package Grav\Common\GPM\Local
- */
-class Package
+class Package extends BasePackage
 {
-    /**
-     * @var Data
-     */
-    protected $data;
-    /**
-     * @var \Grav\Common\Data\Blueprint
-     */
-    protected $blueprints;
+    protected $settings;
 
-    /**
-     * @param Data $package
-     * @param bool $package_type
-     */
-    public function __construct(Data $package, $package_type = false)
+    public function __construct(Data $package, $package_type = null)
     {
-        $this->data       = $package;
-        $this->blueprints = $this->data->blueprints();
+        $data = new Data($package->blueprints()->toArray());
+        parent::__construct($data, $package_type);
 
-        if ($package_type) {
-            $html_description = \Parsedown::instance()->line($this->blueprints->get('description'));
-            $this->blueprints->set('package_type', $package_type);
-            $this->blueprints->set('slug', $this->blueprints->name);
-            $this->blueprints->set('description_html', $html_description);
-            $this->blueprints->set('description_plain', strip_tags($html_description));
-            $this->blueprints->set('symlink', is_link(USER_DIR . $package_type . DS . $this->blueprints->name));
-        }
+        $this->settings = $package->toArray();
+
+        $html_description = \Parsedown::instance()->line($this->description);
+        $this->data->set('slug', $this->name);
+        $this->data->set('description_html', $html_description);
+        $this->data->set('description_plain', strip_tags($html_description));
+        $this->data->set('symlink', is_link(USER_DIR . $package_type . DS . $this->name));
     }
 
     /**
@@ -42,47 +27,6 @@ class Package
      */
     public function isEnabled()
     {
-        return $this->data['enabled'];
-    }
-
-    /**
-     * @return Data
-     */
-    public function getData()
-    {
-        return $this->data;
-    }
-
-    /**
-     * @param $key
-     * @return mixed
-     */
-    public function __get($key)
-    {
-        return $this->blueprints->get($key);
-    }
-
-    /**
-     * @return string
-     */
-    public function __toString()
-    {
-        return $this->toJson();
-    }
-
-    /**
-     * @return string
-     */
-    public function toJson()
-    {
-        return $this->blueprints->toJson();
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray()
-    {
-        return $this->blueprints->toArray();
+        return $this->settings['enabled'];
     }
 }

system/src/Grav/Common/GPM/Local/Packages.php

@@ -1,28 +1,17 @@
 <?php
 namespace Grav\Common\GPM\Local;
 
-use Grav\Common\Iterator;
+use Grav\Common\GPM\Common\CachedCollection;
 
-class Packages extends Iterator
+class Packages extends CachedCollection
 {
-    private $plugins;
-    private $themes;
-    protected static $cache;
-
     public function __construct()
     {
-        // local cache to speed things up
-        if (!isset(self::$cache[__METHOD__])) {
-            self::$cache[__METHOD__] = [
-                'plugins' => new Plugins(),
-                'themes'  => new Themes()
-            ];
-        }
+        $items = [
+            'plugins' => new Plugins(),
+            'themes' => new Themes()
+        ];
 
-        $this->plugins = self::$cache[__METHOD__]['plugins'];
-        $this->themes  = self::$cache[__METHOD__]['themes'];
-
-        $this->append(['plugins' => $this->plugins]);
-        $this->append(['themes' => $this->themes]);
+        parent::__construct($items);
     }
 }

system/src/Grav/Common/GPM/Local/Plugins.php

@@ -5,22 +5,18 @@ namespace Grav\Common\GPM\Local;
  * Class Plugins
  * @package Grav\Common\GPM\Local
  */
-class Plugins extends Collection
+class Plugins extends AbstractPackageCollection
 {
     /**
      * @var string
      */
-    private $type = 'plugins';
+    protected $type = 'plugins';
 
     /**
      * Local Plugins Constructor
      */
     public function __construct()
     {
-        $grav = self::getGrav();
-
-        foreach ($grav['plugins']->all() as $name => $data) {
-            $this->items[$name] = new Package($data, $this->type);
-        }
+        parent::__construct(self::getGrav()['plugins']->all());
     }
 }

system/src/Grav/Common/GPM/Local/Themes.php

@@ -1,15 +1,22 @@
 <?php
 namespace Grav\Common\GPM\Local;
 
-class Themes extends Collection
+/**
+ * Class Themes
+ * @package Grav\Common\GPM\Local
+ */
+class Themes extends AbstractPackageCollection
 {
-    private $type = 'themes';
+    /**
+     * @var string
+     */
+    protected $type = 'themes';
+
+    /**
+     * Local Themes Constructor
+     */
     public function __construct()
     {
-        $grav = self::getGrav();
-
-        foreach ($grav['themes']->all() as $name => $data) {
-            $this->items[$name] = new Package($data, $this->type);
-        }
+        parent::__construct(self::getGrav()['themes']->all());
     }
 }

system/src/Grav/Common/GPM/PackageInterface.php

@@ -0,0 +1,58 @@
+<?php
+namespace Grav\Common\GPM;
+
+use Grav\Common\Data\Data;
+
+/**
+ * Interface Package
+ * @package Grav\Common\GPM
+ */
+class Package
+{
+    /**
+     * @var Data
+     */
+    protected $data;
+
+    /**
+     * @var \Grav\Common\Data\Blueprint
+     */
+    protected $blueprints;
+
+    /**
+     * @param Data $package
+     * @param bool $package_type
+     */
+    public function __construct(Data $package, $package_type = false);
+
+    /**
+     * @return mixed
+     */
+    public function isEnabled();
+
+    /**
+     * @return Data
+     */
+    public function getData();
+
+    /**
+     * @param $key
+     * @return mixed
+     */
+    public function __get($key);
+
+    /**
+     * @return string
+     */
+    public function __toString();
+
+    /**
+     * @return string
+     */
+    public function toJson();
+
+    /**
+     * @return array
+     */
+    public function toArray();
+}

system/src/Grav/Common/GPM/Remote/AbstractPackageCollection.php

@@ -1,15 +1,13 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
+use Grav\Common\GPM\Common\AbstractPackageCollection as BaseCollection;
 use Grav\Common\GPM\Response;
-use Grav\Common\GravTrait;
-use Grav\Common\Iterator;
-use \Doctrine\Common\Cache\Cache as DoctrineCache;
+
 use \Doctrine\Common\Cache\FilesystemCache;
 
-class Collection extends Iterator {
-    use GravTrait;
-
+class AbstractPackageCollection extends BaseCollection
+{
     /**
      * The cached data previously fetched
      * @var string
@@ -21,13 +19,15 @@ class Collection extends Iterator {
      * @var integer
      */
     private $lifetime = 86400;
-    private $repository;
-    private $cache;
 
-    public function __construct($repository = null)
+    protected $repository;
+
+    protected $cache;
+
+    public function __construct($repository = null, $refresh = false, $callback = null)
     {
         if ($repository === null) {
-            throw new \RuntimeException("A repository is required for storing the cache");
+            throw new \RuntimeException("A repository is required to indicate the origin of the remote collection");
         }
 
         $cache_dir = self::getGrav()['locator']->findResource('cache://gpm', true, true);
@@ -35,28 +35,11 @@ class Collection extends Iterator {
 
         $this->repository = $repository;
         $this->raw        = $this->cache->fetch(md5($this->repository));
-    }
 
-    public function toJson()
-    {
-        $items = [];
-
-        foreach ($this->items as $name => $theme) {
-            $items[$name] = $theme->toArray();
+        $this->fetch($refresh, $callback);
+        foreach (json_decode($this->raw, true) as $slug => $data) {
+            $this->items[$slug] = new Package($data, $this->type);
         }
-
-        return json_encode($items);
-    }
-
-    public function toArray()
-    {
-        $items = [];
-
-        foreach ($this->items as $name => $theme) {
-            $items[$name] = $theme->toArray();
-        }
-
-        return $items;
     }
 
     public function fetch($refresh = false, $callback = null)

system/src/Grav/Common/GPM/Remote/Grav.php

@@ -1,9 +1,11 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
-class Grav extends Collection
+use \Doctrine\Common\Cache\FilesystemCache;
+
+class Grav extends AbstractPackageCollection
 {
-    private $repository = 'http://getgrav.org/downloads/grav.json';
+    protected $repository = 'http://getgrav.org/downloads/grav.json';
     private $data;
 
     private $version;
@@ -15,15 +17,17 @@ class Grav extends Collection
      */
     public function __construct($refresh = false, $callback = null)
     {
-        parent::__construct($this->repository);
+        $cache_dir      = self::getGrav()['locator']->findResource('cache://gpm', true, true);
+        $this->cache    = new FilesystemCache($cache_dir);
+        $this->raw      = $this->cache->fetch(md5($this->repository));
 
         $this->fetch($refresh, $callback);
-        $this->data = json_decode($this->raw);
 
-        $this->version = @$this->data->version ?: '-';
-        $this->date = @$this->data->date ?: '-';
+        $this->data = json_decode($this->raw, true);
+        $this->version = @$this->data['version'] ?: '-';
+        $this->date = @$this->data['date'] ?: '-';
 
-        foreach ($this->data->assets as $slug => $data) {
+        foreach ($this->data['assets'] as $slug => $data) {
             $this->items[$slug] = new Package($data);
         }
     }

system/src/Grav/Common/GPM/Remote/Package.php

@@ -1,32 +1,12 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
-class Package {
-    public function __construct($package, $package_type = false) {
-        $this->data = $package;
-        if ($package_type) {
-            $this->data->package_type = $package_type;
-        }
-    }
+use Grav\Common\Data\Data;
+use Grav\Common\GPM\Common\Package as BasePackage;
 
-    public function getData() {
-        return $this->data;
+class Package extends BasePackage {
+    public function __construct($package, $package_type = null) {
+        $data = new Data($package);
+        parent::__construct($data, $package_type);
     }
-
-    public function __get($key) {
-        return $this->data->$key;
-    }
-
-    public function __toString() {
-        return $this->toJson();
-    }
-
-    public function toJson() {
-        return json_encode($this->data);
-    }
-
-    public function toArray() {
-        return $this->data;
-    }
-
 }

system/src/Grav/Common/GPM/Remote/Packages.php

@@ -1,28 +1,17 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
-use Grav\Common\Iterator;
+use Grav\Common\GPM\Common\CachedCollection;
 
-class Packages extends Iterator
+class Packages extends CachedCollection
 {
-    private $plugins;
-    private $themes;
-    protected static $cache;
-
     public function __construct($refresh = false, $callback = null)
     {
-        // local cache to speed things up
-        if (!isset(self::$cache[__METHOD__])) {
-            self::$cache[__METHOD__] = [
-                'plugins' => new Plugins($refresh, $callback),
-                'themes'  => new Themes($refresh, $callback)
-            ];
-        }
+        $items = [
+            'plugins' => new Plugins($refresh, $callback),
+            'themes' => new Themes($refresh, $callback)
+        ];
 
-        $this->plugins = self::$cache[__METHOD__]['plugins']->toArray();
-        $this->themes  = self::$cache[__METHOD__]['themes']->toArray();
-
-        $this->append(['plugins' => $this->plugins]);
-        $this->append(['themes' => $this->themes]);
+        parent::__construct($items);
     }
 }

system/src/Grav/Common/GPM/Remote/Plugins.php

@@ -1,21 +1,24 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
-class Plugins extends Collection
+/**
+ * Class Plugins
+ * @package Grav\Common\GPM\Remote
+ */
+class Plugins extends AbstractPackageCollection
 {
-    private $repository = 'http://getgrav.org/downloads/plugins.json';
-    private $type       = 'plugins';
-    private $data;
+    /**
+     * @var string
+     */
+    protected $type = 'plugins';
 
+    protected $repository = 'http://getgrav.org/downloads/plugins.json';
+
+    /**
+     * Local Plugins Constructor
+     */
     public function __construct($refresh = false, $callback = null)
     {
-        parent::__construct($this->repository);
-
-        $this->fetch($refresh, $callback);
-        $this->data = json_decode($this->raw);
-
-        foreach ($this->data as $slug => $data) {
-            $this->items[$slug] = new Package($data, $this->type);
-        }
+        parent::__construct($this->repository, $refresh, $callback);
     }
 }

system/src/Grav/Common/GPM/Remote/Themes.php

@@ -1,21 +1,24 @@
 <?php
 namespace Grav\Common\GPM\Remote;
 
-class Themes extends Collection
+/**
+ * Class Themes
+ * @package Grav\Common\GPM\Remote
+ */
+class Themes extends AbstractPackageCollection
 {
-    private $repository = 'http://getgrav.org/downloads/themes.json';
-    private $type       = 'themes';
-    private $data;
+    /**
+     * @var string
+     */
+    protected $type = 'themes';
 
+    protected $repository = 'http://getgrav.org/downloads/themes.json';
+
+    /**
+     * Local Themes Constructor
+     */
     public function __construct($refresh = false, $callback = null)
     {
-        parent::__construct($this->repository);
-
-        $this->fetch($refresh, $callback);
-        $this->data = json_decode($this->raw);
-
-        foreach ($this->data as $slug => $data) {
-            $this->items[$slug] = new Package($data, $this->type);
-        }
+        parent::__construct($this->repository, $refresh, $callback);
     }
 }

system/src/Grav/Common/GPM/Response.php

@@ -78,7 +78,6 @@ class Response
         $method  = 'get' . ucfirst(strtolower(self::$method));
 
         self::$callback = $callback;
-
         return static::$method($uri, $options, $callback);
     }