ieee-idams 0.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ff847527e8adda475495e40f2f7152257d3684063b30cc0e41595856840a260e
+  data.tar.gz: 9cc43f1dc641bec279c0b5f56cd962b23d85be4651cc0b36221d4f3fd93a80bf
+SHA512:
+  metadata.gz: 01e83f160ca63bfc142f23ff0fce3c405e35493824ed2b310832e100f83339edd9fb5524c3e80b0a4127b8474ec7568fd6a731b76714c89a7eed68b61e8a3d1f
+  data.tar.gz: f873460146d9aadca68aab1c7bea5d204bfeff36f7ee5eb9b972e81a75a45ae07bca45340c458c5571742d3471522561fe205c2680773c564f4247a3977cfe6b

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,10 @@
+inherit_from: .rubocop_todo.yml
+
+AllCops:
+  TargetRubyVersion: 3.0
+
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes

data/.rubocop_todo.yml

@@ -0,0 +1,36 @@
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2024-11-13 07:13:09 UTC using RuboCop version 1.68.0.
+# The point is for the user to remove these configuration records
+# one by one as the offenses are removed from the code base.
+# Note that changes in the inspected code, or installation of new
+# versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: Severity, Include.
+# Include: **/*.gemspec
+Gemspec/RequiredRubyVersion:
+  Exclude:
+    - 'ieee-idams.gemspec'
+
+# Offense count: 2
+# Configuration parameters: CountComments, CountAsOne, AllowedMethods, AllowedPatterns.
+# AllowedMethods: refine
+Metrics/BlockLength:
+  Max: 32
+
+# Offense count: 1
+# Configuration parameters: ExpectMatchingDefinition, CheckDefinitionPathHierarchy, CheckDefinitionPathHierarchyRoots, Regex, IgnoreExecutableScripts, AllowedAcronyms.
+# CheckDefinitionPathHierarchyRoots: lib, spec, test, src
+# AllowedAcronyms: CLI, DSL, ACL, API, ASCII, CPU, CSS, DNS, EOF, GUID, HTML, HTTP, HTTPS, ID, IP, JSON, LHS, QPS, RAM, RHS, RPC, SLA, SMTP, SQL, SSH, TCP, TLS, TTL, UDP, UI, UID, UUID, URI, URL, UTF8, VM, XML, XMPP, XSRF, XSS
+Naming/FileName:
+  Exclude:
+    - 'Rakefile.rb'
+    - 'lib/ieee-idams.rb'
+
+# Offense count: 2
+# This cop supports safe autocorrection (--autocorrect).
+# Configuration parameters: AllowHeredoc, AllowURI, URISchemes, IgnoreCopDirectives, AllowedPatterns.
+# URISchemes: http, https
+Layout/LineLength:
+  Max: 252

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at ronald.tse@ribose.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/README.adoc

@@ -0,0 +1,30 @@
+= IEEE IDAMS Exchange Format in Ruby
+
+image:https://img.shields.io/gem/v/ieee-idams.svg["Gem Version", link="https://rubygems.org/gems/ieee-idams"]
+image:https://github.com/relaton/ieee-idams/workflows/rake/badge.svg["Build Status", link="https://github.com/relaton/ieee-idams/actions?workflow=rake"]
+image:https://codeclimate.com/github/relaton/ieee-idams/badges/gpa.svg["Code Climate", link="https://codeclimate.com/github/relaton/ieee-idams"]
+
+== Purpose
+
+This is a class-oriented Ruby library that parses IEEE IDAMS Exchange data.
+
+This gem is developed according to:
+
+* https://www.ieee.org/content/dam/ieee-org/ieee/web/org/pubs/ieee-books-xml-metadata-documentation.pdf[IEEE Publishing Technology Books Metadata Description and XML Documentation, Version 4.1, December 2022]
+
+== Usage
+
+=== Ruby API
+
+[source,ruby]
+----
+require 'ieee-idams'
+
+# Single record under `<publication>`
+Ieee::Idams::Publication.from_xml(File.read("spec/fixtures/record_1.xml"))
+----
+
+
+== License
+
+Copyright Ribose.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/ieee/idams/address.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a physical address
+    class Address < Lutaml::Model::Serializable
+      # Street address
+      # @return [String] street address line
+      attribute :street, :string
+
+      # City
+      # @return [String] city name
+      attribute :city, :string
+
+      # Country
+      # @return [String] country name
+      attribute :country, :string
+
+      # Post code
+      # @return [String] postal code
+      attribute :postcode, :string
+
+      xml do
+        root "address"
+        map_element "street", to: :street # , cdata: true
+        map_element "city", to: :city # , cdata: true
+        map_element "country", to: :country # , cdata: true
+        map_element "postcode", to: :postcode
+      end
+    end
+  end
+end

data/lib/ieee/idams/affiliation.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+require_relative "affiliation_address"
+
+module Ieee
+  module Idams
+    # Represents an institutional affiliation
+    class Affiliation < Lutaml::Model::Serializable
+      # AMS ID
+      # @return [Integer] author's AMS ID
+      attribute :amsid, :integer
+
+      # Organization name
+      # @return [String] institution name
+      attribute :orgname, :string
+
+      # Organization division
+      # @return [String] department or division
+      attribute :orgdiv, :string
+
+      # Address information
+      # @return [Address] institutional address
+      attribute :address, AffiliationAddress
+
+      xml do
+        root "affn"
+        map_element "amsid", to: :amsid
+        map_element "orgname", to: :orgname, cdata: true
+        map_element "orgdiv", to: :orgdiv
+        map_element "address", to: :address
+      end
+    end
+  end
+end

data/lib/ieee/idams/affiliation_address.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents a physical address
+    class AffiliationAddress < Lutaml::Model::Serializable
+      # Street address
+      # @return [String] street address line
+      attribute :street, :string
+
+      # City
+      # @return [String] city name
+      attribute :city, :string
+
+      # State
+      # @return [String] state name
+      attribute :state, :string
+
+      # Country
+      # @return [String] country name
+      attribute :country, :string
+
+      # Post code
+      # @return [String] postal code
+      attribute :postcode, :string
+
+      xml do
+        root "address"
+        map_element "street", to: :street, cdata: true
+        map_element "city", to: :city, cdata: true
+        map_element "state", to: :state, cdata: true
+        map_element "country", to: :country, cdata: true
+        map_element "postcode", to: :postcode
+      end
+    end
+  end
+end

data/lib/ieee/idams/affiliation_group.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative "affiliation"
+
+module Ieee
+  module Idams
+    # Represents a group of institutional affiliations
+    class AffiliationGroup < Lutaml::Model::Serializable
+      # List of affiliations
+      # @return [Array<Affiliation>] institutional affiliations
+      attribute :affn, Affiliation, collection: true
+
+      xml do
+        root "affgrp"
+        map_element "affn", to: :affn
+      end
+    end
+  end
+end

data/lib/ieee/idams/article.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require_relative "article_info"
+
+module Ieee
+  module Idams
+    # Represents an article within a volume
+    class Article < Lutaml::Model::Serializable
+      # Article title
+      # @return [String] full article title
+      attribute :title, :string
+
+      # Article information
+      # @return [ArticleInfo] detailed article metadata
+      attribute :articleinfo, ArticleInfo
+
+      xml do
+        root "article"
+        map_element "title", to: :title, cdata: true
+        map_element "articleinfo", to: :articleinfo
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_abstract.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Represents an article abstract
+    class ArticleAbstract < Lutaml::Model::Serializable
+      # Abstract type
+      # @return [String] type of abstract
+      attribute :abstract_type, :string
+
+      # Abstract value
+      # @return [String] abstract text
+      attribute :value, :string
+
+      xml do
+        root "abstract"
+        map_attribute "abstracttype", to: :abstract_type
+        map_content to: :value, cdata: true
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_copyright.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Article copyright information
+    class ArticleCopyright < Lutaml::Model::Serializable
+      # <articlecopyright holderisieee="Yes" year="0"/>
+
+      attribute :holder_is_ieee, :string
+      attribute :year, :integer
+
+      xml do
+        root "articlecopyright"
+
+        map_attribute "holderisieee", to: :holder_is_ieee
+        map_attribute "year", to: :year
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_date.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Article related date
+    class ArticleDate < Lutaml::Model::Serializable
+      # <date datetype="OriginalPub">
+      #   <year>1997</year>
+      #   <month>April</month>
+      #   <day>3</day>
+      # </date>
+      # <date datetype="ePub">
+      #   <year>2019</year>
+      #   <month>4</month>
+      #   <day>26</day>
+      # </date>
+
+      attribute :datetype, :string
+      attribute :year, :string
+      attribute :month, :string
+      attribute :day, :string
+
+      xml do
+        root "date"
+
+        map_attribute "datetype", to: :datetype
+        map_element "year", to: :year
+        map_element "month", to: :month
+        map_element "day", to: :day
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_filename.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Article file name
+    class ArticleFilename < Lutaml::Model::Serializable
+      # <filename docpartition="4" filetype="MainPDF">00000003.pdf</filename>
+
+      attribute :docpartition, :string
+      attribute :filetype, :string
+      attribute :filename, :string
+
+      xml do
+        root "filename"
+
+        map_attribute "docpartition", to: :docpartition
+        map_attribute "filetype", to: :filetype
+        map_content to: :filename
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_info.rb

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+require_relative "keyword_set"
+require_relative "multimedia"
+require_relative "author_group"
+require_relative "article_copyright"
+require_relative "article_date"
+require_relative "article_filename"
+require_relative "article_page_nums"
+require_relative "article_abstract"
+
+module Ieee
+  module Idams
+    # Contains detailed metadata about an article
+    class ArticleInfo < Lutaml::Model::Serializable
+      # Sequence number
+      # @return [Integer] article sequence number
+      attribute :articleseqnum, :integer
+
+      # Digital Object Identifier
+      # @return [String] DOI for the article
+      attribute :articledoi, :string
+
+      # System ID
+      # @return [String] IDAMS internal ID
+      attribute :idamsid, :string
+
+      # Article status
+      # @return [String] Active or Inactive
+      attribute :articlestatus, :string, values: %w[Active Inactive]
+
+      # Content type
+      # @return [String] type of content
+      attribute :content_type, :string
+
+      # Open access status
+      # @return [String] open access indicator
+      attribute :articleopenaccess, :string, values: %w[T F]
+
+      # Display flag
+      # @return [String] show/hide indicator
+      attribute :articleshowflag, :string, values: %w[T F]
+
+      # Article plagiarism flag
+      # @return [String] plagiarism indicator
+      attribute :articleplagiarizedflag, :string, values: %w[T F]
+
+      # Article no DOI flag
+      # @return [String] no DOI indicator
+      attribute :articlenodoiflag, :string, values: %w[T F]
+
+      # Article cover image flag
+      # @return [String] cover image indicator
+      attribute :articlecoverimageflag, :string, values: %w[T F]
+
+      # Article reference flag
+      # @return [String] reference indicator
+      attribute :articlereferenceflag, :string, values: %w[T F]
+
+      # Article peer review flag
+      # @return [String] peer review indicator
+      attribute :articlepeerreviewflag, :string, values: %w[T F]
+
+      # Hold status
+      # @return [String] Publish or Hold
+      attribute :holdstatus, :string, values: %w[Publish Hold]
+
+      # Article copyright
+      # @return [String] copyright statement
+      attribute :articlecopyright, ArticleCopyright
+
+      # Abstract
+      # @return [String] article abstract
+      attribute :abstract, ArticleAbstract
+
+      # Author information
+      # @return [AuthorGroup] article authors
+      attribute :authorgroup, AuthorGroup
+
+      # Standard scope
+      # @return [String] standard scope
+      attribute :articlestdscope, :string
+
+      # Standard purpose
+      # @return [String] standard purpose
+      attribute :articlestdpurpose, :string
+
+      # Dates
+      # @return [String] publication dates
+      attribute :date, ArticleDate, collection: true
+
+      # Article publication date
+      # @return [String] publication date
+      attribute :article_publication_date, :string
+
+      # Number of pages
+      # @return [Integer] page count
+      attribute :numpages, :integer
+
+      # File size in bytes
+      # @return [Integer] PDF file size
+      attribute :size, :integer
+
+      # PDF filename
+      # @return [String] name of PDF file
+      attribute :filename, ArticleFilename
+
+      # Page numbers
+      # @return [String] start and end page numbers
+      attribute :artpagenums, ArticlePageNums
+
+      # System ID
+      # @return [String] AMS internal ID
+      attribute :amsid, :string
+
+      # Multimedia
+      # @return [Multimedia] multimedia content
+      attribute :multimedia, Multimedia
+
+      # Keywords
+      # @return [Array<KeywordSet>] article keywords
+      attribute :keywordset, KeywordSet, collection: true
+
+      xml do
+        root "articleinfo"
+        map_element "articleseqnum", to: :articleseqnum
+        map_element "articledoi", to: :articledoi
+        map_element "idamsid", to: :idamsid
+        map_element "articlestatus", to: :articlestatus
+        map_element "contenttype", to: :content_type
+        map_element "articleopenaccess", to: :articleopenaccess
+        map_element "articleshowflag", to: :articleshowflag
+
+        map_element "articleopenaccess", to: :articleopenaccess
+        map_element "articleshowflag", to: :articleshowflag
+        map_element "articleplagiarizedflag", to: :articleplagiarizedflag
+        map_element "articlenodoiflag", to: :articlenodoiflag
+        map_element "articlecoverimageflag", to: :articlecoverimageflag
+        map_element "articlereferenceflag", to: :articlereferenceflag
+        map_element "articlepeerreviewflag", to: :articlepeerreviewflag
+
+        map_element "holdstatus", to: :holdstatus
+        map_element "articlecopyright", to: :articlecopyright
+        map_element "abstract", to: :abstract, cdata: true
+        map_element "articlestdscope", to: :articlestdscope, cdata: true
+        map_element "articlestdpurpose", to: :articlestdpurpose, cdata: true
+        map_element "authorgroup", to: :authorgroup
+        map_element "date", to: :date
+        map_element "article_publication_date", to: :article_publication_date
+        map_element "numpages", to: :numpages
+        map_element "size", to: :size
+        map_element "filename", to: :filename
+        map_element "artpagenums", to: :artpagenums
+        map_element "amsid", to: :amsid
+        map_element "multimedia", to: :multimedia
+        map_element "keywordset", to: :keywordset
+      end
+    end
+  end
+end

data/lib/ieee/idams/article_page_nums.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Ieee
+  module Idams
+    # Article page nums
+    class ArticlePageNums < Lutaml::Model::Serializable
+      # <artpagenums endpage="28" startpage="1">1-28</artpagenums>
+
+      attribute :endpage, :string
+      attribute :startpage, :string
+      attribute :formatted, :string
+
+      xml do
+        root "artpagenums"
+
+        map_attribute "endpage", to: :endpage
+        map_attribute "startpage", to: :startpage
+        map_content to: :formatted
+      end
+    end
+  end
+end