1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
|
# frozen_string_literal: true
require "active_support/dependencies"
require "active_support/inflector"
require "graphql/client/erubis_enhancer"
module GraphQL
class Client
# Allows a magic namespace to map to app/views/**/*.erb files to retrieve
# statically defined GraphQL definitions.
#
# # app/views/users/show.html.erb
# <%grapql
# fragment UserFragment on User { }
# %>
#
# # Loads graphql section from app/views/users/show.html.erb
# Views::Users::Show::UserFragment
#
module ViewModule
attr_accessor :client
# Public: Extract GraphQL section from ERB template.
#
# src - String ERB text
#
# Returns String GraphQL query and line number or nil or no section was
# defined.
def self.extract_graphql_section(src)
query_string = src.scan(/<%graphql([^%]+)%>/).flatten.first
return nil unless query_string
[query_string, Regexp.last_match.pre_match.count("\n") + 1]
end
# Public: Eager load module and all subdependencies.
#
# Use in production when cache_classes is true.
#
# Traverses all app/views/**/*.erb and loads all static constants defined in
# ERB files.
#
# Examples
#
# Views.eager_load!
#
# Returns nothing.
def eager_load!
return unless File.directory?(load_path)
Dir.entries(load_path).sort.each do |entry|
next if entry == "." || entry == ".."
name = entry.sub(/(\.\w+)+$/, "").camelize.to_sym
if ViewModule.valid_constant_name?(name)
mod = const_defined?(name, false) ? const_get(name) : load_and_set_module(name)
mod.eager_load! if mod
end
end
nil
end
# Internal: Check if name is a valid Ruby constant identifier.
#
# name - String or Symbol constant name
#
# Examples
#
# valid_constant_name?("Foo") #=> true
# valid_constant_name?("404") #=> false
#
# Returns true if name is a valid constant, otherwise false if name would
# result in a "NameError: wrong constant name".
def self.valid_constant_name?(name)
name.to_s =~ /^[A-Z][a-zA-Z0-9_]*$/
end
# Public: Directory to retrieve nested GraphQL definitions from.
#
# Returns absolute String path under app/views.
attr_accessor :load_path
alias_method :path=, :load_path=
alias_method :path, :load_path
# Public: if this module was defined by a view
#
# Returns absolute String path under app/views.
attr_accessor :source_path
# Internal: Initialize new module for constant name and load ERB statics.
#
# name - String or Symbol constant name.
#
# Examples
#
# Views::Users.load_module(:Profile)
# Views::Users::Profile.load_module(:Show)
#
# Returns new Module implementing Loadable concern.
def load_module(name)
pathname = ActiveSupport::Inflector.underscore(name.to_s)
path = Dir[File.join(load_path, "{#{pathname},_#{pathname}}{.*}")].sort.map { |fn| File.expand_path(fn) }.first
return if !path || File.extname(path) != ".erb"
contents = File.read(path)
query, lineno = ViewModule.extract_graphql_section(contents)
return unless query
mod = client.parse(query, path, lineno)
mod.extend(ViewModule)
mod.load_path = File.join(load_path, pathname)
mod.source_path = path
mod.client = client
mod
end
def placeholder_module(name)
dirname = File.join(load_path, ActiveSupport::Inflector.underscore(name.to_s))
return nil unless Dir.exist?(dirname)
Module.new.tap do |mod|
mod.extend(ViewModule)
mod.load_path = dirname
mod.client = client
end
end
def load_and_set_module(name)
placeholder = placeholder_module(name)
const_set(name, placeholder) if placeholder
mod = load_module(name)
return placeholder unless mod
remove_const(name) if placeholder
const_set(name, mod)
mod.unloadable if mod.respond_to?(:unloadable)
mod
end
# Public: Implement constant missing hook to autoload View ERB statics.
#
# name - String or Symbol constant name
#
# Returns module or raises NameError if missing.
def const_missing(name)
load_and_set_module(name) || super
end
end
end
end
|
