module GraphQL::Client::ViewModule
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
Attributes
Public: Directory to retrieve nested GraphQL
definitions from.
Returns absolute String path under app/views.
Public: Directory to retrieve nested GraphQL
definitions from.
Returns absolute String path under app/views.
Public: if this module was defined by a view
Returns absolute String path under app/views.
Public Class Methods
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.
# File lib/graphql/client/view_module.rb, line 28 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
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”.
# File lib/graphql/client/view_module.rb, line 72 def self.valid_constant_name?(name) name.to_s =~ /^[A-Z][a-zA-Z0-9_]*$/ end
Public Instance Methods
Public: Implement constant missing hook to autoload View ERB
statics.
name - String or Symbol constant name
Returns module or raises NameError if missing.
# File lib/graphql/client/view_module.rb, line 145 def const_missing(name) load_and_set_module(name) || super 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.
# File lib/graphql/client/view_module.rb, line 46 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
# File lib/graphql/client/view_module.rb, line 127 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 mod end
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.
# File lib/graphql/client/view_module.rb, line 98 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
# File lib/graphql/client/view_module.rb, line 116 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