Merge branch 'master' into feat/docs

Author: srtab

.gitignore

@@ -5,5 +5,5 @@ composer.lock
 *.sublime-project
 *.sublime-workspace
 /build
-/env
+env
 site

CHANGELOG.md

@@ -4,8 +4,26 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
-## [1.1.0] - XXXX-XX-XX
+## [2.0.3] - 2017-12-13
 ### Added
+ - `setRequired` to `Field` class;
+ - Twig Filter `merge_str` to merge value into as array value through implode.
+
+### Fixed
+ - Form field error class being ignored in `Bootstrap4TemplatePack`.
+
+## [2.0.2] - 2017-12-12
+### Changed
+ - `Twig` minimal version supported setted to `>=1.35`.
+
+## [2.0.1] - 2017-12-11
+### Changed
+ - Loading `Twig` classes with psr-4 mode;
+ - Select `option` tag don't render `value` if it is empty.
+
+## [2.0.0] - 2017-12-11
+### Added
+ - Documentation of package;
  - Renderers to facilitate integrations of template-engines:
     - Added `Renderer` interface;
     - Added `TwigRenderer` that integrates `twig/twig`;
@@ -15,12 +33,14 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
     - Added template pack `DefaultTemplatePack`. Defined as default template pack;
     - Added template pack `Bootstrap4TemplatePack` that integrates Bootstrap v4.0.0-beta.2.
  - `Config` singleton class allowing:
-    - Configure custom template packs class;
-    - Configure custom messages class;
-    - Configure custom renderers class.
- - Added extra arg `label` to method `getContext` of `Widget` class.
+    - Configure custom template packs;
+    - Configure custom messages;
+    - Configure custom renderers.
+ - Added extra arg `label` to method `getContext` of `Widget` class;
+ - `BoundWidget` class to represent the choices of a `ChoiceWidget` in `BoundField`, allowing individual render or data access to each option.
 
 ### Changed
+ - `BoundField` moved from `Fields` to new namespace `Bounds`;
  - `BoundField` attribute name `choices` changed to `options`;
  - `BoundField` attribute `options` now return an array instead of formated string;
  - `Widgets`, `labelTag` and `ErrorList` now render through default renderer instead of formatter `fleshgrinder/format`;

README.md

@@ -1,9 +1,11 @@
 # PHP Form
 [![Build Status](https://travis-ci.org/dipcode-software/php-form.svg?branch=master)](https://travis-ci.org/dipcode-software/php-form)
 [![Coverage Status](https://coveralls.io/repos/github/dipcode-software/php-form/badge.svg?branch=master)](https://coveralls.io/github/dipcode-software/php-form?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/dipcode/php-form/v/stable)](https://packagist.org/packages/dipcode/php-form)
+[![Documentation](https://alexandriadocs.io/projects/php-form/badge-url/?style=flat)](https://alexandriadocs.io/docs/php-form/index.html)
 [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://www.opensource.org/licenses/MIT)
 
-PHP class for form handling abstraction inspired in Django Framework forms.
+Full featured form engine library inspired in Django Framework.
 
 ## Instalation
 Library can be installed using Composer like so:

composer.json

@@ -20,7 +20,7 @@
   "require": {
     "php": ">=7.0.0",
     "fleshgrinder/format": "^1.1",
-    "twig/twig": "^2.4"
+    "twig/twig": ">=1.35"
   },
   "require-dev": {
     "phpunit/phpunit": "~6.0",

docs/deploy.sh

@@ -1,7 +1,10 @@
-#!/bin/sh
-pip install -r docs/requirements.txt
-cd docs/php-form
-mkdocs build
-tar -zcvf phpform.tar.gz -C site .
-curl -X POST -H "Content-Type: multipart/form-data" -H "Api-Key: ${1}" -F "archive=@phpform.tar.gz" https://alexandriadocs.io/api/v1/projects/upload/
-rm phpform.tar.gz
+#!/bin/bash
+
+cd docs/
+source env/bin/activate && \
+    pip install -r requirements.txt && \
+    cd php-form && \
+    mkdocs build && \
+    tar -zcvf phpform.tar.gz -C site . && \
+    curl -X POST -H "Content-Type: multipart/form-data" -H "Api-Key: ${1}" -F "archive=@phpform.tar.gz" https://alexandriadocs.io/api/v1/projects/upload/ && \
+    rm phpform.tar.gz

docs/php-form/docs/index.md

@@ -1,8 +1,8 @@
 # Welcome to PHPForm documentation
 [![Build Status](https://travis-ci.org/dipcode-software/php-form.svg?branch=master)](https://travis-ci.org/dipcode-software/php-form)
 [![Coverage Status](https://coveralls.io/repos/github/dipcode-software/php-form/badge.svg?branch=master)](https://coveralls.io/github/dipcode-software/php-form?branch=master)
+[![Latest Stable Version](https://poser.pugx.org/dipcode/php-form/v/stable)](https://packagist.org/packages/dipcode/php-form)
 [![License](http://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat)](http://www.opensource.org/licenses/MIT)
-[![Documentation](https://alexandriadocs.io/projects/php-form/badge-url/?style=flat)](https://alexandriadocs.io/docs/php-form/index.html)
 
 PHP class for form handling abstraction inspired in the fantastic Django Framework Forms.
 

src/Fields/BoundField.php renamed to src/Bounds/BoundField.php

@@ -1,5 +1,5 @@
 <?php
-namespace PHPForm\Fields;
+namespace PHPForm\Bounds;
 
 use PHPForm\Config;
 
@@ -10,7 +10,7 @@ class BoundField
     private $form;
     private $field;
     private $name;
-    private $options_cache;
+    private $bound_widgets_cache;
 
     public $html_name;
     public $help_text;
@@ -55,18 +55,25 @@ public function __get($name)
         }
 
         if ($name == 'options') {
-            if (!isset($options_cache)) {
-                $options_cache = $this->getOptions();
+            if (!isset($bound_widgets_cache)) {
+                $bound_widgets_cache = $this->getSubWidgets();
             }
-            return $options_cache;
+            return $bound_widgets_cache;
         }
     }
 
-    private function getOptions(array $attrs = array())
+    private function getSubWidgets(array $attrs = array())
     {
+        $bounds = [];
+
         $attrs = $this->buildWidgetAttrs($attrs);
+        $options = $this->field->getWidget()->getOptions($this->html_name, $this->getValue(), $attrs);
+
+        foreach ($options as $option) {
+            $bounds[] = new BoundWidget($option);
+        }
 
-        return $this->field->getWidget()->getOptions($this->html_name, $this->getValue(), $attrs);
+        return $bounds;
     }
 
     protected function asWidget($widget = null, array $attrs = array())

src/Bounds/BoundWidget.php

@@ -0,0 +1,37 @@
+<?php
+namespace PHPForm\Bounds;
+
+use PHPForm\Config;
+
+class BoundWidget
+{
+    private $data;
+    private $template;
+
+    public $for;
+    public $type;
+    public $name;
+    public $value;
+    public $label;
+
+    public function __construct(array $data)
+    {
+        $this->for = $data["for"];
+        $this->type = $data["type"];
+        $this->name = $data["name"];
+        $this->value = $data["value"];
+        $this->label = $data["label"];
+        $this->template = $data["template"];
+
+        unset($data["template"]);
+
+        $this->data = $data;
+    }
+
+    public function __toString()
+    {
+        $renderer = Config::getInstance()->getRenderer();
+
+        return $renderer->render($this->template, $this->data);
+    }
+}

src/Config.php

@@ -7,7 +7,7 @@
 
 class Config extends Singleton
 {
-    const VERSION = "v1.1.0";
+    const VERSION = "v2.0.3";
 
     /**
      * @var array Template packs to be used. The templates will be loaded
@@ -39,17 +39,17 @@ class Config extends Singleton
      */
     public function setTemplatePack(string $template_pack)
     {
-        $this->template_packs = array_unshift($this->template_packs, $template_pack);
+        array_unshift($this->template_packs, $template_pack);
     }
 
     /**
-     * Set messages class.
+     * Redefine default messages.
      *
-     * @param string Class name of Renderer.
+     * @param array Messages array.
      */
-    public function setMessages(string $messages_class)
+    public function setMessages(array $messages)
     {
-        $this->messages_class = $messages_class;
+        $this->messages_class::setMessages($messages);
     }
 
     /**

src/Fields/Field.php

@@ -137,6 +137,16 @@ public function isDisabled()
         return $this->disabled;
     }
 
+    /**
+    * Set disabled value.
+    *
+    * @param bool
+    */
+    public function setDisabled(bool $value)
+    {
+        $this->disabled = $value;
+    }
+
     /**
     * Return defined label or construct one based on the field name.
     *