human_languages 0.5.0

data/lib/languages/constants.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Languages
+  TYPES = %w[ancient constructed extinct historical living special].freeze
+  SCOPES = %w[individual macrolanguage special].freeze
+end

data/lib/languages/language.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Languages
+  # Language defined in ISO 639-3
+  class Language
+    include Comparable
+
+    attr_reader :iso639_1, :iso639_2b, :iso639_2t, :iso639_3, :scope, :type, :name # , :comment
+
+    def initialize(csv_attributes) # rubocop:disable Metrics/AbcSize
+      @iso639_3 = csv_attributes.fetch(:id).to_sym
+      @iso639_2b = csv_attributes.fetch(:part2b)&.to_sym
+      @iso639_2t = csv_attributes.fetch(:part2t)&.to_sym
+      @iso639_1 = csv_attributes.fetch(:part1)&.to_sym
+      @scope = SCOPES.detect { |s| s.chr.upcase == csv_attributes.fetch(:scope) }
+      @type = TYPES.detect { |t| t.chr.upcase == csv_attributes.fetch(:language_type) }
+      @name = csv_attributes.fetch(:ref_name)
+      # @comment = csv_attributes.fetch(:comment)
+    end
+
+    alias iso639_2 iso639_2t
+    alias iso639_5 iso639_2
+
+    alias alpha2 iso639_1
+    alias alpha3 iso639_3
+    alias alpha3_bibliographic iso639_2b
+    alias alpha3_terminology iso639_2t
+
+    def to_s
+      name.to_s # Enforce return of String, even if name is nil
+    end
+
+    TYPES.each do |type|
+      define_method "#{type}?" do
+        self.type == type
+      end
+    end
+
+    SCOPES.each do |scope|
+      # prevent ambiguity of scope "special" and type "special"
+      method_name = scope.end_with?('language') ? scope : "#{scope}_language"
+
+      define_method "#{method_name}?" do
+        self.scope == scope
+      end
+    end
+
+    def ==(other)
+      other.class == self.class && other.iso639_3 == iso639_3
+    end
+
+    alias eql? ==
+
+    def hash
+      iso639_3.hash
+    end
+
+    def <=>(other)
+      other.iso639_3 <=> iso639_3
+    end
+  end
+end

data/lib/languages/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Languages
+  VERSION = '0.5.0'
+end

data/lib/languages.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'csv'
+
+require_relative 'languages/version'
+require_relative 'languages/constants'
+require_relative 'languages/language'
+
+# Provides living, extinct, ancient, historic, and constructed languages, specified in ISO 639-3
+module Languages
+  @@data = CSV.read(File.join(File.dirname(__FILE__), '../data/iso-639-3.tsv'), headers: true, col_sep: "\t") # rubocop:disable Style/ClassVars
+              .map { |row| row.to_h.transform_keys { |k| k.downcase.to_sym } }
+              .map { |h| Language.new(h) }
+              .freeze
+
+  class << self
+    TYPES.each do |type|
+      define_method type do
+        @@data.select { |l| l.public_send("#{type}?") }
+      end
+    end
+
+    SCOPES.each do |scope|
+      # prevent ambiguity of scope "special" and type "special"
+      scope = "#{scope}_language" unless scope.end_with? 'language'
+
+      define_method "#{scope}s" do
+        @@data.select { |l| l.public_send("#{scope}?") }
+      end
+    end
+
+    def [](key)
+      key = key.to_s.downcase
+      case key.size
+      when 3 then get_by_alpha3(key.to_sym)
+      when 2 then get_by_alpha2(key.to_sym)
+      else get_by_name(key)
+      end
+    end
+
+    def search(pattern)
+      @@data.select { |l| l.name.match? pattern }
+    end
+
+    # Returns all human known languages, specified in ISO 639-3
+    def all
+      @@data
+    end
+
+    def names
+      @@data.map(&:name)
+    end
+
+    def alpha2_codes
+      @@data.map(&:alpha2).compact
+    end
+
+    def alpha3_codes
+      @@data.map(&:alpha3)
+    end
+
+    private
+
+    # Returns language associated with ISO 639-1 identifier
+    # @param [Symbol] key ISO 639-1 identifier
+    # @return [Language,NilClass] language with associated with the identifier; otherwise +nil+
+    def get_by_alpha2(key)
+      @@data.detect { |l| l.iso639_1 == key }
+    end
+
+    # Returns language associated with ISO 639-2 or ISO 639-3 identifier
+    # @param [Symbol] key ISO 639-2 or ISO 639-3 identifier
+    # @return [Language,NilClass] language with associated with the identifier; otherwise +nil+
+    def get_by_alpha3(key)
+      @@data.detect { |l| l.iso639_3 == key || l.iso639_2b == key || l.iso639_2t == key }
+    end
+
+    # Returns language associated with ISO 639-3 reference name
+    # @param [String] name reference name (english)
+    # @return [Language,NilClass] language with associated with the name; otherwise +nil+
+    def get_by_name(name)
+      @@data.detect { |l| l.name.downcase == name.downcase }
+    end
+  end
+end

data/sig/languages.rbs

@@ -0,0 +1,67 @@
+module Languages
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+
+  TYPES: Array[String]
+  SCOPES: Array[String]
+
+  @@data: Array[Language]
+
+  def self?.[]: (String | Symbol) -> Language?
+  def self?.search: (String|Regexp) -> Array[Language]
+
+  def self?.all: () -> Array[Language]
+  def self?.names: () -> Array[String]
+  def self?.alpha2_codes: () -> Array[Symbol]
+  def self?.alpha3_codes: () -> Array[Symbol]
+
+  def self?.special_languages: () -> Array[Language]
+  def self?.macrolanguages:() -> Array[Language]
+  def self?.individual_languages: () -> Array[Language]
+
+  def self?.ancient: () -> Array[Language]
+  def self?.constructed: () -> Array[Language]
+  def self?.extinct: () -> Array[Language]
+  def self?.historical: () -> Array[Language]
+  def self?.living: () -> Array[Language]
+  def self?.special: () -> Array[Language]
+
+  class Language
+    attr_reader iso639_1: Symbol?
+    attr_reader iso639_2b: Symbol?
+    attr_reader iso639_2t: Symbol?
+    attr_reader iso639_3: Symbol
+    attr_reader scope: String
+    attr_reader type: String
+    attr_reader name: String
+
+    alias iso639_2 iso639_2t
+    alias iso639_5 iso639_2
+
+    alias alpha2 iso639_1
+    alias alpha3 iso639_3
+    alias alpha3_bibliographic iso639_2b
+    alias alpha3_terminology iso639_2t
+
+
+    def initialize: ({id: String, part2b: String?, part2t: String?, part1: String?, scope: "I" | "M" | "S", language_type: "A" | "C" | "E" | "H" | "L" | "S", ref_name: String, comment: String?}) -> void
+
+    def to_s: () -> String
+
+    def special_language?: () -> bool
+    def macrolanguage? :() -> bool
+    def individual_language?: () -> bool
+
+    def ancient?: () -> bool
+    def constructed?: () -> bool
+    def extinct?: () -> bool
+    def historical?: () -> bool
+    def living?: () -> bool
+    def special?: () -> bool
+
+    def ==: (untyped) -> bool
+    alias eql? ==
+    def hash: () -> Integer
+    def <=>: (Language) -> Integer
+  end
+end

metadata

@@ -0,0 +1,63 @@
+--- !ruby/object:Gem::Specification
+name: human_languages
+version: !ruby/object:Gem::Version
+  version: 0.5.0
+platform: ruby
+authors:
+- Benno Bielmeier
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-06-06 00:00:00.000000000 Z
+dependencies: []
+description: ISO 639-3 is a set of codes that defines three-letter identifiers for
+  all known human languages.
+email:
+- git@bbenno.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".reuse/dep5"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- Gemfile.lock
+- LICENSES/LicenseRef-ISO639-3ToU.txt
+- LICENSES/MIT.txt
+- README.adoc
+- Rakefile
+- data/iso-639-3.tsv
+- lib/languages.rb
+- lib/languages/constants.rb
+- lib/languages/language.rb
+- lib/languages/version.rb
+- sig/languages.rbs
+homepage: https://github.com/bbenno/languages
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/bbenno/languages
+  source_code_uri: https://github.com/bbenno/languages
+  changelog_uri: https://github.com/bbenno/languages/blob/HEAD/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.7
+signing_key:
+specification_version: 4
+summary: ISO 639-3 languages
+test_files: []