newsmlg2 0.1.1

data/docs/usage.md

@@ -0,0 +1,36 @@
+# Usage
+
+## Parsing
+
+```ruby
+require "newsmlg2"
+
+doc = Newsmlg2.parse_file("newsitem.xml")
+doc.item                       # typed item, e.g. Newsmlg2::NewsItem
+doc.item.item_meta.item_class.qcode
+```
+
+## Catalogs and qcodes
+
+```ruby
+doc.catalog_store.get_scheme_for_alias("ninat").uri
+Newsmlg2.qcode_to_uri("ninat:text", doc)
+Newsmlg2.uri_to_qcode("http://cv.iptc.org/newscodes/ninature/text", doc)
+```
+
+## Builder DSL
+
+```ruby
+Newsmlg2.build_news_item(guid: "...", lang: "en-GB") do |item|
+  item.item_meta do |meta|
+    meta.item_class qcode: "ninat:text"
+    meta.version_created "2026-08-30T12:00:00+00:00"
+  end
+end.to_xml
+```
+
+## Serialization
+
+```ruby
+doc.to_xml            # XML declaration + canonical output
+```

data/lib/newsmlg2/base/administrative_metadata_group.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties associated with the administrative facet of
+    # content (contentmeta.py).
+    module AdministrativeMetadataGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :urgency, xml: 'urgency',
+                                type: Newsmlg2::Types::Urgency
+          xml_element :content_created, xml: 'contentCreated',
+                                        type: Newsmlg2::Types::TruncatedDateTimePropType
+          xml_element :content_modified, xml: 'contentModified',
+                                         type: Newsmlg2::Types::TruncatedDateTimePropType
+          xml_element :digital_source_type, xml: 'digitalSourceType',
+                                            type: Newsmlg2::Types::DigitalSourceType
+          xml_element :located, xml: 'located',
+                                type: Newsmlg2::Types::FlexLocationPropType, collection: true
+          xml_element :info_sources, xml: 'infoSource',
+                                     type: Newsmlg2::Types::Flex1PartyPropType, collection: true
+          xml_element :creators, xml: 'creator',
+                                 type: Newsmlg2::Types::FlexAuthorPropType, collection: true
+          xml_element :contributors, xml: 'contributor',
+                                     type: Newsmlg2::Types::FlexAuthorPropType, collection: true
+          xml_element :audiences, xml: 'audience',
+                                  type: Newsmlg2::Types::Audience, collection: true
+          xml_element :excl_audiences, xml: 'exclaudience',
+                                       type: Newsmlg2::Types::ExclAudience, collection: true
+          xml_element :alt_ids, xml: 'altId',
+                                type: Newsmlg2::Types::AltId, collection: true
+          xml_element :ratings, xml: 'rating',
+                                type: Newsmlg2::Types::Rating, collection: true
+          xml_element :user_interactions, xml: 'userInteraction',
+                                          type: Newsmlg2::Types::UserInteraction, collection: true
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/arbitrary_value_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module ArbitraryValueAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :value, :valuedatatype, :valueunit, :valueunituri
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/authority_attributes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # Added in NewsML-G2 2.32.
+    module AuthorityAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :authority, :authoritystatus, :authoritystatusuri
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/common_power_attributes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module CommonPowerAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :id, :creator, :creatoruri, :modified, :custom,
+            :how, :howuri, :why, :whyuri,
+            :pubconstraint, :pubconstrainturi
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/concept_definition_group.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties required to define a concept (concepts.py).
+    module ConceptDefinitionGroup
+      def self.included(klass)
+        klass.class_eval do
+          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
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/concept_relationships_group.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties expressing relationships between concepts
+    # (conceptrelationships.py).
+    module ConceptRelationshipsGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :same_as, xml: 'sameAs',
+                                type: Newsmlg2::Types::SameAs, collection: true
+          xml_element :broader, xml: 'broader',
+                                type: Newsmlg2::Types::Broader, collection: true
+          xml_element :narrower, xml: 'narrower',
+                                 type: Newsmlg2::Types::Narrower, collection: true
+          xml_element :related, xml: 'related',
+                                type: Newsmlg2::Types::Related, collection: true
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/confirmation_status_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module ConfirmationStatusAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :confirmationstatus, :confirmationstatusuri
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/deprecated_link_attributes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # Deprecated attributes once used for target identifiers (link.py).
+    module DeprecatedLinkAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :guidref, :hreftype
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/descriptive_metadata_group.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties associated with the full descriptive facet of
+    # news-related content (contentmeta.py).
+    module DescriptiveMetadataGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :languages, xml: 'language',
+                                  type: Newsmlg2::Types::Language, collection: true
+          xml_element :genres, xml: 'genre',
+                               type: Newsmlg2::Types::Genre, collection: true
+          xml_element :keywords, xml: 'keyword',
+                                 type: Newsmlg2::Types::Keyword, collection: true
+          xml_element :subjects, xml: 'subject',
+                                 type: Newsmlg2::Types::Subject, collection: true
+          xml_element :sluglines, xml: 'slugline',
+                                  type: Newsmlg2::Types::Slugline, collection: true
+          xml_element :headlines, xml: 'headline',
+                                  type: Newsmlg2::Types::Headline, collection: true
+          xml_element :datelines, xml: 'dateline',
+                                  type: Newsmlg2::Types::Dateline, collection: true
+          xml_element :by, xml: 'by', type: Newsmlg2::Types::By, collection: true
+          xml_element :creditlines, xml: 'creditline',
+                                    type: Newsmlg2::Types::Creditline, collection: true
+          xml_element :descriptions, xml: 'description',
+                                     type: Newsmlg2::Types::ContentDescription, collection: true
+        end
+      end
+    end
+
+    # The core subset of the descriptive facet (no genre, dateline, by,
+    # creditline) — used by concept, knowledge, planning and catalog items.
+    module DescriptiveMetadataCoreGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :languages, xml: 'language',
+                                  type: Newsmlg2::Types::Language, collection: true
+          xml_element :keywords, xml: 'keyword',
+                                 type: Newsmlg2::Types::Keyword, collection: true
+          xml_element :subjects, xml: 'subject',
+                                 type: Newsmlg2::Types::Subject, collection: true
+          xml_element :sluglines, xml: 'slugline',
+                                  type: Newsmlg2::Types::Slugline, collection: true
+          xml_element :headlines, xml: 'headline',
+                                  type: Newsmlg2::Types::Headline, collection: true
+          xml_element :descriptions, xml: 'description',
+                                     type: Newsmlg2::Types::ContentDescription, collection: true
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/entity_details_group.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties defining the details of specific entities
+    # (concepts.py EntityDetailsGroup).
+    module EntityDetailsGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :has_instruments, xml: 'hasInstrument',
+                                        type: Newsmlg2::Types::HasInstrument, collection: true
+          xml_element :person_details, xml: 'personDetails',
+                                       type: Newsmlg2::Types::PersonDetails
+          xml_element :organisation_details, xml: 'organisationDetails',
+                                             type: Newsmlg2::Types::OrganisationDetails
+          xml_element :geo_area_details, xml: 'geoAreaDetails',
+                                         type: Newsmlg2::Types::GeoAreaDetails
+          xml_element :poi_details, xml: 'POIDetails',
+                                    type: Newsmlg2::Types::POIDetails
+          xml_element :object_details, xml: 'objectDetails',
+                                       type: Newsmlg2::Types::ObjectDetails
+          xml_element :event_details, xml: 'eventDetails',
+                                      type: Newsmlg2::Types::EventDetails
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/flex_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module FlexAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :qcode, :uri, :literal, :type, :typeuri
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/i18n_attributes.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module I18NAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_lang_attribute
+          xml_attributes :dir
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/item_management_group.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of properties for the management of the item
+    # (itemmanagement.py / XSD ItemManagementGroup). Element order follows the
+    # XSD sequence.
+    module ItemManagementGroup
+      def self.included(klass)
+        klass.class_eval do
+          xml_element :item_class, xml: 'itemClass',
+                                   type: Newsmlg2::Types::QualRelPropType
+          xml_element :provider, xml: 'provider',
+                                 type: Newsmlg2::Types::FlexPartyPropType
+          xml_element :version_created, xml: 'versionCreated',
+                                        type: Newsmlg2::Types::DateTimePropType
+          xml_element :first_created, xml: 'firstCreated',
+                                      type: Newsmlg2::Types::DateTimePropType
+          xml_element :embargoed, xml: 'embargoed',
+                                  type: Newsmlg2::Types::DateTimeOrNullPropType
+          xml_element :pub_status, xml: 'pubStatus',
+                                   type: Newsmlg2::Types::QualPropType
+          xml_element :role, xml: 'role', type: Newsmlg2::Types::QualPropType
+          xml_element :file_name, xml: 'fileName', type: Newsmlg2::Types::FileName
+          xml_element :generators, xml: 'generator',
+                                   type: Newsmlg2::Types::Generator, collection: true
+          xml_element :profile, xml: 'profile',
+                                type: Newsmlg2::Types::VersionedStringType
+          xml_element :services, xml: 'service',
+                                 type: Newsmlg2::Types::QualPropType, collection: true
+          xml_element :titles, xml: 'title',
+                               type: Newsmlg2::Types::Label1Type, collection: true
+          xml_element :ed_notes, xml: 'edNote',
+                                 type: Newsmlg2::Types::BlockType, collection: true
+          xml_element :member_of, xml: 'memberOf',
+                                  type: Newsmlg2::Types::Flex1PropType, collection: true
+          xml_element :instance_of, xml: 'instanceOf',
+                                    type: Newsmlg2::Types::Flex1PropType, collection: true
+          xml_element :signals, xml: 'signal',
+                                type: Newsmlg2::Types::Signal, collection: true
+          xml_element :alt_reps, xml: 'altRep',
+                                 type: Newsmlg2::Types::AltRep, collection: true
+          xml_element :deliverable_of, xml: 'deliverableOf',
+                                       type: Newsmlg2::Types::Link1Type, collection: true
+          xml_element :hashes, xml: 'hash',
+                               type: Newsmlg2::Types::Hash, collection: true
+          xml_element :expires, xml: 'expires',
+                                type: Newsmlg2::Types::DateOptTimePropType, collection: true
+          xml_element :orig_reps, xml: 'origRep',
+                                  type: Newsmlg2::Types::OrigRep, collection: true
+          xml_element :incoming_feed_ids, xml: 'incomingFeedId',
+                                          type: Newsmlg2::Types::IncomingFeedId, collection: true
+          xml_element :metadata_creator, xml: 'metadataCreator',
+                                         type: Newsmlg2::Types::FlexAuthorPropType
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/media_content_characteristics1.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module MediaContentCharacteristics1
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :width, :widthunit, :widthunituri,
+            :height, :heightunit, :heightunituri,
+            :orientation,
+            :layoutorientation, :layoutorientationuri,
+            :colourspace, :colourspaceuri,
+            :colourindicator, :colourindicatoruri,
+            :videocodec, :videocodecuri,
+            :colourdepth
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/news_content_attributes.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module NewsContentAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :id, :creator, :creatoruri, :modified, :custom,
+            :how, :howuri, :why, :whyuri,
+            :rendition, :renditionuri,
+            :generator, :generated, :hascontent
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/news_content_characteristics.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module NewsContentCharacteristics
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :charcount, :wordcount, :linecount, :pagecount,
+            :width, :widthunit, :widthunituri,
+            :height, :heightunit, :heightunituri,
+            :orientation,
+            :layoutorientation, :layoutorientationuri,
+            :colourspace, :colourspaceuri,
+            :colourindicator, :colourindicatoruri,
+            :colourdepth, :resolution,
+            :duration, :durationunit, :durationunituri,
+            :audiocodec, :audiocodecuri, :audiobitrate, :audiovbr,
+            :audiosamplesize, :audiosamplerate,
+            :audiochannels, :audiochannelsuri,
+            :videocodec, :videocodecuri, :videoavgbitrate, :videovbr,
+            :videoframerate, :videoscan, :videoaspectratio, :videosampling,
+            :videoscaling, :videoscalinguri,
+            :videodefinition, :videodefinitionuri
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/news_content_type_attributes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module NewsContentTypeAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :contenttype, :contenttypestandardversion,
+            :contenttypevariant, :contenttypevariantstandardversion,
+            :format, :formaturi, :formatstandardversion
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/persistent_edit_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module PersistentEditAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :id, :creator, :creatoruri, :modified
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/qualifying_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module QualifyingAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :qcode, :uri, :literal, :type, :typeuri, :role, :roleuri
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/quantify_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module QuantifyAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :confidence, :relevance, :derivedfrom
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/ranking_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module RankingAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :rank
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/recurrence_rule_attributes.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # iCalendar RECUR-aligned attributes (events.py).
+    module RecurrenceRuleAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :freq, :interval, :until, :count,
+            :bysecond, :byminute, :byhour, :byday,
+            :bymonthday, :bymonth, :byyearday, :byweekno, :bysetpos, :wkst
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/target_resource_attributes.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    # A group of attributes pertaining to any kind of link (link.py).
+    module TargetResourceAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes(
+            :href, :residref, :version, :persistidref,
+            :contenttype, :contenttypestandardversion,
+            :contenttypevariant, :contenttypevariantstandardversion,
+            :format, :formaturi, :formatstandardversion,
+            :size, :title
+          )
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base/time_validity_attributes.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  module Base
+    module TimeValidityAttributes
+      def self.included(klass)
+        klass.class_eval do
+          xml_attributes :validfrom, :validto
+        end
+      end
+    end
+  end
+end

data/lib/newsmlg2/base.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # Shared XSD attribute groups and element groups, ported module-by-module
+  # from python-newsmlg2's attributegroups.py and the *Group element lists.
+  # Each mixin contributes attributes and mapping rules to the including
+  # NarModel subclass, in include order.
+  module Base
+    autoload :AdministrativeMetadataGroup, 'newsmlg2/base/administrative_metadata_group'
+    autoload :ArbitraryValueAttributes, 'newsmlg2/base/arbitrary_value_attributes'
+    autoload :AuthorityAttributes, 'newsmlg2/base/authority_attributes'
+    autoload :CommonPowerAttributes, 'newsmlg2/base/common_power_attributes'
+    autoload :ConceptDefinitionGroup, 'newsmlg2/base/concept_definition_group'
+    autoload :ConceptRelationshipsGroup, 'newsmlg2/base/concept_relationships_group'
+    autoload :ConfirmationStatusAttributes, 'newsmlg2/base/confirmation_status_attributes'
+    autoload :DeprecatedLinkAttributes, 'newsmlg2/base/deprecated_link_attributes'
+    autoload :DescriptiveMetadataCoreGroup, 'newsmlg2/base/descriptive_metadata_group'
+    autoload :DescriptiveMetadataGroup, 'newsmlg2/base/descriptive_metadata_group'
+    autoload :EntityDetailsGroup, 'newsmlg2/base/entity_details_group'
+    autoload :FlexAttributes, 'newsmlg2/base/flex_attributes'
+    autoload :I18NAttributes, 'newsmlg2/base/i18n_attributes'
+    autoload :ItemManagementGroup, 'newsmlg2/base/item_management_group'
+    autoload :MediaContentCharacteristics1, 'newsmlg2/base/media_content_characteristics1'
+    autoload :NewsContentAttributes, 'newsmlg2/base/news_content_attributes'
+    autoload :NewsContentCharacteristics, 'newsmlg2/base/news_content_characteristics'
+    autoload :NewsContentTypeAttributes, 'newsmlg2/base/news_content_type_attributes'
+    autoload :PersistentEditAttributes, 'newsmlg2/base/persistent_edit_attributes'
+    autoload :QualifyingAttributes, 'newsmlg2/base/qualifying_attributes'
+    autoload :QuantifyAttributes, 'newsmlg2/base/quantify_attributes'
+    autoload :RankingAttributes, 'newsmlg2/base/ranking_attributes'
+    autoload :RecurrenceRuleAttributes, 'newsmlg2/base/recurrence_rule_attributes'
+    autoload :TargetResourceAttributes, 'newsmlg2/base/target_resource_attributes'
+    autoload :TimeValidityAttributes, 'newsmlg2/base/time_validity_attributes'
+  end
+end