newsmlg2 0.1.1

data/lib/newsmlg2/types/party_details.rb

@@ -0,0 +1,258 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The date the person was born.
+    class Born < TruncatedDateTimePropType
+      xml do
+        element 'born'
+      end
+    end
+
+    # The date the person died.
+    class Died < TruncatedDateTimePropType
+      xml do
+        element 'died'
+      end
+    end
+
+    # The type for an electronic address.
+    class ElectronicAddressType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :role, :roleuri
+
+      xml_content
+    end
+
+    # The type for an electronic address with a technical qualifier.
+    class ElectronicAddressTechType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :role, :roleuri, :tech, :techuri
+
+      xml_content
+    end
+
+    # An email address.
+    class Email < ElectronicAddressType
+      xml do
+        element 'email'
+      end
+    end
+
+    # An instant messaging address.
+    class Im < ElectronicAddressTechType
+      xml do
+        element 'im'
+      end
+    end
+
+    # A phone number, preferred in an international format.
+    class Phone < ElectronicAddressTechType
+      xml do
+        element 'phone'
+      end
+    end
+
+    # A fax number, preferred in an international format.
+    class Fax < ElectronicAddressType
+      xml do
+        element 'fax'
+      end
+    end
+
+    # A web address.
+    class Web < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :role, :roleuri
+
+      xml_content
+
+      xml do
+        element 'web'
+      end
+    end
+
+    # A line of address information.
+    class AddressLine < IntlStringType
+      xml_attributes :role, :roleuri
+
+      xml do
+        element 'line'
+      end
+    end
+
+    # A subdivision of a country part of the address.
+    class Area < Flex1RolePropType
+    end
+
+    # A postal code part of the address.
+    class PostalCode < IntlStringType
+      xml do
+        element 'postalCode'
+      end
+    end
+
+    # A country part of the address.
+    class Country < Flex1PropType
+    end
+
+    # A city/town/village etc. part of the address.
+    class Locality < Flex1RolePropType
+    end
+
+    # A world region part of an address.
+    class WorldRegion < Flex1PropType
+    end
+
+    # A postal address for the location of a Point Of Interest.
+    class Address < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :role, :roleuri
+
+      xml_element :lines, xml: 'line',
+                          type: Newsmlg2::Types::AddressLine, collection: true
+      xml_element :world_region, xml: 'worldRegion',
+                                 type: Newsmlg2::Types::WorldRegion
+      xml_element :localities, xml: 'locality',
+                               type: Newsmlg2::Types::Locality, collection: true
+      xml_element :areas, xml: 'area',
+                          type: Newsmlg2::Types::Area, collection: true
+      xml_element :country, xml: 'country',
+                            type: Newsmlg2::Types::Country
+      xml_element :postal_code, xml: 'postalCode',
+                                type: Newsmlg2::Types::PostalCode
+
+      xml do
+        element 'address'
+      end
+    end
+
+    # The type for information to get in contact with a party.
+    class ContactInfoType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :role, :roleuri
+
+      xml_element :emails, xml: 'email',
+                           type: Newsmlg2::Types::Email, collection: true
+      xml_element :ims, xml: 'im',
+                        type: Newsmlg2::Types::Im, collection: true
+      xml_element :phones, xml: 'phone',
+                           type: Newsmlg2::Types::Phone, collection: true
+      xml_element :faxes, xml: 'fax',
+                          type: Newsmlg2::Types::Fax, collection: true
+      xml_element :webs, xml: 'web',
+                         type: Newsmlg2::Types::Web, collection: true
+      xml_element :addresses, xml: 'address',
+                              type: Newsmlg2::Types::Address, collection: true
+      xml_element :notes, xml: 'note',
+                          type: Newsmlg2::Types::Note, collection: true
+
+      xml do
+        element 'contactInfo'
+      end
+    end
+
+    # The date the organisation was founded/established.
+    class OrganisationFounded < TruncatedDateTimePropType
+      xml do
+        element 'founded'
+      end
+    end
+
+    # The date the organisation was dissolved.
+    class OrganisationDissolved < TruncatedDateTimePropType
+      xml do
+        element 'dissolved'
+      end
+    end
+
+    # A place where the organisation is located.
+    class OrganisationLocation < FlexLocationPropType
+      xml do
+        element 'location'
+      end
+    end
+
+    # A financial instrument which is related to a company.
+    class HasInstrument < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes(
+        :symbol, :symbolsrc, :symbolsrcuri, :market, :marketuri,
+        :marketlabel, :marketlabelsrc, :marketlabelsrcuri,
+        :type, :typeuri, :rank
+      )
+
+      xml do
+        element 'hasInstrument'
+      end
+    end
+
+    # A group of properties specific to an organisation.
+    class OrganisationDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :founded, xml: 'founded',
+                            type: Newsmlg2::Types::OrganisationFounded
+      xml_element :dissolved, xml: 'dissolved',
+                              type: Newsmlg2::Types::OrganisationDissolved
+      xml_element :locations, xml: 'location',
+                              type: Newsmlg2::Types::OrganisationLocation, collection: true
+      xml_element :contact_infos, xml: 'contactInfo',
+                                  type: Newsmlg2::Types::ContactInfoType, collection: true
+      xml_element :has_instruments, xml: 'hasInstrument',
+                                    type: Newsmlg2::Types::HasInstrument, collection: true
+
+      xml do
+        element 'organisationDetails'
+      end
+    end
+
+    # An affiliation of a person or an organisation with an organisation.
+    # Composed (rather than subclassing a flex organisation type) so the
+    # flex prop types and the detail types never reference each other's
+    # class bodies. python-newsmlg2 models this as two identical classes
+    # (PersonAffiliationType, OrganisationAffiliationType).
+    class Affiliation < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::QualifyingAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::TimeValidityAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :organisation_details, xml: 'organisationDetails',
+                                         type: Newsmlg2::Types::OrganisationDetails
+
+      xml do
+        element 'affiliation'
+      end
+    end
+
+    class OrganisationDetails
+      xml_element :affiliations, xml: 'affiliation',
+                                 type: Newsmlg2::Types::Affiliation, collection: true
+    end
+
+    # A set of properties specific to a person.
+    class PersonDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :born, xml: 'born', type: Newsmlg2::Types::Born
+      xml_element :died, xml: 'died', type: Newsmlg2::Types::Died
+      xml_element :affiliations, xml: 'affiliation',
+                                 type: Newsmlg2::Types::Affiliation, collection: true
+      xml_element :contact_infos, xml: 'contactInfo',
+                                  type: Newsmlg2::Types::ContactInfoType, collection: true
+
+      xml do
+        element 'personDetails'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/poi.rb

@@ -0,0 +1,79 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Opening hours of a point of interest, in natural language.
+    class OpenHours < Label1Type
+      xml do
+        element 'openHours'
+      end
+    end
+
+    # Total capacity of a point of interest, in natural language.
+    class Capacity < Label1Type
+      xml do
+        element 'capacity'
+      end
+    end
+
+    # Ways to access the place of the point of interest, including
+    # directions.
+    class Access < BlockType
+      xml do
+        element 'access'
+      end
+    end
+
+    # Detailed information about the precise location of the point of
+    # interest.
+    class Details < BlockType
+      xml do
+        element 'details'
+      end
+    end
+
+    # The date (and optionally the time) on which this Point of Interest was
+    # created.
+    class POICreated < TruncatedDateTimePropType
+      xml do
+        element 'created'
+      end
+    end
+
+    # The date (and optionally the time) on which this Point of Interest
+    # ceased to exist.
+    class POICeasedToExist < TruncatedDateTimePropType
+      xml do
+        element 'ceasedToExist'
+      end
+    end
+
+    # A group of properties specific to a point of interest.
+    class POIDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :position, xml: 'position',
+                             type: Newsmlg2::Types::Position
+      xml_element :address, xml: 'address',
+                            type: Newsmlg2::Types::Address
+      xml_element :open_hours, xml: 'openHours',
+                               type: Newsmlg2::Types::OpenHours
+      xml_element :capacity, xml: 'capacity',
+                             type: Newsmlg2::Types::Capacity
+      xml_element :contact_infos, xml: 'contactInfo',
+                                  type: Newsmlg2::Types::ContactInfoType, collection: true
+      xml_element :accesses, xml: 'access',
+                             type: Newsmlg2::Types::Access, collection: true
+      xml_element :details, xml: 'details',
+                            type: Newsmlg2::Types::Details, collection: true
+      xml_element :created, xml: 'created',
+                            type: Newsmlg2::Types::POICreated
+      xml_element :ceased_to_exist, xml: 'ceasedToExist',
+                                    type: Newsmlg2::Types::POICeasedToExist
+
+      xml do
+        element 'POIDetails'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/qcode_prop_type.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property with a QCode value in its qcode attribute.
+    class QCodePropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :qcode, :uri
+    end
+  end
+end

data/lib/newsmlg2/types/qual_prop_type.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A property with a QCode value in its qcode attribute, a URI in its uri
+    # attribute and optional names.
+    class QualPropType < QCodePropType
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::ConceptNameType, collection: true
+      xml_element :hierarchy_infos, xml: 'hierarchyInfo',
+                                    type: Newsmlg2::Types::HierarchyInfo, collection: true
+    end
+
+    # The nature of a concept (python-newsmlg2 calls this class "Type").
+    class ConceptType < QualPropType
+      xml do
+        element 'type'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/qual_rel_prop_type.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A property with a QCode value in its qcode attribute, a URI in its uri
+    # attribute and optional names and related concepts.
+    class QualRelPropType < QCodePropType
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::ConceptNameType, collection: true
+      xml_element :hierarchy_infos, xml: 'hierarchyInfo',
+                                    type: Newsmlg2::Types::HierarchyInfo, collection: true
+      xml_element :related, xml: 'related',
+                            type: Newsmlg2::Types::Related, collection: true
+    end
+  end
+end

data/lib/newsmlg2/types/related_concept.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The type for an identifier of a related concept.
+    #
+    # NOTE: the :related child is declared at the bottom of this file (after
+    # Related exists) because Related's inheritance chain passes through
+    # RelatedConceptType — an eager reference here would be a circular
+    # autoload.
+    class RelatedConceptType < FlexPropType
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml_attributes :rel, :reluri, :rank
+
+      xml_element :facets, xml: 'facet',
+                           type: Newsmlg2::Types::Facet, collection: true
+    end
+
+    # The concept which is faceted by other concept(s) asserted by
+    # facetConcept.
+    class MainConcept < RelatedConceptType
+      xml do
+        element 'mainConcept'
+      end
+    end
+
+    # The concept which is faceting another concept asserted by mainConcept.
+    class FacetConcept < RelatedConceptType
+      xml do
+        element 'facetConcept'
+      end
+    end
+
+    # An identifier of a more generic concept.
+    class Broader < RelatedConceptType
+      xml do
+        element 'broader'
+      end
+    end
+
+    # An identifier of a more specific concept.
+    class Narrower < RelatedConceptType
+      xml do
+        element 'narrower'
+      end
+    end
+
+    # The type for identifying a related concept.
+    class FlexRelatedConceptType < RelatedConceptType
+      include Newsmlg2::Base::ArbitraryValueAttributes
+
+      xml_element :bag, type: Newsmlg2::Types::Bag
+    end
+
+    # A related concept, where the relationship is different from 'sameAs',
+    # 'broader' or 'narrower'.
+    class Related < FlexRelatedConceptType
+      xml do
+        element 'related'
+      end
+    end
+
+    class RelatedConceptType
+      xml_element :related, xml: 'related',
+                            type: Newsmlg2::Types::Related, collection: true
+      xml_element :same_as, xml: 'sameAs',
+                            type: Newsmlg2::Types::SameAs, collection: true
+    end
+  end
+end

data/lib/newsmlg2/types/rights.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # An expression of rights in natural language or as a reference to
+    # remote information.
+    class RightsBlockType < BlockType
+      xml_attributes :href
+    end
+
+    # Any necessary copyright notice for claiming the intellectual property
+    # for the content.
+    class CopyrightNotice < RightsBlockType
+    end
+
+    # A natural-language statement about the usage terms pertaining to the
+    # content.
+    class UsageTerms < RightsBlockType
+    end
+
+    # A rights expression serialized using XML encoding (content is a raw
+    # fragment of the rights expression language).
+    class RightsExpressionXML < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :langid
+
+      attribute :content, :string
+
+      xml do
+        element 'rightsExpressionXML'
+        map_all to: :content
+      end
+    end
+
+    # A rights expression serialized using any specific encoding except XML.
+    class RightsExpressionData < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :langid, :enctype
+
+      attribute :content, :string
+
+      xml do
+        element 'rightsExpressionData'
+        map_all to: :content
+      end
+    end
+
+    # A set of properties representing the rights associated with the Item.
+    # copyrightHolder/accountable/dataMining reuse the flex party/person/prop
+    # types directly — python-newsmlg2's subclasses added no structure.
+    class RightsInfo < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::TimeValidityAttributes
+
+      xml_attributes :idrefs, :scope, :scopeuri, :aspect, :aspecturi
+
+      xml_element :accountable, xml: 'accountable',
+                                type: Newsmlg2::Types::FlexPersonPropType
+      xml_element :copyright_holder, xml: 'copyrightHolder',
+                                     type: Newsmlg2::Types::FlexPartyPropType
+      xml_element :copyright_notices, xml: 'copyrightNotice',
+                                      type: Newsmlg2::Types::CopyrightNotice, collection: true
+      xml_element :usage_terms, xml: 'usageTerms',
+                                type: Newsmlg2::Types::UsageTerms, collection: true
+      xml_element :links, xml: 'link',
+                          type: Newsmlg2::Types::Link, collection: true
+      xml_element :rights_info_ext_properties, xml: 'rightsInfoExtProperty',
+                                               type: Newsmlg2::Types::Flex2ExtPropType, collection: true
+      xml_element :rights_expression_xmls, xml: 'rightsExpressionXML',
+                                           type: Newsmlg2::Types::RightsExpressionXML, collection: true
+      xml_element :rights_expression_datas, xml: 'rightsExpressionData',
+                                            type: Newsmlg2::Types::RightsExpressionData, collection: true
+      xml_element :data_mining, xml: 'dataMining',
+                                type: Newsmlg2::Types::FlexPropType
+
+      xml do
+        element 'rightsInfo'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/ruby_annotation.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A line break inside block content.
+    class Br < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml do
+        element 'br'
+      end
+    end
+
+    # Ruby base text.
+    class Rb < Newsmlg2::NarModel
+      xml_content
+
+      xml do
+        element 'rb'
+      end
+    end
+
+    # Ruby parenthesis.
+    class Rp < Newsmlg2::NarModel
+      xml_content
+
+      xml do
+        element 'rp'
+      end
+    end
+
+    # Ruby text.
+    class Rt < Newsmlg2::NarModel
+      xml_content
+
+      xml do
+        element 'rt'
+      end
+    end
+
+    # Simple W3C Ruby Annotation (http://www.w3.org/TR/ruby/#simple-ruby1).
+    class Ruby < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_element :rb, type: Newsmlg2::Types::Rb
+      xml_element :rt, type: Newsmlg2::Types::Rt
+      xml_element :rp, type: Newsmlg2::Types::Rp
+
+      xml do
+        element 'ruby'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/same_as.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # An identifier of a concept with equivalent semantics.
+    class SameAsType < FlexPropType
+      include Newsmlg2::Base::TimeValidityAttributes
+    end
+
+    # Serialized as the "sameAs" element.
+    class SameAs < SameAsType
+      xml do
+        element 'sameAs'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/truncated_date_time_prop_type.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Property carrying a possibly truncated date-time as content
+    # (xs:date | xs:dateTime | xs:gYearMonth | xs:gYear).
+    class TruncatedDateTimePropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/versioned_string_type.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # IntlStringType extended by a version information attribute.
+    class VersionedStringType < IntlStringType
+      xml_attributes :versioninfo
+    end
+  end
+end

data/lib/newsmlg2/types/xml_base.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # xml:base attribute values (base URIs).
+    class XmlBase < Lutaml::Model::Type::String
+      xml do
+        namespace Lutaml::Xml::W3c::XmlNamespace
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/xml_lang.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # xml:lang attribute values (RFC 5646 language tags).
+    class XmlLang < Lutaml::Model::Type::String
+      xml do
+        namespace Lutaml::Xml::W3c::XmlNamespace
+      end
+    end
+  end
+end