mapkick-rb 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7678cfa0645e5386090c2ce73f06ffca32e0cbe3d3643b23d241ac80036d8c9d
+  data.tar.gz: 348c96a8b02cc983dda7fcc4a655bd2bb276d20b210290d6cce424b669449eac
+SHA512:
+  metadata.gz: 466776e05996b2a6cd0144c7f68e627696b6bbf85742f700ceab060a347a444a8152aa2b8fe6f30d4f0ca677985e5cbc93b7ea80c9c736500ab6e609ae620f04
+  data.tar.gz: 68f2cf1f40bdd1242a2b91ade1bfce042bf2a234c23a64ec87b9989bf6708adcbe822d11e2c477714f989ec151b15358ac082773593f0ad400730c169d12b7a2

data/CHANGELOG.md

@@ -0,0 +1,3 @@
+## 0.1.0 (2023-01-19)
+
+- First release

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2023 Andrew Kane
+
+MIT License
+
+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,193 @@
+# Mapkick
+
+Create beautiful JavaScript maps with one line of Ruby. No more fighting with mapping libraries!
+
+[See it in action](https://chartkick.com/mapkick)
+
+:fire: For charts, check out [Chartkick](https://chartkick.com)
+
+[![Build Status](https://github.com/ankane/mapkick/workflows/build/badge.svg?branch=master)](https://github.com/ankane/mapkick/actions)
+
+## Installation
+
+Add this line to your application’s Gemfile:
+
+```ruby
+gem "mapkick-rb"
+```
+
+Mapkick uses [Mapbox GL JS v1](https://github.com/mapbox/mapbox-gl-js/tree/v1.13.3). To use tiles from Mapbox, [create a Mapbox account](https://account.mapbox.com/auth/signup/) to get an access token and set `ENV["MAPBOX_ACCESS_TOKEN"]` in your environment.
+
+Then follow the instructions for your JavaScript setup:
+
+- [Importmap](#importmap) (Rails 7 default)
+- [esbuild, rollup.js, or Webpack](#esbuild-rollupjs-or-webpack)
+- [Webpacker](#webpacker) (Rails 6 default)
+- [Sprockets](#sprockets)
+
+### Importmap
+
+In `config/importmap.rb`, add:
+
+```ruby
+pin "mapkick/bundle", to: "mapkick.bundle.js"
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "mapkick/bundle"
+```
+
+### esbuild, rollup.js, or Webpack
+
+Run:
+
+```sh
+yarn add mapkick
+```
+
+And in `app/javascript/application.js`, add:
+
+```js
+import "mapkick/bundle"
+```
+
+Note: For rollup.js, this requires `format: "iife"` in `rollup.config.js`.
+
+### Webpacker
+
+Run:
+
+```sh
+yarn add mapkick
+```
+
+And in `app/javascript/packs/application.js`, add:
+
+```js
+import "mapkick/bundle"
+```
+
+### Sprockets
+
+In `app/assets/javascripts/application.js`, add:
+
+```js
+//= require mapkick.bundle
+```
+
+## Maps
+
+Create a map
+
+```erb
+<%= js_map [{latitude: 1.23, longitude: 4.56}] %>
+```
+
+## Data
+
+Data can be an array
+
+```erb
+<%= js_map [{latitude: 1.23, longitude: 4.56}] %>
+```
+
+Or a URL that returns JSON (same format as above)
+
+```erb
+<%= js_map cities_path %>
+```
+
+You can use `latitude`, `lat`, `longitude`, `lon`, and `lng`
+
+You can specify a label and tooltip for each data point
+
+```javascript
+{
+  latitude: ...,
+  longitude: ...,
+  label: "Hot Chicken Takeover",
+  tooltip: "5 stars"
+}
+```
+
+## Options
+
+Id, width, and height
+
+```erb
+<%= js_map data, id: "cities-map", width: "800px", height: "500px" %>
+```
+
+Markers
+
+```erb
+<%= js_map data, markers: {color: "#f84d4d"} %>
+```
+
+Tooltips
+
+```erb
+<%= js_map data, tooltips: {hover: false, html: true} %>
+```
+
+Map style
+
+```erb
+<%= js_map data, style: "mapbox://styles/mapbox/outdoors-v12" %>
+```
+
+Zoom and controls
+
+```erb
+<%= js_map data, zoom: 15, controls: true %>
+```
+
+Refresh data from a remote source every `n` seconds
+
+```erb
+<%= js_map url, refresh: 60 %>
+```
+
+### Global Options
+
+To set options for all of your maps, create an initializer `config/initializers/mapkick.rb` with:
+
+```ruby
+Mapkick.options[:height] = "400px"
+```
+
+## Sinatra and Padrino
+
+Download [mapkick.bundle.js](https://raw.githubusercontent.com/ankane/mapkick/master/vendor/assets/javascripts/mapkick.js) and include it manually.
+
+```html
+<script src="mapkick.bundle.js"></script>
+```
+
+## No Ruby? No Problem
+
+Check out [mapkick.js](https://github.com/ankane/mapkick.js)
+
+## History
+
+View the [changelog](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/issues)
+- Fix bugs and [submit pull requests](https://github.com/ankane/mapkick/pulls)
+- Write, clarify, or fix documentation
+- Suggest or add new features
+
+To get started with development:
+
+```sh
+git clone https://github.com/ankane/mapkick.git
+cd mapkick
+bundle install
+bundle exec rake test
+```

data/lib/mapkick/engine.rb

@@ -0,0 +1,12 @@
+module Mapkick
+  class Engine < ::Rails::Engine
+    # for assets
+
+    # for importmap
+    initializer "mapkick.importmap" do |app|
+      if defined?(Importmap)
+        app.config.assets.precompile << "mapkick.bundle.js"
+      end
+    end
+  end
+end

data/lib/mapkick/helper.rb

@@ -0,0 +1,101 @@
+module Mapkick
+  module Helper
+    # don't break out options since need to merge with default options
+    def js_map(data_source, **options)
+      options = Mapkick::Utils.deep_merge(Mapkick.options, options)
+
+      @mapkick_map_id ||= 0
+      element_id = options.delete(:id) || "map-#{@mapkick_map_id += 1}"
+
+      height = (options.delete(:height) || "500px").to_s
+      width = (options.delete(:width) || "100%").to_s
+
+      nonce = options.fetch(:nonce, true)
+      options.delete(:nonce)
+      if nonce == true
+        # Secure Headers also defines content_security_policy_nonce but it takes an argument
+        # Rails 5.2 overrides this method, but earlier versions do not
+        if respond_to?(:content_security_policy_nonce) && (content_security_policy_nonce rescue nil)
+          # Rails 5.2+
+          nonce = content_security_policy_nonce
+        elsif respond_to?(:content_security_policy_script_nonce)
+          # Secure Headers
+          nonce = content_security_policy_script_nonce
+        else
+          nonce = nil
+        end
+      end
+      nonce_html = nonce ? " nonce=\"#{ERB::Util.html_escape(nonce)}\"" : nil
+
+      # html vars
+      html_vars = {
+        id: element_id,
+        height: height,
+        width: width,
+        # don't delete loading option since it needs to be passed to JS
+        loading: options[:loading] || "Loading..."
+      }
+
+      [:height, :width].each do |k|
+        # limit to alphanumeric and % for simplicity
+        # this prevents things like calc() but safety is the priority
+        # dot does not need escaped in square brackets
+        raise ArgumentError, "Invalid #{k}" unless html_vars[k] =~ /\A[a-zA-Z0-9%.]*\z/
+      end
+
+      html_vars.each_key do |k|
+        # escape all variables
+        # we already limit height and width above, but escape for safety as fail-safe
+        # to prevent XSS injection in worse-case scenario
+        html_vars[k] = ERB::Util.html_escape(html_vars[k])
+      end
+
+      html = %(<div id="%{id}" style="height: %{height}; width: %{width};"><div style="height: %{height}; text-align: center; color: #999; line-height: %{height}; font-size: 14px; font-family: 'Lucida Grande', 'Lucida Sans Unicode', Verdana, Arial, Helvetica, sans-serif;">%{loading}</div></div>) % html_vars
+
+      # access token
+      access_token = options.delete(:access_token) || options.delete(:accessToken) || ENV["MAPBOX_ACCESS_TOKEN"]
+      if access_token
+        # can bypass with string keys
+        # but should help prevent common errors
+        if access_token.start_with?("sk.")
+          raise Mapkick::Error, "Expected public access token"
+        elsif !access_token.start_with?("pk.")
+          raise Mapkick::Error, "Invalid access token"
+        end
+        options[:accessToken] = access_token
+      end
+
+      # js vars
+      js_vars = {
+        id: element_id,
+        data: data_source,
+        options: options
+      }
+      js_vars.each_key do |k|
+        js_vars[k] = Mapkick::Utils.json_escape(js_vars[k].to_json)
+      end
+      createjs = "new Mapkick.Map(%{id}, %{data}, %{options});" % js_vars
+
+      # don't rerun JS on preview
+      js = <<~JS
+        <script#{nonce_html}>
+          (function() {
+            if (document.documentElement.hasAttribute("data-turbolinks-preview")) return;
+            if (document.documentElement.hasAttribute("data-turbo-preview")) return;
+
+            var createMap = function() { #{createjs} };
+            if ("Mapkick" in window) {
+              createMap();
+            } else {
+              window.addEventListener("mapkick:load", createMap, true);
+            }
+          })();
+        </script>
+      JS
+
+      html += "\n#{js}"
+
+      html.respond_to?(:html_safe) ? html.html_safe : html
+    end
+  end
+end

data/lib/mapkick/sinatra.rb

@@ -0,0 +1,5 @@
+require "sinatra/base"
+
+class Sinatra::Base
+  helpers Mapkick::Helper
+end

data/lib/mapkick/utils.rb

@@ -0,0 +1,24 @@
+module Mapkick
+  module Utils
+    # https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/hash/deep_merge.rb
+    def self.deep_merge(hash_a, hash_b)
+      hash_a = hash_a.dup
+      hash_b.each_pair do |k, v|
+        tv = hash_a[k]
+        hash_a[k] = tv.is_a?(Hash) && v.is_a?(Hash) ? deep_merge(tv, v) : v
+      end
+      hash_a
+    end
+
+    # from https://github.com/rails/rails/blob/master/activesupport/lib/active_support/core_ext/string/output_safety.rb
+    JSON_ESCAPE = { "&" => '\u0026', ">" => '\u003e', "<" => '\u003c', "\u2028" => '\u2028', "\u2029" => '\u2029' }
+    JSON_ESCAPE_REGEXP = /[\u2028\u2029&><]/u
+    def self.json_escape(s)
+      if ERB::Util.respond_to?(:json_escape)
+        ERB::Util.json_escape(s)
+      else
+        s.to_s.gsub(JSON_ESCAPE_REGEXP, JSON_ESCAPE)
+      end
+    end
+  end
+end

data/lib/mapkick/version.rb

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

data/lib/mapkick-rb.rb

@@ -0,0 +1 @@
+require_relative "mapkick"

data/lib/mapkick.rb

@@ -0,0 +1,27 @@
+# stdlib
+require "json"
+require "erb"
+
+# modules
+require_relative "mapkick/helper"
+require_relative "mapkick/utils"
+require_relative "mapkick/version"
+
+# integrations
+require_relative "mapkick/engine" if defined?(Rails)
+require_relative "mapkick/sinatra" if defined?(Sinatra)
+
+if defined?(ActiveSupport.on_load)
+  ActiveSupport.on_load(:action_view) do
+    include Mapkick::Helper
+  end
+end
+
+module Mapkick
+  class Error < StandardError; end
+
+  class << self
+    attr_accessor :options
+  end
+  self.options = {}
+end