markdown_media 1.3 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7c783195b2805f1968847903953f28c369539484
-  data.tar.gz: 9faf2d6ee457d0c93693cc4446c7cda2688fcfca
+SHA256:
+  metadata.gz: 16042959f63276782a51a0ba97464089d6c6811adfd01cfb5b2716fad4f4bd63
+  data.tar.gz: 73518ef8fa11dd100ba4d48a4ac63b0bdfb6e0b0c8a6596af229ae1025bde46f
 SHA512:
-  metadata.gz: 73d5056d1e39114551b9b50af7098428c9dc0d88e27915b2bbce98484a62d5bde01f47301cc61730c06ef10c3ff59f5216d5c419aca657bcd8ac30c83867bd97
-  data.tar.gz: 9521dfa197f1955358fe12a434044cc2982d0d48d354b093982643d75ef96bf17c52b14f62d5cd0191594146fb10c3a5ff50ee7b4477ceab2e30d1b358cff550
+  metadata.gz: 54f8455ae1329dcdaf788f4bede41cc4fead9db0a57aadd277dda643abe53cddb8a227a7967c3804dff2652d2de99aa960f780aa21a805b5fd87892666469c6e
+  data.tar.gz: 89f0b56692c2ed81352394decd441e10bbb9db7ce99fd3209ef5b7e7bd2ba00daea255173e097c4ffa568d4d3942f3b338d2a38a5e824a1a1740fb9937e7f3ff

data/README.md

@@ -2,30 +2,30 @@
 
 [![Build Status](https://travis-ci.org/veganstraightedge/markdown_media.svg?branch=master)](https://travis-ci.org/veganstraightedge/markdown_media)
 [![Code Climate](https://codeclimate.com/github/veganstraightedge/markdown_media/badges/gpa.svg)](https://codeclimate.com/github/veganstraightedge/markdown_media)
-![Version 1.0.0](https://img.shields.io/badge/VERSION-1.2.1-green.svg)
+![Version 1.6.0](https://img.shields.io/badge/VERSION-1.6.0-green.svg)
 
 This syntax uses doubles square brackets on each side of a URL and optional options.
-It expands into the current preferred embed code for that site's media or raw media.
+It expands into the current preferred embed code for that site’s media or raw media.
 Supported media types: YouTube, Vimeo, Instagram, Twitter, Daily Motion, images, videos, audios.
 
 
 ## Installation
 
-Add this line to your application's Gemfile:
+Add this line to your application’s Gemfile:
 
 ```ruby
-gem "markdown_media"
+gem 'markdown_media'
 ```
 
 And then execute:
 
-```
+```sh
 bundle
 ```
 
 Or install it yourself as:
 
-```
+```sh
 gem install markdown_media
 ```
 
@@ -34,11 +34,11 @@ gem install markdown_media
 
 ### As a Writer
 
-This a syntax that can sit on top of Markdown (or any templating format, except MediaWiki which already uses the double square bracket syntax). The purpose is to simplify adding images (with or without caption and optionally linked), videos, tweets, audio, etc for writers in a CMS. The HTML that we want for a video is different from an image. But as a writer, it's conceptually the same, "here's a piece of media and its caption, stick it in the page right here".
+This a syntax that can sit on top of Markdown (or any templating format, except MediaWiki which already uses the double square bracket syntax). The purpose is to simplify adding images (with or without caption and optionally linked), videos, tweets, audio, etc for writers in a CMS. The HTML that we want for a video is different from an image. But as a writer, it’s conceptually the same, “here’s a piece of media and its caption, stick it in the page right here”.
 
-So, the media embed syntax makes it so you don't have to think about the differences between YouTube, Vimeo, Twitter and an image. Here's how it works.
+So, the media embed syntax makes it so you don’t have to think about the differences between YouTube, Vimeo, Twitter and an image. Here’s how it works.
 
-There are six pieces. Some are required. Some are optional. It must always be on one line. But for explanation here, I'll put them on separate lines, then tie it all together.
+There are six pieces. Some are required. Some are optional. It must always be on one line. But for explanation here, I’ll put them on separate lines, then tie it all together.
 
 ```
 [[
@@ -51,7 +51,7 @@ type (used for Twitter video)
 ]]
 ```
 
-Here's what they all mean.
+Here’s what they all mean.
 
 - **Required**. Always put a blank line above the media embed
 - **Required**. Always start the media embed with two left square brackets (no space between them).
@@ -64,14 +64,14 @@ Here's what they all mean.
 
 ### As a Developer
 
-```
-MarkdownMedia.parse("[[https://example.com/photo.png]]")
+```ruby
+MarkdownMedia.parse('[[https://example.com/photo.png]]')
 ```
 
 In Rails, you might also need to add `.html_safe` to avoid escaping.
 
-```
-MarkdownMedia.parse("[[https://example.com/photo.png]]").html_safe
+```ruby
+MarkdownMedia.parse('[[https://example.com/photo.png]]').html_safe
 ```
 
 ### Examples
@@ -87,13 +87,13 @@ A simple image.
 An image with a caption.
 
 ```
-[[https://example.com/image.png Look at me, I'm a caption!]]
+[[https://example.com/image.png Look at me, I’m a caption!]]
 ```
 
 An image with Markdown in the caption.
 
 ```
-[[https://example.com/image.png _Look at me_, I'm a **caption**!]]
+[[https://example.com/image.png _Look at me_, I’m a **caption**!]]
 ```
 
 An image linked to a URL (requires a caption present).
@@ -146,12 +146,18 @@ A video from YouTube with caption.
 [[https://www.youtube.com/watch?v=YX40hbAHx3s P vs. NP and the Computational Complexity Zoo]]
 ```
 
-YouTube's short URL format also works.
+YouTube’s short URL format also works.
 
 ```
 [[https://youtu.be/YX40hbAHx3s]]
 ```
 
+YouTube’s embed URL format also works.
+
+```
+[[https://www.youtube.com/embed/YX40hbAHx3s]]
+```
+
 A video from Daily Motion.
 
 ```
@@ -164,6 +170,18 @@ A video from Twitter.
 [[https://twitter.com/Breaking911/status/900211169734131713 type:video]]
 ```
 
+A video/gif from Giphy.
+
+```
+[[https://giphy.com/gifs/cat-funny-OrNbkY7oQOrh6]]
+```
+
+A video/gif from Giphy with caption.
+
+```
+[[https://giphy.com/gifs/cat-funny-OrNbkY7oQOrh6 Dogs and cats are buddies.]]
+```
+
 #### Audio
 
 A simple audio.
@@ -183,10 +201,16 @@ A simple audio with caption.
 Any URL in a [[]] block that is unrecognized, just gets rendered into a linked URL.
 
 ```
-[[https://veganstraightedge.com/cancer]] gets turned into <a href="https://veganstraightedge.com/cancer">https://veganstraightedge.com/cancer</a>.
+[[https://veganstraightedge.com/cancer]]
+```
+
+That gets turned into this.
+
+```html
+<a href='https://veganstraightedge.com/cancer'>https://veganstraightedge.com/cancer</a>.
 ```
 
-If you try to embed some piece of media and it renders to a URL that means that that kind of URL isn't supported yet. But don't distress, new sites are pretty easy to add. So, raise a flag in Slack or GitHub Issues.
+If you try to embed some piece of media and it renders to a URL that means that that kind of URL isn’t supported yet. But don’t distress, new sites are pretty easy to add. So, raise a flag in Slack or GitHub Issues.
 
 ### Supported Media URLs
 
@@ -207,6 +231,7 @@ Here are the currently supported URLs and media types.
 - https://youtu.be/video-id
 - http://www.dailymotion.com/video/video-id_video-slug
 - https://twitter.com/Breaking911/status/900211169734131713
+- https://giphy.com/gifs/cat-funny-OrNbkY7oQOrh6
 
 #### Audios
 
@@ -250,6 +275,6 @@ Your heart is as free as the air you breathe. <br>
 The ground you stand on is liberated territory.
 
 In legal text, *Markdown Media* is dedicated to the public domain
-using Creative Commons -- CC0 1.0 Universal.
+using Creative Commons — CC0 1.0 Universal.
 
-[http://creativecommons.org/publicdomain/zero/1.0](http://creativecommons.org/publicdomain/zero/1.0 "Creative Commons &mdash; CC0 1.0 Universal")
+[http://creativecommons.org/publicdomain/zero/1.0](http://creativecommons.org/publicdomain/zero/1.0 "Creative Commons — CC0 1.0 Universal")

data/lib/markdown_media.rb

@@ -7,7 +7,7 @@ module MarkdownMedia
   EMBED_REGEX = /\[\[\s*(http[^\]\s]+(?:\s.+)?)\s*\]\]/
 
   class << self
-    def parse(text)
+    def parse(text, include_media: true)
       output = text.gsub(EMBED_REGEX) do
         embed_tag = $1
 
@@ -25,7 +25,13 @@ module MarkdownMedia
 
           caption = embed_tag_pieces.join(" ")
 
-          expanded_embed(url, caption: caption, link: link, id: id, type: type, klass: klass)
+          expanded_embed(url,
+                         caption:       caption,
+                         link:          link,
+                         id:            id,
+                         type:          type,
+                         klass:         klass,
+                         include_media: include_media)
         end
       end
 
@@ -75,55 +81,86 @@ module MarkdownMedia
       end
     end
 
-    def expanded_embed(url, caption: nil, link: nil, id: nil, type: nil, klass: nil)
+    def expanded_embed(url, caption: nil, link: nil, id: nil, type: nil, klass: nil, include_media: true)
       url  = URI.parse(url)
 
-      case url.host
-      when /youtube.com/
+      options    = extract_options(url: url, include_media: include_media)
+      slug       = options[:slug]
+      embed_id   = options[:embed_id]
+      type     ||= options[:type]
+
+      render_erb slug, {
+        embed_id: embed_id || url.to_s,
+        caption:  caption,
+        link:     link,
+        id:       id,
+        type:     type,
+        klass:    klass
+      }
+    end
+
+    # TODO: there’s got to be a better way, refactor to classes
+    def extract_options url:, include_media: true
+      type = nil
+
+      if url.to_s =~ %r{youtube.com/embed}
         slug     = "youtube"
-        embed_id = nil
+        embed_id = url.path.split("/embed/")[1]
+      else
+
+        case url.host
+        when /youtube.com/
+          slug     = "youtube"
+          embed_id = nil
 
-        url.query.split("&").each do |key_value_pair|
-          argument, value = key_value_pair.split("=")
-          if argument == "v"
-            embed_id = value
+          url.query.split("&").each do |key_value_pair|
+            argument, value = key_value_pair.split("=")
+            if argument == "v"
+              embed_id = value
+            end
           end
-        end
 
-      when "youtu.be"
-        slug     = "youtube"
-        embed_id = url.path.split("/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first
+        when "youtu.be"
+          slug     = "youtube"
+          embed_id = url.path.split("/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first
 
-      when /dailymotion.com/
-        slug     = "dailymotion"
-        embed_id = url.path.split("/video/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first.split("_").first
+        when /dailymotion.com/
+          slug     = "dailymotion"
+          embed_id = url.path.split("/video/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first.split("_").first
 
-      when "vimeo.com"
-        slug     = "vimeo"
-        embed_id = url.path.split("/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first
+        when "vimeo.com"
+          slug     = "vimeo"
+          embed_id = url.path.split("/").map{ |path_piece| path_piece unless path_piece.to_s.empty? }.compact.first
 
-      when "twitter.com"
-        slug     = "twitter"
-        type   ||= "tweet"
+        when "twitter.com"
+          slug     = "twitter"
+          type   ||= "tweet"
 
-      when /instagram/
-        slug     = "instagram"
+        when /instagram/
+          slug     = "instagram"
+
+        when "giphy.com"
+          slug     = "giphy"
+          embed_id = url.path.split("/").last.split('-').last
 
-      else
-        slug = case url.path
-
-        when /\.mp3|\.aac|\.wav|\.ogg|\.oga|\.m4a/
-          "audio"
-        when /\.mp4|\.avi|\.mov|\.ogv|\.webm|\.m4v|\.3gp|\.m3u8/
-          "video"
-        when /\.png|\.jpeg|\.jpg|\.gif|\.svg/
-          "image"
         else
-          "link"
+          slug =
+            case url.path
+            when /\.mp3|\.aac|\.wav|\.ogg|\.oga|\.m4a/
+              "audio"
+            when /\.mp4|\.avi|\.mov|\.ogv|\.webm|\.m4v|\.3gp|\.m3u8/
+              "video"
+            when /\.png|\.jpeg|\.jpg|\.gif|\.svg/
+              "image"
+            else
+              "link"
+            end
         end
       end
 
-      render_erb slug, { embed_id: embed_id || url.to_s, caption: caption, link: link, id: id, type: type, klass: klass }
+      slug = 'link' if include_media == false
+
+      { slug: slug, embed_id: embed_id, type: type }
     end
 
     def render_erb(template_slug, locals)

data/lib/markdown_media/version.rb

@@ -1,3 +1,3 @@
 module MarkdownMedia
-  VERSION = "1.3"
+  VERSION = "1.7.0"
 end

data/lib/templates/giphy.erb

@@ -0,0 +1,11 @@
+<figure class="video-container <%= klass %>" id="<%= id %>">
+  <div style="width:100%;height:0;padding-bottom:56%;position:relative;">
+    <iframe src="https://giphy.com/embed/<%= embed_id %>" width="100%" height="100%" frameborder="0" class="giphy-embed" webkitallowfullscreen mozallowfullscreen allowFullScreen></iframe>
+  </div>
+
+  <% unless caption.to_s.empty? %>
+    <figcaption class="caption video-caption video-caption-giphy">
+      <%= MarkdownMedia.render_markdown caption %>
+    </figcaption>
+  <% end %>
+</figure>

data/lib/templates/instagram.erb

@@ -1,14 +1,24 @@
-<blockquote class="instagram-media <%= klass %>" id="<%= id %>" data-instgrm-version="7" style=" background:#FFF; border:0; border-radius:3px; box-shadow:0 0 1px 0 rgba(0,0,0,0.5),0 1px 10px 0 rgba(0,0,0,0.15); margin: 1px; max-width:658px; padding:0; width:99.375%; width:-webkit-calc(100% - 2px); width:calc(100% - 2px);">
-  <div style="padding:8px;">
-    <div style=" background:#F8F8F8; line-height:0; margin-top:40px; padding:50.0% 0; text-align:center; width:100%;">
-      <div style=" background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAMAAAApWqozAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAMUExURczMzPf399fX1+bm5mzY9AMAAADiSURBVDjLvZXbEsMgCES5/P8/t9FuRVCRmU73JWlzosgSIIZURCjo/ad+EQJJB4Hv8BFt+IDpQoCx1wjOSBFhh2XssxEIYn3ulI/6MNReE07UIWJEv8UEOWDS88LY97kqyTliJKKtuYBbruAyVh5wOHiXmpi5we58Ek028czwyuQdLKPG1Bkb4NnM+VeAnfHqn1k4+GPT6uGQcvu2h2OVuIf/gWUFyy8OWEpdyZSa3aVCqpVoVvzZZ2VTnn2wU8qzVjDDetO90GSy9mVLqtgYSy231MxrY6I2gGqjrTY0L8fxCxfCBbhWrsYYAAAAAElFTkSuQmCC); display:block; height:44px; margin:0 auto -44px; position:relative; top:-22px; width:44px;"></div>
+<figure class="video-container <%= klass %>" id="<%= id %>">
+  <blockquote class="instagram-media"
+              data-instgrm-version="7"
+              style="background:#FFF; border:0; border-radius:3px; box-shadow:0 0 1px 0 rgba(0,0,0,0.5),0 1px 10px 0 rgba(0,0,0,0.15); max-width:658px; padding:0; width:99.375%; width:-webkit-calc(100% - 2px); width:calc(100% - 2px);">
+    <div style="padding:8px;">
+      <div style=" background:#F8F8F8; line-height:0; margin-top:40px; padding:50.0% 0; text-align:center; width:100%;">
+        <div style="background:url(data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACwAAAAsCAMAAAApWqozAAAABGdBTUEAALGPC/xhBQAAAAFzUkdCAK7OHOkAAAAMUExURczMzPf399fX1+bm5mzY9AMAAADiSURBVDjLvZXbEsMgCES5/P8/t9FuRVCRmU73JWlzosgSIIZURCjo/ad+EQJJB4Hv8BFt+IDpQoCx1wjOSBFhh2XssxEIYn3ulI/6MNReE07UIWJEv8UEOWDS88LY97kqyTliJKKtuYBbruAyVh5wOHiXmpi5we58Ek028czwyuQdLKPG1Bkb4NnM+VeAnfHqn1k4+GPT6uGQcvu2h2OVuIf/gWUFyy8OWEpdyZSa3aVCqpVoVvzZZ2VTnn2wU8qzVjDDetO90GSy9mVLqtgYSy231MxrY6I2gGqjrTY0L8fxCxfCBbhWrsYYAAAAAElFTkSuQmCC); display:block; height:44px; margin:0 auto -44px; position:relative; top:-22px; width:44px;"></div>
+      </div>
+
+      <p style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; line-height:17px; margin-bottom:0; margin-top:8px; overflow:hidden; padding:8px 0 7px; text-align:center; text-overflow:ellipsis; white-space:nowrap;">
+        <a href="<%= embed_id.to_s %>" style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; font-style:normal; font-weight:normal; line-height:17px; text-decoration:none;" target="_blank">
+          <%= embed_id.to_s %>
+        </a>
+      </p>
     </div>
+  </blockquote>
+  <script async defer src="https://platform.instagram.com/en_US/embeds.js"></script>
 
-    <p style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; line-height:17px; margin-bottom:0; margin-top:8px; overflow:hidden; padding:8px 0 7px; text-align:center; text-overflow:ellipsis; white-space:nowrap;">
-      <a href="<%= embed_id.to_s %>" style=" color:#c9c8cd; font-family:Arial,sans-serif; font-size:14px; font-style:normal; font-weight:normal; line-height:17px; text-decoration:none;" target="_blank">
-        <%= embed_id.to_s %>
-      </a>
-    </p>
-  </div>
-</blockquote>
-<script async defer src="https://platform.instagram.com/en_US/embeds.js"></script>
+  <% unless caption.to_s.empty? %>
+    <figcaption class="caption video-caption" style="max-width:658px;">
+      <%= MarkdownMedia.render_markdown caption %>
+    </figcaption>
+  <% end %>
+</figure>

data/lib/templates/link.erb

@@ -1 +1,3 @@
-<a href="<%= embed_id.to_s %>" id="<%= id %>" class="<%= klass %>"><%= caption.to_s.empty? ? embed_id.to_s.sub(/^https*:\/\//, "").sub(/\/$/, "") : caption %></a>
+<a href="<%= embed_id.to_s %>" id="<%= id %>" class="<%= klass %>">
+  <%= caption.to_s.empty? ? embed_id.to_s.sub(/^https*:\/\//, "").sub(/\/$/, "") : caption %>
+</a>

data/markdown_media.gemspec

@@ -28,9 +28,9 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency "bundler", "~> 1.14"
-  spec.add_development_dependency "rake",    "~> 10.0"
-  spec.add_development_dependency "rspec",   "~> 3.7"
+  spec.add_development_dependency "bundler"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
 
   spec.add_runtime_dependency "kramdown"
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: markdown_media
 version: !ruby/object:Gem::Version
-  version: '1.3'
+  version: 1.7.0
 platform: ruby
 authors:
 - Shane Becker
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2017-12-19 00:00:00.000000000 Z
+date: 2021-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.14'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: kramdown
   requirement: !ruby/object:Gem::Requirement
@@ -90,6 +90,7 @@ files:
 - lib/markdown_media/version.rb
 - lib/templates/audio.erb
 - lib/templates/dailymotion.erb
+- lib/templates/giphy.erb
 - lib/templates/image.erb
 - lib/templates/instagram.erb
 - lib/templates/link.erb
@@ -102,7 +103,7 @@ homepage: https://github.com/veganstraightedge/markdown_media
 licenses:
 - CC0
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -117,9 +118,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: A [[ URL ]] syntax to embed media into views.
 test_files: []