mysql_point 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: dc2612e36becbac4abe561f588e43c3772f19428
+  data.tar.gz: 86a04677384baeabdca0ea45168f550b0ca85a3e
+SHA512:
+  metadata.gz: a0d08140c94000a0506b7c113e11af236baa128dc1d1f41786464d039bc7a5ba6caf7f0dd850fc7741765eec40ce1f388522553fcbb1f953d7010ca78a1153c1
+  data.tar.gz: 647e13ac125c70d452b4313fbadb0efa898e2001ed1ffd73a73a6d061bd366c88f5a973cb0c7434d24212c3ce46cced363b92923c09062e95c287ddb4b1130ae

data/.circleci/config.yml

@@ -0,0 +1,16 @@
+version: 2
+
+jobs:
+  build:
+    working_directory: ~/mysql_point
+    docker:
+      - image: circleci/ruby:2.3
+        environment:
+          DATABASE_URL: mysql2://root@127.0.0.1/circle_test
+      - image: circleci/mysql:5.7
+
+    steps:
+      - checkout
+      - run: bundle install
+      - run: echo $DATABASE_URL
+      - run: appraisal rake test

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+gemfiles/*.gemfile.lock

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: gem install bundler -v 1.15.1-lance

data/Appraisals

@@ -0,0 +1,7 @@
+appraise 'activerecord-5.0' do
+  gem 'activerecord', '~> 5.0'
+end
+
+appraise 'activerecord-5.1' do
+  gem 'activerecord', '~> 5.1'
+end

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lance@cainlevy.net. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in mysql_point.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Lance Ivy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,87 @@
+# MySQLPoint
+
+Provides basic ActiveRecord support for MySQL `point` fields. This becomes useful in MySQL 5.7.6, which adds [`ST_DISTANCE_SPHERE`](https://dev.mysql.com/doc/refman/5.7/en/spatial-convenience-functions.html#function_st-distance-sphere) for practical distance-between-points-on-Earth calculations.
+
+## Features
+
+Included:
+
+* migrations
+* schema dumping and loading
+* reading and writing from database
+* a Ruby struct
+* ActiveModel validator for Earth coordinates
+
+Future scope:
+
+* ARel helper to find records near a static location
+
+Never in scope:
+
+* full `geometry` field support in MySQL
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'mysql_point'
+```
+
+## Usage
+
+**Migrating**
+
+```ruby
+class MyMigration < ActiveRecord::Migration
+  def change
+    create_table :public_water_fountains do |t|
+      t.point 'location', null: false
+      t.timestamps
+    end
+  end
+end
+```
+
+**Validating**
+
+```ruby
+class PublicWaterFountain
+  validates :location, coordinate: true
+end
+```
+
+**Setting**
+
+```ruby
+# scalar values can be passed in WKT format, with longitude in first position
+PublicWaterFountain.new(location: 'POINT(-73.9635288 40.7812022)')
+
+# structured values can be passed as a MySQLPoint::Coordinate
+PublicWaterFountain.new(
+  location: MySQLPoint::Coordinate(longitude: -73.9635288, latitude: 40.7812022)
+)
+```
+
+**Querying**
+
+```sql
+-- all public water fountains within 5 miles of Central Park
+SELECT *
+FROM public_water_fountains
+WHERE ST_DISTANCE_SPHERE(location, POINT(-73.9675438, 40.7828687)) * 0.000621371 < 5
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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/empaticoorg/mysql_point. 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.
+
+## Code of Conduct
+
+Everyone interacting in the MySQLPoint project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/empaticoorg/mysql_point/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,10 @@
+require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task default: :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'mysql_point'
+
+# 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 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gemfiles/activerecord_5.0.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.0"
+
+gemspec path: "../"

data/gemfiles/activerecord_5.1.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activerecord", "~> 5.1"
+
+gemspec path: "../"

data/lib/coordinate_validator.rb

@@ -0,0 +1,10 @@
+class CoordinateValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    return if value.respond_to?(:latitude) &&
+              (-90..90).cover?(value.latitude) &&
+              value.respond_to?(:longitude) &&
+              (-180..180).cover?(value.longitude)
+
+    record.errors.add(attribute, options[:message] || :invalid)
+  end
+end

data/lib/mysql_point.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+
+module MySQLPoint
+end
+
+require_relative 'mysql_point/version'
+require_relative 'mysql_point/coordinate'
+require_relative 'coordinate_validator'
+
+# enables column type in ActiveRecord
+require_relative 'mysql_point/type'
+ActiveRecord::Base.connection.type_map.register_type(/^point/, MySQLPoint::Type.new)
+
+# enables a Coordinate to be sent as WKT and converted by a MySQL function on insert/update
+require_relative 'mysql_point/quoting'
+ActiveRecord::Base.connection.class.prepend MySQLPoint::Quoting
+
+# enables shorthand syntax in migrations and db/schema.rb
+require_relative 'mysql_point/column_method'
+ActiveRecord::ConnectionAdapters::MySQL::TableDefinition.include MySQLPoint::ColumnMethod
+ActiveRecord::ConnectionAdapters::MySQL::Table.include MySQLPoint::ColumnMethod
+
+# enables schema dumping into migration syntax
+ActiveRecord::ConnectionAdapters::AbstractMysqlAdapter::NATIVE_DATABASE_TYPES[:point] = {
+  name: 'point'
+}

data/lib/mysql_point/column_method.rb

@@ -0,0 +1,5 @@
+module MySQLPoint::ColumnMethod
+  def point(*args, **options)
+    args.each{|name| column(name, :point, options) }
+  end
+end

data/lib/mysql_point/coordinate.rb

@@ -0,0 +1,46 @@
+# A struct for latitude/longitude coordinates, with serializers and deserializers for the standard
+# WKT and WKB formats.
+#
+# # WKT
+#
+# `POINT(<longitude> <latitude>)`
+#
+# # WKB
+#
+# * byte 0: byte order (little endian is 01)
+# * bytes 1-4: WKB type (point is 01)
+# * bytes 5-12: X coordinate (longitude)
+# * bytes 13-21: Y coordinate (latitude)
+class MySQLPoint::Coordinate
+  # POINT(<longitude> <latitude>)
+  def self.from_wkt(str)
+    md = str.match(/\APOINT\((-?[0-9.]*) (-?[0-9.]*)\)\z/)
+    new(longitude: md[1], latitude: md[2]) if md
+  end
+
+  def self.from_wkb(binstr)
+    type = binstr[1, 4].unpack(binstr[0] == "\x01" ? 'V' : 'N').first
+    return unless type == 1
+
+    x = binstr[5, 8].unpack('D').first
+    y = binstr[13, 8].unpack('D').first
+
+    new(longitude: x, latitude: y)
+  end
+
+  attr_reader :longitude
+  attr_reader :latitude
+
+  def initialize(longitude:, latitude:)
+    @longitude = longitude.to_f if longitude
+    @latitude = latitude.to_f if latitude
+  end
+
+  def to_wkt
+    "POINT(#{format('%.7f', longitude)} #{format('%.7f', latitude)})"
+  end
+
+  def to_wkb
+    "\x01" + [1].pack('L') + [longitude, latitude].pack('D*')
+  end
+end

data/lib/mysql_point/quoting.rb

@@ -0,0 +1,9 @@
+module MySQLPoint::Quoting
+  def quote(value)
+    if value.respond_to?(:to_wkt)
+      "ST_GeomFromText(#{super(value.to_wkt)})"
+    else
+      super
+    end
+  end
+end

data/lib/mysql_point/type.rb

@@ -0,0 +1,31 @@
+class MySQLPoint::Type < ActiveModel::Type::Value
+  # for schema dumping
+  def type
+    :point
+  end
+
+  # from ruby type (Coordinate) to quotable database value (Coordinate)
+  # this depends on the MySQLPoint::Quoting mixin to work.
+  def serialize(value)
+    value
+  end
+
+  # from database value (WKB, Coordinate) to ruby value (Coordinate)
+  def deserialize(value)
+    if value.respond_to?(:to_wkt)
+      value
+    elsif value
+      MySQLPoint::Coordinate.from_wkb(value[4..-1])
+    end
+  end
+
+  # from attribute setter (WKT, Coordinate) to ruby value (Coordinate)
+  # and from user input (WKT) to ruby value (Coordinate)
+  def cast(value)
+    if value.respond_to?(:to_wkt)
+      value
+    elsif value
+      MySQLPoint::Coordinate.from_wkt(value)
+    end
+  end
+end

data/lib/mysql_point/version.rb

@@ -0,0 +1,3 @@
+module MySQLPoint
+  VERSION = '1.0.0'
+end

data/mysql_point.gemspec

@@ -0,0 +1,38 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'mysql_point/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'mysql_point'
+  spec.version       = MySQLPoint::VERSION
+  spec.authors       = ['Lance Ivy']
+  spec.email         = ['lance@cainlevy.net']
+
+  spec.summary       = 'ActiveRecord support for MySQL POINT fields.'
+  spec.homepage      = 'https://github.com/empaticoorg/mysql_point'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+      'public gem pushes.'
+  end
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}){|f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+
+  spec.add_dependency 'activerecord', '>= 5.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.15'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'appraisal'
+  spec.add_development_dependency 'mysql2'
+end

metadata

@@ -0,0 +1,149 @@
+--- !ruby/object:Gem::Specification
+name: mysql_point
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Lance Ivy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-06-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !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: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  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'
+- !ruby/object:Gem::Dependency
+  name: mysql2
+  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:
+- lance@cainlevy.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".circleci/config.yml"
+- ".gitignore"
+- ".travis.yml"
+- Appraisals
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gemfiles/activerecord_5.0.gemfile
+- gemfiles/activerecord_5.1.gemfile
+- lib/coordinate_validator.rb
+- lib/mysql_point.rb
+- lib/mysql_point/column_method.rb
+- lib/mysql_point/coordinate.rb
+- lib/mysql_point/quoting.rb
+- lib/mysql_point/type.rb
+- lib/mysql_point/version.rb
+- mysql_point.gemspec
+homepage: https://github.com/empaticoorg/mysql_point
+licenses: []
+metadata:
+  allowed_push_host: https://rubygems.org
+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.5.1
+signing_key: 
+specification_version: 4
+summary: ActiveRecord support for MySQL POINT fields.
+test_files: []