Class: Card::Name

Inherits:
Cardname
  • Object
show all
Includes:
FieldsAndTraits, NameVariants
Defined in:
lib/card/name.rb,
lib/card/name/all.rb,
lib/card/name/all/parts.rb,
lib/card/name/name_variants.rb,
lib/card/name/all/descendants.rb,
lib/card/name/all/class_methods.rb,
lib/card/name/fields_and_traits.rb

Overview

The Cardname class provides generalized of Card naming patterns (compound names, key-based variants, etc)

Card::Name adds support for deeper card integration

Defined Under Namespace

Modules: All, FieldsAndTraits, NameVariants

Class Method Summary collapse

Instance Method Summary collapse

Methods included from NameVariants

#card, #card_id, #codename, #standard, #vary

Methods included from FieldsAndTraits

#field, #field_name, #field_of?, #field_only?, #relative_field_name, #trait, #trait_name, #trait_name?

Class Method Details

.[](*cardish) ⇒ Object 



17
18
19
20
21
22
23
24
25
26
27
 
# File 'lib/card/name.rb', line 17

def [] *cardish
  cardish = cardish.first if cardish.size <= 1
  case cardish
  when Card             then cardish.name
  when Symbol, Integer  then Card.fetch_name(cardish)
  when Array            then smart_compose cardish
  when String, NilClass then new cardish
  else
    raise ArgumentError, "#{cardish.class} not supported as name identifier"
  end
end

.compose(parts) ⇒ Object 



57
58
59
60
 
# File 'lib/card/name.rb', line 57

def compose parts
  name_parts = parts.flatten.map { |part| new part }
  new name_parts.join(joint), true
end

.new(str, validated_parts = nil) ⇒ Object 



37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/card/name.rb', line 37

def new str, validated_parts=nil
  return compose str if str.is_a?(Array)

  str = str.to_s

  if !validated_parts && str.include?(joint)
    compose Cardname.split_parts(str)
  elsif (id = Card.id_from_string(str))  # handles ~ and :
    Card.fetch_name(id) { Card.bad_mark(str) }
  else
    super str
  end
end

.params ⇒ Object 



33
34
35
 
# File 'lib/card/name.rb', line 33

def params
  Card::Env.params
end

.session ⇒ Object 



29
30
31
 
# File 'lib/card/name.rb', line 29

def session
  Card::Auth.current.name # also_yuck
end

.smart_compose(parts) ⇒ Object

interprets symbols/integers as codenames/ids



52
53
54
55
 
# File 'lib/card/name.rb', line 52

def smart_compose parts
  name_parts = parts.flatten.map { |part| self[part] }
  new name_parts.join(joint), true
end

.url_key_to_standard(key) ⇒ Object 



62
63
64
 
# File 'lib/card/name.rb', line 62

def url_key_to_standard key
  key.to_s.tr "_", " "
end

Instance Method Details

#code ⇒ Object 



75
76
77
 
# File 'lib/card/name.rb', line 75

def code
  Card::Codename[Card.fetch_id self]
end

#rstar? ⇒ Boolean

Returns:

  • (Boolean) 


71
72
73
 
# File 'lib/card/name.rb', line 71

def rstar?
  right && right[0, 1] == "*"
end

#set? ⇒ Boolean

Returns:

  • (Boolean) 


83
84
85
 
# File 'lib/card/name.rb', line 83

def set?
  Set::Pattern.card_keys[tag_name.key]
end

#setting? ⇒ Boolean

Returns:

  • (Boolean) 


79
80
81
 
# File 'lib/card/name.rb', line 79

def setting?
  Set::Type::Setting.member_names[key]
end

#star? ⇒ Boolean

Returns:

  • (Boolean) 


67
68
69
 
# File 'lib/card/name.rb', line 67

def star?
  simple? && s[0, 1] == "*"
end