Class: DSLCompose::Parser::ForChildrenOfParser::ForDSLParser::ForMethodParser

Inherits:
Object
  • Object
show all
Defined in:
lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser/for_method_parser.rb

Defined Under Namespace

Classes: AllBlockParametersMustBeKeywordParametersError, MethodDoesNotExistError, MethodNamesShouldBeSymbolsError, NoBlockProvided

Instance Method Summary collapse

Constructor Details

#initialize(base_class, child_class, dsl_execution, method_names, &block) ⇒ ForMethodParser

This class will yield to the provided block once for each time a method with the provided name is called within a DSL called on the child class.

base_class and child_class are set from the ForChildrenOfParser dsl_execution is set from the ForDSLParser



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser/for_method_parser.rb', line 25

def initialize base_class, child_class, dsl_execution, method_names, &block
  @base_class = base_class
  @child_class = child_class
  @dsl_execution = dsl_execution
  @method_names = method_names

  dsl_name = dsl_execution.dsl.name

  # assert that a block was provided
  unless block
    raise NoBlockProvided
  end

  # if any arguments were provided, then assert that they are valid
  if block.parameters.any?
    # all parameters must be keyword arguments
    if block.parameters.filter { |p| p.first != :keyreq }.any?
      raise AllBlockParametersMustBeKeywordParametersError, "All block parameters must be keyword parameters, i.e. `for_children_of FooClass do |base_class:|`"
    end
  end

  # if the provided dsl name is a symbol, then convert it to an array
  if method_names.is_a? Symbol
    method_names = [method_names]
  end

  # assert that the provided dsl name is an array
  unless method_names.is_a? Array
    raise MethodNamesShouldBeSymbolsError, "Method names `#{method_names}` must be provided with a symbol or array of symbols"
  end

  # assert that the provided dsl name is an array of symbols
  unless method_names.all? { |method_name| method_name.is_a? Symbol }
    raise MethodNamesShouldBeSymbolsError, "Method names `#{method_names}` must be provided with a symbol or array of symbols"
  end

  # assert that the provided method names all exist for the scoped DSL
  unless method_names.all? { |method_name| dsl_execution.dsl.has_dsl_method?(method_name) }
    raise MethodDoesNotExistError, "Method names `#{method_names}` must all exist"
  end

  # for each provided dsl name, yield to the provided block
  method_names.each do |method_name|
    # we only provide the requested arguments to the block, this allows
    # us to use keyword arguments to force a naming convention on these arguments
    # and to validate their use
    args = {}
    if BlockArguments.accepts_argument?(:method_name, &block)
      args[:method_name] = method_name
    end

    # methods can be executed multiple times, so yield once for each method call
    # add any arguments that were provided to the DSL method
    dsl_execution.method_calls.method_calls_by_name(method_name).each do |method_call|
      # add any arguments that were provided to the method call
      method_call.arguments.arguments.each do |name, value|
        if BlockArguments.accepts_argument?(name, &block)
          # if this value is a ClassCoerce object, then convert it from its original
          # string value to a class
          args[name] = value.is_a?(ClassCoerce) ? value.to_class : value
        end
      end

      # a hash representation of all the method arguments, if requested
      if BlockArguments.accepts_argument?(:method_arguments, &block)
        args[:method_arguments] = {}
        # process each argument, because we might need to coerce it
        method_call.arguments.arguments.each do |name, value|
          # if this value is a ClassCoerce object, then convert it from its original
          # string value to a class
          args[:method_arguments][name] = value.is_a?(ClassCoerce) ? value.to_class : value
        end
      end

      # set the method_call in an instance variable so that method calls to `description`
      # from within the block will have access to it
      @method_call = method_call

      # yeild the block in the context of this class
      instance_exec(**args, &block)
    rescue => e
      # if this is an InterpreterError, then it already has the called_from metadata
      # just continue raising the original error
      if e.is_a? Interpreter::InterpreterError
        raise
      end
      # otherwise, decorate the error with where the DSL was defined
      raise e, "#{e.message}\nparsing class: #{child_class.name}\ndsl name: #{dsl_name}\ndsl method name: #{method_name}\ndsl source: #{method_call.called_from}", e.backtrace
    end
  end
end

Instance Method Details

#add_documentation(documentation) ⇒ Object

takes a description of what this parser does and stores it against the DSL definition of the current @child_class, this is used to generate documentation for what the parser has done with the DSL



120
121
122
 
# File 'lib/dsl_compose/parser/for_children_of_parser/for_dsl_parser/for_method_parser.rb', line 120

def add_documentation documentation
  @method_call.add_parser_usage_note documentation
end