active_record_mysql_spatial 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c1fb8466cfa0fa405fd35472dfa05122712db0dc27b7a3daad65d6c0329736ab
-  data.tar.gz: c58c26a2abff58ae9d9c32e710b7898db5648a5980db891deb71911b82336140
+  metadata.gz: 52dc505e977c105df50ab13b4c4bf1363d778ac41479b0ff578632c4d627a7a4
+  data.tar.gz: de9e452572739eeb2634e8ef919ba4683038b05f3fb9ad47bcd1435c6d036c0d
 SHA512:
-  metadata.gz: ded6ba2548871b914758b5306c8b0b6b68f3922e059c3895e2e938e7a7fe6cb781f42e084d46b9871ba71e7a429097f2b9ed52d66b5e415f1bd2132b9d17b7c1
-  data.tar.gz: 162ab35dd4901102eb470bf71c7086ea1febd6de8d24695415a4be983df2b51cf1bb0399b0dac7e9fa1b0aca32e7cbea945fd588ffbcfd14e2f1de27b14876e0
+  metadata.gz: e3888cef99591d42373885f9f7c06913f0226a2df5eb5f2949f102565f2660a7a76b14896f6148aa881de5b4640ab6bd8d8842247d7e91f34b4cfc63cb81aca4
+  data.tar.gz: 8320501949446a2e6a316b4fac74d1bf026db27e23ec8c65808e5fd3e4766119205fc69c5755a516c04a1111d3f5b15f5e805f2d8b01642a8d0e60daac7e04c6

data/README.md

@@ -1,35 +1,102 @@
-# ActiveRecordMysqlSpatial
+ActiveRecord extension for MySQL Spatial Data.
 
-TODO: Delete this and the text below, and describe your gem
+# Installation
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/active_record_mysql_spatial`. To experiment with that code, run `bin/console` for an interactive prompt.
+```sh
+gem 'active_record_mysql_spatial'
+```
 
-## Installation
+# Migration
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
+This extension provides some data type methods for ActiveRecord migration and also register those types to the schema.
 
-Install the gem and add to the application's Gemfile by executing:
+```rb
+# frozen_string_literal: true
 
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+class CreatePositions < ActiveRecord::Migration[7.2]
+  def change
+    create_table :positions do |t|
+      t.linestring :ls
+      t.multilinestring :mls
+      t.point :pt
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+      t.column :tls, :linestring
+      t.column :tmls, :multilinestring
+      t.column :tpt, :point
 
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+      t.timestamps
+    end
+  end
+end
+```
 
-## Usage
+Without this extension, even you use `t.column` to define the column for the table, you will receive the error message in the `schema.rb`
 
-TODO: Write usage instructions here
+```rb
+# Could not dump table "positions" because of following StandardError
+#   Unknown type 'linestring' for column 'tls'
+```
 
-## Development
+# Usage
 
-After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+## Point
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```rb
+position = Position.create!(pt: { x: 1, y: 2 })
 
-## Contributing
+position = Position.create!(pt: [1, 2])
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/active_record_mysql_spatial.
+p position.pt.x # puts x
+p position.pt.y # puts y
+```
 
-## License
+## Linestring
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```rb
+position = Position.create!(ls: [[1, 2], [2, 3]])
+
+p position.ls.coordinates # puts all points
+p position.ls.coordinates.first.x # puts x of first point
+p position.ls.coordinates.last.y # puts y of last point
+```
+
+## Multilinestring
+
+```rb
+position = Position.create!(mls: [[[1, 2], [2, 3]]])
+
+p position.mls.items # puts all linestrings
+p position.mls.items.first.coordinates.first.x # puts x of first point of first linestring
+p position.mls.items.last.coordinates.last.y # puts y of last point of last linestring
+```
+
+# Custom result class
+
+In your business, you may need to use spatial data for a purpose. To load data and map to the semantic data for your business, create a class and override the method `cast_value`.
+
+```rb
+class YourClass < ActiveRecordMysqlSpatial::ActiveRecord::MySQL::Linestring
+  attr_reader :sum_x, :sum_y
+
+  private
+
+  def cast_value(value)
+    super
+
+    @sum_x, @sum_y = @coordinates.reduce([0, 0]) do |sum, point|
+      sum[0] += point.x.to_i
+      sum[1] += point.y.to_i
+      sum
+    end
+
+    self
+  end
+end
+
+# models/position.rb
+class Position < ApplicationRecord
+  include ActiveRecordMysqlSpatial::ActsAsSpatial
+
+  acts_as_linestring :ls, serializer: YourClass
+end
+```

data/lib/active_record_mysql_spatial/acts_as_spatial.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require 'active_support/concern'
+
+module ActiveRecordMysqlSpatial
+  module ActsAsSpatial
+    extend ActiveSupport::Concern
+
+    class_methods do
+      def acts_as_linestring(*columns, serializer: nil)
+        return if serializer.blank?
+
+        columns.each do |col|
+          attribute(col, serializer.new)
+        end
+      end
+
+      alias_method :acts_as_point, :acts_as_linestring
+      alias_method :acts_as_multilinestring, :acts_as_linestring
+    end
+  end
+end

data/lib/active_record_mysql_spatial/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveRecordMysqlSpatial
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/lib/active_record_mysql_spatial.rb

@@ -9,6 +9,7 @@ require_relative 'active_record_mysql_spatial/active_record/mysql/point'
 require_relative 'active_record_mysql_spatial/active_record/native_types'
 require_relative 'active_record_mysql_spatial/active_record/quoting'
 require_relative 'active_record_mysql_spatial/active_record/register_types'
+require_relative 'active_record_mysql_spatial/acts_as_spatial'
 require_relative 'active_record_mysql_spatial/geometry'
 require_relative 'active_record_mysql_spatial/version'
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_record_mysql_spatial
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Alpha
@@ -49,6 +49,7 @@ files:
 - lib/active_record_mysql_spatial/active_record/native_types.rb
 - lib/active_record_mysql_spatial/active_record/quoting.rb
 - lib/active_record_mysql_spatial/active_record/register_types.rb
+- lib/active_record_mysql_spatial/acts_as_spatial.rb
 - lib/active_record_mysql_spatial/geometry.rb
 - lib/active_record_mysql_spatial/version.rb
 homepage: https://github.com/zgid123/active_record_mysql_spatial