recordcdsconfpaper.py

""" store_tools.recordcdsconfpaper

"""
from .base import REG_CONF, REG_YEAR
from plugin_dbui import CLEAN_SPACES
from store_tools.recordcdspubli import RecordCdsPubli


class RecordCdsConfPaper(RecordCdsPubli):
    """The record describing a conference talk or a proceeding.
    Additional field describing the conference data are:

        +----------------+-----------------------------------------------+
        | field          | subfield                                      |
        +================+===============================================+
        | meeting_name   | closing_date, coference_code, country, date,  |
        |                | location, opening_date, year                  |
        +----------------+-----------------------------------------------+

    One field is added by limbra:

        +----------------+-----------------------------------------------+
        | field (limbra) | subfield                                      |
        +================+===============================================+
        | meeting_note   | recid, url                                    |
        +----------------+-----------------------------------------------+

    """

    def conference_country(self):
        """The country where the conference took place.

        Returns:
            str:
                the filter *CLEAN_SPACES* is applied.
                The string is empty when the country is not defined.

        """
        # NOTE:
        #  * country is extract from the location since it is defined
        #    for both cds and inspire store
        #
        #  * The subfield country contains the country code (IT? FR, ..).
        #    It is only defined for cds
        #
        location = self.conference_location()

        if len(location) == 0:
            return ""

        return CLEAN_SPACES(location.split(",")[-1])

    def conference_dates(self):
        """The dates of the conference.

        Returns:
            str:
                the usual pattern is ``6-5 March 2012`` but it can varies
                between records and between stores since it is not
                standardise.

        """
        # for list assume that the first item is the correct one
        val = self._get("meeting_name", "date")
        val = (val[0] if isinstance(val, list) and len(val) > 0 else val)
        return val

    def conference_id(self):
        """The conference identifier used in the store.

        Returns:
            int or None

        """
        if "meeting_note" not in self:
            return None

        return self["meeting_note"].get("recid")

    def conference_key(self):
        """The conference key used in the store.

        Returns:
            str:
                empty string when not defined

        """
        # algorithm depends on the store
        # CDS
        if "aleph_linking_page" in self:
            value = self["aleph_linking_page"]["up_link"]

        # INSPIRE
        elif "publication_info" in self:
            df = self["publication_info"]
            cnums = df[df.cnum.str.match(REG_CONF.pattern) == True].cnum

            if len(cnums) == 1:
                value = cnums.iloc[0]

        else:
            value = ""

        return value

    def conference_location(self):
        """The conference location.

        Returns:
            str:
                - the pattern is ``town, country``
                - empty string when more than one location found
                - empty string when not defined

        """
        location = self._get("meeting_name", "location", force_list=True)
        location = (location[0] if len(location) == 1 else "")

        return CLEAN_SPACES(location)

    def conference_title(self):
        """The title of the conference.

        Returns:
            str:

        """
        # for list assume that the first item is the correct one
        value = self._get("meeting_name", "meeting")
        value = (value[0] if isinstance(value, list) else value)
        return CLEAN_SPACES(value)

    def conference_town(self):
        """The town where the conference took place.

        Returns:
            str:
                empty string when it is not defined.

        """
        location = self.conference_location()

        if len(location) == 0:
            return ""

        return CLEAN_SPACES(location.split(",")[0])

    def conference_url(self):
        """The URL of the conference home page.

        Returns:
            str:
                select arbitrarily the first URL when severals
                are founded. The string is empty string when the URL
                is not defined.

        """
        if "meeting_note" not in self:
            return ""

        return self["meeting_note"].get("url", "")

    def conference_year(self):
        """The year of the conference.

        Returns:
            str:
                empty string when it is not defined.

        """
        # from the conference dates
        match = REG_YEAR.search(self.conference_dates())
        if match:
            return match.group(1)

        return ""