newsmlg2 0.1.1

data/lib/newsmlg2/scheme.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # A scheme alias-to-URI mapping, as declared inside a catalog.
+  class Scheme < Newsmlg2::NarModel
+    include Newsmlg2::Base::CommonPowerAttributes
+    include Newsmlg2::Base::AuthorityAttributes
+
+    xml_attributes :schemecreated, :schememodified, :schemeretired,
+                   alias_attr: 'alias', uri: 'uri'
+    xml_element :same_as_schemes, xml: 'sameAsScheme',
+                                  type: Newsmlg2::SameAsScheme, collection: true
+    xml_element :names, xml: 'name',
+                        type: Newsmlg2::Types::ConceptNameType, collection: true
+    xml_element :definitions, xml: 'definition',
+                              type: Newsmlg2::Types::Definition, collection: true
+    xml_element :notes, xml: 'note',
+                        type: Newsmlg2::Types::Note, collection: true
+    xml_element :same_as, xml: 'sameAs',
+                          type: Newsmlg2::Types::SameAs, collection: true
+
+    xml do
+      element 'scheme'
+    end
+
+    def to_s
+      "#{names.first} (#{alias_attr}, #{uri})"
+    end
+  end
+end

data/lib/newsmlg2/types/approximate_date_time_prop_type.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property carrying an approximate date-time as content, with an optional
+    # approximation range.
+    class ApproximateDateTimePropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :approxstart, :approxend
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/bag.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A group of existing concepts which express a new concept.
+    class Bag < QCodePropType
+      include Newsmlg2::Base::QuantifyAttributes
+
+      xml_attributes :type, :typeuri, :significance
+
+      xml do
+        element 'bag'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/block_types.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The PCL-type for information about the content as a natural language
+    # string with minimal markup. Mixed content.
+    class Label1Type < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_attributes :role, :roleuri, :media
+      xml_element :anchors, xml: 'a', type: Newsmlg2::Types::A, collection: true
+      xml_element :spans, xml: 'span', type: Newsmlg2::Types::Span, collection: true
+      xml_element :rubies, xml: 'ruby', type: Newsmlg2::Types::Ruby, collection: true
+      xml_element :inlines, xml: 'inline', type: Newsmlg2::Types::Inline, collection: true
+
+      xml_content(collection: true)
+
+      def to_s
+        Array(text).join.strip
+      end
+    end
+
+    # Natural-language content with minimal markup and line breaks.
+    # Mixed content.
+    class BlockType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_attributes :media, :role, :roleuri
+      xml_element :anchors, xml: 'a', type: Newsmlg2::Types::A, collection: true
+      xml_element :spans, xml: 'span', type: Newsmlg2::Types::Span, collection: true
+      xml_element :rubies, xml: 'ruby', type: Newsmlg2::Types::Ruby, collection: true
+      xml_element :brs, xml: 'br', type: Newsmlg2::Types::Br, collection: true
+      xml_element :inlines, xml: 'inline', type: Newsmlg2::Types::Inline, collection: true
+
+      xml_content(collection: true)
+
+      def to_s
+        Array(text).join.strip
+      end
+    end
+
+    # A natural language definition of the semantics of a concept.
+    class Definition < BlockType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml do
+        element 'definition'
+      end
+    end
+
+    # Additional natural language information about a concept.
+    class Note < BlockType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml do
+        element 'note'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/concept.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A set of properties defining a concept.
+    class Concept < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_element :concept_id, xml: 'conceptId',
+                               type: Newsmlg2::Types::ConceptId
+      xml_element :type, xml: 'type', type: Newsmlg2::Types::ConceptType
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::ConceptNameType, collection: true
+      xml_element :definitions, xml: 'definition',
+                                type: Newsmlg2::Types::Definition, collection: true
+      xml_element :notes, xml: 'note',
+                          type: Newsmlg2::Types::Note, collection: true
+      xml_element :facets, xml: 'facet',
+                           type: Newsmlg2::Types::Facet, collection: true
+      xml_element :remote_infos, xml: 'remoteInfo',
+                                 type: Newsmlg2::Types::RemoteInfo, collection: true
+      xml_element :hierarchy_infos, xml: 'hierarchyInfo',
+                                    type: Newsmlg2::Types::HierarchyInfo, collection: true
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+      include Newsmlg2::Base::EntityDetailsGroup
+
+      xml_element :concept_ext_property, xml: 'conceptExtProperty',
+                                         type: Newsmlg2::Types::Flex2ExtPropType
+
+      xml do
+        element 'concept'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/concept_id.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The preferred unambiguous identifier for a concept.
+    class ConceptIdType < QCodePropType
+      xml_attributes :created, :retired
+    end
+
+    # Serialized as the "conceptId" element.
+    class ConceptId < ConceptIdType
+      xml do
+        element 'conceptId'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/concept_name_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A natural-language name of a concept, with validity period and
+    # role/part refinements. Serialized as the "name" element.
+    class ConceptNameType < IntlStringType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml_attributes :role, :roleuri, :part, :parturi
+
+      xml do
+        element 'name'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/content_meta_types.rb

@@ -0,0 +1,152 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The editorial urgency of the content (1-9), as scoped by the parent
+    # element.
+    class Urgency < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+
+      xml do
+        element 'urgency'
+      end
+    end
+
+    # Indicates the source type from which the content was created.
+    class DigitalSourceType < FlexPropType
+    end
+
+    # An iconic visual identification of the content.
+    class Icon < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::TargetResourceAttributes
+      include Newsmlg2::Base::MediaContentCharacteristics1
+
+      xml_attributes :rendition, :renditionuri
+
+      xml do
+        element 'icon'
+      end
+    end
+
+    # The type covering all qualifiers for an audience property.
+    class AudienceType < Flex1PropType
+      include Newsmlg2::Base::QuantifyAttributes
+
+      xml_attributes :significance
+    end
+
+    # An intended audience for the content.
+    class Audience < AudienceType
+    end
+
+    # An excluded audience for the content.
+    class ExclAudience < AudienceType
+    end
+
+    # Expresses the rating of the content of this item by a party.
+    class Rating < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes(
+        :value, :valcalctype, :valcalctypeuri,
+        :scalemin, :scalemax, :scaleunit, :scaleunituri,
+        :raters, :ratertype, :ratertypeuri, :ratingtype, :ratingtypeuri
+      )
+    end
+
+    # Reflects a specific kind of user interaction with the content.
+    class UserInteraction < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :interactions, :interactiontype, :interactiontypeuri
+    end
+
+    # A name for a concept assigned as property value of a language.
+    class LanguageName < IntlStringType
+    end
+
+    # A language used by the news content.
+    class Language < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::RankingAttributes
+
+      xml_attributes :tag, :role, :roleuri
+
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::LanguageName, collection: true
+
+      xml do
+        element 'language'
+      end
+    end
+
+    # A nature, intellectual or journalistic form of the content.
+    class Genre < Flex1ConceptPropType
+      include Newsmlg2::Base::RankingAttributes
+    end
+
+    # Free-text term for indexing or finding the content.
+    class Keyword < IntlStringType
+      include Newsmlg2::Base::RankingAttributes
+
+      xml_attributes :role, :roleuri, :confidence, :relevance
+
+      xml do
+        element 'keyword'
+      end
+    end
+
+    # An important topic of the content; what the content is about.
+    class Subject < Flex1ConceptPropType
+      include Newsmlg2::Base::RankingAttributes
+    end
+
+    # A sequence of tokens associated with the content.
+    class Slugline < IntlStringType
+      include Newsmlg2::Base::RankingAttributes
+
+      xml_attributes :separator, :role, :roleuri, :confidence, :relevance
+
+      xml do
+        element 'slugline'
+      end
+    end
+
+    # A brief and snappy introduction to the content.
+    class Headline < Label1Type
+      include Newsmlg2::Base::RankingAttributes
+
+      xml_attributes :confidence, :relevance
+
+      xml do
+        element 'headline'
+      end
+    end
+
+    # A natural-language statement of the date and/or place of creation of
+    # the content.
+    class Dateline < Label1Type
+      include Newsmlg2::Base::RankingAttributes
+    end
+
+    # A natural-language statement about the creator of the content.
+    class By < Label1Type
+      include Newsmlg2::Base::RankingAttributes
+    end
+
+    # A free-form expression of the credit(s) for the content.
+    class Creditline < IntlStringType
+      include Newsmlg2::Base::RankingAttributes
+    end
+
+    # A free-form textual description of the content of the item.
+    class ContentDescription < BlockType
+      include Newsmlg2::Base::RankingAttributes
+
+      xml_attributes :confidence, :relevance
+    end
+  end
+end

data/lib/newsmlg2/types/date_opt_time_prop_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property carrying a date with an optional time part as content.
+    class DateOptTimePropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/date_time_or_null_prop_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property carrying a date-time or an empty string as content.
+    class DateTimeOrNullPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/date_time_prop_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property carrying an xsd:dateTime as element content.
+    class DateTimePropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/event_details.rb

@@ -0,0 +1,213 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Explicit dates of recurrence.
+    class RDate < DateOptTimePropType
+      xml do
+        element 'rDate'
+      end
+    end
+
+    # Rule for recurrence.
+    class RRule < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::RecurrenceRuleAttributes
+
+      xml do
+        element 'rRule'
+      end
+    end
+
+    # Explicit dates to be excluded from any recurrence.
+    class ExDate < DateOptTimePropType
+      xml do
+        element 'exDate'
+      end
+    end
+
+    # Rule for dates to be excluded from recurrence.
+    class ExRule < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::RecurrenceRuleAttributes
+
+      xml do
+        element 'exRule'
+      end
+    end
+
+    # The date the event commences.
+    class Start < ApproximateDateTimePropType
+      include Newsmlg2::Base::ConfirmationStatusAttributes
+    end
+
+    # The date the event ends.
+    class End < ApproximateDateTimePropType
+      include Newsmlg2::Base::ConfirmationStatusAttributes
+    end
+
+    # The period the event will last (xsd:duration value as content).
+    class EventDuration < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::ConfirmationStatusAttributes
+
+      xml_content
+    end
+
+    # DEPRECATED since 2.24: use confirmationstatus attributes instead.
+    class Confirmation < QCodePropType
+    end
+
+    # All dates pertaining to the event.
+    class Dates < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :start, xml: 'start', type: Newsmlg2::Types::Start
+      xml_element :end, xml: 'end', type: Newsmlg2::Types::End
+      xml_element :duration, xml: 'duration', type: Newsmlg2::Types::EventDuration
+      xml_element :rdates, xml: 'rDate', type: Newsmlg2::Types::RDate, collection: true
+      xml_element :rrules, xml: 'rRule', type: Newsmlg2::Types::RRule, collection: true
+      xml_element :exdates, xml: 'exDate', type: Newsmlg2::Types::ExDate, collection: true
+      xml_element :exrules, xml: 'exRule', type: Newsmlg2::Types::ExRule, collection: true
+      xml_element :confirmation, xml: 'confirmation',
+                                 type: Newsmlg2::Types::Confirmation
+
+      xml do
+        element 'dates'
+      end
+    end
+
+    # Indicates the certainty of the occurrence of the event.
+    class OccurStatus < QualPropType
+    end
+
+    # The planning of the news coverage of the event.
+    class NewsCoverageStatus < QualPropType
+    end
+
+    # How and when to register for the event.
+    class Registration < BlockType
+    end
+
+    # Indication of the accessibility of the event.
+    class AccessStatus < QualPropType
+    end
+
+    # A requirement for participating in the event.
+    class ParticipationRequirement < Flex1PropType
+      xml_attributes :role, :roleuri
+    end
+
+    # A subject covered by the event.
+    class EventDetailsSubject < Flex1ConceptPropType
+    end
+
+    # A location (geographical area or point of interest) where the event
+    # takes place.
+    class EventDetailsLocation < FlexLocationPropType
+      xml_attributes :role, :roleuri
+    end
+
+    # A person or organisation participating in the event.
+    class Participant < Flex1PartyPropType
+    end
+
+    # A person or organisation organising the event.
+    class Organiser < Flex1PartyPropType
+    end
+
+    # Legacy structured information about intended coverage, scoped to an
+    # event (the planning-item NewsCoverage is the modern form).
+    class EventNewsCoverage < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :g2content_type, xml: 'g2contentType',
+                                   type: Newsmlg2::G2ContentType
+      xml_element :item_class, xml: 'itemClass',
+                               type: Newsmlg2::Types::QualRelPropType
+      xml_element :assigned_to, xml: 'assignedTo',
+                                type: Newsmlg2::AssignedTo, collection: true
+      xml_element :scheduled, xml: 'scheduled',
+                              type: Newsmlg2::Scheduled
+      xml_element :services, xml: 'service',
+                             type: Newsmlg2::Types::QualPropType, collection: true
+      xml_element :ed_notes, xml: 'edNote',
+                             type: Newsmlg2::Types::BlockType, collection: true
+      include Newsmlg2::Base::DescriptiveMetadataGroup
+
+      xml_attributes :role, :roleuri
+    end
+
+    # A set of properties with details about an event.
+    class EventDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :dates, xml: 'dates', type: Newsmlg2::Types::Dates
+      xml_element :occur_status, xml: 'occurStatus',
+                                 type: Newsmlg2::Types::OccurStatus
+      xml_element :news_coverage_status, xml: 'newsCoverageStatus',
+                                         type: Newsmlg2::Types::NewsCoverageStatus
+      xml_element :registrations, xml: 'registration',
+                                  type: Newsmlg2::Types::Registration, collection: true
+      xml_element :keywords, xml: 'keyword',
+                             type: Newsmlg2::Types::Keyword, collection: true
+      xml_element :access_statuses, xml: 'accessStatus',
+                                    type: Newsmlg2::Types::AccessStatus, collection: true
+      xml_element :participation_requirements, xml: 'participationRequirement',
+                                               type: Newsmlg2::Types::ParticipationRequirement, collection: true
+      xml_element :subjects, xml: 'subject',
+                             type: Newsmlg2::Types::EventDetailsSubject, collection: true
+      xml_element :locations, xml: 'location',
+                              type: Newsmlg2::Types::EventDetailsLocation, collection: true
+      xml_element :participants, xml: 'participant',
+                                 type: Newsmlg2::Types::Participant, collection: true
+      xml_element :organisers, xml: 'organiser',
+                               type: Newsmlg2::Types::Organiser, collection: true
+      xml_element :contact_infos, xml: 'contactInfo',
+                                  type: Newsmlg2::Types::ContactInfoType, collection: true
+      xml_element :languages, xml: 'language',
+                              type: Newsmlg2::Types::Language, collection: true
+      xml_element :news_coverages, xml: 'newsCoverage',
+                                   type: Newsmlg2::Types::EventNewsCoverage, collection: true
+
+      xml do
+        element 'eventDetails'
+      end
+    end
+
+    # Structured information about an event without a concept identifier,
+    # used only with News Items.
+    class Event < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::ConceptNameType, collection: true
+      xml_element :definitions, xml: 'definition',
+                                type: Newsmlg2::Types::Definition, collection: true
+      xml_element :notes, xml: 'note',
+                          type: Newsmlg2::Types::Note, collection: true
+      xml_element :facets, xml: 'facet',
+                           type: Newsmlg2::Types::Facet, collection: true
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :event_details, xml: 'eventDetails',
+                                  type: Newsmlg2::Types::EventDetails
+
+      xml do
+        element 'event'
+      end
+    end
+
+    # A wrapper for events in a News Item.
+    class Events < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :events, xml: 'event',
+                           type: Newsmlg2::Types::Event, collection: true
+
+      xml do
+        element 'events'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/ext_property.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible generic PCL-type for controlled, uncontrolled and arbitrary
+    # values (extension property base).
+    class Flex1ExtPropType < Flex1PropType
+      include Newsmlg2::Base::ArbitraryValueAttributes
+    end
+
+    # Flexible generic PCL-type for controlled, uncontrolled and arbitrary
+    # values, with a mandatory relationship. All per-parent "ext property"
+    # elements (itemMetaExtProperty, rightsInfoExtProperty, …) use this type;
+    # their element names are declared at the usage site.
+    class Flex2ExtPropType < Flex1ExtPropType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml_attributes :rel, :reluri
+    end
+  end
+end

data/lib/newsmlg2/types/facet.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # An intrinsic property of a concept (deprecated since NAR 1.8; use
+    # "related" instead).
+    class Facet < FlexPropType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml_attributes :rel, :reluri, :g2flag
+
+      xml do
+        element 'facet'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/flex1_prop_type.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible generic PCL-type for both controlled and uncontrolled values,
+    # carrying a full concept definition and concept relationships.
+    class Flex1PropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+    end
+
+    # Flex1PropType with a role refinement.
+    class Flex1RolePropType < Flex1PropType
+      xml_attributes :role, :roleuri
+    end
+
+    # Flexible generic PCL-type for controlled and uncontrolled values, with
+    # optional quantifiers and faceted-concept children.
+    class Flex1ConceptPropType < Flex1PropType
+      include Newsmlg2::Base::QuantifyAttributes
+
+      xml_element :bag, type: Newsmlg2::Types::Bag
+      xml_element :main_concept, xml: 'mainConcept',
+                                 type: Newsmlg2::Types::MainConcept
+      xml_element :facet_concepts, xml: 'facetConcept',
+                                   type: Newsmlg2::Types::FacetConcept, collection: true
+    end
+  end
+end