llaxta 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 259da34dd7234726246bba70e468b739ec2e0c1e604383952becc6066d863d1d
-  data.tar.gz: '07248a7a573b1a34054a87b2b562d3c4ce506d89baaf35fc94189f95b3bbe87c'
+  metadata.gz: 8385e27b2c596697ccca7422634a95e73ca4aaff39ee381e61b53893e12e1cd7
+  data.tar.gz: a40f9114345448971881408739a5d3ad678d1033528478b402b661d8cd2c83d1
 SHA512:
-  metadata.gz: c77627c344abf4022f05f3e8f27c070e326f5b0d65c98d91450d1789f7b94f0d39e87a20f4b5dfcae404796066d9e4cace0b4dfabbf242d5811e32477baa7389
-  data.tar.gz: b558046d41b352a96905fdd5052ec4da2aa4151b04725d8f8c7fb41eab529c393c80697c87d760d011f9e794dcce7dba0f8f39387bc3aa312f88610f762bb7f5
+  metadata.gz: d6dbfb89cf4114cfe6042ea769cb16d7d10d51be26b96e262c1a4285ccc0978210bd640900dccd12fea6d0aeaf41509c0eaca09be2e0e0df5a899936ba16ca7e
+  data.tar.gz: 81f89c6c6e5b44c613505bf95a27dcc8171f8ca35e90b8eb62972b36e31e20ae55729e9d0df1968900a77798abcd5779e81dc0712d767e2a025a852f4d0b5ac4

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-# 0.0.3 (June 9, 2021) 
+# 0.0.4 (June 15, 2021)
+
+- Add the Llaxta.alpha2 method
+
+# 0.0.3 (June 9, 2021)
 
 - Restore locale files
 
@@ -8,4 +12,4 @@
 
 # 0.0.1 (June 8, 2021)
 
-- Initial commit
+- Initial commit

data/README.md

@@ -2,7 +2,7 @@ Get the name of any of the 249 countries listed in English US, Spanish, Brazilia
 
 ### Usage
 
-There's an only public method called `t` which receives the country Alpha2 code and the locale corresponding to the language in which the country name is going to be shown.
+`Llaxta.t` receives the country Alpha2 code and the locale corresponding to the language in which the country name is going to be shown.
 
 ```ruby
 Llaxta.t("CH", "en_us") # => "Switzerland"
@@ -18,3 +18,12 @@ Llaxta.t("CH", "us") # => "Switzerland"
 Llaxta.t("CH", "br") # => "Suíça"
 Llaxta.t("CH", "cn") # => "瑞士"
 ```
+
+`Llaxta.alpha2` receives a country name and a locale, and returns the country alpha2 if it can be found through the given country name for the given locale.
+
+```ruby
+Llaxta.alpha2("Etiópia", "br")    # => "ET"
+Llaxta.alpha2("埃塞俄比亚", "cn") # => "ET"
+Llaxta.alpha2("Etiopía", "es")    # => "ET"
+Llaxta.alpha2("Ethiopia", "us")   # => "ET"
+```

data/lib/llaxta.rb

@@ -4,17 +4,29 @@ require "yaml"
 require "llaxta/exceptions"
 
 class Llaxta
-  VERSION = Gem::Version.new("0.0.3")
+  VERSION = Gem::Version.new("0.0.4")
 
   class << self
+    # @param [String] alpha2
+    # @param [String] locale
+    # @return [String]
     def t(alpha2, locale)
       raise Exceptions::AlphaMissing unless alpha2
 
       dictionary(locale)[alpha2]
     end
 
+    # @param [String] country_name
+    # @param [String] locale
+    # @return [String]
+    def alpha2(country_name, locale)
+      dictionary(locale).key(country_name)
+    end
+
     private
 
+    # @param [String] locale
+    # @return [Hash<String, String>]
     def dictionary(locale)
       @@locales ||= {}
       @@locales[locale] ||= new(locale).send(:load_dict)
@@ -36,18 +48,23 @@ class Llaxta
   }.freeze
   private_constant :SUPPORTED_LOCALES
 
+  # @param [String] locale
+  # @return [void]
   def initialize(locale)
     raise Exceptions::LocaleMissing unless locale
 
     @locale = SUPPORTED_LOCALES[locale]
   end
 
+  # @return [void]
+  # @raise [Exceptions::LocaleNotFound] if unable to load a YAML file given an unexpected locale
   def load_dict
     YAML.load_file(locale_path)
   rescue Errno::ENOENT
     raise Exceptions::LocaleNotFound.new(locale)
   end
 
+  # @return [String]
   def locale_path
     File.expand_path("../llaxta/locales/#{locale}.yml", __FILE__)
   end

data/spec/llaxta_spec.rb

@@ -43,21 +43,51 @@ RSpec.describe Llaxta do
     end
   end
 
+  describe ".alpha2" do
+    context "when country exists in the file for the given language" do
+      context "with locale br" do
+        it { expect(Llaxta.alpha2("Etiópia", "br")).to eq("ET") }
+      end
+
+      context "with locale cn" do
+        it { expect(Llaxta.alpha2("埃塞俄比亚", "cn")).to eq("ET") }
+      end
+
+      context "with locale es" do
+        it { expect(Llaxta.alpha2("Etiopía", "es")).to eq("ET") }
+      end
+
+      context "with locale us" do
+        it { expect(Llaxta.alpha2("Ethiopia", "us")).to eq("ET") }
+      end
+    end
+
+    context "when country does not exist in the file for the given language" do
+      it { expect(Llaxta.alpha2("NA", "us")).to be_nil }
+    end
+
+    context "with an unsupported locale" do
+      it "raises a LocaleNotFound exception" do
+        expect { Llaxta.alpha2("Chile", "oa") }.to raise_exception Exceptions::LocaleNotFound
+      end
+    end
+  end
+
   describe "exceptions" do
     context "when locale is NOT valid" do
-      it "raises" do
+      it "raises a LocaleNotFound exception" do
         expect { Llaxta.t("PE", "2GFA") }.to raise_exception Exceptions::LocaleNotFound
       end
     end
 
     context "when alpha is nil" do
-      it "raises" do
+      it "raises a AlphaMissing exception" do
         expect { Llaxta.t(nil, "br") }.to raise_exception Exceptions::AlphaMissing
       end
     end
 
     context "when locale is nil" do
-      it "raises" do
+      it "raises a LocaleMissing exception" do
         expect { Llaxta.t("PE", nil) }.to raise_exception Exceptions::LocaleMissing
       end
     end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: llaxta
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Victor Rodriguez
 - Sebastian Palma
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-06-09 00:00:00.000000000 Z
+date: 2021-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -93,7 +93,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/kucho/llaxta
   changelog_uri: https://github.com/kucho/llaxta/blob/master/CHANGELOG.md
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -108,8 +108,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.15
-signing_key:
+rubygems_version: 3.1.4
+signing_key: 
 specification_version: 4
 summary: Translate ISO 3166-1 codes to Country names given a locale
 test_files: