module Fauna
  ##
  # Helpers modeling the FaunaDB \Query language.
  #
  # Helpers are usually used via a concise DSL notation. A DSL block
  # may be used directly with Fauna::Client
  #
  #   client.query { create(ref('classes', 'spells'), { data: { name: 'Magic Missile' } }) }
  #
  # To build and return an query expression to execute later, use Fauna::Query.expr
  #
  #   Fauna::Query.expr { create(ref('classes', 'spells'), { data: { name: 'Magic Missile' } }) }
  #
  # Or, you may directly use the helper methods:
  #
  #   Fauna::Query.create(Fauna::Query.ref('classes', 'spells'), { data: { name: 'Magic Missile' } })
  module Query
    extend self

    class QueryDSLContext < DSLContext # :nodoc:
      include Query
    end

    ##
    # Build a query expression.
    #
    # Allows for unscoped calls to Fauna::Query methods within the
    # provided block. The block should return the constructed query
    # expression.
    #
    # Example: <code>Fauna::Query.expr { add(1, 2, subtract(3, 2)) }</code>
    def self.expr(&block)
      return nil if block.nil?

      dsl = QueryDSLContext.new

      Expr.wrap DSLContext.eval_dsl(dsl, &block)
    end

    # :section: Values

    ##
    # Construct a ref value
    #
    # Reference: {FaunaDB Values}[https://fauna.com/documentation/queries#values]
    def ref(str, id = nil)
      if id.nil?
        Ref.new(str)
      else
        Expr.new ref: Expr.wrap(str), id: Expr.wrap(id)
      end
    end

    ##
    # An object expression
    #
    # Query expression constructs can also take a regular ruby object, so the following are equivalent:
    #
    #   Fauna.query { { x: 1, y: add(1, 2) } }
    #   Fauna.query { object(x: 1, y: add(1, 2)) }
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def object(fields)
      Expr.new object: Expr.wrap_values(fields)
    end

    ##
    # A query expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def query(expr)
      Expr.new query: Expr.wrap(expr)
    end

    # :section: Basic forms

    ##
    # An at expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def at(timestamp, expr)
      Expr.new at: Expr.wrap(timestamp), expr: Expr.wrap(expr)
    end

    ##
    # A let expression
    #
    # Only one of +expr+ or +block+ should be provided.
    #
    # Block example: <code>Fauna.query { let(x: 2) { add(1, x) } }</code>.
    #
    # Expression example: <code>Fauna.query { let({ x: 2 }, add(1, var(:x))) }</code>.
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def let(vars, expr = nil, &block)
      in_ =
        if block.nil?
          expr
        else
          dsl = QueryDSLContext.new
          dslcls = (class << dsl; self; end)

          vars.keys.each do |v|
            dslcls.send(:define_method, v) { var(v) }
          end

          DSLContext.eval_dsl(dsl, &block)
        end

      Expr.new let: Expr.wrap_values(vars), in: Expr.wrap(in_)
    end

    ##
    # A var expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def var(name)
      Expr.new var: Expr.wrap(name)
    end

    ##
    # An if expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def if_(condition, then_, else_)
      Expr.new if: Expr.wrap(condition), then: Expr.wrap(then_), else: Expr.wrap(else_)
    end

    ##
    # A do expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def do_(*expressions)
      Expr.new do: Expr.wrap_varargs(expressions)
    end

    ##
    # A lambda expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    #
    # This form generates #var objects for you, and is called like:
    #
    #   Query.lambda do |a|
    #     Query.add a, a
    #   end
    #   # Produces: {lambda: :a, expr: {add: [{var: :a}, {var: :a}]}}
    #
    # Query functions requiring lambdas can be passed blocks without explicitly calling #lambda.
    #
    # You can also use #lambda_expr and #var directly.
    # +block+::
    #   Takes one or more #var expressions and uses them to construct an expression.
    #   If this takes more than one argument, the lambda destructures an array argument.
    #   (To destructure single-element arrays use #lambda_expr.)
    def lambda(&block)
      dsl = Query::QueryDSLContext.new
      vars =
        block.parameters.map do |kind, name|
          fail ArgumentError, 'Splat parameters are not supported in lambda expressions.' if kind == :rest
          name
        end

      case vars.length
      when 0
        fail ArgumentError, 'Block must take at least 1 argument.'
      when 1
        # When there's only 1 parameter, don't use an array pattern.
        lambda_expr vars[0], DSLContext.eval_dsl(dsl, var(vars[0]), &block)
      else
        lambda_expr vars, DSLContext.eval_dsl(dsl, *(vars.map { |v| var(v) }), &block)
      end
    end

    ##
    # A raw lambda expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    #
    # See also #lambda.
    def lambda_expr(var, expr)
      Expr.new lambda: Expr.wrap(var), expr: Expr.wrap(expr)
    end

    ##
    # A call expression
    #
    # Reference: {FaunaDB Basic Forms}[https://fauna.com/documentation/queries#basic_forms]
    def call(name, *args)
      Expr.new call: Expr.wrap(name), arguments: Expr.wrap_varargs(args)
    end

    # :section: Collection Functions

    ##
    # A map expression
    #
    # Only one of +lambda_expr+ or +lambda_block+ should be provided.
    # For example: <code>Fauna.query { map(collection) { |a| add a, 1 } }</code>.
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def map(collection, lambda_expr = nil, &lambda_block)
      Expr.new map: Expr.wrap(lambda_expr || lambda_block), collection: Expr.wrap(collection)
    end

    ##
    # A foreach expression
    #
    # Only one of +lambda_expr+ or +lambda_block+ should be provided.
    # For example: <code>Fauna.query { foreach(collection) { |a| delete a } }</code>.
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def foreach(collection, lambda_expr = nil, &lambda_block)
      Expr.new foreach: Expr.wrap(lambda_expr || lambda_block), collection: Expr.wrap(collection)
    end

    ##
    # A filter expression
    #
    # Only one of +lambda_expr+ or +lambda_block+ should be provided.
    # For example: <code>Fauna.query { filter(collection) { |a| equals a, 1 } }</code>.
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def filter(collection, lambda_expr = nil, &lambda_block)
      Expr.new filter: Expr.wrap(lambda_expr || lambda_block), collection: Expr.wrap(collection)
    end

    ##
    # A take expression
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def take(number, collection)
      Expr.new take: Expr.wrap(number), collection: Expr.wrap(collection)
    end

    ##
    # A drop expression
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def drop(number, collection)
      Expr.new drop: Expr.wrap(number), collection: Expr.wrap(collection)
    end

    ##
    # A prepend expression
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def prepend(collection, elements)
      Expr.new prepend: Expr.wrap(elements), collection: Expr.wrap(collection)
    end

    ##
    # An append expression
    #
    # Reference: {FaunaDB Collections}[https://fauna.com/documentation/queries#collection_functions]
    def append(collection, elements)
      Expr.new append: Expr.wrap(elements), collection: Expr.wrap(collection)
    end

    # :section: Read Functions

    ##
    # A get expression
    #
    # Reference: {FaunaDB Read functions}[https://fauna.com/documentation/queries#read_functions]
    def get(ref, params = {})
      Expr.new Expr.wrap_values(params).merge(get: Expr.wrap(ref))
    end

    ##
    # A key_from_secret expression
    #
    # Reference: {FaunaDB Read functions}[https://fauna.com/documentation/queries#read_functions]
    def key_from_secret(secret)
      Expr.new key_from_secret: Expr.wrap(secret)
    end

    ##
    # A paginate expression
    #
    # Reference: {FaunaDB Read functions}[https://fauna.com/documentation/queries#read_functions]
    def paginate(set, params = {})
      Expr.new Expr.wrap_values(params).merge(paginate: Expr.wrap(set))
    end

    ##
    # An exists expression
    #
    # Reference: {FaunaDB Read functions}[https://fauna.com/documentation/queries#read_functions]
    def exists(ref, params = {})
      Expr.new Expr.wrap_values(params).merge(exists: Expr.wrap(ref))
    end

    # :section: Write Functions

    ##
    # A create expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create(class_ref, params)
      Expr.new create: Expr.wrap(class_ref), params: Expr.wrap(params)
    end

    ##
    # An update expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def update(ref, params)
      Expr.new update: Expr.wrap(ref), params: Expr.wrap(params)
    end

    ##
    # A replace expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def replace(ref, params)
      Expr.new replace: Expr.wrap(ref), params: Expr.wrap(params)
    end

    ##
    # A delete expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def delete(ref)
      Expr.new delete: Expr.wrap(ref)
    end

    ##
    # An insert expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def insert(ref, ts, action, params)
      Expr.new insert: Expr.wrap(ref), ts: Expr.wrap(ts), action: Expr.wrap(action), params: Expr.wrap(params)
    end

    ##
    # A remove expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def remove(ref, ts, action)
      Expr.new remove: Expr.wrap(ref), ts: Expr.wrap(ts), action: Expr.wrap(action)
    end

    ##
    # A create class expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create_class(params)
      Expr.new create_class: Expr.wrap(params)
    end

    ##
    # A create index expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create_index(params)
      Expr.new create_index: Expr.wrap(params)
    end

    ##
    # A create database expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create_database(params)
      Expr.new create_database: Expr.wrap(params)
    end

    ##
    # A create key expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create_key(params)
      Expr.new create_key: Expr.wrap(params)
    end

    ##
    # A create function expression
    #
    # Reference: {FaunaDB Write functions}[https://fauna.com/documentation/queries#write_functions]
    def create_function(params)
      Expr.new create_function: Expr.wrap(params)
    end

    # :section: Set Functions

    ##
    # A match expression
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def match(index, *terms)
      Expr.new match: Expr.wrap(index), terms: Expr.wrap_varargs(terms)
    end

    ##
    # A union expression
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def union(*sets)
      Expr.new union: Expr.wrap_varargs(sets)
    end

    ##
    # An intersection expression
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def intersection(*sets)
      Expr.new intersection: Expr.wrap_varargs(sets)
    end

    ##
    # A difference expression
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def difference(*sets)
      Expr.new difference: Expr.wrap_varargs(sets)
    end

    ##
    # A distinct expression
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def distinct(set)
      Expr.new distinct: Expr.wrap(set)
    end

    ##
    # A join expression
    #
    # Only one of +target_expr+ or +target_block+ should be provided.
    # For example: <code>Fauna.query { join(source) { |x| match some_index, x } }</code>.
    #
    # Reference: {FaunaDB Sets}[https://fauna.com/documentation/queries#sets]
    def join(source, target_expr = nil, &target_block)
      Expr.new join: Expr.wrap(source), with: Expr.wrap(target_expr || target_block)
    end

    # :section: Authentication Functions

    ##
    # A login function
    #
    # Reference: {FaunaDB Authentication}[https://fauna.com/documentation/queries#auth_functions]
    def login(ref, params)
      Expr.new login: Expr.wrap(ref), params: Expr.wrap(params)
    end

    ##
    # A logout function
    #
    # Reference: {FaunaDB Authentication}[https://fauna.com/documentation/queries#auth_functions]
    def logout(all_tokens)
      Expr.new logout: Expr.wrap(all_tokens)
    end

    ##
    # An identify function
    #
    # Reference: {FaunaDB Authentication}[https://fauna.com/documentation/queries#auth_functions]
    def identify(ref, password)
      Expr.new identify: Expr.wrap(ref), password: Expr.wrap(password)
    end

    # :section: String Functions

    ##
    # A concat function
    #
    # Reference: {FaunaDB String Functions}[https://fauna.com/documentation/queries#string_functions]
    def concat(strings, separator = nil)
      if separator.nil?
        Expr.new concat: Expr.wrap(strings)
      else
        Expr.new concat: Expr.wrap(strings), separator: Expr.wrap(separator)
      end
    end

    ##
    # A casefold function
    #
    # Reference: {FaunaDB String Functions}[https://fauna.com/documentation/queries#string_functions]
    def casefold(string)
      Expr.new casefold: Expr.wrap(string)
    end

    # :section: Time and Date Functions

    ##
    # A time expression
    #
    # Reference: {FaunaDB Time Functions}[https://fauna.com/documentation/queries#time_functions]
    def time(string)
      Expr.new time: Expr.wrap(string)
    end

    ##
    # An epoch expression
    #
    # Reference: {FaunaDB Time Functions}[https://fauna.com/documentation/queries#time_functions]
    def epoch(number, unit)
      Expr.new epoch: Expr.wrap(number), unit: Expr.wrap(unit)
    end

    ##
    # A date expression
    #
    # Reference: {FaunaDB Time Functions}[https://fauna.com/documentation/queries#time_functions]
    def date(string)
      Expr.new date: Expr.wrap(string)
    end

    # :section: Miscellaneous Functions

    ##
    # A next_id function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def next_id
      Expr.new next_id: nil
    end

    ##
    # A database function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def database(name)
      Expr.new database: Expr.wrap(name)
    end

    ##
    # A class function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def class_(name)
      Expr.new class: Expr.wrap(name)
    end

    ##
    # An index function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def index(name)
      Expr.new index: Expr.wrap(name)
    end

    ##
    # A function function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def function(name)
      Expr.new function: Expr.wrap(name)
    end

    ##
    # An equals function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation#queries-misc_functions]
    def equals(*values)
      Expr.new equals: Expr.wrap_varargs(values)
    end

    ##
    # A contains function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def contains(path, in_)
      Expr.new contains: Expr.wrap(path), in: Expr.wrap(in_)
    end

    ##
    # A select function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def select(path, from, params = {})
      Expr.new Expr.wrap_values(params).merge(select: Expr.wrap(path), from: Expr.wrap(from))
    end

    ##
    # An add function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def add(*numbers)
      Expr.new add: Expr.wrap_varargs(numbers)
    end

    ##
    # A multiply function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def multiply(*numbers)
      Expr.new multiply: Expr.wrap_varargs(numbers)
    end

    ##
    # A subtract function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def subtract(*numbers)
      Expr.new subtract: Expr.wrap_varargs(numbers)
    end

    ##
    # A divide function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def divide(*numbers)
      Expr.new divide: Expr.wrap_varargs(numbers)
    end

    ##
    # A modulo function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def modulo(*numbers)
      Expr.new modulo: Expr.wrap_varargs(numbers)
    end

    ##
    # A less than function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def lt(*values)
      Expr.new lt: Expr.wrap_varargs(values)
    end

    ##
    # A less than or equal function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def lte(*values)
      Expr.new lte: Expr.wrap_varargs(values)
    end

    ##
    # A greater than function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def gt(*values)
      Expr.new gt: Expr.wrap_varargs(values)
    end

    ##
    # A greater than or equal function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def gte(*values)
      Expr.new gte: Expr.wrap_varargs(values)
    end

    ##
    # An and function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def and_(*booleans)
      Expr.new and: Expr.wrap_varargs(booleans)
    end

    ##
    # An or function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def or_(*booleans)
      Expr.new or: Expr.wrap_varargs(booleans)
    end

    ##
    # A not function
    #
    # Reference: {FaunaDB Miscellaneous Functions}[https://fauna.com/documentation/queries#misc_functions]
    def not_(boolean)
      Expr.new not: Expr.wrap(boolean)
    end

    class Expr # :nodoc:
      attr_reader :raw
      alias_method :to_hash, :raw

      def initialize(obj)
        @raw = obj
      end

      def to_s
        "Expr(#{@raw})"
      end

      alias_method :inspect, :to_s

      def ==(other)
        return false unless other.is_a? Expr
        raw == other.raw
      end

      alias_method :eql?, :==

      def self.wrap(obj)
        if obj.is_a? Expr
          obj
        elsif obj.is_a? Proc
          Query.lambda(&obj)
        elsif obj.is_a? Hash
          Expr.new object: wrap_values(obj)
        elsif obj.is_a? Array
          Expr.new obj.map { |v| wrap(v) }
        else
          obj
        end
      end

      def self.wrap_values(obj)
        obj.inject({}) { |h, (k, v)| h[k] = wrap(v); h }
      end

      def self.wrap_varargs(values)
        wrap(values.length == 1 ? values[0] : values)
      end
    end
  end
end