gtfs_stops_clustering 0.1.2 → 0.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32c396f8f9377660da84a4b29d78657e23efcfefe01e6d05368894dd1ffbf07d
-  data.tar.gz: 42f3961fb4a896fb3f25c3f113672a0ac8894d74458270bfce2fef82f5e50e11
+  metadata.gz: bd1d3d49ce47faac98cf22d674adab3d37d0afc1a0b7b55ecba36fe5cde3bac3
+  data.tar.gz: 3b6572e53a4268c2e8def8dd80e8605768e425dd05570827822b80ce0448a100
 SHA512:
-  metadata.gz: 197ec5fb775f93c61c1207392bb2b0a136c09b61572327d2855b9f0c73bf1dc94f552b6665d842a757c20e06248692001ff013c23407e3bc94ed7a024ca5dbd0
-  data.tar.gz: 88c0c3d4106abf305d0ac7a4196a6612f40745bf2632ffadab32673d3fb60f04800a2d4de44027fa9fb4a3c8c03db206881dccc91505fb15e48253e56e85952c
+  metadata.gz: a7f35b9d4c35f638b5baac0fa384f50e44db4ef1a20cfc119c74c184b1d900c1207704c1503094fb85c63ea84c9acf283c4cb33e8e7efa7ae13aa5d18e5d5d67
+  data.tar.gz: 6b5c325393774c7f926891445c09f82eda11fbdb1b5528942e31284f2c5c946ceada56aabe82911a8167956a933ffce1ec17fb599a71ace3853e24dcbec059a9

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.6
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 140

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-12-06
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# 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, 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 e-mail 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 visconti373@gmail.com. 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.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Visco01
+
+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,39 @@
+# GtfsStopsClustering
+
+TODO: Delete this and the text below, and describe your gem
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/gtfs_stops_clustering`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+## Installation
+
+TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install UPDATE_WITH_YOUR_GEM_NAME_PRIOR_TO_RELEASE_TO_RUBYGEMS_ORG
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. 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/[USERNAME]/gtfs_stops_clustering. 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/[USERNAME]/gtfs_stops_clustering/blob/main/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 GtfsStopsClustering project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/gtfs_stops_clustering/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/gtfs_stops_clustering.gemspec

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+require_relative "lib/gtfs_stops_clustering/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "gtfs_stops_clustering"
+  spec.version = GtfsStopsClustering::VERSION
+  spec.authors = ["Pietro Visconti"]
+  spec.email = ["pietro.visconti2001@gmail.com"]
+
+  spec.summary = "A gem to read GTFS stops data and create clusters based on coordinates and stop names' similarities."
+  spec.description = "A gem to read GTFS stops data and create clusters based on coordinates and stop names' similarities."
+  spec.homepage = "https://github.com/Visco01/gtfs_stops_clustering"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.6.0"
+
+  # spec.metadata["allowed_push_host"] = "TODO: Set to your gem server 'https://example.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = spec.homepage
+  spec.metadata["changelog_uri"] = "https://github.com/Visco01/gtfs_stops_clustering/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (File.expand_path(f) == __FILE__) ||
+        f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # spec.files = ["lib/gtfs_stops_clustering.rb", "lib/gtfs_stops_clustering/data_import.rb", "lib/gtfs_stops_clustering/dbscan.rb",
+  #               "lib/gtfs_stops_clustering/redis_geodata.rb", "lib/gtfs_stops_clustering/version.rb",
+  #               "lib/gtfs_stops_clustering/input_consistency_checks.rb"]
+
+  spec.add_runtime_dependency "csv", "~> 3.2", ">= 3.2.8"
+  spec.add_runtime_dependency "distance_measures", "~> 0.0.6"
+  spec.add_runtime_dependency "geocoder", "~> 1.8", ">= 1.8.2"
+  spec.add_runtime_dependency "gtfs", "~> 0.4.1"
+  spec.add_runtime_dependency "redis", "~> 5.0", ">= 5.0.8"
+  spec.add_runtime_dependency "text", "~> 1.3", ">= 1.3.1"
+
+  spec.add_development_dependency "minitest", "~> 5.20"
+  spec.add_development_dependency "pry", "~> 0.14.2"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/gtfs_stops_clustering/data_import.rb

@@ -1,12 +1,15 @@
+# frozen_string_literal: true
+
 # lib/data_import.rb
 
-require 'csv'
-require 'gtfs'
+require "csv"
+require "gtfs"
 
+# DataImport module
 module DataImport
-  VERSION='0.0.1'
   attr_accessor :data_import
 
+  # DataImport class
   class DataImport
     attr_accessor :stops, :stops_config_file, :stops_names, :stops_corner_cases, :stops_data, :stops_redis_geodata
 
@@ -22,13 +25,13 @@ module DataImport
     end
 
     def import_stops_corner_cases
-      if File.exist?(@stops_config_file)
-        CSV.foreach(@stops_config_file, headers: true) do |row|
-          stop_name = row['stop_name']
-          cluster_name = row['cluster_name']
+      return unless File.exist?(@stops_config_file)
+
+      CSV.foreach(@stops_config_file, headers: true) do |row|
+        stop_name = row["stop_name"]
+        cluster_name = row["cluster_name"]
 
-          stops_corner_cases << { stop_name: stop_name, cluster_name: cluster_name }
-        end
+        stops_corner_cases << { stop_name: stop_name, cluster_name: cluster_name }
       end
     end
 
@@ -38,13 +41,20 @@ module DataImport
         longitude = row.lon
         stop_name = row.name
 
-        stop_name = @stops_corner_cases.find { |entry| entry[:stop_name] == stop_name }[:cluster_name] if stops_corner_cases.find { |entry| entry[:stop_name] == stop_name }
+        stop_name = stop_name_from_corner_cases(stop_name)
 
         @stops_names << stop_name
         @stops_data << [latitude, longitude]
         @stops_redis_geodata << [longitude, latitude, "#{longitude},#{latitude}"]
       end
     end
+
+    def stop_name_from_corner_cases(stop_name)
+      csv_entry = @stops_corner_cases.find do |entry|
+        entry[:stop_name] == stop_name
+      end
+      csv_entry.nil? ? stop_name : csv_entry[:cluster_name]
+    end
   end
 
   def import_stops_data(*args)
@@ -56,5 +66,3 @@ module DataImport
     }
   end
 end
-
-include DataImport

data/lib/gtfs_stops_clustering/dbscan.rb

@@ -1,33 +1,45 @@
-## https://github.com/shiguodong/dbscan (fork)
+# lib/gtfs_stops_clustering/dbscan.rb
 
-require 'distance_measures'
-require 'text'
-require 'geocoder'
-require_relative 'redis_geodata'
+require "distance_measures"
+require "text"
+require "geocoder"
+require_relative "redis_geodata"
 
+# Array class
 class Array
-  def haversine_distance2(n)
-    Geocoder::Calculations.distance_between(self, n)
+  def haversine_distance2(other)
+    Geocoder::Calculations.distance_between(self, other)
   end
 end
 
+# DBSCAN module
 module DBSCAN
+  # Clusterer class
   class Clusterer
+    include RedisGeodata
     attr_accessor :points, :options, :clusters
 
     def initialize(points, stops_redis_geodata, options = {})
       options[:distance] = :euclidean_distance unless options[:distance]
       options[:labels] = [] unless options[:labels]
 
-      c = 0
       redis_geodata_import(stops_redis_geodata, options[:epsilon])
-      @points = points.map { |e| po = Point.new(e, options[:labels][c]); c +=1; po }
       @options = options
-      @clusters = {-1 => []}
+      init_points(points)
+      @clusters = { -1 => [] }
 
       clusterize!
     end
 
+    def init_points(points)
+      c = 0
+      @points = points.map do |e|
+        po = Point.new(e, @options[:labels][c])
+        c += 1
+        po
+      end
+    end
+
     def clusterize!
       current_cluster = -1
       @points.each do |point|
@@ -49,10 +61,10 @@ module DBSCAN
           # Get Cluster Position
           cluster_pos = find_cluster_position(clusters[current_cluster])
 
-          clusters[current_cluster].each { |e|
+          clusters[current_cluster].each do |e|
             e.cluster_name = cluster_name
             e.cluster_pos = cluster_pos
-          }
+          end
         else
           clusters[-1].push(point)
         end
@@ -91,9 +103,11 @@ module DBSCAN
       neighbors = []
       geosearch_results = geosearch(point.items[1], point.items[0])
       geosearch_results.each do |neighbor_pos|
-        coordinates = neighbor_pos.split(',')
-        neighbor = @points.find { |point| point.items[0] == coordinates[1] &&
-                                  point.items[1] == coordinates[0] }
+        coordinates = neighbor_pos.split(",")
+        neighbor = @points.find do |elem|
+          elem.items[0] == coordinates[1] &&
+            elem.items[1] == coordinates[0]
+        end
         next unless neighbor
 
         string_distance = Text::Levenshtein.distance(point.label.downcase, neighbor.label.downcase)
@@ -112,9 +126,7 @@ module DBSCAN
 
           if new_points.size >= options[:min_points]
             new_points.each do |p|
-              unless neighbors.include?(p)
-                neighbors.push(p)
-              end
+              neighbors.push(p) unless neighbors.include?(p)
             end
           end
         end
@@ -127,32 +139,31 @@ module DBSCAN
 
       cluster_points
     end
-  end
 
-  def find_cluster_name(labels)
-    words = labels.map { |label| label.strip.split }
-    common_title = ''
+    def find_cluster_name(labels)
+      words = labels.map { |label| label.strip.split }
+      common_title = ""
 
-    # Loop through each word index starting from the first
-    (0...words.first.length).each do |i|
-      words_at_index = words.map { |word_list| word_list[i] }
+      # Loop through each word index starting from the first
+      (0...words.first.length).each do |i|
+        words_at_index = words.map { |word_list| word_list[i] }
 
-      break unless words_at_index.uniq.length == 1
+        break unless words_at_index.uniq.length == 1
 
-      common_title += " #{words_at_index.first.capitalize}"
-    end
-
-    common_title.strip! ? common_title : labels.first
-  end
+        common_title += " #{words_at_index.first.capitalize}"
+      end
 
-  def find_cluster_position(cluster)
-    total_lat = cluster.map { |e| e.items[0].to_f }.sum
-    total_lon = cluster.map { |e| e.items[1].to_f }.sum
-    avg_lat = total_lat / cluster.size
-    avg_lon = total_lon / cluster.size
-    [avg_lat, avg_lon]
+      common_title.strip! ? common_title : labels.first
+    end
+    def find_cluster_position(cluster)
+      total_lat = cluster.map { |e| e.items[0].to_f }.sum
+      total_lon = cluster.map { |e| e.items[1].to_f }.sum
+      avg_lat = total_lat / cluster.size
+      avg_lon = total_lon / cluster.size
+      [avg_lat, avg_lon]
+    end
   end
-
+  # Point class
   class Point
     attr_accessor :items, :cluster, :visited, :label, :cluster_name, :cluster_pos
 
@@ -176,5 +187,3 @@ module DBSCAN
     clusterer.labeled_results
   end
 end
-
-include DBSCAN

data/lib/gtfs_stops_clustering/input_consistency_checks.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+# lib/input_consistency_checks.rb
+
+# InputConsistencyChecks module
+module InputConsistencyChecks
+  # InputConsistencyChecks class
+  class InputConsistencyChecks
+    attr_accessor :gtfs_paths, :epsilon, :min_points, :names_similarity, :stops_config_path
+
+    def initialize(gtfs_paths, epsilon, min_points, names_similarity, stops_config_path)
+      @gtfs_paths = gtfs_paths
+      @stops_config_path = stops_config_path
+      @epsilon = epsilon
+      @min_points = min_points
+      @names_similarity = names_similarity
+      input_consistency_checks
+    end
+
+    def input_consistency_checks
+      gtfs_paths_check
+      epsilon_check
+      min_points_check
+      names_similarity_check
+    end
+
+    def gtfs_paths_check
+      raise ArgumentError, "gtfs_paths cannot be nil" if @gtfs_paths.nil?
+      raise ArgumentError, "gtfs_paths must be an Array" unless @gtfs_paths.is_a?(Array)
+      raise ArgumentError, "gtfs_paths must not be empty" if @gtfs_paths.empty?
+    end
+
+    def epsilon_check
+      raise ArgumentError, "epsilon must be a Float" unless @epsilon.is_a?(Float)
+      raise ArgumentError, "epsilon must be greater than 0" if @epsilon.negative?
+    end
+
+    def min_points_check
+      raise ArgumentError, "min_points must be an Integer" unless @min_points.is_a?(Integer)
+      raise ArgumentError, "min_points must be greater than 0" if @min_points.negative?
+    end
+
+    def names_similarity_check
+      raise ArgumentError, "names_similarity must be a Float" unless @names_similarity.is_a?(Float)
+      raise ArgumentError, "names_similarity must be between 0 and 1" if @names_similarity.negative? || @names_similarity > 1
+    end
+  end
+
+  def input_consistency_checks(gtfs_paths, epsilon, min_points, names_similarity, stop_config_path)
+    @input_consistency_checks = InputConsistencyChecks.new(gtfs_paths, epsilon, min_points, names_similarity, stop_config_path)
+  end
+end

data/lib/gtfs_stops_clustering/redis_geodata.rb

@@ -1,29 +1,38 @@
-# lib/redis_geodata.rb
-require 'redis'
+# frozen_string_literal: true
 
+# lib/gtfs_stops_clustering/redis_geodata.rb
+
+require "redis"
+
+# RedisGeodata module
 module RedisGeodata
-  VERSION='0.0.1'
   attr_accessor :redis
 
+  # RedisGeodata class
   class RedisGeodata
     attr_accessor :stops, :key, :redis, :epsilon
 
     def initialize(stops, epsilon)
-      @redis = Redis.new(url: 'redis://127.0.0.1:6379')
+      begin
+        @redis = Redis.new(url: "redis://127.0.0.1:6379")
+      rescue Redis::CannotConnectError => e
+        raise RuntimeError "Error occurred while connecting to Redis: #{e.message}"
+      end
       @stops = stops
-      @key = 'stops'
+      @key = "stops"
       @epsilon = epsilon
       geoadd
     end
 
     def geoadd
+      @redis.del(@key)
       @redis.geoadd(@key, *@stops)
       @redis.expire(@key, 100_000_0)
     end
 
     def geosearch(longitude, latitude)
-      list = @redis.georadius(@key, longitude, latitude, @epsilon, 'km')
-      list.reject! { |point| point == longitude.to_s + "," + latitude.to_s }
+      list = @redis.georadius(@key, longitude, latitude, @epsilon, "km")
+      list.reject! { |point| point == "#{longitude},#{latitude}" }
       list
     end
   end
@@ -36,5 +45,3 @@ module RedisGeodata
     @redis.geosearch(*args)
   end
 end
-
-include RedisGeodata

data/lib/gtfs_stops_clustering/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GtfsStopsClustering
-  VERSION = "0.1.2"
+  VERSION = "0.1.4"
 end

data/lib/gtfs_stops_clustering.rb

@@ -1,47 +1,66 @@
-#!/usr/bin/env ruby
+# frozen_string_literal: true
+
 # lib/gtfs_stops_clustering.rb
-require 'rubygems'
-require 'bundler/setup'
+
+require "rubygems"
+require "bundler/setup"
 require_relative "gtfs_stops_clustering/version"
-require 'gtfs'
-require 'csv'
-require_relative './gtfs_stops_clustering/data_import'
-require_relative './gtfs_stops_clustering/dbscan'
+require "gtfs"
+require "csv"
+require_relative "./gtfs_stops_clustering/data_import"
+require_relative "./gtfs_stops_clustering/dbscan"
+require_relative "./gtfs_stops_clustering/input_consistency_checks"
 
+# GtfsStopClustering module
 module GtfsStopsClustering
-  VERSION = GtfsStopsClustering::VERSION
   attr_accessor :gtfs_stops_clustering
 
+  # GtfsStopsClustering class
   class GtfsStopsClustering
-    attr_accessor :clusters, :gtfs_urls, :gtfs_stops, :stops_config_path, :epsilon, :min_points, :names_similarity
+    include InputConsistencyChecks
+    include DataImport
+    include DBSCAN
+    attr_accessor :clusters, :gtfs_paths, :gtfs_stops, :stops_config_path, :epsilon, :min_points, :names_similarity
 
-    def initialize(gtfs_urls, epsilon, min_points, names_similarity, stops_config_path)
+    def initialize(gtfs_paths, epsilon, min_points, names_similarity, stops_config_path)
+      @gtfs_paths = gtfs_paths
+      @stops_config_path = stops_config_path
+      @epsilon = epsilon
+      @min_points = min_points
+      @names_similarity = names_similarity
+      input_consistency_checks(@gtfs_paths, @epsilon, @min_points, @names_similarity, @stops_config_path)
       @clusters = []
-      unless gtfs_urls.empty?
-        @gtfs_paths = gtfs_urls
-        @stops_config_path = stops_config_path
-        @epsilon = epsilon
-        @min_points = min_points
-        @names_similarity = names_similarity
-        @gtfs_stops = create_stops_merged
-        clusterize_stops_csv(@gtfs_stops)
-      end
+      @gtfs_stops = create_stops_merged
+      clusterize_stops
     end
 
     def create_stops_merged
       gtfs_stops = []
       @gtfs_paths.each do |gtfs_path|
-        gtfs = GTFS::Source.build(gtfs_path)
-        gtfs_stops << gtfs.stops
+        begin
+          gtfs = GTFS::Source.build(gtfs_path)
+          gtfs_stops << gtfs.stops
+        rescue GTFS::InvalidSourceException => e
+          raise IOError "Error occurred while building GTFS from #{gtfs_path}: #{e.message}"
+        end
       end
       gtfs_stops.flatten
     end
 
-    def clusterize_stops_csv(stops_merged)
-      data = import_stops_data(stops_merged, @stops_config_path)
-      @clusters = DBSCAN( data[:stops_data], data[:stops_redis_geodata], :epsilon => @epsilon, :min_points => @min_points, :similarity => @names_similarity, :distance => :haversine_distance2, :labels => data[:stops_names] )
+    def clusterize_stops
+      data = import_stops_data(@gtfs_stops, @stops_config_path)
+      @clusters = DBSCAN(data[:stops_data],
+                         data[:stops_redis_geodata],
+                         epsilon: @epsilon,
+                         min_points: @min_points,
+                         similarity: @names_similarity,
+                         distance: :haversine_distance2,
+                         labels: data[:stops_names])
+      map_clustered_stops
+    end
 
-      @clusters.each do |cluster_id, cluster|
+    def map_clustered_stops
+      @clusters.each_value do |cluster|
         cluster.each do |stop|
           gtfs_stop = @gtfs_stops.find { |e| e.lat == stop[:stop_lat] && e.lon == stop[:stop_lon] }
           stop[:stop_id] = gtfs_stop.id
@@ -49,24 +68,11 @@ module GtfsStopsClustering
           stop[:parent_station] = gtfs_stop.parent_station
         end
       end
-
-      output_path = 'stop_clusters.txt'
-      File.open(output_path, 'w') do |file|
-        @clusters.each do |cluster_id, cluster |
-          file.puts "Cluster #{cluster_id}"
-          cluster.each do |point|
-            file.puts point.inspect
-          end
-          file.puts
-        end
-      end
     end
   end
 
-  def build(gtfs_urls, epsilon, min_points, names_similarity = 1, stop_config_path = '')
-    @gtfs_stops_clustering = GtfsStopsClustering.new(gtfs_urls, epsilon, min_points, names_similarity, stop_config_path)
+  def build_clusters(gtfs_paths, epsilon, min_points, names_similarity = 1, stop_config_path = "")
+    @gtfs_stops_clustering = GtfsStopsClustering.new(gtfs_paths, epsilon, min_points, names_similarity, stop_config_path)
     @gtfs_stops_clustering.clusters
   end
 end
-
-include GtfsStopsClustering

data/lib/stops_corner_cases.txt

@@ -0,0 +1,3 @@
+stop_name,cluster_name
+Example Stop Name,Corrected Stop Name
+Placeholder,Corrected Placeholder

data/sig/gtfs_stops_clustering.rbs

@@ -0,0 +1,4 @@
+module GtfsStopsClustering
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -1,29 +1,35 @@
 --- !ruby/object:Gem::Specification
 name: gtfs_stops_clustering
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
 platform: ruby
 authors:
-- Visco01
+- Pietro Visconti
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-12-07 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: gtfs
+  name: csv
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: '3.2'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.2.8
 - !ruby/object:Gem::Dependency
   name: distance_measures
   requirement: !ruby/object:Gem::Requirement
@@ -39,85 +45,107 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 0.0.6
 - !ruby/object:Gem::Dependency
-  name: text
+  name: geocoder
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '1.8'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.1
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
-  name: geocoder
+  name: gtfs
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 0.4.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.8'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.2
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
-  name: csv
+  name: redis
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 5.0.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.2'
+        version: '5.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 3.2.8
+        version: 5.0.8
 - !ruby/object:Gem::Dependency
-  name: redis
+  name: text
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.8
+        version: 1.3.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '1.3'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.8
+        version: 1.3.1
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.20'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.14.2
 description: A gem to read GTFS stops data and create clusters based on coordinates
   and stop names' similarities.
 email:
@@ -126,11 +154,21 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- gtfs_stops_clustering.gemspec
 - lib/gtfs_stops_clustering.rb
 - lib/gtfs_stops_clustering/data_import.rb
 - lib/gtfs_stops_clustering/dbscan.rb
+- lib/gtfs_stops_clustering/input_consistency_checks.rb
 - lib/gtfs_stops_clustering/redis_geodata.rb
 - lib/gtfs_stops_clustering/version.rb
+- lib/stops_corner_cases.txt
+- sig/gtfs_stops_clustering.rbs
 homepage: https://github.com/Visco01/gtfs_stops_clustering
 licenses:
 - MIT