quad_tile 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c40edff7edcbb1958d16f9bf2353ce16c8c83900cda9f3ae5d7f8be9c84a6c75
+  data.tar.gz: f09d21cf909290977fe522ba15d2b0db78364fcdfca8ac41201b5e7132a8b562
+SHA512:
+  metadata.gz: cff3d09b7bb3483fc0d7cdd2470e71c232c08bd248f4151db291329a37a6fde18f54d5e2d2564059bc7f4463a60eb39e6e9d116ba9dc8bb90108efe40b2c2c51
+  data.tar.gz: 44878ba207ea1fc0b51983b9742594f4e991102aea4fa990c67fa3586085eeb3283c77c0131ae90edddabc09a5c8c1c0a8c8f4a18075d78240d01b12120a6e5d

data/README.md

@@ -0,0 +1,57 @@
+# Quad Tile
+
+Gem bundle of native C extensions to `QuadTile` module from [openstreetmap](https://github.com/openstreetmap/openstreetmap-website)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'quad_tile'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install quad_tile
+
+## Usage
+
+This primary functions from C exposed to the `QuadTile` module in ruby are `.tile_for_point` and `tiles_for_area`.
+
+```ruby
+
+QuadTile.tile_for_point(51.0, 1.0)
+#=> 3493907048
+
+# Build an object with min_lon, min_lat, max_lon, max_lon instance varialbes. In OSM
+# this is an instance of BoundingBox
+box = BoundingBox.new(min_lon: 0.99, min_lat: 50.99, max_lon: 1.01, max_lat: 51.01)
+
+QuadTile.tiles_for_area(box)
+#=> [3493906992, 3493906993, 3493906996, 3493906997, 3493907040, 3493907041, 3493907044, 3493907045, 3493906994, 3493906995, 3493906998, 3493906999, 3493907042, 3493907043, 3493907046, 3493907047, 3493907000, 3493907001, 3493907004, 3493907005, 3493907048, 3493907049, 3493907052, 3493907053, 3493907002, 3493907003, 3493907006, 3493907007, 3493907050, 3493907051, 3493907054, 3493907055]
+
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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 tags, 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/rubyforgood/quad_tile. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [GPLv2 License](http://opensource.org/licenses/GPL-2.0).
+
+## Code of Conduct
+
+Everyone interacting in the Quad Tile project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rubyforgood/quad_tile/bextextlob/master/CODE_OF_CONDUCT.md).
+
+Made with :heart: at [Ruby for Good](https://rubyforgood.org/)

data/ext/quad_tile/extconf.rb

@@ -0,0 +1,5 @@
+require "mkmf"
+
+with_cflags("-std=c99 #{$CFLAGS}") do
+  create_makefile("quad_tile/quad_tile")
+end

data/ext/quad_tile/quad_tile.c

@@ -0,0 +1,148 @@
+#include "ruby.h"
+#include "quad_tile.h"
+
+typedef struct {
+   unsigned int *tilev;
+   unsigned int tilec;
+} tilelist_t;
+
+static tilelist_t tilelist_for_area(unsigned int minx, unsigned int miny, unsigned int maxx, unsigned int maxy)
+{
+   unsigned int x;
+   unsigned int y;
+   tilelist_t   tl;
+   unsigned int maxtilec;
+
+   maxtilec = 256;
+
+   tl.tilev = malloc(maxtilec * sizeof(unsigned int));
+   tl.tilec = 0;
+
+   for (x = minx; x <= maxx; x++)
+   {
+      for (y = miny; y <= maxy; y++)
+      {
+         if (tl.tilec == maxtilec)
+         {
+            maxtilec = maxtilec * 2;
+
+            tl.tilev = realloc(tl.tilev, maxtilec * sizeof(unsigned int));
+         }
+
+         tl.tilev[tl.tilec++] = xy2tile(x, y);
+      }
+   }
+
+   return tl;
+}
+
+static int tile_compare(const void *ap, const void *bp)
+{
+   unsigned int a = *(unsigned int *)ap;
+   unsigned int b = *(unsigned int *)bp;
+
+   if (a < b)
+   {
+      return -1;
+   }
+   else if (a > b)
+   {
+      return 1;
+   }
+   else
+   {
+      return 0;
+   }
+}
+
+static VALUE tile_for_point(VALUE self, VALUE lat, VALUE lon)
+{
+   unsigned int x = lon2x(NUM2DBL(lon));
+   unsigned int y = lat2y(NUM2DBL(lat));
+
+   return UINT2NUM(xy2tile(x, y));
+}
+
+static VALUE tiles_for_area(VALUE self, VALUE bbox)
+{
+   unsigned int minx = lon2x(NUM2DBL(rb_iv_get(bbox, "@min_lon")));
+   unsigned int maxx = lon2x(NUM2DBL(rb_iv_get(bbox, "@max_lon")));
+   unsigned int miny = lat2y(NUM2DBL(rb_iv_get(bbox, "@min_lat")));
+   unsigned int maxy = lat2y(NUM2DBL(rb_iv_get(bbox, "@max_lat")));
+   tilelist_t   tl = tilelist_for_area(minx, miny, maxx, maxy);
+   VALUE        tiles = rb_ary_new();
+   unsigned int t;
+
+   for (t = 0; t < tl.tilec; t++)
+   {
+      rb_ary_push(tiles, UINT2NUM(tl.tilev[t]));
+   }
+
+   free(tl.tilev);
+
+   return tiles;
+}
+
+static VALUE tile_for_xy(VALUE self, VALUE x, VALUE y)
+{
+   return UINT2NUM(xy2tile(NUM2UINT(x), NUM2UINT(y)));
+}
+
+static VALUE iterate_tiles_for_area(VALUE self, VALUE bbox)
+{
+   unsigned int minx = lon2x(NUM2DBL(rb_iv_get(bbox, "@min_lon")));
+   unsigned int maxx = lon2x(NUM2DBL(rb_iv_get(bbox, "@max_lon")));
+   unsigned int miny = lat2y(NUM2DBL(rb_iv_get(bbox, "@min_lat")));
+   unsigned int maxy = lat2y(NUM2DBL(rb_iv_get(bbox, "@max_lat")));
+   tilelist_t   tl = tilelist_for_area(minx, miny, maxx, maxy);
+
+   if (tl.tilec > 0)
+   {
+      unsigned int first;
+      unsigned int last;
+      unsigned int t;
+      VALUE        a = rb_ary_new();
+
+      qsort(tl.tilev, tl.tilec, sizeof(unsigned int), tile_compare);
+
+      first = last = tl.tilev[0];
+
+      for (t = 1; t < tl.tilec; t++)
+      {
+         unsigned int tile = tl.tilev[t];
+
+         if (tile == last + 1)
+         {
+            last = tile;
+         }
+         else
+         {
+            rb_ary_store(a, 0, UINT2NUM(first));
+            rb_ary_store(a, 1, UINT2NUM(last));
+            rb_yield(a);
+
+            first = last = tile;
+         }
+      }
+
+      rb_ary_store(a, 0, UINT2NUM(first));
+      rb_ary_store(a, 1, UINT2NUM(last));
+      rb_yield(a);
+   }
+
+   free(tl.tilev);
+
+   return Qnil;
+}
+
+void Init_quad_tile(void)
+{
+   VALUE m = rb_define_module("QuadTile");
+
+   rb_define_module_function(m, "tile_for_point", tile_for_point, 2);
+   rb_define_module_function(m, "tiles_for_area", tiles_for_area, 1);
+   rb_define_module_function(m, "tile_for_xy", tile_for_xy, 2);
+   rb_define_module_function(m, "iterate_tiles_for_area", iterate_tiles_for_area, 1);
+
+   return;
+}

data/lib/quad_tile/version.rb

@@ -0,0 +1,3 @@
+module QuadTile
+  VERSION = "1.0.0"
+end

data/lib/quad_tile.rb

@@ -0,0 +1,23 @@
+require "quad_tile/version"
+require "quad_tile/quad_tile"
+
+module QuadTile
+  def self.sql_for_area(bbox, prefix)
+    sql = []
+    single = []
+
+    iterate_tiles_for_area(bbox) do |first, last|
+      if first == last
+        single.push(first)
+      else
+        sql.push("#{prefix}tile BETWEEN #{first} AND #{last}")
+      end
+    end
+
+    sql.push("#{prefix}tile IN (#{single.join(',')})") unless single.empty?
+
+    "( " + sql.join(" OR ") + " )"
+  end
+
+  private_class_method :tile_for_xy, :iterate_tiles_for_area
+end

data/test/quad_tile_test.rb

@@ -0,0 +1,82 @@
+require_relative "test_helper"
+
+class QuadTileTest < Minitest::Test
+  def test_tile_for_point
+    assert_equal 3493907048, QuadTile.tile_for_point(51.0, 1.0)
+    assert_equal 3493908088, QuadTile.tile_for_point(51.1, 1.0)
+    assert_equal 3493913808, QuadTile.tile_for_point(51.1, 1.1)
+    assert_equal 1221887424, QuadTile.tile_for_point(10.0, -123.0)
+    assert_equal 2147483648, QuadTile.tile_for_point(-90.0, 0.0)
+  end
+
+  def test_tiles_for_area
+    assert_equal [3493906992, 3493906993, 3493906996, 3493906997,
+                  3493907040, 3493907041, 3493907044, 3493907045,
+                  3493906994, 3493906995, 3493906998, 3493906999,
+                  3493907042, 3493907043, 3493907046, 3493907047,
+                  3493907000, 3493907001, 3493907004, 3493907005,
+                  3493907048, 3493907049, 3493907052, 3493907053,
+                  3493907002, 3493907003, 3493907006, 3493907007,
+                  3493907050, 3493907051, 3493907054, 3493907055],
+                 QuadTile.tiles_for_area(BoundingBox.new(0.99, 50.99, 1.01, 51.01))
+    assert_equal [3493908065, 3493908068, 3493908069, 3493908080,
+                  3493908081, 3493908084, 3493908085, 3493908256,
+                  3493908067, 3493908070, 3493908071, 3493908082,
+                  3493908083, 3493908086, 3493908087, 3493908258,
+                  3493908073, 3493908076, 3493908077, 3493908088,
+                  3493908089, 3493908092, 3493908093, 3493908264,
+                  3493908075, 3493908078, 3493908079, 3493908090,
+                  3493908091, 3493908094, 3493908095, 3493908266],
+                 QuadTile.tiles_for_area(BoundingBox.new(0.99, 51.09, 1.01, 51.11))
+    assert_equal [3493913705, 3493913708, 3493913709, 3493913720,
+                  3493913721, 3493913724, 3493913725, 3493913896,
+                  3493913707, 3493913710, 3493913711, 3493913722,
+                  3493913723, 3493913726, 3493913727, 3493913898,
+                  3493913793, 3493913796, 3493913797, 3493913808,
+                  3493913809, 3493913812, 3493913813, 3493913984,
+                  3493913795, 3493913798, 3493913799, 3493913810,
+                  3493913811, 3493913814, 3493913815, 3493913986,
+                  3493913801, 3493913804, 3493913805, 3493913816,
+                  3493913817, 3493913820, 3493913821, 3493913992],
+                 QuadTile.tiles_for_area(BoundingBox.new(1.09, 51.09, 1.11, 51.11))
+    assert_equal [3509256924, 3509256925, 3509257096, 3509257097,
+                  3509257100, 3509257101, 3509257112, 3509257113,
+                  3509256926, 3509256927, 3509257098, 3509257099,
+                  3509257102, 3509257103, 3509257114, 3509257115,
+                  3509256948, 3509256949, 3509257120, 3509257121,
+                  3509257124, 3509257125, 3509257136, 3509257137,
+                  3509256950, 3509256951, 3509257122, 3509257123,
+                  3509257126, 3509257127, 3509257138, 3509257139,
+                  3509256956, 3509256957, 3509257128, 3509257129,
+                  3509257132, 3509257133, 3509257144, 3509257145],
+                 QuadTile.tiles_for_area(BoundingBox.new(9.99, -123.01, 10.01, -122.99))
+    assert_equal [1252698792, 1252698793, 1252698796, 1252698797,
+                  1252698794, 1252698795, 1252698798, 1252698799,
+                  1610612736, 1610612737, 1610612740, 1610612741,
+                  1610612738, 1610612739, 1610612742, 1610612743,
+                  1610612744, 1610612745, 1610612748, 1610612749],
+                 QuadTile.tiles_for_area(BoundingBox.new(-90.01, 0.0, -89.99, 0.01))
+  end
+
+  def test_sql_for_area
+    assert_equal "( tile BETWEEN 3493906992 AND 3493907007 OR tile BETWEEN 3493907040 AND 3493907055 )",
+                 QuadTile.sql_for_area(BoundingBox.new(0.99, 50.99, 1.01, 51.01), "")
+    assert_equal "( tile BETWEEN 3493908067 AND 3493908071 OR tile BETWEEN 3493908075 AND 3493908095"\
+                 " OR tile IN (3493908065,3493908073,3493908256,3493908258,3493908264,3493908266) )",
+                 QuadTile.sql_for_area(BoundingBox.new(0.99, 51.09, 1.01, 51.11), "")
+    assert_equal "( tile BETWEEN 3493913707 AND 3493913711 OR tile BETWEEN 3493913720 AND 3493913727"\
+                 " OR tile BETWEEN 3493913795 AND 3493913799 OR tile BETWEEN 3493913804 AND 3493913805"\
+                 " OR tile BETWEEN 3493913808 AND 3493913817 OR tile BETWEEN 3493913820 AND 3493913821"\
+                 " OR tile IN (3493913705,3493913793,3493913801,3493913896,3493913898,3493913984,3493913986,3493913992) )",
+                 QuadTile.sql_for_area(BoundingBox.new(1.09, 51.09, 1.11, 51.11), "")
+    assert_equal "( tile BETWEEN 3509256924 AND 3509256927 OR tile BETWEEN 3509256948 AND 3509256951"\
+                 " OR tile BETWEEN 3509256956 AND 3509256957 OR tile BETWEEN 3509257096 AND 3509257103"\
+                 " OR tile BETWEEN 3509257112 AND 3509257115 OR tile BETWEEN 3509257120 AND 3509257129"\
+                 " OR tile BETWEEN 3509257132 AND 3509257133 OR tile BETWEEN 3509257136 AND 3509257139"\
+                 " OR tile BETWEEN 3509257144 AND 3509257145 )",
+                 QuadTile.sql_for_area(BoundingBox.new(9.99, -123.01, 10.01, -122.99), "")
+    assert_equal "( tile BETWEEN 1252698792 AND 1252698799 OR tile BETWEEN 1610612736 AND 1610612745"\
+                 " OR tile BETWEEN 1610612748 AND 1610612749 )",
+                 QuadTile.sql_for_area(BoundingBox.new(-90.01, 0.0, -89.99, 0.01), "")
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,15 @@
+require "bundler/setup"
+require "quad_tile"
+require "minitest/autorun"
+require "minitest/pride"
+
+class BoundingBox
+  attr_reader :min_lon, :min_lat, :max_lon, :max_lat
+
+  def initialize(min_lon, min_lat, max_lon, max_lat)
+    @min_lon = min_lon.to_f unless min_lon.nil?
+    @min_lat = min_lat.to_f unless min_lat.nil?
+    @max_lon = max_lon.to_f unless max_lon.nil?
+    @max_lat = max_lat.to_f unless max_lat.nil?
+  end
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: quad_tile
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Benjamin Reynolds
+- Tom Hughes
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-06-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- breyno127@gmail.com
+- tom@compton.nu
+executables: []
+extensions:
+- ext/quad_tile/extconf.rb
+extra_rdoc_files: []
+files:
+- README.md
+- ext/quad_tile/extconf.rb
+- ext/quad_tile/quad_tile.c
+- lib/quad_tile.rb
+- lib/quad_tile/version.rb
+- test/quad_tile_test.rb
+- test/test_helper.rb
+homepage: https://github.com/openstreetmap/quad_tile
+licenses:
+- GPL-2.0
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: native implementation of osm quad_tile functions
+test_files: []