Cleaned code a little bit. Pass environment to evaluate functions.

Author: Danack

.gitignore

@@ -1,2 +1,5 @@
 vendor
 example/output
+example/env.php
+example/example.nginx.conf
+example/example.php-fpm.conf

README.md

@@ -5,4 +5,109 @@ Generates config files from PHP based templates and PHP style config files.
 
 
 
-Please run the example/example.php for an example of how to use it.
+## Generate config files
+
+
+Source config file
+
+```
+    access_log  ${'nginx.log.directory'}/project.access.log requestTime;    
+    error_log  ${'nginx.log.directory'}/project.error.log;
+    root ${'project.root.directory'}/public;
+```
+
+Settings file:
+
+```
+<?php
+
+$centos = [
+    'nginx.log.directory' => '/var/log/nginx', 
+    'project.root.directory' => '/home/project',
+];
+
+$windows = [
+    'nginx.log.directory' => 'c:/nginx', 
+    'project.root.directory' => 'c:/documents/project',
+];
+
+$dave = [
+    'project.root.directory' => '/home/workdir/project',
+]
+
+```
+
+
+configurate data/nginx.conf.php var/generated/nginx.conf centos,dave -p settings.php  
+
+
+```
+    access_log  /var/log/nginx/project.access.log requestTime;    
+    error_log  /var/log/nginx/project.error.log;
+    root /home/workdir/project/public;
+```
+
+
+
+
+## Generate environment settings
+
+
+
+A file that returns an array of what env settings are required by this application
+
+```
+<?php
+
+use ImagickDemo\Config;
+
+$env = [
+    Config::CACHING_SETTING,
+    Config::SCRIPT_PACKING,
+];
+
+return $env;
+```
+
+
+Produces a file containing a single function that contains all the requested env settings.
+
+```
+<?php
+
+function getAppEnv() {
+    static $env = [
+        'caching.setting' => 'caching.revalidate',
+        'script.packing' => '',
+    ];
+
+    return $env;
+}
+
+```
+
+The keys are the actual strings, rather than the constants used in the application, to allow the settings to be used outside of the application. 
+
+
+
+
+
+## Convert PHP ini files to PHP-FPM format
+
+Because of reasons, PHP-FPM doesn't use the standard PHP in file format when including ini files in a pool in the PHP-FPM conf file.
+
+This aspect of the Configurator converts PHP style ini files:
+
+```
+extension=imagick.so
+default_charset = "utf-8";
+post_max_size = 10M
+```
+
+to PHP-FPM style files:
+
+```
+php_admin_value[extension] = "imagick.so"
+php_admin_value[default_charset] = "utf-8"
+php_admin_value[post_max_size] = "10M"
+```

composer.json

@@ -1,13 +1,16 @@
 {
     "name": "intahwebz/configurator",
     "description": "Generates config files from PHP based config files and PHP and JSON data files.",
-    "keywords": ["php", "config", "tool", "UTF-8"],
+    "keywords": ["php", "config", "environment", "configuration", "tool", "UTF-8"],
     "license": "MIT",
     "autoload": {
         "psr-0": {
             "Configurator": "src/"
         }
     },
+    "autoload-dev": {
+        "psr-0": { "ExampleApp\\": "example/" }
+    },
     "bin": [
         "bin/configurate",
         "bin/genenv",
@@ -27,7 +30,5 @@
             "email": "Danack@basereality.com",
             "homepage": "http://www.basereality.com"
         }
-    ],
-    "minimum-stability": "dev",
-    "prefer-stable": true
+    ]
 }

example/ExampleApp/AppConfig.php

@@ -0,0 +1,20 @@
+<?php
+
+namespace ExampleApp;
+
+class AppConfig
+{
+    // Whether assets should be cached or not.
+    const CACHING_SETTING = 'caching.setting';
+    
+    // Whether JS / CSS script are packed together
+    // or served separately.
+    const SCRIPT_PACKING = 'script.packing';
+    
+    
+    const FILE_STORAGE = 'file.storage';
+}
+
+
+
+

example/config/config.php

@@ -0,0 +1,54 @@
+<?php
+
+// This is a sample configuration file
+$socketDir = '/var/run/php-fpm';
+
+$liveMemory = 32;
+
+
+// By deploying each version of an app into its own directory,
+// this allows a unique socket to be used per deploy.
+// e.g. if the app is deployed into the directory /home/appname/${commitSHA}
+//
+$fullSocketPath = $socketDir."/php-fpm-example-".basename(dirname(__DIR__)).".sock";
+
+$default = [
+    //global/default variables go here.
+    'nginx.sendFile' => 'off',
+    'mysql.charset' => 'utf8mb4',
+    'mysql.collation' => 'utf8mb4_unicode_ci',
+];
+
+$centos = [
+    'nginx.log.directory' => '/var/log/nginx',
+    'nginx.root.directory' => '/usr/share/nginx',
+    'nginx.conf.directory' => '/etc/nginx',
+    'nginx.run.directory ' => '/var/run',
+    'nginx.user' => 'nginx',
+    'nginx.sendFile' => 'on',
+    
+    'example.root.directory' => dirname(__DIR__),
+    
+    'phpfpm.www.maxmemory' => "".$liveMemory."M",
+    'phpfpm.user' => 'intahwebz',
+    'phpfpm.group' => 'www-data',
+    'phpfpm.socket.directory' => $socketDir,
+    'phpfpm.conf.directory' => '/etc/php-fpm.d',
+    'phpfpm.pid.directory' => '/var/run/php-fpm',
+    
+    //
+    'phpfpm.fullsocketpath' => $fullSocketPath,
+
+    'php.conf.directory' => '/etc/php',
+    'php.log.directory' => '/var/log/php',
+    'php.errorlog.directory' => '/var/log/php',
+    'php.session.directory' => '/var/lib/php/session',
+];
+
+
+
+$dev = [];
+
+// Dev mode should be run with less memory than live, to make
+// out of memory issues more likely to show up on dev than live
+$dev['phpfpm.www.maxmemory'] = "".($liveMemory - 10)."M";

example/config/example.nginx.conf.php

@@ -0,0 +1,86 @@
+<?php
+
+$config = <<< END
+
+server {
+
+    gzip  on;
+    gzip_http_version 1.0;
+    gzip_vary on;
+    gzip_comp_level 6;
+    gzip_proxied any;
+    gzip_types text/plain text/css application/json application/javascript application/x-javascript text/javascript text/xml application/xml application/rss+xml application/atom+xml application/rdf+xml;
+
+    gzip_buffers 16 8k;
+
+    # ~ nginx performs a regular expression match.
+    # ~* removes case sensitivity from the matches
+    # ^~) matches literal string and stops processing
+    # =) as an argument to location forces an exact match with the path requested and then stops searching for more specific matches. will only match http://ducklington.org/ but not http://ducklington.org/index.html
+
+    listen 80;
+    listen 8080;
+    server_name example.com www.example.com test.example.com example.test;
+
+    access_log  ${'nginx.log.directory'}/example.access.log requestTime;    
+    error_log  ${'nginx.log.directory'}/example.error.log;
+
+    root ${'example.root.directory'}/example;
+
+    client_max_body_size 1m;
+    
+    rewrite ^/(.*)/$ /$1 permanent;
+
+    error_page  404  /404.html;
+    location = /404.html {
+        try_files /html/404.html =500;
+    }
+
+    # redirect server error pages to the static page /50x.html
+    #error_page   500 502 503 504  /50x.html;
+
+    #location = /50x.html {
+    #	root   /usr/share/nginx/html;
+    #}
+
+    fastcgi_intercept_errors off;
+
+    # this prevents hidden files (beginning with a period) from being served
+    location ~ /\.          { access_log off; log_not_found off; deny all; }
+
+    location = /robots.txt  { access_log off; log_not_found off; }
+    location = /favicon.ico { access_log off; log_not_found off; }
+    location ~ /\.          { access_log off; log_not_found off; deny all; }
+    location ~ ~$           { access_log off; log_not_found off; deny all; }
+    
+    #This must be the last regular epxression match
+    location ~* ^[^\?\&]+\.(html|jpg|jpeg|gif|png|ico|css|zip|tgz|gz|rar|bz2|doc|xls|pdf|ppt|psd|txt|tar|mid|midi|wav|bmp|rtf|js|svg|woff|ttf)$ {
+        try_files \$uri /index.php?file=\$1;
+
+        #access_log off;
+        expires 7d;
+        add_header Pragma public;
+        add_header Cache-Control "public, must-revalidate, proxy-revalidate";
+    }
+   
+    location ~ ^/(www-status|ping)$ {
+        if ( \$remote_addr != 127.0.0.1 ) { return 444;} 
+        access_log off;
+        allow 127.0.0.1;
+        deny all;
+        fastcgi_param  QUERY_STRING       \$query_string;
+        include       ${'example.root.directory'}/data/conf/fastcgi.conf;
+        fastcgi_pass   unix:${'phpfpm.fullsocketpath'};
+    }
+
+    location  / {
+        try_files \$uri /index.php =404;
+        fastcgi_param  QUERY_STRING  \$query_string;
+        fastcgi_pass   unix:${'phpfpm.fullsocketpath'};
+        include       ${'example.root.directory'}/data/conf/fastcgi.conf;
+    }
+}
+
+END;
+
+return $config;

example/config/example.php-fpm.conf.php

@@ -0,0 +1,58 @@
+<?php
+
+$config = <<< END
+
+
+;;;;;;;;;;;;;;;;;;;;
+; Pool Definitions ; 
+;;;;;;;;;;;;;;;;;;;;
+
+; Start a new pool named 'www'.
+[example]
+
+; Unix user/group of processes
+user = exampleuser
+group = ${'phpfpm.group'}
+
+listen = ${'phpfpm.fullsocketpath'}
+
+; List of ipv4 addresses of FastCGI clients which are allowed to connect.
+listen.allowed_clients = 127.0.0.1
+
+listen.owner = exampleuser
+listen.group = ${'phpfpm.group'}
+listen.mode = 0664
+
+; Per pool prefix
+;prefix = /path/to/pools/\$pool
+;prefix = \$pool
+
+request_slowlog_timeout = 10
+slowlog = ${'php.log.directory'}/slow.\$pool.log
+
+request_terminate_timeout=500
+
+catch_workers_output = yes
+
+pm = dynamic
+
+pm.max_children = 20
+pm.start_servers = 4
+pm.min_spare_servers = 2
+pm.max_spare_servers = 10
+pm.max_requests = 5000
+
+; The URI to view the FPM status page.
+pm.status_path = /www-status
+
+; Additional php.ini defines
+php_admin_value[memory_limit] = ${'phpfpm.www.maxmemory'}
+php_admin_value[error_log] = ${'php.errorlog.directory'}/\$pool-error.log
+
+security.limit_extensions = .php
+
+include = ${'example.root.directory'}/autogen/example.php.fpm.ini
+
+END;
+
+return $config;

example/config/fastcgi.conf

@@ -0,0 +1,28 @@
+fastcgi_param  SCRIPT_FILENAME    $document_root$fastcgi_script_name;
+
+#QUERY_STRING is not set in here - set it in Nginx to prevent extra redirect
+#fastcgi_param  QUERY_STRING       $query_string;
+
+fastcgi_param  REQUEST_METHOD     $request_method;
+fastcgi_param  CONTENT_TYPE       $content_type;
+fastcgi_param  CONTENT_LENGTH     $content_length;
+
+fastcgi_param  SCRIPT_NAME        $fastcgi_script_name;
+fastcgi_param  REQUEST_URI        $request_uri;
+fastcgi_param  DOCUMENT_URI       $document_uri;
+fastcgi_param  DOCUMENT_ROOT      $document_root;
+fastcgi_param  SERVER_PROTOCOL    $server_protocol;
+fastcgi_param  HTTPS              $https if_not_empty;
+
+fastcgi_param  GATEWAY_INTERFACE  CGI/1.1;
+fastcgi_param  SERVER_SOFTWARE    nginx/$nginx_version;
+
+fastcgi_param  REMOTE_ADDR        $remote_addr;
+fastcgi_param  REMOTE_PORT        $remote_port;
+fastcgi_param  SERVER_ADDR        $server_addr;
+fastcgi_param  SERVER_PORT        $server_port;
+fastcgi_param  SERVER_NAME        $server_name;
+
+# PHP only, required if PHP was built with --enable-force-cgi-redirect
+fastcgi_param  REDIRECT_STATUS    200;
+