FarmBot/Farmbot-Web-App

# Takes a corpus and an AST and tells you if it is syntactically valid.
# EXTREMELY COMPLICATED CODE. If you are attempting to learn the codebase, read
# this part last
module CeleryScript
  UNBOUND_VAR = "Unbound variable: %s"

  class TypeCheckError < StandardError; end

  class Checker
    MISSING_ARG = "Expected node '%s' to have a '%s', but got: %s."
    EXTRA_ARGS = "'%s' has unexpected arguments: %s. Allowed arguments: %s"
    BAD_LEAF = "Expected leaf '%{kind}' within '%{parent_kind}'" \
               " to be one of: %{allowed} but got %{actual}"
    MALFORMED = "Expected '%s' to be a node or leaf, but it was neither"
    BAD_BODY = "Body of '%s' node contains '%s' node. " \
               "Expected one of: %s"
    T_MISMATCH = "Type mismatch. %s must be one of: %s. Got: %s"
    MISSING_VAR = "You must select a Location for the Location Variable."
    MISSING_PARAM = "You must select a Default Value for the Location Variable."

    # Certain CeleryScript pairing errors are more than just a syntax error.
    # For instance, A `nothing` node in a `parameter_declaration` is often an
    # indication that the user did not fill out a value for a variable. In these
    # rare cases, we must provide information beyond what is found in the
    # BAD_LEAF template.
    FRIENDLY_ERRORS = {
      nothing: {
        write_pin: "You must select a Peripheral in the Control Peripheral step.",
        toggle_pin: "You must select a Peripheral in the Toggle Peripheral step.",
        variable_declaration: MISSING_VAR,
        parameter_declaration: MISSING_PARAM,
        read_pin: "You must select a Sensor in the Read Sensor step.",
        move_absolute: "You must select a Location in the Move To step.",
        execute: CeleryScriptSettingsBag::NO_SUB_SEQ,
      },
    }.with_indifferent_access

    attr_reader :tree, :corpus, :device

    def initialize(tree, corpus, device)
      # Device is required for security / permission checks.
      @tree, @corpus, @device = tree, corpus, device
      self.freeze
    end

    # This is the type checker entry point after initialization.
    def run!
      # NOTE: Some nodes require knowledge of
      # `Device.current` in order to validate
      # properly
      device.auto_sync_transaction do
        CeleryScript::TreeClimber.travel(tree, method(:validate).to_proc)
      end
      tree
    end

    def run
      error || tree
    end

    def valid?
      error ? false : true
    end

    def error
      run!
      nil
    rescue TypeCheckError => e
      e
    end

    def check_leaf(node)
      maybe_bad_leaf(node)
    end

    private

    def validate(node)
      p = node.try(:parent).try(:kind) || "root"
      validate_body(node)
      validate_node(node)
    end

    def validate_body(node)
      (node.body || []).each_with_index do |inner_node, i|
        allowed = corpus.bodies(node)
        body_ok = allowed.include?(inner_node.kind.to_sym)
        bad_body_kind(node, inner_node, i, allowed) unless body_ok
      end
    end

    def validate_node(node)
      check_arity(node)
      node.args.map { |array| check_arg_validity(*array) }
      corpus.validate_node(node)
    end

    def check_arity(node)
      allowed = corpus.args(node)
      allowed.map do |arg|
        has_key = node.args.has_key?(arg) || node.args.has_key?(arg.to_s)
        unless has_key
          msgs = node.args.keys.join(", ")
          msgs = "nothing" if msgs.length < 1
          msg = MISSING_ARG % [node.kind, arg, msgs]
          raise TypeCheckError, msg
        end
      end
      has = node.args.keys.map(&:to_sym) # Either bigger or equal.
      required = corpus.args(node) # Always smallest.
      if !(has.length === required.length)
        extras = has - required
        raise TypeCheckError, (EXTRA_ARGS % [node.kind, extras, allowed])
      end
    end

    def check_arg_validity(key, value)
      case value
      when AstNode
        validate_node_pairing(key, value)
      when AstLeaf
        validate_leaf_pairing(key, value)
        check_leaf(value)
      else
        malformed_node!(key)
      end
      run_additional_validations(value, key)
    end

    def validate_node_pairing(key, value)
      maybe_bad_leaf(value, key)
    end

    # This is where leaves get invalidated.
    def maybe_bad_leaf(node, key = nil)
      node.cross_check(corpus, key)
    end

    def validate_leaf_pairing(key, value)
      maybe_bad_leaf(value, key)
    end

    def bad_body_kind(prnt, child, i, ok)
      raise TypeCheckError, (BAD_BODY % [prnt.kind, child.kind, ok.inspect])
    end

    def malformed_node!(expectation)
      raise TypeCheckError, (MALFORMED % expectation)
    end

    def run_additional_validations(node, expectation)
      blk = corpus.arg_validator(expectation)
      return if blk == NOOP
      blk.call(*[node, device].first(blk.arity))
    end
  end
end