active_map 0.12.2 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d9f43399567d037a7bd1d30e0616d74764a5a8bf94fced533bed02faaf9eff81
-  data.tar.gz: 448d1f7ae3251522374a7042915c57659ac964d01b842da66c54104cfa3c139e
+  metadata.gz: 9de22853c093f901edd0cdce8369b569ef2c84997e846a05fe33b51a4dbed1b3
+  data.tar.gz: e1d5d728d054a275a65e195a487fa89b937dbe88d544606884c7db30bfec1076
 SHA512:
-  metadata.gz: 05ee1b5ca47f0907faf32031797909dacd2dfc807edabfbf638b76014e11d05e97504bb7105befe5b94c1c928f69a1ddd546d77d9a948ed841fccfc572dd902e
-  data.tar.gz: 69728ced9ebba43c4fb50533797b2362bf7ecc633292984bc288449dbd9c5ab2595a4311124bf2c6ed45596b00c0ee3ab8f025f8bccb49bed82b2a5cd4ce8d22
+  metadata.gz: 58df67bdcf82aa7fef438e3ef10a190b38156ddd664605dbf45eab2cee23cd6f4a5b379242387723431220a1b9320ca1b6cad7740d25220615f4e54083b216fb
+  data.tar.gz: 85054688467ed05e7e2a1b4c2a8c4baad09136a37b0b2583edd939ead8583a34148e24d66e93849c41c663c2ef8c3af78ad562b4ea37f945fbd7f408e3ba955f

data/README.md

@@ -1,5 +1,6 @@
 # ActiveMap
 
+[![Gem Version](https://img.shields.io/gem/v/active_map)](https://rubygems.org/gems/active_map)
 [![CI](https://github.com/itisbryan/active_map/actions/workflows/ci.yml/badge.svg)](https://github.com/itisbryan/active_map/actions/workflows/ci.yml)
 
 Declarative maps for Rails + PostgreSQL/PostGIS. A Ruby DSL turns your models
@@ -21,18 +22,23 @@ gem "active_map"
 
 ```bash
 bundle install
-bin/rails g active_map:install   # mounts the engine at /maps, creates initializer + sample map
+bin/rails g active_map:install   # mounts /maps, initializer + sample map, PostGIS migration, Stimulus wiring
+bin/rails db:migrate             # enables the postgis extension
 ```
 
-Enable PostGIS and add geometry columns:
+Make a model mappable — the generator adds the geometry column (with a GiST
+index) and `acts_as_mappable` in one step:
 
-```ruby
-enable_extension "postgis"
-
-add_column :warehouses, :coordinates, "geometry(Point,4326)"
-add_index  :warehouses, :coordinates, using: :gist
+```bash
+bin/rails g active_map:mappable Warehouse coordinates:point
+bin/rails g active_map:mappable DeliveryZone area:polygon
+bin/rails g active_map:mappable Route path:line
+bin/rails db:migrate
 ```
 
+Both generators are idempotent — safe to re-run. Prefer to wire it by hand?
+See the Model DSL below.
+
 ## Model DSL
 
 ```ruby

data/lib/active_map/version.rb

@@ -1,3 +1,3 @@
 module ActiveMap
-  VERSION = "0.12.2"
+  VERSION = "0.13.0"
 end

data/lib/generators/active_map/install/install_generator.rb

@@ -1,7 +1,13 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
 module ActiveMap
   module Generators
     # Idempotent: safe to re-run; every step checks for prior installation.
     class InstallGenerator < Rails::Generators::Base
+      include Rails::Generators::Migration
+
       source_root File.expand_path("templates", __dir__)
 
       MOUNT = 'mount ActiveMap::Engine, at: "/maps"'.freeze
@@ -12,12 +18,24 @@ module ActiveMap
         application.register("active-map", ActiveMapController)
       JS
 
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
       def mount_engine
         return say_status :skip, "route (already mounted)", :yellow if routes_file.include?("ActiveMap::Engine")
 
         route MOUNT
       end
 
+      def create_postgis_migration
+        if postgis_migration_exists?
+          say_status :skip, "PostGIS migration (already present)", :yellow
+        else
+          migration_template "enable_postgis.rb.tt", "db/migrate/enable_postgis.rb"
+        end
+      end
+
       def create_initializer
         template "initializer.rb", "config/initializers/active_map.rb", skip: true
       end
@@ -48,17 +66,26 @@ module ActiveMap
       def next_steps
         say <<~MSG, :green
           ActiveMap installed. Next steps:
-            1. Enable PostGIS:  bin/rails g migration EnablePostgis  ->  enable_extension "postgis"
-            2. Add a geometry column:  add_column :things, :coordinates, "geometry(Point,4326)"
-               and index it:          add_index :things, :coordinates, using: :gist
-            3. Declare `acts_as_mappable geometry: :coordinates` in the model.
-            4. Define layers in app/maps/sample_map.rb, then render with <%= active_map :sample %>.
+            1. Run migrations:  bin/rails db:migrate   (enables PostGIS)
+            2. Make a model mappable, e.g.:
+                 bin/rails g active_map:mappable Warehouse coordinates:point
+            3. Define layers in app/maps/sample_map.rb, then render with <%= active_map :sample %>.
           Docs: README.md and llms.txt in the gem root (`bundle show active_map`).
         MSG
       end
 
       private
 
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def postgis_migration_exists?
+        Dir.glob(destination.join("db/migrate/*.rb")).any? do |f|
+          File.read(f).include?('enable_extension "postgis"')
+        end
+      end
+
       def destination
         Pathname(destination_root)
       end

data/lib/generators/active_map/install/templates/enable_postgis.rb.tt

@@ -0,0 +1,5 @@
+class EnablePostgis < ActiveRecord::Migration<%= migration_version %>
+  def change
+    enable_extension "postgis" unless extension_enabled?("postgis")
+  end
+end

data/lib/generators/active_map/mappable/mappable_generator.rb

@@ -0,0 +1,90 @@
+require "rails/generators"
+require "rails/generators/migration"
+require "rails/generators/active_record"
+
+module ActiveMap
+  module Generators
+    # Scaffolds a mappable model in one step:
+    #
+    #   rails g active_map:mappable Warehouse coordinates:point
+    #   rails g active_map:mappable DeliveryZone area:polygon
+    #
+    # Adds a geometry column migration (with a GiST index) and injects
+    # `acts_as_mappable` into the model (creating it if absent). Idempotent.
+    class MappableGenerator < Rails::Generators::NamedBase
+      include Rails::Generators::Migration
+
+      source_root File.expand_path("templates", __dir__)
+
+      GEOMETRY_TYPES = {"point" => "Point", "polygon" => "Polygon", "line" => "LineString"}.freeze
+
+      argument :geometry, type: :string, default: "coordinates:point",
+        banner: "column:point|polygon|line",
+        desc: "geometry column and shape, e.g. coordinates:point"
+
+      def self.next_migration_number(dir)
+        ActiveRecord::Generators::Base.next_migration_number(dir)
+      end
+
+      def validate!
+        return if GEOMETRY_TYPES.key?(shape)
+
+        raise Thor::Error, "unknown geometry type #{shape.inspect} (one of: #{GEOMETRY_TYPES.keys.join(", ")})"
+      end
+
+      def create_geometry_migration
+        if column_migration_exists?
+          say_status :skip, "column migration (already present)", :yellow
+        else
+          migration_template "add_geometry_column.rb.tt",
+            "db/migrate/add_#{column}_to_#{table_name}.rb"
+        end
+      end
+
+      def add_acts_as_mappable
+        path = File.join(destination_root, "app/models", "#{file_path}.rb")
+        declaration = "  acts_as_mappable geometry: :#{column}, type: :#{shape}\n"
+
+        if File.exist?(path)
+          if File.read(path).include?("acts_as_mappable")
+            say_status :skip, "acts_as_mappable (already declared)", :yellow
+          else
+            inject_into_class path, class_name, declaration
+          end
+        else
+          template "model.rb.tt", "app/models/#{file_path}.rb"
+        end
+      end
+
+      def done
+        say_status :info,
+          "Run bin/rails db:migrate, then add a layer: " \
+          "layer :#{table_name}, #{class_name}.all", :green
+      end
+
+      private
+
+      def column
+        @column ||= geometry.split(":").first
+      end
+
+      def shape
+        @shape ||= geometry.split(":")[1] || "point"
+      end
+
+      def geometry_type
+        GEOMETRY_TYPES.fetch(shape)
+      end
+
+      def migration_version
+        "[#{ActiveRecord::VERSION::MAJOR}.#{ActiveRecord::VERSION::MINOR}]"
+      end
+
+      def column_migration_exists?
+        Dir.glob(File.join(destination_root, "db/migrate/*.rb")).any? do |f|
+          File.read(f).match?(/add_column\s+:#{table_name},\s*:#{column}\b/)
+        end
+      end
+    end
+  end
+end

data/lib/generators/active_map/mappable/templates/add_geometry_column.rb.tt

@@ -0,0 +1,6 @@
+class Add<%= column.camelize %>To<%= table_name.camelize %> < ActiveRecord::Migration<%= migration_version %>
+  def change
+    add_column :<%= table_name %>, :<%= column %>, "geometry(<%= geometry_type %>,4326)"
+    add_index :<%= table_name %>, :<%= column %>, using: :gist
+  end
+end

data/lib/generators/active_map/mappable/templates/model.rb.tt

@@ -0,0 +1,3 @@
+class <%= class_name %> < ApplicationRecord
+  acts_as_mappable geometry: :<%= column %>, type: :<%= shape %>
+end

data/llms.txt

@@ -5,10 +5,9 @@
 ## Install (exact steps)
 
 1. Gemfile: `gem "active_map"`; run `bundle install`.
-2. `bin/rails g active_map:install` — idempotent; mounts engine at `/maps`, writes `config/initializers/active_map.rb` and `app/maps/sample_map.rb`, pins/registers the Stimulus controller when `config/importmap.rb` / `app/javascript/controllers/index.js` exist.
-3. Migration: `enable_extension "postgis"`; geometry columns are plain SQL types:
-   `add_column :warehouses, :coordinates, "geometry(Point,4326)"` + `add_index :warehouses, :coordinates, using: :gist`.
-   Column types: `geometry(Point,4326)`, `geometry(Polygon,4326)`, `geometry(LineString,4326)`.
+2. `bin/rails g active_map:install` — idempotent; mounts engine at `/maps`, writes `config/initializers/active_map.rb` and `app/maps/sample_map.rb`, generates a PostGIS-enable migration, and pins/registers the Stimulus controller when `config/importmap.rb` / `app/javascript/controllers/index.js` exist. Then `bin/rails db:migrate`.
+3. Make a model mappable: `bin/rails g active_map:mappable Warehouse coordinates:point` (shape = point|polygon|line) — adds the geometry column migration (with GiST index) and injects `acts_as_mappable`; creates the model if absent; idempotent. Then `bin/rails db:migrate`.
+   Manual equivalent: `add_column :warehouses, :coordinates, "geometry(Point,4326)"` + `add_index :warehouses, :coordinates, using: :gist`. Column types: `geometry(Point,4326)`, `geometry(Polygon,4326)`, `geometry(LineString,4326)`.
 4. Assign geometry with EWKT strings: `Warehouse.create!(coordinates: "SRID=4326;POINT(<lng> <lat>)")` — LNG FIRST in WKT.
 
 ## Model DSL

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_map
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.13.0
 platform: ruby
 authors:
 - Bryan
@@ -65,8 +65,12 @@ files:
 - lib/active_map/version.rb
 - lib/active_map/wkb.rb
 - lib/generators/active_map/install/install_generator.rb
+- lib/generators/active_map/install/templates/enable_postgis.rb.tt
 - lib/generators/active_map/install/templates/initializer.rb
 - lib/generators/active_map/install/templates/sample_map.rb
+- lib/generators/active_map/mappable/mappable_generator.rb
+- lib/generators/active_map/mappable/templates/add_geometry_column.rb.tt
+- lib/generators/active_map/mappable/templates/model.rb.tt
 - llms.txt
 - vendor/active_map/MarkerCluster.Default.css
 - vendor/active_map/MarkerCluster.css