openphar 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 280d70f7579d3cb228333df16ec115b82188d187cc1048ac36175306deb776ac
-  data.tar.gz: 758ea9d16267bbe17b97bfee72b2822ef94099ea306e3f6adf3c74fe1bd30a02
+  metadata.gz: d35db752ba7a2c40757ca084fb31fdb95f519c1a4cdc5fca9197b6798a9b426f
+  data.tar.gz: a987b5e0709dcad7573af2e76a54c1e906a59492b9ac0cec394769448cd15880
 SHA512:
-  metadata.gz: d16970a8e1c456ca1218b84167f9bd8d9882f0bca5882380ea63d6521df404ec66b34c95fb764ba1c8181f2be83e1ab0850bf7624b67c074db8fc6268ce5b5d2
-  data.tar.gz: 6cf813f872155cbf7f767bf1393c8c199a9f1c0c86fbb16597a748a3f84f18a1380e52c4f1631ec7298dfc306290661b0c157c3447041e766aade3e71cf8ac39
+  metadata.gz: 34a0338ab86fa45a258b3084a694242eec59ca8578960788078f3f4d3afe6c1c6e814d5117e3e3c211658c996c7bc4bd8faae6d378dd206aaea163b21a707b2b
+  data.tar.gz: 47235f7908eb73956a0f553f985c4b5fbf162589f634a3fccecdf9ea0df82a7b3edd02a1257dfebf1d2340df3bed462d1e6738f1a7c0d1b1b5946d9566519348

data/lib/openphar/harmonized_type_registry.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Openphar
+  # Frozen set of recognized harmonized type names.
+  #
+  # Every publisher subclass's `harmonized_type` (when non-nil) must be in
+  # this list. Specs verify that. Catches typos at definition time.
+  #
+  module HarmonizedTypeRegistry
+    RECOGNIZED = %w[
+      Monograph
+      CrudeDrug
+      ChemicalDrug
+      Formulation
+      BiologicalSubstance
+      Vitamin
+      AminoAcid
+      MineralSubstance
+      Radiopharmaceutical
+      DosageForm
+      TestMethod
+      Reagent
+      ReferenceSubstance
+      GeneralChapter
+    ].freeze
+
+    class << self
+      def valid?(type)
+        return false if type.nil?
+
+        RECOGNIZED.include?(type.to_s)
+      end
+
+      def assert!(type)
+        return if valid?(type)
+
+        raise ArgumentError, "unknown harmonized type: #{type.inspect}. " \
+                             "Must be one of: #{RECOGNIZED.join(', ')}"
+      end
+
+      def all
+        RECOGNIZED.dup
+      end
+    end
+  end
+end

data/lib/openphar/migrators/jp/classifier.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Migrators
+    module JP
+      # Single dispatch point mapping a JP record's type string to the
+      # correct Openphar::Models::JP::* subclass.
+      #
+      # JP's HTML parser already produces a type string (e.g.,
+      # "CrudeDrugMonograph"); the classifier trusts it and maps to the
+      # JP-specific subclass. Falls back to JP::Monograph for unknown
+      # type strings.
+      #
+      # MECE invariant: every type string in TYPE_MAP classifies to
+      # exactly one subclass; every other input falls back to the base.
+      #
+      class Classifier
+        TYPE_MAP = {
+          'CrudeDrugMonograph' => 'CrudeDrug',
+          'ChemicalDrugMonograph' => 'ChemicalDrug',
+          'FormulationMonograph' => 'Formulation',
+          'BiologicalSubstanceMonograph' => 'Biological',
+          'VitaminMonograph' => 'Vitamin',
+          'AminoAcidMonograph' => 'AminoAcid',
+          'MineralSubstanceMonograph' => 'Mineral',
+        }.freeze
+
+        FINAL_FALLBACK = 'Monograph'.freeze
+
+        class << self
+          # @param type_string [String, nil] Harmonized type string from the parser.
+          # @param name [String, nil] Monograph name (for name-based heuristics, deferred).
+          # @return [Class] a subclass of Openphar::Models::JP::Monograph
+          def classify(type_string:, name: nil)
+            klass_name = TYPE_MAP.fetch(type_string, FINAL_FALLBACK)
+            Openphar::Models::JP.const_get(klass_name)
+          end
+
+          def all_types
+            %i[CrudeDrug ChemicalDrug Formulation Biological
+               Excipient Vitamin AminoAcid Mineral].map do |k|
+              Openphar::Models::JP.const_get(k)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openphar/migrators/jp.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Migrators
+    # Japan Pharmacopoeia migrator namespace.
+    #
+    module JP
+      autoload :Classifier, 'openphar/migrators/jp/classifier'
+    end
+  end
+end

data/lib/openphar/migrators/ph_int/classifier.rb

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Migrators
+    module PhInt
+      # Single dispatch point mapping a Ph.Int. record's section_id to the
+      # correct Openphar::Models::PhInt::* subclass.
+      #
+      # Ph.Int. is organized by section number:
+      #   1     preface
+      #   4     general notices
+      #   5     abbreviations
+      #   6.1   pharmaceutical substances (chemical)
+      #   6.2   dosage forms
+      #   6.3   radiopharmaceuticals (specific)
+      #   7     methods
+      #   8     radiopharmaceuticals (general)
+      #   9     reagents / reference substances
+      #   10    supplementary
+      #
+      class Classifier
+        SECTION_PATTERNS = [
+          { regex: %r{\A6\.1\.}, klass: 'DosageFormMonograph' }, # default for 6.1 — overridden below
+          { regex: %r{\A6\.2\.1\.}, klass: 'DosageFormMonograph' },
+          { regex: %r{\A6\.2\.2\.}, klass: 'DosageFormMonograph' },
+          { regex: %r{\A6\.3\.}, klass: 'RadiopharmaceuticalMonograph' },
+          { regex: %r{\A7\.},     klass: 'TestMethod' },
+          { regex: %r{\A8\.},     klass: 'RadiopharmaceuticalMonograph' },
+          { regex: %r{\A9\.},     klass: 'Reagent' },
+        ].freeze
+
+        SECTION_DEFAULTS = {
+          '6.1' => 'DosageFormMonograph', # Ph.Int. substances are typically 6.1.x
+        }.freeze
+
+        FINAL_FALLBACK = 'Monograph'.freeze
+
+        class << self
+          # @param section_id [String, nil] e.g., "6.1.1", "7.1", "9.1"
+          # @param entity_type [String, nil] Optional explicit type hint
+          # @return [Class] a subclass of Openphar::Models::PhInt's namespaces
+          def classify(section_id:, entity_type: nil)
+            return Openphar::Models::Monograph if section_id.nil? || section_id.empty?
+
+            klass_name = resolve(section_id)
+            # Ph.Int. classes live under Openphar::Models::PhInt::*
+            return Openphar::Models::PhInt.const_get(klass_name) if Openphar::Models::PhInt.const_defined?(klass_name)
+
+            Openphar::Models::Monograph
+          rescue NameError
+            Openphar::Models::Monograph
+          end
+
+          def all_types
+            %i[RadiopharmaceuticalMonograph DosageFormMonograph
+               TestMethod Reagent TestSolution VolumetricSolution
+               BufferSolution ReferenceSubstance].map do |k|
+              Openphar::Models::PhInt.const_get(k)
+            end
+          end
+
+          private
+
+          def resolve(section_id)
+            SECTION_PATTERNS.each do |rule|
+              return rule[:klass] if section_id.match?(rule[:regex])
+            end
+            FINAL_FALLBACK
+          end
+        end
+      end
+    end
+  end
+end

data/lib/openphar/migrators/ph_int.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Migrators
+    # International Pharmacopoeia (Ph.Int.) migrator namespace.
+    #
+    module PhInt
+      autoload :Classifier, 'openphar/migrators/ph_int/classifier'
+    end
+  end
+end

data/lib/openphar/migrators.rb

@@ -11,5 +11,7 @@ module Openphar
     autoload :PhIntMigrator, 'openphar/migrators/phint_migrator'
     autoload :Chp, 'openphar/migrators/chp'
     autoload :ChpMigrator, 'openphar/migrators/chp_migrator'
+    autoload :JP, 'openphar/migrators/jp'
+    autoload :PhInt, 'openphar/migrators/ph_int'
   end
 end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module AHP
+      # AHP finished-product formulation monograph.
+      #
+      class Formulation < Monograph
+        attribute :ingredients, :hash, collection: true, default: []
+        attribute :dosage_form, :string
+        attribute :adult_dose, :string
+        attribute :indications, :string, collection: true, default: []
+
+        json do
+          map 'ingredients', to: :ingredients
+          map 'dosageForm', to: :dosage_form
+          map 'adultDose', to: :adult_dose
+          map 'indications', to: :indications
+        end
+
+        class << self
+          def wire_key = 'formulation'
+          def harmonized_type = 'Formulation'
+          def jsonld_type = 'AhpFormulation'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module AHP
+      # AHP crude drug (herbal substance) monograph.
+      #
+      class HerbalMonograph < Monograph
+        attribute :parts_used, :string, collection: true, default: []
+        attribute :botanical_description, :hash, default: {}
+        attribute :constituents, :hash, default: {}
+        attribute :therapeutic_actions, :string, collection: true, default: []
+        attribute :clinical_evidence, :hash, default: {}
+        attribute :safety_rating, :string
+        attribute :contraindications, :string, collection: true, default: []
+        attribute :drug_interactions, :string, collection: true, default: []
+        attribute :side_effects, :string, collection: true, default: []
+        attribute :dosage_forms, :string, collection: true, default: []
+        attribute :adult_dose, :string
+
+        json do
+          map 'partsUsed', to: :parts_used
+          map 'botanicalDescription', to: :botanical_description
+          map 'constituents', to: :constituents
+          map 'therapeuticActions', to: :therapeutic_actions
+          map 'clinicalEvidence', to: :clinical_evidence
+          map 'safetyRating', to: :safety_rating
+          map 'contraindications', to: :contraindications
+          map 'drugInteractions', to: :drug_interactions
+          map 'sideEffects', to: :side_effects
+          map 'dosageForms', to: :dosage_forms
+          map 'adultDose', to: :adult_dose
+        end
+
+        class << self
+          def wire_key = 'herbal_monograph'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'AhpHerbalMonograph'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module AHP
+      # Base class for American Herbal Pharmacopoeia monographs.
+      #
+      # AHP monographs carry the most extensive botanical and clinical
+      # evidence of any pharmacopoeia, including safety ratings and
+      # contraindications.
+      #
+      class Monograph < Openphar::Models::Monograph
+        attribute :common_name, :string
+        attribute :latin_name, :string
+        attribute :family, :string
+
+        json do
+          map 'commonName', to: :common_name
+          map 'latinName', to: :latin_name
+          map 'family', to: :family
+        end
+
+        class << self
+          def wire_key = 'monograph'
+          def harmonized_type = nil
+          def jsonld_type = 'AhpMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/ahp.rb

@@ -3,23 +3,10 @@
 module Openphar
   module Models
     # American Herbal Pharmacopoeia (AHP) specific models.
-    #
-    # Contains models unique to the American Herbal Pharmacopoeia:
-    # - Western herbal monographs with comprehensive therapeutic information
-    # - Safety and efficacy profiles
-    # - Detailed analytical methods for botanicals
-    #
-    # @example
-    #   # Access AHP models
-    #   Openphar::Models::AHP::HerbalMonograph
-    #
-    # @see https://www.herbal-ahp.org/
     module AHP
-      # Placeholder for AHP-specific models
-      # Will include:
-      # - HerbalMonograph (Western herbal medicine)
-      # - TherapeuticProfile
-      # - SafetyProfile
+      autoload :Monograph, "openphar/models/ahp/monograph"
+      autoload :HerbalMonograph, "openphar/models/ahp/herbal_monograph"
+      autoload :Formulation, "openphar/models/ahp/formulation"
     end
   end
 end

data/lib/openphar/models/api/bhasma.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module API
+      # Bhasma — Ayurvedic processed-mineral / metal preparation.
+      #
+      # Bhasmas are unique to Ayurvedic medicine: a mineral or metal is
+      # repeatedly calcined with herbal juices to produce an ash with
+      # therapeutic properties. Carries Rasa/Guna/Virya/Vipaka/Karma like
+      # a Dravya but with mineral-specific source + preparation method.
+      #
+      class Bhasma < Monograph
+        attribute :source_mineral, :string
+        attribute :purification_method, :string
+        attribute :preparation_method, :string
+        attribute :rasa, :string, collection: true, default: []
+        attribute :guna, :string, collection: true, default: []
+        attribute :virya, :string
+        attribute :vipaka, :string
+        attribute :karma, :string, collection: true, default: []
+        attribute :dose, :string
+
+        json do
+          map 'sourceMineral', to: :source_mineral
+          map 'purificationMethod', to: :purification_method
+          map 'preparationMethod', to: :preparation_method
+          map 'rasa', to: :rasa
+          map 'guna', to: :guna
+          map 'virya', to: :virya
+          map 'vipaka', to: :vipaka
+          map 'karma', to: :karma
+          map 'dose', to: :dose
+        end
+
+        class << self
+          def wire_key = 'bhasma'
+          def harmonized_type = 'MineralSubstance'
+          def jsonld_type = 'ApiBhasma'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/api/dravya.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module API
+      # Ayurvedic plant-substance monograph (Dravya).
+      #
+      # Dravya = "substance" in Ayurveda. Carries the full Ayurvedic
+      # pharmacognostic profile: Panchakarma properties (Rasa/Guna/Virya/
+      # Vipaka/Karma), purity limits, constituents, dose.
+      #
+      # Mirrors the structure of `data-india-ayurvedic-pharmacopoeia/
+      # sample-monograph.md`.
+      #
+      class Dravya < Monograph
+        attribute :plant_part, :string
+        attribute :macroscopic_description, :hash, default: {}
+        attribute :microscopic_description, :hash, default: {}
+        attribute :foreign_matter_limit, :string
+        attribute :total_ash_limit, :string
+        attribute :acid_insoluble_ash_limit, :string
+        attribute :alcohol_soluble_extractive, :string
+        attribute :water_soluble_extractive, :string
+        attribute :constituents, :string, collection: true, default: []
+        attribute :rasa, :string, collection: true, default: []
+        attribute :guna, :string, collection: true, default: []
+        attribute :virya, :string
+        attribute :vipaka, :string
+        attribute :karma, :string, collection: true, default: []
+        attribute :important_formulations, :string, collection: true, default: []
+        attribute :therapeutic_uses, :string, collection: true, default: []
+        attribute :dose, :string
+
+        json do
+          map 'plantPart', to: :plant_part
+          map 'macroscopicDescription', to: :macroscopic_description
+          map 'microscopicDescription', to: :microscopic_description
+          map 'foreignMatterLimit', to: :foreign_matter_limit
+          map 'totalAshLimit', to: :total_ash_limit
+          map 'acidInsolubleAshLimit', to: :acid_insoluble_ash_limit
+          map 'alcoholSolubleExtractive', to: :alcohol_soluble_extractive
+          map 'waterSolubleExtractive', to: :water_soluble_extractive
+          map 'constituents', to: :constituents
+          map 'rasa', to: :rasa
+          map 'guna', to: :guna
+          map 'virya', to: :virya
+          map 'vipaka', to: :vipaka
+          map 'karma', to: :karma
+          map 'importantFormulations', to: :important_formulations
+          map 'therapeuticUses', to: :therapeutic_uses
+          map 'dose', to: :dose
+        end
+
+        class << self
+          def wire_key = 'dravya'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'ApiDravya'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module API
+      # Classical Ayurvedic formulation (Asava, Arishta, Bhasma, Churna, etc.)
+      #
+      class Formulation < Monograph
+        attribute :ingredients, :hash, collection: true, default: []
+        attribute :method_of_preparation, :string
+        attribute :anupana, :string
+        attribute :dose, :string
+        attribute :indications, :string, collection: true, default: []
+
+        json do
+          map 'ingredients', to: :ingredients
+          map 'methodOfPreparation', to: :method_of_preparation
+          map 'anupana', to: :anupana
+          map 'dose', to: :dose
+          map 'indications', to: :indications
+        end
+
+        class << self
+          def wire_key = 'formulation'
+          def harmonized_type = 'Formulation'
+          def jsonld_type = 'ApiFormulation'
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module API
+      # Base class for Ayurvedic Pharmacopoeia of India monographs.
+      #
+      # Carries multi-language identity (Sanskrit, English, Latin, plus
+      # regional Indian-language synonyms — API monographs typically list
+      # 13+ language variants per plant).
+      #
+      class Monograph < Openphar::Models::Monograph
+        attribute :sanskrit_name, :string
+        attribute :english_name, :string
+        attribute :latin_name, :string
+        attribute :family, :string
+        attribute :synonyms, :hash, default: {}
+
+        json do
+          map 'sanskritName', to: :sanskrit_name
+          map 'englishName', to: :english_name
+          map 'latinName', to: :latin_name
+          map 'family', to: :family
+          map 'synonyms', to: :synonyms
+        end
+
+        class << self
+          def wire_key = 'monograph'
+          def harmonized_type = nil
+          def jsonld_type = 'ApiMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/api.rb

@@ -3,27 +3,11 @@
 module Openphar
   module Models
     # Ayurvedic Pharmacopoeia of India (API) specific models.
-    #
-    # Contains models unique to the Ayurvedic Pharmacopoeia of India:
-    # - Dravya (Ayurvedic substances) with Rasa/Guna/Virya/Vipaka/Karma properties
-    # - Traditional Ayurvedic formulations (Asava, Arishta, Bhasma, etc.)
-    # - Classical preparation methods
-    #
-    # @example
-    #   # Access API models
-    #   Openphar::Models::API::DravyaMonograph
-    #   Openphar::Models::API::AyurvedicFormula
-    #
-    # @see https://main.ayush.gov.in/
     module API
-      # Placeholder for API-specific models
-      # Will include:
-      # - DravyaMonograph (Ayurvedic substances)
-      # - AyurvedicFormula (classical formulations)
-      # - Rasa (taste properties)
-      # - Guna (quality properties)
-      # - Virya (potency)
-      # - Vipaka (post-digestive effect)
+      autoload :Monograph, "openphar/models/api/monograph"
+      autoload :Dravya, "openphar/models/api/dravya"
+      autoload :Formulation, "openphar/models/api/formulation"
+      autoload :Bhasma, "openphar/models/api/bhasma"
     end
   end
 end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module HKCMMS
+      # Hong Kong Chinese Materia Medica Standards monograph (base + stub).
+      #
+      # TCM-specific properties (nature, flavor, meridian) are deferred;
+      # this class exists so HKCMMS records classify and serialize today.
+      #
+      class Monograph < Openphar::Models::Monograph
+        attribute :chinese_name, :string
+        attribute :english_name, :string
+
+        json do
+          map 'chineseName', to: :chinese_name
+          map 'englishName', to: :english_name
+        end
+
+        class << self
+          def wire_key = 'monograph'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'HkcmmsMonograph'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/hkcmms/tcm_crude_drug.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module HKCMMS
+      # HKCMMS TCM crude drug monograph.
+      #
+      # Carries the four classical TCM pharmacological properties:
+      # nature (四气), flavor (五味), meridian tropism (归经), plus
+      # TCM functions (功效) and indications (主治).
+      #
+      class TcmCrudeDrug < Monograph
+        attribute :nature, :string, collection: true, default: []  # 四气: cold/cool/neutral/warm/hot
+        attribute :flavor, :string, collection: true, default: []  # 五味: sweet/sour/bitter/pungent/salty
+        attribute :meridian_tropism, :string, collection: true, default: []  # 归经
+        attribute :functions, :string, collection: true, default: []  # 功效
+        attribute :indications, :string, collection: true, default: []  # 主治
+        attribute :botanical_source, :hash, default: {}
+        attribute :parts_used, :string, collection: true, default: []
+        attribute :constituents, :hash, default: {}
+        attribute :dosage, :string
+
+        json do
+          map 'nature', to: :nature
+          map 'flavor', to: :flavor
+          map 'meridianTropism', to: :meridian_tropism
+          map 'functions', to: :functions
+          map 'indications', to: :indications
+          map 'botanicalSource', to: :botanical_source
+          map 'partsUsed', to: :parts_used
+          map 'constituents', to: :constituents
+          map 'dosage', to: :dosage
+        end
+
+        class << self
+          def wire_key = 'tcm_crude_drug'
+          def harmonized_type = 'CrudeDrug'
+          def jsonld_type = 'HkcmmsTcmCrudeDrug'
+        end
+      end
+    end
+  end
+end

data/lib/openphar/models/hkcmms/tcm_formulation.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Openphar
+  module Models
+    module HKCMMS
+      # HKCMMS classical TCM formulation (方剂).
+      #
+      class TcmFormulation < Monograph
+        attribute :ingredients, :hash, collection: true, default: []
+        attribute :method_of_preparation, :string
+        attribute :dosage, :string
+        attribute :indications, :string, collection: true, default: []
+        attribute :contraindications, :string, collection: true, default: []
+
+        json do
+          map 'ingredients', to: :ingredients
+          map 'methodOfPreparation', to: :method_of_preparation
+          map 'dosage', to: :dosage
+          map 'indications', to: :indications
+          map 'contraindications', to: :contraindications
+        end
+
+        class << self
+          def wire_key = 'tcm_formulation'
+          def harmonized_type = 'Formulation'
+          def jsonld_type = 'HkcmmsTcmFormulation'
+        end
+      end
+    end
+  end
+end