pak_cities 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 703d631879a626f87eaf0deb2824a6a71b26bcabd794a33355e830a99f8a3077
+  data.tar.gz: 9faa31649e047760a7463a34ce9be35d6878f34dba641466c57f82ba3b585103
+SHA512:
+  metadata.gz: ad546b843ea055926160181fd0b84f0e2610a3e39986ab9d5fa74cddf9fdd936ceb1904d2c42840af836ede0c5e8fb21ef3cd166c78cf43082706b16e33be12f
+  data.tar.gz: 42c1442cbdb531b1d74793b0dc1b643922feaa59e759e6d217301caf96a9c90e11fd4cf3301e8ad7c196c839b46025a6210ab105f2ac9995982626a290e6bedb

data/CHANGELOG.md

@@ -0,0 +1,55 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.0] - 2026-01-08
+
+### Added
+
+- Initial release of Pak Cities gem
+- City class with proper methods (`to_s`, `to_h`, `inspect`, `==`, `hash`)
+- Comprehensive query methods:
+  - `all` - Get all cities
+  - `count` - Total number of cities
+  - `find(name)` - Find city by name
+  - `find!(name)` - Find city or raise error
+  - `search(query)` - Fuzzy search by city name
+  - `where(conditions)` - Filter by multiple criteria
+  - `by_province(province)` - Get cities in a province
+  - `top_by_population(limit)` - Top cities by population
+  - `by_name(order:)` - Sort cities by name
+  - `by_population(order:)` - Sort cities by population
+  - `random(limit)` - Get random cities
+  - `provinces` - List all provinces
+  - `grouped_by_province` - Group cities by province
+  - `nearest_to(lat, lng, limit)` - Find nearest cities
+  - `within_bounds(...)` - Cities within bounding box
+  - `distance_between(city1, city2)` - Distance between two cities
+  - `same_province?(city1, city2)` - Check if same province
+  - `reload!` - Reload city data
+- Statistical methods:
+  - `total_population` - Sum of all populations
+  - `average_population` - Average population
+  - `median_population` - Median population
+  - `population_by_province` - Population per province
+  - `cities_count_by_province` - City count per province
+  - `largest_city` - City with largest population
+  - `smallest_city` - City with smallest population
+- Configuration system:
+  - Configurable distance units (km/miles)
+  - Configurable case sensitivity
+- Distance calculator with Haversine formula
+- Input validation for coordinates and parameters
+- Custom error classes:
+  - `CityNotFoundError`
+  - `InvalidCoordinatesError`
+  - `InvalidConfigurationError`
+- Comprehensive test suite (100 tests, 227 assertions)
+- Full RuboCop compliance
+- Support for Ruby >= 2.7.0
+- Professional documentation and README
+
+[0.1.0]: https://github.com/Talha380/pak_cities/releases/tag/v0.1.0

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders 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, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2026 Talha Razzaq
+
+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,228 @@
+# PakCities
+
+A professional Ruby gem providing comprehensive access to Pakistan cities data with powerful query methods, statistical analysis, and configurable options. Search cities by name, province, population, or find nearest cities by coordinates.
+
+[![Ruby](https://img.shields.io/badge/ruby-%3E%3D%202.7.0-ruby.svg)](https://www.ruby-lang.org/)
+[![Gem Version](https://badge.fury.io/rb/pak_cities.svg)](https://badge.fury.io/rb/pak_cities)
+
+## Features
+
+- 🔍 **Comprehensive Query Methods** - Find, search, filter cities with ease
+- 📊 **Statistical Analysis** - Population statistics, averages, medians
+- 📍 **Geographic Calculations** - Find nearest cities, calculate distances
+- ⚙️ **Configurable** - Distance units (km/miles), case sensitivity
+- 🧪 **Well Tested** - 100% test coverage with 100+ tests
+- 📝 **Professional Code** - Clean architecture, modular design
+- 🚀 **Ruby 2.7+** - Compatible with modern Ruby versions
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "pak_cities"
+```
+
+And then execute:
+
+```bash
+bundle install
+```
+
+Or install it yourself as:
+
+```bash
+gem install pak_cities
+```
+
+## Usage
+
+### Basic Queries
+
+```ruby
+require "pak_cities"
+
+PakCities.all
+PakCities.count
+
+city = PakCities.find("Karachi")
+city.name
+city.province
+city.latitude
+city.longitude
+city.population
+```
+
+### Search and Filter
+
+```ruby
+PakCities.search("Lah")
+
+PakCities.where(province: "Punjab")
+PakCities.where(min_population: 1_000_000)
+PakCities.where(max_population: 500_000)
+PakCities.where(province: "Sindh", min_population: 1_000_000)
+
+PakCities.by_province("Punjab")
+```
+
+### Population Queries
+
+```ruby
+PakCities.top_by_population
+PakCities.top_by_population(5)
+
+PakCities.by_population(order: :desc)
+PakCities.by_population(order: :asc)
+```
+
+### Sorting
+
+```ruby
+PakCities.by_name(order: :asc)
+PakCities.by_name(order: :desc)
+```
+
+### Random Selection
+
+```ruby
+PakCities.random
+PakCities.random(5)
+```
+
+### Province Operations
+
+```ruby
+PakCities.provinces
+
+PakCities.grouped_by_province
+
+PakCities.same_province?("Karachi", "Hyderabad")
+```
+
+### Geographic Queries
+
+```ruby
+PakCities.nearest_to(24.8608, 67.0104)
+PakCities.nearest_to(31.558, 74.3507, 3)
+
+PakCities.within_bounds(
+  min_lat: 24.0, max_lat: 26.0,
+  min_lng: 67.0, max_lng: 69.0
+)
+
+PakCities.distance_between("Karachi", "Lahore")
+```
+
+### Statistical Methods
+
+```ruby
+PakCities.total_population
+PakCities.average_population
+PakCities.median_population
+
+PakCities.population_by_province
+PakCities.cities_count_by_province
+
+PakCities.largest_city
+PakCities.smallest_city
+```
+
+### Configuration
+
+```ruby
+PakCities.configure do |config|
+  config.distance_unit = :miles
+  config.case_sensitive = true
+end
+
+PakCities.reset_configuration!
+```
+
+### Error Handling
+
+```ruby
+begin
+  city = PakCities.find!("NonexistentCity")
+rescue PakCities::CityNotFoundError => e
+  puts e.message
+end
+
+begin
+  PakCities.nearest_to(91, 67.0104)
+rescue PakCities::InvalidCoordinatesError => e
+  puts e.message
+end
+```
+
+## API Reference
+
+### Query Methods
+
+| Method | Description | Returns |
+|--------|-------------|---------|
+| `all` | Get all cities | Array<City> |
+| `count` | Total number of cities | Integer |
+| `find(name)` | Find city by name (case-insensitive) | City or nil |
+| `find!(name)` | Find city or raise error | City |
+| `search(query)` | Fuzzy search by city name | Array<City> |
+| `where(conditions)` | Filter by multiple criteria | Array<City> |
+| `by_province(province)` | Get cities in a province | Array<City> |
+| `top_by_population(limit)` | Top cities by population | Array<City> |
+| `by_name(order:)` | Sort cities by name | Array<City> |
+| `by_population(order:)` | Sort cities by population | Array<City> |
+| `random(limit)` | Get random cities | Array<City> |
+| `provinces` | List all provinces | Array<String> |
+| `grouped_by_province` | Group cities by province | Hash |
+| `nearest_to(lat, lng, limit)` | Find nearest cities | Array<City> |
+| `within_bounds(...)` | Cities within bounding box | Array<City> |
+| `distance_between(city1, city2)` | Distance between two cities | Float |
+| `same_province?(city1, city2)` | Check if same province | Boolean |
+| `reload!` | Reload city data | Array<City> |
+
+### Statistical Methods
+
+| Method | Description | Returns |
+|--------|-------------|---------|
+| `total_population` | Sum of all populations | Integer |
+| `average_population` | Average population | Float |
+| `median_population` | Median population | Numeric |
+| `population_by_province` | Population per province | Hash |
+| `cities_count_by_province` | City count per province | Hash |
+| `largest_city` | City with largest population | City |
+| `smallest_city` | City with smallest population | City |
+
+### Configuration Options
+
+| Option | Values | Default | Description |
+|--------|--------|---------|-------------|
+| `distance_unit` | `:km`, `:miles` | `:km` | Unit for distance calculations |
+| `case_sensitive` | `true`, `false` | `false` | Case sensitivity for searches |
+
+### City Attributes
+
+| Attribute | Type | Description |
+|-----------|------|-------------|
+| `name` | String | City name |
+| `province` | String | Province name |
+| `latitude` | Float | Geographic latitude |
+| `longitude` | Float | Geographic longitude |
+| `population` | Integer | Population (2025 estimate) |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Talha380/pak_cities. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/Talha380/pak_cities/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the PakCities project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/Talha380/pak_cities/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "minitest/test_task"
+
+Minitest::TestTask.create
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/build_output.txt

@@ -0,0 +1,19 @@
+WARNING:  See https://guides.rubygems.org/specification-reference/ for help
+ERROR:  While executing gem ... (Gem::InvalidSpecificationException)
+    ["lib/pakistan_cities.rb", "lib/pakistan_cities/city.rb", "lib/pakistan_cities/configuration.rb", "lib/pakistan_cities/data.json", "lib/pakistan_cities/distance_calculator.rb", "lib/pakistan_cities/errors.rb", "lib/pakistan_cities/query.rb", "lib/pakistan_cities/statistics.rb", "lib/pakistan_cities/validators.rb", "lib/pakistan_cities/version.rb", "pakistan_cities.gemspec", "sig/pakistan_cities.rbs"] are not files
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/specification_policy.rb:514:in 'Gem::SpecificationPolicy#error'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/specification_policy.rb:290:in 'Gem::SpecificationPolicy#validate_non_files'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/specification_policy.rb:77:in 'Gem::SpecificationPolicy#validate_required!'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/specification_policy.rb:47:in 'Gem::SpecificationPolicy#validate'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/specification.rb:2501:in 'Gem::Specification#validate'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/package.rb:298:in 'Gem::Package#build'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/package.rb:137:in 'Gem::Package.build'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/commands/build_command.rb:87:in 'Gem::Commands::BuildCommand#build_package'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/commands/build_command.rb:77:in 'Gem::Commands::BuildCommand#build_gem'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/commands/build_command.rb:68:in 'Gem::Commands::BuildCommand#execute'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/command.rb:326:in 'Gem::Command#invoke_with_build_args'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/command_manager.rb:252:in 'Gem::CommandManager#invoke_command'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/command_manager.rb:193:in 'Gem::CommandManager#process_args'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/command_manager.rb:151:in 'Gem::CommandManager#run'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/lib/ruby/site_ruby/3.4.0/rubygems/gem_runner.rb:56:in 'Gem::GemRunner#run'
+	/home/talha-razzaq/.rbenv/versions/3.4.5/bin/gem:12:in '<main>'

data/lib/pak_cities/city.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module PakCities
+  class City
+    attr_reader :name, :province, :latitude, :longitude, :population
+
+    def initialize(name:, province:, latitude:, longitude:, population:)
+      @name = name
+      @province = province
+      @latitude = latitude.to_f
+      @longitude = longitude.to_f
+      @population = population.to_i
+    end
+
+    def to_s
+      "#{name}, #{province}"
+    end
+
+    def to_h
+      {
+        name: name,
+        province: province,
+        latitude: latitude,
+        longitude: longitude,
+        population: population
+      }
+    end
+
+    def inspect
+      "#<PakCities::City name=\"#{name}\" province=\"#{province}\" " \
+        "latitude=#{latitude} longitude=#{longitude} population=#{population}>"
+    end
+
+    def ==(other)
+      other.is_a?(City) &&
+        name == other.name &&
+        province == other.province
+    end
+    alias eql? ==
+
+    def hash
+      [name, province].hash
+    end
+  end
+end

data/lib/pak_cities/configuration.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module PakCities
+  class Configuration
+    attr_accessor :case_sensitive
+    attr_reader :distance_unit
+
+    VALID_DISTANCE_UNITS = %i[km miles].freeze
+
+    def initialize
+      @distance_unit = :km
+      @case_sensitive = false
+    end
+
+    def distance_unit=(unit)
+      unit = unit.to_sym
+      unless VALID_DISTANCE_UNITS.include?(unit)
+        raise InvalidConfigurationError, "Invalid distance unit: #{unit}. Must be :km or :miles"
+      end
+
+      @distance_unit = unit
+    end
+  end
+
+  class << self
+    attr_writer :configuration
+
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    def configure
+      yield(configuration)
+    end
+
+    def reset_configuration!
+      @configuration = Configuration.new
+    end
+  end
+end