ieee-idams 0.2.6

data/lib/ieee/idams/author.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: true
+
+require_relative "affiliation_group"
+
+module Ieee
+  module Idams
+    # Represents an individual author
+    class Author < Lutaml::Model::Serializable
+      # AMS ID
+      # @return [Integer] author's AMS ID
+      attribute :amsid, :integer
+
+      # Order of authorship
+      # @return [Integer] author's order in the list of authors
+      attribute :authororder, :integer
+
+      # Normalized author name
+      # @return [String] surname, initials format
+      attribute :normname, :string
+
+      # Non-normalized author name
+      # @return [String] original format name
+      attribute :nonnormname, :string
+
+      # First name
+      # @return [String] author's first name
+      attribute :firstname, :string
+
+      # Middle name
+      # @return [String] author's middle name/initial
+      attribute :othername, :string
+
+      # Last name
+      # @return [String] author's surname
+      attribute :surname, :string
+
+      # Affiliation
+      # @return [String] author's institutional affiliation
+      attribute :affiliation, :string
+
+      # Affiliation information
+      # @return [AffiliationGroup] author's institutional affiliations
+      attribute :affgrp, AffiliationGroup
+
+      # Author type/role
+      # @return [String] one of: author, editor
+      attribute :authortype, :string, values: %w[author editor]
+
+      xml do
+        root "author"
+        map_element "amsid", to: :amsid
+        map_element "authororder", to: :authororder
+        map_element "normname", to: :normname, cdata: true
+        map_element "nonnormname", to: :nonnormname, cdata: true
+        map_element "firstname", to: :firstname, cdata: true
+        map_element "othername", to: :othername, cdata: true
+        map_element "surname", to: :surname, cdata: true
+        map_element "affiliation", to: :affiliation, cdata: true
+        map_element "affgrp", to: :affgrp
+        map_element "authortype", to: :authortype
+      end
+    end
+  end
+end

data/lib/ieee/idams/author_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "author"
+
+module Ieee
+  module Idams
+    # Represents a group of authors
+    class AuthorGroup < Lutaml::Model::Serializable
+      # List of authors
+      # @return [Array<Author>] authors of the work
+      attribute :author, Author, collection: true
+
+      xml do
+        root "authorgroup"
+        map_element "author", to: :author
+      end
+    end
+  end
+end

data/lib/ieee/idams/conf_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Configuration Groiup
+    class ConfGroup < Lutaml::Model::Serializable
+      # <confgroup>
+      #   <doi_permission>F</doi_permission>
+      # </confgroup>
+
+      attribute :doi_permission, :string, collection: true
+
+      xml do
+        root "confgroup"
+        map_element "doi_permission", to: :doi_permission
+      end
+    end
+  end
+end

data/lib/ieee/idams/copyright.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "copyright"
+
+module Ieee
+  module Idams
+    # Represents a copyright entry
+    class Copyright < Lutaml::Model::Serializable
+      # Copyright year
+      # @return [Integer] year of copyright
+      attribute :year, :integer
+
+      # Copyright holder
+      # @return [String] name of copyright holder
+      attribute :holder, :string
+
+      xml do
+        root "copyright"
+        map_element "year", to: :year
+        map_element "holder", to: :holder
+      end
+    end
+  end
+end

data/lib/ieee/idams/copyright_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "copyright"
+
+module Ieee
+  module Idams
+    # Represents a group of copyright information
+    class CopyrightGroup < Lutaml::Model::Serializable
+      # Copyright entries
+      # @return [Array<Copyright>] copyright information
+      attribute :copyright, Copyright, collection: true
+
+      xml do
+        root "copyrightgroup"
+        map_element "copyright", to: :copyright
+      end
+    end
+  end
+end

data/lib/ieee/idams/ics_code_term.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # ICS code with term
+    class IcsCodeTerm < Lutaml::Model::Serializable
+      attribute :codenum, :string
+      attribute :name, :string
+
+      xml do
+        root "code_term"
+        map_attribute "codenum", to: :codenum
+        map_content to: :name
+      end
+    end
+  end
+end

data/lib/ieee/idams/ics_codes.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+require_relative "ics_code_term"
+
+module Ieee
+  module Idams
+    # ICS Codes
+    class IcsCodes < Lutaml::Model::Serializable
+      attribute :code_term, IcsCodeTerm, collection: true
+
+      xml do
+        root "icscodes"
+        map_element "code_term", to: :code_term
+      end
+    end
+  end
+end

data/lib/ieee/idams/isbn.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents an ISBN identifier for a book
+    class Isbn < Lutaml::Model::Serializable
+      # ISBN number
+      # @return [String] 13 or 10 digit ISBN, max 15 chars
+      attribute :content, :string
+
+      # File type for this ISBN
+      # @return [String] one of: paperback, hardcover, ePub, PDF
+      attribute :isbnfiletype, :string, values: %w[paperback hardcover ePub PDF]
+
+      # ISBN type specification
+      # @return [String] one of: New-2005, Historical
+      attribute :isbntype, :string, values: %w[New-2005 Historical]
+
+      # Media type
+      # @return [String] one of: Paper, CD, Online, Electronic
+      attribute :mediatype, :string, values: %w[Paper CD Online Electronic]
+
+      xml do
+        root "isbn"
+        map_content to: :content
+        map_attribute "isbnfiletype", to: :isbnfiletype
+        map_attribute "isbntype", to: :isbntype
+        map_attribute "mediatype", to: :mediatype
+      end
+    end
+  end
+end

data/lib/ieee/idams/keyword.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a keyword
+    class Keyword < Lutaml::Model::Serializable
+      # Keyword term
+      # @return [String] keyword text
+      attribute :keywordterm, :string
+      attribute :keywordmodifier, :string
+
+      xml do
+        root "keyword"
+        map_element "keywordterm", to: :keywordterm, cdata: true
+        map_element "keywordmodifier", to: :keywordmodifier
+      end
+    end
+  end
+end

data/lib/ieee/idams/keyword_set.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "keyword"
+
+module Ieee
+  module Idams
+    # Represents a set of keywords
+    class KeywordSet < Lutaml::Model::Serializable
+      # Keyword type
+      # @return [String] type of keywords
+      attribute :keywordtype, :string
+
+      # List of keywords
+      # @return [Array<Keyword>] keywords
+      attribute :keyword, Keyword, collection: true
+
+      xml do
+        root "keywordset"
+        map_attribute "keywordtype", to: :keywordtype
+        map_element "keyword", to: :keyword
+      end
+    end
+  end
+end

data/lib/ieee/idams/multimedia.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "multimedia_compressed"
+require_relative "multimedia_component"
+
+module Ieee
+  module Idams
+    # Multimedia
+    class Multimedia < Lutaml::Model::Serializable
+      # <multimedia>
+      #   <summary>The IEEE 1584 calculators can be accessed via the auxiliary files (5), ¿IEEE_1584_Bolted_Fault_Cal.xls¿ and
+      # ¿IEEE_1584_Arc_Flash_Hazard.xls¿, and test data can be accessed via the auxiliary files, ¿Data_set.xls¿,
+      # ¿Test_results_database.xls¿, and ¿CL_Fuse_test_data.xls¿ provided for use with IEEE 1584-2002.</summary>
+      #   <compressed>
+      #     <compressedfilename>IEEE1584-2002_AncillaryFiles.zip</compressedfilename>
+      #     <compressedfilesize>180</compressedfilesize>
+      #     <compressiontype>ZIP</compressiontype>
+      #     <environmenttype>Windows</environmenttype>
+      #     <readmefile>IEEE1584-2002_AncillaryFiles.readme.txt</readmefile>
+      #   </compressed>
+      #   <component>
+      #     <componentfilename/>
+      #     <componentfilesize/>
+      #     <componenttype/>
+      #     <componentplatform/>
+      #     <componentdoi/>
+      #   </component>
+      # </multimedia>
+
+      attribute :summary, :string
+      attribute :compressed, MultimediaCompressed
+      attribute :component, MultimediaComponent
+
+      xml do
+        root "multimedia"
+
+        map_element "summary", to: :summary
+        map_element "compressed", to: :compressed
+        map_element "component", to: :component
+      end
+    end
+  end
+end

data/lib/ieee/idams/multimedia_component.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Multimedia component
+    class MultimediaComponent < Lutaml::Model::Serializable
+      #   <component>
+      #     <componentfilename/>
+      #     <componentfilesize/>
+      #     <componenttype/>
+      #     <componentplatform/>
+      #     <componentdoi/>
+      #   </component>
+
+      attribute :filename, :string
+      attribute :filesize, :string
+      attribute :type, :string
+      attribute :platform, :string
+      attribute :doi, :string
+
+      xml do
+        root "component"
+
+        map_element "componentfilename", to: :filename, render_nil: true
+        map_element "componentfilesize", to: :filesize, render_nil: true
+        map_element "componenttype", to: :type, render_nil: true
+        map_element "componentplatform", to: :platform, render_nil: true
+        map_element "componentdoi", to: :doi, render_nil: true
+      end
+    end
+  end
+end

data/lib/ieee/idams/multimedia_compressed.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Multimedia compressed
+    class MultimediaCompressed < Lutaml::Model::Serializable
+      #   <compressed>
+      #     <compressedfilename>IEEE1584-2002_AncillaryFiles.zip</compressedfilename>
+      #     <compressedfilesize>180</compressedfilesize>
+      #     <compressiontype>ZIP</compressiontype>
+      #     <environmenttype>Windows</environmenttype>
+      #     <readmefile>IEEE1584-2002_AncillaryFiles.readme.txt</readmefile>
+      #   </compressed>
+
+      attribute :filename, :string
+      attribute :filesize, :string
+      attribute :compression_type, :string
+      attribute :environment_type, :string
+      attribute :readme_file, :string
+
+      xml do
+        root "compressed"
+
+        map_element "compressedfilename", to: :filename
+        map_element "compressedfilesize", to: :filesize
+        map_element "compressiontype", to: :compression_type
+        map_element "environmenttype", to: :environment_type
+        map_element "readmefile", to: :readme_file
+      end
+    end
+  end
+end

data/lib/ieee/idams/package_member_set.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a set of package members
+    class PackageMemberSet < Lutaml::Model::Serializable
+      attribute :package_member, :string, collection: true
+
+      xml do
+        root "packagememberset"
+        map_element "packagemember", to: :package_member
+      end
+    end
+  end
+end

data/lib/ieee/idams/product_number.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Product number
+    class ProductNumber < Lutaml::Model::Serializable
+      # <productnumber pubtype="Online">STDWD94477</productnumber>
+
+      attribute :pubtype, :string
+      attribute :value, :string
+
+      xml do
+        root "productnumber"
+        map_attribute "pubtype", to: :pubtype
+        map_content to: :value
+      end
+    end
+  end
+end

data/lib/ieee/idams/pub_sponsor.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Contains volume metadata
+    class PubSponsor < Lutaml::Model::Serializable
+      # IEEE Society that sponsors the publication
+      # @return [String] Society name that sponsors the publication
+      attribute :society, :string, collection: true
+
+      xml do
+        root "pubsponsor"
+        map_element "society", to: :society
+      end
+    end
+  end
+end

data/lib/ieee/idams/pub_sponsoring_committee_set.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a set of sponsoring committees
+    class PubSponsoringCommitteeSet < Lutaml::Model::Serializable
+      # List of committees
+      # @return [Array<String>] sponsoring committees
+      attribute :pubsponsoringcommittee, :string, collection: true
+
+      xml do
+        root "pubsponsoringcommitteeset"
+        map_element "pubsponsoringcommittee", to: :pubsponsoringcommittee, cdata: true
+      end
+    end
+  end
+end

data/lib/ieee/idams/pub_topical_browse_set.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a set of topical browse categories
+    class PubTopicalBrowseSet < Lutaml::Model::Serializable
+      # List of topical browse categories
+      VALID_CATEGORIES = [
+        "Aerospace",
+        "Bioengineering",
+        "Communication, Networking, and Broadcast Technologies",
+        "Components, Circuits, Devices and Systems",
+        "Computing and Processing",
+        "Engineered Materials, Dielectrics and Plasmas",
+        "Engineering Profession",
+        "Fields, Waves and Electromagnetics",
+        "General Topics for Engineers",
+        "Geoscience",
+        "Nuclear Engineering",
+        "Photonics and Electrooptics",
+        "Power, Industry and Industry Applications",
+        "Robotics and Control Systems",
+        "Signal Processing and Analysis",
+        "Transportation"
+      ].freeze
+
+      # List of topical categories
+      # @return [Array<String>] subject classifications
+      attribute :pubtopicalbrowse, :string, collection: true,
+                                            values: VALID_CATEGORIES
+
+      xml do
+        root "pubtopicalbrowseset"
+        map_element "pubtopicalbrowse", to: :pubtopicalbrowse
+      end
+
+      # def validate
+      #   errors = super
+      #   pubtopicalbrowse.each do |category|
+      #     unless VALID_CATEGORIES.include?(category)
+      #       errors << "Invalid topical browse category: #{category}"
+      #     end
+      #   end
+      #   errors
+      # end
+    end
+  end
+end

data/lib/ieee/idams/publication.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+require_relative "publication_info"
+require_relative "volume"
+
+module Ieee
+  module Idams
+    # Represents an IEEE IDAMS publication record
+    class Publication < Lutaml::Model::Serializable
+      # Publication title
+      # @return [String] normalized title
+      attribute :title, :string
+
+      # Publication normalized title
+      # @return [String] normalized title
+      attribute :normtitle, :string
+
+      # Standards family title
+      # @return [String] family title for standards
+      attribute :standardsfamilytitle, :string
+
+      # Publication information
+      # @return [PublicationInfo] detailed publication metadata
+      attribute :publicationinfo, PublicationInfo
+
+      # Volume information
+      # @return [Volume] volume details
+      attribute :volume, Volume
+
+      xml do
+        root "publication"
+        map_element "title", to: :title, cdata: true
+        map_element "normtitle", to: :normtitle, cdata: true
+        map_element "standardsfamilytitle", to: :standardsfamilytitle
+        map_element "publicationinfo", to: :publicationinfo
+        map_element "volume", to: :volume
+      end
+    end
+  end
+end

data/lib/ieee/idams/publication_acronym.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Publication ID acronym
+    class PublicationAcronym < Lutaml::Model::Serializable
+      # Type of acronym
+      # @return [String]
+      attribute :type, :string
+
+      # Acronym value
+      # @return [String]
+      attribute :value, :string
+
+      xml do
+        root "acronym"
+        map_attribute "acronymtype", to: :type
+        map_content to: :value
+      end
+    end
+  end
+end