Class: Jekyll::Spaceship::MediaProcessor

Inherits:
Processor
  • Object
show all
Defined in:
lib/jekyll-spaceship/processors/media-processor.rb

Constant Summary

Constants inherited from Processor

Processor::DEFAULT_PRIORITY, Processor::PRIORITY_MAP

Instance Attribute Summary

Attributes inherited from Processor

#config, #exclusions, #handled, #logger, #page, #priority, #registers

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Processor

class_name, #converter, #dispatch, escape_html, exclude, #exclusion_regexs, #ext, fetch_img_data, #filename, #get_exclusion, handle_bang_link, #initialize, #initialize_exclusions, #initialize_priority, #initialize_register, make_img_tag, #name, #next?, #on_handle_html_block, #on_handled, #output_ext, #post_exclude, #pre_exclude, priority, #process?, register

Constructor Details

This class inherits a constructor from Jekyll::Spaceship::Processor

Class Method Details

.config ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 8

def self.config
  {
    'default' => {
      'id' => 'media-{id}',
      'class' => 'media',
      'width' => '100%',
      'height' => 350,
      'frameborder' => 0,
      'style' => 'max-width: 600px;outline: none',
      'allow' => 'encrypted-media; picture-in-picture'
    }
  }
end

Instance Method Details

#get_id_from_html(url, pattern) ⇒ Object 



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 233

def get_id_from_html(url, pattern)
  id = ''
  begin
    url = 'https:' + url if url.start_with? '//'
    res = Net::HTTP.get_response URI(url)
    raise res.body unless res.is_a?(Net::HTTPSuccess)
    res.body.match pattern do |match_data|
      id = match_data[0]
      break
    end
  rescue StandardError => msg
    data = url
    logger.log msg
  end
  id
end

#handle_audio(element, data) ⇒ Object 



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 176

def handle_audio(element, data)
  cfg = data[:cfg]
  html = "<audio"\
    " id=\"#{cfg['id']}\""\
    " class=\"#{cfg['class']}\""\
    " #{cfg['autoplay'] ? 'autoplay' : ''}"\
    " #{cfg['loop'] ? 'loop' : ''}"\
    " src=\"#{cfg['src']}\""\
    " style=\"#{cfg['style']}\""\
    " controls>" \
    " Your browser doesn't support HTML5 audio."\
    " Here is a <a href=\"#{cfg['src']}\">link to download the audio</a>"\
    " instead."\
    "</audio>"
  doc = Nokogiri::HTML(html)
  return if element.parent.nil?
  element.replace(doc.at('body').children.first)
end

#handle_dailymotion(element) ⇒ Object

Examples: ![dailymotion](www.dailymotion.com/video/x7tgcev) ![dailymotion](dai.ly/x7tgcev?height=100%&width=400)



90
91
92
93
94
95
96
97
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 90

def handle_dailymotion(element)
  handle_media(element, {
    media_type: 'iframe',
    host: '(https?:)?\\/\\/(?>www\\.)?dai\\.?ly(?>motion\\.com\\/video)?\\/',
    id: '([a-zA-Z0-9\\_\\-]+)',
    base_url: "https://www.dailymotion.com/embed/video/"
  })
end

#handle_iframe(element, data) ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 214

def handle_iframe(element, data)
  cfg = data[:cfg]
  html = "<iframe"\
    " id=\"#{cfg['id']}\""\
    " class=\"#{cfg['class']}\""\
    " src=\"#{cfg['src']}\""\
    " title=\"#{cfg['title']}\""\
    " width=\"#{cfg['width']}\""\
    " height=\"#{cfg['height']}\""\
    " style=\"#{cfg['style']}\""\
    " allow=\"#{cfg['allow']}\""\
    " frameborder=\"#{cfg['frameborder']}\""\
    " allowfullscreen>"\
    "</iframe>"
  doc = Nokogiri::HTML(html)
  return if element.parent.nil?
  element.replace(doc.at('body').children.first)
end

#handle_media(element, data) ⇒ Object 



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 126

def handle_media(element, data)
  host = data[:host]
  src = element.get_attribute('src')
  title = element.get_attribute('title')
  id = data[:id_from] === 'html' ? '()' : data[:id]
  match_data = src&.match(/#{host}#{id}\S*/)
  return if match_data.nil?

  media_type = data[:media_type]
  base_url = data[:base_url]
  id = data[:id_from] === 'html' \
    ? get_id_from_html(src, data[:id]) \
    : match_data[2]
  qs = src.match(/(?<=\?)(\S*?)$/)
  qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
    next true if v == id or v == ''
  end

  cfg = self.config['default'].clone
  cfg['id'] = qs['id'] || cfg['id']
  cfg['class'] = qs['class'] || cfg['class']
  cfg['style'] = qs['style'] || cfg['style']
  cfg['id'] = cfg['id'].gsub('{id}', id)
  cfg['class'] = cfg['class'].gsub('{id}', id)

  cfg['src'] = URI(base_url ? "#{base_url}#{id}" : src).tap do |v|
    v.query = URI.encode_www_form(qs) if qs.size > 0
  end

  case media_type
  when 'audio'
    cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
    cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
    cfg['style'] += ';display: none;' if qs['hidden']
    handle_audio(element, { cfg: cfg })
  when 'video'
    cfg['autoplay'] = qs['autoplay'] || data[:autoplay] || cfg['autoplay']
    cfg['loop'] = qs['loop'] || data[:loop] || cfg['loop']
    handle_video(element, { cfg: cfg })
  when 'iframe'
    cfg['title'] = title
    cfg['width'] = qs['width'] || data[:width] || cfg['width']
    cfg['height'] = qs['height'] || data[:height] || cfg['height']
    cfg['frameborder'] = qs['frameborder'] || cfg['frameborder']
    cfg['allow'] ||= cfg['allow']
    handle_iframe(element, { cfg: cfg })
  end
  self.handled = true
end

#handle_normal_audio(element) ⇒ Object

Examples: ![audio](//www.soundhelix.com/examples/mp3/SoundHelix-Song-1.mp3) ![audio](//www.expample.com/examples/t-rex-roar.mp3?autoplay=true&loop=true)



41
42
43
44
45
46
47
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 41

def handle_normal_audio(element)
  handle_media(element, {
    media_type: 'audio',
    host: '(https?:\\/\\/)?.*\\/',
    id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))'
  })
end

#handle_normal_video(element) ⇒ Object

Examples: ![video](//www.html5rocks.com/en/tutorials/video/basics/devstories.webm) ![video](//techslides.com/demos/sample-videos/small.ogv?allow=autoplay) ![video](//techslides.com/demos/sample-videos/small.mp4?width=400)



54
55
56
57
58
59
60
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 54

def handle_normal_video(element)
  handle_media(element, {
    media_type: 'video',
    host: '(https?:\\/\\/)?.*\\/',
    id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))'
  })
end

#handle_soundcloud(element) ⇒ Object

Examples: ![soundcloud](//soundcloud.com/aviciiofficial/preview-avicii-vs-lenny)



114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 114

def handle_soundcloud(element)
  handle_media(element, {
    media_type: 'iframe',
    id_from: 'html',
    host: '(https?:)?\\/\\/soundcloud\\.com\\/.+\\/[^\\?]+',
    id: '(?<=soundcloud:\\/\\/sounds:)([0-9]+)',
    base_url: "https://w.soundcloud.com/player/?url="\
      "https%3A//api.soundcloud.com/tracks/",
    height: 125,
  })
end

#handle_spotify(element) ⇒ Object

Examples: ![spotify](//open.spotify.com/track/4Dg5moVCTqxAb7Wr8Dq2T5) ![spotify](//open.spotify.com/track/37mEkAaqCE7FXMvnlVA8pp?width=400)



102
103
104
105
106
107
108
109
110
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 102

def handle_spotify(element)
  handle_media(element, {
    media_type: 'iframe',
    host: '(https?:)?\\/\\/open\\.spotify\\.com\\/track\\/',
    id: '(?<=track\\/)([a-zA-Z0-9\\_\\-]+)',
    base_url: "https://open.spotify.com/embed/track/",
    height: 80
  })
end

#handle_video(element, data) ⇒ Object 



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 195

def handle_video(element, data)
  cfg = data[:cfg]
  html = "<video"\
    " id=\"#{cfg['id']}\""\
    " class=\"#{cfg['class']}\""\
    " style=\"#{cfg['style']}\""\
    " #{cfg['autoplay'] ? 'autoplay' : ''}"\
    " #{cfg['loop'] ? 'loop' : ''}"\
    " controls>" \
    " <source src=\"#{cfg['src']}\">" \
    " Your browser doesn't support HTML5 video."\
    " Here is a <a href=\"#{cfg['src']}\">link to download the video</a>"\
    " instead."\
    "</video>"
  doc = Nokogiri::HTML(html)
  return if element.parent.nil?
  element.replace(doc.at('body').children.first)
end

#handle_vimeo(element) ⇒ Object

Examples: ![vimeo](vimeo.com/263856289) ![vimeo](vimeo.com/263856289?height=100%&width=400)



78
79
80
81
82
83
84
85
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 78

def handle_vimeo(element)
  handle_media(element, {
    media_type: 'iframe',
    host: '(https?:)?\\/\\/vimeo\\.com\\/',
    id: '([0-9]+)',
    base_url: "https://player.vimeo.com/video/"
  })
end

#handle_youtube(element) ⇒ Object

Examples: ![youtube](www.youtube.com/watch?v=XA2WjJbmmoM “title”) ![youtube](www.youtube.com/embed/w-m_yZCLF5Q) ![youtube](//youtu.be/mEP3YXaSww8?height=100%&width=400)



66
67
68
69
70
71
72
73
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 66

def handle_youtube(element)
  handle_media(element, {
    media_type: 'iframe',
    host: '(https?:)?\\/\\/.*youtu.*',
    id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
    base_url: "https://www.youtube.com/embed/"
  })
end

#on_handle_html(content) ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
 
# File 'lib/jekyll-spaceship/processors/media-processor.rb', line 22

def on_handle_html(content)
  # use nokogiri to parse html content
  doc = Nokogiri::HTML(content)
  # handle each img tag
  doc.css('img').each do |element|
    handle_normal_audio(element)
    handle_normal_video(element)
    handle_youtube(element)
    handle_vimeo(element)
    handle_dailymotion(element)
    handle_spotify(element)
    handle_soundcloud(element)
  end
  doc.to_html
end