/*jshint globalstrict:false, strict:false, maxlen: 700 */
/*global assertEqual, AQL_EXECUTE, AQL_EXPLAIN */

////////////////////////////////////////////////////////////////////////////////
/// @brief tests for query language, attribute accesses
///
/// @file
///
/// DISCLAIMER
///
/// Copyright 2010-2012 triagens GmbH, Cologne, Germany
///
/// Licensed under the Apache License, Version 2.0 (the "License");
/// you may not use this file except in compliance with the License.
/// You may obtain a copy of the License at
///
///     http://www.apache.org/licenses/LICENSE-2.0
///
/// Unless required by applicable law or agreed to in writing, software
/// distributed under the License is distributed on an "AS IS" BASIS,
/// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
/// See the License for the specific language governing permissions and
/// limitations under the License.
///
/// Copyright holder is triAGENS GmbH, Cologne, Germany
///
/// @author Jan Steemann
/// @author Copyright 2012, triAGENS GmbH, Cologne, Germany
////////////////////////////////////////////////////////////////////////////////

var jsunity = require("jsunity");
var db = require("internal").db;

////////////////////////////////////////////////////////////////////////////////
/// @brief test suite
////////////////////////////////////////////////////////////////////////////////

function attributeAccessTestSuite () {
  var values = [
    { name: "sir alfred", age: 60, loves: [ "lettuce", "flowers" ] },
    { person: { name: "gadgetto", age: 50, loves: "gadgets" } },
    { name: "everybody", loves: "sunshine" },
    { name: "judge", loves: [ "order", "policing", "weapons" ] },
    "someone"
  ];

  return {

////////////////////////////////////////////////////////////////////////////////
/// @brief set up
////////////////////////////////////////////////////////////////////////////////

    setUp : function () {
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief tear down
////////////////////////////////////////////////////////////////////////////////

    tearDown : function () {
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test direct access
////////////////////////////////////////////////////////////////////////////////

    testDirectAccess : function () {
      var result = AQL_EXECUTE("RETURN " + JSON.stringify(values[0]) + ".name").json;
      assertEqual([ "sir alfred" ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test direct access
////////////////////////////////////////////////////////////////////////////////

    testDirectAccessBind : function () {
      var result = AQL_EXECUTE("RETURN @value.name", { value: values[0] }).json;
      assertEqual([ "sir alfred" ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test non-existing attribute
////////////////////////////////////////////////////////////////////////////////

    testNonExistingAttribute : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN value.broken", { values: values }).json;
      assertEqual([ null, null, null, null, null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test partially existing attribute
////////////////////////////////////////////////////////////////////////////////

    testPartiallyExistingAttribute : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN value.name", { values: values }).json;
      assertEqual([ "sir alfred", null, "everybody", "judge", null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test partially existing sub-attribute
////////////////////////////////////////////////////////////////////////////////

    testPartiallyExistingSubAttribute : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN value.person.name", { values: values }).json;
      assertEqual([ null, "gadgetto", null, null, null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test function call result attribute
////////////////////////////////////////////////////////////////////////////////

    testFunctionCallResultAttribute : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN NOOPT(PASSTHRU(value.age))", { values: values }).json;
      assertEqual([ 60, null, null, null, null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test function call result sub-attribute
////////////////////////////////////////////////////////////////////////////////

    testFunctionCallResultAttribute1 : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN NOOPT(PASSTHRU(value.person.name))", { values: values }).json;
      assertEqual([ null, "gadgetto", null, null, null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test function call result sub-attribute
////////////////////////////////////////////////////////////////////////////////

    testFunctionCallResultAttribute2 : function () {
      var result = AQL_EXECUTE("FOR value IN @values RETURN NOOPT(PASSTHRU(value).person).name", { values: values }).json;
      assertEqual([ null, "gadgetto", null, null, null ], result);
    },

////////////////////////////////////////////////////////////////////////////////
/// @brief test subquery result attribute
////////////////////////////////////////////////////////////////////////////////

    testSubqueryResultAttribute : function () {
      // won't work (accessing an attribute of an array)
      var result = AQL_EXECUTE("RETURN (FOR value IN @values RETURN value).name", { values: values }).json;
      assertEqual([ null ], result);
    }

  };
}



function nestedAttributeAccessTestSuite () {
  var values = [
    {'whichOne' : 1, 'foo bar' : 'searchvalue'},
    {'whichOne' : 2, 'foo.bar' : 'searchvalue'},
    {'whichOne' : 3, 'foo': {'bar': 'searchvalue'}}
  ];
  var cn = "testcol";
  var c;
  return {

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief set up
    ////////////////////////////////////////////////////////////////////////////////

    setUp : function () {
      c = db._create(cn);
      var i;
      for (i = 0; i < 3 ; i ++) {
        c.save(values[i]);
      }
    },

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief tear down
    ////////////////////////////////////////////////////////////////////////////////

    tearDown : function () {
      db._drop(cn);
    },

    ////////////////////////////////////////////////////////////////////////////////
    /// @brief test direct access
    ////////////////////////////////////////////////////////////////////////////////

    testNestedDirectAccess : function () {
      var queryRes = [
        { 'xpRes': 3, 'q': "FOR item IN @@cn FILTER item.foo.bar == 'searchvalue' RETURN item.whichOne" },
        { 'xpRes': 2, 'q': "FOR item IN @@cn FILTER item.`foo.bar` == 'searchvalue' RETURN item.whichOne" },
        { 'xpRes': 1, 'q': "FOR item IN @@cn FILTER item.`foo bar` == 'searchvalue' RETURN item.whichOne" }

      ];

      var j;
      for (j = 0; j < queryRes.length; j ++) {
        var result = AQL_EXECUTE(queryRes[j].q, {'@cn': cn});
        assertEqual(queryRes[j].xpRes, result.json[0]);
      }
    },

    testNestedDirectAccessIndexed : function () {
      var queryRes = [
        { 'xpRes': 3, 'q': "FOR item IN @@cn FILTER item.foo.bar == 'searchvalue' RETURN item.whichOne" },
        { 'xpRes': 2, 'q': "FOR item IN @@cn FILTER item.`foo.bar` == 'searchvalue' RETURN item.whichOne" },
        { 'xpRes': 1, 'q': "FOR item IN @@cn FILTER item.`foo bar` == 'searchvalue' RETURN item.whichOne" }
      ];
      c.ensureIndex({ type: "hash", fields: [ "foo.bar" ], sparse: true });
      // TODO: not yet implemented:   c.ensureIndex({ type: "hash", fields: [ "`foo.bar`" ], sparse: true });
      c.ensureIndex({ type: "hash", fields: [ "foo bar" ], sparse: true });

      var j;
      for (j = 0; j < queryRes.length; j ++) {
        var plan = AQL_EXPLAIN(queryRes[j].q, {'@cn': cn});
        // TODO: not yet implemented for #1:
        if (j !== 1) {
          assertEqual(plan.plan.nodes[1].type, 'IndexNode');
        }
        var result = AQL_EXECUTE(queryRes[j].q, {'@cn': cn});
        assertEqual(queryRes[j].xpRes, result.json[0]);
      }
    }
  };
}

////////////////////////////////////////////////////////////////////////////////
/// @brief executes the test suite
////////////////////////////////////////////////////////////////////////////////

jsunity.run(attributeAccessTestSuite);
jsunity.run(nestedAttributeAccessTestSuite);

return jsunity.done();