turkish_cities 0.1.0 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d0cd05d34a416272e2b661c675e262f27737396cf43cad8a73ecc87d21c19fcb
-  data.tar.gz: ebfffaf7f5e7a1790b6300ea1f377c35aac9b1792d571315379ecd954ccaff0e
+  metadata.gz: cf40e5e9b493d00931c7cda7597941d09a589f18eacaace649659bbc3018324e
+  data.tar.gz: 25776268893ae75242c27025bfc581bb50a6aa77154fef88c4bd584434456e8b
 SHA512:
-  metadata.gz: 66047b377afdd925f20c54e8a17e40b3985b4919f2010e8dd82f59bf59a22a1afb5612b6487085503f21ebfb18cd11692c9ca5e89563e65a1df4c93e81e8af12
-  data.tar.gz: 3c46b9903d71b2325219f8fb7f3339df600e5a0a7d1d8abd8295ee70d031760b489b1353bcaaddef3ae4705a8523589c5520bb858f12c461cefefcd4be7657c7
+  metadata.gz: 7d69c0c456c33731de3b9c02a63a90f18893d761c6fad0cf688fb0af350e9263411ef4f15fe5588732048b9d351491c80cbe023376ecf747fa80631fede07ddf
+  data.tar.gz: f4d429988cfc994842db241e3ae0e5440de8a6c8be09d691bdd5037492d73f95c7d347b9bb4c6a088e546c5e6b3083ef80dbe1dea7f81fb34a913410300556e4

data/.codeclimate.yml

@@ -0,0 +1,5 @@
+version: "2"
+checks:
+  method-complexity:
+    config:
+      threshold: 10

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/.gitignore

@@ -0,0 +1,2 @@
+# Simplecov related files
+/coverage

data/.hound.yml

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

data/.rspec

@@ -0,0 +1 @@
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,16 @@
+AllCops:
+  TargetRubyVersion: 2.5.1
+  Exclude:
+    - 'Gemfile'
+    - 'turkish_cities.gemspec'
+  NewCops: enable
+Layout/LineLength:
+  Max: 100
+Metrics/AbcSize:
+  Max: 20
+Metrics/BlockLength:
+  ExcludedMethods: ['describe', 'context']
+Metrics/MethodLength:
+  Max: 15
+Style/Documentation:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,21 @@
+env:
+  global:
+    - CC_TEST_REPORTER_ID=23062197f289fd0ae7601ae06c2dd4a0af4e16c436f2428b99ab4b64a7e4a587
+language: ruby
+dist: trusty
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+before_install:
+  - gem install bundler
+before_script:
+  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
+  - chmod +x ./cc-test-reporter
+  - ./cc-test-reporter before-build
+script: bundle exec rspec spec
+after_script:
+  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT
+notifications:
+  email:
+    - arslanoglusemih93@gmail.com

data/CHANGELOG.md

@@ -0,0 +1,61 @@
+# 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
+
+* [#36](https://github.com/sarslanoglu/turkish_cities/issues/36): Add ```postcode``` class and ```find_by_postcode``` method for finding city, district and subdistrict information by given postcode
+
+* [#33](https://github.com/sarslanoglu/turkish_cities/issues/33): Add ```list_neighborhoods``` method for listing neighborhoods and fix some wrong district names
+
+* [#29](https://github.com/sarslanoglu/turkish_cities/issues/29): Add ```district``` class and ```list_subdistricts``` method for listing subdistricts
+
+* [#27](https://github.com/sarslanoglu/turkish_cities/issues/27): Add all subdistricts and neighborhoods of all Turkish cities
+
+* [#25](https://github.com/sarslanoglu/turkish_cities/issues/25): Add district data to each city at yaml file and add new method ```list_districts``` for listing disctricts of cities alphabetically sorted
+
+### Changes
+
+* [#24](https://github.com/sarslanoglu/turkish_cities/issues/24): Add listing support with ```metropolitan_municipality_since, phone_code, plate_number, region``` to ```listing_cities``` method
+
+## 0.1.3 (2020-04-20)
+
+### 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
+
+* [#18](https://github.com/sarslanoglu/turkish_cities/issues/18): Fix yaml file read error while deploying apps to Heroku
+
+## 0.1.2 (2020-04-13)
+
+### New features
+
+* [#3](https://github.com/sarslanoglu/turkish_cities/issues/3): Change city_list data to yaml file format
+
+### Bug fixes
+
+* [#2](https://github.com/sarslanoglu/turkish_cities/issues/2): Fix capital Turkish characters bug on cities with capital 'I' letter
+
+### Changes
+
+* [#15](https://github.com/sarslanoglu/turkish_cities/issues/15): Handle error messages at ```find_name_by_plate_number``` and ```find_plate_number_by_name``` methods
+
+## 0.1.1 (2020-03-31)
+
+### Changes
+
+* Fix homepage problem on .gemspec file

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,76 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, sex characteristics, gender identity and expression,
+level of experience, education, socio-economic status, nationality, personal
+appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at arslanoglusemih93@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see
+https://www.contributor-covenant.org/faq

data/CONTRIBUTING.md

@@ -0,0 +1,38 @@
+# Contributing
+
+If you discover issues, have ideas for improvements or new features,
+please report them to the [issue tracker][1] of the repository or
+submit a pull request. Please, try to follow these guidelines when you
+do so.
+
+## Guidelines
+
+* Read [how to properly contribute to open source projects on GitHub][2].
+* Fork the project.
+* Write [good commit messages][3].
+* Use the same coding conventions as the rest of the project.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it.
+* Add an entry to the [Changelog](CHANGELOG.md) accordingly. See [changelog entry format](#changelog-entry-format).
+* Make sure the test suite is passing and the code you wrote doesn't produce RuboCop offenses.
+* [Squash related commits together][4].
+
+### Changelog entry format
+
+Here are a few examples:
+
+```
+* [#11](https://github.com/sarslanoglu/turkish_cities/pull/11): Change city_list data to yaml file format
+* [#6](https://github.com/sarslanoglu/turkish_cities/pull/6): Fix capital Turkish characters bug on cities with capital 'I' letter
+* [#16](https://github.com/sarslanoglu/turkish_cities/pull/16): Handle error messages at ```find_name_by_plate_number``` and ```find_plate_number_by_name``` methods
+```
+
+* Mark it up in [Markdown syntax][5].
+* The entry line should start with `* ` (an asterisk and a space).
+* If the change has a related GitHub issue (e.g. a bug fix for a reported issue), put a link to the issue as `[#11](https://github.com/sarslanoglu/turkish_cities/issues/11): `.
+
+[1]: https://github.com/sarslanoglu/turkish_cities/issues
+[2]: https://www.gun.io/blog/how-to-github-fork-branch-and-pull-request
+[3]: https://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html
+[4]: http://gitready.com/advanced/2009/02/10/squashing-commits-with-rebase.html
+[5]: https://daringfireball.net/projects/markdown/syntax

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,78 @@
+PATH
+  remote: .
+  specs:
+    turkish_cities (0.2.1)
+      i18n (>= 0.6.4, <= 2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.1)
+    concurrent-ruby (1.1.6)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    json (2.3.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.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.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)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    tins (1.25.0)
+      sync
+    unicode-display_width (1.7.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  coveralls (~> 0.8.23)
+  rspec (~> 3.9.0)
+  rubocop (~> 0.86.0)
+  turkish_cities!
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 Semih Arslanoglu
+
+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,267 @@
+# 🏙️ Turkish Cities
+[![Gem Version](https://badge.fury.io/rb/turkish_cities.svg)](https://rubygems.org/gems/turkish_cities)
+[![Build Status](https://travis-ci.org/sarslanoglu/turkish_cities.svg?branch=master)](https://travis-ci.org/sarslanoglu/turkish_cities)
+[![Coverage Status](https://coveralls.io/repos/github/sarslanoglu/turkish_cities/badge.svg?branch=master)](https://coveralls.io/github/sarslanoglu/turkish_cities?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/c1dbe0cef353b152956e/maintainability)](https://codeclimate.com/github/sarslanoglu/turkish_cities/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/c1dbe0cef353b152956e/test_coverage)](https://codeclimate.com/github/sarslanoglu/turkish_cities/test_coverage)
+[![Protected by Hound](https://img.shields.io/badge/Protected_by-Hound-a873d1.svg)](https://houndci.com)
+[![License](https://img.shields.io/github/license/sarslanoglu/turkish_cities.svg)](https://opensource.org/licenses/MIT)
+
+**turkish_cities** is a Ruby gem which makes searching and listing Turkish cities easy. https://rubygems.org/gems/turkish_cities
+
+## Table of Contents
+* [Installation](#installation)
+* [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)
+  * [Finding plate number by city name](#finding-plate-number-by-city-name)
+  * [Finding phone code by city name](#finding-phone-code-by-city-name)
+  * [Listing all cities](#listing-all-cities)
+    * [Listing all cities with only name](#listing-all-cities-with-only-name)
+    * [Listing all cities with other parameters](#listing-all-cities-with-other-parameters)
+  * [Listing all districts of given city](#listing-all-districts-of-given-city)
+  * [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](#without-subdistrict-info)
+  * [Finding city, district and subdistrict name by postcode](#finding-city-district-and-subdistrict-name-by-postcode)
+* [Compatibility](#compatibility)
+* [Contributing](#contributing)
+* [Changelog](#changelog)
+* [Copyright](#copyright)
+
+## Installation
+
+Installation is pretty standard:
+
+```sh
+$ gem install turkish_cities
+```
+
+or with using Bundler, add this line to your Gemfile
+
+```rb
+gem 'turkish_cities'
+```
+
+and run
+
+```sh
+$ bundle
+```
+
+## Documentation
+
+With using irb just require gem and start using
+
+```rb
+require 'turkish_cities'
+```
+
+### Finding city name by plate number
+
+There are 81 cities in Turkey. By calling a plate number between 1-81 will give city_name.
+
+```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"
+TurkishCities.find_name_by_plate_number(43.0) # => "Kütahya"
+TurkishCities.find_name_by_plate_number('78') # => "Karabük"
+TurkishCities.find_name_by_plate_number(100)  # => 'Given value [100] is outside bounds of 1 to 81.'
+```
+
+### 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.
+
+```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"
+TurkishCities.find_name_by_phone_code(274.0)  # => "Kütahya"
+TurkishCities.find_name_by_phone_code('212')  # => "İstanbul"
+TurkishCities.find_name_by_phone_code(216)    # => "İstanbul"
+TurkishCities.find_name_by_phone_code(360)    # => 'Couldn't find city name with phone code 360'
+TurkishCities.find_name_by_phone_code(0)      # => 'Given value [0] is outside bounds of 212 to 488.'
+TurkishCities.find_name_by_phone_code(213)    # => 'Given value [213] must be an even number.'
+```
+
+### Finding plate number by city name
+
+City name can be given case and turkish character insensitive.
+
+```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
+TurkishCities.find_plate_number_by_name('Istanbul')   # => 34
+TurkishCities.find_plate_number_by_name('kirsehir')   # => 40
+TurkishCities.find_plate_number_by_name('falansehir') # => "Couldn't find city name with 'falansehir'"
+```
+
+### Finding phone code by city name
+
+City name can be given case and turkish character insensitive.
+
+```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
+TurkishCities.find_phone_code_by_name('Istanbul')   # => [212, 216]
+TurkishCities.find_phone_code_by_name('kirsehir')   # => 386
+TurkishCities.find_phone_code_by_name('filansehir') # => "Couldn't find city name with 'filansehir'"
+```
+
+### Listing all cities
+
+By default cities will be listed by their plate number ascending.
+
+```rb
+TurkishCities.list_cities # => ["Adana", "Adıyaman" ... "Kilis", "Osmaniye", "Düzce"]
+```
+
+### 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.
+
+```rb
+TurkishCities.list_cities({ alphabetically_sorted: true })
+# => ["Adana", "Adıyaman" ... "Yalova", "Yozgat", "Zonguldak"]
+TurkishCities.list_cities({ metropolitan_municipality: true })
+# => ["Adana", "Ankara" ... "Trabzon", "Şanlıurfa", "Van"]
+TurkishCities.list_cities({ region: 'Karadeniz' })
+# => ["Amasya", "Artvin" ... "Bartın", "Karabük", "Düzce"]
+TurkishCities.list_cities({ alphabetically_sorted: true, region: 'Karadeniz' })
+# => ["Amasya", "Artvin" ... "Tokat", "Trabzon", "Zonguldak"]
+TurkishCities.list_cities({ metropolitan_municipality: true, region: 'Karadeniz' })
+# => ["Ordu", "Samsun", "Trabzon"]
+TurkishCities.list_cities({ alphabetically_sorted: true, metropolitan_municipality: true })
+# => ["Adana", "Ankara" ... "Tekirdağ", "Trabzon", "Van"]
+```
+
+### 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.
+
+```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}]
+TurkishCities.list_cities({ with: { plate_number: true } })
+# => [{:name=>"Adana", :plate_number=>1}, {:name=>"Adıyaman", :plate_number=>2}, {:name=>"Afyon", :plate_number=>3} .
+# .. {:name=>"Osmaniye", :plate_number=>80}, {:name=>"Düzce", :plate_number=>81}]
+TurkishCities.list_cities({ metropolitan_municipality: true, region: 'Karadeniz', with: { all: true } })
+# => [{:name=>"Ordu", :plate_number=>52, :phone_code=>452, :metropolitan_municipality_since=>2012,
+#      :region=>"Karadeniz"},{:name=>"Samsun", :plate_number=>55, :phone_code=>362,
+#      :metropolitan_municipality_since=>1993, :region=>"Karadeniz"}, {:name=>"Trabzon", :plate_number=>61,
+#      :phone_code=>462, :metropolitan_municipality_since=>2012, :region=>"Karadeniz"}]
+```
+
+### Listing all districts of given city
+
+City name can be given case and turkish character insensitive. Listing of districts are alphabetically sorted.
+
+```rb
+TurkishCities.list_districts('Ankara')
+# => ["Akyurt", "Altındağ" ... "Sincan", "Şereflikoçhisar", "Yenimahalle"]
+TurkishCities.list_districts('Eskişehir')
+# => ["Alpu", "Beylikova", "Çifteler" ... "Sivrihisar", "Tepebaşı"]
+TurkishCities.list_districts('Canakkale')
+# => ["Ayvacık", "Bayramiç" ... "Lapseki", "Merkez", "Yenice"]
+TurkishCities.list_districts('Bayburt')
+# => ["Aydıntepe", "Demirözü", "Merkez"]
+TurkishCities.list_districts('Istanbul').length
+# => 39
+TurkishCities.list_districts('filansehir')
+# => "Couldn't find city name with 'filansehir'"
+```
+
+### Listing all subdistricts of given 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 subdistricts are alphabetically sorted.
+
+```rb
+TurkishCities.list_subdistricts('Adana', 'Seyhan')
+# => ["Akkapı", "Denizli" ... "Yeşiloba", "Yeşilyurt", "Ziyapaşa"]
+TurkishCities.list_subdistricts('Eskişehir', 'Odunpazarı')
+# => ["Alanönü", "Arifiye", "Büyükdere" ... "Vişnelik", "Yenikent"]
+TurkishCities.list_subdistricts('Istanbul', 'Beşiktaş')
+# => ["Abbasağa", "Akatlar", "Arnavutköy", "Bebek", "Etiler", "Gayrettepe", "Levazım", "Levent", "Ortaköy", "Türkali"]
+TurkishCities.list_subdistricts('filansehir', 'Beşiktaş')
+# => "Couldn't find district name with 'Beşiktaş' of 'filansehir'"
+TurkishCities.list_subdistricts('İstanbul', 'Kadılarköyü')
+# => "Couldn't find district name with 'Kadılarköyü' of 'İstanbul'"
+```
+
+### Listing all neighborhoods of given city and district
+
+### 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.
+
+```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')
+# => ["Büyükdere Mah", "Göztepe Mah", "Gültepe Mah", "Yıldıztepe Mah"]
+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
+
+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.
+
+```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ı')
+# => ["71 Evler Mah", "75. Yıl Osb Mah" ... "Yukarıkalabak Mah", "Yürükkaracaören Mah", "Yürükkırka Mah"]
+TurkishCities.list_neighborhoods('Istanbul', 'Beşiktaş')
+# => ["Abbasağa Mah", "Akat Mah", "Arnavutköy Mah" ... "Türkali Mah", "Ulus Mah", "Vişnezade Mah", "Yıldız Mah"]
+TurkishCities.list_neighborhoods('İstanbul', 'filanmevki')
+# => "Couldn't find district name with 'filanmevki' of 'İstanbul'"
+```
+
+### Finding city, district and subdistrict name by postcode
+
+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
+
+```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"]
+TurkishCities.find_by_postcode(34382)    # => "Couldn't find any subdistrict with postcode '34382'"
+TurkishCities.find_by_postcode('100000') # => Given value [100000] is outside bounds of 1010 to 81952.
+```
+
+## Compatibility
+
+| 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.
+
+## Contributing
+
+Contributing guidelines are available [here](CONTRIBUTING.md).
+
+## Changelog
+
+Changelog is available [here](CHANGELOG.md).
+
+## Copyright
+
+Copyright (c) 2020 Semih Arslanoglu. See [LICENSE.txt](LICENSE.txt) for
+further details.