Class: Card::Codename

Inherits:
Object
  • Object
show all
Defined in:
lib/card/codename.rb

Overview

Card‘s names can be changed, and therefore names should not be directly mentioned in code, lest a name change break the application.

Instead, a Card that needs specific code manipulations should be given a Codename, which will not change even if the card’s name does.

An administrator might add to the Company card via the RESTful web API with a url like

/update/CARDNAME?card[codename]=CODENAME

…or via the api like

Card[CARDNAME].update! codename: CODENAME

Generally speaking, codenames are represented by Symbols.

The Codename class provides a fast cache for this slow-changing data. Every process maintains a complete cache that is not frequently reset

Class Method Summary collapse

Class Method Details

.[](codename) ⇒ Symbol

returns codename for id and id for codename

Parameters:

Returns:

  • (Symbol) 


37
38
39
40
41
42
43
44
 
# File 'lib/card/codename.rb', line 37

def [] codename
  case codename
  when Integer
    codehash[:i2c][codename]
  when Symbol, String
    codehash[:c2i].key?(codename.to_sym) ? codename.to_sym : nil
  end
end

.card(codename) ⇒ Card

Parameters:

  • codename (Symbol, String)

Returns:



65
66
67
68
69
70
71
 
# File 'lib/card/codename.rb', line 65

def card codename
  if (card_id = id(codename))
    Card[card_id]
  elsif block_given?
    yield
  end
end

.codehash ⇒ Hash

A hash of two hashes:

  • the c2i hash has codenames (symbols) as keys and ids (integers) as values

  • the i2c hash has the opposite.

Returns:

  • (Hash) —

    (the codehash)



137
138
139
 
# File 'lib/card/codename.rb', line 137

def codehash
  @codehash ||= load_codehash
end

.exist?(codename) ⇒ True/False Also known as: exists?

Parameters:

  • codename (Symbol, String)

Returns:

  • (True/False) 


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

def exist? codename
  id(codename).present?
end

.generate_id_constants ⇒ Object

Creates ruby constants for codenames. Eg, if a card has the codename gibbon, then Card::GibbonID will contain the id for that card.



105
106
107
108
109
 
# File 'lib/card/codename.rb', line 105

def generate_id_constants
  codehash[:c2i].each do |codename, id|
    Card.const_get_or_set("#{codename.to_s.camelize}ID") { id }
  end
end

.id(codename) ⇒ Integer

Parameters:

  • codename (Symbol, String)

Returns:

  • (Integer) 


48
49
50
51
52
53
54
55
 
# File 'lib/card/codename.rb', line 48

def id codename
  case codename
  when Symbol, String
    codehash[:c2i][codename.to_sym]
  when Integer
    codehash[:i2c].key?(codename) ? codename : nil
  end
end

.id!(codename) ⇒ Integer

Parameters:

  • codename (Symbol, String)

Returns:

  • (Integer) 


88
89
90
 
# File 'lib/card/codename.rb', line 88

def id! codename
  id(codename) || unknown_codename!(codename)
end

.ids ⇒ Array<Integer>

Returns list of ids of cards with codenames.

Returns:

  • (Array<Integer>) —

    list of ids of cards with codenames



99
100
101
 
# File 'lib/card/codename.rb', line 99

def ids
  codehash[:i2c].keys
end

.name(codename) ⇒ Card::Name

Parameters:

  • codename (Symbol, String)

Returns:



59
60
61
 
# File 'lib/card/codename.rb', line 59

def name codename
  (card_id = id codename) && Lexicon.name(card_id)
end

.name!(codename) ⇒ Card::Name

Parameters:

  • codename (Symbol, String)

Returns:



94
95
96
 
# File 'lib/card/codename.rb', line 94

def name! codename
  (card_id = id! codename) && Lexicon.name(card_id)
end

.process_codenames ⇒ Hash

Queries the database and generates a “codehash” (see #codehash).

It also seeds the Card and Lexicon caches with codename details

Returns:

  • (Hash) —

    (the codehash)



125
126
127
128
129
130
131
 
# File 'lib/card/codename.rb', line 125

def process_codenames
  codenamed_cards.each_with_object(c2i: {}, i2c: {}) do |card, hash|
    hash[:c2i][card.codename] = card.id
    hash[:i2c][card.id] = card.codename
    seed_caches card
  end
end

.recode(oldcode, newcode) ⇒ Object

Update a codenamed card’s codename



112
113
114
115
116
117
118
 
# File 'lib/card/codename.rb', line 112

def recode oldcode, newcode
  return unless id(oldcode) && !id(newcode)

  Rails.logger.info "recode #{oldcode}, #{newcode}"
  Card.where(codename: oldcode).take.update_column :codename, newcode
  reset_cache
end

.reset_cache ⇒ Object

clear codename cache both in local variable and in temporary and shared caches



81
82
83
84
 
# File 'lib/card/codename.rb', line 81

def reset_cache
  @codehash = nil
  ::Card.cache.delete "CODENAMES"
end