tokyo_metro 0.10.1

data/lib/tokyo_metro/initializer/rails.rb

@@ -0,0 +1,38 @@
+class TokyoMetro::Initializer::Rails
+
+  def set( as_for: nil )
+    raise unless as_for.instance_of?( ::String )
+    rails_dir = as_for
+    dev_dir = "#{ rails_dir }/dev"
+
+    ::TokyoMetro.module_eval do
+      # Directory of Rails application
+      const_set( :RAILS_DIR , rails_dir ) # "C:/RubyPj/rails/tokyo_metro"
+
+      # 開発のためのファイルを格納するディレクトリ
+      const_set( :DEV_DIR , dev_dir ) # "C:/RubyPj/rails/tokyo_metro/dev"
+
+      # fixture ファイルを格納するディレクトリ
+      const_set( :RAILS_FIXTURES_DIR , "#{ rails_dir }/test/fixtures" )
+
+      # HTML のディレクトリ
+      const_set( :HTML_DIR , "#{ dev_dir }/app/html" )
+
+      # HAML のディレクトリ
+      const_set( :HAML_DIR , "#{ dev_dir }/app/haml" )
+
+      # CSS のディレクトリ
+      const_set( :CSS_DIR , "#{ dev_dir }/app/assets/css" )
+
+      # SCSS のディレクトリ
+      const_set( :SCSS_DIR , "#{ dev_dir }/app/assets/scss" )
+    end
+
+    return nil
+  end
+
+  def self.consts_in_gem
+    self.new
+  end
+
+end

data/lib/tokyo_metro/modules.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Modules
+end

data/lib/tokyo_metro/modules/api.rb

@@ -0,0 +1,3 @@
+# 東京メトロ オープンデータの API から提供される情報を扱うクラスに組み込むモジュール
+module TokyoMetro::Modules::Api
+end

data/lib/tokyo_metro/modules/api/common.rb

@@ -0,0 +1,3 @@
+# 各クラスの属性を定義するメソッドなどを集めたモジュールを格納する名前空間
+module TokyoMetro::Modules::Api::Common
+end

data/lib/tokyo_metro/modules/api/common/db_dirname.rb

@@ -0,0 +1,21 @@
+# データを保存するディレクトリの情報に関するメソッドを組み込むためのモジュール
+# @note データ検索 API を利用するクラス、地理情報 API を利用するクラスに共通するクラスメソッド
+# @note {TokyoMetro::Api::MetaClass::Fundamental} に include する。
+# @note ActiveSupport::Concern を利用している。
+module TokyoMetro::Modules::Api::Common::DbDirname
+
+  extend ::ActiveSupport::Concern
+
+  module ClassMethods
+
+    private
+
+    # データを保存するディレクトリ
+    # @return [String]
+    def db_dirname
+      "#{::TokyoMetro::API_LOG_DEFAULT_DIR}/#{db_dirname_sub}"
+    end
+
+  end
+
+end

data/lib/tokyo_metro/modules/api/common/not_real_time.rb

@@ -0,0 +1,18 @@
+# リアルタイムでない情報を扱うクラスに組み込むモジュール
+# @note {TokyoMetro::Api::MetaClass::Fundamental} などに include する。
+# @note ActiveSupport::Concern を利用している。
+module TokyoMetro::Modules::Api::Common::NotRealTime
+
+  extend ::ActiveSupport::Concern
+
+  module ClassMethods
+
+    # リアルタイムな情報を扱うクラスか否かを判定するメソッド
+    # @return [Boolean]
+    def real_time_info?
+      false
+    end
+
+  end
+
+end

data/lib/tokyo_metro/modules/api/common/real_time.rb

@@ -0,0 +1,22 @@
+# リアルタイム情報のクラス属性を定義するためのモジュール
+# @note {TokyoMetro::Api::MetaClass::RealTime}, {TokyoMetro::Api::MetaClass::RealTime::List}, {TokyoMetro::Api::MetaClass::RealTime::Info} に include する。
+# @note ActiveSupport::Concern を利用している。
+module TokyoMetro::Modules::Api::Common::RealTime
+
+  extend ::ActiveSupport::Concern
+
+  if self.instance_methods( true ).include?( :real_time_info? )
+    undef :real_time_info?
+  end
+
+  module ClassMethods
+
+    # リアルタイムな情報を扱うクラスか否かを判定するメソッド
+    # @return [Boolean]
+    def real_time_info?
+      true
+    end
+
+  end
+
+end

data/lib/tokyo_metro/modules/api/info.rb

@@ -0,0 +1,3 @@
+# 各クラスに共通するインスタンスメソッドを集めたモジュールを格納する名前空間
+module TokyoMetro::Modules::Api::Info
+end

data/lib/tokyo_metro/modules/api/info/decision.rb

@@ -0,0 +1,2 @@
+module TokyoMetro::Modules::Api::Info::Decision
+end

data/lib/tokyo_metro/modules/api/info/decision/actual_starting_station.rb

@@ -0,0 +1,17 @@
+module TokyoMetro::Modules::Api::Info::Decision::ActualStartingStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::ActualStartingStation
+
+  private
+
+  # @param args [Regexp or String] 比較に使用する正規表現または文字列
+  # @param compared [String] 比較対象（include されるクラスで指定する）
+  def actually_starting?( *args , compared: self.actual_starting_stations )
+    raise if args.empty?
+    super( *args , compared )
+  end
+
+  alias :is_actually_starting? :actually_starting?
+  alias :actually_start? :actually_starting?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/actual_terminal_station.rb

@@ -0,0 +1,18 @@
+module TokyoMetro::Modules::Api::Info::Decision::ActualTerminalStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::ActualTerminalStation
+
+  private
+
+  # @param args [Regexp or String] 比較に使用する正規表現または文字列
+  # @param compared [String] 比較対象（include されるクラスで指定する）
+  # @note include されるクラス・モジュールで、super を用いるなどして上書きする。（include されるクラスにより、compared の部分が @terminal_station になったり @terminal_station_info_in_db.same_as になったりするため）
+  def actually_terminating?( *args , compared: self.actual_terminal_stations )
+    raise if args.empty?
+    super( *args , compared )
+  end
+
+  alias :is_actually_terminating? :actually_terminating?
+  alias :actually_terminate? :actually_terminating?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/arrival_station.rb

@@ -0,0 +1,15 @@
+module TokyoMetro::Modules::Api::Info::Decision::ArrivalStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::ArrivalStation
+
+  private
+
+  def arrival_at?( *args , compared: @arrival_station )
+    raise if args.empty?
+    super( *args , compared )
+  end
+
+  alias :is_arrival_at? :arrival_at?
+  alias :arrive_at? :arrival_at?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/current_station.rb

@@ -0,0 +1,12 @@
+module TokyoMetro::Modules::Api::Info::Decision::CurrentStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::CurrentStation
+
+  private
+
+  def station_same_as__is_in?( *args , compared: @station )
+    raise if args.empty?
+    super( *args , compared )
+  end
+
+end

data/lib/tokyo_metro/modules/api/info/decision/operated_section.rb

@@ -0,0 +1,55 @@
+module TokyoMetro::Modules::Api::Info::Decision::OperatedSection
+
+  # @!group 運転区間に関するメソッド
+
+  def operated_only_on_marunouchi_branch_line?
+    # marunouchi_branch_line?
+    #   and ( start_at_honancho? or start_at_nakano_fujimicho? or start_at_nakano_sakaue_on_marunouchi_branch_line? )
+    #   and ( terminate_at_honancho? or terminate_at_nakano_fujimicho? or terminate_at_nakano_sakaue_on_marunouchi_branch_line? )
+
+    marunouchi_branch_line? and start_on_marunouchi_branch_line? and terminate_on_marunouchi_branch_line?
+  end
+
+  def operated_only_on_marunouchi_branch_line_including_invalid?
+    # marunouchi_line_including_branch?
+    #   and ( start_at_honancho_including_invalid? or start_at_nakano_fujimicho_including_invalid? or start_at_nakano_sakaue_on_marunouchi_line_including_branch? )
+    #   and ( terminate_at_honancho_including_invalid? or terminate_at_nakano_fujimicho_including_invalid? or terminate_at_nakano_sakaue_on_marunouchi_line_including_branch? )
+
+    marunouchi_line_including_branch? and start_on_marunouchi_branch_line_including_invalid? and terminate_on_marunouchi_branch_line_including_invalid?
+  end
+
+  def operated_only_on_chiyoda_branch_line?
+    chiyoda_branch_line? and ( ( start_at_kita_ayase_on_chiyoda_branch_line? and terminate_at_ayase_on_chiyoda_branch_line? ) or ( start_at_ayase_on_chiyoda_branch_line? and terminate_at_kita_ayase_on_chiyoda_branch_line? ) )
+  end
+
+  def operated_only_on_chiyoda_branch_line_including_invalid?
+    ( chiyoda_line? or chiyoda_branch_line? ) and ( ( start_at_kita_ayase? and terminate_at_ayase? ) or ( start_at_ayase? and terminate_at_kita_ayase? ) )
+  end
+
+  #-------- [alias]
+  [
+    :marunouchi_branch_line ,
+    :marunouchi_branch_line_including_invalid ,
+    :chiyoda_branch_line ,
+    :chiyoda_branch_line_including_invalid
+  ].each do | method_base_name |
+    [ :only , :is_operated_only_on , :only_on , :is_only_on ].each do | prefix |
+      eval <<-ALIAS
+        alias :#{ prefix }_#{ method_base_name }? :operated_only_on_#{ method_base_name }?
+      ALIAS
+    end
+  end
+
+  def marunouchi_main_and_branch_line?
+    marunouchi_line_including_branch? and !( operated_only_on_marunouchi_branch_line? ) and ( starting_on_marunouchi_branch_line? or terminating_on_marunouchi_branch_line? ) and !( starting_at_nakano_sakaue? ) and !( terminate_at_nakano_sakaue? )
+  end
+
+  [ :is , :is_on , :is_operated_on , :operated_on , :on ].each do | prefix |
+    eval <<-ALIAS
+      alias :#{ prefix }_marunouchi_main_and_branch_line? :marunouchi_main_and_branch_line?
+    ALIAS
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/modules/api/info/decision/railway_line.rb

@@ -0,0 +1,14 @@
+module TokyoMetro::Modules::Api::Info::Decision::RailwayLine
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::RailwayLine
+
+  private
+
+  def on_the_railway_line_of?( *args , compared: @railway_line )
+    raise if args.empty?
+    super( *args , compared )
+  end
+
+  alias :is_on_the_railway_line_of? :on_the_railway_line_of?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/starting_station.rb

@@ -0,0 +1,14 @@
+module TokyoMetro::Modules::Api::Info::Decision::StartingStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::StartingStation
+
+  private
+
+  def starting?( *args , compared: @starting_station )
+    super( *args , compared )
+  end
+
+  alias :is_starting? :starting?
+  alias :start? :starting?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/terminal_station.rb

@@ -0,0 +1,21 @@
+# 行先に関するメソッドを提供するモジュール
+# @note 判定にはインスタンス変数 @terminal_station を利用する。
+module TokyoMetro::Modules::Api::Info::Decision::TerminalStation
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::TerminalStation
+
+  # 列車の行先を判定するメソッド
+  # @param list_of_train_terminal_station [::Array <::String>] 判定する駅名のリスト
+  # @return [Boolean]
+  # @note 複数指定した場合は、指定された【いずれか】の駅を行先とする列車を取得する。
+  def bound_for?( *list_of_train_terminal_station , compared: @terminal_station )
+    raise if list_of_train_terminal_station.empty?
+    super( *list_of_train_terminal_station , compared )
+  end
+
+  #-------- [alias]
+  alias :is_bound_for? :bound_for?
+  alias :is_terminating? :bound_for?
+  alias :terminate? :bound_for?
+
+end

data/lib/tokyo_metro/modules/api/info/decision/train_direction.rb

@@ -0,0 +1,24 @@
+module TokyoMetro::Modules::Api::Info::Decision::TrainDirection
+
+  # @!group 方面に関するメソッド
+
+  def direction_a?
+    /\AA/ === @train_number
+  end
+
+  def direction_b?
+    /\AB/ === @train_number
+  end
+
+  [ :a , :b ].each do | key |
+    [ "#{key}_direction?" , "#{key}_line?" , "line_#{key}?" ].each do | method_base_name |
+      eval <<-ALIAS
+        alias :#{method_base_name} :direction_#{key}?
+        alias :is_#{method_base_name} :direction_#{key}?
+      ALIAS
+    end
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/modules/api/info/decision/train_operation_day.rb

@@ -0,0 +1,21 @@
+module TokyoMetro::Modules::Api::Info::Decision::TrainOperationDay
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::TrainOperationDay
+
+  # @!group 運行日に関するメソッド
+
+  # 運行日のDBでのインスタンス
+  # @return [::OperationDay]
+  def operation_day_in_db
+    if operated_on_weekdays?
+      ::OperationDay.find_by_name_en( ::TokyoMetro::Static.operation_days.weekday.en )
+    elsif operated_on_saturdays_and_holidays?
+      ::OperationDay.find_by_name_en( ::TokyoMetro::Static.operation_days.saturday_and_holiday.en )
+    else
+      raise "Error"
+    end
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/modules/api/info/decision/train_type.rb

@@ -0,0 +1,19 @@
+module TokyoMetro::Modules::Api::Info::Decision::TrainType
+
+  include ::TokyoMetro::Modules::Common::Info::Decision::TrainType
+
+  private
+
+  def train_type_of?( *args , compared: @train_type )
+    super( *args , compared )
+  end
+
+  alias :is_train_type_of? :train_type_of?
+
+  def train_of?( *args , compared: @train_name )
+    super( *args , compared )
+  end
+
+  alias :is_train_of? :train_of?
+
+end

data/lib/tokyo_metro/modules/api/info/seed_completed.rb

@@ -0,0 +1,22 @@
+# データベースへの流し込みが終了したか否かに関するメソッドを提供するモジュール
+module TokyoMetro::Modules::Api::Info::SeedCompleted
+
+  # @!group データベース関連
+
+  # データベースへの流し込みが終了したか否かを判定するメソッド
+  # @return [Boolean]
+  def seed_completed?
+    @seed_completed
+  end
+
+  # データベースへの流し込みが終了したことを設定するメソッド
+  # @return [self]
+  # @note 破壊的メソッド
+  def seed_completed!
+    @seed_completed = true
+    return self
+  end
+
+  # @!endgroup
+
+end

data/lib/tokyo_metro/modules/api/info/set_data_to_hash.rb

@@ -0,0 +1,19 @@
+# インスタンスをハッシュに変換して返すときに使用するメソッドを集めたモジュール
+# @note インスタンスメソッドとして include する。
+module TokyoMetro::Modules::Api::Info::SetDataToHash
+
+  private
+
+  # インスタンスをハッシュに変換して返すときに、ハッシュにインスタンス変数を格納するメソッド
+  # @param h [Hash] API から取得したデータのハッシュ
+  # @param k [String or Symbol] ハッシュのキー
+  # @param v [Object] ハッシュの値
+  # @return [nil]
+  def set_data_to_hash( h , k , v )
+    if v.present?
+      h[ k ] = v
+    end
+    return nil
+  end
+
+end

data/lib/tokyo_metro/modules/api/info/to_json.rb

@@ -0,0 +1,11 @@
+# インスタンスをハッシュに変換し、さらに JSON の文字列に変換するための機能を集めたモジュール
+# @note インスタンスメソッドとして include する。
+module TokyoMetro::Modules::Api::Info::ToJson
+
+  # インスタンスをハッシュに変換し、さらに JSON の文字列に変換するメソッド
+  # @return [String (JSON)]
+  def to_json
+    self.to_h.to_s.encode( "UTF-8" )
+  end
+
+end

data/lib/tokyo_metro/modules/api/info/to_string_general.rb

@@ -0,0 +1,14 @@
+# ハッシュを出力用の文字列に変換するための機能を集めたモジュール
+# @note インスタンスメソッドとして include する。
+module TokyoMetro::Modules::Api::Info::ToStringGeneral
+
+  # インスタンスの情報を文字列にして返すメソッド
+  # @param indent [Integer (>=0)] インデントの幅
+  # @return [String]
+  def to_s( indent = 0 )
+    self.to_h.map { | key , value |
+      " " * indent + key.ljust(32) + value.to_s
+    }.join( "\n" )
+  end
+
+end