Class: Nomen::Nomenclature

Inherits:
Object
  • Object
show all
Defined in:
lib/nomen/nomenclature.rb

Overview

This class represents a nomenclature

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ Nomenclature

Instanciate a new nomenclature


9
10
11
12
13
14
15
16
17
18
# File 'lib/nomen/nomenclature.rb', line 9

def initialize(name, options = {})
  @name = name.to_sym
  @set = options.delete(:set)
  @items = HashWithIndifferentAccess.new
  @forest_right = 0
  @roots = []
  @properties = {}.with_indifferent_access
  @translateable = !options[:translateable].is_a?(FalseClass)
  @notions = options[:notions] || []
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method_name, *args) ⇒ Object

Returns property nature


484
485
486
# File 'lib/nomen/nomenclature.rb', line 484

def method_missing(method_name, *args)
  @properties[method_name] || super
end

Instance Attribute Details

#forest_rightObject

Returns the value of attribute forest_right


5
6
7
# File 'lib/nomen/nomenclature.rb', line 5

def forest_right
  @forest_right
end

#itemsObject (readonly)

Returns the value of attribute items


4
5
6
# File 'lib/nomen/nomenclature.rb', line 4

def items
  @items
end

#nameObject

Returns the value of attribute name


4
5
6
# File 'lib/nomen/nomenclature.rb', line 4

def name
  @name
end

#notionsObject

Returns the value of attribute notions


5
6
7
# File 'lib/nomen/nomenclature.rb', line 5

def notions
  @notions
end

#propertiesObject (readonly) Also known as: property_natures

Returns the value of attribute properties


4
5
6
# File 'lib/nomen/nomenclature.rb', line 4

def properties
  @properties
end

#rootsObject (readonly)

Returns the value of attribute roots


4
5
6
# File 'lib/nomen/nomenclature.rb', line 4

def roots
  @roots
end

#translateableObject

Returns the value of attribute translateable


5
6
7
# File 'lib/nomen/nomenclature.rb', line 5

def translateable
  @translateable
end

Class Method Details

.harvest(element, options = {}) ⇒ Object


21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# File 'lib/nomen/nomenclature.rb', line 21

def harvest(element, options = {})
  notions = element.attr('notions').to_s.split(/\s*\,\s*/).map(&:to_sym)
  options[:notions] = notions if notions.any?
  options[:translateable] = element.attr('translateable').to_s != 'false'
  name = element.attr('name').to_s
  nomenclature = new(name, options)
  element.xpath('xmlns:properties/xmlns:property').each do |property|
    nomenclature.harvest_property(property)
  end
  element.xpath('xmlns:items/xmlns:item').each do |item|
    nomenclature.harvest_item(item)
  end
  nomenclature.list.each(&:fetch_parent)
  nomenclature.rebuild_tree!
  nomenclature
end

Instance Method Details

#<=>(other) ⇒ Object


333
334
335
# File 'lib/nomen/nomenclature.rb', line 333

def <=>(other)
  name <=> other.name
end

#[](item_name) ⇒ Object

Returns the given item


315
316
317
# File 'lib/nomen/nomenclature.rb', line 315

def [](item_name)
  @items[item_name]
end

#add_item(name, attributes = {}, options = {}) ⇒ Object

Add an item to the nomenclature


145
146
147
148
149
150
151
152
153
154
# File 'lib/nomen/nomenclature.rb', line 145

def add_item(name, attributes = {}, options = {})
  i = Item.new(self, name, attributes)
  if @items[i.name]
    raise "Item #{i.name} is already defined in nomenclature #{@name}"
  end
  @items[i.name] = i
  @roots << i unless i.parent?
  i.rebuild_tree! unless options[:rebuild].is_a?(FalseClass)
  i
end

#add_property(name, type, options = {}) ⇒ Object

Add an property to the nomenclature


230
231
232
233
234
235
236
237
238
# File 'lib/nomen/nomenclature.rb', line 230

def add_property(name, type, options = {})
  p = PropertyNature.new(self, name, type, options)
  if @properties[p.name]
    raise "Property #{p.name} is already defined in nomenclature #{@name}"
  end
  @properties[p.name] = p
  @references = nil
  p
end

#best_match(property_name, searched_item) ⇒ Object

Returns the best match on nomenclature properties


471
472
473
474
475
476
477
478
479
480
481
# File 'lib/nomen/nomenclature.rb', line 471

def best_match(property_name, searched_item)
  items = []
  begin
    list.select do |item|
      items << item if item.property(property_name) == searched_item.name
    end
    break if items.any?
    searched_item = searched_item.parent
  end while searched_item
  items
end

#cascade_item_renaming(name, new_name) ⇒ Object

name and new_name are Symbol


191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
# File 'lib/nomen/nomenclature.rb', line 191

def cascade_item_renaming(name, new_name)
  @set.references.each do |reference|
    next unless reference.foreign_nomenclature == self
    p = reference.property
    if p.list?
      reference.nomenclature.find_each do |item|
        v = item.property(p.name)
        if v && v.include?(name)
          l = v.map do |n|
            n == name ? new_name : n
          end
          item.set(p.name, l)
        end
      end
    else
      reference.nomenclature.find_each do |item|
        v = item.property(p.name)
        item.set(p.name, new_name) if v == name
      end
    end
  end
end

#cast_options(options) ⇒ Object


488
489
490
491
492
493
494
495
496
497
# File 'lib/nomen/nomenclature.rb', line 488

def cast_options(options)
  return {} if options.nil?
  options.each_with_object({}) do |(k, v), h|
    h[k.to_sym] = if properties[k]
                    cast_property(k, v.to_s)
                  else
                    v
                  end
  end
end

#cast_property(name, value) ⇒ Object


499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
# File 'lib/nomen/nomenclature.rb', line 499

def cast_property(name, value)
  value = value.to_s
  if property = properties[name]
    if property.type == :choice || property.type == :item
      if value =~ /\,/
        raise InvalidPropertyNature, 'A property nature of choice type cannot contain commas'
      end
      value = value.strip.to_sym
    elsif property.list?
      value = value.strip.split(/[[:space:]]*\,[[:space:]]*/).map(&:to_sym)
    elsif property.type == :boolean
      value = (value == 'true' ? true : value == 'false' ? false : nil)
    elsif property.type == :decimal
      value = value.to_d
    elsif property.type == :integer
      value = value.to_i
    elsif property.type == :date
      value = (value.blank? ? nil : value.to_date)
    elsif property.type == :symbol
      unless value =~ /\A\w+\z/
        raise InvalidPropertyNature, "A property '#{name}' must contains a symbol. /[a-z0-9_]/ accepted. No spaces. Got #{value.inspect}"
      end
      value = value.to_sym
    end
  elsif !%w[name parent aliases].include?(name.to_s)
    raise ArgumentError, "Undefined property '#{name}' in #{@name}"
  end
  value
end

#change_item(name, changes = {}) ⇒ Object

Add an item to the nomenclature


157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/nomen/nomenclature.rb', line 157

def change_item(name, changes = {})
  i = find!(name)
  has_parent = changes.key?(:parent)
  new_parent = changes[:parent]
  new_name = changes[:name]
  changes.each do |k, v|
    next if %i[parent name].include? k
    i.set(k, v)
  end
  if has_parent
    @roots << i if i.parent? && new_parent.nil?
    @roots.delete(i) if i.root? && new_parent
    i.parent = new_parent
  end
  i = rename_item(name, new_name) if new_name
  i
end

#check!Object


244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/nomen/nomenclature.rb', line 244

def check!
  # Check properties
  @properties.values.each do |property|
    if property.choices_nomenclature && !property.inline_choices? && !Nomen[property.choices_nomenclature.to_s]
      raise InvalidPropertyNature, "[#{name}] #{property.name} nomenclature property must refer to an existing nomenclature. Got #{property.choices_nomenclature.inspect}. Expecting: #{Nomen.names.inspect}"
    end
    next unless property.type == :choice && property.default
    unless property.choices.include?(property.default)
      raise InvalidPropertyNature, "The default choice #{property.default.inspect} is invalid (in #{name}##{property.name}). Pick one from #{property.choices.sort.inspect}."
    end
  end

  # Check items
  list.each do |item|
    @properties.values.each do |property|
      choices = property.choices
      if item.property(property.name) && property.type == :choice
        # Cleans for parametric reference
        name = item.property(property.name).to_s.split(/\(/).first.to_sym
        unless choices.include?(name)
          raise InvalidProperty, "The given choice #{name.inspect} is invalid (in #{self.name}##{item.name}). Pick one from #{choices.sort.inspect}."
        end
      elsif item.property(property.name) && property.type == :list && property.choices_nomenclature
        for name in item.property(property.name) || []
          # Cleans for parametric reference
          name = name.to_s.split(/\(/).first.to_sym
          unless choices.include?(name)
            raise InvalidProperty, "The given choice #{name.inspect} is invalid (in #{self.name}##{item.name}). Pick one from #{choices.sort.inspect}."
          end
        end
      end
    end
  end

  # Default return
  true
end

#default(item_name = nil) ⇒ Object

Return the default item name


390
391
392
# File 'lib/nomen/nomenclature.rb', line 390

def default(item_name = nil)
  first(item_name)
end

#degree_of_kinship(a, b) ⇒ Object


380
381
382
# File 'lib/nomen/nomenclature.rb', line 380

def degree_of_kinship(a, b)
  a.degree_of_kinship_with(b)
end

#dependency_indexObject


337
338
339
340
341
342
343
344
345
346
347
# File 'lib/nomen/nomenclature.rb', line 337

def dependency_index
  unless @dependency_index
    @dependency_index = 0
    properties.each do |_n, p|
      if p.choices_nomenclature && !p.inline_choices?
        @dependency_index += 1 + Nomen[p.choices_nomenclature].dependency_index
      end
    end
  end
  @dependency_index
end

#exists?(item) ⇒ Boolean Also known as: include?

Returns true if an item exists in the nomenclature that matches the name, or false otherwise. The argument can take two forms:

* String/Symbol - Find an item with this primary name
* Nomen::Item - Find an item with the same name of the item

Returns:

  • (Boolean)

412
413
414
# File 'lib/nomen/nomenclature.rb', line 412

def exists?(item)
  @items[item.respond_to?(:name) ? item.name : item].present?
end

#find(item_name) ⇒ Object Also known as: item

Return the Item for the given name. Returns nil if no item found


395
396
397
# File 'lib/nomen/nomenclature.rb', line 395

def find(item_name)
  @items[item_name]
end

#find!(item_name) ⇒ Object

Return the Item for the given name. Raises Nomen::ItemNotFound if no item found in nomenclature

Raises:


402
403
404
405
406
# File 'lib/nomen/nomenclature.rb', line 402

def find!(item_name)
  i = find(item_name)
  raise ItemNotFound, "Cannot find item #{item_name.inspect} in #{name}" unless i
  i
end

#find_by(properties) ⇒ Object


464
465
466
467
468
# File 'lib/nomen/nomenclature.rb', line 464

def find_by(properties)
  items = where(properties)
  return nil unless items.any?
  items.first
end

#find_each(&block) ⇒ Object

Iterates on items


427
428
429
# File 'lib/nomen/nomenclature.rb', line 427

def find_each(&block)
  list.each(&block)
end

#first(item_name = nil) ⇒ Object

Return first item name


385
386
387
# File 'lib/nomen/nomenclature.rb', line 385

def first(item_name = nil)
  all(item_name).first
end

#harvest_item(element, attributes = {}) ⇒ Object

Add an item to the nomenclature from an XML element


93
94
95
96
97
98
99
100
101
102
103
# File 'lib/nomen/nomenclature.rb', line 93

def harvest_item(element, attributes = {})
  name = element.attr('name').to_s
  parent = attributes[:parent] || (element.key?('parent') ? element['parent'] : nil)
  attributes = element.attributes.each_with_object(HashWithIndifferentAccess.new) do |(k, v), h|
    next if %w[name parent].include?(k)
    h[k] = cast_property(k, v.to_s)
  end
  attributes[:parent] = parent if parent
  item = add_item(name, attributes, rebuild: false)
  item
end

#harvest_property(element) ⇒ Object

Add an property to the nomenclature from an XML element


106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
# File 'lib/nomen/nomenclature.rb', line 106

def harvest_property(element)
  name = element.attr('name').to_sym
  type = element.attr('type').to_sym
  options = {}
  if element.has_attribute?('fallbacks')
    options[:fallbacks] = element.attr('fallbacks').to_s.strip.split(/[[:space:]]*\,[[:space:]]*/).map(&:to_sym)
  end
  if element.has_attribute?('default')
    options[:default] = element.attr('default').to_sym
  end
  options[:required] = element.attr('required').to_s == 'true'
  # options[:inherit]  = !!(element.attr('inherit').to_s == 'true')
  if type == :list
    type = element.has_attribute?('nomenclature') ? :item_list : :choice_list
  elsif type == :choice
    type = :item if element.has_attribute?('nomenclature')
  end
  if type == :choice || type == :choice_list
    if element.has_attribute?('choices')
      options[:choices] = element.attr('choices').to_s.strip.split(/[[:space:]]*\,[[:space:]]*/).map(&:to_sym)
    else
      type = :string_list
    end
  elsif type == :item || type == :item_list
    if element.has_attribute?('choices')
      options[:choices] = element.attr('choices').to_s.strip.to_sym
    elsif element.has_attribute?('nomenclature')
      options[:choices] = element.attr('nomenclature').to_s.strip.to_sym
    else
      raise MissingChoices, "[#{@name}] Property #{name} must have nomenclature as choices"
    end
  end
  unless Nomen::PROPERTY_TYPES.include?(type)
    raise ArgumentError, "Property #{name} type is unknown: #{type.inspect}"
  end
  add_property(name, type, options)
end

#human_name(options = {}) ⇒ Object Also known as: humanize

Return human name


300
301
302
# File 'lib/nomen/nomenclature.rb', line 300

def human_name(options = {})
  "nomenclatures.#{I18n.escape_key(name)}.name".t(options.merge(default: ["labels.#{I18n.escape_key(name)}".to_sym, name.to_s.humanize]))
end

#inspectObject


282
283
284
# File 'lib/nomen/nomenclature.rb', line 282

def inspect
  "Nomen::#{name.to_s.classify}"
end

#listObject

Returns list of items as an Array


422
423
424
# File 'lib/nomen/nomenclature.rb', line 422

def list
  Nomen::Relation.new(self, @items.values)
end

#merge_item(name, into) ⇒ Object


214
215
216
217
218
219
220
221
222
# File 'lib/nomen/nomenclature.rb', line 214

def merge_item(name, into)
  i = find!(name)
  dest = find!(into)
  i.children.each do |child|
    child.parent = dest
  end
  cascade_item_renaming(name.to_sym, into.to_sym)
  @items.delete(name)
end

#new_boundaries(count = 2) ⇒ Object


305
306
307
308
309
310
311
312
# File 'lib/nomen/nomenclature.rb', line 305

def new_boundaries(count = 2)
  boundaries = []
  count.times do
    @forest_right += 1
    boundaries << @forest_right
  end
  boundaries
end

#property(property_name) ⇒ Object


417
418
419
# File 'lib/nomen/nomenclature.rb', line 417

def property(property_name)
  @properties[property_name]
end

#rebuild_tree!Object

Build a nested set index on items Returns last right value


87
88
89
90
# File 'lib/nomen/nomenclature.rb', line 87

def rebuild_tree!
  @forest_right = 0
  roots.each(&:rebuild_tree!)
end

#referencesObject


53
54
55
56
57
58
59
60
61
62
63
# File 'lib/nomen/nomenclature.rb', line 53

def references
  unless @references
    @references = []
    properties.each do |_p, property|
      if property.item_reference?
        @references << Nomen::Reference.new(@set, property, @set.find(property.source), property.item_list? ? :array : :key)
      end
    end
  end
  @references
end

#remove_item(name) ⇒ Object


224
225
226
227
# File 'lib/nomen/nomenclature.rb', line 224

def remove_item(name)
  find!(name)
  @items.delete(name)
end

#rename_item(name, new_name) ⇒ Object


175
176
177
178
179
180
181
182
183
184
185
186
187
188
# File 'lib/nomen/nomenclature.rb', line 175

def rename_item(name, new_name)
  if @items[new_name]
    raise "Item #{new_name} is already defined in nomenclature #{@name}. Use merging instead."
  end
  i = find!(name)
  i.children.each do |child|
    child.parent_name = new_name
  end
  cascade_item_renaming(name.to_sym, new_name.to_sym)
  i = @items.delete(i.name)
  i.name = new_name
  @items[new_name] = i
  i
end

#select(&block) ⇒ Object


319
320
321
# File 'lib/nomen/nomenclature.rb', line 319

def select(&block)
  list.select(&block)
end

#select_without(already_imported) ⇒ Object

Returns a list for select, without specified items


368
369
370
371
372
373
374
375
376
377
378
# File 'lib/nomen/nomenclature.rb', line 368

def select_without(already_imported)
  ActiveSupport::Deprecation.warn 'Nomen::Nomenclature#select_without method is deprecated. Please use Nomen::Nomenclature#without method instead.'
  select_options = @items.values.collect do |item|
    [item.human_name, item.name.to_s] unless already_imported[item.name.to_s]
  end
  select_options.compact!
  select_options.sort! do |a, b|
    a.first <=> b.first
  end
  select_options
end

#selection(item_name = nil) ⇒ Object

Returns a list for select as an array of pair (array)


350
351
352
353
354
355
356
357
# File 'lib/nomen/nomenclature.rb', line 350

def selection(item_name = nil)
  items = (item_name ? find!(item_name).self_and_children : @items.values)
  items.collect do |item|
    [item.human_name, item.name.to_s]
  end.sort do |a, b|
    a.first.lower_ascii <=> b.first.lower_ascii
  end
end

#selection_hash(item_name = nil) ⇒ Object

Returns a list for select as an array of pair (hash)


360
361
362
363
364
365
# File 'lib/nomen/nomenclature.rb', line 360

def selection_hash(item_name = nil)
  items = (item_name ? find!(item_name).self_and_children : @items.values)
  items.collect do |item|
    { label: item.human_name, value: item.name }
  end.sort { |a, b| a[:label].lower_ascii <=> b[:label].lower_ascii }
end

#sibling(name) ⇒ Object


240
241
242
# File 'lib/nomen/nomenclature.rb', line 240

def sibling(name)
  @set.find(name)
end

#table_nameObject


286
287
288
# File 'lib/nomen/nomenclature.rb', line 286

def table_name
  @name.to_s.pluralize
end

#to_a(item_name = nil) ⇒ Object Also known as: all

List all item names. Can filter on a given item name and its children


324
325
326
327
328
329
330
# File 'lib/nomen/nomenclature.rb', line 324

def to_a(item_name = nil)
  if item_name.present? && @items[item_name]
    @items[item_name].self_and_children.map(&:name)
  else
    @items.keys.sort
  end
end

#to_csv(file, _options = {}) ⇒ Object

Write CSV file with all items an there properties


66
67
68
69
70
71
72
73
74
75
76
77
# File 'lib/nomen/nomenclature.rb', line 66

def to_csv(file, _options = {})
  properties = @properties.values
  CSV.open(file, 'wb') do |csv|
    csv << [:name] + properties.map do |p|
      suffix = (p.decimal? ? ' D' : p.integer? ? ' I' : p.boolean? ? ' B' : p.item? ? " R(#{p.choices_nomenclature})" : '')
      "#{p.name}#{suffix}"
    end
    @items.values.each do |i|
      csv << [i.name] + properties.map { |p| i.attributes[p.name] }
    end
  end
end

#to_xml_attrsObject


79
80
81
82
83
# File 'lib/nomen/nomenclature.rb', line 79

def to_xml_attrs
  attrs = { name: name, translateable: translateable.to_s }
  attrs[:notions] = @notions.join(', ') if @notions.any?
  attrs
end

#translateable?Boolean

Returns:

  • (Boolean)

295
296
297
# File 'lib/nomen/nomenclature.rb', line 295

def translateable?
  @translateable
end

#treeObject

Returns hash with items in tree: => nil, b => {c => nil}


291
292
293
# File 'lib/nomen/nomenclature.rb', line 291

def tree
  @roots.collect(&:tree).join
end

#update_attributes(attributes = {}) ⇒ Object


47
48
49
50
51
# File 'lib/nomen/nomenclature.rb', line 47

def update_attributes(attributes = {})
  attributes.each do |attribute, value|
    send("#{attribute}=", value)
  end
end

#where(properties) ⇒ Object

List items with properties filtering


432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
# File 'lib/nomen/nomenclature.rb', line 432

def where(properties)
  list.select do |item|
    valid = true
    properties.each do |name, value|
      item_value = item.property(name)
      if value.is_a?(Array)
        one_found = false
        value.each do |val|
          if val.is_a?(Nomen::Item)
            one_found = true if item_value == val.name.to_sym
          else
            one_found = true if item_value == val
          end
        end
        valid = false unless one_found
      elsif value.is_a?(Nomen::Item)
        valid = false unless item_value == value.name.to_sym
      else
        valid = false unless item_value == value
      end
    end
    valid
  end
end

#without(*names) ⇒ Object


457
458
459
460
461
462
# File 'lib/nomen/nomenclature.rb', line 457

def without(*names)
  excluded = names.flatten.compact.map(&:to_sym)
  list.reject do |item|
    excluded.include?(item.name)
  end
end