Class: Metanorma::Requirements

Inherits:
Object
  • Object
show all
Defined in:
lib/metanorma/default/utils.rb,
lib/metanorma/default/xrefs.rb,
lib/metanorma/modspec/xrefs.rb,
lib/metanorma/default/isodoc.rb,
lib/metanorma/modspec/isodoc.rb,
lib/metanorma/default/cleanup.rb,
lib/metanorma/default/default.rb,
lib/metanorma/modspec/cleanup.rb,
lib/metanorma/modspec/modspec.rb,
lib/metanorma/modspec/validate.rb,
lib/metanorma/requirements/version.rb,
lib/metanorma/modspec/table_cleanup.rb,
lib/metanorma/requirements/selector.rb,
lib/metanorma/modspec/reqt_label.rb

Defined Under Namespace

Classes: Default, Modspec

Constant Summary collapse

VERSION = 
"0.3.6".freeze
REQRECPER = 
"//requirement | //recommendation | //permission".freeze

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options) ⇒ Requirements

Returns a new instance of Requirements.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'lib/metanorma/requirements/selector.rb', line 12

def initialize(options)
  @default = options[:default]
  @i18n = i18n_klass(options[:lang] || "en",
                     options[:script] || "Latn",
                     options[:locale],
                     options[:labels])
  # @labels = @i18n.get.deep_merge(options[:labels] || {})["requirements"]
  @labels = @i18n.get["requirements"]
  @modspecidentifierbase = options[:modspecidentifierbase]
  @models =
    model_names.each_with_object({}) { |k, m| m[k] = create(k) }
end

Instance Attribute Details

#i18n ⇒ Object

Returns the value of attribute i18n.



8
9
10
 
# File 'lib/metanorma/requirements/selector.rb', line 8

def i18n
  @i18n
end

#labels ⇒ Object

Returns the value of attribute labels.



8
9
10
 
# File 'lib/metanorma/requirements/selector.rb', line 8

def labels
  @labels
end

#modspecidentifierbase ⇒ Object

Returns the value of attribute modspecidentifierbase.



8
9
10
 
# File 'lib/metanorma/requirements/selector.rb', line 8

def modspecidentifierbase
  @modspecidentifierbase
end

Instance Method Details

#create(type) ⇒ Object 



50
51
52
53
54
55
56
 
# File 'lib/metanorma/requirements/selector.rb', line 50

def create(type)
  case type
  when :modspec, :ogc
    Metanorma::Requirements::Modspec.new(parent: self)
  else Metanorma::Requirements::Default.new(parent: self)
  end
end

#i18n_klass(lang, script, locale = nil, i18nhash = nil) ⇒ Object 



29
30
31
32
 
# File 'lib/metanorma/requirements/selector.rb', line 29

def i18n_klass(lang, script, locale = nil, i18nhash = nil)
  ::IsoDoc::MnRequirementsI18n.new(lang, script, locale: locale,
                                                 i18nhash: i18nhash)
end

#model(type) ⇒ Object 



58
59
60
 
# File 'lib/metanorma/requirements/selector.rb', line 58

def model(type)
  @models[type&.to_sym] || @models[@default]
end

#model_names ⇒ Object 



25
26
27
 
# File 'lib/metanorma/requirements/selector.rb', line 25

def model_names
  %i[default ogc]
end

#requirement_cleanup(xmldoc) ⇒ Object

all cleanup steps by all possible models are included here, and each model can skip a given step. This class iterates through the entire document, and picks the model for each requirement; then that model’s method is applied to that particular requirement instance



68
69
70
71
72
73
74
 
# File 'lib/metanorma/requirements/selector.rb', line 68

def requirement_cleanup(xmldoc)
  requirement_metadata_cleanup(xmldoc)
  requirement_type_cleanup(xmldoc)
  requirement_inherit_cleanup(xmldoc)
  requirement_descriptions_cleanup(xmldoc)
  requirement_identifier_cleanup(xmldoc)
end

#requirement_descriptions_cleanup(xmldoc) ⇒ Object 



94
95
96
97
98
 
# File 'lib/metanorma/requirements/selector.rb', line 94

def requirement_descriptions_cleanup(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    model(r["model"]).requirement_descriptions_cleanup(r)
  end
end

#requirement_identifier_cleanup(xmldoc) ⇒ Object 



100
101
102
103
104
 
# File 'lib/metanorma/requirements/selector.rb', line 100

def requirement_identifier_cleanup(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    model(r["model"]).requirement_identifier_cleanup(r)
  end
end

#requirement_inherit_cleanup(xmldoc) ⇒ Object 



88
89
90
91
92
 
# File 'lib/metanorma/requirements/selector.rb', line 88

def requirement_inherit_cleanup(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    model(r["model"]).requirement_inherit_cleanup(r)
  end
end

#requirement_metadata_cleanup(xmldoc) ⇒ Object 



82
83
84
85
86
 
# File 'lib/metanorma/requirements/selector.rb', line 82

def requirement_metadata_cleanup(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    model(r["model"]).requirement_metadata_cleanup(r)
  end
end

#requirement_roles ⇒ Object

all roles that can be assigned to an example to make it a reqt, across all models (because the model may not be an attribute but embedded in the definition list). Mapped to obligation TODO may need to make it conditional on model



38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/metanorma/requirements/selector.rb', line 38

def requirement_roles
  {
    recommendation: "recommendation",
    requirement: "requirement",
    permission: "permission",
    requirements_class: "requirement",
    conformance_test: "requirement",
    conformance_class: "requirement",
    abstract_test: "requirement",
  }
end

#requirement_type_cleanup(xmldoc) ⇒ Object 



76
77
78
79
80
 
# File 'lib/metanorma/requirements/selector.rb', line 76

def requirement_type_cleanup(xmldoc)
  xmldoc.xpath(REQRECPER).each do |r|
    model(r["model"]).requirement_type_cleanup(r)
  end
end