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


480
481
482
# File 'lib/nomen/nomenclature.rb', line 480

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
# 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.rebuild_tree!
  nomenclature
end

Instance Method Details

#<=>(other) ⇒ Object


337
338
339
# File 'lib/nomen/nomenclature.rb', line 337

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

#[](item_name) ⇒ Object

Returns the given item


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

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

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

Add an item to the nomenclature


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

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


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

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


467
468
469
470
471
472
473
474
475
476
477
# File 'lib/nomen/nomenclature.rb', line 467

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


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

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


484
485
486
487
488
489
490
491
492
493
# File 'lib/nomen/nomenclature.rb', line 484

def cast_options(options)
  return {} if options.nil?
  hash = 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


495
496
497
498
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
# File 'lib/nomen/nomenclature.rb', line 495

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


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

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 [: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


243
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
# File 'lib/nomen/nomenclature.rb', line 243

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


393
394
395
# File 'lib/nomen/nomenclature.rb', line 393

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

#degree_of_kinship(a, b) ⇒ Object


383
384
385
# File 'lib/nomen/nomenclature.rb', line 383

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

#dependency_indexObject


341
342
343
344
345
346
347
348
349
350
351
# File 'lib/nomen/nomenclature.rb', line 341

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)

415
416
417
# File 'lib/nomen/nomenclature.rb', line 415

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


398
399
400
# File 'lib/nomen/nomenclature.rb', line 398

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:


405
406
407
408
409
# File 'lib/nomen/nomenclature.rb', line 405

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


460
461
462
463
464
# File 'lib/nomen/nomenclature.rb', line 460

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

#find_each(&block) ⇒ Object

Iterates on items


430
431
432
# File 'lib/nomen/nomenclature.rb', line 430

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

#first(item_name = nil) ⇒ Object

Return first item name


388
389
390
# File 'lib/nomen/nomenclature.rb', line 388

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


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

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


105
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
# File 'lib/nomen/nomenclature.rb', line 105

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


304
305
306
# File 'lib/nomen/nomenclature.rb', line 304

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

#inspectObject


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

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

#listObject

Returns list of items as an Array


425
426
427
# File 'lib/nomen/nomenclature.rb', line 425

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

#merge_item(name, into) ⇒ Object


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

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


309
310
311
312
313
314
315
316
# File 'lib/nomen/nomenclature.rb', line 309

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

#property(property_name) ⇒ Object


420
421
422
# File 'lib/nomen/nomenclature.rb', line 420

def property(property_name)
  @properties[property_name]
end

#rebuild_tree!Object

Build a nested set index on items Returns last right value


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

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

#referencesObject


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

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


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

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

#rename_item(name, new_name) ⇒ Object


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

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


323
324
325
# File 'lib/nomen/nomenclature.rb', line 323

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

#select_without(already_imported) ⇒ Object

Returns a list for select, without specified items


372
373
374
375
376
377
378
379
380
381
# File 'lib/nomen/nomenclature.rb', line 372

def select_without(already_imported)
  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)


354
355
356
357
358
359
360
361
# File 'lib/nomen/nomenclature.rb', line 354

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)


364
365
366
367
368
369
# File 'lib/nomen/nomenclature.rb', line 364

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


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

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

#table_nameObject


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

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


328
329
330
331
332
333
334
# File 'lib/nomen/nomenclature.rb', line 328

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

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

Write CSV file with all items an there properties


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

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


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

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

#translateable?Boolean

Returns:

  • (Boolean)

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

def translateable?
  @translateable
end

#treeObject

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


290
291
292
293
294
295
296
297
# File 'lib/nomen/nomenclature.rb', line 290

def tree
  x = @roots.collect(&:tree).join
  return x
  i.attributes.merge(parent: i.parent_name, name: i.name, left: i.left, right: i.right, depth: i.depth).deep_stringify_keys
  return x
  @roots.map do |_i|
  end
end

#update_attributes(attributes = {}) ⇒ Object


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

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

#where(properties) ⇒ Object

List items with properties filtering


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

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