Skip to content

[SPARK-11399] Add label support in include_example #9430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
yinxusen wants to merge 2 commits into from
Closed

[SPARK-11399] Add label support in include_example #9430

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ced8b13
add label support
yinxusen Nov 3, 2015
3c6ddd8
fix incompetible
yinxusen Dec 8, 2015
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 17 additions & 6 deletions docs/_plugins/include_example.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,19 +21,30 @@
module Jekyll
class IncludeExampleTag < Liquid::Tag

FileOnly = /^(\S+\.\S+)$/
FileTag = /^(\S+\.\S+)\s+(\S+)$/

def initialize(tag_name, markup, tokens)
@markup = markup
super
clean_markup = markup.strip
if clean_markup =~ FileOnly
@markup = $1
@label = ''
elsif clean_markup =~ FileTag
@markup = $1
@label = " #{$2}"
else
raise "Invalid syntax. Use {% include_example path/to/file [label] %}."
end
end

def render(context)
site = context.registers[:site]
config_dir = '../examples/src/main'
@code_dir = File.join(site.source, config_dir)

clean_markup = @markup.strip
@file = File.join(@code_dir, clean_markup)
@lang = clean_markup.split('.').last
@file = File.join(@code_dir, @markup)
@lang = @markup.split('.').last

code = File.open(@file).read.encode("UTF-8")
code = select_lines(code)
Expand Down Expand Up @@ -66,13 +77,13 @@ def select_lines(code)
# Select the array of start labels from code.
startIndices = lines
.each_with_index
.select { |l, i| l.include? "$example on$" }
.select { |l, i| l.include? "$example on#{@label}$" }
.map { |l, i| i }

# Select the array of end labels from code.
endIndices = lines
.each_with_index
.select { |l, i| l.include? "$example off$" }
.select { |l, i| l.include? "$example off#{@label}$" }
.map { |l, i| i }

raise "Start indices amount is not equal to end indices amount, see #{@file}." \
Expand Down