tp-language_list 1.3.0

data/language_list.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "language_list/version"
+
+Gem::Specification.new do |s|
+  s.name        = "tp-language_list"
+  s.version     = LanguageList::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Steve Smith"]
+  s.email       = ["gems@dynedge.co.uk"]
+  s.homepage    = "https://github.com/dabroz/language_list"
+  s.summary     = %q{A list of languages and methods to find and work with these languages.}
+  s.description = %q{A list of languages based upon ISO-639-1 and ISO-639-3 with functions to retrieve only common languages.}
+
+  s.rubyforge_project = "language_list"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+  s.add_development_dependency 'minitest', '> 5.0.0'
+  s.add_development_dependency 'rake'
+end

data/lib/language_list/version.rb

@@ -0,0 +1,3 @@
+module LanguageList
+  VERSION = "1.3.0"
+end

data/lib/language_list.rb

@@ -0,0 +1,107 @@
+require 'yaml'
+
+module LanguageList
+  class LanguageInfo
+    attr_reader :name, :iso_639_3, :iso_639_1, :iso_639_2b, :iso_639_2t, :type
+
+    def initialize(options)
+      @name = options[:name]
+      @common_name = options[:common_name]
+      @iso_639_3 = options[:iso_639_3]
+      @iso_639_1 = options[:iso_639_1]
+      @iso_639_2b = options[:iso_639_2b]
+      @iso_639_2t = options[:iso_639_2t]
+      @common = options[:common]
+      @type = options[:type]
+    end
+
+    def common_name
+      @common_name || @name
+    end
+
+    def common?
+      @common
+    end
+
+    def <=>(other)
+      self.name <=> other.name
+    end
+
+    def iso_639_1?
+      !@iso_639_1.nil?
+    end
+
+    [:ancient, :constructed, :extinct, :historical, :living, :special].each do |type|
+      define_method("#{type.to_s}?") do
+        @type == type
+      end
+    end
+
+    def to_s
+      "#{@iso_639_3}#{" (#{@iso_639_1})" if @iso_639_1} - #{@name}"
+    end
+
+    def self.find_by_iso_639_1(code)
+      LanguageList::BY_ISO_639_1[code]
+    end
+
+    def self.find_by_iso_639_3(code)
+      LanguageList::BY_ISO_639_3[code]
+    end
+
+    def self.find_by_iso_639_2b(code)
+      LanguageList::BY_ISO_639_2B[code]
+    end
+
+    def self.find_by_iso_639_2t(code)
+      LanguageList::BY_ISO_639_2T[code]
+    end
+
+    def self.find_by_name(name)
+      return if name.nil?
+      
+      LanguageList::BY_NAME[name.downcase]
+    end
+
+    def self.find(code)
+      return if code.nil?
+      
+      code = code.downcase
+      find_by_iso_639_1(code) ||
+        find_by_iso_639_3(code) ||
+        find_by_iso_639_2b(code) ||
+        find_by_iso_639_2t(code) ||
+        find_by_name(code)
+    end
+  end
+
+  ALL_LANGUAGES = begin
+     Marshal.load(File.read(File.expand_path('../../data/dump', __FILE__)))
+  rescue => e
+    warn "Reverting to hash load: #{e.message}"
+    yaml_data = YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__),'..', 'data', 'languages.yml')))
+    yaml_data.map{|e| LanguageInfo.new(e) }
+  end.freeze
+  ISO_639_1 = ALL_LANGUAGES.select(&:iso_639_1?).freeze
+  LIVING_LANGUAGES = ALL_LANGUAGES.select(&:living?).freeze
+  COMMON_LANGUAGES = ALL_LANGUAGES.select(&:common?).freeze
+
+  BY_NAME      = {}
+  BY_ISO_639_1 = {}
+  BY_ISO_639_3 = {}
+  BY_ISO_639_2B = {}
+  BY_ISO_639_2T = {}
+  ALL_LANGUAGES.each do |lang|
+    BY_NAME[lang.name.downcase] = lang
+    BY_NAME[lang.common_name.downcase] = lang if lang.common_name
+    BY_ISO_639_1[lang.iso_639_1] = lang if lang.iso_639_1
+    BY_ISO_639_3[lang.iso_639_3] = lang if lang.iso_639_3
+    BY_ISO_639_2B[lang.iso_639_2b] = lang if lang.iso_639_2b
+    BY_ISO_639_2T[lang.iso_639_2t] = lang if lang.iso_639_2t
+  end
+  BY_NAME.freeze
+  BY_ISO_639_1.freeze
+  BY_ISO_639_3.freeze
+  BY_ISO_639_2B.freeze
+  BY_ISO_639_2T.freeze
+end

data/test/benchmark.rb

@@ -0,0 +1,9 @@
+#!/usr/bin/env ruby
+
+require "benchmark"
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+
+time = Benchmark.measure do
+  require 'language_list'
+end
+puts time

data/test/benchmark_lookup.rb

@@ -0,0 +1,20 @@
+#!/usr/bin/env ruby
+
+require "benchmark"
+$:.unshift(File.expand_path(File.join(File.dirname(__FILE__), '..', 'lib')))
+require 'language_list'
+
+
+count = LanguageList::ALL_LANGUAGES.count
+
+time = Benchmark.measure do
+   
+
+   1000.times do 
+   	target = LanguageList::ALL_LANGUAGES[rand(count)]
+
+    LanguageList::LanguageInfo.find_by_name(target.name)
+    LanguageList::LanguageInfo.find(target.iso_639_3)
+   end
+end
+puts time

data/test/language_list_test.rb

@@ -0,0 +1,257 @@
+require 'minitest/autorun'
+require 'language_list'
+
+class LanguageListTest < Minitest::Test
+  def test_all_languages
+    assert_equal 7707, LanguageList::ALL_LANGUAGES.length
+  end
+
+  def test_common_languages
+    assert_equal 71, LanguageList::COMMON_LANGUAGES.length
+  end
+
+  def test_living_languages
+    assert_equal 6986, LanguageList::LIVING_LANGUAGES.length
+  end
+
+  def test_iso_iso_639_1_languages
+    assert_equal 184, LanguageList::ISO_639_1.length
+  end
+
+  def test_find_by_iso_639_1
+    english = LanguageList::LanguageInfo.find_by_iso_639_1('en')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_iso_639_1_with_nil
+    result = LanguageList::LanguageInfo.find_by_iso_639_1(nil)
+    assert_equal nil, result
+  end
+
+  def test_find_by_iso_639_1_with_empty_string
+    result = LanguageList::LanguageInfo.find_by_iso_639_1('')
+    assert_equal nil, result
+  end
+
+  def test_find_by_iso_639_1_with_frozen_string
+    english = LanguageList::LanguageInfo.find_by_iso_639_1('en'.freeze)
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_iso_639_3
+    english = LanguageList::LanguageInfo.find_by_iso_639_3('eng')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_iso_639_3_with_nil
+    result = LanguageList::LanguageInfo.find_by_iso_639_3(nil)
+    assert_equal nil, result
+  end
+
+  def test_find_by_iso_639_3_with_empty_string
+    result = LanguageList::LanguageInfo.find_by_iso_639_3('')
+    assert_equal nil, result
+  end
+
+  def test_find_by_iso_639_3_with_frozen_string
+    english = LanguageList::LanguageInfo.find_by_iso_639_3('eng'.freeze)
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_name_with_nil
+    result = LanguageList::LanguageInfo.find_by_name(nil)
+    assert_equal nil, result
+  end
+
+  def test_find_by_name_with_empty_string
+    result = LanguageList::LanguageInfo.find_by_name('')
+    assert_equal nil, result
+  end
+
+  def test_find_by_name_with_frozen_string
+    english = LanguageList::LanguageInfo.find_by_name('English'.freeze)
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'eng', english.iso_639_2b
+    assert_equal 'eng', english.iso_639_2t
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_name
+    english = LanguageList::LanguageInfo.find_by_name('English')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'eng', english.iso_639_2b
+    assert_equal 'eng', english.iso_639_2t
+    assert_equal 'English', english.name
+  end
+
+  def test_find_by_common_name
+    greek = LanguageList::LanguageInfo.find_by_name('greek')
+    assert_equal 'el', greek.iso_639_1
+    assert_equal 'ell', greek.iso_639_3
+    assert_equal 'gre', greek.iso_639_2b
+    assert_equal 'ell', greek.iso_639_2t
+    assert_equal 'Greek', greek.common_name
+  end
+
+  def test_case_insensitive_find_by_name
+    english = LanguageList::LanguageInfo.find_by_name('english')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_with_nil
+    result = LanguageList::LanguageInfo.find(nil)
+    assert_equal nil, result
+  end
+
+  def test_find_with_empty_string
+    result = LanguageList::LanguageInfo.find('')
+    assert_equal nil, result
+  end
+
+  def test_find_with_frozen_string
+    english = LanguageList::LanguageInfo.find('EN'.freeze)
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_with_iso_639_1_code
+    english = LanguageList::LanguageInfo.find('en')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_case_insensitive_find_with_iso_639_1_code
+    english = LanguageList::LanguageInfo.find('EN')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_with_iso_639_2b_code
+    macedonian = LanguageList::LanguageInfo.find('mac')
+    assert_equal 'mk', macedonian.iso_639_1
+    assert_equal 'mac', macedonian.iso_639_2b
+    assert_equal 'mkd', macedonian.iso_639_2t
+    assert_equal 'mkd', macedonian.iso_639_3
+    assert_equal 'Macedonian', macedonian.name
+  end
+
+  def test_case_insensitive_find_with_iso_639_2b_code
+    macedonian = LanguageList::LanguageInfo.find('MAC')
+    assert_equal 'mk', macedonian.iso_639_1
+    assert_equal 'mac', macedonian.iso_639_2b
+    assert_equal 'mkd', macedonian.iso_639_2t
+    assert_equal 'mkd', macedonian.iso_639_3
+    assert_equal 'Macedonian', macedonian.name
+  end
+
+  def test_find_with_iso_639_2t_code
+    macedonian = LanguageList::LanguageInfo.find('mkd')
+    assert_equal 'mk', macedonian.iso_639_1
+    assert_equal 'mac', macedonian.iso_639_2b
+    assert_equal 'mkd', macedonian.iso_639_2t
+    assert_equal 'mkd', macedonian.iso_639_3
+    assert_equal 'Macedonian', macedonian.name
+  end
+
+  def test_case_insensitive_find_with_iso_639_2t_code
+    macedonian = LanguageList::LanguageInfo.find('MKD')
+    assert_equal 'mk', macedonian.iso_639_1
+    assert_equal 'mac', macedonian.iso_639_2b
+    assert_equal 'mkd', macedonian.iso_639_2t
+    assert_equal 'mkd', macedonian.iso_639_3
+    assert_equal 'Macedonian', macedonian.name
+  end
+
+  def test_find_with_iso_639_3_code
+    english = LanguageList::LanguageInfo.find('eng')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_case_insensitive_find_with_iso_639_3_code
+    english = LanguageList::LanguageInfo.find('Eng')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'English', english.name
+  end
+
+  def test_find_with_name
+    english = LanguageList::LanguageInfo.find('English')
+    assert_equal 'en', english.iso_639_1
+    assert_equal 'eng', english.iso_639_3
+    assert_equal 'eng', english.iso_639_2b
+    assert_equal 'eng', english.iso_639_2t
+    assert_equal 'English', english.name
+  end
+
+  def test_sort_should_order_by_name
+    sorted = LanguageList::COMMON_LANGUAGES.sort
+    expected = LanguageList::COMMON_LANGUAGES.map(&:name).sort
+
+    assert_equal expected, sorted.map(&:name)
+  end
+
+  def test_common_name_when_present
+    greek = LanguageList::LanguageInfo.find('el')
+    assert_equal 'Greek', greek.common_name
+  end
+
+  def test_common_name_when_not_present
+    english = LanguageList::LanguageInfo.find('en')
+    assert_equal english.name, english.common_name
+  end
+
+  def test_cannot_change_constants
+    assert_raises RuntimeError, TypeError do
+      LanguageList::ALL_LANGUAGES[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::ISO_639_1[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::LIVING_LANGUAGES[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::COMMON_LANGUAGES[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::BY_NAME[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::BY_ISO_639_1[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::BY_ISO_639_3[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::BY_ISO_639_2T[0] = nil
+    end
+
+    assert_raises RuntimeError, TypeError do
+      LanguageList::BY_ISO_639_2B[0] = nil
+    end
+  end
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: tp-language_list
+version: !ruby/object:Gem::Version
+  version: 1.3.0
+platform: ruby
+authors:
+- Steve Smith
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2024-09-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">"
+      - !ruby/object:Gem::Version
+        version: 5.0.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A list of languages based upon ISO-639-1 and ISO-639-3 with functions
+  to retrieve only common languages.
+email:
+- gems@dynedge.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- data/dump
+- data/languages.yml
+- language_list.gemspec
+- lib/language_list.rb
+- lib/language_list/version.rb
+- test/benchmark.rb
+- test/benchmark_lookup.rb
+- test/language_list_test.rb
+homepage: https://github.com/dabroz/language_list
+licenses: []
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.9
+signing_key:
+specification_version: 4
+summary: A list of languages and methods to find and work with these languages.
+test_files:
+- test/benchmark.rb
+- test/benchmark_lookup.rb
+- test/language_list_test.rb