mirror of
https://github.com/SharpeTronics/jekyll-spaceship.git
synced 2025-06-24 00:01:24 -04:00
Compare commits
No commits in common. "master" and "v0.8.3" have entirely different histories.
@ -1,8 +1,8 @@
|
||||
language: ruby
|
||||
cache: bundler
|
||||
rvm:
|
||||
- 2.7
|
||||
- 2.3
|
||||
- 2.7
|
||||
- 2.3
|
||||
env:
|
||||
global:
|
||||
- NOKOGIRI_USE_SYSTEM_LIBRARIES=true
|
||||
@ -15,8 +15,8 @@ matrix:
|
||||
- rvm: 2.7
|
||||
env: JEKYLL_VERSION=">= 4.0.0"
|
||||
before_install:
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
- gem update --system
|
||||
- gem install bundler
|
||||
before_script: bundle update
|
||||
script: script/cibuild
|
||||
notifications:
|
||||
|
||||
146
README.md
146
README.md
@ -101,20 +101,16 @@ Spaceship is a minimalistic, powerful and extremely customizable [Jekyll](https:
|
||||
- [1.3 Headerless](#headerless)
|
||||
- [1.4 Cell Alignment](#cell-alignment)
|
||||
- [1.5 Cell Markdown](#cell-markdown)
|
||||
- [1.6 Cell Inline Attributes](#cell-inline-attributes)
|
||||
- [2. MathJax Usage](#2-mathjax-usage)
|
||||
- [2.1 Performance Optimization](#21-performance-optimization)
|
||||
- [2.2 How to use?](#22-how-to-use)
|
||||
- [3. PlantUML Usage](#3-plantuml-usage)
|
||||
- [4. Mermaid Usage](#4-mermaid-usage)
|
||||
- [5. Media Usage](#5-media-usage)
|
||||
- [5. Video Usage](#5-video-usage)
|
||||
- [5.1 Youtube Usage](#youtube-usage)
|
||||
- [5.2 Vimeo Usage](#vimeo-usage)
|
||||
- [5.3 DailyMotion Usage](#dailymotion-usage)
|
||||
- [5.4 Spotify Usage](#spotify-usage)
|
||||
- [5.5 SoundCloud Usage](#soundcloud-usage)
|
||||
- [5.6 General Video Usage](#general-video-usage)
|
||||
- [5.7 General Audio Usage](#general-audio-usage)
|
||||
- [5.4 General Video Usage](#general-video-usage)
|
||||
- [6. Hybrid HTML with Markdown](#6-hybrid-html-with-markdown)
|
||||
- [7. Markdown Polyfill](#7-markdown-polyfill)
|
||||
- [7.1 Escape Ordered List](#71-escape-ordered-list)
|
||||
@ -146,7 +142,7 @@ plugins:
|
||||
|
||||
**💡 Tip:** Note that GitHub Pages runs in `safe` mode and only allows [a set of whitelisted plugins](https://pages.github.com/versions/). To use the gem in GitHub Pages, you need to build locally or use CI (e.g. [travis](https://travis-ci.org/), [github workflow](https://help.github.com/en/actions/configuring-and-managing-workflows/configuring-a-workflow)) and deploy to your `gh-pages` branch.
|
||||
|
||||
### Additions for Unlimited GitHub Pages
|
||||
### Additions
|
||||
|
||||
* Here is a GitHub Action named [jekyll-deploy-action](https://github.com/jeffreytse/jekyll-deploy-action) for Jekyll site deployment conveniently. 👍
|
||||
* Here is a [Jekyll site](https://github.com/jeffreytse/jekyll-jeffreytse-blog) using Travis to build and deploy to GitHub Pages for your references.
|
||||
@ -165,20 +161,16 @@ jekyll-spaceship:
|
||||
- plantuml-processor
|
||||
- mermaid-processor
|
||||
- polyfill-processor
|
||||
- media-processor
|
||||
- video-processor
|
||||
- emoji-processor
|
||||
- element-processor
|
||||
mathjax-processor:
|
||||
src:
|
||||
- https://polyfill.io/v3/polyfill.min.js?features=es6
|
||||
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
|
||||
src: //cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML
|
||||
config:
|
||||
tex:
|
||||
tex2jax:
|
||||
inlineMath:
|
||||
- ['$','$']
|
||||
- ['\(','\)']
|
||||
svg:
|
||||
fontCache: 'global'
|
||||
plantuml-processor:
|
||||
mode: default # mode value 'pre-fetch' for fetching image at building stage
|
||||
css:
|
||||
@ -186,7 +178,7 @@ jekyll-spaceship:
|
||||
syntax:
|
||||
code: 'plantuml!'
|
||||
custom: ['@startuml', '@enduml']
|
||||
src: http://www.plantuml.com/plantuml/svg/
|
||||
src: http://www.plantuml.com/plantuml/png/
|
||||
mermaid-processor:
|
||||
mode: default # mode value 'pre-fetch' for fetching image at building stage
|
||||
css:
|
||||
@ -197,14 +189,14 @@ jekyll-spaceship:
|
||||
config:
|
||||
theme: default
|
||||
src: https://mermaid.ink/svg/
|
||||
media-processor:
|
||||
video-processor:
|
||||
default:
|
||||
id: 'media-{id}'
|
||||
class: 'media'
|
||||
id: 'video-{id}'
|
||||
class: 'video'
|
||||
width: '100%'
|
||||
height: 350
|
||||
frameborder: 0
|
||||
style: 'max-width: 600px; outline: none;'
|
||||
border: 0
|
||||
style: 'max-width: 600px'
|
||||
allow: 'encrypted-media; picture-in-picture'
|
||||
emoji-processor:
|
||||
css:
|
||||
@ -542,61 +534,6 @@ Rowspan is 4
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
#### Cell Inline Attributes
|
||||
|
||||
This feature is very useful for custom cell such as using inline style. (e.g., background, color, font)
|
||||
The idea and syntax comes from the [Maruku](http://maruku.rubyforge.org/) package.
|
||||
|
||||
[](https://kramdown.gettalong.org/syntax.html#block-ials)
|
||||
|
||||
Following are some examples of attributes definitions (ALDs) and afterwards comes the syntax explanation:
|
||||
|
||||
```markdown
|
||||
{:ref-name: #id .cls1 .cls2}
|
||||
{:second: ref-name #id-of-other title="hallo you"}
|
||||
{:other: ref-name second}
|
||||
```
|
||||
|
||||
An ALD line has the following structure:
|
||||
|
||||
- a left brace, optionally preceded by up to three spaces,
|
||||
- followed by a colon, the id and another colon,
|
||||
- followed by attribute definitions (allowed characters are backslash-escaped closing braces or any character except a not escaped closing brace),
|
||||
- followed by a closing brace and optional spaces until the end of the line.
|
||||
|
||||
If there is more than one ALD with the same reference name, the attribute definitions of all the ALDs are processed like they are defined in one ALD.
|
||||
|
||||
An inline attribute list (IAL) is used to attach attributes to another element.
|
||||
Here are some examples for span IALs:
|
||||
|
||||
```markdown
|
||||
{: #id .cls1 .cls2} <!-- #id <=> id="id", .cls1 .cls2 <=> class="cls1 cls2" -->
|
||||
{: ref-name title="hallo you"}
|
||||
{: ref-name class='.cls3' .cls4}
|
||||
```
|
||||
|
||||
Here is an example for custom table cell with IAL:
|
||||
|
||||
```markdown
|
||||
{:color-style: style="background: black;"}
|
||||
{:color-style: style="color: white;"}
|
||||
{:text-style: style="font-weight: 800; text-decoration: underline;"}
|
||||
|
||||
|: Here's an Inline Attribute Lists example :||||
|
||||
| ------- | ------------------ | -------------------- | ------------------ |
|
||||
|: :|: <div style="color: red;"> < Normal HTML Block > </div> :|||
|
||||
| ^^ | Red {: .cls style="background: orange" } |||
|
||||
| ^^ IALs | Green {: #id style="background: green; color: white" } |||
|
||||
| ^^ | Blue {: style="background: blue; color: white" } |||
|
||||
| ^^ | Black {: color-style text-style } |||
|
||||
```
|
||||
|
||||
Code above would be parsed as:
|
||||
|
||||
<img width="580px" src="https://user-images.githubusercontent.com/9413601/88461592-738afb00-ced7-11ea-9aac-3179023742b0.png" alt="IALs">
|
||||
|
||||
Additionally, [here](https://kramdown.gettalong.org/syntax.html#block-ials) you can learn more details about IALs.
|
||||
|
||||
### 2. MathJax Usage
|
||||
|
||||
[MathJax](http://www.mathjax.org/) is an open-source JavaScript display engine for LaTeX, MathML, and AsciiMath notation that works in all modern browsers.
|
||||
@ -637,7 +574,7 @@ Code above would be parsed as:
|
||||
|
||||
### 3. PlantUML Usage
|
||||
|
||||
[PlantUML](https://plantuml.com) is a component that allows to quickly write:
|
||||
[PlantUML](http://plantuml.sourceforge.net/) is a component that allows to quickly write:
|
||||
|
||||
- sequence diagram,
|
||||
- use case diagram,
|
||||
@ -708,31 +645,25 @@ Code above would be parsed as:
|
||||
|
||||
|
||||
|
||||
### 5. Media Usage
|
||||
### 5. Video Usage
|
||||
|
||||
How often did you find yourself googling "**How to embed a video/audio in markdown?**"
|
||||
How often did you find yourself googling "**How to embed a video in markdown?**"
|
||||
|
||||
While its not possible to embed a video/audio in markdown, the best and easiest
|
||||
way is to extract a frame from the video/audio. To add videos/audios to your
|
||||
markdown files easier I developped this tool for you, and it will parse the
|
||||
video/audio link inside the image block automatically.
|
||||
While its not possible to embed a video in markdown, the best and easiest way is to extract a frame from the video. To add videos to your markdown files easier I developped this tool for you, and it will parse the video link inside the image block automatically.
|
||||
|
||||
**For now, these media links parsing are provided:**
|
||||
**For now, these video links parsing are provided:**
|
||||
|
||||
- Youtube
|
||||
- Vimeo
|
||||
- DailyMotion
|
||||
- Spotify
|
||||
- SoundCloud
|
||||
- General Video ( mp4 | avi | ogg | ogv | webm | 3gp | flv | mov ... )
|
||||
- General Audio ( mp3 | wav | ogg | mid | midi | aac | wma ... )
|
||||
- General Video ( mp4 | avi | webm | ogg | ogv | 3gp | flv | mov ... )
|
||||
|
||||
There are two ways to embed a video/audio in your Jekyll blog page:
|
||||
There are two ways to embed a video in your Jekyll blog page:
|
||||
|
||||
Inline-style:
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
```
|
||||
|
||||
Reference-style:
|
||||
@ -740,10 +671,10 @@ Reference-style:
|
||||
```markdown
|
||||
![][{reference}]
|
||||
|
||||
[{reference}]: {media-link}
|
||||
[{reference}]: {video-link}
|
||||
```
|
||||
|
||||
For configuring media attributes (e.g, width, height), just adding query string to
|
||||
For configuring video attributes (e.g, width, height), just adding query string to
|
||||
the link as below:
|
||||
|
||||
```markdown
|
||||
@ -776,22 +707,6 @@ the link as below:
|
||||
|
||||
```
|
||||
|
||||
#### Spotify Usage
|
||||
|
||||
```markdown
|
||||
|
||||
```
|
||||
|
||||
<image width="600" src="https://user-images.githubusercontent.com/9413601/89762618-5d11b000-db23-11ea-81db-35cc3682b234.png">
|
||||
|
||||
#### SoundCloud Usage
|
||||
|
||||
```markdown
|
||||
|
||||
```
|
||||
|
||||
<image width="600" src="https://user-images.githubusercontent.com/9413601/89762969-1c666680-db24-11ea-97e3-4340f7fac7ac.png">
|
||||
|
||||
#### General Video Usage
|
||||
|
||||
```markdown
|
||||
@ -802,15 +717,6 @@ the link as below:
|
||||
|
||||
```
|
||||
|
||||
#### General Audio Usage
|
||||
|
||||
```markdown
|
||||
|
||||
|
||||
|
||||
```
|
||||
|
||||
<image width="300" src="https://user-images.githubusercontent.com/9413601/89762143-68181080-db22-11ea-8467-e8b2a8a96ae5.png">
|
||||
|
||||
### 6. Hybrid HTML with Markdown
|
||||
|
||||
@ -966,7 +872,7 @@ Automatically adds a `target="_blank" rel="noopener noreferrer"` attribute to al
|
||||
jekyll-spaceship:
|
||||
element-processor:
|
||||
css:
|
||||
- a: # Replace all `a` tags
|
||||
- a: # Replce all `a` tags
|
||||
props:
|
||||
class: ['(^.*$)', '\0 ext-link'] # Add `ext-link` to class by regex pattern
|
||||
target: _blank # Replace `target` value to `_blank`
|
||||
@ -982,9 +888,9 @@ Automatically adds `loading="lazy"` to `img` and `iframe` tags to natively load
|
||||
jekyll-spaceship:
|
||||
element-processor:
|
||||
css:
|
||||
- a: # Replace all `a` tags
|
||||
- a: # Replce all `a` tags
|
||||
props: #
|
||||
loading: lazy # Replace `loading` value to `lazy`
|
||||
loading: lazy # Replace `lading` value to `lazy`
|
||||
```
|
||||
|
||||
In case you want to prevent loading some images/iframes lazily, add
|
||||
@ -997,7 +903,7 @@ See the following examples to prevent lazy loading.
|
||||
jekyll-spaceship:
|
||||
element-processor:
|
||||
css:
|
||||
- a: # Replace all `a` tags
|
||||
- a: # Replce all `a` tags
|
||||
props: #
|
||||
loading: eager # Replace `loading` value to `eager`
|
||||
```
|
||||
|
||||
@ -9,7 +9,7 @@ Gem::Specification.new do |spec|
|
||||
spec.version = Jekyll::Spaceship::VERSION
|
||||
spec.authors = ["jeffreytse"]
|
||||
spec.email = ["jeffreytse.mail@gmail.com"]
|
||||
spec.summary = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, audio, youtube, vimeo, dailymotion, spotify, soundcloud, etc."
|
||||
spec.summary = "A Jekyll plugin to provide powerful supports for table, mathjax, plantuml, mermaid, emoji, video, youtube, vimeo, dailymotion, etc."
|
||||
spec.homepage = "https://github.com/jeffreytse/jekyll-spaceship"
|
||||
spec.license = "MIT"
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ module Jekyll::Spaceship
|
||||
'plantuml-processor',
|
||||
'mermaid-processor',
|
||||
'polyfill-processor',
|
||||
'media-processor',
|
||||
'video-processor',
|
||||
'emoji-processor',
|
||||
'element-processor'
|
||||
]
|
||||
|
||||
@ -69,7 +69,7 @@ module Jekyll::Spaceship
|
||||
end
|
||||
|
||||
def self.ext(page)
|
||||
ext = page.path.match(/\.[^.]+$/)
|
||||
ext = page.path.match(/\.\S+$/)
|
||||
ext.to_s.rstrip
|
||||
end
|
||||
|
||||
|
||||
@ -65,7 +65,7 @@ module Jekyll::Spaceship
|
||||
|
||||
def initialize_exclusions
|
||||
if @@_exclusions.size.zero?
|
||||
self.class.exclude :code, :math, :liquid_filter
|
||||
self.class.exclude :code, :math
|
||||
end
|
||||
@exclusions = @@_exclusions.uniq
|
||||
@@_exclusions.clear
|
||||
@ -116,12 +116,12 @@ module Jekyll::Spaceship
|
||||
if self.respond_to? method
|
||||
@page.content = self.pre_exclude @page.content
|
||||
@page.content = self.send method, @page.content
|
||||
@page.content = self.post_exclude @page.content
|
||||
@page.content = self.after_exclude @page.content
|
||||
end
|
||||
else
|
||||
if Type.html? output_ext
|
||||
method = 'on_handle_html'
|
||||
elsif Type.css? output_ext
|
||||
elsif css? output_ext
|
||||
method = 'on_handle_css'
|
||||
end
|
||||
if self.respond_to? method
|
||||
@ -151,40 +151,31 @@ module Jekyll::Spaceship
|
||||
logger.log file
|
||||
end
|
||||
|
||||
def exclusion_regexs()
|
||||
regexs = []
|
||||
def pre_exclude(content)
|
||||
@exclusion_store = []
|
||||
@exclusions.each do |type|
|
||||
regex = nil
|
||||
if type == :code
|
||||
regex = /(((?<!\\)`+)\s*(\w*)((?:.|\n)*?)\2)/
|
||||
regex = /((`+)\s*(\w*)((?:.|\n)*?)\2)/
|
||||
elsif type == :math
|
||||
regex = /(((?<!\\)\${1,2})[^\n]*?\1)/
|
||||
elsif type == :liquid_filter
|
||||
regex = /((?<!\\)((\{\{[^\n]*?\}\})|(\{%[^\n]*?%\})))/
|
||||
end
|
||||
regexs.push regex unless regex.nil?
|
||||
end
|
||||
regexs
|
||||
end
|
||||
|
||||
def pre_exclude(content, regexs = self.exclusion_regexs())
|
||||
@exclusion_store = []
|
||||
regexs.each do |regex|
|
||||
next if regex.nil?
|
||||
content.scan(regex) do |match_data|
|
||||
match = match_data[0]
|
||||
id = @exclusion_store.size
|
||||
content = content.sub(match, "<!JEKYLL@#{object_id}@#{id}>")
|
||||
content = content.sub(match, "[JEKYLL@#{object_id}@#{id}]")
|
||||
@exclusion_store.push match
|
||||
end
|
||||
end
|
||||
content
|
||||
end
|
||||
|
||||
def post_exclude(content)
|
||||
def after_exclude(content)
|
||||
while @exclusion_store.size > 0
|
||||
match = @exclusion_store.pop
|
||||
id = @exclusion_store.size
|
||||
content = content.sub("<!JEKYLL@#{object_id}@#{id}>", match)
|
||||
content = content.sub("[JEKYLL@#{object_id}@#{id}]", match)
|
||||
end
|
||||
@exclusion_store = []
|
||||
content
|
||||
@ -199,38 +190,5 @@ module Jekyll::Spaceship
|
||||
end
|
||||
content
|
||||
end
|
||||
|
||||
def self.fetch_img_data(url)
|
||||
begin
|
||||
res = Net::HTTP.get_response URI(url)
|
||||
raise res.body unless res.is_a?(Net::HTTPSuccess)
|
||||
content_type = res.header['Content-Type']
|
||||
raise 'Unknown content type!' if content_type.nil?
|
||||
content_body = res.body.force_encoding('UTF-8')
|
||||
return {
|
||||
'type' => content_type,
|
||||
'body' => content_body
|
||||
}
|
||||
rescue StandardError => msg
|
||||
logger.log msg
|
||||
end
|
||||
end
|
||||
|
||||
def self.make_img_tag(data)
|
||||
css_class = data['class']
|
||||
type = data['type']
|
||||
body = data['body']
|
||||
if type == 'url'
|
||||
"<img class=\"#{css_class}\" src=\"#{body}\">"
|
||||
elsif type.include?('svg')
|
||||
body.gsub(/\<\?xml.*?\?>/, '')
|
||||
.gsub(/<!--[^\0]*?-->/, '')
|
||||
.sub(/<svg /, "<svg class=\"#{css_class}\" ")
|
||||
else
|
||||
body = Base64.encode64(body)
|
||||
body = "data:#{type};base64, #{body}"
|
||||
"<img class=\"#{css_class}\" src=\"#{body}\">"
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -24,16 +24,15 @@ module Jekyll::Spaceship
|
||||
|
||||
# escape plus sign
|
||||
emoji_name = emoji.name.gsub('+', '\\\+')
|
||||
css_class = self.config['css']['class']
|
||||
|
||||
content = content.gsub(
|
||||
/(?<!\=")\s*:#{emoji_name}:\s*(?!"\s)/,
|
||||
"<img class=\"#{css_class}\""\
|
||||
"<img class=\"\""\
|
||||
" title=\":#{emoji.name}:\""\
|
||||
" alt=\":#{emoji.name}:\""\
|
||||
" raw=\"#{emoji.raw}\""\
|
||||
" src=\"#{config['src']}#{emoji.image_filename}\""\
|
||||
" style=\"vertical-align: middle; display: inline;"\
|
||||
" style=\"vertical-align: middle;"\
|
||||
" max-width: 1em; visibility: hidden;\""\
|
||||
" onload=\"this.style.visibility='visible'\""\
|
||||
" onerror=\"this.replaceWith(this.getAttribute('raw'))\">"\
|
||||
|
||||
@ -6,13 +6,9 @@ module Jekyll::Spaceship
|
||||
class MathjaxProcessor < Processor
|
||||
def self.config
|
||||
{
|
||||
'src' => [
|
||||
'https://polyfill.io/v3/polyfill.min.js?features=es6',
|
||||
'https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js',
|
||||
],
|
||||
'src' => '//cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML',
|
||||
'config' => {
|
||||
'tex' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] },
|
||||
'svg': { 'fontCache': 'global' }
|
||||
'tex2jax' => { 'inlineMath' => [['$','$'], ['\\(','\\)']] }
|
||||
}
|
||||
}
|
||||
end
|
||||
@ -31,15 +27,8 @@ module Jekyll::Spaceship
|
||||
|
||||
self.handled = true
|
||||
|
||||
# add mathjax config
|
||||
cfg = config['config'].to_json
|
||||
head.add_child("<script>MathJax=#{cfg}</script>")
|
||||
|
||||
# add mathjax dependencies
|
||||
config['src'] = [config['src']] if config['src'].is_a? String
|
||||
config['src'].each do |src|
|
||||
head.add_child("<script src=\"#{src}\"></script>")
|
||||
end
|
||||
cfg = "MathJax.Hub.Config(#{config['config'].to_json});"
|
||||
head.add_child("<script src=\"#{config['src']}\">#{cfg}</script>")
|
||||
|
||||
doc.to_html
|
||||
end
|
||||
|
||||
@ -1,234 +0,0 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'uri'
|
||||
|
||||
module Jekyll::Spaceship
|
||||
class MediaProcessor < Processor
|
||||
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
|
||||
|
||||
def on_handle_markdown(content)
|
||||
content = handle_normal_audio(content)
|
||||
content = handle_normal_video(content)
|
||||
content = handle_youtube(content)
|
||||
content = handle_vimeo(content)
|
||||
content = handle_dailymotion(content)
|
||||
content = handle_spotify(content)
|
||||
content = handle_soundcloud(content)
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_normal_audio(content)
|
||||
handle_media(content, {
|
||||
media_type: 'audio',
|
||||
host: '(https?:)?\\/\\/.*\\/',
|
||||
id: '(.+?\\.(mp3|wav|ogg|mid|midi|aac|wma))',
|
||||
})
|
||||
end
|
||||
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
# 
|
||||
def handle_normal_video(content)
|
||||
handle_media(content, {
|
||||
media_type: 'iframe',
|
||||
host: '(https?:)?\\/\\/.*\\/',
|
||||
id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))'
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
# 
|
||||
def handle_youtube(content)
|
||||
handle_media(content, {
|
||||
media_type: 'iframe',
|
||||
host: '(https?:)?\\/\\/.*youtu.*',
|
||||
id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
|
||||
base_url: "https://www.youtube.com/embed/"
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_vimeo(content)
|
||||
handle_media(content, {
|
||||
media_type: 'iframe',
|
||||
host: '(https?:)?\\/\\/vimeo\\.com\\/',
|
||||
id: '([0-9]+)',
|
||||
base_url: "https://player.vimeo.com/video/"
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_dailymotion(content)
|
||||
handle_media(content, {
|
||||
media_type: 'iframe',
|
||||
host: '(https?:)?\\/\\/.*dai.?ly.*',
|
||||
id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
|
||||
base_url: "https://www.dailymotion.com/embed/video/"
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_spotify(content)
|
||||
handle_media(content, {
|
||||
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
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
def handle_soundcloud(content)
|
||||
handle_media(content, {
|
||||
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
|
||||
|
||||
def handle_media(content, data)
|
||||
host = data[:host]
|
||||
return content if content.sub(/#{host}/, '').nil?
|
||||
|
||||
media_type = data[:media_type]
|
||||
base_url = data[:base_url]
|
||||
id = data[:id_from] === 'html' ? '()' : data[:id]
|
||||
url = "(#{host}#{id}\\S*)"
|
||||
title = '("(.*)".*){0,1}'
|
||||
|
||||
# pre-handle reference-style links
|
||||
regex = /(\[(.*)\]:\s*(#{url}\s*#{title}))/
|
||||
content.scan regex do |match_data|
|
||||
match = match_data[0]
|
||||
ref_name = match_data[1]
|
||||
ref_value = match_data[2]
|
||||
content = content.gsub(match, '')
|
||||
.gsub(/\!\[(.*)\]\s*\[#{ref_name}\]/,
|
||||
"")
|
||||
end
|
||||
|
||||
# handle inline-style links
|
||||
regex = /(\!\[(.*)\]\(.*#{url}\s*#{title}\))/
|
||||
content.scan regex do |match_data|
|
||||
url = match_data[2]
|
||||
id = data[:id_from] === 'html' \
|
||||
? get_id_from_html(url, data[:id]) \
|
||||
: match_data[4]
|
||||
title = match_data[6]
|
||||
qs = url.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}" : url).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']
|
||||
content = handle_audio(content, { target: match_data[0], 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']
|
||||
content = handle_iframe(content, { target: match_data[0], cfg: cfg })
|
||||
end
|
||||
self.handled = true
|
||||
end
|
||||
content
|
||||
end
|
||||
|
||||
def handle_audio(content, 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>" \
|
||||
"<p> Your browser doesn't support HTML5 audio."\
|
||||
" Here is a <a href=\"#{cfg['src']}\">link to download the audio</a>"\
|
||||
"instead. </p>"\
|
||||
"</audio>"
|
||||
content.gsub(data[:target], html)
|
||||
end
|
||||
|
||||
def handle_iframe(content, 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>"
|
||||
content.gsub(data[:target], html)
|
||||
end
|
||||
|
||||
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
|
||||
end
|
||||
end
|
||||
@ -62,20 +62,18 @@ module Jekyll::Spaceship
|
||||
def handle_mermaid(code)
|
||||
# encode to UTF-8
|
||||
code = code.encode('UTF-8')
|
||||
|
||||
url = get_url(code)
|
||||
|
||||
# render mode
|
||||
case self.config['mode']
|
||||
when 'pre-fetch'
|
||||
data = self.class.fetch_img_data(url)
|
||||
end
|
||||
if data.nil?
|
||||
data = { 'type' => 'url', 'body' => url }
|
||||
url = self.get_mermaid_img_data(url)
|
||||
end
|
||||
|
||||
# return img tag
|
||||
data['class'] = self.config['css']['class']
|
||||
self.class.make_img_tag(data)
|
||||
css_class = self.config['css']['class']
|
||||
"<img class=\"#{css_class}\" src=\"#{url}\">"
|
||||
end
|
||||
|
||||
def get_url(code)
|
||||
@ -98,5 +96,21 @@ module Jekyll::Spaceship
|
||||
raise "No supported src ! #{src}"
|
||||
end
|
||||
end
|
||||
|
||||
def get_mermaid_img_data(url)
|
||||
data = ''
|
||||
begin
|
||||
res = Net::HTTP.get_response URI(url)
|
||||
raise res.body unless res.is_a?(Net::HTTPSuccess)
|
||||
data = Base64.encode64(res.body)
|
||||
content_type = res.header['Content-Type']
|
||||
raise 'Unknown content type!' if content_type.nil?
|
||||
data = "data:#{content_type};base64, #{data}"
|
||||
rescue StandardError => msg
|
||||
data = url
|
||||
logger.log msg
|
||||
end
|
||||
data
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -17,7 +17,7 @@ module Jekyll::Spaceship
|
||||
'css' => {
|
||||
'class' => 'plantuml'
|
||||
},
|
||||
'src' => 'http://www.plantuml.com/plantuml/svg/'
|
||||
'src' => 'http://www.plantuml.com/plantuml/png/'
|
||||
}
|
||||
end
|
||||
|
||||
@ -59,20 +59,18 @@ module Jekyll::Spaceship
|
||||
def handle_plantuml(code)
|
||||
# wrap plantuml code
|
||||
code = "@startuml#{code}@enduml".encode('UTF-8')
|
||||
url = self.get_url(code)
|
||||
|
||||
url = get_url(code)
|
||||
|
||||
# render mode
|
||||
case self.config['mode']
|
||||
when 'pre-fetch'
|
||||
data = self.class.fetch_img_data(url)
|
||||
end
|
||||
if data.nil?
|
||||
data = { 'type' => 'url', 'body' => url }
|
||||
url = self.get_plantuml_img_data(url)
|
||||
end
|
||||
|
||||
# return img tag
|
||||
data['class'] = self.config['css']['class']
|
||||
self.class.make_img_tag(data)
|
||||
css_class = self.config['css']['class']
|
||||
"<img class=\"#{css_class}\" src=\"#{url}\">"
|
||||
end
|
||||
|
||||
def get_url(code)
|
||||
@ -89,5 +87,21 @@ module Jekyll::Spaceship
|
||||
raise "No supported src ! #{src}"
|
||||
end
|
||||
end
|
||||
|
||||
def get_plantuml_img_data(url)
|
||||
data = ''
|
||||
begin
|
||||
res = Net::HTTP.get_response URI(url)
|
||||
raise res.body unless res.is_a?(Net::HTTPSuccess)
|
||||
data = Base64.encode64(res.body)
|
||||
content_type = res.header['Content-Type']
|
||||
raise 'Unknown content type!' if content_type.nil?
|
||||
data = "data:#{content_type};base64, #{data}"
|
||||
rescue StandardError => msg
|
||||
data = url
|
||||
logger.log msg
|
||||
end
|
||||
data
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
@ -5,9 +5,6 @@ require "nokogiri"
|
||||
|
||||
module Jekyll::Spaceship
|
||||
class TableProcessor < Processor
|
||||
ATTR_LIST_PATTERN = /((?<!\\)\{:(?:([A-Za-z]\S*):)?(.*?)(?<!\\)\})/
|
||||
ATTR_LIST_REFS = {}
|
||||
|
||||
def on_handle_markdown(content)
|
||||
# pre-handle reference-style links
|
||||
references = {}
|
||||
@ -19,9 +16,7 @@ module Jekyll::Spaceship
|
||||
if references.size > 0
|
||||
content.scan(/[^\n]*(?<!\\)\|[^\n]*/) do |result|
|
||||
references.each do |key, val|
|
||||
replace = result.gsub(
|
||||
/\[([^\n\]]*?)\]\s*\[#{key}\]/,
|
||||
"[\1](#{val})")
|
||||
replace = result.gsub(/\[([^\n]*)\]\s*\[#{key}\]/, "[\1](#{val})")
|
||||
next if result == replace
|
||||
content = content.gsub(result, replace)
|
||||
end
|
||||
@ -47,19 +42,6 @@ module Jekyll::Spaceship
|
||||
next if result == replace
|
||||
content = content.gsub(result, replace)
|
||||
end
|
||||
|
||||
# pre-handle attribute list (AL)
|
||||
ATTR_LIST_REFS.clear()
|
||||
content.scan(ATTR_LIST_PATTERN) do |result|
|
||||
ref = result[1]
|
||||
list = result[2]
|
||||
next if ref.nil?
|
||||
if ATTR_LIST_REFS.has_key? ref
|
||||
ATTR_LIST_REFS[ref] += list
|
||||
else
|
||||
ATTR_LIST_REFS[ref] = list
|
||||
end
|
||||
end
|
||||
content
|
||||
end
|
||||
|
||||
@ -87,7 +69,6 @@ module Jekyll::Spaceship
|
||||
handle_multi_rows(data)
|
||||
handle_text_align(data)
|
||||
handle_rowspan(data)
|
||||
handle_attr_list(data)
|
||||
end
|
||||
end
|
||||
rows.each do |row|
|
||||
@ -180,7 +161,7 @@ module Jekyll::Spaceship
|
||||
if scope.table.multi_row_cells != cells and scope.table.multi_row_start
|
||||
for i in 0...scope.table.multi_row_cells.count do
|
||||
multi_row_cell = scope.table.multi_row_cells[i]
|
||||
multi_row_cell.inner_html += "\n<br>\n#{cells[i].inner_html}"
|
||||
multi_row_cell.inner_html += "<br>#{cells[i].inner_html}"
|
||||
end
|
||||
row.remove
|
||||
end
|
||||
@ -205,7 +186,7 @@ module Jekyll::Spaceship
|
||||
span_cell = scope.table.span_row_cells[scope.row.col_index]
|
||||
if span_cell and cell.content.match(/^\s*\^{2}/)
|
||||
cell.content = cell.content.gsub(/^\s*\^{2}/, '')
|
||||
span_cell.inner_html += "\n<br>\n#{cell.inner_html}"
|
||||
span_cell.inner_html += "<br>#{cell.inner_html}"
|
||||
rowspan = span_cell.get_attribute('rowspan') || 1
|
||||
rowspan = rowspan.to_i + 1
|
||||
span_cell.set_attribute('rowspan', "#{rowspan}")
|
||||
@ -254,69 +235,15 @@ module Jekyll::Spaceship
|
||||
cell.set_attribute('style', style)
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# {:ref-name: .cls1 title="hello" }
|
||||
# {: #id ref-name data="world" }
|
||||
# {: #id title="hello" }
|
||||
# {: .cls style="color: #333" }
|
||||
def handle_attr_list(data)
|
||||
cell = data.cell
|
||||
content = cell.inner_html
|
||||
# inline attribute list(IAL) handler
|
||||
ial_handler = ->(list) do
|
||||
list.scan(/(\S+)=("|')(.*?)\2|(\S+)/) do |attr|
|
||||
key = attr[0]
|
||||
val = attr[2]
|
||||
single = attr[3]
|
||||
if !key.nil?
|
||||
val = (cell.get_attribute(key) || '') + val
|
||||
cell.set_attribute(key, val)
|
||||
elsif !single.nil?
|
||||
if single.start_with? '#'
|
||||
key = 'id'
|
||||
val = single[1..-1]
|
||||
elsif single.start_with? '.'
|
||||
key = 'class'
|
||||
val = cell.get_attribute(key) || ''
|
||||
val += (val.size.zero? ? '' : ' ') + single[1..-1]
|
||||
elsif ATTR_LIST_REFS.has_key? single
|
||||
ial_handler.call ATTR_LIST_REFS[single]
|
||||
end
|
||||
unless key.nil?
|
||||
cell.set_attribute(key, val)
|
||||
end
|
||||
end
|
||||
end
|
||||
end
|
||||
# handle attribute list
|
||||
content.scan(ATTR_LIST_PATTERN) do |result|
|
||||
ref = result[1]
|
||||
list = result[2]
|
||||
# handle inline attribute list
|
||||
ial_handler.call list if ref.nil?
|
||||
# remove attr_list
|
||||
content = content.sub(result[0], '')
|
||||
end
|
||||
cell.inner_html = content
|
||||
end
|
||||
|
||||
def handle_format(data)
|
||||
cell = data.cell
|
||||
cvter = self.converter('markdown')
|
||||
return if cvter.nil?
|
||||
content = cell.inner_html
|
||||
content = self.pre_exclude(content, [/(\<code.*\>.*\<\/code\>)/])
|
||||
.gsub(/(?<!\\)\|/, '\\|')
|
||||
.gsub(/^\s+|\s+$/, '')
|
||||
.gsub(/</, '<')
|
||||
.gsub(/>/, '>')
|
||||
content = self.post_exclude(content)
|
||||
content = cvter.convert(content)
|
||||
content = Nokogiri::HTML.fragment(content)
|
||||
if content.children.first&.name == 'p'
|
||||
content = content.children
|
||||
end
|
||||
cell.inner_html = content.inner_html
|
||||
cell.inner_html = Nokogiri::HTML.fragment(content)
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
139
lib/jekyll-spaceship/processors/video-processor.rb
Normal file
139
lib/jekyll-spaceship/processors/video-processor.rb
Normal file
@ -0,0 +1,139 @@
|
||||
# frozen_string_literal: true
|
||||
|
||||
require 'uri'
|
||||
|
||||
module Jekyll::Spaceship
|
||||
class VideoProcessor < Processor
|
||||
def self.config
|
||||
{
|
||||
'default' => {
|
||||
'id' => 'video-{id}',
|
||||
'class' => 'video',
|
||||
'width' => '100%',
|
||||
'height' => 350,
|
||||
'border' => 0,
|
||||
'style' => 'max-width: 600px',
|
||||
'allow' => 'encrypted-media; picture-in-picture',
|
||||
}
|
||||
}
|
||||
end
|
||||
|
||||
def on_handle_markdown(content)
|
||||
content = handle_normal_video(content)
|
||||
content = handle_youtube(content)
|
||||
content = handle_vimeo(content)
|
||||
content = handle_dailymotion(content)
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
# 
|
||||
def handle_normal_video(content)
|
||||
handle_video(content, {
|
||||
host: '(https?:)?\\/\\/.*\\/',
|
||||
id: '(.+?\\.(avi|mp4|webm|ogg|ogv|flv|mkv|mov|wmv|3gp|rmvb|asf))',
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
# 
|
||||
def handle_youtube(content)
|
||||
handle_video(content, {
|
||||
host: '(https?:)?\\/\\/.*youtu.*',
|
||||
id: '(?<=\\?v\\=|embed\\/|\\.be\\/)([a-zA-Z0-9\\_\\-]+)',
|
||||
iframe_url: "https://www.youtube.com/embed/"
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_vimeo(content)
|
||||
handle_video(content, {
|
||||
host: '(https?:)?\\/\\/vimeo\\.com\\/',
|
||||
id: '([0-9]+)',
|
||||
iframe_url: "https://player.vimeo.com/video/"
|
||||
})
|
||||
end
|
||||
|
||||
# Examples:
|
||||
# 
|
||||
# 
|
||||
def handle_dailymotion(content)
|
||||
handle_video(content, {
|
||||
host: '(https?:)?\\/\\/.*dai.?ly.*',
|
||||
id: '(?<=video\\/|\\/)([a-zA-Z0-9\\_\\-]+)',
|
||||
iframe_url: "https://www.dailymotion.com/embed/video/"
|
||||
})
|
||||
end
|
||||
|
||||
def handle_video(content, data)
|
||||
host = data[:host]
|
||||
return content if content.sub(/#{host}/, '').nil?
|
||||
|
||||
iframe_url = data[:iframe_url]
|
||||
id = data[:id]
|
||||
url = "(#{host}#{id}\\S*)"
|
||||
title = '("(.*)".*){0,1}'
|
||||
|
||||
# pre-handle reference-style links
|
||||
regex = /(\[(.*)\]:\s*(#{url}\s*#{title}))/
|
||||
content.scan regex do |match_data|
|
||||
match = match_data[0]
|
||||
ref_name = match_data[1]
|
||||
ref_value = match_data[2]
|
||||
content = content.gsub(match, '')
|
||||
.gsub(/\!\[(.*)\]\s*\[#{ref_name}\]/,
|
||||
"")
|
||||
end
|
||||
|
||||
# handle inline-style links
|
||||
regex = /(\!\[(.*)\]\(.*#{url}\s*#{title}\))/
|
||||
content.scan regex do |match_data|
|
||||
url = match_data[2]
|
||||
id = match_data[4]
|
||||
title = match_data[6]
|
||||
qs = url.match(/(?<=\?)(\S*?)$/)
|
||||
qs = Hash[URI.decode_www_form(qs.to_s)].reject do |k, v|
|
||||
next true if v == id or v == ''
|
||||
end
|
||||
|
||||
default = self.config['default']
|
||||
css_id = qs['id'] || default['id']
|
||||
css_class = qs['class'] || default['class']
|
||||
width = qs['width'] || data[:width] || default['width']
|
||||
height = qs['height'] || data[:height] || default['height']
|
||||
frameborder = qs['frameborder'] || default['border']
|
||||
style = qs['style'] || default['style']
|
||||
allow = qs['allow'] || default['allow']
|
||||
|
||||
css_id = css_id.gsub('{id}', id)
|
||||
css_class = css_class.gsub('{id}', id)
|
||||
|
||||
url = URI(iframe_url ? "#{iframe_url}#{id}" : url).tap do |v|
|
||||
v.query = URI.encode_www_form(qs) if qs.size > 0
|
||||
end
|
||||
|
||||
html = "<iframe"\
|
||||
" id=\"#{css_id}\""\
|
||||
" class=\"#{css_class}\""\
|
||||
" src=\"#{url}\""\
|
||||
" title=\"#{title}\""\
|
||||
" width=\"#{width}\""\
|
||||
" height=\"#{height}\""\
|
||||
" style=\"#{style}\""\
|
||||
" allow=\"#{allow}\""\
|
||||
" frameborder=\"#{frameborder}\""\
|
||||
" allowfullscreen>" \
|
||||
"</iframe>"
|
||||
|
||||
content = content.gsub(match_data[0], html)
|
||||
self.handled = true
|
||||
end
|
||||
content
|
||||
end
|
||||
end
|
||||
end
|
||||
@ -2,6 +2,6 @@
|
||||
|
||||
module Jekyll
|
||||
module Spaceship
|
||||
VERSION = "0.9.3"
|
||||
VERSION = "0.8.3"
|
||||
end
|
||||
end
|
||||
|
||||
@ -1,100 +0,0 @@
|
||||
# This file was generated by the `rspec --init` command. Conventionally, all
|
||||
# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
|
||||
# The generated `.rspec` file contains `--require spec_helper` which will cause
|
||||
# this file to always be loaded, without a need to explicitly require it in any
|
||||
# files.
|
||||
#
|
||||
# Given that it is always loaded, you are encouraged to keep this file as
|
||||
# light-weight as possible. Requiring heavyweight dependencies from this file
|
||||
# will add to the boot time of your test suite on EVERY test run, even for an
|
||||
# individual file that may not need all of that loaded. Instead, consider making
|
||||
# a separate helper file that requires the additional dependencies and performs
|
||||
# the additional setup, and require it from the spec files that actually need
|
||||
# it.
|
||||
#
|
||||
# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
|
||||
RSpec.configure do |config|
|
||||
# rspec-expectations config goes here. You can use an alternate
|
||||
# assertion/expectation library such as wrong or the stdlib/minitest
|
||||
# assertions if you prefer.
|
||||
config.expect_with :rspec do |expectations|
|
||||
# This option will default to `true` in RSpec 4. It makes the `description`
|
||||
# and `failure_message` of custom matchers include text for helper methods
|
||||
# defined using `chain`, e.g.:
|
||||
# be_bigger_than(2).and_smaller_than(4).description
|
||||
# # => "be bigger than 2 and smaller than 4"
|
||||
# ...rather than:
|
||||
# # => "be bigger than 2"
|
||||
expectations.include_chain_clauses_in_custom_matcher_descriptions = true
|
||||
end
|
||||
|
||||
# rspec-mocks config goes here. You can use an alternate test double
|
||||
# library (such as bogus or mocha) by changing the `mock_with` option here.
|
||||
config.mock_with :rspec do |mocks|
|
||||
# Prevents you from mocking or stubbing a method that does not exist on
|
||||
# a real object. This is generally recommended, and will default to
|
||||
# `true` in RSpec 4.
|
||||
mocks.verify_partial_doubles = true
|
||||
end
|
||||
|
||||
# This option will default to `:apply_to_host_groups` in RSpec 4 (and will
|
||||
# have no way to turn it off -- the option exists only for backwards
|
||||
# compatibility in RSpec 3). It causes shared context metadata to be
|
||||
# inherited by the metadata hash of host groups and examples, rather than
|
||||
# triggering implicit auto-inclusion in groups with matching metadata.
|
||||
config.shared_context_metadata_behavior = :apply_to_host_groups
|
||||
|
||||
# The settings below are suggested to provide a good initial experience
|
||||
# with RSpec, but feel free to customize to your heart's content.
|
||||
=begin
|
||||
# This allows you to limit a spec run to individual examples or groups
|
||||
# you care about by tagging them with `:focus` metadata. When nothing
|
||||
# is tagged with `:focus`, all examples get run. RSpec also provides
|
||||
# aliases for `it`, `describe`, and `context` that include `:focus`
|
||||
# metadata: `fit`, `fdescribe` and `fcontext`, respectively.
|
||||
config.filter_run_when_matching :focus
|
||||
|
||||
# Allows RSpec to persist some state between runs in order to support
|
||||
# the `--only-failures` and `--next-failure` CLI options. We recommend
|
||||
# you configure your source control system to ignore this file.
|
||||
config.example_status_persistence_file_path = "spec/examples.txt"
|
||||
|
||||
# Limits the available syntax to the non-monkey patched syntax that is
|
||||
# recommended. For more details, see:
|
||||
# - http://rspec.info/blog/2012/06/rspecs-new-expectation-syntax/
|
||||
# - http://www.teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
|
||||
# - http://rspec.info/blog/2014/05/notable-changes-in-rspec-3/#zero-monkey-patching-mode
|
||||
config.disable_monkey_patching!
|
||||
|
||||
# This setting enables warnings. It's recommended, but in some cases may
|
||||
# be too noisy due to issues in dependencies.
|
||||
config.warnings = true
|
||||
|
||||
# Many RSpec users commonly either run the entire suite or an individual
|
||||
# file, and it's useful to allow more verbose output when running an
|
||||
# individual spec file.
|
||||
if config.files_to_run.one?
|
||||
# Use the documentation formatter for detailed output,
|
||||
# unless a formatter has already been configured
|
||||
# (e.g. via a command-line flag).
|
||||
config.default_formatter = "doc"
|
||||
end
|
||||
|
||||
# Print the 10 slowest examples and example groups at the
|
||||
# end of the spec run, to help surface which specs are running
|
||||
# particularly slow.
|
||||
config.profile_examples = 10
|
||||
|
||||
# Run specs in random order to surface order dependencies. If you find an
|
||||
# order dependency and want to debug it, you can fix the order by providing
|
||||
# the seed, which is printed after each run.
|
||||
# --seed 1234
|
||||
config.order = :random
|
||||
|
||||
# Seed global randomization in this process using the `--seed` CLI option.
|
||||
# Setting this allows you to use `--seed` to deterministically reproduce
|
||||
# test failures related to randomization by passing the same `--seed` value
|
||||
# as the one that triggered the failure.
|
||||
Kernel.srand config.seed
|
||||
=end
|
||||
end
|
||||
Loading…
x
Reference in New Issue
Block a user