country-codes-rb 0.1.0-java

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d4bd566540d3cc08d6ef1efb46bd53ed4e90323b026a347d0516932f7b8d4b5c
+  data.tar.gz: 24781cceb630629ba7d0ed6d7f507c986d923a6d1d2a297f7e2fd064a2c89190
+SHA512:
+  metadata.gz: 3f7850b7a39ae169b92b5b13497a43e15c344311603ec2df386409c854efe49d66840f4eb9fd3c624f2151f4ea3d324a224368df584fdd2de9af02ce38ebc659
+  data.tar.gz: 1784d56441f8e80f7a588303a93b2b6e12db1a311b73f9dff7581d122524d6ec74d58e0a143c968767d4dcfbd2d337113df9a7dc3eb150eeea2c5226a05b2945

data/Gemfile

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec
+
+gem 'rake', '~> 13.0'
+
+gem 'rspec', '~> 3.0'
+
+gem 'rubocop', '~> 1.21'
+
+gem 'rubocop-rake', '~> 0.6.0'
+
+gem 'pry', '~> 0.14.1'
+
+gem 'rubocop-rspec', '~> 2.7'

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 Karl F. Meinkopf
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# CountryCodes.rb
+
+A JRuby wrapper for the country-codes library.
+
+## Building
+* Install Bundler 
+  ```shell
+  gem install bundler
+  ```
+* Install gem dependencies 
+  ```shell
+  bundle install
+  ```
+* Configure an access token for Github Packages Maven repo:
+  ```shell
+  GITHUB_USER=<username> GITHUB_TOKEN=<token> envsubst < settings.xml.template > settings.xml
+  ```
+* Install jar dependencies
+  ```shell
+  bundle exec rake jars:install
+  ```
+* Now you can just build the gem!
+  ```shell
+  gem build
+  ```
+
+There's also an option to just run `bin/setup` shell file, which just executes commands listed above (except the last one).
+Note that `$GITHUB_USER` and `$GITUHB_TOKEN` env variables should be set to valid GitHub credentials.

data/Rakefile

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+require 'jars/installer'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+namespace :jars do
+  desc 'Download jar dependencies and generate a jar-linker file'
+  task :install do
+    Jars::Installer.vendor_jars!
+  end
+end
+
+task default: %i[spec rubocop]

data/lib/country-codes-rb_jars.rb

@@ -0,0 +1,30 @@
+# this is a generated file, to avoid over-writing it just delete this comment
+begin
+  require 'jar_dependencies'
+rescue LoadError
+  require 'org/scala-lang/scala-library/2.12.12/scala-library-2.12.12.jar'
+  require 'com/fasterxml/jackson/dataformat/jackson-dataformat-yaml/2.10.5/jackson-dataformat-yaml-2.10.5.jar'
+  require 'org/yaml/snakeyaml/1.26/snakeyaml-1.26.jar'
+  require 'com/fasterxml/jackson/module/jackson-module-scala_2.12/2.10.5/jackson-module-scala_2.12-2.10.5.jar'
+  require 'com/fasterxml/jackson/module/jackson-module-paranamer/2.10.5/jackson-module-paranamer-2.10.5.jar'
+  require 'com/fasterxml/jackson/core/jackson-core/2.10.5/jackson-core-2.10.5.jar'
+  require 'com/fasterxml/jackson/core/jackson-annotations/2.10.5/jackson-annotations-2.10.5.jar'
+  require 'org/scala-lang/scala-reflect/2.12.12/scala-reflect-2.12.12.jar'
+  require 'com/fasterxml/jackson/core/jackson-databind/2.10.5/jackson-databind-2.10.5.jar'
+  require 'io/wunderschild/country-codes_2.12/0.0.4/country-codes_2.12-0.0.4.jar'
+  require 'com/thoughtworks/paranamer/paranamer/2.8/paranamer-2.8.jar'
+end
+
+if defined? Jars
+  require_jar 'org.scala-lang', 'scala-library', '2.12.12'
+  require_jar 'com.fasterxml.jackson.dataformat', 'jackson-dataformat-yaml', '2.10.5'
+  require_jar 'org.yaml', 'snakeyaml', '1.26'
+  require_jar 'com.fasterxml.jackson.module', 'jackson-module-scala_2.12', '2.10.5'
+  require_jar 'com.fasterxml.jackson.module', 'jackson-module-paranamer', '2.10.5'
+  require_jar 'com.fasterxml.jackson.core', 'jackson-core', '2.10.5'
+  require_jar 'com.fasterxml.jackson.core', 'jackson-annotations', '2.10.5'
+  require_jar 'org.scala-lang', 'scala-reflect', '2.12.12'
+  require_jar 'com.fasterxml.jackson.core', 'jackson-databind', '2.10.5'
+  require_jar 'io.wunderschild', 'country-codes_2.12', '0.0.4'
+  require_jar 'com.thoughtworks.paranamer', 'paranamer', '2.8'
+end

data/lib/country_codes/country.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+require 'country_codes/internal/helpers'
+
+module CountryCodes
+  # @!attribute [r] alpha2
+  #   @return [String] Returns ISO-3166-1 alpha-2 country code
+  # @!attribute [r] alpha3
+  #   @return [String] Returns ISO-3166-1 alpha-3 country code
+  # @!attribute [r] nationality
+  #   @return [String] Returns a human-readable nationality name for this country
+  # @!attribute [r] sovereignty
+  #   @return [String, nil] Return country code for a country that this country is affiliated to (if any).
+  # @!attribute [r] official_name
+  #   @return [String] Returns an official name of this country
+  # @!attribute [r] other_names
+  #   @return [Array<String>] Returns an array of alternative names for this country
+  class Country
+    include Internal::Helpers
+
+    # Wraps an instance of `io.wunderschild.country_codes.Country` to be used in Ruby.
+    #
+    # @note This code is not supposed to be used externally!
+    # @param [JavaLangObject] java_country An instance of `io.wunderschild.country_codes.Country`
+    def initialize(java_country)
+      @country = java_country
+    end
+
+    delegate :alpha2, :alpha3, :official_name, to: :country
+    delegate :nationality, :sovereignty, to: :country, interceptors: :unpack_some
+    delegate :other_names, to: :country, interceptors: %i[unpack_some unpack_seq array_no_nil]
+
+    private
+
+    attr_reader :country
+
+    def array_no_nil(array)
+      array.nil? ? [] : array
+    end
+  end
+end

data/lib/country_codes/internal/helpers.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'country-codes-rb_jars'
+
+module CountryCodes
+  # @note This code is not supposed to be used externally!
+  module Internal
+    # @note This code is not supposed to be used externally!
+    module Helpers
+      java_import 'scala.collection.JavaConverters'
+      java_import 'java.util.ArrayList'
+
+      # rubocop:disable Metrics/CyclomaticComplexity
+      def self.included(obj)
+        obj.class_eval do
+          # Defines a method(s) that redirect calls to an underlying object (receiver).
+          # Allows passing a list of interceptors that will be applied sequentially
+          # with the result of redirected call as the first (and only) argument.
+          # An interceptor can be either a Proc (the proc itself will be `#call`-ed),
+          # or a Symbol as a name of an instance method to be used.
+          #
+          # @param [Array<Symbol>] methods Name of methods to be defined
+          # @param [Object] to Name of an instance method used to retrieve the receiver
+          # @param [Array<Proc, Symbol>] interceptors A list of interceptors.
+          def self.delegate(*methods, to:, interceptors: [])
+            unless methods.reject { |m| m.is_a? Symbol }.empty?
+              raise ArgumentError, 'expected method reference to be a Symbol!'
+            end
+
+            interceptors = [interceptors] unless interceptors.is_a?(Array)
+
+            methods.each do |method|
+              define_method(method) do |*args|
+                result = send(to).send(method, *args)
+
+                interceptors.reduce(result) do |memo, interceptor|
+                  case interceptor
+                  when Proc
+                    interceptor.call(memo)
+                  when Symbol
+                    send(interceptor, memo)
+                  else
+                    memo
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+      # rubocop:enable Metrics/CyclomaticComplexity
+
+      # Unpacks a scala.Some Java object to a value or `nil` (if an object is empty).
+      #
+      # @param [JavaLangObject] some A `scala.Some` object to unpack
+      # @return [Object] A value contained in the object, or nil, if the object is empty
+      def unpack_some(some)
+        if some.empty?
+          nil
+        else
+          some.get
+        end
+      end
+
+      # Converts a `scala.collection.Seq` Java object to a Ruby array
+      #
+      # @param [JavaLangObject] seq An object to convert
+      # @return [JavaLangObject] Extracted array
+      def unpack_seq(seq)
+        JavaConverters.seq_as_java_list(seq).to_a
+      end
+
+      # Converts a given enumerable to a `scala.collection.Seq` Java object
+      #
+      # @param [Enumerable] enumerable An enumerable to wrap
+      # @return [JavaLangObject] A wrapped Seq object
+      def pack_seq(enumerable)
+        list_iter = ArrayList.new(enumerable.to_a).iterator
+
+        JavaConverters.as_scala_iterator_converter(list_iter).as_scala.to_seq
+      end
+    end
+  end
+end

data/lib/country_codes/lookup_table.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'java'
+require 'country-codes-rb_jars'
+
+require 'country_codes/internal/helpers'
+require 'country_codes/country'
+
+module CountryCodes
+  class LookupTable
+    include Internal::Helpers
+
+    java_import 'io.wunderschild.country_codes.ISOCountryCodes'
+
+    # @note This code is not supposed to be used externally!
+    def initialize(locale, indexed_fields)
+      @lookup_table = ISOCountryCodes.apply(locale, pack_seq(indexed_fields))
+    end
+
+    # Searches for a country that matches a given term.
+    # If nothing was found, returns `nil`.
+    #
+    # @param [String] term Search term
+    # @return [CountryCodes::Country, nil] Search result
+    def find(term)
+      packed = @lookup_table.lookup(term)
+
+      java_country = unpack_some(packed)
+
+      return nil if java_country.nil?
+
+      Country.new(java_country)
+    end
+  end
+end

data/lib/country_codes/version.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module CountryCodes
+  VERSION = '0.1.0'
+  LIB_VERSION = '0.0.4'
+end

data/lib/country_codes.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require 'country_codes/country'
+require 'country_codes/lookup_table'
+require 'country_codes/version'
+
+module CountryCodes
+  # A list of allowed search fields (see {.instance}).
+  SEARCHABLE_FIELDS = %i[officialName otherNames nationality sovereignty alpha2 alpha3].freeze
+
+  # Creates an instance of {CountryCodes::LookupTable} to be used for querying.
+  #
+  # @param [String] locale A locale of expected search terms.
+  # @param [Array<Symbol>] search_fields Fields available for searching (see {SEARCHABLE_FIELDS}).
+  # @return [LookupTable]
+  def self.instance(locale: 'en', search_fields: %i[officialName otherNames nationality])
+    unless (search_fields - SEARCHABLE_FIELDS).empty?
+      raise ArgumentError, "Unknown search fields: #{search_fields - SEARCHABLE_FIELDS}"
+    end
+
+    CountryCodes::LookupTable.new(locale, search_fields.map(&:to_s))
+  end
+
+  # Searches for a country that matches a given term.
+  # If nothing was found, returns `nil`.
+  # Check {.instance} for the description of named parameters.
+  #
+  # @param [String] term Search term
+  # @param [String] locale
+  # @param [Array<Symbol>] search_fields
+  # @return [Country, nil] Search result
+  def self.find(term, locale: 'en', search_fields: %i[officialName otherNames nationality])
+    instance(locale: locale, search_fields: search_fields).find(term)
+  end
+end

data/sig/country_codes.rbs

@@ -0,0 +1,28 @@
+module CountryCodes
+  SEARCHABLE_FIELDS: Array[Symbol]
+  VERSION: String
+  LIB_VERSION: String
+
+  def self.instance: (?locale: String, ?search_fields: ::Array[Symbol]) -> LookupTable
+
+  def self.find: (String term, ?locale: String, ?search_fields: ::Array[Symbol]) -> Country?
+
+  class Country
+    attr_reader alpha2: String
+
+    attr_reader alpha3: String
+
+    attr_reader nationality: String
+
+    attr_reader sovereignty: String?
+
+    attr_reader official_name: String
+
+    attr_reader other_names: ::Array[String]
+  end
+
+  class LookupTable
+    def find: (String term) -> CountryCodes::Country?
+  end
+
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: country-codes-rb
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: java
+authors:
+- Wunderschild
+- Karl F. Meinkopf
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2022-01-22 00:00:00.000000000 Z
+dependencies: []
+description: ''
+email:
+- k.meinkopf@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/com/fasterxml/jackson/core/jackson-annotations/2.10.5/jackson-annotations-2.10.5.jar
+- lib/com/fasterxml/jackson/core/jackson-core/2.10.5/jackson-core-2.10.5.jar
+- lib/com/fasterxml/jackson/core/jackson-databind/2.10.5/jackson-databind-2.10.5.jar
+- lib/com/fasterxml/jackson/dataformat/jackson-dataformat-yaml/2.10.5/jackson-dataformat-yaml-2.10.5.jar
+- lib/com/fasterxml/jackson/module/jackson-module-paranamer/2.10.5/jackson-module-paranamer-2.10.5.jar
+- lib/com/fasterxml/jackson/module/jackson-module-scala_2.12/2.10.5/jackson-module-scala_2.12-2.10.5.jar
+- lib/com/thoughtworks/paranamer/paranamer/2.8/paranamer-2.8.jar
+- lib/country-codes-rb_jars.rb
+- lib/country_codes.rb
+- lib/country_codes/country.rb
+- lib/country_codes/internal/helpers.rb
+- lib/country_codes/lookup_table.rb
+- lib/country_codes/version.rb
+- lib/io/wunderschild/country-codes_2.12/0.0.4/country-codes_2.12-0.0.4.jar
+- lib/org/scala-lang/scala-library/2.12.12/scala-library-2.12.12.jar
+- lib/org/scala-lang/scala-reflect/2.12.12/scala-reflect-2.12.12.jar
+- lib/org/yaml/snakeyaml/1.26/snakeyaml-1.26.jar
+- sig/country_codes.rbs
+homepage: https://github.com/wunderschild/country-codes
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/wunderschild/country-codes
+  source_code_uri: https://github.com/wunderschild/country-codes
+  github_repo: https://github.com/thedeadferryman/country-codes
+  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.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements:
+- jar io.wunderschild:country-codes_2.12, 0.0.4
+rubygems_version: 3.2.29
+signing_key:
+specification_version: 4
+summary: A JRuby wrapper for country-codes Scala library
+test_files: []