openphar 0.1.1 → 0.3.0

data/lib/openphar/models/hkcmms.rb

@@ -2,25 +2,11 @@
 
 module Openphar
   module Models
-    # Hong Kong Chinese Medicine (HKCMMS) specific models.
-    #
-    # Contains models unique to the Hong Kong Chinese Materia Medica Standards:
-    # - Traditional Chinese Medicine monographs
-    # - Bilingual (Chinese/English) content
-    # - TCM-specific properties (nature, flavor, meridian)
-    #
-    # @example
-    #   # Access HKCMMS models
-    #   Openphar::Models::HKCMMS::TcmMonograph
-    #
-    # @see https://www.cmchk.org.hk/
+    # Hong Kong Chinese Materia Medica Standards (HKCMMS) specific models.
     module HKCMMS
-      # Placeholder for HKCMMS-specific models
-      # Will include:
-      # - TcmMonograph (Traditional Chinese Medicine)
-      # - TcmNature (thermal nature: hot/warm/neutral/cool/cold)
-      # - TcmFlavor (five flavors)
-      # - TcmMeridian (meridian tropism)
+      autoload :Monograph, "openphar/models/hkcmms/monograph"
+      autoload :TcmCrudeDrug, "openphar/models/hkcmms/tcm_crude_drug"
+      autoload :TcmFormulation, "openphar/models/hkcmms/tcm_formulation"
     end
   end
 end

data/lib/openphar/models/jp/amino_acid.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Amino acid monograph.
+      #
+      class AminoAcid < Monograph
+        class << self
+          def wire_key = 'amino_acid'
+          def harmonized_type = 'AminoAcid'
+          def jsonld_type = 'JpAminoAcid'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/biological.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Biological substance monograph.
+      #
+      class Biological < Monograph
+        class << self
+          def wire_key = 'biological'
+          def harmonized_type = 'BiologicalSubstance'
+          def jsonld_type = 'JpBiological'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/chemical_drug.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Chemical drug monograph (substance or preparation).
+      #
+      class ChemicalDrug < Monograph
+        class << self
+          def wire_key = 'chemical_drug'
+          def harmonized_type = 'ChemicalDrug'
+          def jsonld_type = 'JpChemicalDrug'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/crude_drug.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # JP-specific crude-drug (herbal) monograph.
+      #
+      # Carries the botanical source (organism + part used) per JP's
+      # `biological_source` shape in `data-japan-pharmacopia/lib/jp_pharmacopoeia/`.
+      #
+      class CrudeDrug < Monograph
+        attribute :botanical_source, :hash, default: {}
+        attribute :parts_used, :string, collection: true, default: []
+        attribute :description, :hash, default: {}
+        attribute :identification_tests, :hash, default: {}
+        attribute :constituents, :hash, default: {}
+
+        json do
+          map 'botanicalSource', to: :botanical_source
+          map 'partsUsed', to: :parts_used
+          map 'description', to: :description
+          map 'identificationTests', to: :identification_tests
+          map 'constituents', to: :constituents
+        end
+
+        class << self
+          def wire_key = 'crude_drug'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'JpCrudeDrug'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/excipient.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Excipient monograph. No dedicated harmonized base class yet —
+      # excipients are an emerging category that may get a dedicated
+      # type in a future ontology revision.
+      #
+      class Excipient < Monograph
+        class << self
+          def wire_key = 'excipient'
+          def harmonized_type = nil
+          def jsonld_type = 'JpExcipient'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/formulation.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Formulation (finished product) monograph.
+      #
+      class Formulation < Monograph
+        class << self
+          def wire_key = 'formulation'
+          def harmonized_type = 'Formulation'
+          def jsonld_type = 'JpFormulation'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/mineral.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Mineral substance monograph.
+      #
+      class Mineral < Monograph
+        class << self
+          def wire_key = 'mineral'
+          def harmonized_type = 'MineralSubstance'
+          def jsonld_type = 'JpMineral'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/monograph.rb

@@ -0,0 +1,58 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Base class for all Japan Pharmacopoeia monographs.
+      #
+      # Carries JP-specific identity (japanese_name, english_name, category)
+      # on top of the harmonized Openphar::Models::Monograph. Concrete
+      # subclasses declare their semantic @type via class methods.
+      #
+      class Monograph < Openphar::Models::Monograph
+        attribute :japanese_name, :string
+        attribute :english_name, :string
+        attribute :category, :string
+
+        json do
+          map 'japaneseName', to: :japanese_name
+          map 'englishName', to: :english_name
+          map 'category', to: :category
+        end
+
+        class << self
+          def wire_key
+            'monograph'
+          end
+
+          def harmonized_type
+            nil
+          end
+
+          def jsonld_type
+            'JpMonograph'
+          end
+
+          def jsonld_types
+            types = ['Monograph']
+            types << harmonized_type if harmonized_type
+            types << jsonld_type unless jsonld_type == 'Monograph'
+            types.uniq
+          end
+
+          def neo4j_labels
+            labels = %w[Monograph JP]
+            labels << harmonized_type if harmonized_type
+            labels << name&.split('::')&.last
+            labels.compact.uniq
+          end
+        end
+
+        def iri
+          ed = (edition || 'jp18').to_s.downcase.gsub(/[^a-z0-9]/, '-')
+          "#{Openphar.base_iri}/data/jp/#{ed}/#{monograph_id}"
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/powdered_crude_drug.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # JP-specific powdered crude drug.
+      #
+      # JP distinguishes powdered crude drugs from whole crude drugs in
+      # its own monograph type — a JP-only distinction. Powdered forms
+      # have additional tests (e.g., microscopic identification) that
+      # whole crude drugs don't.
+      #
+      class PowderedCrudeDrug < CrudeDrug
+        attribute :microscopic_identification, :hash, default: {}
+
+        json do
+          map 'microscopicIdentification', to: :microscopic_identification
+        end
+
+        class << self
+          def wire_key = 'powdered_crude_drug'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'JpPowderedCrudeDrug'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp/vitamin.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module JP
+      # Vitamin monograph.
+      #
+      class Vitamin < Monograph
+        class << self
+          def wire_key = 'vitamin'
+          def harmonized_type = 'Vitamin'
+          def jsonld_type = 'JpVitamin'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/jp.rb

@@ -3,19 +3,18 @@
 module Openphar
   module Models
     # Japan Pharmacopoeia (JP) specific models.
-    #
-    # Contains models unique to the Japanese Pharmacopoeia:
-    # - Kampo formulas (Japanese traditional medicine formulations)
-    # - JP-specific monograph extensions
-    #
-    # @example
-    #   # Access JP models
-    #   Openphar::Models::JP::KampoFormula
-    #
-    # @see https://www.mhlw.go.jp/topics/bukyoku/iyaku/yakkyoku/
     module JP
-      # Kampo formulas (Japanese traditional medicine)
-      autoload :KampoFormula, 'openphar/models/jp/kampo_formula'
+      autoload :KampoFormula, "openphar/models/jp/kampo_formula"
+      autoload :Monograph, "openphar/models/jp/monograph"
+      autoload :CrudeDrug, "openphar/models/jp/crude_drug"
+      autoload :PowderedCrudeDrug, "openphar/models/jp/powdered_crude_drug"
+      autoload :ChemicalDrug, "openphar/models/jp/chemical_drug"
+      autoload :Formulation, "openphar/models/jp/formulation"
+      autoload :Biological, "openphar/models/jp/biological"
+      autoload :Excipient, "openphar/models/jp/excipient"
+      autoload :Vitamin, "openphar/models/jp/vitamin"
+      autoload :AminoAcid, "openphar/models/jp/amino_acid"
+      autoload :Mineral, "openphar/models/jp/mineral"
     end
   end
 end

data/lib/openphar/models/monograph.rb

@@ -44,6 +44,34 @@ module Openphar
         def jsonld_type
           'Monograph'
         end
+
+        # Override in subclasses to declare the cross-publisher semantic
+        # type (e.g., "CrudeDrug", "ChemicalDrug"). Returns nil when the
+        # subclass is publisher-specific with no harmonized equivalent.
+        #
+        # @return [String, nil]
+        def harmonized_type
+          nil
+        end
+
+        # Override in subclasses to declare the publisher-specific
+        # snake_case routing key (e.g., "tcm_crude_drug", "dravya").
+        #
+        # @return [String]
+        def wire_key
+          'monograph'
+        end
+
+        # Array of types to emit in JSON-LD @type. Computed from
+        # harmonized_type + jsonld_type + the base 'Monograph'.
+        #
+        # @return [Array<String>]
+        def jsonld_types
+          types = ['Monograph']
+          types << harmonized_type if harmonized_type
+          types << jsonld_type unless jsonld_type == 'Monograph'
+          types.uniq
+        end
       end
 
       def iri

data/lib/openphar/models/thp/cannabis_monograph.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module THP
+      # THP-specific cannabis monograph (Thailand legalized cannabis for
+      # medical and research use in 2018; the Thai Herbal Pharmacopoeia
+      # maintains a distinct monograph type with regulatory-specific fields).
+      #
+      class CannabisMonograph < Monograph
+        attribute :cultivar, :string
+        attribute :thc_content, :string          # Δ9-THC percent by dry weight
+        attribute :cbd_content, :string          # CBD percent
+        attribute :cbn_content, :string           # CBN percent
+        attribute :terpene_profile, :hash, default: {}
+        attribute :cultivation_license, :string  # Thai FDA license category
+        attribute :medical_use_category, :string
+        attribute :contraindications, :string, collection: true, default: []
+
+        json do
+          map 'cultivar', to: :cultivar
+          map 'thcContent', to: :thc_content
+          map 'cbdContent', to: :cbd_content
+          map 'cbnContent', to: :cbn_content
+          map 'terpeneProfile', to: :terpene_profile
+          map 'cultivationLicense', to: :cultivation_license
+          map 'medicalUseCategory', to: :medical_use_category
+          map 'contraindications', to: :contraindications
+        end
+
+        class << self
+          def wire_key = 'cannabis_monograph'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'ThpCannabisMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/thp/herbal_monograph.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module THP
+      # Standard Thai Herbal Pharmacopoeia crude drug monograph.
+      #
+      class HerbalMonograph < Monograph
+        attribute :plant_part, :string
+        attribute :botanical_description, :hash, default: {}
+        attribute :constituents, :hash, default: {}
+        attribute :uses, :string, collection: true, default: []
+        attribute :dose, :string
+        attribute :contraindications, :string, collection: true, default: []
+
+        json do
+          map 'plantPart', to: :plant_part
+          map 'botanicalDescription', to: :botanical_description
+          map 'constituents', to: :constituents
+          map 'uses', to: :uses
+          map 'dose', to: :dose
+          map 'contraindications', to: :contraindications
+        end
+
+        class << self
+          def wire_key = 'herbal_monograph'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'ThpHerbalMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/thp/monograph.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module THP
+      # Thai Herbal Pharmacopoeia monograph (base + stub).
+      #
+      # Thai-specific traditional-medicine properties are deferred; this
+      # class exists so THP records classify and serialize today.
+      #
+      class Monograph < Openphar::Models::Monograph
+        attribute :thai_name, :string
+        attribute :english_name, :string
+
+        json do
+          map 'thaiName', to: :thai_name
+          map 'englishName', to: :english_name
+        end
+
+        class << self
+          def wire_key = 'monograph'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'ThpMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/thp.rb

@@ -3,22 +3,10 @@
 module Openphar
   module Models
     # Thai Herbal Pharmacopoeia (THP) specific models.
-    #
-    # Contains models unique to the Thai Herbal Pharmacopoeia:
-    # - Thai traditional medicine monographs
-    # - Bilingual (Thai/English) content
-    # - Cannabis monographs (legal in Thailand)
-    #
-    # @example
-    #   # Access THP models
-    #   Openphar::Models::THP::ThaiHerbalMonograph
-    #
-    # @see http://www.fda.moph.go.th/
     module THP
-      # Placeholder for THP-specific models
-      # Will include:
-      # - ThaiHerbalMonograph
-      # - CannabisMonograph (THP-specific)
+      autoload :Monograph, "openphar/models/thp/monograph"
+      autoload :HerbalMonograph, "openphar/models/thp/herbal_monograph"
+      autoload :CannabisMonograph, "openphar/models/thp/cannabis_monograph"
     end
   end
 end

data/lib/openphar/publisher_registry.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Openphar
+  # Single source of truth for "which publishers are registered."
+  #
+  # Static frozen hash — adding a publisher means one edit here AND a new
+  # publisher module file. Specs verify the two stay in sync.
+  #
+  module PublisherRegistry
+    KNOWN_PUBLISHERS = {
+      "ChP" => {
+        code: "ChP",
+        label: "Chinese Pharmacopoeia",
+        module_name: "Openphar::Models::Chp",
+        editions: %w[ChP-2025 ChP-2020].freeze,
+        homepage: "https://2025.chp.org.cn".freeze,
+      }.freeze,
+      "JP" => {
+        code: "JP",
+        label: "Japanese Pharmacopoeia",
+        module_name: "Openphar::Models::JP",
+        editions: %w[JP18].freeze,
+        homepage: "https://www.mhlw.go.jp/topics/bukyoku/iyaku/yakkyoku/".freeze,
+      }.freeze,
+      "PhInt" => {
+        code: "PhInt",
+        label: "International Pharmacopoeia (WHO)",
+        module_name: "Openphar::Models::PhInt",
+        editions: %w[PhInt-13].freeze,
+        homepage: "https://www.who.int/teams/health-product-and-policy-standards/inn-and-pharmacopoeia".freeze,
+      }.freeze,
+      "AHP" => {
+        code: "AHP",
+        label: "American Herbal Pharmacopoeia",
+        module_name: "Openphar::Models::AHP",
+        editions: [].freeze,
+        homepage: "https://www.herbal-ahp.org/".freeze,
+      }.freeze,
+      "API" => {
+        code: "API",
+        label: "Ayurvedic Pharmacopoeia of India",
+        module_name: "Openphar::Models::API",
+        editions: [].freeze,
+        homepage: "https://main.ayush.gov.in/".freeze,
+      }.freeze,
+      "HKCMMS" => {
+        code: "HKCMMS",
+        label: "Hong Kong Chinese Materia Medica Standards",
+        module_name: "Openphar::Models::HKCMMS",
+        editions: [].freeze,
+        homepage: "https://www.cmchk.org.hk/".freeze,
+      }.freeze,
+      "THP" => {
+        code: "THP",
+        label: "Thai Herbal Pharmacopoeia",
+        module_name: "Openphar::Models::THP",
+        editions: [].freeze,
+        homepage: "http://www.fda.moph.go.th/".freeze,
+      }.freeze,
+    }.freeze
+
+    class << self
+      def all
+        KNOWN_PUBLISHERS
+      end
+
+      def [](code)
+        KNOWN_PUBLISHERS[code.to_s]
+      end
+
+      def registered?(code)
+        KNOWN_PUBLISHERS.key?(code.to_s)
+      end
+
+      def codes
+        KNOWN_PUBLISHERS.keys.sort
+      end
+
+      def module_for(code)
+        entry = self[code]
+        return nil unless entry
+
+        entry[:module_name].safe_constantize
+      end
+    end
+  end
+
+  module_function
+
+  def publishers
+    PublisherRegistry.all
+  end
+end

data/lib/openphar/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Openphar
-  VERSION = "0.1.1"
+  VERSION = "0.3.0"
 end

data/lib/openphar.rb

@@ -112,4 +112,6 @@ module Openphar
   autoload :Errors, 'openphar/errors'
   autoload :MonographMerger, 'openphar/monograph_merger'
   autoload :Registry, 'openphar/registry'
+  autoload :PublisherRegistry, 'openphar/publisher_registry'
+  autoload :HarmonizedTypeRegistry, 'openphar/harmonized_type_registry'
 end

data/ontology/context/ahp.jsonld

@@ -0,0 +1,20 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@base": "https://www.openphar.org/data/ahp/",
+    "@vocab": "https://www.openphar.org/ontology/publisher/ahp/",
+    "ahp": "https://www.openphar.org/ontology/publisher/ahp/",
+    "op": "https://www.openphar.org/ontology/core/",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "dct": "http://purl.org/dc/terms/",
+    "skos": "http://www.w3.org/2004/02/skos/core#",
+    "id": "@id",
+    "type": "@type",
+    "title": "dct:title",
+    "prefLabel": "skos:prefLabel",
+    "publisher": "dct:publisher",
+    "monographId": { "@id": "op:monographId", "@type": "xsd:string" },
+    "belongsToEdition": { "@id": "op:belongsToEdition", "@type": "@id" },
+    "sameSubstanceAs": { "@id": "op:sameSubstanceAs", "@type": "@id", "@container": "@set" }
+  }
+}

data/ontology/context/api.jsonld

@@ -0,0 +1,20 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@base": "https://www.openphar.org/data/api/",
+    "@vocab": "https://www.openphar.org/ontology/publisher/api/",
+    "api": "https://www.openphar.org/ontology/publisher/api/",
+    "op": "https://www.openphar.org/ontology/core/",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "dct": "http://purl.org/dc/terms/",
+    "skos": "http://www.w3.org/2004/02/skos/core#",
+    "id": "@id",
+    "type": "@type",
+    "title": "dct:title",
+    "prefLabel": "skos:prefLabel",
+    "publisher": "dct:publisher",
+    "monographId": { "@id": "op:monographId", "@type": "xsd:string" },
+    "belongsToEdition": { "@id": "op:belongsToEdition", "@type": "@id" },
+    "sameSubstanceAs": { "@id": "op:sameSubstanceAs", "@type": "@id", "@container": "@set" }
+  }
+}

data/ontology/context/hkcmms.jsonld

@@ -0,0 +1,20 @@
+{
+  "@context": {
+    "@version": 1.1,
+    "@base": "https://www.openphar.org/data/hkcmms/",
+    "@vocab": "https://www.openphar.org/ontology/publisher/hkcmms/",
+    "hkcmms": "https://www.openphar.org/ontology/publisher/hkcmms/",
+    "op": "https://www.openphar.org/ontology/core/",
+    "xsd": "http://www.w3.org/2001/XMLSchema#",
+    "dct": "http://purl.org/dc/terms/",
+    "skos": "http://www.w3.org/2004/02/skos/core#",
+    "id": "@id",
+    "type": "@type",
+    "title": "dct:title",
+    "prefLabel": "skos:prefLabel",
+    "publisher": "dct:publisher",
+    "monographId": { "@id": "op:monographId", "@type": "xsd:string" },
+    "belongsToEdition": { "@id": "op:belongsToEdition", "@type": "@id" },
+    "sameSubstanceAs": { "@id": "op:sameSubstanceAs", "@type": "@id", "@container": "@set" }
+  }
+}