Class: Prato::Internal::SpecificationBuilder

Inherits:
Object
  • Object
show all
Defined in:
lib/prato/internal/specification_builder.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ SpecificationBuilder

Returns a new instance of SpecificationBuilder.



8
9
10
11
12
 
# File 'lib/prato/internal/specification_builder.rb', line 8

def initialize
  @config = Prato::Configuration.config
  @draft_columns = []
  @ruby_loaders = nil
end

Instance Attribute Details

#draft_columns ⇒ Object (readonly)

Returns the value of attribute draft_columns.



6
7
8
 
# File 'lib/prato/internal/specification_builder.rb', line 6

def draft_columns
  @draft_columns
end

#ruby_loaders ⇒ Object (readonly)

Returns the value of attribute ruby_loaders.



6
7
8
 
# File 'lib/prato/internal/specification_builder.rb', line 6

def ruby_loaders
  @ruby_loaders
end

Instance Method Details

#build(base_model) ⇒ Object 



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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/prato/internal/specification_builder.rb', line 81

def build(base_model)
  columns = {}
  visible_fields = []
  filterable_fields = Set.new
  sortable_fields = Set.new
  output_paths = {}
  field_lookup = {}

  @draft_columns.each do |draft|
    column_output_path = draft.output_paths.map do |path|
      transform_key_part(path, @config.key_transformation)
    end
    internal_column_name = Query::FieldResolver.join(draft.output_paths)

    if columns.key?(internal_column_name)
      raise ArgumentError,
            "Column '#{draft.name}' (internal id: #{internal_column_name}) has already been defined."
    end

    column = draft.column

    if column.is_a?(Types::DirectColumn) ||
       column.is_a?(Types::AssociationColumn) ||
       column.is_a?(Types::ExpressionColumn) ||
       column.is_a?(Types::AggregateColumn)
      column.resolve_arel!(base_model, internal_column_name)
    end

    filterable = resolve_capability(:filter, draft)
    sortable = resolve_capability(:sort, draft)

    columns[internal_column_name] = column
    visible_fields << internal_column_name unless draft.query_only
    filterable_fields << internal_column_name if filterable
    sortable_fields << internal_column_name if sortable
    output_paths[internal_column_name] = column_output_path.map(&:to_sym)
    field_lookup[column_output_path.map(&:to_s)] = internal_column_name
  end

  Specification.new(
    columns: columns,
    visible_fields: visible_fields,
    filterable_fields: filterable_fields,
    sortable_fields: sortable_fields,
    output_paths: output_paths,
    field_lookup: field_lookup,
    ruby_loaders: @ruby_loaders,
    config: @config
  )
end

#inner_column(*args, **kwargs) ⇒ Object 



19
20
21
22
 
# File 'lib/prato/internal/specification_builder.rb', line 19

def inner_column(*args, **kwargs)
  draft = build_draft(args, kwargs)
  @draft_columns << draft
end

#inner_config(config) ⇒ Object 



77
78
79
 
# File 'lib/prato/internal/specification_builder.rb', line 77

def inner_config(config)
  @config = config
end

#inner_query_column(*args, **kwargs) ⇒ Object 



24
25
26
27
 
# File 'lib/prato/internal/specification_builder.rb', line 24

def inner_query_column(*args, **kwargs)
  draft = build_draft(args, kwargs, query_only: true)
  @draft_columns << draft
end

#inner_ruby_column(*args, **kwargs, &block) ⇒ Object 



29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/prato/internal/specification_builder.rb', line 29

def inner_ruby_column(*args, **kwargs, &block)
  name_map, options = extract_name_and_options(args, kwargs, RESERVED_RUBY_COLUMN_SYMBOLS)
  display_name, loader_id = parse_name_map(name_map)

  key = parse_accessor(options[:key])
  queryable = resolve_queryable_option!(options, VALID_COLUMN_QUERYABLE)
  validate_filter_option!(options[:filter])
  column = ::Prato::Types::RubyColumn.new(loader_id, key: key, filter: options[:filter], includes: options[:includes])

  @draft_columns << DraftColumn.new(display_name, loader_id, column, queryable: queryable)
  inner_ruby_loader(loader_id, &block) if block_given?
end

#inner_ruby_loader(id, includes: nil, &block) ⇒ Object 



69
70
71
72
73
74
75
 
# File 'lib/prato/internal/specification_builder.rb', line 69

def inner_ruby_loader(id, includes: nil, &block)
  @ruby_loaders ||= {}
  @ruby_loaders[id] = {
    block: block,
    includes: includes
  }
end

#inner_section(id, &block) ⇒ Object

Raises:

  • (ArgumentError) 


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
 
# File 'lib/prato/internal/specification_builder.rb', line 42

def inner_section(id, &block)
  section = SectionBuilder.new

  raise ArgumentError, "No block given to section" unless block_given?

  section.instance_exec(&block)

  section.spec.draft_columns.each do |nested_draft|
    new_output_path = [id] + nested_draft.output_paths

    draft = DraftColumn.new(
      nested_draft.override_name,
      nested_draft.accessor_name,
      nested_draft.column,
      queryable: nested_draft.queryable,
      query_only: nested_draft.query_only,
      output_paths: new_output_path
    )

    @draft_columns << draft
  end
  return if section.spec.ruby_loaders.nil?

  @ruby_loaders ||= {}
  @ruby_loaders.merge!(section.spec.ruby_loaders)
end