Contents

# frozen_string_literal: true

# Copyright (c) 2018-2022 The Ruby Citation File Format Developers.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#      http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

require_relative 'model_part'
require_relative 'schema'

##
module CFF
  # An Entity can represent different types of entities, e.g., a publishing
  # company, or conference. Like a Person, an Entity might have a number of
  # roles, such as author, contact, editor, etc.
  #
  # Entity implements all of the fields listed in the
  # [CFF standard](https://citation-file-format.github.io/). All fields
  # are simple strings and can be set as such. A field which has not been set
  # will return the empty string. The simple fields are (with defaults in
  # parentheses):
  #
  # * `address`
  # * `alias`
  # * `city`
  # * `country`
  # * `date_end` - *Note:* returns a `Date` object
  # * `date_start` - *Note:* returns a `Date` object
  # * `email`
  # * `fax`
  # * `location`
  # * `name`
  # * `orcid`
  # * `post_code`
  # * `region`
  # * `tel`
  # * `website`
  class Entity < ModelPart
    ALLOWED_FIELDS = SCHEMA_FILE['definitions']['entity']['properties'].keys.freeze # :nodoc:

    attr_date :date_end, :date_start

    # :call-seq:
    #   new(name) -> Entity
    #   new(name) { |entity| block } -> Entity
    #
    # Create a new Entity with the supplied name.
    def initialize(param)
      super()

      if param.is_a?(Hash)
        @fields = param
      else
        @fields = {}
        @fields['name'] = param
      end

      yield self if block_given?
    end
  end
end

Version data entries

5 entries across 5 versions & 1 rubygems

Version	Path
cff-1.3.0	lib/cff/entity.rb
cff-1.2.0	lib/cff/entity.rb
cff-1.1.0	lib/cff/entity.rb
cff-1.0.1	lib/cff/entity.rb
cff-1.0.0	lib/cff/entity.rb