fast-polylines 2.2.0 → 2.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0ab14d087b6992d7abec3047ad38aea4e7474f4bfff06b921ea91699bd788172
-  data.tar.gz: 4225fc53ff0801e6b145058461d9cf6d5f65be902787a7496e85c83883b52ba5
+  metadata.gz: fd26a9400977f70c17d07fbbc97484bc33fa5c2a876ec72739379b9650b00403
+  data.tar.gz: b2caa0bcaa90d269bd92b948b01ecc080c006a1304500edd1435513671a2b465
 SHA512:
-  metadata.gz: 82f43939d565a422fdf0696539f1c668d851aa88ff36d52a9f3ad2d909ebfe095c1ccd0b7266243943c834f70dc5c954c85715a3c435768df2c6ccce871443b4
-  data.tar.gz: 97ab65e7683ecbb53bf5673532e5ff99399b7f0b97b140221127b302e2d54020c1e3b1b6c174a624c49d276801b0f76089e3378cf5949b7a8fdad64494d89db0
+  metadata.gz: 7fb523730effba875e1eb7f557904bfdf11f44e419cbea433f11d29c73587b29956339075ac3b6af8f7e83de2a5b17241d93bb806f703a69f2ca81ff439fcd2a
+  data.tar.gz: 4311f966e39d44e47fd039712549466fa29a828f7470e5c33238f8997540f95327e2befd182bc79ceebfe9c5c728e001a41cd57ab7250ea80b676023a3a8913f

data/.yardopts

@@ -0,0 +1,7 @@
+--markup markdown
+--output-dir ./yardoc
+lib/**/*.rb
+ext/**/*.c
+-
+README.md
+CHANGELOG.md

data/CHANGELOG.md

@@ -13,6 +13,12 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Fixed
 
+## [2.2.2] — 2022-01-11
+
+### Added
+
+- C API documentation.
+
 ## [2.2.0] — 2020-11-24
 
 ### Added
@@ -42,7 +48,8 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - Broken behavior when approaching the chunk size limit (#16)
 
 
-[unreleased]: https://github.com/klaxit/fast-polylines/compare/v2.2.0...HEAD
+[unreleased]: https://github.com/klaxit/fast-polylines/compare/v2.2.2...HEAD
+[2.2.2]: https://github.com/klaxit/fast-polylines/compare/v2.2.0...v2.2.2
 [2.2.0]: https://github.com/klaxit/fast-polylines/compare/v2.1.0...v2.2.0
 [2.1.0]: https://github.com/klaxit/fast-polylines/compare/v2.0.1...v2.1.0
 [2.0.1]: https://github.com/klaxit/fast-polylines/compare/v2.0.0...v2.0.1

data/README.md

@@ -1,7 +1,7 @@
 # Fast Polylines
 
-[![Gem Version](https://badge.fury.io/rb/fast-polylines.svg)](https://badge.fury.io/rb/fast-polylines)
-[![Build Status](https://travis-ci.org/klaxit/fast-polylines.svg?branch=master)](https://travis-ci.org/klaxit/fast-polylines)
+[![Gem](https://img.shields.io/gem/v/fast-polylines)](https://rubygems.org/gems/fast-polylines)
+[![GitHub Workflow Status](https://img.shields.io/github/workflow/status/klaxit/fast-polylines/Continuous%20Integration)](https://github.com/klaxit/fast-polylines/actions?query=workflow%3A%22Continuous+Integration%22)
 
 Implementation of the [Google polyline algorithm][algorithm].
 

data/ext/fast_polylines/fast_polylines.c

@@ -1,3 +1,24 @@
+/**
+ * Document-module: FastPolylines
+ *
+ * Implementation of the [Google polyline algorithm](https://code.google.com/apis/maps/documentation/utilities/polylinealgorithm.html).
+ *
+ * Install it with `gem install fast-polylines`, and then:
+ *
+ *     require "fast_polylines"
+ *
+ *     FastPolylines.encode([[38.5, -120.2], [40.7, -120.95], [43.252, -126.453]])
+ *     # "_p~iF~ps|U_ulLnnqC_mqNvxq`@"
+ *
+ *     FastPolylines.decode("_p~iF~ps|U_ulLnnqC_mqNvxq`@")
+ *     # [[38.5, -120.2], [40.7, -120.95], [43.252, -126.453]]
+ *
+ * You can set an arbitrary precision for your coordinates to be encoded/decoded. It may be from 1
+ * to 13 decimal digits. However, 13 may be too much.
+ *
+ * [![https://xkcd.com/2170/](https://imgs.xkcd.com/comics/coordinate_precision.png)](https://www.explainxkcd.com/wiki/index.php/2170:_Coordinate_Precision)
+ */
+
 #include <ruby.h>
 
 // An encoded number can have at most _precision_ characters. However,
@@ -46,7 +67,15 @@ static inline uint _get_precision(VALUE value) {
 	return (uint)precision;
 }
 
-static inline VALUE
+/**
+ * call-seq:
+ *   FastPolylines.decode(polyline, precision = 5) -> [[lat, lng], ...]
+ *
+ * Decode a polyline to a list of coordinates (lat, lng tuples). You may
+ * set an arbitrary coordinate precision, however, it **must match** the precision
+ * that was used for encoding.
+ */
+static VALUE
 rb_FastPolylines__decode(int argc, VALUE *argv, VALUE self) {
 	rb_check_arity(argc, 1, 2);
 	Check_Type(argv[0], T_STRING);
@@ -103,7 +132,15 @@ _polyline_encode_number(char *chunks, int64_t number) {
 	return i;
 }
 
-static inline VALUE
+/**
+ * call-seq:
+ *   FastPolylines.encode([[lat, lng], ...], precision = 5) -> string
+ *
+ * Encode a list of coordinates to a polyline, you may give a specific precision
+ * if you want to retain more (or less) than 5 digits of precision. The maximum
+ * is 13, and may really be [too much](https://xkcd.com/2170/).
+ */
+static VALUE
 rb_FastPolylines__encode(int argc, VALUE *argv, VALUE self) {
 	rb_check_arity(argc, 1, 2);
 	Check_Type(argv[0], T_ARRAY);

data/lib/fast_polylines/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FastPolylines
-  VERSION = "2.2.0"
+  VERSION = "2.2.2"
 end

data/lib/fast_polylines.rb

@@ -3,17 +3,19 @@
 require "fast_polylines/fast_polylines"
 
 module FastPolylines::Encoder
-  module_function def encode(points, precision = 1e5)
+  # @deprecated Use {FastPolylines.encode} instead.
+  def self.encode(points, precision = 1e5)
     warn "Deprecated use of `FastPolylines::Encoder.encode`, " \
-          "use `FastPolylines.encode`."
+         "use `FastPolylines.encode`."
     FastPolylines.encode(points, Math.log10(precision))
   end
 end
 
 module FastPolylines::Decoder
-  module_function def decode(polyline, precision = 1e5)
+  # @deprecated Use {FastPolylines.decode} instead.
+  def self.decode(polyline, precision = 1e5)
     warn "Deprecated use of `FastPolylines::Decoder.decode`, " \
-          "use `FastPolylines.decode`."
+         "use `FastPolylines.decode`."
     FastPolylines.decode(polyline, Math.log10(precision))
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fast-polylines
 version: !ruby/object:Gem::Version
-  version: 2.2.0
+  version: 2.2.2
 platform: ruby
 authors:
 - Cyrille Courtière
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-11-24 00:00:00.000000000 Z
+date: 2022-01-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
@@ -62,6 +62,7 @@ extensions:
 extra_rdoc_files: []
 files:
 - ".rspec"
+- ".yardopts"
 - CHANGELOG.md
 - README.md
 - ext/fast_polylines/extconf.rb
@@ -91,12 +92,12 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
+rubygems_version: 3.2.3
 signing_key:
 specification_version: 4
 summary: Fast & easy Google polylines
 test_files:
-- spec/spec_helper.rb
 - spec/fast-polylines_spec.rb
 - spec/fast_polylines_spec.rb
+- spec/spec_helper.rb
 - ".rspec"