moscow_metro 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a3ca24e1f947f900ac557036affe46c5eabf2c1ce0e0f9d3f9c6e5ac5fd9082
-  data.tar.gz: '05229b81d7ae536c6c7187e0b012f173d48ff3678addcca1034be6ce61a0e699'
+  metadata.gz: 2586265a75c83c37b4e62f3a6a223b2ea1922f10983565a20d14fd452193a7f6
+  data.tar.gz: e4f8e90ab89d6cffb110052a8841feca9bee57cc40e36df245ddd58f684a3e65
 SHA512:
-  metadata.gz: 3704aa416a05fa18fef020923b1748e38ef379980b2c35539d9fa3b9d14103f73446d44f28eb30cc0061b21e6e048c84db0621ac4451efe29780c357544eca04
-  data.tar.gz: 56df27f3f6a3bb46d8fc09ed9a07fe424c1900056b6fd0e5052b1644820ecbf92eaf1ad90fdac123f8b15ca6854447768f4410343e65936aa0b5b91a25d1acd8
+  metadata.gz: 7cc454f5707a6fbf1cc1b70b23c559c19bc286e51790ba7c4c570a46c1d1d6fb64d90a1844ca0257027d8562c5c5c4f62591dfb54efca978ad45ea329d2bc6fe
+  data.tar.gz: d93d3d15d61f1ee20ca11bbcb57a303957bb976786ee6248d99d59ff0f15cc5d55bf68263b7cce1d90936de8ded54690b6c18a29cd511578e4b966518eeb916d

data/.travis.yml

@@ -1,6 +1,8 @@
 ---
-language: ruby
+before_install:
+  - gem install bundler
+bundler_args: --without production
 cache: bundler
-rvm:
-  - 2.6.6
-before_install: gem install bundler -v 2.1.4
+install: bundle install --jobs=3
+language: ruby
+rvm: 2.7.2

data/Changelog.md

@@ -1 +1,11 @@
 # Changelog
+
+### 0.1.8
+
+- Corrected Pry dependency in `bin/console`
+- Added helpers to query lines belonging to metro sub-systems and stations at those lines:
+
+	```ruby
+	MoscowMetro::Station.at_mck #=> Array of stations
+	MoscowMetro::Line.monorail  #=> Array of lines
+	```

data/Gemfile

@@ -1,8 +1,16 @@
+# frozen_string_literal: true
+
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in moscow_metro.gemspec
 gemspec
 
-gem "pry"
-gem "rake", "~> 13"
-gem "rspec", "~> 3"
+group :test do
+	gem "pry"
+end
+
+group :test do
+	gem "coveralls", require: false
+	gem "rake"
+	gem "rspec"
+end

data/Gemfile.lock

@@ -1,13 +1,21 @@
 PATH
   remote: .
   specs:
-    moscow_metro (0.1.6)
+    moscow_metro (0.1.7)
 
 GEM
   remote: https://rubygems.org/
   specs:
     coderay (1.1.3)
+    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.4.4)
+    docile (1.3.2)
+    json (2.3.1)
     method_source (1.0.0)
     pry (0.13.1)
       coderay (~> 1.1)
@@ -26,15 +34,27 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
+    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.26.0)
+      sync
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls
   moscow_metro!
   pry
-  rake (~> 13)
-  rspec (~> 3)
+  rake
+  rspec
 
 BUNDLED WITH
    2.1.4

data/README.md

@@ -1,16 +1,34 @@
 # MoscowMetro
 
-Список станций и линий Московского метрополитена + хелперы.
+[![Gem Version](https://badge.fury.io/rb/moscow_metro.svg)](https://badge.fury.io/rb/moscow_metro)
+[![Build Status](https://travis-ci.org/sergeypedan/moscow-metro.svg?branch=master)](https://travis-ci.org/sergeypedan/moscow-metro)
+[![Maintainability](https://api.codeclimate.com/v1/badges/379adc59603516bdbc8a/maintainability)](https://codeclimate.com/github/sergeypedan/moscow-metro/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/379adc59603516bdbc8a/test_coverage)](https://codeclimate.com/github/sergeypedan/moscow-metro/test_coverage)
+[![Coverage Status](https://coveralls.io/repos/github/sergeypedan/moscow-metro/badge.svg?branch=master)](https://coveralls.io/github/sergeypedan/moscow-metro?branch=master)
+
+Список станций и линий Московского метрополитена + хелперы.
 
 ### Актуальность данных
 
 Дата последней проверки: 1 июля 2020 г.
 
+Если гем отстал от жизни, можно написать мне в Telegram (`sergey_pedan`) или прислать PR (и лучше написать об этом в Tg).
+
+### Только метро?
+
+Есть линии и странции из:
+
+- Метрополитена
+- Большой кольцевой линии метро
+- Монорельса
+- Московского центрального кольца (МЦК)
+- Московских центральных диаметров
+
 ### Уникальность названий
 
-Названия станций не уникальны: есть Белорусская кольцевой и Замоскворецкой линии.
+Названия станций не уникальны: есть Белорусская кольцевой и Замоскворецкой линии.
 
-Возможно, выводя название станций на страницу (например, в `<select>` или в блоке адреса), вам захочется писать название линии рядом с теми станциями, которые называются одинаково, и не указывать для станций с уникальным именем. Например, «Белорусская кольцевая», но «Новокузнецкая».
+Возможно, выводя название станций на страницу (например, в `<select>` или в блоке адреса), вам захочется писать название линии рядом с теми станциями, которые называются одинаково, и не указывать для станций с уникальным именем. Например, «Белорусская кольцевая», но «Новокузнецкая».
 
 Для этих целей у станций есть свойство `name_uniq` (boolean):
 
@@ -24,7 +42,11 @@ ul
 
 ### UID линий
 
-Московский метрополитен использует некие UID для линий, мы берём его, а не придумываем свои ID. Для большинства линий это Integer, но встречаются линии с UID, состоящим из Integer и строки, как `11A`, поэтому все UID мы храним как String.
+Московский метрополитен использует некие UID для линий, мы берём его, а не придумываем свои ID. Для большинства линий это Integer, но встречаются линии с UID, состоящим из Integer и строки, как `11A`, поэтому все UID хранятся как String.
+
+### UID станций
+
+У станций пока нет UID, добавлю в ближайшем будущем.
 
 ### Корректность данных
 
@@ -37,9 +59,10 @@ ul
 - у всех станций заполнен `name_en`
 - у всех станций заполнен `color`
 - у всех станций заполнен `line_uid`
-- у всех станций заполнен `name_uniq`, и он указывает на существующую линию
+- у всех станций заполнен `name_uniq`, и он указывает на существующую линию
 - у всех станции `line_uid` указывает на какую-то конкретную линию
 
+
 ## Installation
 
 ```ruby
@@ -48,21 +71,33 @@ gem "moscow_metro"
 
 ## Usage
 
-Предполагается 2 варианта использования этого джема:
+Предполагается 3 варианта использования этого джема:
+
+### 1. Использовать данные напрямую из gem
 
-1. Использовать gem в качестве базы данных, не создавая таблиц в своей БД. Если gem отстанет от жизни, можно форкнуть или прислать PR.
-1. Хранить станции и линии в БД, а gem использовать для валидаций.
+Использовать gem в качестве источника данных, не создавая таблиц в своей БД.
 
+Для данных о станциях и линиях есть ActiveModel-подобные классы с методами поиска:
 
-### 1. Использовать gem в качестве базы данных
+```ruby
+MoscowMetro::Station.all #=> Array of stations
 
-Для данных о станциях и линиях есть ActiveModel-подобные классы с методами поиска:
+MoscowMetro::Station.at_mcd      #=> Array of stations
+MoscowMetro::Station.at_mck      #=> Array of stations
+MoscowMetro::Station.at_metro    #=> Array of stations
+MoscowMetro::Station.at_monorail #=> Array of stations
+```
 
 ```ruby
-MoscowMetro::Station.all #=> Array
-MoscowMetro::Line.all    #=> Array
+MoscowMetro::Line.all    #=> Array of lines
+
 MoscowMetro::Line.find_by_uid("11A") #=> #<struct MoscowMetro::Line::Record...>
 MoscowMetro::Line.find_by_uid("404") #=> nil
+
+MoscowMetro::Line.mcd      #=> Array of lines
+MoscowMetro::Line.mck      #=> Array of lines
+MoscowMetro::Line.metro    #=> Array of lines
+MoscowMetro::Line.monorail #=> Array of lines
 ```
 
 и attribute-readers у экземпляров:
@@ -85,7 +120,9 @@ station.name_en     #=> "Aviamotornaya" || nil
 station.name_uniq   #=> false || true
 ```
 
-### 2. Использовать gem для валидаций
+### 2. Хранить станции и линии в БД, а gem использовать для валидаций
+
+Это имеет смысл, если вы решите хранить станции и линии в БД, но не хотите хранить все существующие станции. Тогда при создании новой станции будет полезно проверять корректность имени.
 
 Например, так:
 
@@ -96,6 +133,21 @@ class Metro::Station < ActiveRecord::Base
 end
 ```
 
+### 3. Для первичного «посева» станций в БД
+
+Вы хотите хранить станции и линии в БД, и вам нужно просто их туда откуда-то записать.
+
+```ruby
+MoscowMetro::Station.all.each do |station|
+  ::Station.create!({ name_ru: station.name, name_en: station.name_en, ... })
+end
+```
+
+Также можно использовать данные прямо из YAML-файлов:
+
+- [stations.yml](https://github.com/sergeypedan/moscow-metro/blob/master/lib/db/stations.yml)
+- [lines.yml](https://github.com/sergeypedan/moscow-metro/blob/master/lib/db/lines.yml)
+
 
 ## Источники данных
 
@@ -107,7 +159,7 @@ end
 - https://en.wikipedia.org/wiki/Moscow_Metro
 - https://en.wikipedia.org/wiki/List_of_Moscow_Metro_stations
 
-### Получаем инфомацию из раскрывающегося списка метро
+На сайте mosmetro.ru есть удобный `<select>`, из которого можно скачать данные:
 
 ```js
 window.location.href = "http://mcd.mosmetro.ru/map/desktop/"
@@ -131,7 +183,7 @@ let station_objects = divs.map(div => station_object_from_div(div))
 console.table(station_objects)
 ```
 
-Получаем таблицу врое этой:
+Получаем таблицу наподобие этой:
 
  color   | name                | line_uid | uid
 :--------|:--------------------|:---------|:----
@@ -144,3 +196,5 @@ console.table(station_objects)
  #ef7e24 | Алексеевская        | 6        | 6
  #4baf4f | Алма-Атинская       | 2        | 24
  #adacac | Алтуфьево           | 9        | 1
+
+Жалко только, в названиях они не ставят букву «ё».

data/bin/console

@@ -6,9 +6,5 @@ require "moscow_metro"
 # You can add fixtures and/or initialization code here to make experimenting
 # with your gem easier. You can also use a different console, if you like.
 
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
 require "pry"
 Pry.start(__FILE__)

data/lib/moscow_metro/line.rb

@@ -1,19 +1,41 @@
 # frozen_string_literal: true
 
 module MoscowMetro
-  class Line < RecordFromYaml
+	class Line < RecordFromYaml
 
-    COLUMNS = [:color, :name, :open_year, :uid]
-    RECORDS = YAML.load_file(DB_DIR.join("lines.yml"))
-    Record  = Struct.new(*COLUMNS)
+		COLUMNS = [:color, :name, :open_year, :uid]
+		RECORDS = YAML.load_file(DB_DIR.join("lines.yml"))
+		Record  = Struct.new(*COLUMNS)
+		UIDS = {
+			mcd:      %w[D1 D2 D3 D4 D5].freeze,
+			mck:      %w[14].freeze,
+			metro:    %w[1 2 3 4 5 6 7 8 8A 9 10 11 11A 12].freeze,
+			monorail: %w[13].freeze
+		}
 
-    def self.all
-      RECORDS.map { |record_data| Record.new(*hash_values(COLUMNS, record_data)) }
-    end
+		def self.all
+			RECORDS.map { |record_data| Record.new(*hash_values(COLUMNS, record_data)) }
+		end
 
-    def self.find_by_uid(uid)
-      all.find { |line| line.uid == uid }
-    end
+		def self.find_by_uid(uid)
+			all.find { |line| line.uid == uid }
+		end
 
-  end
+		def self.mcd
+			all.select { |line| UIDS[:mck].include? line.uid }
+		end
+
+		def self.mck
+			all.select { |line| UIDS[:mck].include? line.uid }
+		end
+
+		def self.metro
+			all.select { |line| UIDS[:metro].include? line.uid }
+		end
+
+		def self.monorail
+			all.select { |line| UIDS[:monorail].include? line.uid }
+		end
+
+	end
 end

data/lib/moscow_metro/station.rb

@@ -24,5 +24,25 @@ module MoscowMetro
 			all.map(&:name).uniq
 		end
 
+		def self.at_lines(uids)
+			all.select { |station| uids.include? station.line_uid }
+		end
+
+		def self.at_mcd
+			at_lines Line::UIDS[:mck]
+		end
+
+		def self.at_mck
+			at_lines Line::UIDS[:mck]
+		end
+
+		def self.at_metro
+			at_lines Line::UIDS[:metro]
+		end
+
+		def self.at_monorail
+			at_lines Line::UIDS[:monorail]
+		end
+
 	end
 end

data/lib/moscow_metro/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module MoscowMetro
-  VERSION = "0.1.7"
+	VERSION = "0.1.8"
 end

data/moscow_metro.gemspec

@@ -1,21 +1,25 @@
+# frozen_string_literal: true
+
 require_relative 'lib/moscow_metro/version'
 
 Gem::Specification.new do |spec|
-  spec.name    = "moscow_metro"
-  spec.version = MoscowMetro::VERSION
+  spec.author      =  "Sergey Pedan"
+  spec.summary     =  "Database of lines and stations metro & metro-like train transport of Moscow"
+  spec.description =  "#{spec.summary}. Can be used as a database alongside a real database or as a source of data for further import into your database."
+  spec.email       = ["sergey.pedan@gmail.com"]
+  spec.homepage    =  "https://github.com/sergeypedan/moscow-metro"
+  spec.license     =  "MIT"
+  spec.name        =  "moscow_metro"
+  spec.version     =   MoscowMetro::VERSION
 
   spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
 
-  spec.authors  = ["Sergey Pedan"]
-  spec.email    = ["sergey.pedan@gmail.com"]
-
-  spec.summary     = %q{Database of lines and stations of Moscow metro.}
-  spec.description = %q{Database of lines and stations of Moscow metro.}
-
-  spec.homepage                      = "https://github.com/sergeypedan/moscow-metro"
-  spec.metadata["homepage_uri"]      = spec.homepage
-  spec.metadata["source_code_uri"]   = "https://github.com/sergeypedan/moscow-metro"
-  spec.metadata["changelog_uri"]     = "https://github.com/sergeypedan/moscow-metro/Changelog.md"
+  spec.metadata = {
+    "changelog_uri"     => "#{spec.homepage}/blob/master/Changelog.md",
+    "documentation_uri" => "#{spec.homepage}#usage",
+    "homepage_uri"      => spec.homepage,
+    "source_code_uri"   => spec.homepage
+  }
 
   # 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.

metadata

@@ -1,16 +1,18 @@
 --- !ruby/object:Gem::Specification
 name: moscow_metro
 version: !ruby/object:Gem::Version
-  version: 0.1.7
+  version: 0.1.8
 platform: ruby
 authors:
 - Sergey Pedan
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-12-13 00:00:00.000000000 Z
+date: 2020-12-14 00:00:00.000000000 Z
 dependencies: []
-description: Database of lines and stations of Moscow metro.
+description: Database of lines and stations metro & metro-like train transport of
+  Moscow. Can be used as a database alongside a real database or as a source of data
+  for further import into your database.
 email:
 - sergey.pedan@gmail.com
 executables:
@@ -38,11 +40,13 @@ files:
 - lib/moscow_metro/version.rb
 - moscow_metro.gemspec
 homepage: https://github.com/sergeypedan/moscow-metro
-licenses: []
+licenses:
+- MIT
 metadata:
+  changelog_uri: https://github.com/sergeypedan/moscow-metro/blob/master/Changelog.md
+  documentation_uri: https://github.com/sergeypedan/moscow-metro#usage
   homepage_uri: https://github.com/sergeypedan/moscow-metro
   source_code_uri: https://github.com/sergeypedan/moscow-metro
-  changelog_uri: https://github.com/sergeypedan/moscow-metro/Changelog.md
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -61,5 +65,5 @@ requirements: []
 rubygems_version: 3.1.4
 signing_key:
 specification_version: 4
-summary: Database of lines and stations of Moscow metro.
+summary: Database of lines and stations metro & metro-like train transport of Moscow
 test_files: []