Added analysis requestbuilder classes and new unittests for these classes

library/Solarium/Client/RequestBuilder/Analysis.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ *
+ * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
+ * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
+ * @link http://www.solarium-project.org/
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+
+/**
+ * Build an analysis request
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+class Solarium_Client_RequestBuilder_Analysis extends Solarium_Client_RequestBuilder
+{
+
+    /**
+     * Build request for an analysis query
+     *
+     * @param Solarium_Query_Analysis $query
+     * @return Solarium_Client_Request
+     */
+    public function build($query)
+    {
+        $request = new Solarium_Client_Request;
+        $request->setHandler($query->getHandler());
+
+        $request->addParam('wt', 'json');
+        $request->addParam('analysis.query', $query->getQuery());
+        $request->addParam('analysis.showmatch', $query->getShowMatch());
+
+        return $request;
+    }
+
+}
\ No newline at end of file

library/Solarium/Client/RequestBuilder/Analysis/Document.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ *
+ * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
+ * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
+ * @link http://www.solarium-project.org/
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+
+/**
+ * Build a document analysis request
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+class Solarium_Client_RequestBuilder_Analysis_Document extends Solarium_Client_RequestBuilder_Analysis
+{
+
+    /**
+     * Build request for an analysis document query
+     *
+     * @param Solarium_Query_Analysis_Document $query
+     * @return Solarium_Client_Request
+     */
+    public function build($query)
+    {
+        $request = parent::build($query);
+        $request->setRawData($this->getRawData($query));
+        $request->setMethod(Solarium_Client_Request::METHOD_POST);
+        
+        return $request;
+    }
+
+    /**
+     * Create the raw post data (xml)
+     *
+     * @param Solarium_Query_Analysis_Document $query
+     * @return string
+     */
+    public function getRawData($query)
+    {
+        $xml = '<docs>';
+
+        foreach ($query->getDocuments() AS $doc) {
+            $xml .= '<doc>';
+
+            foreach ($doc->getFields() AS $name => $value) {
+                if (is_array($value)) {
+                    foreach ($value AS $multival) {
+                        $xml .= $this->_buildFieldXml($name, $multival);
+                    }
+                } else {
+                    $xml .= $this->_buildFieldXml($name, $value);
+                }
+            }
+
+            $xml .= '</doc>';
+        }
+
+        $xml .= '</docs>';
+        
+        return $xml;
+    }
+
+    /**
+     * Build XML for a field
+     *
+     * @param string $name
+     * @param mixed $value
+     * @return string
+     */
+    protected function _buildFieldXml($name, $value)
+    {
+        return '<field name="' . $name . '">' . htmlspecialchars($value, ENT_NOQUOTES, 'UTF-8') . '</field>';
+    }
+
+}
\ No newline at end of file

library/Solarium/Client/RequestBuilder/Analysis/Field.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ *
+ * @copyright Copyright 2011 Bas de Nooijer <solarium@raspberry.nl>
+ * @license http://github.com/basdenooijer/solarium/raw/master/COPYING
+ * @link http://www.solarium-project.org/
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+
+/**
+ * Build a field analysis request
+ *
+ * @package Solarium
+ * @subpackage Client
+ */
+class Solarium_Client_RequestBuilder_Analysis_Field extends Solarium_Client_RequestBuilder_Analysis
+{
+
+    /**
+     * Build request for an analysis field query
+     *
+     * @param Solarium_Query_Analysis_Field $query
+     * @return Solarium_Client_Request
+     */
+    public function build($query)
+    {
+        $request = parent::build($query);
+
+        $request->addParam('analysis.fieldvalue', $query->getFieldValue());
+        $request->addParam('analysis.fieldname', $query->getFieldName());
+        $request->addParam('analysis.fieldtype', $query->getFieldType());
+
+        return $request;
+    }
+
+}
\ No newline at end of file

tests/Solarium/Client/RequestBuilder/Analysis/DocumentTest.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ */
+
+class Solarium_Client_RequestBuilder_Analysis_DocumentTest extends PHPUnit_Framework_TestCase
+{
+
+    /**
+     * @var Solarium_Query_Analysis_Document
+     */
+    protected $_query;
+
+    /**
+     * @var Solarium_Client_RequestBuilder_Analysis_Document
+     */
+    protected $_builder;
+
+    public function setUp()
+    {
+        $this->_query = new Solarium_Query_Analysis_Document();
+        $this->_builder = new Solarium_Client_RequestBuilder_Analysis_Document;
+    }
+
+    public function testBuild()
+    {
+        $request = $this->_builder->build($this->_query);
+
+        $this->assertEquals(Solarium_Client_Request::METHOD_POST, $request->getMethod());
+        $this->assertEquals($this->_builder->getRawData($this->_query), $request->getRawData());
+    }
+
+    public function testGetRawData()
+    {
+        // this doc tests data escaping
+        $doc1 = new Solarium_Document_ReadWrite(array('id' => 1, 'name' => 'doc1', 'cat' => 'my > cat'));
+
+        // this doc tests a multivalue field
+        $doc2 = new Solarium_Document_ReadWrite(array('id' => 2, 'name' => 'doc2', 'cat' => array(1,2,3)));
+
+        $this->_query->addDocuments(array($doc1, $doc2));
+
+        $this->assertEquals(
+            '<docs><doc><field name="id">1</field><field name="name">doc1</field><field name="cat">my &gt; cat</field></doc><doc><field name="id">2</field><field name="name">doc2</field><field name="cat">1</field><field name="cat">2</field><field name="cat">3</field></doc></docs>',
+            $this->_builder->getRawData($this->_query)
+        );
+    }
+
+
+}
\ No newline at end of file

tests/Solarium/Client/RequestBuilder/Analysis/FieldTest.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ */
+
+class Solarium_Client_RequestBuilder_Analysis_FieldTest extends PHPUnit_Framework_TestCase
+{
+
+    /**
+     * @var Solarium_Query_Analysis_Field
+     */
+    protected $_query;
+
+    /**
+     * @var Solarium_Client_RequestBuilder_Analysis_Field
+     */
+    protected $_builder;
+
+    public function setUp()
+    {
+        $this->_query = new Solarium_Query_Analysis_Field();
+        $this->_builder = new Solarium_Client_RequestBuilder_Analysis_Field;
+    }
+
+    public function testBuild()
+    {
+        $fieldValue = 'myvalue';
+        $fieldName = 'myfield';
+        $fieldType = 'text';
+        
+        $this->_query->setFieldValue($fieldValue)
+                     ->setFieldName($fieldName)
+                     ->setFieldType($fieldType);
+        
+        $request = $this->_builder->build($this->_query);
+
+        $this->assertEquals($fieldValue, $request->getParam('analysis.fieldvalue'));
+        $this->assertEquals($fieldName, $request->getParam('analysis.fieldname'));
+        $this->assertEquals($fieldType, $request->getParam('analysis.fieldtype'));
+    }
+
+
+}
\ No newline at end of file

tests/Solarium/Client/RequestBuilder/AnalysisTest.php

+<?php
+/**
+ * Copyright 2011 Bas de Nooijer. All rights reserved.
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright notice,
+ *    this list of conditions and the following disclaimer.
+ *
+ * 2. Redistributions in binary form must reproduce the above copyright notice,
+ *    this listof conditions and the following disclaimer in the documentation
+ *    and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDER 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.
+ *
+ * The views and conclusions contained in the software and documentation are
+ * those of the authors and should not be interpreted as representing official
+ * policies, either expressed or implied, of the copyright holder.
+ */
+
+class Solarium_Client_RequestBuilder_AnalysisTest extends PHPUnit_Framework_TestCase
+{
+
+    /**
+     * @var Solarium_Query_Analysis_Field
+     */
+    protected $_query;
+
+    /**
+     * @var Solarium_Client_RequestBuilder_Analysis
+     */
+    protected $_builder;
+
+    public function setUp()
+    {
+        $this->_query = new Solarium_Query_Analysis_Field();
+        $this->_builder = new Solarium_Client_RequestBuilder_Analysis;
+    }
+
+    public function testBuild()
+    {
+        $query = 'cat:1';
+        $showMatch = true;
+        $handler = 'myhandler';
+        
+        $this->_query->setQuery($query)
+                     ->setShowMatch($showMatch)
+                     ->setHandler($handler);
+        $request = $this->_builder->build($this->_query);
+
+        $this->assertEquals(
+            array(
+                'wt' => 'json',
+                'analysis.query' => $query,
+                'analysis.showmatch' => $showMatch,
+            ),
+            $request->getParams()
+        );
+
+        $this->assertEquals($handler, $request->getHandler());
+    }
+
+
+}
\ No newline at end of file