imagemagick-async/im_modules/Drawables/Effects/Mod/Compare/compare.js

An API for Image Magick commands.

let Path = require('path');

let PathParts = __dirname.split(Path.sep);
let index = PathParts.indexOf('imagemagick-async');
let RootDir = PathParts.slice(0, index + 1).join(Path.sep);

let Err = require(Path.join(RootDir, 'error.js'));
let Validate = require(Path.join(RootDir, 'validate.js'));
let Filepath = require(Path.join(RootDir, 'filepath.js')).Filepath;
let CompareBaseClass = require(Path.join(Filepath.ModCompareDir(), 'comparebaseclass.js')).CompareBaseClass;

//------------------------------------

class Compare extends CompareBaseClass {
  constructor(builder) {
    super(builder);
  }

  /**
   * @override
   */
  static get Builder() {
    class Builder {
      constructor() {
        this.name = 'Compare';
        this.args = {};
        this.command = 'compare';
      }

      /**
       * @param {string} str The path of the image file used as a base for comparison.
       */
      source1(str) {
        this.args.source1 = str;
        return this;
      }

      /**
       * @param {string} str The path of the image file being compared to source1.
       */
      source2(str) {
        this.args.source2 = str;
        return this;
      }

      /**
       * @param {Color} color This color shows the differences between the two images.
       */
      highlightColor(color) {
        this.args.highlightColor = color;
        return this;
      }

      /**
       * @param {Color} color This color serves as a background for the highlight color. Omitting it results in the image from source1 being displayed in the background. (Optional)
       */
      lowlightColor(color) {
        this.args.lowlightColor = color;
        return this;
      }

      build() {
        return new Compare(this);
      }
    }
    return new Builder();
  }

  /**
   * @override
   */
  Args() {
    let args = [];

    if (this.args.highlightColor || this.args.lowlightColor) {
      args.push('-metric', 'AE', '-fuzz', '5%');

      if (this.args.highlightColor)
        args.push('-highlight-color', this.args.highlightColor.String());

      if (this.args.lowlightColor)
        args.push('-lowlight-color', this.args.lowlightColor.String());
    }

    args.push(this.args.source1, this.args.source2);

    return args;
  }

  /**
   * @override
   */
  Errors() {
    let params = Compare.Parameters();
    let errors = [];
    let prefix = 'COMPARE_COMPARE_MOD_ERROR';

    let source1Err = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Source 1')
      .condition(
        new Err.StringCondition.Builder(this.args.source1)
          .isempty(false)
          .isWhitespace(false)
          .build()
      )
      .build()
      .String();

    if (source1Err)
      errors.push(source1Err);

    let source2Err = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Source 2')
      .condition(
        new Err.StringCondition.Builder(this.args.source2)
          .isempty(false)
          .isWhitespace(false)
          .build()
      )
      .build()
      .String();

    if (source2Err)
      errors.push(source2Err);

    let highlightColorErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Highlight color')
      .condition(
        new Err.ObjectCondition.Builder(this.args.highlightColor)
          .typeName('Color')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (highlightColorErr)
      errors.push(highlightColorErr);

    let lowlightColorErr = Err.ErrorMessage.Builder
      .prefix(prefix)
      .varName('Lowlight color')
      .condition(
        new Err.ObjectCondition.Builder(this.args.lowlightColor)
          .typeName('Color')
          .checkForErrors(true)
          .build()
      )
      .build()
      .String();

    if (lowlightColorErr)
      errors.push(lowlightColorErr);

    return errors;
  }

  /**
   * @override
   */
  static Parameters() {
    return {
      source1: {
        type: 'string',
        required: true
      },
      source2: {
        type: 'string',
        required: true
      },
      highlightColor: {
        type: 'Inputs.Color',
        required: true
      },
      lowlightColor: {
        type: 'Inputs.Color',
        required: false
      }
    };
  }
}

//------------------------------
// EXPORTS

exports.Compare = Compare;