Class: Lookbook::Engine

Inherits:
Rails::Engine
  • Object
show all
Defined in:
lib/lookbook/engine.rb

Class Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Class Attribute Details

.preview_controllerObject (readonly)

Returns the value of attribute preview_controller.



171
172
173
# File 'lib/lookbook/engine.rb', line 171

def preview_controller
  @preview_controller
end

Class Method Details

.app_nameObject



117
118
119
120
121
122
123
124
# File 'lib/lookbook/engine.rb', line 117

def app_name
  name = if Rails.application.class.respond_to?(:module_parent_name)
    Rails.application.class.module_parent_name
  else
    Rails.application.class.parent_name
  end
  name.underscore
end

.component_pathsObject



151
152
153
# File 'lib/lookbook/engine.rb', line 151

def component_paths
  @_component_paths ||= Array(PathUtils.to_absolute(opts.components_path))
end

.hooksObject



147
148
149
# File 'lib/lookbook/engine.rb', line 147

def hooks
  @_hooks ||= HookStore.init_from_config
end

.inputsObject



139
140
141
# File 'lib/lookbook/engine.rb', line 139

def inputs
  @_inputs ||= InputStore.init_from_config
end

.mount_pathObject



109
110
111
# File 'lib/lookbook/engine.rb', line 109

def mount_path
  routes.find_script_name({})
end

.mounted?Boolean

Returns:

  • (Boolean)


113
114
115
# File 'lib/lookbook/engine.rb', line 113

def mounted?
  mount_path.present?
end

.page_pathsObject



155
156
157
# File 'lib/lookbook/engine.rb', line 155

def page_paths
  @_page_paths ||= PathUtils.normalize_paths(opts.page_paths)
end

.pagesObject



163
164
165
# File 'lib/lookbook/engine.rb', line 163

def pages
  @_pages ||= PageCollection.new
end

.panelsObject



135
136
137
# File 'lib/lookbook/engine.rb', line 135

def panels
  @_panels ||= PanelStore.init_from_config
end

.preview_pathsObject



159
160
161
# File 'lib/lookbook/engine.rb', line 159

def preview_paths
  @_preview_paths ||= PathUtils.normalize_paths(opts.preview_paths)
end

.previewsObject



167
168
169
# File 'lib/lookbook/engine.rb', line 167

def previews
  @_previews ||= PreviewCollection.new
end

.tagsObject



143
144
145
# File 'lib/lookbook/engine.rb', line 143

def tags
  @_tags ||= TagStore.init_from_config
end

.websocketObject



126
127
128
129
130
131
132
133
# File 'lib/lookbook/engine.rb', line 126

def websocket
  if mounted?
    use_websocket = opts.auto_refresh && opts.listen && process.supports_listening?
    @websocket ||= use_websocket ? Websocket.new(mount_path, logger: Lookbook.logger) : Websocket.noop
  else
    Websocket.noop
  end
end

Instance Method Details

#file_watcherObject



96
97
98
# File 'lib/lookbook/engine.rb', line 96

def file_watcher
  @_file_watcher ||= FileWatcher.new(force_polling: opts.listen_use_polling)
end

#listen?Boolean

Returns:

  • (Boolean)


104
105
106
# File 'lib/lookbook/engine.rb', line 104

def listen?
  opts.listen && process.supports_listening?
end

#optsObject



82
83
84
# File 'lib/lookbook/engine.rb', line 82

def opts
  Lookbook.config
end

#parserObject



92
93
94
# File 'lib/lookbook/engine.rb', line 92

def parser
  @_parser ||= PreviewParser.new(opts.preview_paths, Engine.tags)
end

#processObject



100
101
102
# File 'lib/lookbook/engine.rb', line 100

def process
  @_process ||= Process.new(env: Rails.env)
end

#run_hooks(event_name, *args) ⇒ Object



86
87
88
89
90
# File 'lib/lookbook/engine.rb', line 86

def run_hooks(event_name, *args)
  Engine.hooks.for_event(event_name).each do |hook|
    hook.call(Lookbook, *args)
  end
end