initial commit

Author: dmolsen

LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Dave Olsen, http://dmolsen.com
+
+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,37 @@
+# Faker Plugin for Pattern Lab
+
+The Faker Plugin adds support for the [Faker Library](https://github.com/fzaninotto/Faker) to Pattern Lab.
+
+## Installation
+
+Pattern Lab PHP uses [Composer](https://getcomposer.org/) to manage project dependencies with Pattern Lab Editions. To add the Faker Plugin to the dependencies list for your Edition you can type the following in the command line at the base of your project:
+
+    composer require pattern-lab/plugin-faker
+
+See Packagist for [information on the latest release](https://packagist.org/packages/pattern-lab/plugin-faker).
+
+## Usage
+
+To use this in your project set the value for a data option to:
+
+```
+"key": "Faker.[formatter]([options])",
+```
+
+For example, to have a random first name use:
+
+```
+"firstName": "Faker.firstName('female')",
+```
+
+Using Mustache as an example you'd use:
+
+```
+First Name: {{ firstName }}
+```
+
+would output:
+
+```
+First Name: Mary
+```

composer.json

@@ -0,0 +1,40 @@
+{
+  "name":             "pattern-lab/plugin-faker",
+  "description":      "Faker for the PHP version of Pattern Lab",
+  "keywords":         ["faker", "pattern lab"],
+  "homepage":         "http://patternlab.io",
+  "license":          "MIT",
+  "type":             "patternlab-plugin",
+  "authors": [
+    {
+      "name":         "Dave Olsen",
+      "email":        "[email protected]",
+      "homepage":     "http://dmolsen.com",
+      "role":         "Lead Developer"
+    }
+  ],
+  "support": {
+    "issues":         "https://github.com/pattern-lab/mustachehelper-php-verbatim/issues",
+    "wiki":           "http://patternlab.io/docs/",
+    "source":         "https://github.com/pattern-lab/mustachehelper-php-verbatim/releases"
+  },
+  "autoload": {
+    "psr-0": {
+      "PatternLab\\Faker": "src/"
+    }
+  },
+  "require": {
+    "php":              ">=5.4",
+    "pattern-lab/core": "^2.0.0",
+    "fzaninotto/faker": "^1.0.0"
+  },
+  "extra": {
+    "patternlab": {
+      "config": {
+        "faker": {
+          "locale": "en_US"
+        }
+      }
+    }
+  }
+}

src/PatternLab/Faker/PatternLabListener.php

@@ -0,0 +1,115 @@
+<?php
+
+/*!
+ * Faker Listener Class
+ *
+ * Copyright (c) 2016 Dave Olsen, http://dmolsen.com
+ * Licensed under the MIT license
+ *
+ * Adds Faker support to Pattern Lab
+ *
+ */
+
+namespace PatternLab\Faker;
+
+use \PatternLab\Config;
+use \PatternLab\PatternEngine\Twig\TwigUtil;
+
+class PatternLabListener extends \PatternLab\Listener {
+  
+  /**
+  * Add the listeners for this plug-in
+  */
+  public function __construct() {
+    
+    // add listener
+    $this->addListener("twigPatternLoader.customize","fakeContent");
+    
+    // set-up locale
+    $locale = Config::getOption("faker.locale");
+    $locale = ($locale) ? $locale : "en_US";
+    
+    // set-up Faker
+    $this->faker = \Faker\Factory::create($locale);
+    $this->faker->addProvider(new \Faker\Provider\Color($faker));
+    $this->faker->addProvider(new \Faker\Provider\Payment($faker));
+    $this->faker->addProvider(new \Faker\Provider\DateTime($faker));
+    $this->faker->addProvider(new \Faker\Provider\Image($faker));
+    
+  }
+  
+  /**
+  * Go through data and replace any values that match items from the link.array
+  * @param  {String}       a string entry from the data to check for link.pattern
+  *
+  * @return {String}       replaced version of link.pattern
+  */
+  private function compareReplaceFaker($value) {
+    if (is_string($value) && preg_match("/^Faker\.([A-z]+)(\((\'|\")?([A-z]+)?(\'|\")?\))?$/",$value,$matches)) {
+      $formatter = $matches[1];
+      $options   = isset($matches[5]) ? $matches[5] : "";
+      if ($options != "") {
+        return $this->formatOptionsAndFake($formatter, $options);
+      } else {
+        return $this->faker->$formatter;
+      }
+    }
+    return $value;
+  }
+  
+  /**
+  * Read in the data and process faker data
+  */
+  public function fakeContent() {
+    
+    $foo = $this->recursiveWalk(Data::get());
+    print_r($foo);
+    
+  }
+  
+  /**
+  * Read in the data and process faker data
+  */
+  public function formatOptionsAndFake($formatter, $options) {
+    
+    if (($formatter == "date") || ($formatter == "time")) {
+      return $this->faker->$formatter($options);
+    } else {
+      $options = explode(",", $options);
+      if (count($options) === 6) {
+        return $this->faker->$formatter($options[0],$options[1],$options[2],$options[3],$options[4],$options[5]);
+      } else if (count($options) === 5) {
+        return $this->faker->$formatter($options[0],$options[1],$options[2],$options[3],$options[4]);
+      } else if (count($options) === 4) {
+        return $this->faker->$formatter($options[0],$options[1],$options[2],$options[3]);
+      } else if (count($options) === 3) {
+        return $this->faker->$formatter($options[0],$options[1],$options[2]);
+      } else if (count($options) === 2) {
+        return $this->faker->$formatter($options[0],$options[1]);
+      } else {
+        return $this->faker->$formatter($options[0]);
+      }
+    }
+    
+  }
+  
+  /**
+  * Work through a given array and decide if the walk should continue or if we should replace the var
+  * @param  {Array}       the array to be checked
+  *
+  * @return {Array}       the "fixed" array
+  */
+  private function recursiveWalk($array) {
+    foreach ($array as $k => $v) {
+        if (is_array($v)) {
+            $array[$k] = self::recursiveWalk($v);
+        } else {
+            $array[$k] = self::compareReplaceFaker($v);
+        }
+    }
+    return $array;
+  }
+  
+
+  
+}