newsmlg2 0.1.1

data/lib/newsmlg2/types/flex_location_prop_type.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible location (geopolitical area or point-of-interest) data type.
+    class FlexLocationPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :geo_area_details, xml: 'geoAreaDetails',
+                                     type: Newsmlg2::Types::GeoAreaDetails
+      xml_element :poi_details, xml: 'POIDetails',
+                                type: Newsmlg2::Types::POIDetails
+    end
+
+    # Flexible point-of-interest data type.
+    class FlexPOIPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :poi_details, xml: 'POIDetails',
+                                type: Newsmlg2::Types::POIDetails
+    end
+
+    # Flexible geopolitical area data type.
+    class FlexGeoAreaPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :geo_area_details, xml: 'geoAreaDetails',
+                                     type: Newsmlg2::Types::GeoAreaDetails
+    end
+  end
+end

data/lib/newsmlg2/types/flex_party_prop_type.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible person data type for both controlled and uncontrolled values.
+    class FlexPersonPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :person_details, xml: 'personDetails',
+                                   type: Newsmlg2::Types::PersonDetails
+    end
+
+    # Flexible party (person or organisation) PCL-type for both controlled
+    # and uncontrolled values.
+    class FlexPartyPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::ConceptDefinitionGroup
+      include Newsmlg2::Base::ConceptRelationshipsGroup
+
+      xml_element :person_details, xml: 'personDetails',
+                                   type: Newsmlg2::Types::PersonDetails
+      xml_element :organisation_details, xml: 'organisationDetails',
+                                         type: Newsmlg2::Types::OrganisationDetails
+    end
+
+    # A party involved in a hop of the Hop History.
+    class Party < FlexPartyPropType
+      xml do
+        element 'party'
+      end
+    end
+
+    # FlexPartyPropType with a role refinement.
+    class Flex1PartyPropType < FlexPartyPropType
+      xml_attributes :role, :roleuri
+    end
+
+    # Flexible author (creator or contributor) PCL-type.
+    class FlexAuthorPropType < FlexPartyPropType
+      xml_attributes :role, :roleuri, :jobtitle, :jobtitleuri
+    end
+  end
+end

data/lib/newsmlg2/types/flex_prop2_type.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible type for related concepts for both controlled and
+    # uncontrolled values.
+    class FlexProp2Type < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      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 :same_as, xml: 'sameAs',
+                            type: Newsmlg2::Types::SameAs, collection: true
+    end
+
+    # Flexible generic type for controlled and uncontrolled values of a
+    # related concept.
+    class FlexRelatedPropType < FlexProp2Type
+      xml_attributes :rel, :reluri
+    end
+  end
+end

data/lib/newsmlg2/types/flex_prop_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Flexible generic type for both controlled and uncontrolled values.
+    class FlexPropType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_element :names, xml: 'name',
+                          type: Newsmlg2::Types::ConceptNameType, collection: true
+      xml_element :hierarchy_info, xml: 'hierarchyInfo',
+                                   type: Newsmlg2::Types::HierarchyInfo, collection: true
+    end
+  end
+end

data/lib/newsmlg2/types/geo.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Geographic coordinates.
+    class GeoCoordinatesType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :latitude, :longitude, :altitude, :gpsdatum
+    end
+
+    # The coordinates of a location.
+    class Position < GeoCoordinatesType
+      xml do
+        element 'position'
+      end
+    end
+
+    # The date the geopolitical area was founded/established.
+    class GeoAreaFounded < TruncatedDateTimePropType
+      xml do
+        element 'founded'
+      end
+    end
+
+    # The date the geopolitical area was dissolved.
+    class GeoAreaDissolved < TruncatedDateTimePropType
+      xml do
+        element 'dissolved'
+      end
+    end
+
+    # A line as a geographic area.
+    class GeoAreaLine < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :positions, xml: 'position',
+                              type: Newsmlg2::Types::Position, collection: true
+
+      xml do
+        element 'line'
+      end
+    end
+
+    # A circle as a geographic area.
+    class GeoAreaCircle < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :radius, :radunit, :radunituri
+      xml_element :positions, xml: 'position',
+                              type: Newsmlg2::Types::Position, collection: true
+
+      xml do
+        element 'circle'
+      end
+    end
+
+    # A polygon as a geographic area.
+    class GeoAreaPolygon < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :positions, xml: 'position',
+                              type: Newsmlg2::Types::Position, collection: true
+
+      xml do
+        element 'polygon'
+      end
+    end
+
+    # A group of properties specific to a geopolitical area.
+    class GeoAreaDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :position, xml: 'position',
+                             type: Newsmlg2::Types::Position
+      xml_element :founded, xml: 'founded',
+                            type: Newsmlg2::Types::GeoAreaFounded
+      xml_element :dissolved, xml: 'dissolved',
+                              type: Newsmlg2::Types::GeoAreaDissolved
+      xml_element :lines, xml: 'line',
+                          type: Newsmlg2::Types::GeoAreaLine, collection: true
+      xml_element :circles, xml: 'circle',
+                            type: Newsmlg2::Types::GeoAreaCircle, collection: true
+      xml_element :polygons, xml: 'polygon',
+                             type: Newsmlg2::Types::GeoAreaPolygon, collection: true
+
+      xml do
+        element 'geoAreaDetails'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/hierarchy_info.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Position of a concept in a hierarchical taxonomy tree, expressed by a
+    # sequence of QCode tokens as element content.
+    class HierarchyInfo < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+
+      xml do
+        element 'hierarchyInfo'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/ids.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # An alternative identifier assigned to the content.
+    class AltId < IntlStringType2
+      xml_attributes(
+        :type, :typeuri, :environment, :environmenturi,
+        :idformat, :idformaturi, :role, :roleuri, :version
+      )
+
+      xml do
+        element 'altId'
+      end
+    end
+
+    # Hash value of parts of an item as defined by the hashscope attribute.
+    class Hash < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_attributes :hashtype, :hashtypeuri, :scope, :scopeuri
+
+      xml do
+        element 'hash'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/inline_types.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # A generic mechanism for adding inline information to parts of textual
+    # content. Mixed content.
+    class Span < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_attributes class_attr: 'class'
+      xml_element :rubies, xml: 'ruby', type: Newsmlg2::Types::Ruby, collection: true
+
+      xml_content(collection: true)
+
+      xml do
+        element 'span'
+      end
+    end
+
+    # An inline markup tag usable with any concept. Mixed content.
+    class Inline < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::FlexAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::QuantifyAttributes
+
+      xml_attributes class_attr: 'class'
+      xml_element :spans, xml: 'span', type: Newsmlg2::Types::Span, collection: true
+      xml_element :rubies, xml: 'ruby', type: Newsmlg2::Types::Ruby, collection: true
+
+      xml_content(collection: true)
+
+      xml do
+        element 'inline'
+      end
+    end
+
+    # An anchor for inline linking, like the HTML a element. Mixed content.
+    class A < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_attributes :href, :hreflang, :rel, :rev, class_attr: 'class'
+      xml_element :inlines, xml: 'inline', type: Newsmlg2::Types::Inline, 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_content(collection: true)
+
+      xml do
+        element 'a'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/intl_string_type.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Internationalized normalized string: content plus language/directionality.
+    class IntlStringType < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_content
+
+      def to_s
+        text.to_s.strip
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/intl_string_type2.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # Internationalized unrestricted string: content plus
+    # language/directionality.
+    class IntlStringType2 < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::I18NAttributes
+
+      xml_content
+    end
+  end
+end

data/lib/newsmlg2/types/item_management.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The recommended file name for this Item.
+    class FileName < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+
+      xml do
+        element 'fileName'
+      end
+    end
+
+    # The name and version of the software tool used to generate the Item.
+    class Generator < VersionedStringType
+      xml_attributes :role, :roleuri
+
+      xml do
+        element 'generator'
+      end
+    end
+
+    # An instruction to the processor that the content requires special
+    # handling.
+    class Signal < Flex1PropType
+      xml_attributes :severity, :severityuri
+
+      xml do
+        element 'signal'
+      end
+    end
+
+    # An IRI which, upon dereferencing, provides an alternative
+    # representation of the Item.
+    class AltRep < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::TimeValidityAttributes
+      include Newsmlg2::Base::NewsContentTypeAttributes
+
+      xml_content
+
+      xml_attributes :representation, :representationuri, :size
+
+      xml do
+        element 'altRep'
+      end
+    end
+
+    # An IRI which, upon dereferencing, provides the original representation
+    # of the Item.
+    class OrigRep < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_content
+
+      xml_attributes :accesstype, :accesstypeuri, :reposrole, :reposroleuri
+
+      xml do
+        element 'origRep'
+      end
+    end
+
+    # The identifier of an incoming feed.
+    class IncomingFeedId < QCodePropType
+      xml_attributes :role, :roleuri
+
+      xml do
+        element 'incomingFeedId'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/link.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The PCL-type of a link from the current Item to a target Item or Web
+    # resource.
+    class Link1Type < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+      include Newsmlg2::Base::TargetResourceAttributes
+      include Newsmlg2::Base::TimeValidityAttributes
+      include Newsmlg2::Base::I18NAttributes
+      include Newsmlg2::Base::DeprecatedLinkAttributes
+
+      xml_attributes :rel, :reluri, :rank
+
+      # Link1Type permits arbitrary inline content (xs:any) — e.g. the
+      # referenced item's metadata preview inside package itemRef.
+      attribute :content, :string
+
+      xml do
+        map_all to: :content
+      end
+    end
+
+    # A link from the current Item to a target Item or Web resource.
+    class Link < Link1Type
+      xml do
+        element 'link'
+      end
+    end
+
+    # A link to an item or a web resource which provides information about
+    # the concept.
+    class RemoteInfo < Link1Type
+      xml do
+        element 'remoteInfo'
+      end
+    end
+  end
+end

data/lib/newsmlg2/types/object_details.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Types
+    # The date (and optionally the time) on which this object was created.
+    class ObjectCreated < TruncatedDateTimePropType
+      xml do
+        element 'created'
+      end
+    end
+
+    # The date (and optionally the time) on which this object ceased to
+    # exist.
+    class ObjectCeasedToExist < TruncatedDateTimePropType
+      xml do
+        element 'ceasedToExist'
+      end
+    end
+
+    # A group of properties specific to an object. Kept in its own file so
+    # the party detail types and the rights types never load each other
+    # mid-flight.
+    class ObjectDetails < Newsmlg2::NarModel
+      include Newsmlg2::Base::CommonPowerAttributes
+
+      xml_element :created, xml: 'created',
+                            type: Newsmlg2::Types::ObjectCreated
+      xml_element :copyright_notices, xml: 'copyrightNotice',
+                                      type: Newsmlg2::Types::CopyrightNotice, collection: true
+      xml_element :creators, xml: 'creator',
+                             type: Newsmlg2::Types::FlexAuthorPropType, collection: true
+      xml_element :ceased_to_exist, xml: 'ceasedToExist',
+                                    type: Newsmlg2::Types::ObjectCeasedToExist
+
+      xml do
+        element 'objectDetails'
+      end
+    end
+  end
+end