yard_rideliner 0.4.1 → 0.5.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 +4 -4
- data/.gitignore +3 -2
- data/.rubocop.yml +2 -45
- data/Gemfile +0 -7
- data/Rakefile +5 -10
- data/lib/yard_rideliner/task/ghpages_deploy.rb +70 -0
- data/lib/yard_rideliner/task/yard.rb +26 -0
- data/lib/yard_rideliner/tasks.rb +9 -0
- data/lib/yard_rideliner/template_path.rb +3 -9
- data/lib/yard_rideliner/version.rb +1 -1
- data/template/default/fulldoc/html/setup.rb +6 -0
- data/template/default/layout/html/setup.rb +4 -0
- data/yard_rideliner.gemspec +5 -1
- metadata +52 -7
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cf8a9d6cf8504de33ec5d42673065c30a89ef6ac
|
4
|
+
data.tar.gz: e3e4c7c4a3409f6e0963822ae0ddea9f9a51cd05
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 828d23155231553158056539e2663c33ec1ba03079caf2d60782ae406979c5463d554811bbf25d5cbc2a720432e49c7d8332dd9e47a0afb9839f26438c29cf28
|
7
|
+
data.tar.gz: accd3d4860e6f86bf2e22fc410f3f36d235d1ab108bac7252128168f4fec21c21caaed4667315f002aefa772c26268633a6186d26f6da092a60dcf6c9752f38b
|
data/.gitignore
CHANGED
data/.rubocop.yml
CHANGED
@@ -1,47 +1,4 @@
|
|
1
1
|
---
|
2
2
|
|
3
|
-
|
4
|
-
|
5
|
-
|
6
|
-
Metrics/MethodLength:
|
7
|
-
Max: 12
|
8
|
-
|
9
|
-
Style/SpecialGlobalVars:
|
10
|
-
Enabled: false
|
11
|
-
|
12
|
-
Style/AutoResourceCleanup:
|
13
|
-
Enabled: true
|
14
|
-
|
15
|
-
Style/CollectionMethods:
|
16
|
-
Enabled: true
|
17
|
-
|
18
|
-
Style/Copyright:
|
19
|
-
Enabled: true
|
20
|
-
Notice: '^# Copyright \(c\) 2\d{3} .+$'
|
21
|
-
|
22
|
-
Style/Encoding:
|
23
|
-
Enabled: true
|
24
|
-
|
25
|
-
Style/MethodCalledOnDoEndBlock:
|
26
|
-
Enabled: true
|
27
|
-
|
28
|
-
Style/MultilineArrayBraceLayout:
|
29
|
-
Enabled: true
|
30
|
-
|
31
|
-
Style/MultilineAssignmentLayout:
|
32
|
-
Enabled: true
|
33
|
-
|
34
|
-
Style/OptionHash:
|
35
|
-
Enabled: true
|
36
|
-
|
37
|
-
Style/Send:
|
38
|
-
Enabled: true
|
39
|
-
|
40
|
-
Style/StringMethods:
|
41
|
-
Enabled: true
|
42
|
-
|
43
|
-
Style/SymbolArray:
|
44
|
-
Enabled: true
|
45
|
-
|
46
|
-
Lint/LiteralInInterpolation:
|
47
|
-
Enabled: true
|
3
|
+
inherit_gem:
|
4
|
+
rideliner: .rubocop.yml
|
data/Gemfile
CHANGED
data/Rakefile
CHANGED
@@ -1,17 +1,12 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
# Copyright (c) 2016 Nathan Currier
|
3
3
|
|
4
|
-
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
7
|
+
|
5
8
|
require 'bundler'
|
6
9
|
|
7
10
|
Bundler.setup(:default, :development)
|
8
11
|
|
9
|
-
require '
|
10
|
-
|
11
|
-
require 'rubocop/rake_task'
|
12
|
-
RuboCop::RakeTask.new(:rubocop) do |t|
|
13
|
-
t.fail_on_error = false
|
14
|
-
end
|
15
|
-
task('rubocop:auto_correct').clear
|
16
|
-
|
17
|
-
task default: :rubocop
|
12
|
+
require 'rideliner/tasks'
|
@@ -0,0 +1,70 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Copyright (c) 2016 Nathan Currier
|
3
|
+
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
7
|
+
|
8
|
+
def current_gemspec
|
9
|
+
root = `git rev-parse --show-toplevel`.strip
|
10
|
+
abort('Only git repositories are supported') unless $?
|
11
|
+
|
12
|
+
gemspecs = Dir["#{root}/*.gemspec"]
|
13
|
+
abort "No gemspec found in #{root}" if gemspecs.empty?
|
14
|
+
|
15
|
+
spec = gemspecs.first
|
16
|
+
if gemspecs.length > 1
|
17
|
+
$stderr.puts "Warning: only using the first gemspec found (#{spec})."
|
18
|
+
end
|
19
|
+
|
20
|
+
Gem::Specification.load(spec)
|
21
|
+
end
|
22
|
+
|
23
|
+
if ENV['TRAVIS'] && ENV['DOCS']
|
24
|
+
namespace :yard do
|
25
|
+
if ENV['TRAVIS_PULL_REQUEST'] == 'false'
|
26
|
+
require 'ghpages_deploy/rake_task'
|
27
|
+
|
28
|
+
desc 'Deploy documentation to Github Pages'
|
29
|
+
GithubPagesGithubPages::DeployTask.new(deploy: [:yard]) do |ghpages|
|
30
|
+
ghpages.remote = 'website'
|
31
|
+
ghpages.repo = 'https://github.com/rideliner/rideliner.github.io.git'
|
32
|
+
ghpages.source = '_yardoc'
|
33
|
+
|
34
|
+
tag = ENV['TRAVIS_TAG']
|
35
|
+
branch = ENV['TRAVIS_BRANCH']
|
36
|
+
|
37
|
+
project = PROJECT_NAME || current_gemspec.name
|
38
|
+
project_root = "project/#{project}"
|
39
|
+
doc_root = "#{project_root}/doc"
|
40
|
+
|
41
|
+
dest_and_msg =
|
42
|
+
lambda do |type, loc|
|
43
|
+
[
|
44
|
+
"#{doc_root}/#{type}/#{loc}",
|
45
|
+
"Deploying documentation for #{project}, #{type} #{loc}."
|
46
|
+
]
|
47
|
+
end
|
48
|
+
|
49
|
+
abort 'No tag or branch specified' if tag.empty? && branch.empty?
|
50
|
+
|
51
|
+
ghpages.destination, ghpages.message =
|
52
|
+
if !tag.empty?
|
53
|
+
dest_and_msg['tag', tag]
|
54
|
+
elsif !branch.empty?
|
55
|
+
dest_and_msg['branch', branch]
|
56
|
+
end
|
57
|
+
|
58
|
+
ghpages.json_sitemap(
|
59
|
+
directory: doc_root,
|
60
|
+
whitelist: ['**/_index.html', '**/index_html'],
|
61
|
+
output: "#{project_root}/documentation.json"
|
62
|
+
)
|
63
|
+
end
|
64
|
+
else
|
65
|
+
task :deploy do
|
66
|
+
puts 'Documentation not generated for pull requests.'
|
67
|
+
end
|
68
|
+
end
|
69
|
+
end
|
70
|
+
end
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Copyright (c) 2016 Nathan Currier
|
3
|
+
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
7
|
+
|
8
|
+
require 'yard'
|
9
|
+
require 'yard/rake/yardoc_task'
|
10
|
+
|
11
|
+
require 'rake/clean'
|
12
|
+
|
13
|
+
YARD::Rake::YardocTask.new(:yard) do |t|
|
14
|
+
t.files = ['lib/**/*.rb', '-', 'doc/*.md', 'LICENSE.md']
|
15
|
+
t.options = [
|
16
|
+
'--charset utf-8', '--readme README.md',
|
17
|
+
'--markup markdown', '--markup-provider kramdown',
|
18
|
+
'--output-dir _yardoc',
|
19
|
+
'--protected', '--private',
|
20
|
+
"--default-return ''",
|
21
|
+
'--plugin yard_rideliner'
|
22
|
+
]
|
23
|
+
end
|
24
|
+
|
25
|
+
CLEAN.include '.yardoc'
|
26
|
+
CLOBBER.include '_yardoc'
|
@@ -0,0 +1,9 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Copyright (c) 2016 Nathan Currier
|
3
|
+
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
7
|
+
|
8
|
+
require 'yard_rideliner/task/ghpages_deploy'
|
9
|
+
require 'yard_rideliner/task/yard'
|
@@ -3,12 +3,6 @@
|
|
3
3
|
|
4
4
|
require 'yard'
|
5
5
|
|
6
|
-
|
7
|
-
|
8
|
-
|
9
|
-
File.expand_path('../../template', File.dirname(__FILE__))
|
10
|
-
end
|
11
|
-
end
|
12
|
-
end
|
13
|
-
|
14
|
-
YARD::Templates::Engine.register_template_path(YARD::Rideliner.template_path)
|
6
|
+
YARD::Templates::Engine.register_template_path(
|
7
|
+
File.expand_path('../../template', __dir__)
|
8
|
+
)
|
@@ -1,3 +1,9 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
# Copyright (c) 2016 Nathan Currier
|
3
|
+
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
1
7
|
|
2
8
|
def generate_version_list
|
3
9
|
@list_title = 'Version List'
|
@@ -1,6 +1,10 @@
|
|
1
1
|
# encoding: utf-8
|
2
2
|
# Copyright (c) 2016 Nathan Currier
|
3
3
|
|
4
|
+
# This Source Code Form is subject to the terms of the Mozilla Public
|
5
|
+
# License, v. 2.0. If a copy of the MPL was not distributed with this
|
6
|
+
# file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
7
|
+
|
4
8
|
def javascripts
|
5
9
|
super + %w(js/view_on_github.js)
|
6
10
|
end
|
data/yard_rideliner.gemspec
CHANGED
@@ -20,5 +20,9 @@ Gem::Specification.new do |spec|
|
|
20
20
|
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
21
21
|
spec.require_paths = ['lib']
|
22
22
|
|
23
|
-
spec.add_dependency '
|
23
|
+
spec.add_dependency 'kramdown'
|
24
|
+
spec.add_dependency 'yard'
|
25
|
+
spec.add_dependency 'ghpages_deploy'
|
26
|
+
|
27
|
+
spec.add_dependency 'rideliner'
|
24
28
|
end
|
metadata
CHANGED
@@ -1,29 +1,71 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: yard_rideliner
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.5.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Nathan Currier
|
8
8
|
autorequire:
|
9
9
|
bindir: bin
|
10
10
|
cert_chain: []
|
11
|
-
date: 2016-
|
11
|
+
date: 2016-05-07 00:00:00.000000000 Z
|
12
12
|
dependencies:
|
13
13
|
- !ruby/object:Gem::Dependency
|
14
|
+
prerelease: false
|
15
|
+
version_requirements: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0'
|
20
|
+
type: :runtime
|
21
|
+
name: kramdown
|
22
|
+
requirement: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - ">="
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
prerelease: false
|
29
|
+
version_requirements: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - ">="
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '0'
|
14
34
|
type: :runtime
|
15
35
|
name: yard
|
36
|
+
requirement: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - ">="
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '0'
|
41
|
+
- !ruby/object:Gem::Dependency
|
16
42
|
prerelease: false
|
43
|
+
version_requirements: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - ">="
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '0'
|
48
|
+
type: :runtime
|
49
|
+
name: ghpages_deploy
|
17
50
|
requirement: !ruby/object:Gem::Requirement
|
18
51
|
requirements:
|
19
|
-
- - "
|
52
|
+
- - ">="
|
20
53
|
- !ruby/object:Gem::Version
|
21
|
-
version: '0
|
54
|
+
version: '0'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
prerelease: false
|
22
57
|
version_requirements: !ruby/object:Gem::Requirement
|
23
58
|
requirements:
|
24
|
-
- - "
|
59
|
+
- - ">="
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '0'
|
62
|
+
type: :runtime
|
63
|
+
name: rideliner
|
64
|
+
requirement: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - ">="
|
25
67
|
- !ruby/object:Gem::Version
|
26
|
-
version: '0
|
68
|
+
version: '0'
|
27
69
|
description: YARD plugin for Rideliner's projects
|
28
70
|
email:
|
29
71
|
- nathan.currier@gmail.com
|
@@ -36,6 +78,9 @@ files:
|
|
36
78
|
- Gemfile
|
37
79
|
- Rakefile
|
38
80
|
- lib/yard_rideliner.rb
|
81
|
+
- lib/yard_rideliner/task/ghpages_deploy.rb
|
82
|
+
- lib/yard_rideliner/task/yard.rb
|
83
|
+
- lib/yard_rideliner/tasks.rb
|
39
84
|
- lib/yard_rideliner/template_path.rb
|
40
85
|
- lib/yard_rideliner/version.rb
|
41
86
|
- template/default/fulldoc/html/full_list_version.erb
|
@@ -64,7 +109,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
|
|
64
109
|
version: '0'
|
65
110
|
requirements: []
|
66
111
|
rubyforge_project:
|
67
|
-
rubygems_version: 2.
|
112
|
+
rubygems_version: 2.6.2
|
68
113
|
signing_key:
|
69
114
|
specification_version: 4
|
70
115
|
summary: YARD plugin to template Rideliner's projects
|