wbyoung/maguey

'use strict';

var _ = require('lodash');
var Class = require('corazon/class');

/**
 * @class FieldString
 * @classdesc
 *
 * A field-safe string. This is used to indicate that a value should not be
 * sent to the database as data (a positional argument). In general, this is
 * used via a shorthand notation of a function named `f`.
 *
 * For instance:
 *
 *     select('users').where({ firstName: 'lastName' })
 *     // -> select * from users where firstName = ?, 'lastName'
 *     select('users').where({ firstName: f('lastName') })
 *     // -> select * from users where firstName = lastName
 */
var FieldString = Class.extend(/** @lends FieldString# */ {

  /**
   * Create a field string.
   *
   * @constructor Condition.FieldString
   * @param {String} string The string to mark as field-safe.
   */
  init: function(string) {
    this._super();
    this.string = string;
  },

  /**
   * Converts to a native string. This is provided to ensure that the string
   * will appear naturally when used via many output options.
   *
   * @return {String} The string
   */
  toString: function() {
    return '' + this.string;
  },
});

FieldString.reopenClass(/** @lends FieldString */ {

  /**
   * Alias for {@link Condition.FieldString}.
   *
   * @constant {Condition.FieldString} Condition.f
   * @see {@link Condition.FieldString}
   */
  f: _.extend(FieldString.create.bind(FieldString), FieldString),

});

module.exports = FieldString.reopenClass({ __name__: 'FieldString' });