Class: ViewComponent::Preview

Inherits:
Object
  • Object
show all
Extended by:
ActiveSupport::DescendantsTracker
Includes:
ActionView::Helpers::TagHelper
Defined in:
lib/view_component/preview.rb

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.all ⇒ Object

Returns all component preview classes.



31
32
33
34
 
# File 'lib/view_component/preview.rb', line 31

def all
  load_previews if descendants.empty?
  descendants
end

.component ⇒ Object

Returns the component object class associated to the preview.



48
49
50
 
# File 'lib/view_component/preview.rb', line 48

def component
  name.chomp("Preview").constantize
end

.example_exists?(example) ⇒ Boolean

Returns true if the example of the component preview exists.

Returns:

  • (Boolean) 


58
59
60
 
# File 'lib/view_component/preview.rb', line 58

def example_exists?(example)
  examples.include?(example)
end

.examples ⇒ Object

Returns all of the available examples for the component preview.



53
54
55
 
# File 'lib/view_component/preview.rb', line 53

def examples
  public_instance_methods(false).map(&:to_s).sort
end

.exists?(preview) ⇒ Boolean

Returns true if the preview exists.

Returns:

  • (Boolean) 


63
64
65
 
# File 'lib/view_component/preview.rb', line 63

def exists?(preview)
  all.any? { |p| p.preview_name == preview }
end

.find(preview) ⇒ Object

Find a component preview by its underscored class name.



68
69
70
 
# File 'lib/view_component/preview.rb', line 68

def find(preview)
  all.find { |p| p.preview_name == preview }
end

.layout(layout_name) ⇒ Object

Setter for layout name.



78
79
80
 
# File 'lib/view_component/preview.rb', line 78

def layout(layout_name)
  @layout = layout_name
end

.preview_example_template_path(example) ⇒ Object

Returns the relative path (from preview_path) to the preview example template if the template exists



83
84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/view_component/preview.rb', line 83

def preview_example_template_path(example)
  preview_path = Array(preview_paths).detect do |preview_path|
    Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
  end

  if preview_path.nil?
    raise PreviewTemplateError, "preview template for example #{example} does not exist"
  end

  path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
  Pathname.new(path).relative_path_from(Pathname.new(preview_path)).to_s
end

.preview_name ⇒ Object

Returns the underscored name of the component preview without the suffix.



73
74
75
 
# File 'lib/view_component/preview.rb', line 73

def preview_name
  name.chomp("Preview").underscore
end

.render_args(example, params: {}) ⇒ Object

Returns the arguments for rendering of the component in its layout



37
38
39
40
41
42
43
44
45
 
# File 'lib/view_component/preview.rb', line 37

def render_args(example, params: {})
  example_params_names = instance_method(example).parameters.map(&:last)
  provided_params = params.slice(*example_params_names).to_h.symbolize_keys
  result = provided_params.empty? ? new.public_send(example) : new.public_send(example, **provided_params)
  result ||= {}
  result[:template] = preview_example_template_path(example) if result[:template].nil?
  @layout = nil unless defined?(@layout)
  result.merge(layout: @layout)
end

Instance Method Details

#render(component, **args, &block) ⇒ Object Also known as: render_component 



10
11
12
13
14
15
16
17
18
 
# File 'lib/view_component/preview.rb', line 10

def render(component, **args, &block)
  {
    args: args,
    block: block,
    component: component,
    locals: {},
    template: "view_components/preview",
  }
end

#render_with_template(template: nil, locals: {}) ⇒ Object 



20
21
22
23
24
25
 
# File 'lib/view_component/preview.rb', line 20

def render_with_template(template: nil, locals: {})
  {
    template: template,
    locals: locals
  }
end