mapkick-static 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1a8fd5cb74990e96209e87feab8beee6b31e1d69a42f34a10a92beb03cd5e064
+  data.tar.gz: d18aa7816d2e76a2cead6a487d443b88c3876d28f3885b578318e03d9c87332b
+SHA512:
+  metadata.gz: 35dd8ef3064bc945f515119fee0fa29e0f58aad2e2042a5a23e407b6fa5cc10bdc6b5c109c61196c59fd7c71cb95f5e37aabc3bfc7e49101fccdb52bddfaac8e
+  data.tar.gz: e0e8577a9d1e7dd8cc6dc5b55e125f84aa03d5f0a61cda7068608cc807b12bfc7e2729d09d947e211558171d8c54a3567f0afeb1fac9fcd20441706c87064989

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2023-04-26)
+
+- First commit

data/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2023 Andrew Kane
+
+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,116 @@
+# Mapkick Static
+
+Create beautiful static maps with one line of Ruby. No more fighting with mapping libraries!
+
+[See it in action](https://chartkick.com/mapkick-static)
+
+:fire: For JavaScript maps, check out [Mapkick](https://chartkick.com/mapkick)
+
+[![Build Status](https://github.com/ankane/mapkick-static/workflows/build/badge.svg?branch=master)](https://github.com/ankane/mapkick-static/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "mapkick-static"
+```
+
+Mapkick Static uses the [Mapbox Static Images API](https://docs.mapbox.com/api/maps/static-images/). [Create a Mapbox account](https://account.mapbox.com/auth/signup/) to get an access token and set `ENV["MAPBOX_ACCESS_TOKEN"]` in your environment.
+
+## Maps
+
+Point map
+
+```erb
+<%= static_map [{latitude: 37.7829, longitude: -122.4190}] %>
+```
+
+Area map (experimental)
+
+```erb
+<%= static_area_map [{geometry: {type: "Polygon", coordinates: ...}}] %>
+```
+
+## Data
+
+Data can be an array
+
+```erb
+<%= static_map [{latitude: 37.7829, longitude: -122.4190}] %>
+```
+
+### Point Map
+
+Use `latitude` or `lat` for latitude and `longitude`, `lon`, or `lng` for longitude
+
+You can specify a color for each data point
+
+```ruby
+{
+  latitude: ...,
+  longitude: ...,
+  color: "#f84d4d"
+}
+```
+
+### Area Map
+
+Use `geometry` with a GeoJSON `Polygon` or `MultiPolygon`
+
+You can specify a color for each data point
+
+```ruby
+{
+  geometry: {type: "Polygon", coordinates: ...},
+  color: "#0090ff"
+}
+```
+
+## Options
+
+Width and height
+
+```erb
+<%= static_map data, width: 800, height: 500 %>
+```
+
+Alt text
+
+```erb
+<%= static_map data, alt: "Map of ..." %>
+```
+
+Marker color
+
+```erb
+<%= static_map data, markers: {color: "#f84d4d"} %>
+```
+
+Map style
+
+```erb
+<%= static_map data, style: "mapbox/outdoors-v12" %>
+```
+
+## History
+
+View the [changelog](https://github.com/ankane/mapkick-static/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Everyone is encouraged to help improve this project. Here are a few ways you can help:
+
+- [Report bugs](https://github.com/ankane/mapkick-static/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/mapkick-static/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/mapkick-static.git
+cd mapkick-static
+bundle install
+bundle exec rake test
+```

data/lib/mapkick/static/area_map.rb

@@ -0,0 +1,27 @@
+module Mapkick
+  module Static
+    class AreaMap < BaseMap
+      private
+
+      def generate_features(data, default_color)
+        default_color ||= "#0090ff"
+
+        data.map do |v|
+          color = v["color"] || default_color
+          {
+            type: "Feature",
+            # TODO round coordinates
+            geometry: v["geometry"],
+            properties: {
+              "fill" => color,
+              "fill-opacity" => 0.3,
+              "stroke" => color,
+              "stroke-width" => 1,
+              "stroke-opacity" => 0.7
+            }
+          }
+        end
+      end
+    end
+  end
+end

data/lib/mapkick/static/base_map.rb

@@ -0,0 +1,99 @@
+module Mapkick
+  module Static
+    class BaseMap
+      attr_reader :url, :url_2x
+
+      def initialize(data, width: 800, height: 500, markers: {}, style: "mapbox/streets-v12", alt: "Map", access_token: nil, view_context: nil)
+        @width = width.to_i
+        @height = height.to_i
+        @alt = alt
+        @view_context = view_context
+
+        prefix = "https://api.mapbox.com/styles/v1"
+        style = set_style(style)
+        geojson = create_geojson(data, markers)
+        overlay = "geojson(#{CGI.escape(JSON.generate(geojson))})"
+        viewport = set_viewport(geojson)
+        size = "%dx%d" % [@width.to_i, @height.to_i]
+        query = set_query(access_token, viewport)
+
+        url = "#{prefix}/#{style}/static/#{overlay}/#{viewport}/#{size}"
+        @url = "#{url}?#{query}"
+        @url_2x = "#{url}@2x?#{query}"
+
+        check_request_size
+      end
+
+      def to_s
+        @view_context.image_tag(url, alt: @alt, style: image_style, srcset: "#{url} 1x, #{url_2x} 2x")
+      end
+
+      private
+
+      def set_style(style)
+        style = style.delete_prefix("mapbox://styles/")
+        if style.count("/") != 1
+          raise ArgumentError, "Invalid style"
+        end
+        style.split("/", 2).map { |v| CGI.escape(v) }.join("/")
+      end
+
+      def create_geojson(data, markers)
+        data = data.map { |v| v.transform_keys(&:to_s) }
+        default_color = markers.transform_keys(&:to_s)["color"]
+        {
+          type: "FeatureCollection",
+          features: generate_features(data, default_color)
+        }
+      end
+
+      def set_viewport(geojson)
+        if geojson[:features].size == 1 && (geometry = geojson[:features][0][:geometry]) && geometry&.[](:type) == "MultiPoint" && geometry[:coordinates].size == 1
+          coordinates = geometry[:coordinates][0]
+          zoom = 15
+          "%f,%f,%d" % [round_coordinate(coordinates[0].to_f), round_coordinate(coordinates[1].to_f), zoom.to_i]
+        else
+          "auto"
+        end
+      end
+
+      def set_query(access_token, viewport)
+        params = {}
+        params[:access_token] = check_access_token(access_token || ENV["MAPBOX_ACCESS_TOKEN"])
+        if viewport == "auto"
+          params[:padding] = 40
+        end
+        URI.encode_www_form(params)
+      end
+
+      def check_access_token(access_token)
+        if !access_token
+          raise Error, "No access token"
+        elsif access_token.start_with?("sk.")
+          # can bypass with string keys
+          # but should help prevent common errors
+          raise Error, "Expected public access token"
+        elsif !access_token.start_with?("pk.")
+          raise Error, "Invalid access token"
+        end
+        access_token
+      end
+
+      # round to reduce URL size
+      def round_coordinate(point)
+        point.round(7)
+      end
+
+      # https://docs.mapbox.com/api/overview/#url-length-limits
+      def check_request_size
+        if @url_2x.bytesize > 8192
+          warn "[mapkick-static] URL exceeds 8192 byte limit of API (#{@url_2x.bytesize} bytes)"
+        end
+      end
+
+      def image_style
+        "width: %dpx; height: %dpx;" % [@width.to_i, @height.to_i]
+      end
+    end
+  end
+end

data/lib/mapkick/static/helper.rb

@@ -0,0 +1,13 @@
+module Mapkick
+  module Static
+    module Helper
+      def static_map(data, **options)
+        Mapkick::Static::Map.new(data, **options, view_context: self)
+      end
+
+      def static_area_map(data, **options)
+        Mapkick::Static::AreaMap.new(data, **options, view_context: self)
+      end
+    end
+  end
+end

data/lib/mapkick/static/map.rb

@@ -0,0 +1,34 @@
+module Mapkick
+  module Static
+    class Map < BaseMap
+      private
+
+      def generate_features(data, default_color)
+        default_color ||= "#f84d4d"
+        default_icon = nil
+
+        data.group_by { |v| [v["color"] || default_color, v["x_icon"] || default_icon] }.map do |(color, icon), vs|
+          geometry = {
+            type: "MultiPoint",
+            coordinates: vs.map { |v| row_coordinates(v).map { |vi| round_coordinate(vi) } }
+          }
+
+          properties = {
+            "marker-color" => color
+          }
+          properties["marker-symbol"] = icon if icon
+
+          {
+            type: "Feature",
+            geometry: geometry,
+            properties: properties
+          }
+        end
+      end
+
+      def row_coordinates(row)
+        [row["longitude"] || row["lng"] || row["lon"], row["latitude"] || row["lat"]]
+      end
+    end
+  end
+end

data/lib/mapkick/static/version.rb

@@ -0,0 +1,5 @@
+module Mapkick
+  module Static
+    VERSION = "0.1.0"
+  end
+end

data/lib/mapkick/static.rb

@@ -0,0 +1,29 @@
+# stdlib
+require "cgi"
+require "json"
+require "uri"
+
+# maps
+require_relative "static/base_map"
+require_relative "static/area_map"
+require_relative "static/map"
+
+# modules
+require_relative "static/helper"
+require_relative "static/version"
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:action_view) do
+    include Mapkick::Static::Helper
+  end
+
+  ActiveSupport.on_load(:action_mailer) do
+    include Mapkick::Static::Helper
+  end
+end
+
+module Mapkick
+  module Static
+    class Error < StandardError; end
+  end
+end

metadata

@@ -0,0 +1,51 @@
+--- !ruby/object:Gem::Specification
+name: mapkick-static
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrew Kane
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-04-26 00:00:00.000000000 Z
+dependencies: []
+description:
+email: andrew@ankane.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE.txt
+- README.md
+- lib/mapkick/static.rb
+- lib/mapkick/static/area_map.rb
+- lib/mapkick/static/base_map.rb
+- lib/mapkick/static/helper.rb
+- lib/mapkick/static/map.rb
+- lib/mapkick/static/version.rb
+homepage: https://chartkick.com/mapkick-static
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: Create beautiful static maps with one line of Ruby
+test_files: []