newsmlg2 0.1.1

data/lib/newsmlg2/builder/node.rb

@@ -0,0 +1,125 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  class Builder
+    # Wraps one model instance and exposes a DSL method per lutaml-model
+    # attribute. Methods are generated at wrap time from the attribute
+    # metadata, so unknown methods fail with a normal NoMethodError.
+    class Node
+      def initialize(model)
+        @model = model
+        define_attribute_methods
+      end
+
+      attr_reader :model
+
+      # Runs a block against this node and returns the underlying model.
+      def apply(&block)
+        instance_eval(&block) if block
+        @model
+      end
+
+      private
+
+      def define_attribute_methods
+        @model.class.attributes.each_key do |name|
+          next if respond_to?(name, false) || respond_to?(name)
+
+          define_singleton_method(name) do |value = UNSET, **attrs, &block|
+            set_attribute(name, value, attrs, block)
+          end
+
+          singular = singular_of(name)
+          next unless singular && collection?(name)
+
+          define_singleton_method(singular) do |value = UNSET, **attrs, &block|
+            set_attribute(name, value, attrs, block)
+          end
+        end
+      end
+
+      # python-newsmlg2 parity: singular accessor appending to a plural
+      # collection attribute (names -> name, keywords -> keyword,
+      # libraries -> library).
+      def singular_of(name)
+        s = name.to_s
+        if s.end_with?('ies')
+          "#{s[0..-4]}y"
+        elsif s.end_with?('s') && !s.end_with?('ss')
+          s[0..-2]
+        end
+      end
+
+      def private_method_defined?(name)
+        respond_to?(name, true) && !respond_to?(name)
+      end
+
+      def set_attribute(name, value, attrs, block)
+        child =
+          if attrs.any? && !value.equal?(UNSET)
+            build_child(name, **attrs, text: value.to_s)
+          elsif attrs.any?
+            build_child(name, **attrs)
+          elsif !value.equal?(UNSET)
+            coerce(name, value)
+          else
+            build_child(name)
+          end
+
+        child = self.class.new(child).apply(&block) if block && child.is_a?(NarModel)
+        assign(name, child)
+        child
+      end
+
+      def build_child(name, **attrs)
+        type = attribute_type(name)
+        raise ArgumentError, "attribute #{name} is a plain value" if type == String
+
+        type.new(**attrs)
+      end
+
+      def coerce(name, value)
+        type = attribute_type(name)
+        return value if type == String || (!value.is_a?(String) && !value.is_a?(Numeric))
+
+        # A String (or number) assigned to a content-bearing model type
+        # wraps into the type's text content (python-newsmlg2's
+        # "located.name = 'Berlin'" convenience).
+        type.new(text: value.to_s)
+      end
+
+      def text_typed?(name)
+        type = attribute_type(name)
+        type != String
+      end
+
+      def assign(name, child)
+        if collection?(name)
+          current = @model.send(name)
+          if current.nil?
+            @model.send(:"#{name}=", [child])
+          else
+            current << child
+          end
+        else
+          @model.send(:"#{name}=", child)
+        end
+      end
+
+      def collection?(name)
+        attribute = @model.class.attributes[name]
+        attribute.options[:collection] == true
+      rescue StandardError
+        false
+      end
+
+      def attribute_type(name)
+        attribute = @model.class.attributes[name]
+        type = attribute.type
+        type.is_a?(Class) ? type : String
+      rescue StandardError
+        String
+      end
+    end
+  end
+end

data/lib/newsmlg2/builder.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # Generic, reflection-driven builder DSL: node methods are generated from
+  # each model's lutaml-model attribute metadata, so every current and
+  # future Newsmlg2 model is buildable without per-class builder code.
+  #
+  #   doc = Newsmlg2.build_news_item(guid: "...", lang: "en-GB") do |item|
+  #     item.item_meta do |meta|
+  #       meta.item_class qcode: "ninat:text"
+  #       meta.provider qcode: "nprov:acme" do |p|
+  #         p.name "Acme News Agency"
+  #       end
+  #       meta.version_created "2026-08-30T12:00:00+00:00"
+  #     end
+  #     item.content_meta do |cm|
+  #       cm.urgency 2
+  #       cm.headline "Volcano erupts"
+  #       cm.subject qcode: "medtop:20000962" do |s|
+  #         s.name "Volcano"
+  #       end
+  #     end
+  #   end
+  #
+  #   doc.to_xml  # => Newsmlg2::Document
+  class Builder
+    UNSET = Object.new.freeze
+
+    autoload :Node, 'newsmlg2/builder/node'
+
+    class << self
+      # Builds any item model and returns a Document.
+      def build(klass, attributes = {}, &block)
+        attributes = attributes.transform_keys(lang: :xml_lang)
+        model = klass.new(attributes)
+        Builder::Node.new(model).apply(&block) if block
+        Document.new(model)
+      end
+
+      def build_news_item(**attributes, &)
+        build(Newsmlg2::NewsItem, attributes, &)
+      end
+
+      def build_package_item(**attributes, &)
+        build(Newsmlg2::PackageItem, attributes, &)
+      end
+
+      def build_concept_item(**attributes, &)
+        build(Newsmlg2::ConceptItem, attributes, &)
+      end
+
+      def build_knowledge_item(**attributes, &)
+        build(Newsmlg2::KnowledgeItem, attributes, &)
+      end
+
+      def build_catalog_item(**attributes, &)
+        build(Newsmlg2::CatalogItem, attributes, &)
+      end
+
+      def build_planning_item(**attributes, &)
+        build(Newsmlg2::PlanningItem, attributes, &)
+      end
+
+      def build_news_message(**attributes, &)
+        build(Newsmlg2::NewsMessage, attributes, &)
+      end
+    end
+  end
+end

data/lib/newsmlg2/catalog.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # A local or remote catalog: a set of scheme alias-to-URI declarations.
+  class Catalog < Newsmlg2::NarModel
+    include Newsmlg2::Base::CommonPowerAttributes
+    include Newsmlg2::Base::AuthorityAttributes
+
+    xml_attributes additionalinfo: 'additionalInfo', url: 'url',
+                   guid: 'guid', version: 'version'
+    xml_element :titles, xml: 'title',
+                         type: Newsmlg2::Types::Label1Type, collection: true
+    xml_element :schemes, xml: 'scheme',
+                          type: Newsmlg2::Scheme, collection: true
+
+    xml do
+      element 'catalog'
+    end
+
+    def get_scheme_for_alias(alias_name)
+      schemes.find { |scheme| scheme.alias_attr == alias_name }
+    end
+
+    def get_scheme_for_uri(uri)
+      schemes.find { |scheme| scheme.uri == uri }
+    end
+
+    def length
+      schemes.length
+    end
+
+    def to_s
+      return '<Catalog>' if titles.empty?
+
+      "<Catalog \"#{titles.first}\">"
+    end
+  end
+end

data/lib/newsmlg2/catalog_cache.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # Maps remote IPTC catalog URLs to the catalog XML files bundled with this
+  # gem (under lib/newsmlg2/catalogs), so catalogRef resolution never touches
+  # the network.
+  module CatalogCache
+    CATALOGS_PATH = File.join(__dir__, 'catalogs')
+
+    URL_TO_FILE = {
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_32.xml' => 'catalog.IPTC-G2-Standards_32.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_33.xml' => 'catalog.IPTC-G2-Standards_33.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_34.xml' => 'catalog.IPTC-G2-Standards_34.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_35.xml' => 'catalog.IPTC-G2-Standards_35.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_36.xml' => 'catalog.IPTC-G2-Standards_36.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_37.xml' => 'catalog.IPTC-G2-Standards_37.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_38.xml' => 'catalog.IPTC-G2-Standards_38.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_39.xml' => 'catalog.IPTC-G2-Standards_39.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_40.xml' => 'catalog.IPTC-G2-Standards_40.xml',
+      'http://www.iptc.org/std/catalog/catalog.IPTC-G2-Standards_41.xml' => 'catalog.IPTC-G2-Standards_41.xml'
+    }.freeze
+
+    class << self
+      # The bundled file path for a remote catalog URL, or nil when unknown.
+      def bundled_path_for(url)
+        file = URL_TO_FILE[url]
+        return nil unless file
+
+        File.join(CATALOGS_PATH, file)
+      end
+
+      # Reads the bundled catalog XML for a remote catalog URL, or nil.
+      def read(url)
+        path = bundled_path_for(url)
+        return nil unless path
+
+        File.read(path)
+      end
+
+      # Parses the bundled catalog for a remote URL into a Catalog.
+      def load(url)
+        xml = read(url)
+        return nil unless xml
+
+        Newsmlg2::Catalog.from_xml(xml)
+      end
+    end
+  end
+end

data/lib/newsmlg2/catalog_ref.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # A reference to a remote catalog: a hyperlink to a set of scheme alias
+  # declarations.
+  class CatalogRef < Newsmlg2::NarModel
+    xml_attributes :title, :href
+
+    xml do
+      element 'catalogRef'
+    end
+  end
+end

data/lib/newsmlg2/catalog_store.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Newsmlg2
+  # The set of catalogs known to one NewsML-G2 document: inline <catalog>
+  # elements plus catalogs resolved from <catalogRef> hrefs (IPTC standard
+  # catalogs resolve to the files bundled with this gem). Owns scheme alias
+  # and URI lookups used for qcode expansion.
+  class CatalogStore
+    include Enumerable
+
+    def initialize
+      @catalogs = []
+    end
+
+    attr_reader :catalogs
+
+    def add_catalog(catalog)
+      catalogs << catalog
+      self
+    end
+    alias << add_catalog
+
+    def add_catalog_ref(href)
+      catalog = Newsmlg2::CatalogCache.load(href)
+      add_catalog(catalog) if catalog
+    end
+
+    def each(&)
+      catalogs.each(&)
+    end
+
+    def length
+      catalogs.length
+    end
+    alias size length
+
+    def [](index)
+      catalogs[index]
+    end
+
+    def get_scheme_for_alias(alias_name)
+      schemes.each do |scheme|
+        return scheme if scheme.alias_attr == alias_name
+      end
+      raise AliasNotFoundInCatalogs,
+            'no catalog of this document declares the scheme alias ' \
+            "'#{alias_name}'"
+    end
+
+    def get_scheme_for_uri(uri)
+      schemes.each do |scheme|
+        return scheme if scheme.uri == uri
+      end
+      raise UriNotFoundInCatalogs,
+            "no catalog of this document declares the scheme URI '#{uri}'"
+    end
+
+    def schemes
+      catalogs.flat_map(&:schemes)
+    end
+
+    def to_s
+      "#<Newsmlg2::CatalogStore #{length} catalog(s)>"
+    end
+  end
+end