Csv-writers for all 18 GTFS files.

README.md

@@ -1,4 +1,4 @@
-# just_gtfs - header-only modern C++ GTFS parsing library
+# just_gtfs - header-only modern C++ library for reading and writing GTFS feeds
 
 [![GTFS parser for C++](https://github.com/mapsme/just_gtfs/blob/add-the-most-important-readers/docs/logo.jpeg)](https://github.com/mapsme/just_gtfs)
 
@@ -7,20 +7,23 @@
 ![](https://github.com/mapsme/just_gtfs/workflows/C%2FC%2B%2B%20CI/badge.svg)
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](https://github.com/mapsme/just_gtfs/issues)
 
+ - Fast reading and writing of GTFS feeds
+ - Supports [extended GTFS route types](https://developers.google.com/transit/gtfs/reference/extended-route-types)
  - Header-only
  - C++17
  - Tested on GCC and Clang
  - STL-compatible containers
- - Fast reading and parsing of GTFS feeds
-
+ 
 ## Table of Contents
 - [Working with GTFS feeds](#working-with-gtfs-feeds)
-- [How to use just_library](#how-to-use-it)
+- [How to use library](#how-to-use-library)
 - [Used third-party tools](#used-third-party-tools)
+- [Contributing](#contributing)
+- [Resources](#resources)
 
 ## Working with GTFS feeds
-The library implements reading static transit data in GTFS - [General Transit Feed Specification](https://developers.google.com/transit/gtfs/reference).
-It provides class for working with GTFS feeds: `gtfs::Feed`.
+The library implements reading and writing static transit data in GTFS - [General Transit Feed Specification](https://developers.google.com/transit/gtfs/reference).
+It provides main class `gtfs::Feed` for working with GTFS feeds and classes for each of 17 GTFS entities: `Route`, `Stop`, `Pathway`, `Translation` and others.
 GTFS csv files are mapped to the corresponding C++ classes. Every GTFS entity can be accessed through `gtfs::Feed`.
 
 :pushpin: Example of providing `gtfs::Feed` the feed path, reading it and working with GTFS entities such as stops and routes:
@@ -52,7 +55,7 @@ if (feed.read_shapes() == ResultCode::OK)
 ```
 
 
-## Methods for reading and writing GTFS entities
+### Methods for reading and writing GTFS entities
 Methods of the `Feed` class for working with agencies:
 
 Read agencies from the corresponding csv file.
@@ -93,6 +96,7 @@ Or you can find stop times for the particular trip:
 StopTimes get_stop_times_for_trip(const Id & trip_id, bool sort_by_sequence = true)
 ```
 
+
 ## How to use library
 - For including the library in your own project: just_gtfs is completely contained inside a single header and therefore it is sufficient to copy include/just_gtfs/just_gtfs.h to your include pathes. The library does not have to be explicitly build.
 - For running library tests:
@@ -108,3 +112,11 @@ The library makes use of the C++17 features and therefore you have to use approp
 
 ## Used third-party tools
 - [**doctest**](https://github.com/onqtam/doctest) for unit testing.
+
+## Contributing
+Please open a [Github issue](https://github.com/mapsme/just_gtfs/issues/new) with as much of the information as you're able to specify, or create a [pull request](https://github.com/mapsme/just_gtfs/pulls) according to our [guidelines](https://github.com/mapsme/just_gtfs/blob/master/docs/CPP_STYLE.md).
+
+## Resources
+[GTFS reference in Google GitHub repository](https://github.com/google/transit/blob/master/gtfs/spec/en/reference.md)
+
+[GTFS reference on Google Transit API](https://developers.google.com/transit/gtfs/reference?csw=1)

tests/data/output_feed/agency.txt

@@ -0,0 +1,3 @@
+agency_id,agency_name,agency_url,agency_timezone,agency_lang,agency_phone,agency_fare_url,agency_email
+0Id_b^3 Company,"Big Big ""Bus Company""",,,,,b3c.no,b3c@gtfs.com
+kwf,"""killer whale ferries""",,Asia/Tokyo,en,842,f@mail.com,

tests/unit_tests.cpp

@@ -151,9 +151,24 @@ TEST_CASE("Quotation marks")
   CHECK_EQ(res[4], "44.29124");
   CHECK_EQ(res[5], "1");
 }
+
+TEST_CASE("Not wrapped quotation marks")
+{
+  const auto res = CsvParser::split_record(R"(Contains "quotes", commas and text)");
+  REQUIRE_EQ(res.size(), 2);
+  CHECK_EQ(res[0], R"(Contains "quotes")");
+  CHECK_EQ(res[1], "commas and text");
+}
+
+TEST_CASE("Wrapped quotation marks")
+{
+  const auto res = CsvParser::split_record(R"("Contains ""quotes"", commas and text")");
+  REQUIRE_EQ(res.size(), 1);
+  CHECK_EQ(res[0], R"(Contains "quotes", commas and text)");
+}
 TEST_SUITE_END();
 
-TEST_SUITE_BEGIN("Read");
+TEST_SUITE_BEGIN("Read & write");
 // Credits:
 // https://developers.google.com/transit/gtfs/examples/gtfs-feed
 TEST_CASE("Empty container before parsing")
@@ -264,6 +279,11 @@ TEST_CASE("Agency")
 
   const auto agency = feed.get_agency("DTA");
   CHECK(agency);
+
+  REQUIRE_EQ(feed.write_agencies("data/output_feed"), ResultCode::OK);
+  Feed feed_copy("data/output_feed");
+  REQUIRE_EQ(feed_copy.read_agencies(), ResultCode::OK);
+  CHECK_EQ(agencies, feed_copy.get_agencies());
 }
 
 TEST_CASE("Routes")
@@ -534,3 +554,34 @@ TEST_CASE("Feed info")
 }
 
 TEST_SUITE_END();
+
+TEST_SUITE_BEGIN("Simple pipelines");
+
+TEST_CASE("Agencies create & save")
+{
+  Feed feed_for_writing;
+
+  Agency agency1;
+  agency1.agency_id = "0Id_b^3 Company";
+  agency1.agency_name = R"(Big Big "Bus Company")";
+  agency1.agency_email = "b3c@gtfs.com";
+  agency1.agency_fare_url = "b3c.no";
+
+  Agency agency2;
+  agency2.agency_id = "kwf";
+  agency2.agency_name = R"("killer whale ferries")";
+  agency2.agency_lang = "en";
+  agency2.agency_phone = "842";
+  agency2.agency_timezone = "Asia/Tokyo";
+  agency2.agency_fare_url = "f@mail.com";
+
+  feed_for_writing.add_agency(agency1);
+  feed_for_writing.add_agency(agency2);
+
+  REQUIRE_EQ(feed_for_writing.write_agencies("data/output_feed"), ResultCode::OK);
+  Feed feed_for_testing("data/output_feed");
+
+  REQUIRE_EQ(feed_for_testing.read_agencies(), ResultCode::OK);
+  CHECK_EQ(feed_for_writing.get_agencies(), feed_for_testing.get_agencies());
+}
+TEST_SUITE_END();