turkish_cities 0.3.0 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d25fd4c984c9526d142458a9a5c3b6cb76b3f9d1c6b97ef97e931aca0bd305d
-  data.tar.gz: c8ddb6072e8db3c909d2bb023ce86a7c8f9f0b97eb655816aa8c3d4005fc30da
+  metadata.gz: 3ec20706a6b0a7afa3bdca2e6dfc0c6e70c2a67b1cfc1f3ce31f6390c107a4ad
+  data.tar.gz: 603d48232efc5ada2b0210814be61569f4e547776db4e4cfb9998df5a6e85277
 SHA512:
-  metadata.gz: 1543f861a161ca1384261aa85ecb058966e445db3e3c3b39cdab8df1616da101ebaebeb81f7bfd5b402cb85a3fe068c04b9d664f5fee20a8c9487d309bb9504e
-  data.tar.gz: d1c29d060f7205dc6312027b066f33f87364cdff050df70ca17f0d81a693cde736bfddba48cce46ceb61e3613f121bd9324875cfb6466e1e50ffc9a476f40235
+  metadata.gz: 9f55936144b6e0c926e12df2ccc16fa4e52d2a48c28ac248749422122af16a241b5b33501dd8234939bc6ff66278bf02f5bc435cf715ddb1f26c0c68a6197515
+  data.tar.gz: 3df41060bd4478b0875f316c358074b5881002a631a1b9fe1bff4864b74de15c6618e2c16c3b59ef2fc8ab5894914da71f9f31a041ca8845f8031b974d1f6468

data/.github/dependabot.yml

@@ -0,0 +1,20 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: monthly
+    time: "09:00"
+  open-pull-requests-limit: 10
+  ignore:
+  - dependency-name: rubocop
+    versions:
+    - 1.8.1
+    - 1.9.1
+  - dependency-name: bundler
+    versions:
+    - 2.2.6
+    - 2.2.7
+  - dependency-name: i18n
+    versions:
+    - 1.8.7

data/.hound.yml

@@ -1,3 +1,3 @@
 rubocop:
-  version: 0.83.0
+  version: 1.22.1
   config_file: .rubocop.yml

data/.rubocop.yml

@@ -4,12 +4,13 @@ AllCops:
     - 'Gemfile'
     - 'turkish_cities.gemspec'
   NewCops: enable
+  SuggestExtensions: false
 Layout/LineLength:
   Max: 120
 Metrics/AbcSize:
   Max: 20
 Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
+  IgnoredMethods: ['describe', 'context']
 Metrics/MethodLength:
   Max: 15
 Style/Documentation:

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.6.0 (2022-02-26)
+
+### New features
+
+* [#12](https://github.com/sarslanoglu/turkish_cities/issues/12): Add city population data and ```find_by_population``` method
+
+### Changes
+
+* [#103](https://github.com/sarslanoglu/turkish_cities/issues/103): Update city/district/subdistrict informations to 2022
+
+## 0.5.0 (2021-06-06)
+
+### New features
+
+* [#68](https://github.com/sarslanoglu/turkish_cities/issues/68): Add localization for all method responses and errors
+
+## 0.4.0 (2021-04-25)
+
+### New features
+
+* [#66](https://github.com/sarslanoglu/turkish_cities/issues/66): Add ```distance_between_land``` method for calculating land travel distances between cities
+
 ## 0.3.0 (2020-11-22)
 
 ### New features

data/Gemfile.lock

@@ -1,14 +1,14 @@
 PATH
   remote: .
   specs:
-    turkish_cities (0.3.0)
+    turkish_cities (0.6.0)
       i18n (>= 0.6.4, <= 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.1)
-    concurrent-ruby (1.1.6)
+    ast (2.4.2)
+    concurrent-ruby (1.1.9)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
       simplecov (~> 0.16.1)
@@ -17,15 +17,15 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.4.4)
     docile (1.3.2)
-    i18n (1.8.5)
+    i18n (1.10.0)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
-    parallel (1.20.0)
-    parser (2.7.2.0)
+    parallel (1.21.0)
+    parser (3.1.0.0)
       ast (~> 2.4.1)
-    rainbow (3.0.0)
-    regexp_parser (1.8.2)
-    rexml (3.2.4)
+    rainbow (3.1.1)
+    regexp_parser (2.2.0)
+    rexml (3.2.5)
     rspec (3.10.0)
       rspec-core (~> 3.10.0)
       rspec-expectations (~> 3.10.0)
@@ -39,18 +39,18 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.3.1)
+    rubocop (1.25.0)
       parallel (~> 1.10)
-      parser (>= 2.7.1.5)
+      parser (>= 3.1.0.0)
       rainbow (>= 2.2.2, < 4.0)
-      regexp_parser (>= 1.8)
+      regexp_parser (>= 1.8, < 3.0)
       rexml
-      rubocop-ast (>= 1.1.1)
+      rubocop-ast (>= 1.15.1, < 2.0)
       ruby-progressbar (~> 1.7)
-      unicode-display_width (>= 1.4.0, < 2.0)
-    rubocop-ast (1.1.1)
-      parser (>= 2.7.1.5)
-    ruby-progressbar (1.10.1)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.15.1)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
     simplecov (0.16.1)
       docile (~> 1.1)
       json (>= 1.8, < 3)
@@ -62,17 +62,17 @@ GEM
     thor (1.0.1)
     tins (1.25.0)
       sync
-    unicode-display_width (1.7.0)
+    unicode-display_width (2.1.0)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 2.1.4)
+  bundler (~> 2.2.16)
   coveralls (~> 0.8.23)
   rspec (~> 3.10.0)
-  rubocop (~> 1.3.1)
+  rubocop (~> 1.25.0)
   turkish_cities!
 
 BUNDLED WITH
-   2.1.4
+   2.2.16

data/README.md

@@ -7,6 +7,8 @@
         <img src="https://travis-ci.org/sarslanoglu/turkish_cities.svg?branch=master" alt="BuildStatus"/></a>
     <a href="https://coveralls.io/github/sarslanoglu/turkish_cities?branch=master">
         <img src="https://coveralls.io/repos/github/sarslanoglu/turkish_cities/badge.svg?branch=master" alt="CoverageStatus"/></a>
+    <a href="https://rubygems.org/gems/turkish_cities">
+        <img src="https://img.shields.io/gem/dt/turkish_cities.svg" alt="DownloadCount"/></a>
     <a href="https://codeclimate.com/github/sarslanoglu/turkish_cities/maintainability">
         <img src="https://api.codeclimate.com/v1/badges/c1dbe0cef353b152956e/maintainability" alt="Maintainability"/></a>
     <a href="https://houndci.com">
@@ -20,6 +22,7 @@ https://rubygems.org/gems/turkish_cities
 
 ## Table of Contents
 * [Installation](#installation)
+* [Localization](#localization)
 * [Documentation](#documentation)
   * [Finding city name by plate number](#finding-city-name-by-plate-number)
   * [Finding city name by phone code](#finding-city-name-by-phone-code)
@@ -34,7 +37,13 @@ https://rubygems.org/gems/turkish_cities
     * [With subdistrict info](#with-subdistrict-info)
     * [Without subdistrict info](#without-subdistrict-info)
   * [Finding city, district and subdistrict name by postcode](#finding-city-district-and-subdistrict-name-by-postcode)
+  * [Finding city name with population data](#finding-city-name-with-population-data)
+    * [Exact search](#exact-search)
+    * [Below given](#below-given)
+    * [Above given](#above-given)
+    * [Between search](#between-search)
   * [Finding travel distance and time estimation between two cities](#finding-travel-distance-and-time-estimation-between-two-cities)
+    * [By land](#by-land)
     * [By air](#by-air)
 * [Data sources](#data-sources)
 * [Compatibility](#compatibility)
@@ -62,6 +71,24 @@ and run
 $ bundle
 ```
 
+## Localization
+
+Currently gem supports two different languages, Turkish and English. English is default, if no action taken.
+
+Language can be easily changed by ```change_locale``` method. Valid parameters are 'tr' for Turkish and 'en' for English.
+
+```rb
+TurkishCities.change_locale('tr') # => "Dil Türkçe olarak ayarlandı."
+```
+
+After changing language all errors and result sets will be in desired language
+
+```rb
+TurkishCities.list_districts('Eskişehirrr') # => "'Eskişehirrr' ile bir şehir bulunamadı"
+TurkishCities.distance_between('kirsehir', 'Ordu', 'land')
+# => [533, "Kırşehir ile Ordu arasındaki karayolu mesafesi 533 km"]
+```
+
 ## Documentation
 
 With using irb just require gem and start using
@@ -85,7 +112,7 @@ TurkishCities.find_name_by_plate_number(100)  # => 'Given value [100] is outside
 
 ### Finding city name by phone code
 
-There are 81 cities in Turkey. By calling a phone code between 212-488 will give city_name. All phone codes are even sending odd number will give error without searching.
+There are 82 phone codes for each city in Turkey (Istanbul is an exception with different phone codes for Anatolian side and European side). By calling a phone code between 212-488 will give city_name. All phone codes ending with even numbers. So sending an odd number will give an error without searching.
 
 ```rb
 TurkishCities.find_name_by_phone_code(312)    # => "Ankara"
@@ -135,7 +162,7 @@ TurkishCities.list_cities # => ["Adana", "Adıyaman" ... "Kilis", "Osmaniye", "D
 
 ### Listing all cities with only name
 
-While listing cities three additional parameters can be send ```alphabetically_sorted```, ```metropolitan_municipality``` and ```region```. All parameters can be send seperately and together.
+While listing cities three additional parameters can be sent ```alphabetically_sorted```, ```metropolitan_municipality``` and ```region```. All parameters can be sent separately and together.
 
 ```rb
 TurkishCities.list_cities({ alphabetically_sorted: true })
@@ -154,7 +181,7 @@ TurkishCities.list_cities({ alphabetically_sorted: true, metropolitan_municipali
 
 ### Listing all cities with other parameters
 
-While listing cities ```with``` parameter can be used for listing cities with other attributes. These parameters are ```alphabetically_sorted```, ```metropolitan_municipality``` and ```region```. All parameters can be send seperately and together.
+While listing cities ```with``` parameter can be used for listing cities with other attributes. These parameters are ```alphabetically_sorted```, ```metropolitan_municipality``` and ```region```. All parameters can be sent separately and together.
 
 ```rb
 TurkishCities.list_cities({ alphabetically_sorted: true, with: { phone_code: true } })
@@ -210,7 +237,7 @@ TurkishCities.list_subdistricts('İstanbul', 'Kadılarköyü')
 
 ### With subdistrict info
 
-City name can be given case and turkish character insensitive. District name and subdistrict name should be case and turkish character sensitive.(Correct district names can be obtained by ```list_districts``` method. Correct subdistrict names can be obtained by ```list_subdistricts``` method.) Listing of neighborhoods are alphabetically sorted.
+City name can be given case and turkish character insensitive. District name and subdistrict name should be case and turkish character sensitive.(Correct district names can be obtained by the ```list_districts``` method. Correct subdistrict names can be obtained by ```list_subdistricts``` method.) Listings of neighborhoods are alphabetically sorted.
 
 ```rb
 TurkishCities.list_neighborhoods('Adana', 'Seyhan', 'Emek')
@@ -229,7 +256,7 @@ TurkishCities.list_neighborhoods('Eskişehir', 'Odunpazarı', 'Büyükkkkkdere')
 
 Also ```list_neighborhoods``` can work without subdistrict information. This time neighborhoods result will be larger based on searched city and district.
 
-City name can be given case and turkish character insensitive. District name should be case and turkish character sensitive.(Correct district names can be obtained by ```list_districts``` method.) Listing of neighborhoods are alphabetically sorted.
+City name can be given case and turkish character insensitive. District name should be case and turkish character sensitive.(Correct district names can be obtained by the ```list_districts``` method.) Listings of neighborhoods are alphabetically sorted.
 
 ```rb
 TurkishCities.list_neighborhoods('Adana', 'Seyhan')
@@ -254,11 +281,102 @@ TurkishCities.find_by_postcode(34382)    # => "Couldn't find any subdistrict wit
 TurkishCities.find_by_postcode('100000') # => Given value [100000] is outside bounds of 1010 to 81952.
 ```
 
+### Finding city name with population data
+
+### Exact search
+
+Search city name with exact population
+
+```rb
+TurkishCities.find_by_population('exact', 15840900)
+# => ["İstanbul"]
+TurkishCities.find_by_population('exatc', 2130432)
+# => "Population type 'exatc' is unsupported"
+TurkishCities.find_by_population('exact', 10432)
+# => []
+TurkishCities.find_by_population('exact', 22130432)
+# => []
+```
+
+### Below given
+
+Search city name with below population
+
+```rb
+TurkishCities.find_by_population('below', 86000)
+# => ["Tunceli", "Bayburt"]
+TurkishCities.find_by_population('below', 500000)
+# => ["Amasya", "Artvin" ... "Kilis", "Düzce"]
+TurkishCities.find_by_population('below', 5000000)
+# => ["Adana", "Adıyaman" ... "Kilis", "Osmaniye", "Düzce"]
+TurkishCities.find_by_population('woleb', 2130432)
+# => "Population type 'woleb' is unsupported"
+TurkishCities.find_by_population('below', 10432)
+# => []
+TurkishCities.find_by_population('below', 22130432)
+# => []
+```
+
+### Above given
+
+Search city name with above population
+
+```rb
+TurkishCities.find_by_population('above', 860000)
+# => ["Adana", "Ankara" ... "Şanlıurfa", "Van"]
+TurkishCities.find_by_population('above', 2500000)
+# => ["Ankara", "Antalya", "Bursa", "İstanbul", "İzmir"]
+TurkishCities.find_by_population('above', 5000000)
+# => ["Ankara", "İstanbul"]
+TurkishCities.find_by_population('abov', 2130432)
+# => "Population type 'abov' is unsupported"
+TurkishCities.find_by_population('above', 10432)
+# => []
+TurkishCities.find_by_population('above', 22130432)
+# => []
+```
+
+### Between search
+
+Search city name with between population
+
+```rb
+TurkishCities.find_by_population('between', 15840900, 3000000)
+# => ["Ankara", "Bursa", "İzmir"]
+TurkishCities.find_by_population('between', 828369, 985732)
+# => ["Eskişehir", "Mardin"]
+TurkishCities.find_by_population('between', 2130432, 3500000)
+# => ["Adana", "Antalya", "Bursa", "Konya", "Şanlıurfa"]
+TurkishCities.find_by_population('between', 10432, 100000)
+# => []
+TurkishCities.find_by_population('between', 2130432, 34000000)
+# => []
+```
+
 ### Finding travel distance and time estimation between two cities
 
+### By land
+
+City names can be given case and turkish character insensitive. Travel method should be lower case. Array with 2 elements will be returned. First element is distance between cities in kilometers and the second element is the description created by the first element.
+
+```rb
+TurkishCities.distance_between('Eskişehir', 'Kastamonu', 'land')
+# => [480, "Land travel distance between Eskişehir and Kastamonu is 480 km."]
+TurkishCities.distance_between('kirsehir', 'Ordu', 'land')
+# => [533, "Land travel distance between Kırşehir and Ordu is 533 km."]
+TurkishCities.distance_between('İzmir', 'Antalya', 'land')
+# => [444, "Land travel distance between İzmir and Antalya is 444 km."]
+TurkishCities.distance_between('istanbul', 'kars', 'land')
+# => [1427, "Land travel distance between İstanbul and Kars is 1427 km."]
+TurkishCities.distance_between('Adana', 'Adıyaman', 'time')
+# => "Travel method 'time' is unsupported"
+TurkishCities.distance_between('filansa', 'falansa', 'land')
+# => "Couldn't find cities combination with 'filansa/falansa'"
+```
+
 ### By air
 
-City names can be given case and turkish character insensitive. Travel method should be lower case. Array with 3 elements will be return. First element is distance between cities in kilometers, second element is estimated travel time and last element is description created by first two element.
+City names can be given case and turkish character insensitive. Travel method should be lower case. Array with 3 elements will be returned. First element is distance between cities in kilometers, the second element is estimated travel time and the last element is the description created by the first two elements.
 
 ```rb
 TurkishCities.distance_between('Eskişehir', 'Kastamonu', 'air')
@@ -283,29 +401,41 @@ All information related with cities can be found at:
 https://tr.wikipedia.org/wiki/{#city_name_here}
 ```
 
-Districts, subdisctricts, neighborhoods and postcodes can be found at:
+Districts, subdisctricts, neighborhoods and postcodes information can be found at:
 
 ```
 https://postakodu.ptt.gov.tr/
 ```
+All districts/subdistricts are up to date at: 23 January 2022 with using PTT file released at 22 November 2021
+
+Land distance information can be found at:
+
+```
+https://www.kgm.gov.tr/SiteCollectionDocuments/KGMdocuments/Root/Uzakliklar/ilmesafe.xls
+```
+
+Population of cities are up to date as 15 February 2022 as using February 2022 report of Türkiye İstatistik Kurumu (TÜİK) / Turkish Statistical Institute (TURKSTAT)
+
+Statistics for gem can be found at:
+```
+https://bestgems.org/gems/turkish_cities
+```
 
 ## Compatibility
 
 | Ruby Version | Supported          |
 | ------------ | ------------------ |
-| 2.7.1        | :white_check_mark: |
-| 2.6.6        | :white_check_mark: |
-| 2.5.8        | :white_check_mark: |
+| 2.7.x        | :white_check_mark: |
+| 2.6.x        | :white_check_mark: |
+| 2.5.x        | :white_check_mark: |
 | < 2.5.1      | :x:                |
 
 - TurkishCities heavily depends on ```:turkic``` case mapping support of Ruby string downcase method. Below Ruby version 2.5.1 some functions will run buggy/false or even won't run at all.
 
 ## Roadmap
 
-- Add missing land travel method
 - Add missing sea travel method
-- Add localization to gem
-- Refactor tests (seperate test suites with more edge case tests)
+- Refactor tests (separate test suites with more edge case tests)
 
 ## Contributing
 

data/config/locales/en.yml

@@ -0,0 +1,19 @@
+en:
+  description_text:
+    air_travel: "Air travel distance between %{first_city} and %{second_city} is %{distance} km. Estimated air travel would take %{duration} minutes"
+    land_travel: "Land travel distance between %{first_city} and %{second_city} is %{distance} km"
+  errors:
+    cities_not_found_error: "Couldn't find cities combination with '%{first}/%{second}'"
+    city_not_found_error: "Couldn't find city name with '%{input}'"
+    city_population_not_found_error: "Couldn't find any city with population data"
+    district_not_found_error: "Couldn't find district name with '%{district_input}' of '%{city_input}'"
+    not_even_input: "Given value [%{input}] must be an even number"
+    outside_bounds: "Given value [%{input}] is outside bounds of %{min} to %{max}"
+    postcode_not_found_error: "Couldn't find any subdistrict with postcode '%{postcode_input}'"
+    subdistrict_not_found_error: "Couldn't find subdistrict with '%{subdistrict_input}' of '%{district_input}'/'%{city_input}'"
+    unsupported_population_type: "Population type '%{input}' is unsupported"
+    unsupported_travel_method: "Travel method '%{input}' is unsupported"
+  language:
+    errors:
+      unsupported_language_code: "Unsupported language code. Please use 'tr' for Turkish, 'en' for English"
+    success: "Language set to English"

data/config/locales/tr.yml

@@ -0,0 +1,19 @@
+tr:
+  description_text:
+    air_travel: "%{first_city} ile %{second_city} arasındaki havayolu mesafesi %{distance} km. Tahmini uçuş süresi %{duration} dakikadır"
+    land_travel: "%{first_city} ile %{second_city} arasındaki karayolu mesafesi %{distance} km"
+  errors:
+    cities_not_found_error: "'%{first}/%{second}' ile şehir kombinasyonu bulunamadı"
+    city_not_found_error: "'%{input}' ile bir şehir bulunamadı"
+    city_population_not_found_error: "Verilen nüfus verisi ile şehir bulunamadı"
+    district_not_found_error: "'%{city_input}' şehrine ait '%{district_input}' ilçesi ile bir kayıt bulunamadı"
+    not_even_input: "Girilen değer [%{input}] çift sayı olmalı"
+    outside_bounds: "Girilen değer [%{input}] %{min} ile %{max} değerleri dışında"
+    postcode_not_found_error: "'%{postcode_input}' posta kodu ile kayıt bulunamadı"
+    subdistrict_not_found_error: "'%{subdistrict_input}' ile '%{district_input}'/'%{city_input}' ait bir kayıt bulunamdı"
+    unsupported_population_type: "'%{input}' ile arama methodu desteklenmiyor"
+    unsupported_travel_method: "'%{input}' yolculuk methodu desteklenmiyor"
+  language:
+    errors:
+      unsupported_language_code: "Desteklenmeyen dil kodu. Lütfen Türkçe için 'tr', İngilizce için 'en' kullanınız"
+    success: "Dil Türkçe olarak ayarlandı"

data/lib/turkish_cities/city.rb

@@ -8,8 +8,6 @@ require_relative '../turkish_cities/helpers/decomposer_helper'
 class City
   include DecomposerHelper
 
-  I18n.enforce_available_locales = false
-
   file_path = File.join(File.dirname(__FILE__), 'data/cities.yaml')
   CITY_LIST = YAML.load_file(file_path)
 
@@ -67,7 +65,7 @@ class City
   def check_phone_code(input)
     return if input.to_i.even?
 
-    raise ArgumentError, "Given value [#{input}] must be an even number."
+    raise ArgumentError, I18n.t('errors.not_even_input', input: input)
   end
 
   def filter_metropolitan_municipalities(city_list)