2.0 (WIP)

.gitignore

@@ -1,3 +1,2 @@
 /vendor
 composer.lock
-Gemfile.lock

.travis.yml

@@ -1,20 +1,24 @@
 language: php
 
-php:
-  - 5.3
-  - 5.4
-  - 5.5
-  - 5.6
-  - 7.0
-  - hhvm
-
 matrix:
+  include:
+    - php: 5.4
+    - php: 5.5
+    - php: 5.6
+    - php: 7
+    - php: nightly
+    - php: hhvm
   allow_failures:
-    - php: 7.0
+    - php: nightly
+    - php: hhvm
 
 before_script:
-  - travis_retry composer self-update
-  - travis_retry composer install --no-interaction --prefer-source --dev
+  - composer self-update
+  - composer install --prefer-source  --no-interaction --no-scripts
 
 script:
-  - vendor/bin/phpunit --verbose --coverage-text
+  - vendor/bin/phpunit --verbose --coverage-clover=coverage.clover
+
+after_success:
+  - if [[ "$TRAVIS_PHP_VERSION" != "hhvm" ]] && [[ "$TRAVIS_PHP_VERSION" != "nightly" ]]; then wget https://scrutinizer-ci.com/ocular.phar; fi
+  - if [[ "$TRAVIS_PHP_VERSION" != "hhvm" ]] && [[ "$TRAVIS_PHP_VERSION" != "nightly" ]]; then php ocular.phar code-coverage:upload --format=php-clover coverage.clover; fi

CHANGELOG.md

@@ -1,3 +1,14 @@
+# Changelog since 1.5.4
+
+The 2.0 version is a major overhaul, which is *not* backwards compatible.
+
+* From now on you can re-use the class for multiple mails.
+* A lot less complicated options, as in: no more options at all.
+* More separate classes which handle their own (tested) methods.
+* A lot more tests
+
+The reason why I did this was to made the class more usable.
+
 # Changelog since 1.5.3
 
 * Fix properties split on base64 encoded url content, thx to [tguyard](https://github.com/Giga-gg),

LICENSE.md

@@ -7,16 +7,17 @@ modification, are permitted provided that the following conditions are met:
 2. Redistributions in binary form must reproduce the above copyright notice,
    this list of conditions and the following disclaimer in the documentation
    and/or other materials provided with the distribution.
-3. The name of the author may not be used to endorse or promote products
-   derived from this software without specific prior written permission.
+3. Neither the name of the copyright holder nor the names of its contributors
+   may be used to endorse or promote products derived from this software
+   without specific prior written permission.
 
-This software is provided by the author "as is" and any express or implied
-warranties, including, but not limited to, the implied warranties of
-merchantability and fitness for a particular purpose are disclaimed. In no event
-shall the author be liable for any direct, indirect, incidental, special,
-exemplary, or consequential damages (including, but not limited to, procurement
-of substitute goods or services; loss of use, data, or profits; or business
-interruption) however caused and on any theory of liability, whether in
-contract, strict liability, or tort (including negligence or otherwise) arising
-in any way out of the use of this software, even if advised of the possibility
-of such damage.
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,6 +1,8 @@
 # CssToInlineStyles class
 
-[![Build Status](https://travis-ci.org/tijsverkoyen/CssToInlineStyles.svg?branch=master)](https://travis-ci.org/tijsverkoyen/CssToInlineStyles)
+[![Build Status](https://travis-ci.org/tijsverkoyen/CssToInlineStyles.svg?branch=master)](https://travis-ci.org/tijsverkoyen/CssToInlineStyles) [![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/tijsverkoyen/CssToInlineStyles/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/tijsverkoyen/CssToInlineStyles/?branch=master) [![Code Coverage](https://scrutinizer-ci.com/g/tijsverkoyen/CssToInlineStyles/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/tijsverkoyen/CssToInlineStyles/?branch=master) [![SensioLabsInsight](https://insight.sensiolabs.com/projects/5c0ce94f-de6d-403e-9e0a-431268deb75c/mini.png)](https://insight.sensiolabs.com/projects/5c0ce94f-de6d-403e-9e0a-431268deb75c)
+
+## Installation
 
 > CssToInlineStyles is a class that enables you to convert HTML-pages/files into
 > HTML-pages/files with inline styles. This is very usefull when you're sending
@@ -22,28 +24,17 @@ $ composer require tijsverkoyen/css-to-inline-styles
 
     use TijsVerkoyen\CssToInlineStyles\CssToInlineStyles;
 
-    // Convert HTML + CSS to HTML with inlined CSS
-    $cssToInlineStyles= new CssToInlineStyles();
-    $cssToInlineStyles->setHTML($html);
-    $cssToInlineStyles->setCSS($css);
-    $html = $cssToInlineStyles->convert();
-
-    // Or use inline-styles blocks from the HTML as CSS
-    $cssToInlineStyles = new CssToInlineStyles($html);
-    $cssToInlineStyles->setUseInlineStylesBlock(true);
-    $html = $cssToInlineStyles->convert();
-
-
-## Documentation
+    // create instance
+    $cssToInlineStyles = new CssToInlineStyles();
 
-The following properties exists and have get/set methods available:
+    $html = file_get_contents(__DIR__ . '/examples/sumo/index.htm');
+    $css = file_get_contents(__DIR__ . '/examples/sumo/style.css');
 
-Property | Default | Description
--------|---------|------------
-cleanup|false|Should the generated HTML be cleaned?
-useInlineStylesBlock |false|Use inline-styles block as CSS.
-stripOriginalStyleTags |false|Strip original style tags.
-excludeMediaQueries |true|Exclude the media queries from the inlined styles.
+    // output
+    echo $cssToInlineStyles->convert(
+        $html,
+        $css
+    );
 
 ## Known issues
 

composer.json

@@ -1,31 +1,25 @@
 {
-  "name":        "tijsverkoyen/css-to-inline-styles",
-  "type":        "library",
+  "name": "tijsverkoyen/css-to-inline-styles",
+  "type": "library",
   "description": "CssToInlineStyles is a class that enables you to convert HTML-pages/files into HTML-pages/files with inline styles. This is very useful when you're sending emails.",
-  "homepage":    "https://github.com/tijsverkoyen/CssToInlineStyles",
-  "license":     "BSD",
-  "authors":     [
+  "homepage": "https://github.com/tijsverkoyen/CssToInlineStyles",
+  "license": "BSD-3-Clause",
+  "authors": [
     {
-      "name":  "Tijs Verkoyen",
+      "name": "Tijs Verkoyen",
       "email": "[email protected]",
-      "role":  "Developer"
+      "role": "Developer"
     }
   ],
-  "require":     {
-    "php":                  ">=5.3.0",
-    "symfony/css-selector": "~2.1"
+  "require": {
+    "symfony/css-selector": "^2.7"
   },
   "require-dev": {
-    "phpunit/phpunit":      "~4.0"
+    "phpunit/phpunit": "~4.8"
   },
-  "autoload":    {
+  "autoload": {
     "psr-4": {
       "TijsVerkoyen\\CssToInlineStyles\\": "src"
     }
-  },
-  "extra":       {
-    "branch-alias": {
-      "dev-master": "1.5.x-dev"
-    }
   }
 }

example/index.php

@@ -1,6 +1,5 @@
 <?php
 
-require_once 'config.php';
 require_once __DIR__ . '/../vendor/autoload.php';
 
 use TijsVerkoyen\CssToInlineStyles\CssToInlineStyles;
@@ -11,8 +10,8 @@
 $html = file_get_contents(__DIR__ . '/examples/sumo/index.htm');
 $css = file_get_contents(__DIR__ . '/examples/sumo/style.css');
 
-$cssToInlineStyles->setHTML($html);
-$cssToInlineStyles->setCSS($css);
-
 // output
-echo $cssToInlineStyles->convert();
+echo $cssToInlineStyles->convert(
+    $html,
+    $css
+);

phpunit.xml → phpunit.xml.dist

@@ -1,9 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
-
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
          bootstrap="vendor/autoload.php"
-         cacheTokens="true"
          colors="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"
@@ -19,9 +17,10 @@
     </testsuites>
 
     <filter>
-        <whitelist addUncoveredFilesFromWhitelist="false">
+        <whitelist addUncoveredFilesFromWhitelist="true">
             <directory suffix=".php">src</directory>
             <exclude>
+                <directory suffix=".php">tests</directory>
                 <directory suffix=".php">vendor</directory>
             </exclude>
         </whitelist>

src/Css/Processor.php

@@ -0,0 +1,42 @@
+<?php
+
+namespace TijsVerkoyen\CssToInlineStyles\Css;
+
+use TijsVerkoyen\CssToInlineStyles\Css\Rule\Processor as RuleProcessor;
+
+class Processor
+{
+    /**
+     * Get the rules from a given CSS-string
+     *
+     * @param string $css
+     * @return array
+     */
+    public function getRules($css)
+    {
+        $css = $this->doCleanup($css);
+        $rulesProcessor = new RuleProcessor();
+        $rules = $rulesProcessor->splitIntoSeparateRules($css);
+
+        return $rulesProcessor->convertArrayToObjects($rules);
+    }
+
+    /**
+     * @param $css
+     * @return mixed|string
+     */
+    protected function doCleanup($css)
+    {
+        // remove media queries
+        $css = preg_replace('/@media [^{]*{([^{}]|{[^{}]*})*}/', '', $css);
+
+        $css = str_replace(array("\r", "\n"), '', $css);
+        $css = str_replace(array("\t"), ' ', $css);
+        $css = str_replace('"', '\'', $css);
+        $css = preg_replace('|/\*.*?\*/|', '', $css);
+        $css = preg_replace('/\s\s+/', ' ', $css);
+        $css = trim($css);
+
+        return $css;
+    }
+}

src/Css/Property/Processor.php

@@ -0,0 +1,108 @@
+<?php
+
+namespace TijsVerkoyen\CssToInlineStyles\Css\Property;
+
+class Processor
+{
+    /**
+     * Split a string into seperate properties
+     *
+     * @param string $propertiesString
+     * @return array
+     */
+    public function splitIntoSeparateProperties($propertiesString)
+    {
+        $propertiesString = $this->cleanup($propertiesString);
+
+        $properties = (array) explode(';', $propertiesString);
+        $keysToRemove = array();
+        $numberOfProperties = count($properties);
+
+        for ($i = 0; $i < $numberOfProperties; $i++) {
+            $properties[$i] = trim($properties[$i]);
+
+            // if the new property begins with base64 it is part of the current property
+            if (isset($properties[$i + 1]) && strpos(trim($properties[$i + 1]), 'base64,') === 0) {
+                $properties[$i] .= ';' . trim($properties[$i + 1]);
+                $keysToRemove[] = $i + 1;
+            }
+        }
+
+        if (!empty($keysToRemove)) {
+            foreach ($keysToRemove as $key) {
+                unset($properties[$key]);
+            }
+        }
+
+        return array_values($properties);
+    }
+
+    /**
+     * @param $string
+     * @return mixed|string
+     */
+    protected function cleanup($string)
+    {
+        $string = str_replace(array("\r", "\n"), '', $string);
+        $string = str_replace(array("\t"), ' ', $string);
+        $string = str_replace('"', '\'', $string);
+        $string = preg_replace('|/\*.*?\*/|', '', $string);
+        $string = preg_replace('/\s\s+/', ' ', $string);
+
+        $string = trim($string);
+        $string = rtrim($string, ';');
+
+        return $string;
+    }
+
+    /**
+     * Convert a property-string into an object
+     *
+     * @param string $property
+     * @return Property|null
+     */
+    public function convertToObject($property)
+    {
+        $chunks = (array) explode(':', $property, 2);
+
+        if (!isset($chunks[1]) || $chunks[1] == '') {
+            return null;
+        }
+
+        return new Property(trim($chunks[0]), trim($chunks[1]));
+    }
+
+    /**
+     * Convert an array of property-strings into objects
+     *
+     * @param array $properties
+     * @return array
+     */
+    public function convertArrayToObjects(array $properties)
+    {
+        $objects = array();
+
+        foreach ($properties as $property) {
+            $objects[] = $this->convertToObject($property);
+        }
+
+        return $objects;
+    }
+
+    /**
+     * Build the property-string for multiple properties
+     *
+     * @param array $properties
+     * @return string
+     */
+    public function buildPropertiesString(array $properties)
+    {
+        $chunks = array();
+
+        foreach ($properties as $property) {
+            $chunks[] = $property->toString();
+        }
+
+        return implode(' ', $chunks);
+    }
+}