Class: Playbook::PbKit::Base

Inherits:

Object

• Object
• Playbook::PbKit::Base

Defined in:

app/pb_kits/playbook/pb_kit/base.rb

Direct Known Subclasses

Playbook::PbAvatar::Avatar, Playbook::PbBarGraph::BarGraph, Playbook::PbBody::Body, Playbook::PbButton::Button, Playbook::PbCaption::Caption, Playbook::PbCard::Card, Playbook::PbCard::CardBody, Playbook::PbCurrency::Currency, Playbook::PbDashboardValue::DashboardValue, Playbook::PbDate::Date, Playbook::PbIcon::Icon, Playbook::PbIconCircle::IconCircle, Playbook::PbIconValue::IconValue, Playbook::PbImage::Image, Playbook::PbInput::Input, Playbook::PbLabelPill::LabelPill, Playbook::PbLabelValue::LabelValue, Playbook::PbLayout::Body, Playbook::PbLayout::Layout, Playbook::PbLayout::Sidebar, Playbook::PbLineGraph::LineGraph, Playbook::PbList::Item, Playbook::PbList::List, Playbook::PbMessage::Message, Playbook::PbOnlineStatus::OnlineStatus, Playbook::PbOwner::Owner, Playbook::PbOwnerPhone::OwnerPhone, Playbook::PbPhone::Phone, Playbook::PbPill::Pill, Playbook::PbProgressSimple::ProgressSimple, Playbook::PbSectionSeparator::SectionSeparator, Playbook::PbSource::Source, Playbook::PbStarRating::StarRating, Playbook::PbStatChange::StatChange, Playbook::PbStatValue::StatValue, Playbook::PbTable::Table, Playbook::PbTime::Time, Playbook::PbTimestamp::Timestamp, Playbook::PbTitle::Title, Playbook::PbTitleCount::TitleCount, Playbook::PbTitleDetail::TitleDetail, Playbook::PbToggle::Toggle, Playbook::PbUser::User, Playbook::PbUserBadge::UserBadge, Playbook::PbVerticalNav::Item, Playbook::PbVerticalNav::VerticalNav

Instance Method Summary

• #adjusted_value(value, adjusted_value, default_value) ⇒ Object
• #aria(ui_aria = {}) ⇒ Object

  Default props =============.

• #classname(ui_classes = "") ⇒ Object
• #concat_value(value, value2) ⇒ Object
• #data(ui_data = {}) ⇒ Object
• #default_value(value, default_value) ⇒ Object

  Default value =============.

• #false_value(value, false_value = "", true_value = "") ⇒ Object
• #id(ui_id = nil) ⇒ Object
• #is_boolean?(value) ⇒ Boolean
• #is_integer?(value) ⇒ Boolean
• #is_set?(value) ⇒ Boolean
• #is_string?(value) ⇒ Boolean
• #is_true?(value) ⇒ Boolean

  Type checking =============.

• #merge_value(value, value2) ⇒ Object
• #one_of?(value, options = []) ⇒ Boolean
• #one_of_value(value, options = [], default = "") ⇒ Object
• #true_value(value, true_value = "", false_value = "") ⇒ Object

Instance Method Details

#adjusted_value(value, adjusted_value, default_value) ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 53

def adjusted_value(value, adjusted_value, default_value)
  is_set?(value) ? adjusted_value : default_value
end

#aria(ui_aria = {}) ⇒ Object

Default props =============

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 7

def aria(ui_aria = {})
  merge_value(configured_aria, ui_aria)
end

#classname(ui_classes = "") ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 11

def classname(ui_classes = "")
  concat_value(configured_classname, ui_classes)
end

#concat_value(value, value2) ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 57

def concat_value(value, value2)
  is_set?(value) ? value2 + " " + value : value2
end

#data(ui_data = {}) ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 15

def data(ui_data = {})
  merge_value(configured_data, ui_data)
end

#default_value(value, default_value) ⇒ Object

Default value =============

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 49

def default_value(value, default_value)
  is_set?(value) ? value : default_value
end

#false_value(value, false_value = "", true_value = "") ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 82

def false_value(value, false_value = "", true_value = "")
  if is_set?(value)
    is_true?(value) ? true_value : false_value
  else
    false_value
  end
end

#id(ui_id = nil) ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 19

def id(ui_id = nil)
  default_value(configured_id, ui_id)
end

#is_boolean?(value) ⇒ Boolean

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 36

def is_boolean?(value)
  [true, false].include? value
end

#is_integer?(value) ⇒ Boolean

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 32

def is_integer?(value)
  value.is_a? Integer
end

#is_set?(value) ⇒ Boolean

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 44

def is_set?(value)
  value != default_configuration
end

#is_string?(value) ⇒ Boolean

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 28

def is_string?(value)
  value.is_a? String
end

#is_true?(value) ⇒ Boolean

Type checking =============

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 24

def is_true?(value)
  is_boolean?(value) && value == true
end

#merge_value(value, value2) ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 61

def merge_value(value, value2)
  value2 ||= {}
  is_set?(value) ? value.merge(value2) : value2
end

#one_of?(value, options = []) ⇒ Boolean

Returns:

• (Boolean)

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 40

def one_of?(value, options = [])
  options.include? value
end

#one_of_value(value, options = [], default = "") ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 66

def one_of_value(value, options = [], default = "")
  if is_set?(value)
    options.include?(value) ? value : default
  else
    default
  end
end

#true_value(value, true_value = "", false_value = "") ⇒ Object

# File 'app/pb_kits/playbook/pb_kit/base.rb', line 74

def true_value(value, true_value = "", false_value = "")
  if is_set?(value)
    is_true?(value) ? true_value : false_value
  else
    false_value
  end
end