class NameParameter

This class represents an entity name in Analytics API.

Constants

VALID_GENDERS

Attributes

entity_type [RW]

Name’s entity type (PERSON, LOCATION, ORGANIZATION) (optional)

gender [RW]

Name’s gender (male, female, nonbinary) (optional)

language [RW]

ISO 639-3 code of the name’s language (optional)

script [RW]

ISO 15924 code of the name’s script (optional)

text [RW]

Name to be analyzed

Public Instance Methods

load_param ()

Source

# File name_parameter.rb, line 46
def load_param
  to_hash
    .select { |_key, value| value }
    .transform_keys { |key| key.to_s.split('_').map(&:capitalize).join.sub!(/\D/, &:downcase) }
end

Converts this class to Hash with its keys in lower CamelCase.

Returns the new Hash.

to_hash ()

Source

# File name_parameter.rb, line 55
def to_hash
  {
    entity_type: @entity_type,
    language: @language,
    script: @script,
    gender: @gender,
    text: @text
  }
end

Converts this class to Hash.

Returns the new Hash.

validate_gender ()

Source

# File name_parameter.rb, line 34
def validate_gender
  return if @gender.nil?

  normalized = @gender.to_s.downcase
  return if VALID_GENDERS.include?(normalized)

  raise ArgumentError.new("gender must be one of: #{VALID_GENDERS.join(', ')}")
end

Protected Instance Methods

initialize (text, options = {})

Source

# File name_parameter.rb, line 18
def initialize(text, options = {}) # :notnew:
  options = {
    entity_type: nil,
    language: nil,
    script: nil,
    gender: nil
  }.update options
  @text = text
  @entity_type = options[:entity_type]
  @language = options[:language]
  @script = options[:script]
  @gender = options[:gender]

  validate_gender
end