opal-google_maps 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5360d29c0f5cabf4c11ca826a0d3e0e2d9a5fc50
+  data.tar.gz: ec3414274194e249480133e3c319017237959623
+SHA512:
+  metadata.gz: 9b8d0daaba7de60e5eddf530592461912361ef1ee0efd727d803fcef1a2246a58112d812388e5c4acc88eafb30e00981651eea37895fe06e2c611c6d8b6eb18c
+  data.tar.gz: 882c2d21b688265290bf92e2ab59d74adee8b0a56afe0ea2572a33a99f2932d02cca8673eea6651f93fc4240ed23605b825ff5765ff78563e3ef9fe059d670ac

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

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

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 jgaskins@gmail.com. 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 opal-google_maps.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Jamie Gaskins
+
+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,98 @@
+# Opal::GoogleMaps
+
+Ruby bindings for client-side Google Maps integration via Opal and helpers for server-side loading.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'opal-google_maps'
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Since this gem is a Ruby interface for Google Maps, it requires that the Google Maps JS library be loaded (from Google) first. This is as simple as putting the following line in your server-side application's view template:
+
+```erb
+<%= Opal::GoogleMaps.google_maps(YOUR_API_KEY) %>
+```
+
+This will add a `<script>` tag to the rendered HTML with your API key.
+
+### Client-side
+
+If you're using this gem with Clearwater, you'll want to render it into a `Clearwater::BlackBoxNode` rather than a simple `Clearwater::Component`. The `BlackBoxNode` gives you callbacks for `mount`, `update`, and `unmount`, but the simpler components do not. For example:
+
+```ruby
+require 'clearwater/black_box_node' # It is not loaded with Clearwater by default
+require 'google/maps' # No need for the `opal` namespace
+
+class MyMap
+  include Clearwater::BlackBoxNode
+  include Google::Maps # So we don't have to namespace every constant
+
+  attr_reader :map
+
+  def node
+    # Important to set the dimensions of the map container
+    Clearwater::Component.div(style: { width: '600px', height: '600px' })
+  end
+
+  def mount(element)
+    # Need to delay this one animation frame so the div we specified above is
+    # actually in the rendered DOM. Google Maps needs to get the dimensions of
+    # the map from a fully rendered DOM node.
+    Bowser.window.animation_frame do
+      # Similar to the `google.maps.Map` namespace
+      @map = Map.new(
+        element, # passed into this method
+        center: LatLng.new(-34.397, 150.644), # Sydney, NSW, Australia
+        zoom: 8,
+      )
+    end
+  end
+
+  # Each time you render a BlackBoxNode, you get a new instance, so you need
+  # to copy it across instances if you want to operate on it across renders.
+  # If you're only rendering it and never doing anything with it, you can omit
+  # this method entirely.
+  def update(previous, element)
+    @map = previous.map
+  end
+end
+```
+
+### Loading other Google Maps JS libraries
+
+Google Maps has several additional libraries to choose from. To load them, add the `libraries` key to your server-side rendering call:
+
+```erb
+<%= Opal::GoogleMaps.google_maps(YOUR_API_KEY, libraries: %w[drawing geometry places visualization]) %>
+```
+
+### Loading Google Maps asynchronously
+
+You can use the `async` keyword argument to load the Google Maps libraries in a way that will not block rendering.
+
+```erb
+<%= Opal::GoogleMaps.google_maps(YOUR_API_KEY, async: true) %>
+```
+
+Keep in mind that this can cause problems if your app renders a map immediately on load. If you load Google Maps asynchronously, it isn't guaranteed to be loaded before your app. In such a case, you may get an error saying something to the effect of `google is not an object`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/jgaskins/opal-google_maps. 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.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Opal::GoogleMaps project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jgaskins/opal-google_maps/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "opal/google_maps"
+
+# 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/lib/opal/google_maps.rb

@@ -0,0 +1,12 @@
+require 'opal'
+require "opal/google_maps/version"
+
+module Opal
+  module GoogleMaps
+    def google_maps key, libraries: [], async: false
+      %{<script src="https://maps.googleapis.com/maps/api/js?key=#{key}&libraries=#{libraries.join(',')}"#{' async defer' if async}></script>}
+    end
+  end
+end
+
+Opal.append_path File.expand_path('../../../opal', __FILE__)

data/lib/opal/google_maps/version.rb

@@ -0,0 +1,5 @@
+module Opal
+  module GoogleMaps
+    VERSION = "0.1.0"
+  end
+end

data/opal-google_maps.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "opal/google_maps/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "opal-google_maps"
+  spec.version       = Opal::GoogleMaps::VERSION
+  spec.authors       = ["Jamie Gaskins"]
+  spec.email         = ["jgaskins@gmail.com"]
+
+  spec.summary       = %q{Opal bindings for Google Maps}
+  spec.homepage      = "https://github.com/jgaskins/opal-google_maps"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "opal", "~> 0.10.0"
+  spec.add_dependency "bowser" # Uses Bowser::EventTarget
+end

data/opal/google/maps.rb

@@ -0,0 +1,39 @@
+require 'bowser/event_target'
+require 'google/maps/map'
+require 'google/maps/delegate_native'
+
+module Google
+  module Maps
+    class LatLng
+      attr_reader :lat, :lng
+
+      def self.from_native native
+        new(`#{native}.lat()`, `#{native}.lng()`)
+      end
+
+      def initialize lat, lng
+        @lat = lat
+        @lng = lng
+      end
+
+      # An instance of this class can stand in for a google.maps.LatLng instance
+      def to_n
+        self
+      end
+
+      alias latitude lat
+      alias longitude lng
+    end
+
+    class Marker
+      include DelegateNative
+      include Bowser::EventTarget
+
+      def initialize options={}
+        @native = `new maps.Marker(#{options.to_n})`
+      end
+    end
+  end
+end
+
+require 'google/maps/map'

data/opal/google/maps/delegate_native.rb

@@ -0,0 +1,35 @@
+module Google
+  module Maps
+    module DelegateNative
+      %x{
+        var upper = function(char) { return char[char.length - 1].toUpperCase() };
+        var titleCase = function(string) {
+          return string.replace(/^\w|_\w/, upper)
+        };
+        var maps = google.maps;
+      }
+
+      def method_missing message, *args, &block
+        property = `titleCase(#{message})`
+
+        result = if `#@native['get' + #{property}]`
+                   puts "#{self.class}#get#{property}(#{args})"
+                   `#@native['get' + #{property}].apply(#@native, #{args})`
+                 elsif property.end_with?('=') && `#@native['set' + #{property.chop}]`
+                   puts "#{self.class}#set#{property.chop}(#{args})"
+                   `#@native['set' + #{property.chop}].apply(#@native, #{args})`
+                 else
+                   super
+                 end
+
+        if `#{result} instanceof maps.LatLng`
+          LatLng.from_native(result)
+        end
+      end
+
+      def to_n
+        @native
+      end
+    end
+  end
+end

data/opal/google/maps/map.rb

@@ -0,0 +1,17 @@
+require 'bowser/event_target'
+require 'google/maps/delegate_native'
+
+module Google
+  module Maps
+    class Map
+      include Bowser::EventTarget
+      include DelegateNative
+
+      def initialize element, options={}
+        @element = element
+        @options = options
+        @native = `new google.maps.Map(#{element.to_n}, #{options.to_n})`
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,130 @@
+--- !ruby/object:Gem::Specification
+name: opal-google_maps
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jamie Gaskins
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-08-29 00:00:00.000000000 Z
+dependencies:
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: opal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: bowser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- jgaskins@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/opal/google_maps.rb
+- lib/opal/google_maps/version.rb
+- opal-google_maps.gemspec
+- opal/google/maps.rb
+- opal/google/maps/delegate_native.rb
+- opal/google/maps/map.rb
+homepage: https://github.com/jgaskins/opal-google_maps
+licenses:
+- MIT
+metadata: {}
+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.6.12
+signing_key: 
+specification_version: 4
+summary: Opal bindings for Google Maps
+test_files: []