jekyll-menu 0.1.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/.gitignore +9 -0
- data/.rspec +2 -0
- data/.travis.yml +5 -0
- data/Gemfile +2 -0
- data/LICENSE.txt +21 -0
- data/README.md +5 -0
- data/Rakefile +16 -0
- data/bin/console +14 -0
- data/bin/setup +8 -0
- data/jekyll-menu.gemspec +33 -0
- data/lib/jekyll-menu.rb +1 -0
- data/lib/jekyll/menu.rb +155 -0
- data/lib/jekyll/menu/version.rb +5 -0
- metadata +183 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 0713a8fb9ae531c61b7f2b8503392bb2f7cafc96
|
4
|
+
data.tar.gz: 2aa3309250b19e9bdf0718d35826b2abe363850a
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 70b6051bee175d3665439b9c20fc3f8847a750ae59d54454f1f9026ec2381eeb503f716fc1e12c9c2d453946bb363c831030265b366ccc217187344d699f18a5
|
7
|
+
data.tar.gz: a7297faf80d053dd4375104649865c091e983d50f9cc76c320aca2903e5857b9e21b9de94f1b2c9d597bdd7043402246142e695a2f1396f1041f098fe3cd5e87
|
data/.gitignore
ADDED
data/.rspec
ADDED
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
The MIT License (MIT)
|
2
|
+
|
3
|
+
Copyright (c) 2017 Help Scout
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
7
|
+
in the Software without restriction, including without limitation the rights
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
10
|
+
furnished to do so, subject to the following conditions:
|
11
|
+
|
12
|
+
The above copyright notice and this permission notice shall be included in
|
13
|
+
all copies or substantial portions of the Software.
|
14
|
+
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
21
|
+
THE SOFTWARE.
|
data/README.md
ADDED
data/Rakefile
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
2
|
+
require 'rubygems'
|
3
|
+
require 'rake'
|
4
|
+
require 'rdoc'
|
5
|
+
require 'date'
|
6
|
+
require 'yaml'
|
7
|
+
require 'rake/testtask'
|
8
|
+
|
9
|
+
$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), *%w[lib]))
|
10
|
+
require 'jekyll/version'
|
11
|
+
|
12
|
+
Rake::TestTask.new(:test) do |test|
|
13
|
+
test.libs << 'lib' << 'test'
|
14
|
+
test.pattern = 'test/**/test_*.rb'
|
15
|
+
# test.verbose = true
|
16
|
+
end
|
data/bin/console
ADDED
@@ -0,0 +1,14 @@
|
|
1
|
+
#!/usr/bin/env ruby
|
2
|
+
|
3
|
+
require "bundler/setup"
|
4
|
+
require "jekyll/menu"
|
5
|
+
|
6
|
+
# You can add fixtures and/or initialization code here to make experimenting
|
7
|
+
# with your gem easier. You can also use a different console, if you like.
|
8
|
+
|
9
|
+
# (If you use this, don't forget to add pry to your Gemfile!)
|
10
|
+
# require "pry"
|
11
|
+
# Pry.start
|
12
|
+
|
13
|
+
require "irb"
|
14
|
+
IRB.start
|
data/bin/setup
ADDED
data/jekyll-menu.gemspec
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'jekyll/menu/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "jekyll-menu"
|
8
|
+
spec.version = Jekyll::Menu::VERSION
|
9
|
+
spec.authors = ["ItsJonQ"]
|
10
|
+
spec.email = ["itsjonq@gmail.com"]
|
11
|
+
|
12
|
+
spec.summary = "Easy menu creation with YAML data"
|
13
|
+
spec.homepage = "https://github.com/helpscout/jekyll-menu"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0").reject do |f|
|
17
|
+
f.match(%r{^(test|spec|features)/})
|
18
|
+
end
|
19
|
+
spec.bindir = "exe"
|
20
|
+
spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
|
21
|
+
spec.require_paths = ["lib"]
|
22
|
+
|
23
|
+
spec.add_runtime_dependency("jekyll", "3.1.2")
|
24
|
+
|
25
|
+
spec.add_development_dependency "bundler", "~> 1.13"
|
26
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
27
|
+
spec.add_development_dependency "minitest-reporters"
|
28
|
+
spec.add_development_dependency "minitest-profile"
|
29
|
+
spec.add_development_dependency "minitest", "~> 5.8"
|
30
|
+
spec.add_development_dependency "rspec-mocks"
|
31
|
+
spec.add_development_dependency "shoulda"
|
32
|
+
spec.add_development_dependency "kramdown"
|
33
|
+
end
|
data/lib/jekyll-menu.rb
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require "jekyll/menu"
|
data/lib/jekyll/menu.rb
ADDED
@@ -0,0 +1,155 @@
|
|
1
|
+
require "jekyll"
|
2
|
+
|
3
|
+
module Jekyll
|
4
|
+
module Menu
|
5
|
+
@site = false
|
6
|
+
@data = {}
|
7
|
+
@options = {
|
8
|
+
"url_path" => "/",
|
9
|
+
"menu_class" => "c-menu",
|
10
|
+
"menu_sub_class" => "c-menu--sub-menu",
|
11
|
+
"menu_active_class" => "is-active",
|
12
|
+
"item_class" => "c-menu__item",
|
13
|
+
"item_active_class" => "is-active",
|
14
|
+
}
|
15
|
+
|
16
|
+
def self.initialize(data)
|
17
|
+
@data = data ? data : {}
|
18
|
+
if @site.data.key?("menus")
|
19
|
+
if @site.data["menus"].length
|
20
|
+
self.setup_menus()
|
21
|
+
end
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def self.setup_menus
|
26
|
+
menus = @site.data["menus"].map { |m|
|
27
|
+
title = m[0]
|
28
|
+
items = m[1]
|
29
|
+
m[1] = self.setup_menu(items, title)["items"]
|
30
|
+
m
|
31
|
+
}
|
32
|
+
@data.data["menu"] = Hash[*menus.flatten(1)]
|
33
|
+
end
|
34
|
+
|
35
|
+
def self.setup_menu(items, title, sub = true)
|
36
|
+
new_menu = {}
|
37
|
+
if title
|
38
|
+
new_menu["title"] = title
|
39
|
+
end
|
40
|
+
path = menu_path(title)
|
41
|
+
new_menu["path"] = path
|
42
|
+
new_menu["items"] = self.setup_menu_items(items, path)
|
43
|
+
new_menu["link"] = "#"
|
44
|
+
new_menu["class"] = self.menu_class(sub, new_menu["items"])
|
45
|
+
new_menu
|
46
|
+
end
|
47
|
+
|
48
|
+
def self.setup_menu_items(items, path)
|
49
|
+
path = path ? path : @options["url_path"]
|
50
|
+
items.map { |i|
|
51
|
+
if i.key?("pages")
|
52
|
+
item = self.setup_menu(i["pages"], i["title"], true)
|
53
|
+
else
|
54
|
+
item = {}
|
55
|
+
item["title"] = i["title"]
|
56
|
+
item["link"] = self.item_link(i, path)
|
57
|
+
item["class"] = self.item_class(item["link"])
|
58
|
+
item["active"] = self.item_is_active(item["link"])
|
59
|
+
end
|
60
|
+
item
|
61
|
+
}
|
62
|
+
end
|
63
|
+
|
64
|
+
def self.liquify(input)
|
65
|
+
output = Liquid::Template.parse(input)
|
66
|
+
output.render(@data)
|
67
|
+
end
|
68
|
+
|
69
|
+
def self.slugify(path)
|
70
|
+
path.downcase.strip.gsub(' ', '-').gsub(/[^\w-]/, '')
|
71
|
+
end
|
72
|
+
|
73
|
+
def self.menu_path(title)
|
74
|
+
path = @options["url_path"]
|
75
|
+
title = self.slugify(title)
|
76
|
+
"#{path}#{title}"
|
77
|
+
end
|
78
|
+
|
79
|
+
def self.menu_class(sub = false, items = [])
|
80
|
+
class_name = @options["menu_class"]
|
81
|
+
if sub
|
82
|
+
class_name = "#{class_name} #{@options['menu_sub_class']}"
|
83
|
+
end
|
84
|
+
if self.menu_has_active_item(items)
|
85
|
+
class_name = "#{class_name} #{@options['menu_active_class']}"
|
86
|
+
end
|
87
|
+
class_name
|
88
|
+
end
|
89
|
+
|
90
|
+
def self.menu_has_active_item(items = [], has_active = false)
|
91
|
+
unless has_active
|
92
|
+
items.each do |item|
|
93
|
+
if item["items"]
|
94
|
+
self.menu_has_active_item(item["items"], has_active)
|
95
|
+
end
|
96
|
+
if item["active"]
|
97
|
+
has_active = true
|
98
|
+
break
|
99
|
+
end
|
100
|
+
end
|
101
|
+
end
|
102
|
+
has_active
|
103
|
+
end
|
104
|
+
|
105
|
+
def self.item_link(item, path)
|
106
|
+
if item.key?("link")
|
107
|
+
item["link"]
|
108
|
+
else
|
109
|
+
unless path === "/"
|
110
|
+
title = item["title"]
|
111
|
+
link = self.slugify(title)
|
112
|
+
"#{path}/#{link}"
|
113
|
+
else
|
114
|
+
path
|
115
|
+
end
|
116
|
+
end
|
117
|
+
end
|
118
|
+
|
119
|
+
def self.item_is_active(path)
|
120
|
+
url = @data.url
|
121
|
+
unless path === "/"
|
122
|
+
path = path.gsub(/\/$/, "")
|
123
|
+
end
|
124
|
+
unless url === "/"
|
125
|
+
url = url.gsub(/\/$/, "")
|
126
|
+
end
|
127
|
+
url === path
|
128
|
+
end
|
129
|
+
|
130
|
+
def self.item_class(path)
|
131
|
+
class_name = @options["item_class"]
|
132
|
+
if self.item_is_active(path)
|
133
|
+
class_name = "#{class_name} #{@options['item_active_class']}"
|
134
|
+
end
|
135
|
+
class_name
|
136
|
+
end
|
137
|
+
|
138
|
+
# Sets the Site class for jekyll-menu
|
139
|
+
Jekyll::Hooks.register :site, :pre_render do |site|
|
140
|
+
@site = site
|
141
|
+
end
|
142
|
+
|
143
|
+
# Generates and evaluates data for posts
|
144
|
+
Jekyll::Hooks.register :posts, :pre_render do |post, payload|
|
145
|
+
self.initialize(post)
|
146
|
+
payload["page"]["menu"] = @data["menu"]
|
147
|
+
end
|
148
|
+
|
149
|
+
# Generates and evaluates data for pages
|
150
|
+
Jekyll::Hooks.register :pages, :pre_render do |page, payload|
|
151
|
+
self.initialize(page)
|
152
|
+
payload["page"]["menu"] = @data["menu"]
|
153
|
+
end
|
154
|
+
end
|
155
|
+
end
|
metadata
ADDED
@@ -0,0 +1,183 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: jekyll-menu
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- ItsJonQ
|
8
|
+
autorequire:
|
9
|
+
bindir: exe
|
10
|
+
cert_chain: []
|
11
|
+
date: 2017-01-17 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: jekyll
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 3.1.2
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 3.1.2
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: bundler
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '1.13'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '1.13'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: rake
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '10.0'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '10.0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: minitest-reporters
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: minitest-profile
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - ">="
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - ">="
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: minitest
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '5.8'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '5.8'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rspec-mocks
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - ">="
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '0'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: shoulda
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - ">="
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '0'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - ">="
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '0'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: kramdown
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - ">="
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '0'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - ">="
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '0'
|
139
|
+
description:
|
140
|
+
email:
|
141
|
+
- itsjonq@gmail.com
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".gitignore"
|
147
|
+
- ".rspec"
|
148
|
+
- ".travis.yml"
|
149
|
+
- Gemfile
|
150
|
+
- LICENSE.txt
|
151
|
+
- README.md
|
152
|
+
- Rakefile
|
153
|
+
- bin/console
|
154
|
+
- bin/setup
|
155
|
+
- jekyll-menu.gemspec
|
156
|
+
- lib/jekyll-menu.rb
|
157
|
+
- lib/jekyll/menu.rb
|
158
|
+
- lib/jekyll/menu/version.rb
|
159
|
+
homepage: https://github.com/helpscout/jekyll-menu
|
160
|
+
licenses:
|
161
|
+
- MIT
|
162
|
+
metadata: {}
|
163
|
+
post_install_message:
|
164
|
+
rdoc_options: []
|
165
|
+
require_paths:
|
166
|
+
- lib
|
167
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
168
|
+
requirements:
|
169
|
+
- - ">="
|
170
|
+
- !ruby/object:Gem::Version
|
171
|
+
version: '0'
|
172
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
173
|
+
requirements:
|
174
|
+
- - ">="
|
175
|
+
- !ruby/object:Gem::Version
|
176
|
+
version: '0'
|
177
|
+
requirements: []
|
178
|
+
rubyforge_project:
|
179
|
+
rubygems_version: 2.5.2
|
180
|
+
signing_key:
|
181
|
+
specification_version: 4
|
182
|
+
summary: Easy menu creation with YAML data
|
183
|
+
test_files: []
|