turkish_cities 0.2.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 528b791fc697635aaedf2ea43825b172f02271f452256c6a3886fb74c8971a83
-  data.tar.gz: d6e52070ceaed57ff61fa8725e80a2d5459aefce48c0787bfd0c87a7705c3877
+  metadata.gz: cf40e5e9b493d00931c7cda7597941d09a589f18eacaace649659bbc3018324e
+  data.tar.gz: 25776268893ae75242c27025bfc581bb50a6aa77154fef88c4bd584434456e8b
 SHA512:
-  metadata.gz: ee0223deae4c3907f26e1769ab57e19f8b901873efa532aa8be31fec3cfe27ce22ebb32fd0d24ebf99d7ec3a17abfc26f3c6061b05782a9cfb376de26ae18b18
-  data.tar.gz: 9a10b09a78d230af8e57dafd1609ef3246de8e3ceb45c610132567553d519b6cc6535e7a76e38febedb0547dc5a018683456405ac56892b557ceb788449c02e6
+  metadata.gz: 7d69c0c456c33731de3b9c02a63a90f18893d761c6fad0cf688fb0af350e9263411ef4f15fe5588732048b9d351491c80cbe023376ecf747fa80631fede07ddf
+  data.tar.gz: f4d429988cfc994842db241e3ae0e5440de8a6c8be09d691bdd5037492d73f95c7d347b9bb4c6a088e546c5e6b3083ef80dbe1dea7f81fb34a913410300556e4

data/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,22 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: "[BUG] - (Fill here)"
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. In terminal ```require 'turkish_cities'```
+2. Call method ```'....'```
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Additional context**
+Add any other context about the problem here.

data/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: "[FEAT] - (Fill here)"
+labels: enhancement
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

data/.github/pull_request_template.md

@@ -0,0 +1,38 @@
+### Related github issue for this PR
+
+Resolves #001 <!--fill issue number-->
+
+### Checklist
+
+* [ ] I have performed a self-review of my own code
+* [ ] I added comments, particularly in hard-to-understand areas
+* [ ] I have made corresponding changes to the documentation `README.md`
+* [ ] I added tests that prove my fix is effective or that my feature works
+* [ ] `bundle exec rake` passes locally
+* [ ] `rubocop` gives no error locally
+* [ ] My PR title includes "WIP" or is [draft PR](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests#draft-pull-requests) if work is in progress
+
+### Description
+
+<!-- Please include a summary of the change and which issue is fixed.
+Please also include relevant motivation and context.
+Guide questions:
+  - What changed, and why?
+  - What alternative solutions did you consider?
+  - What are the tradeoffs for your solution?
+
+Include anything else we should know about. -->
+
+### Type of change
+
+<!-- Please delete options that are not relevant. -->
+
+* Bug fix (non-breaking change which fixes an issue)
+* New feature (non-breaking change which adds functionality)
+* Breaking change (fix or feature that would cause existing functionality to not
+work as expected)
+* Documentation update
+
+### Which tests are written for this PR? And what are the expected results for these tests?
+
+<!-- Please describe the tests that you ran to verify your changes. -->

data/.hound.yml

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

data/.rubocop.yml

@@ -3,16 +3,9 @@ AllCops:
   Exclude:
     - 'Gemfile'
     - 'turkish_cities.gemspec'
-Layout/EmptyLinesAroundAttributeAccessor:
-  Enabled: true
+  NewCops: enable
 Layout/LineLength:
   Max: 100
-Layout/SpaceAroundMethodCallOperator:
-  Enabled: true
-Lint/RaiseException:
-  Enabled: true
-Lint/StructNewOverride:
-  Enabled: true
 Metrics/AbcSize:
   Max: 20
 Metrics/BlockLength:
@@ -21,15 +14,3 @@ Metrics/MethodLength:
   Max: 15
 Style/Documentation:
   Enabled: false
-Style/ExponentialNotation:
-  Enabled: true
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Description: 'Prefer `transform_keys` over `each_with_object` and `map`.'
-  Enabled: true
-Style/HashTransformValues:
-  Description: 'Prefer `transform_values` over `each_with_object` and `map`.'
-  Enabled: true
-Style/SlicingWithRange:
-  Enabled: true

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.2.1 (2020-06-29)
+
+### Bug fixes
+
+* [#38](https://github.com/sarslanoglu/turkish_cities/issues/38): ```NoMethodError``` on ```list_neighborhoods``` when called with wrong subdistrict name
+
+### Changes
+
+* [#39](https://github.com/sarslanoglu/turkish_cities/issues/39): May maintenance of gem - 2020-05-24
+
 ## 0.2.0 (2020-05-18)
 
 ### New features
@@ -23,6 +33,7 @@
 ### New features
 
 * [#22](https://github.com/sarslanoglu/turkish_cities/issues/22): Add region data to cities.yaml and update ```list_cities``` method to support regions
+
 * [#20](https://github.com/sarslanoglu/turkish_cities/issues/20): Add city finding with phone code and vice versa. ```find_name_by_phone_code``` and ```find_phone_code_by_name``` methods are added
 
 ### Bug fixes

data/Gemfile

@@ -1,4 +1,3 @@
 source 'https://rubygems.org'
 
-# Specify your gem's dependencies in turkish_cities.gemspec
 gemspec

data/Gemfile.lock

@@ -1,13 +1,13 @@
 PATH
   remote: .
   specs:
-    turkish_cities (0.1.3)
+    turkish_cities (0.2.1)
       i18n (>= 0.6.4, <= 2)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    ast (2.4.0)
+    ast (2.4.1)
     concurrent-ruby (1.1.6)
     coveralls (0.8.23)
       json (>= 1.8, < 3)
@@ -17,34 +17,39 @@ GEM
       tins (~> 1.6)
     diff-lcs (1.3)
     docile (1.3.2)
-    i18n (1.8.2)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
     json (2.3.0)
-    parallel (1.19.1)
-    parser (2.7.1.2)
-      ast (~> 2.4.0)
+    parallel (1.19.2)
+    parser (2.7.1.4)
+      ast (~> 2.4.1)
     rainbow (3.0.0)
+    regexp_parser (1.7.1)
     rexml (3.2.4)
     rspec (3.9.0)
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-support (3.9.2)
-    rubocop (0.83.0)
+    rspec-support (3.9.3)
+    rubocop (0.86.0)
       parallel (~> 1.10)
       parser (>= 2.7.0.1)
       rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.7)
       rexml
+      rubocop-ast (>= 0.0.3, < 1.0)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
+    rubocop-ast (0.0.3)
+      parser (>= 2.7.0.1)
     ruby-progressbar (1.10.1)
     simplecov (0.16.1)
       docile (~> 1.1)
@@ -55,7 +60,7 @@ GEM
     term-ansicolor (1.7.1)
       tins (~> 1.0)
     thor (1.0.1)
-    tins (1.24.1)
+    tins (1.25.0)
       sync
     unicode-display_width (1.7.0)
 
@@ -66,7 +71,7 @@ DEPENDENCIES
   bundler (~> 2.1.4)
   coveralls (~> 0.8.23)
   rspec (~> 3.9.0)
-  rubocop (~> 0.83.0)
+  rubocop (~> 0.86.0)
   turkish_cities!
 
 BUNDLED WITH

data/README.md

@@ -23,7 +23,7 @@
   * [Listing all subdistricts of given city and district](#listing-all-subdistricts-of-given-city-and-district)
   * [Listing all neighborhoods of given city and district](#listing-all-neighborhoods-of-given-city-and-district)
     * [With subdistrict info](#with-subdistrict-info)
-    * [Without subdistrict info](#ithout-subdistrict-info)
+    * [Without subdistrict info](#without-subdistrict-info)
   * [Finding city, district and subdistrict name by postcode](#finding-city-district-and-subdistrict-name-by-postcode)
 * [Compatibility](#compatibility)
 * [Contributing](#contributing)
@@ -54,7 +54,7 @@ $ bundle
 
 With using irb just require gem and start using
 
-```ruby
+```rb
 require 'turkish_cities'
 ```
 
@@ -62,7 +62,7 @@ require 'turkish_cities'
 
 There are 81 cities in Turkey. By calling a plate number between 1-81 will give city_name.
 
-```ruby
+```rb
 TurkishCities.find_name_by_plate_number(26)   # => "Eskişehir"
 TurkishCities.find_name_by_plate_number(7)    # => "Antalya"
 TurkishCities.find_name_by_plate_number(0007) # => "Antalya"
@@ -75,7 +75,7 @@ TurkishCities.find_name_by_plate_number(100)  # => 'Given value [100] is outside
 
 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.
 
-```ruby
+```rb
 TurkishCities.find_name_by_phone_code(312)    # => "Ankara"
 TurkishCities.find_name_by_phone_code(242)    # => "Antalya"
 TurkishCities.find_name_by_phone_code(000222) # => "Eskişehir"
@@ -91,7 +91,7 @@ TurkishCities.find_name_by_phone_code(213)    # => 'Given value [213] must be an
 
 City name can be given case and turkish character insensitive.
 
-```ruby
+```rb
 TurkishCities.find_plate_number_by_name('Ankara')     # => 6
 TurkishCities.find_plate_number_by_name('Eskişehir')  # => 26
 TurkishCities.find_plate_number_by_name('Canakkale')  # => 17
@@ -104,7 +104,7 @@ TurkishCities.find_plate_number_by_name('falansehir') # => "Couldn't find city n
 
 City name can be given case and turkish character insensitive.
 
-```ruby
+```rb
 TurkishCities.find_phone_code_by_name('Ankara')     # => 312
 TurkishCities.find_phone_code_by_name('Eskişehir')  # => 222
 TurkishCities.find_phone_code_by_name('Canakkale')  # => 286
@@ -117,7 +117,7 @@ TurkishCities.find_phone_code_by_name('filansehir') # => "Couldn't find city nam
 
 By default cities will be listed by their plate number ascending.
 
-```ruby
+```rb
 TurkishCities.list_cities # => ["Adana", "Adıyaman" ... "Kilis", "Osmaniye", "Düzce"]
 ```
 
@@ -125,7 +125,7 @@ TurkishCities.list_cities # => ["Adana", "Adıyaman" ... "Kilis", "Osmaniye", "D
 
 While listing cities three additional parameters can be send ```alphabetically_sorted```, ```metropolitan_municipality``` and ```region```. All parameters can be send seperately and together.
 
-```ruby
+```rb
 TurkishCities.list_cities({ alphabetically_sorted: true })
 # => ["Adana", "Adıyaman" ... "Yalova", "Yozgat", "Zonguldak"]
 TurkishCities.list_cities({ metropolitan_municipality: true })
@@ -144,7 +144,7 @@ TurkishCities.list_cities({ alphabetically_sorted: true, metropolitan_municipali
 
 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.
 
-```ruby
+```rb
 TurkishCities.list_cities({ alphabetically_sorted: true, with: { phone_code: true } })
 # => [{:name=>"Adana", :phone_code=>322}, {:name=>"Adıyaman", :phone_code=>416}, {:name=>"Afyon", :phone_code=>272} .
 # .. {:name=>"Yozgat", :phone_code=>354}, {:name=>"Zonguldak", :phone_code=>372}]
@@ -162,7 +162,7 @@ TurkishCities.list_cities({ metropolitan_municipality: true, region: 'Karadeniz'
 
 City name can be given case and turkish character insensitive. Listing of districts are alphabetically sorted.
 
-```ruby
+```rb
 TurkishCities.list_districts('Ankara')
 # => ["Akyurt", "Altındağ" ... "Sincan", "Şereflikoçhisar", "Yenimahalle"]
 TurkishCities.list_districts('Eskişehir')
@@ -181,7 +181,7 @@ TurkishCities.list_districts('filansehir')
 
 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 subdistricts are alphabetically sorted.
 
-```ruby
+```rb
 TurkishCities.list_subdistricts('Adana', 'Seyhan')
 # => ["Akkapı", "Denizli" ... "Yeşiloba", "Yeşilyurt", "Ziyapaşa"]
 TurkishCities.list_subdistricts('Eskişehir', 'Odunpazarı')
@@ -200,7 +200,7 @@ TurkishCities.list_subdistricts('İstanbul', 'Kadılarköyü')
 
 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.
 
-```ruby
+```rb
 TurkishCities.list_neighborhoods('Adana', 'Seyhan', 'Emek')
 # => ["Emek Mah", "Ova Mah", "Şakirpaşa Mah", "Uçak Mah"]
 TurkishCities.list_neighborhoods('Eskişehir', 'Odunpazarı', 'Büyükdere')
@@ -209,6 +209,8 @@ TurkishCities.list_neighborhoods('Istanbul', 'Beşiktaş', 'Gayrettepe')
 # => ["Balmumcu Mah", "Dikilitaş Mah", "Gayrettepe Mah", "Yıldız Mah"]
 TurkishCities.list_neighborhoods('Adana', 'Beşiktaş', 'Emek')
 # => "Couldn't find district name with 'Beşiktaş' of 'Adana'"
+TurkishCities.list_neighborhoods('Eskişehir', 'Odunpazarı', 'Büyükkkkkdere')
+# => "Couldn't find subdistrict with 'Büyükkkkkdere' of 'Odunpazarı'/'Eskişehir'"
 ```
 
 ### Without subdistrict info
@@ -217,7 +219,7 @@ Also ```list_neighborhoods``` can work without subdistrict information. This tim
 
 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.
 
-```ruby
+```rb
 TurkishCities.list_neighborhoods('Adana', 'Seyhan')
 # => ["2000 Evler Mah", "Ahmet Remzi Yüreğir Mah", "Akkapı Mah" ... "Zeytinli Mah", "Ziyapaşa Mah"]
 TurkishCities.list_neighborhoods('Eskişehir', 'Odunpazarı')
@@ -232,7 +234,7 @@ TurkishCities.list_neighborhoods('İstanbul', 'filanmevki')
 
 In Turkey postcodes are uniq for subdistricts. Basically when a postcode is search through ```find_by_postcode``` it will give city, district and subdistrict information of postcode if valid and found
 
-```ruby
+```rb
 TurkishCities.find_by_postcode(34380)    # => ["İstanbul", "Şişli", "Cumhuriyet"]
 TurkishCities.find_by_postcode(34433)    # => ["İstanbul", "Beyoğlu", "Cihangir"]
 TurkishCities.find_by_postcode('26040')  # => ["Eskişehir", "Odunpazarı", "Büyükdere"]
@@ -242,9 +244,12 @@ TurkishCities.find_by_postcode('100000') # => Given value [100000] is outside bo
 
 ## Compatibility
 
-- ✅ `2.7.1` (stable)
-- ✅ `2.6.6` (stable)
-- ✅ `2.5.8` (stable)
+| Ruby Version | Supported          |
+| ------------ | ------------------ |
+| 2.7.1        | :white_check_mark: |
+| 2.6.6        | :white_check_mark: |
+| 2.5.8        | :white_check_mark: |
+| < 2.5.1      | :x:                |
 
 - This gem 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.
 

data/lib/turkish_cities/district.rb

@@ -26,14 +26,10 @@ class District
     district_list = create_district_list(city_name)
 
     if !district_list[district_name].nil?
-      neighborhoods = if subdistrict_name.nil?
-                        create_neighborhoods_without_subdistrict_name(district_list, district_name)
-                      else
-                        create_neighborhoods_with_subdistrict_name(district_list,
-                                                                   district_name,
-                                                                   subdistrict_name)
-                      end
-      sort_alphabetically(neighborhoods)
+      neighborhoods = create_neighborhoods(district_list, city_name,
+                                           district_name, subdistrict_name)
+
+      neighborhoods.is_a?(Array) ? sort_alphabetically(neighborhoods) : neighborhoods
     else
       district_not_found_error(district_name, city_name)
     end
@@ -41,6 +37,18 @@ class District
 
   private
 
+  def create_neighborhoods(district_list, city_name, district_name, subdistrict_name)
+    if subdistrict_name.nil?
+      create_neighborhoods_without_subdistrict_name(district_list, district_name)
+    else
+      if district_list[district_name][subdistrict_name].nil?
+        return subdistrict_not_found_error(subdistrict_name, district_name, city_name)
+      end
+
+      create_neighborhoods_with_subdistrict_name(district_list, district_name, subdistrict_name)
+    end
+  end
+
   def create_neighborhoods_without_subdistrict_name(district_list, district_name)
     neighborhoods = []
     district_list[district_name].each do |subdistrict|

data/lib/turkish_cities/helpers/decomposer_helper.rb

@@ -70,6 +70,10 @@ module DecomposerHelper
     end
   end
 
+  def subdistrict_not_found_error(subdistrict_input, district_input, city_input)
+    "Couldn't find subdistrict with '#{subdistrict_input}' of '#{district_input}'/'#{city_input}'"
+  end
+
   private
 
   def add_plate_number_if_requested(result, city, options = nil)

data/lib/turkish_cities/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TurkishCities
-  VERSION = '0.2.0'
+  VERSION = '0.2.1'
 end

data/turkish_cities.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'bundler', '~> 2.1.4'
   s.add_development_dependency 'coveralls', '~> 0.8.23'
   s.add_development_dependency 'rspec', '~> 3.9.0'
-  s.add_development_dependency 'rubocop', '~> 0.83.0'
+  s.add_development_dependency 'rubocop', '~> 0.86.0'
 
   if s.respond_to?(:metadata)
     s.metadata['changelog_uri'] = 'https://github.com/sarslanoglu/turkish_cities/blob/master/CHANGELOG.md'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: turkish_cities
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.2.1
 platform: ruby
 authors:
 - Semih Arslanoglu
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.86.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.83.0
+        version: 0.86.0
 description: Simple ruby gem for listing and finding Turkish cities via name, plate
   number or size
 email: arslanoglusemih93@gmail.com
@@ -94,9 +94,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".codeclimate.yml"
+- ".github/ISSUE_TEMPLATE/bug_report.md"
+- ".github/ISSUE_TEMPLATE/feature_request.md"
+- ".github/pull_request_template.md"
 - ".gitignore"
 - ".hound.yml"
-- ".older.rubocop.yml"
 - ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"

data/.older.rubocop.yml

@@ -1,23 +0,0 @@
-AllCops:
-  TargetRubyVersion: 2.5.1
-  Exclude:
-    - 'Gemfile'
-    - 'turkish_cities.gemspec'
-Layout/LineLength:
-  Max: 100
-Metrics/AbcSize:
-  Max: 20
-Metrics/BlockLength:
-  ExcludedMethods: ['describe', 'context']
-Metrics/MethodLength:
-  Max: 15
-Style/Documentation:
-  Enabled: false
-Style/HashEachMethods:
-  Enabled: true
-Style/HashTransformKeys:
-  Description: 'Prefer `transform_keys` over `each_with_object` and `map`.'
-  Enabled: true
-Style/HashTransformValues:
-  Description: 'Prefer `transform_values` over `each_with_object` and `map`.'
-  Enabled: true