code
stringlengths 26
124k
| docstring
stringlengths 23
125k
| func_name
stringlengths 1
98
| language
stringclasses 1
value | repo
stringlengths 5
53
| path
stringlengths 7
151
| url
stringlengths 50
211
| license
stringclasses 7
values |
|---|---|---|---|---|---|---|---|
def leading_visual(
scheme: :invisible,
size: :medium,
block: false,
id: "button-preview",
align_content: :center
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content
})
end | @label Leading visual
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start]
@snapshot | leading_visual | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def leading_visual_svg(
scheme: :invisible,
size: :medium,
block: false,
id: "button-preview",
align_content: :center
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content
})
end | @label Leading visual SVG
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start]
@snapshot | leading_visual_svg | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def trailing_action(
block: false,
id: "button-preview",
align_content: :center
)
render_with_template(locals: {
block: block,
id: id,
align_content: align_content
})
end | @label Trailing action
@param block toggle
@param align_content select [center, start]
@snapshot | trailing_action | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def trailing_counter(
block: false,
id: "button-preview",
align_content: :center,
scheme: :primary
)
render_with_template(locals: {
block: block,
id: id,
align_content: align_content,
scheme: scheme
})
end | @label Trailing Counter
@param block toggle
@param align_content select [center, start]
@param scheme select [default, primary, danger, invisible]
@snapshot | trailing_counter | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def with_tooltip(
scheme: :default,
size: :medium,
block: false,
id: "button-preview",
align_content: :center
)
render_with_template(locals: {
scheme: scheme,
size: size,
block: block,
id: id,
align_content: align_content
})
end | @label With tooltip
@param scheme select [default, primary, danger, invisible, link]
@param size select [small, medium]
@param block toggle
@param align_content select [center, start] | with_tooltip | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def inactive(
id: "button-preview",
inactive: true
)
render(Primer::Beta::Button.new(
id: id,
inactive: inactive
)) do |_c|
"Button"
end
end | @label Inactive
@param inactive toggle
@snapshot | inactive | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def link_scheme_label_wrap
render_with_template(locals: {})
end | @label Link scheme with long label
@snapshot | link_scheme_label_wrap | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def small_scheme_one_character
render_with_template(locals: {})
end | @label Small scheme with one character
@snapshot | small_scheme_one_character | ruby | primer/view_components | previews/primer/beta/button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/button_preview.rb | MIT |
def playground(value: "Text to copy", aria_label: "Copy text to the system clipboard")
render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label))
end | @label Playground
@param aria_label [String]
@param value [String] | playground | ruby | primer/view_components | previews/primer/beta/clipboard_copy_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/clipboard_copy_preview.rb | MIT |
def default(value: "Text to copy", aria_label: "Copy text to the system clipboard")
render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label))
end | @label Default Options
@param aria_label [String]
@param value [String]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/clipboard_copy_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/clipboard_copy_preview.rb | MIT |
def text(value: "Text to copy", aria_label: "Click to copy!")
render(Primer::Beta::ClipboardCopy.new(value: value, "aria-label": aria_label)) { "Click to copy!" }
end | @label With text instead of icons
@param aria_label [String]
@param value [String]
@snapshot | text | ruby | primer/view_components | previews/primer/beta/clipboard_copy_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/clipboard_copy_preview.rb | MIT |
def element(aria_label: "Copy text to the system clipboard")
render_with_template(locals: { aria_label: aria_label })
end | @label Copying from an element
@param aria_label [String] | element | ruby | primer/view_components | previews/primer/beta/clipboard_copy_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/clipboard_copy_preview.rb | MIT |
def playground(reset: false, overlay: :default, disabled: false)
render Primer::Beta::Details.new(reset: reset, overlay: overlay, disabled: disabled) do |component|
component.with_summary do
"Summary"
end
component.with_body do
"Body"
end
end
end | @label Playground
@param overlay [Symbol] select [none, default, dark]
@param reset [Boolean] toggle
@param disabled [Boolean] toggle | playground | ruby | primer/view_components | previews/primer/beta/details_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/details_preview.rb | MIT |
def default(reset: false, overlay: :default, disabled: false)
render Primer::Beta::Details.new(reset: reset, overlay: overlay, disabled: disabled) do |component|
component.with_summary do
"Summary"
end
component.with_body do
"Body"
end
end
end | @label Default options
@param overlay [Symbol] select [none, default, dark]
@param reset [Boolean] toggle
@param disabled [Boolean] toggle | default | ruby | primer/view_components | previews/primer/beta/details_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/details_preview.rb | MIT |
def custom_button(reset: false, overlay: :default, disabled: false)
render Primer::Beta::Details.new(reset: reset, overlay: overlay, disabled: disabled) do |component|
component.with_summary(size: :small, scheme: :primary) { "Click me" }
component.with_body { "Body" }
end
end | @label Custom button
@param overlay [Symbol] select [none, default, dark]
@param reset [Boolean] toggle
@param disabled [Boolean] toggle | custom_button | ruby | primer/view_components | previews/primer/beta/details_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/details_preview.rb | MIT |
def without_button(reset: false, overlay: :default, disabled: false)
render Primer::Beta::Details.new(reset: reset, overlay: overlay, disabled: disabled) do |component|
component.with_summary(button: false) { "Click me" }
component.with_body { "Body" }
end
end | @label Without button
@param overlay [Symbol] select [none, default, dark]
@param reset [Boolean] toggle | without_button | ruby | primer/view_components | previews/primer/beta/details_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/details_preview.rb | MIT |
def open(reset: false, overlay: :default, disabled: false)
render Primer::Beta::Details.new(reset: reset, overlay: overlay, disabled: disabled, open: true) do |component|
component.with_summary { "Click me" }
component.with_body { "Body" }
end
end | @label Open
@param overlay [Symbol] select [none, default, dark]
@param reset [Boolean] toggle
@param disabled [Boolean] toggle | open | ruby | primer/view_components | previews/primer/beta/details_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/details_preview.rb | MIT |
def playground(full: false, spacious: false, dismissible: false, icon: :people, scheme: Primer::Beta::Flash::DEFAULT_SCHEME, content: "This is a flash message!")
render(Primer::Beta::Flash.new(full: full, spacious: spacious, dismissible: dismissible, icon: icon, scheme: scheme)) { content }
end | @label Playground
@param full toggle
@param spacious toggle
@param dismissible toggle
@param icon [Symbol] select [alert, check, info, people]
@param scheme [Symbol] select [default, warning, danger, success]
@param content text | playground | ruby | primer/view_components | previews/primer/beta/flash_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/flash_preview.rb | MIT |
def color_scheme_default
render(Primer::Beta::Flash.new) { "This is a flash message!" }
end | @!group Color Schemes
@label Default
@snapshot | color_scheme_default | ruby | primer/view_components | previews/primer/beta/flash_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/flash_preview.rb | MIT |
def options_full
render(Primer::Beta::Flash.new(full: true)) { "This is a full width flash message!" }
end | @!endgroup
@!group More options
@label Full width
@snapshot | options_full | ruby | primer/view_components | previews/primer/beta/flash_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/flash_preview.rb | MIT |
def playground(tag: :h2, content: "Heading")
render(Primer::Beta::Heading.new(tag: tag)) { content }
end | @label Playground
@param tag [Symbol] select [h1, h2, h3, h4, h5, h6]
@param content [String] text | playground | ruby | primer/view_components | previews/primer/beta/heading_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/heading_preview.rb | MIT |
def default(tag: :h2, content: "Heading")
render(Primer::Beta::Heading.new(tag: tag)) { content }
end | @label Default options
@param tag [Symbol] select [h1, h2, h3, h4, h5, h6]
@param content [String] text
@snapshot | default | ruby | primer/view_components | previews/primer/beta/heading_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/heading_preview.rb | MIT |
def playground(
scheme: :default,
size: :medium,
id: "button-preview",
tag: :button,
disabled: false,
inactive: false,
icon: :plus,
aria_label: "Button",
show_tooltip: true,
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::IconButton.new(
scheme: scheme,
size: size,
id: id,
tag: tag,
disabled: disabled,
inactive: inactive,
icon: icon,
"aria-label": aria_label,
show_tooltip: show_tooltip,
href: href
))
end | @label Playground
@param scheme select [default, danger, invisible]
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param inactive toggle
@param tag select [a, button]
@param icon [Symbol] octicon
@param show_tooltip toggle | playground | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def default(
size: :medium,
id: "button-preview",
tag: :button,
disabled: false,
icon: :star,
aria_label: "Button",
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::IconButton.new(
scheme: :default,
size: size,
id: id,
tag: tag,
disabled: disabled,
icon: icon,
"aria-label": aria_label,
href: href
))
end | @label Default
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param tag select [a, button]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def invisible(
size: :medium,
id: "button-preview",
tag: :button,
disabled: false,
icon: :x,
aria_label: "Button",
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::IconButton.new(
scheme: :invisible,
size: size,
id: id,
tag: tag,
disabled: disabled,
icon: icon,
"aria-label": aria_label,
href: href
))
end | @label Invisible
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param tag select [a, button]
@snapshot | invisible | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def primary(
size: :medium,
id: "button-preview",
tag: :button,
disabled: false,
icon: :x,
aria_label: "Button",
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::IconButton.new(
scheme: :primary,
size: size,
id: id,
tag: tag,
disabled: disabled,
icon: icon,
"aria-label": aria_label,
href: href
))
end | @label Primary
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param tag select [a, button]
@snapshot | primary | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def danger(
size: :medium,
id: "button-preview",
tag: :button,
disabled: false,
icon: :trash,
aria_label: "Button",
href: nil
)
# Sets default href to `a`, to ensure it's keyboard interactive and proper markup
if tag == :a && href.nil?
href = "#"
end
render(Primer::Beta::IconButton.new(
scheme: :danger,
size: size,
id: id,
tag: tag,
disabled: disabled,
icon: icon,
"aria-label": aria_label,
href: href
))
end | @label Danger
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param tag select [a, button]
@snapshot | danger | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def link_as_button(
size: :medium,
id: "button-preview",
tag: :a,
href: "#",
disabled: false,
icon: :star,
aria_label: "Link"
)
render(Primer::Beta::IconButton.new(
scheme: :default,
size: size,
id: id,
tag: tag,
href: href,
disabled: disabled,
icon: icon,
"aria-label": aria_label
))
end | @label Link as button
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@param href text
@snapshot | link_as_button | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def summary_as_button(
size: :medium,
id: "button-preview",
tag: :summary,
disabled: false,
icon: :star,
aria_label: "Button"
)
render_with_template(locals: {
scheme: :default,
size: size,
id: id,
tag: tag,
disabled: disabled,
icon: icon,
"aria-label": aria_label
})
end | @label Summary as button
@param size select [small, medium, large]
@param aria_label text
@param disabled toggle
@snapshot | summary_as_button | ruby | primer/view_components | previews/primer/beta/icon_button_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/icon_button_preview.rb | MIT |
def playground(size: :medium, tag: :span, inline: false, href: nil)
if tag == :a
render(Primer::Beta::Label.new(tag: tag, size: size, inline: inline, href: href || "#")) { "Link label" }
else
render(Primer::Beta::Label.new(tag: tag, size: size, inline: inline)) { "Label" }
end
end | @label Playground
@param size [Symbol] select [medium, large]
@param tag [Symbol] select [span, summary, a, div]
@param inline [Boolean] toggle
@param href [String] URL to be used with an anchor tag | playground | ruby | primer/view_components | previews/primer/beta/label_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/label_preview.rb | MIT |
def size_default
render(Primer::Beta::Label.new) { "Default" }
end | @!endgroup
@!group Sizes
@label Default
@snapshot | size_default | ruby | primer/view_components | previews/primer/beta/label_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/label_preview.rb | MIT |
def playground(scheme: :default, muted: false, underline: true, leading_visual_icon: nil, trailing_visual_icon: nil)
render(Primer::Beta::Link.new(href: "#", scheme: scheme, muted: muted, underline: underline)) do |link|
link.with_leading_visual_icon(icon: leading_visual_icon) if leading_visual_icon && leading_visual_icon != :none
link.with_trailing_visual_icon(icon: trailing_visual_icon) if trailing_visual_icon && trailing_visual_icon != :none
"This is a link!"
end
end | @label Playground
@param underline [Boolean]
@param muted [Boolean]
@param scheme [Symbol] select [default, primary, secondary]
@param leading_visual_icon [Symbol] octicon
@param trailing_visual_icon [Symbol] octicon | playground | ruby | primer/view_components | previews/primer/beta/link_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/link_preview.rb | MIT |
def default(scheme: :default, muted: false, underline: true)
render(Primer::Beta::Link.new(href: "#", scheme: scheme, muted: muted, underline: underline)) { "This is a link!" }
end | @label Default Options
@param underline [Boolean]
@param muted [Boolean]
@param scheme [Symbol] select [default, primary, secondary]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/link_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/link_preview.rb | MIT |
def tooltip(scheme: :default, muted: false, underline: true)
render(Primer::Beta::Link.new(href: "#", id: "tooltip-link", scheme: scheme, muted: muted, underline: underline)) do |component|
component.with_tooltip(text: "Tooltip text")
"Link with tooltip"
end
end | @label With Tooltip
@param underline [Boolean]
@param muted [Boolean]
@param scheme [Symbol] select [default, primary, secondary] | tooltip | ruby | primer/view_components | previews/primer/beta/link_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/link_preview.rb | MIT |
def truncate(truncate_label: :none)
render_with_template(locals: {
truncate_label: truncate_label
})
end | @label Long label truncate overflow
@param truncate_label [Symbol] select [none, truncate, show_tooltip]
@snapshot | truncate | ruby | primer/view_components | previews/primer/beta/nav_list_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/nav_list_preview.rb | MIT |
def playground(size: :small, aria_label: nil)
render(Primer::Beta::Octicon.new(icon: :people, size: size, "aria-label": aria_label))
end | @label Playground
@param aria_label [String]
@param size [Symbol] select [xsmall, small, medium] | playground | ruby | primer/view_components | previews/primer/beta/octicon_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/octicon_preview.rb | MIT |
def default(size: :small, aria_label: nil)
render(Primer::Beta::Octicon.new(icon: :people, size: size, "aria-label": aria_label))
end | @label Default Options
@param aria_label [String]
@param size [Symbol] select [xsmall, small, medium]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/octicon_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/octicon_preview.rb | MIT |
def playground(caret: :top)
render Primer::Beta::Popover.new do |component|
component.with_heading do
"Activity feed"
end
component.with_body(caret: caret) do
"This is the Popover body."
end
end
end | @label Playground
@param caret [Symbol] select [top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, left_bottom, left_top, right_bottom, right_top] | playground | ruby | primer/view_components | previews/primer/beta/popover_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/popover_preview.rb | MIT |
def default(caret: :top)
render Primer::Beta::Popover.new do |component|
component.with_heading do
"Activity feed"
end
component.with_body(caret: caret) do
"This is the Popover body."
end
end
end | @label Default
@param caret [Symbol] select [top, right, bottom, left, top_right, top_left, bottom_right, bottom_left, left_bottom, left_top, right_bottom, right_top]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/popover_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/popover_preview.rb | MIT |
def playground(size: :default)
render(Primer::Beta::ProgressBar.new(size: size)) do |component|
component.with_item(percentage: 10)
component.with_item(bg: :accent_emphasis, percentage: 20)
component.with_item(bg: :danger_emphasis, percentage: 30)
end
end | @label Playground
@param size [Symbol] select [default, small, large] | playground | ruby | primer/view_components | previews/primer/beta/progress_bar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/progress_bar_preview.rb | MIT |
def default(size: :default)
render(Primer::Beta::ProgressBar.new(size: size)) do |component|
component.with_item(percentage: 10)
component.with_item(bg: :accent_emphasis, percentage: 20)
component.with_item(bg: :danger_emphasis, percentage: 30)
end
end | @label Default
@param size [Symbol] select [default, small, large]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/progress_bar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/progress_bar_preview.rb | MIT |
def size_small
render(Primer::Beta::ProgressBar.new(size: :small)) do |component|
component.with_item(percentage: 10)
component.with_item(bg: :accent_emphasis, percentage: 20)
component.with_item(bg: :danger_emphasis, percentage: 30)
end
end | @!group Sizes
@label Size small
@snapshot | size_small | ruby | primer/view_components | previews/primer/beta/progress_bar_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/progress_bar_preview.rb | MIT |
def playground(
tense: nil,
prefix: nil,
second: nil,
minute: nil,
hour: nil,
weekday: nil,
day: nil,
month: nil,
year: nil,
time_zone_name: nil,
threshold: nil,
precision: nil,
format: nil,
format_style: nil,
datetime: Time.utc(2020, 1, 1, 0, 0, 0),
lang: nil,
title: nil,
no_title: true
)
render(Primer::Beta::RelativeTime.new(
tense: tense,
prefix: prefix,
second: second,
minute: minute,
hour: hour,
weekday: weekday,
day: day,
month: month,
year: year,
time_zone_name: time_zone_name,
threshold: threshold,
precision: precision,
format: format,
format_style: format_style,
datetime: datetime,
lang: lang,
title: title,
no_title: no_title
))
end | @label Playground
@param datetime datetime-local
@param tense [Symbol] select [~, auto, past, future]
@param prefix [String] text
@param second [Symbol] select [~, numeric, two_digit]
@param minute [Symbol] select [~, numeric, two_digit]
@param hour [Symbol] select [~, numeric, two_digit]
@param weekday [Symbol] select [~, long, short, narrow]
@param day [Symbol] select [~, numeric, two_digit]
@param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
@param year [Symbol] select [~, numeric, two_digit]
@param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
@param precision [Symbol] select [~, second, minute, hour, day, month, year]
@param format [Symbol] select [~, auto, micro, elapsed]
@param format_style [Symbol] select [~, long, short, narrow]
@param lang [String] text
@param title [String] text | playground | ruby | primer/view_components | previews/primer/beta/relative_time_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/relative_time_preview.rb | MIT |
def default(
tense: nil,
prefix: nil,
second: nil,
minute: nil,
hour: nil,
weekday: nil,
day: nil,
month: nil,
year: nil,
time_zone_name: nil,
threshold: nil,
precision: nil,
format: nil,
format_style: nil,
datetime: Time.now.utc,
lang: nil,
title: nil,
no_title: true
)
render(Primer::Beta::RelativeTime.new(
tense: tense,
prefix: prefix,
second: second,
minute: minute,
hour: hour,
weekday: weekday,
day: day,
month: month,
year: year,
time_zone_name: time_zone_name,
threshold: threshold,
precision: precision,
format: format,
format_style: format_style,
datetime: datetime,
lang: lang,
title: title,
no_title: no_title
))
end | @label Default
@param datetime datetime-local
@param tense [Symbol] select [~, auto, past, future]
@param prefix [String] text
@param second [Symbol] select [~, numeric, two_digit]
@param minute [Symbol] select [~, numeric, two_digit]
@param hour [Symbol] select [~, numeric, two_digit]
@param weekday [Symbol] select [~, long, short, narrow]
@param day [Symbol] select [~, numeric, two_digit]
@param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
@param year [Symbol] select [~, numeric, two_digit]
@param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
@param precision [Symbol] select [~, second, minute, hour, day, month, year]
@param format [Symbol] select [~, auto, micro, elapsed]
@param format_style [Symbol] select [~, long, short, narrow]
@param lang [String] text
@param title [String] text | default | ruby | primer/view_components | previews/primer/beta/relative_time_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/relative_time_preview.rb | MIT |
def micro_format(
tense: nil,
prefix: nil,
second: nil,
minute: nil,
hour: nil,
weekday: nil,
day: nil,
month: nil,
year: nil,
time_zone_name: nil,
threshold: nil,
precision: nil,
format_style: nil,
datetime: Time.now.iso8601,
lang: nil,
title: nil,
no_title: true
)
render(Primer::Beta::RelativeTime.new(
tense: tense,
prefix: prefix,
second: second,
minute: minute,
hour: hour,
weekday: weekday,
day: day,
month: month,
year: year,
time_zone_name: time_zone_name,
threshold: threshold,
precision: precision,
format: :micro,
format_style: format_style,
datetime: datetime,
lang: lang,
title: title,
no_title: no_title
))
end | @label Micro Format
@param datetime datetime-local
@param tense [Symbol] select [~, auto, past, future]
@param prefix [String] text
@param second [Symbol] select [~, numeric, two_digit]
@param minute [Symbol] select [~, numeric, two_digit]
@param hour [Symbol] select [~, numeric, two_digit]
@param weekday [Symbol] select [~, long, short, narrow]
@param day [Symbol] select [~, numeric, two_digit]
@param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
@param year [Symbol] select [~, numeric, two_digit]
@param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
@param precision [Symbol] select [~, second, minute, hour, day, month, year]
@param format_style [Symbol] select [~, long, short, narrow]
@param lang [String] text
@param title [String] text | micro_format | ruby | primer/view_components | previews/primer/beta/relative_time_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/relative_time_preview.rb | MIT |
def recent_time(
tense: nil,
prefix: nil,
second: nil,
minute: nil,
hour: nil,
weekday: nil,
day: nil,
month: nil,
year: nil,
time_zone_name: nil,
threshold: nil,
precision: nil,
format: nil,
format_style: nil,
datetime: Time.now.iso8601,
lang: nil,
title: nil,
no_title: true
)
render(Primer::Beta::RelativeTime.new(
tense: tense,
prefix: prefix,
second: second,
minute: minute,
hour: hour,
weekday: weekday,
day: day,
month: month,
year: year,
time_zone_name: time_zone_name,
threshold: threshold,
precision: precision,
format: format,
format_style: format_style,
datetime: datetime,
lang: lang,
title: title,
no_title: no_title
))
end | @label Recent Time
@param datetime datetime-local
@param tense [Symbol] select [~, auto, past, future]
@param prefix [String] text
@param second [Symbol] select [~, numeric, two_digit]
@param minute [Symbol] select [~, numeric, two_digit]
@param hour [Symbol] select [~, numeric, two_digit]
@param weekday [Symbol] select [~, long, short, narrow]
@param day [Symbol] select [~, numeric, two_digit]
@param month [Symbol] select [~, numeric, two_digit, short, long, narrow]
@param year [Symbol] select [~, numeric, two_digit]
@param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
@param precision [Symbol] select [~, second, minute, hour, day, month, year]
@param format [Symbol] select [~, auto, micro, elapsed]
@param format_style [Symbol] select [~, long, short, narrow]
@param lang [String] text
@param title [String] text | recent_time | ruby | primer/view_components | previews/primer/beta/relative_time_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/relative_time_preview.rb | MIT |
def count_down_timer(
tense: nil,
prefix: nil,
second: nil,
minute: nil,
hour: nil,
weekday: nil,
year: nil,
time_zone_name: nil,
threshold: nil,
precision: nil,
format_style: nil,
datetime: Time.utc(2038, 1, 19, 0o3, 14, 8),
lang: nil,
title: nil,
no_title: true
)
render(Primer::Beta::RelativeTime.new(
tense: tense,
prefix: prefix,
second: second,
minute: minute,
hour: hour,
weekday: weekday,
year: year,
time_zone_name: time_zone_name,
threshold: threshold,
precision: precision,
format: :elapsed,
format_style: format_style,
datetime: datetime,
lang: lang,
title: title,
no_title: no_title
))
end | @label Count Down Timer
@param datetime datetime-local
@param tense [Symbol] select [~, auto, past, future]
@param prefix [String] text
@param second [Symbol] select [~, numeric, two_digit]
@param minute [Symbol] select [~, numeric, two_digit]
@param hour [Symbol] select [~, numeric, two_digit]
@param weekday [Symbol] select [~, long, short, narrow]
@param year [Symbol] select [~, numeric, two_digit]
@param time_zone_name [Symbol] select [~, long, short, short_offset, long_offset, short_generic, long_generic]
@param precision [Symbol] select [~, second, minute, hour, day, month, year]
@param format_style [Symbol] select [~, long, short, narrow]
@param lang [String] text
@param title [String] text | count_down_timer | ruby | primer/view_components | previews/primer/beta/relative_time_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/relative_time_preview.rb | MIT |
def playground(size: :medium, sr_text: "Loading content...")
render(Primer::Beta::Spinner.new(size: size, sr_text: sr_text))
end | @label Playground
@param size [Symbol] select [small, medium, large] | playground | ruby | primer/view_components | previews/primer/beta/spinner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/spinner_preview.rb | MIT |
def default(size: :medium)
render(Primer::Beta::Spinner.new(size: size))
end | @label Default Options
@param size [Symbol] select [small, medium, large]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/spinner_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/spinner_preview.rb | MIT |
def playground(title: "State", scheme: :default, size: :default, tag: :span)
render(Primer::Beta::State.new(title: title, scheme: scheme, size: size, tag: tag)) { "State" }
end | @label Playground
@param title [String]
@param tag [Symbol] select [span, div]
@param size [Symbol] select [default, small]
@param scheme [Symbol] select [default, open, closed, merged] | playground | ruby | primer/view_components | previews/primer/beta/state_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/state_preview.rb | MIT |
def default(title: "State", scheme: :default, size: :default, tag: :span)
render(Primer::Beta::State.new(title: title, scheme: scheme, size: size, tag: tag)) { "State" }
end | @label Default
@param title [String]
@param tag [Symbol] select [span, div]
@param size [Symbol] select [default, small]
@param scheme [Symbol] select [default, open, closed, merged]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/state_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/state_preview.rb | MIT |
def sizes_default
render(Primer::Beta::State.new(title: "Default")) { "Default size" }
end | @!endgroup
@!group Sizes
@label Default
@snapshot | sizes_default | ruby | primer/view_components | previews/primer/beta/state_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/state_preview.rb | MIT |
def playground(spacious: false, hide_border: false, heading_tag: :div, heading_size: Primer::Beta::Subhead::DEFAULT_HEADING_SIZE, heading_danger: false)
render(Primer::Beta::Subhead.new(spacious: spacious, hide_border: hide_border)) do |component|
component.with_heading(tag: heading_tag, size: heading_size, danger: heading_danger) do
"My Heading"
end
component.with_description do
"My Description"
end
end
end | @label Playground
@param spacious [Boolean]
@param hide_border [Boolean]
@param heading_danger [Boolean]
@param heading_size [Symbol] select [medium, large]
@param heading_tag [Symbol] select [div, h1, h2, h3, h4, h5, h6] | playground | ruby | primer/view_components | previews/primer/beta/subhead_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/subhead_preview.rb | MIT |
def default(spacious: false, hide_border: false, heading_tag: :div, heading_size: Primer::Beta::Subhead::DEFAULT_HEADING_SIZE, heading_danger: false)
render(Primer::Beta::Subhead.new(spacious: spacious, hide_border: hide_border)) do |component|
component.with_heading(tag: heading_tag, size: heading_size, danger: heading_danger) do
"My Heading"
end
component.with_description do
"My Description"
end
end
end | @label Default Options
@param spacious [Boolean]
@param hide_border [Boolean]
@param heading_danger [Boolean]
@param heading_size [Symbol] select [medium, large]
@param heading_tag [Symbol] select [div, h1, h2, h3, h4, h5, h6]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/subhead_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/subhead_preview.rb | MIT |
def large_header
render(Primer::Beta::Subhead.new) do |component|
component.with_heading(size: :large) do
"Large Header"
end
component.with_description do
"Description"
end
end
end | @!endgroup
@!group Header size
@label Large | large_header | ruby | primer/view_components | previews/primer/beta/subhead_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/subhead_preview.rb | MIT |
def playground(tag: :span, content: "Text")
render(Primer::Beta::Text.new(tag: tag)) { content }
end | @label Playground
@param tag [Symbol] select [div, p, span]
@param content [String] text | playground | ruby | primer/view_components | previews/primer/beta/text_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/text_preview.rb | MIT |
def default(tag: :span, content: "Text")
render(Primer::Beta::Text.new(tag: tag)) { content }
end | @label Default options
@param tag [Symbol] select [div, p, span]
@param content [String] text
@snapshot | default | ruby | primer/view_components | previews/primer/beta/text_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/text_preview.rb | MIT |
def default(condensed: false)
render(Primer::Beta::TimelineItem.new(condensed: condensed)) do |component|
component.with_avatar(src: Primer::ExampleImage::BASE64_SRC, alt: "octocat")
component.with_badge(bg: :success_emphasis, color: :on_emphasis, icon: :check)
component.with_body { "Success!" }
end
end | @label Default
@param condensed [Boolean]
@snapshot | default | ruby | primer/view_components | previews/primer/beta/timeline_item_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/timeline_item_preview.rb | MIT |
def playground(text: "branch-name-that-is-really-long")
render(Primer::Beta::Truncate.new) { text }
end | @label Playground
@param text [String] text | playground | ruby | primer/view_components | previews/primer/beta/truncate_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/truncate_preview.rb | MIT |
def default(text: "branch-name-that-is-really-long")
render(Primer::Beta::Truncate.new) { text }
end | @label Default options
@param text [String] text | default | ruby | primer/view_components | previews/primer/beta/truncate_preview.rb | https://github.com/primer/view_components/blob/master/previews/primer/beta/truncate_preview.rb | MIT |
def test_renders_as_a_paragraph
render_inline(Primer::BaseComponent.new(tag: :p))
refute_text("[")
end | We were calling tag.send(as), passing in :p ended up calling `p`, aka `puts`
Due to how Rails uses method_missing in TagHelper. See Slack convo:
https://github.slack.com/archives/C0HV3F37A/p1556216733019500 | test_renders_as_a_paragraph | ruby | primer/view_components | test/components/base_component_test.rb | https://github.com/primer/view_components/blob/master/test/components/base_component_test.rb | MIT |
def test_asserts_recommended_setup_works
erb_lint_config = ERBLint::RunnerConfig.new(file_loader.yaml(".erb-lint.yml"), file_loader)
rules_enabled_in_accessibility_config = 0
erb_lint_config.to_hash["linters"].each do |linter|
rules_enabled_in_accessibility_config += 1 if linter[0].include?("Primer::Accessibility") && linter[1]["enabled"] == true
end
known_linter_names ||= ERBLint::LinterRegistry.linters.map(&:simple_name)
known_linter_names_count = known_linter_names.count { |linter| linter.include?("Primer::Accessibility") }
assert_equal 2, rules_enabled_in_accessibility_config
assert_equal 2, known_linter_names_count
end | The ability to share rules and configs from other gems in erb_lint is not well-documented.
This test validates that our recommended setup works. | test_asserts_recommended_setup_works | ruby | primer/view_components | test/lib/erblint/linter_config_works_test.rb | https://github.com/primer/view_components/blob/master/test/lib/erblint/linter_config_works_test.rb | MIT |
def test_const_source_location
ensure_autoload!
actual_loc = Primer::Forms::Utils.const_source_location("Primer::Forms::ConstSrc")
expected_loc = File.join(File.dirname(__FILE__), "const_src.rb")
assert actual_loc == expected_loc
end | This should pass under both Rubies that have the bug fix described in
https://github.com/ruby/ruby/pull/5646 and Rubies that do not. Ruby versions 2.7 to 3.1
(inclusive) are affected. See also https://bugs.ruby-lang.org/issues/18624. | test_const_source_location | ruby | primer/view_components | test/lib/primer/forms/utils_test.rb | https://github.com/primer/view_components/blob/master/test/lib/primer/forms/utils_test.rb | MIT |
def test_link_to_system_arguments_docs
assert_equal("[System arguments](/system-arguments)", link_to_system_arguments_docs)
end | We're not sure these tests are ideal. Feel free to refactor! | test_link_to_system_arguments_docs | ruby | primer/view_components | test/lib/yard/docs_helper_test.rb | https://github.com/primer/view_components/blob/master/test/lib/yard/docs_helper_test.rb | MIT |
def fill_in(locator = nil, **kwargs)
super
assert_accessible
end | Capybara Overrides to run accessibility checks when UI changes. | fill_in | ruby | primer/view_components | test/system/test_case.rb | https://github.com/primer/view_components/blob/master/test/system/test_case.rb | MIT |
def test_with_scrollable_body
visit_preview(:long_text)
click_button("Show Dialog")
end | We're just opening the dialog with a scrollable body
so the Axe scan can ensure the scrollable region is compliant | test_with_scrollable_body | ruby | primer/view_components | test/system/alpha/dialog_test.rb | https://github.com/primer/view_components/blob/master/test/system/alpha/dialog_test.rb | MIT |
def wait_for_request
count = 0
loop do
break if Primer::ViewComponents::ToggleSwitchController.last_request
count += 1
break if count >= 5
sleep 1
end
end | Toggle switches switch immediately for a11y reasons, i.e. they do not wait for the
request to finish before toggling. We used to wait for the request by asserting the
checked state, but that doesn't work anymore. This method waits for the request by
examining ToggleSwitchController.last_request. | wait_for_request | ruby | primer/view_components | test/system/alpha/toggle_switch_test.rb | https://github.com/primer/view_components/blob/master/test/system/alpha/toggle_switch_test.rb | MIT |
def without_fetch_or_fallback_raises
FetchOrFallbackHelper.fallback_raises = false
yield
ensure
FetchOrFallbackHelper.fallback_raises = true
end | For components using fetch_or_fallback,
we want to ensure that the correct
fallback behavior works in production.
The helper enables us to easily test
this production-only behavior. | without_fetch_or_fallback_raises | ruby | primer/view_components | test/test_helpers/component_test_helpers.rb | https://github.com/primer/view_components/blob/master/test/test_helpers/component_test_helpers.rb | MIT |
def should_use_simulator?
want_simulator? || ! connected?
end | deprecated. Remove when Rakefile support removed | should_use_simulator? | ruby | bendyworks/bwoken | lib/bwoken/device.rb | https://github.com/bendyworks/bwoken/blob/master/lib/bwoken/device.rb | MIT |
def want_simulator?
ENV['SIMULATOR'] && ENV['SIMULATOR'].downcase == 'true'
end | deprecated. Remove when Rakefile support removed | want_simulator? | ruby | bendyworks/bwoken | lib/bwoken/device.rb | https://github.com/bendyworks/bwoken/blob/master/lib/bwoken/device.rb | MIT |
def initialize opts
opts = opts.to_hash if opts.is_a?(Slop)
Bwoken.integration_path = opts[:'integration-path']
end | opts - A slop command object (acts like super-hash)
Only allowed option is 'integration-path' which should
have defaulted to 'integration' | initialize | ruby | bendyworks/bwoken | lib/bwoken/cli/init.rb | https://github.com/bendyworks/bwoken/blob/master/lib/bwoken/cli/init.rb | MIT |
def initialize opts
opts = opts.to_hash if opts.is_a?(Slop)
self.options = opts.to_hash.tap do |o|
o[:formatter] = 'passthru' if o[:verbose]
o[:formatter] = select_formatter(o[:formatter])
o[:simulator] = use_simulator?(o[:simulator])
o[:family] = o[:family]
end
Bwoken.integration_path = options[:'integration-path']
Bwoken.app_name = options[:'product-name']
end | opts - A slop command object (acts like super-hash)
:clobber - remove all generated files, including iOS build
:family - enum of [nil, 'iphone', 'ipad'] (case-insensitive)
:flags - custom build flag array (default: []) TODO: not yet implmented
:focus - which tests to run (default: [], meaning "all")
:formatter - custom formatter (default: 'colorful')
:scheme - custom scheme (default: nil)
:simulator - should force simulator use (default: nil)
:skip-build - do not build the iOS binary
:verbose - be verbose
:integration-path - the base directory for all the integration files
:product-name - the name of the generated .app file if it is different from the name of the project/workspace
:configuration - typically "Debug" or "Release"
:sdk-version - the version of the sdk to use when building | initialize | ruby | bendyworks/bwoken | lib/bwoken/cli/test.rb | https://github.com/bendyworks/bwoken/blob/master/lib/bwoken/cli/test.rb | MIT |
def parse_parts
importing = @string.match(%r{\A\s*#github\s+['"]?\b([^'"]*)['"]?}i)[1]
@repo_name, @file_path = importing.match(%r{([-a-z_0-9]+/[-a-z_0-9\.]+)/([-a-z_0-9/\.]*)}i)[1..2]
end | this is kinda gross. Key thing to recognize is that we're whitelisting
the account name, project name, and filename. We'll eventually be escaping
out to Kernel#`, so we shouldn't be allowing all characters (eg, ';' would be BAD) | parse_parts | ruby | bendyworks/bwoken | lib/bwoken/coffeescript/github_import_string.rb | https://github.com/bendyworks/bwoken/blob/master/lib/bwoken/coffeescript/github_import_string.rb | MIT |
def action(name, &block)
_actions[name] = block
end | Defines an action that can resolve the error.
class PendingMigrationError < MigrationError
include ActiveSupport::ActionableError
action "Run pending migrations" do
ActiveRecord::Tasks::DatabaseTasks.migrate
end
end | action | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/actionable_error.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/actionable_error.rb | Apache-2.0 |
def any?(*candidates)
if candidates.none?
super
else
candidates.any? do |candidate|
include?(candidate.to_sym) || include?(candidate.to_s)
end
end
end | Passes each element of +candidates+ collection to ArrayInquirer collection.
The method returns true if any element from the ArrayInquirer collection
is equal to the stringified or symbolized form of any element in the +candidates+ collection.
If +candidates+ collection is not given, method returns true.
variants = ActiveSupport::ArrayInquirer.new([:phone, :tablet])
variants.any? # => true
variants.any?(:phone, :tablet) # => true
variants.any?('phone', 'desktop') # => true
variants.any?(:desktop, :watch) # => false | any? | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/array_inquirer.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/array_inquirer.rb | Apache-2.0 |
def clean(backtrace, kind = :silent)
filtered = filter_backtrace(backtrace)
case kind
when :silent
silence(filtered)
when :noise
noise(filtered)
else
filtered
end
end | Returns the backtrace after all filters and silencers have been run
against it. Filters run first, then silencers. | clean | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | Apache-2.0 |
def add_filter(&block)
@filters << block
end | Adds a filter from the block provided. Each line in the backtrace will be
mapped against this filter.
# Will turn "/my/rails/root/app/models/person.rb" into "/app/models/person.rb"
backtrace_cleaner.add_filter { |line| line.gsub(Rails.root, '') } | add_filter | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | Apache-2.0 |
def add_silencer(&block)
@silencers << block
end | Adds a silencer from the block provided. If the silencer returns +true+
for a given line, it will be excluded from the clean backtrace.
# Will reject all lines that include the word "puma", like "/gems/puma/server.rb" or "/app/my_puma_server/rb"
backtrace_cleaner.add_silencer { |line| /puma/.match?(line) } | add_silencer | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | Apache-2.0 |
def remove_silencers!
@silencers = []
end | Removes all silencers, but leaves in the filters. Useful if your
context of debugging suddenly expands as you suspect a bug in one of
the libraries you use. | remove_silencers! | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | Apache-2.0 |
def remove_filters!
@filters = []
end | Removes all filters, but leaves in the silencers. Useful if you suddenly
need to see entire filepaths in the backtrace that you had already
filtered out. | remove_filters! | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/backtrace_cleaner.rb | Apache-2.0 |
def benchmark(message = "Benchmarking", options = {})
if logger
options.assert_valid_keys(:level, :silence)
options[:level] ||= :info
result = nil
ms = Benchmark.ms { result = options[:silence] ? logger.silence { yield } : yield }
logger.public_send(options[:level], "%s (%.1fms)" % [ message, ms ])
result
else
yield
end
end | Allows you to measure the execution time of a block in a template and
records the result to the log. Wrap this block around expensive operations
or possible bottlenecks to get a time reading for the operation. For
example, let's say you thought your file processing method was taking too
long; you could wrap it in a benchmark block.
<% benchmark 'Process data files' do %>
<%= expensive_files_operation %>
<% end %>
That would add something like "Process data files (345.2ms)" to the log,
which you can then use to compare timings when optimizing your code.
You may give an optional logger level (<tt>:debug</tt>, <tt>:info</tt>,
<tt>:warn</tt>, <tt>:error</tt>) as the <tt>:level</tt> option. The
default logger level value is <tt>:info</tt>.
<% benchmark 'Low-level files', level: :debug do %>
<%= lowlevel_files_operation %>
<% end %>
Finally, you can pass true as the third argument to silence all log
activity (other than the timing information) from inside the block. This
is great for boiling down a noisy block to just a single statement that
produces one log line:
<% benchmark 'Process data files', level: :info, silence: true do %>
<%= expensive_and_chatty_files_operation %>
<% end %> | benchmark | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/benchmarkable.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/benchmarkable.rb | Apache-2.0 |
def lookup_store(store = nil, *parameters)
case store
when Symbol
options = parameters.extract_options!
# clean this up once Ruby 2.7 support is dropped
# see https://github.com/rails/rails/pull/41522#discussion_r581186602
if options.empty?
retrieve_store_class(store).new(*parameters)
else
retrieve_store_class(store).new(*parameters, **options)
end
when Array
lookup_store(*store)
when nil
ActiveSupport::Cache::MemoryStore.new
else
store
end
end | Creates a new Store object according to the given options.
If no arguments are passed to this method, then a new
ActiveSupport::Cache::MemoryStore object will be returned.
If you pass a Symbol as the first argument, then a corresponding cache
store class under the ActiveSupport::Cache namespace will be created.
For example:
ActiveSupport::Cache.lookup_store(:memory_store)
# => returns a new ActiveSupport::Cache::MemoryStore object
ActiveSupport::Cache.lookup_store(:mem_cache_store)
# => returns a new ActiveSupport::Cache::MemCacheStore object
Any additional arguments will be passed to the corresponding cache store
class's constructor:
ActiveSupport::Cache.lookup_store(:file_store, '/tmp/cache')
# => same as: ActiveSupport::Cache::FileStore.new('/tmp/cache')
If the first argument is not a Symbol, then it will simply be returned:
ActiveSupport::Cache.lookup_store(MyOwnCacheStore.new)
# => returns MyOwnCacheStore.new | lookup_store | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def expand_cache_key(key, namespace = nil)
expanded_cache_key = namespace ? +"#{namespace}/" : +""
if prefix = ENV["RAILS_CACHE_ID"] || ENV["RAILS_APP_VERSION"]
expanded_cache_key << "#{prefix}/"
end
expanded_cache_key << retrieve_cache_key(key)
expanded_cache_key
end | Expands out the +key+ argument into a key that can be used for the
cache store. Optionally accepts a namespace, and all keys will be
scoped within that namespace.
If the +key+ argument provided is an array, or responds to +to_a+, then
each of elements in the array will be turned into parameters/keys and
concatenated into a single key. For example:
ActiveSupport::Cache.expand_cache_key([:foo, :bar]) # => "foo/bar"
ActiveSupport::Cache.expand_cache_key([:foo, :bar], "namespace") # => "namespace/foo/bar"
The +key+ argument can also respond to +cache_key+ or +to_param+. | expand_cache_key | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def retrieve_store_class(store)
# require_relative cannot be used here because the class might be
# provided by another gem, like redis-activesupport for example.
require "active_support/cache/#{store}"
rescue LoadError => e
raise "Could not find cache store adapter for #{store} (#{e})"
else
ActiveSupport::Cache.const_get(store.to_s.camelize)
end | Obtains the specified cache store class, given the name of the +store+.
Raises an error when the store class cannot be found. | retrieve_store_class | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def initialize(options = nil)
@options = options ? options.dup : {}
@coder = @options.delete(:coder) { self.class::DEFAULT_CODER } || NullCoder
end | Creates a new cache. The options will be passed to any write method calls
except for <tt>:namespace</tt> which can be used to set the global
namespace for the cache. | initialize | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def fetch(name, options = nil, &block)
if block_given?
options = merged_options(options)
key = normalize_key(name, options)
entry = nil
instrument(:read, name, options) do |payload|
cached_entry = read_entry(key, **options, event: payload) unless options[:force]
entry = handle_expired_entry(cached_entry, key, options)
entry = nil if entry && entry.mismatched?(normalize_version(name, options))
payload[:super_operation] = :fetch if payload
payload[:hit] = !!entry if payload
end
if entry
get_entry_value(entry, name, options)
else
save_block_result_to_cache(name, options, &block)
end
elsif options && options[:force]
raise ArgumentError, "Missing block: Calling `Cache#fetch` with `force: true` requires a block."
else
read(name, options)
end
end | Fetches data from the cache, using the given key. If there is data in
the cache with the given key, then that data is returned.
If there is no such data in the cache (a cache miss), then +nil+ will be
returned. However, if a block has been passed, that block will be passed
the key and executed in the event of a cache miss. The return value of the
block will be written to the cache under the given cache key, and that
return value will be returned.
cache.write('today', 'Monday')
cache.fetch('today') # => "Monday"
cache.fetch('city') # => nil
cache.fetch('city') do
'Duckburgh'
end
cache.fetch('city') # => "Duckburgh"
You may also specify additional options via the +options+ argument.
Setting <tt>force: true</tt> forces a cache "miss," meaning we treat
the cache value as missing even if it's present. Passing a block is
required when +force+ is true so this always results in a cache write.
cache.write('today', 'Monday')
cache.fetch('today', force: true) { 'Tuesday' } # => 'Tuesday'
cache.fetch('today', force: true) # => ArgumentError
The +:force+ option is useful when you're calling some other method to
ask whether you should force a cache write. Otherwise, it's clearer to
just call <tt>Cache#write</tt>.
Setting <tt>skip_nil: true</tt> will not cache nil result:
cache.fetch('foo') { nil }
cache.fetch('bar', skip_nil: true) { nil }
cache.exist?('foo') # => true
cache.exist?('bar') # => false
Setting <tt>compress: false</tt> disables compression of the cache entry.
Setting <tt>:expires_in</tt> will set an expiration time on the cache.
All caches support auto-expiring content after a specified number of
seconds. This value can be specified as an option to the constructor
(in which case all entries will be affected), or it can be supplied to
the +fetch+ or +write+ method to effect just one entry.
cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 5.minutes)
cache.write(key, value, expires_in: 1.minute) # Set a lower value for one entry
Setting <tt>:version</tt> verifies the cache stored under <tt>name</tt>
is of the same version. nil is returned on mismatches despite contents.
This feature is used to support recyclable cache keys.
Setting <tt>:race_condition_ttl</tt> is very useful in situations where
a cache entry is used very frequently and is under heavy load. If a
cache expires and due to heavy load several different processes will try
to read data natively and then they all will try to write to cache. To
avoid that case the first process to find an expired cache entry will
bump the cache expiration time by the value set in <tt>:race_condition_ttl</tt>.
Yes, this process is extending the time for a stale value by another few
seconds. Because of extended life of the previous cache, other processes
will continue to use slightly stale data for a just a bit longer. In the
meantime that first process will go ahead and will write into cache the
new value. After that all the processes will start getting the new value.
The key is to keep <tt>:race_condition_ttl</tt> small.
If the process regenerating the entry errors out, the entry will be
regenerated after the specified number of seconds. Also note that the
life of stale cache is extended only if it expired recently. Otherwise
a new value is generated and <tt>:race_condition_ttl</tt> does not play
any role.
# Set all values to expire after one minute.
cache = ActiveSupport::Cache::MemoryStore.new(expires_in: 1.minute)
cache.write('foo', 'original value')
val_1 = nil
val_2 = nil
sleep 60
Thread.new do
val_1 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
sleep 1
'new value 1'
end
end
Thread.new do
val_2 = cache.fetch('foo', race_condition_ttl: 10.seconds) do
'new value 2'
end
end
cache.fetch('foo') # => "original value"
sleep 10 # First thread extended the life of cache by another 10 seconds
cache.fetch('foo') # => "new value 1"
val_1 # => "new value 1"
val_2 # => "original value"
Other options will be handled by the specific cache store implementation.
Internally, #fetch calls #read_entry, and calls #write_entry on a cache
miss. +options+ will be passed to the #read and #write calls.
For example, MemCacheStore's #write method supports the +:raw+
option, which tells the memcached server to store all values as strings.
We can use this option with #fetch too:
cache = ActiveSupport::Cache::MemCacheStore.new
cache.fetch("foo", force: true, raw: true) do
:bar
end
cache.fetch('foo') # => "bar" | fetch | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def read(name, options = nil)
options = merged_options(options)
key = normalize_key(name, options)
version = normalize_version(name, options)
instrument(:read, name, options) do |payload|
entry = read_entry(key, **options, event: payload)
if entry
if entry.expired?
delete_entry(key, **options)
payload[:hit] = false if payload
nil
elsif entry.mismatched?(version)
payload[:hit] = false if payload
nil
else
payload[:hit] = true if payload
entry.value
end
else
payload[:hit] = false if payload
nil
end
end
end | Reads data from the cache, using the given key. If there is data in
the cache with the given key, then that data is returned. Otherwise,
+nil+ is returned.
Note, if data was written with the <tt>:expires_in</tt> or
<tt>:version</tt> options, both of these conditions are applied before
the data is returned.
Options are passed to the underlying cache implementation. | read | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def read_multi(*names)
options = names.extract_options!
options = merged_options(options)
instrument :read_multi, names, options do |payload|
read_multi_entries(names, **options, event: payload).tap do |results|
payload[:hits] = results.keys
end
end
end | Reads multiple values at once from the cache. Options can be passed
in the last argument.
Some cache implementation may optimize this method.
Returns a hash mapping the names provided to the values found. | read_multi | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def write_multi(hash, options = nil)
options = merged_options(options)
instrument :write_multi, hash, options do |payload|
entries = hash.each_with_object({}) do |(name, value), memo|
memo[normalize_key(name, options)] = Entry.new(value, **options.merge(version: normalize_version(name, options)))
end
write_multi_entries entries, **options
end
end | Cache Storage API to write multiple values at once. | write_multi | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def fetch_multi(*names)
raise ArgumentError, "Missing block: `Cache#fetch_multi` requires a block." unless block_given?
options = names.extract_options!
options = merged_options(options)
instrument :read_multi, names, options do |payload|
reads = read_multi_entries(names, **options)
writes = {}
ordered = names.index_with do |name|
reads.fetch(name) { writes[name] = yield(name) }
end
payload[:hits] = reads.keys
payload[:super_operation] = :fetch_multi
write_multi(writes, options)
ordered
end
end | Fetches data from the cache, using the given keys. If there is data in
the cache with the given keys, then that data is returned. Otherwise,
the supplied block is called for each key for which there was no data,
and the result will be written to the cache and returned.
Therefore, you need to pass a block that returns the data to be written
to the cache. If you do not want to write the cache when the cache is
not found, use #read_multi.
Returns a hash with the data for each of the names. For example:
cache.write("bim", "bam")
cache.fetch_multi("bim", "unknown_key") do |key|
"Fallback value for key: #{key}"
end
# => { "bim" => "bam",
# "unknown_key" => "Fallback value for key: unknown_key" }
Options are passed to the underlying cache implementation. For example:
cache.fetch_multi("fizz", expires_in: 5.seconds) do |key|
"buzz"
end
# => {"fizz"=>"buzz"}
cache.read("fizz")
# => "buzz"
sleep(6)
cache.read("fizz")
# => nil | fetch_multi | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def write(name, value, options = nil)
options = merged_options(options)
instrument(:write, name, options) do
entry = Entry.new(value, **options.merge(version: normalize_version(name, options)))
write_entry(normalize_key(name, options), entry, **options)
end
end | Writes the value to the cache, with the key.
Options are passed to the underlying cache implementation. | write | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def delete(name, options = nil)
options = merged_options(options)
instrument(:delete, name) do
delete_entry(normalize_key(name, options), **options)
end
end | Deletes an entry in the cache. Returns +true+ if an entry is deleted.
Options are passed to the underlying cache implementation. | delete | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def delete_multi(names, options = nil)
options = merged_options(options)
names.map! { |key| normalize_key(key, options) }
instrument :delete_multi, names do
delete_multi_entries(names, **options)
end
end | Deletes multiple entries in the cache.
Options are passed to the underlying cache implementation. | delete_multi | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def exist?(name, options = nil)
options = merged_options(options)
instrument(:exist?, name) do |payload|
entry = read_entry(normalize_key(name, options), **options, event: payload)
(entry && !entry.expired? && !entry.mismatched?(normalize_version(name, options))) || false
end
end | Returns +true+ if the cache contains an entry for the given key.
Options are passed to the underlying cache implementation. | exist? | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def delete_matched(matcher, options = nil)
raise NotImplementedError.new("#{self.class.name} does not support delete_matched")
end | Deletes all entries with keys matching the pattern.
Options are passed to the underlying cache implementation.
Some implementations may not support this method. | delete_matched | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def increment(name, amount = 1, options = nil)
raise NotImplementedError.new("#{self.class.name} does not support increment")
end | Increments an integer value in the cache.
Options are passed to the underlying cache implementation.
Some implementations may not support this method. | increment | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def decrement(name, amount = 1, options = nil)
raise NotImplementedError.new("#{self.class.name} does not support decrement")
end | Decrements an integer value in the cache.
Options are passed to the underlying cache implementation.
Some implementations may not support this method. | decrement | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def cleanup(options = nil)
raise NotImplementedError.new("#{self.class.name} does not support cleanup")
end | Cleanups the cache by removing expired entries.
Options are passed to the underlying cache implementation.
Some implementations may not support this method. | cleanup | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def clear(options = nil)
raise NotImplementedError.new("#{self.class.name} does not support clear")
end | Clears the entire cache. Be careful with this method since it could
affect other processes if shared cache is being used.
The options hash is passed to the underlying cache implementation.
Some implementations may not support this method. | clear | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
def key_matcher(pattern, options) # :doc:
prefix = options[:namespace].is_a?(Proc) ? options[:namespace].call : options[:namespace]
if prefix
source = pattern.source
if source.start_with?("^")
source = source[1, source.length]
else
source = ".*#{source[0, source.length]}"
end
Regexp.new("^#{Regexp.escape(prefix)}:#{source}", pattern.options)
else
pattern
end
end | Adds the namespace defined in the options to a pattern designed to
match keys. Implementations that support delete_matched should call
this method to translate a pattern that matches names into one that
matches namespaced keys. | key_matcher | ruby | collabnix/kubelabs | .bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | https://github.com/collabnix/kubelabs/blob/master/.bundles_cache/ruby/2.6.0/gems/activesupport-6.1.7.3/lib/active_support/cache.rb | Apache-2.0 |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.