nanoc-graphviz 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 +26 -0
- data/.travis.yml +3 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +50 -0
- data/Rakefile +15 -0
- data/lib/nanoc-graphviz.rb +3 -0
- data/lib/nanoc/graphviz.rb +11 -0
- data/lib/nanoc/graphviz/filter.rb +45 -0
- data/lib/nanoc/graphviz/version.rb +6 -0
- data/nanoc-graphviz.gemspec +30 -0
- data/test/minitest_helper.rb +7 -0
- data/test/nanoc-graphviz/test_filter.rb +66 -0
- data/test/nanoc-graphviz/test_graphviz.rb +16 -0
- metadata +180 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 4e0bd01739d6524dd4c8efccdf82035e2bd412a8
|
4
|
+
data.tar.gz: 3d14a2e26ac28df089647c643519b086f6ac8f3b
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 0bc79161c9b8e775a35999958c6ba10231398bbbfe457201f77367811c6b4e5b86d61720b5228e9a7f2aa8ec1b7f6b18a61ed977ac8421b06492a76753bfb83a
|
7
|
+
data.tar.gz: a56ba59ee1300f1caf5c4306ca61078c7a20455a3545ec07d856d7bc29dfdcd1bae6a638f4f39bd26b1af0243f247a50a7589937e38be6bfeba1f97317af2aba
|
data/.gitignore
ADDED
@@ -0,0 +1,26 @@
|
|
1
|
+
.ruby-version
|
2
|
+
.rbenv-gemsets
|
3
|
+
.gems
|
4
|
+
|
5
|
+
Gemfile.lock
|
6
|
+
*.gem
|
7
|
+
*.rbc
|
8
|
+
.bundle
|
9
|
+
.config
|
10
|
+
.yardoc
|
11
|
+
InstalledFiles
|
12
|
+
_yardoc
|
13
|
+
coverage
|
14
|
+
doc/
|
15
|
+
lib/bundler/man
|
16
|
+
pkg
|
17
|
+
rdoc
|
18
|
+
spec/reports
|
19
|
+
test/tmp
|
20
|
+
test/version_tmp
|
21
|
+
tmp
|
22
|
+
*.bundle
|
23
|
+
*.so
|
24
|
+
*.o
|
25
|
+
*.a
|
26
|
+
mkmf.log
|
data/.travis.yml
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2014 tetor
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,50 @@
|
|
1
|
+
[](https://travis-ci.org/tetor/nanoc-graphviz)
|
2
|
+
|
3
|
+
# Nanoc::Graphviz
|
4
|
+
|
5
|
+
Nanoc Graphviz filter plugin.
|
6
|
+
|
7
|
+
This filter converts dot file to PNG.
|
8
|
+
|
9
|
+
## Installation
|
10
|
+
|
11
|
+
Add this line to your application's Gemfile:
|
12
|
+
|
13
|
+
gem 'nanoc-graphviz'
|
14
|
+
|
15
|
+
And then execute:
|
16
|
+
|
17
|
+
$ bundle
|
18
|
+
|
19
|
+
Or install it yourself as:
|
20
|
+
|
21
|
+
$ gem install nanoc-graphviz
|
22
|
+
|
23
|
+
## Usage
|
24
|
+
|
25
|
+
This plugin adds `:graphviz` filter to nanoc.
|
26
|
+
|
27
|
+
In Nanoc Rules file, please write compile and route settings as below.
|
28
|
+
|
29
|
+
compile '*' do
|
30
|
+
if item[:extension] == 'dot'
|
31
|
+
filter :graphviz
|
32
|
+
end
|
33
|
+
end
|
34
|
+
|
35
|
+
route '*' do
|
36
|
+
if item[:extension] == 'dot'
|
37
|
+
item.identifier.chop + '.png'
|
38
|
+
end
|
39
|
+
end
|
40
|
+
|
41
|
+
If you forget route setting, the filter will generate PNG file but it extension will be same to source file. (perhaps '.dot')
|
42
|
+
|
43
|
+
|
44
|
+
## Contributing
|
45
|
+
|
46
|
+
1. Fork it ( https://github.com/tetor/nanoc-graphviz/fork )
|
47
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
48
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
49
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
50
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1,15 @@
|
|
1
|
+
require 'bundler/gem_tasks'
|
2
|
+
require 'rake/testtask'
|
3
|
+
require 'yard'
|
4
|
+
require 'rubocop/rake_task'
|
5
|
+
|
6
|
+
Rake::TestTask.new(:test) do |t|
|
7
|
+
t.libs = %w(lib test)
|
8
|
+
t.test_files = FileList['test/nanoc-graphviz/test_*.rb']
|
9
|
+
end
|
10
|
+
|
11
|
+
YARD::Rake::YardocTask.new
|
12
|
+
|
13
|
+
RuboCop::RakeTask.new
|
14
|
+
|
15
|
+
task default: :test
|
@@ -0,0 +1,45 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
|
3
|
+
# Graphviz filter
|
4
|
+
module Nanoc
|
5
|
+
module Graphviz
|
6
|
+
# Graphviz Filter class
|
7
|
+
class Filter < Nanoc::Filter
|
8
|
+
# set filter name
|
9
|
+
identifier :graphviz
|
10
|
+
# type :type => :binary
|
11
|
+
type :binary
|
12
|
+
|
13
|
+
# convert Graphviz code to image
|
14
|
+
#
|
15
|
+
# @param [String] content Graphviz code
|
16
|
+
# @return [Integer] command process status
|
17
|
+
# @raise [RuntimeError]
|
18
|
+
def run(content, _ = {})
|
19
|
+
fail 'Runtime environments is not ready' unless ready?
|
20
|
+
command = "dot -Tpng -o #{output_filename} < #{content}"
|
21
|
+
system(command)
|
22
|
+
$?
|
23
|
+
end
|
24
|
+
|
25
|
+
# check runtime envs
|
26
|
+
#
|
27
|
+
# @return [Boolean]
|
28
|
+
def ready?
|
29
|
+
graphviz_ready?
|
30
|
+
end
|
31
|
+
|
32
|
+
private
|
33
|
+
|
34
|
+
# Whether the Graphviz installed
|
35
|
+
#
|
36
|
+
# @return [Boolean]
|
37
|
+
def graphviz_ready?
|
38
|
+
if system('which dot >/dev/null 2>&1')
|
39
|
+
return true
|
40
|
+
end
|
41
|
+
false
|
42
|
+
end
|
43
|
+
end
|
44
|
+
end
|
45
|
+
end
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'nanoc/graphviz/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = 'nanoc-graphviz'
|
8
|
+
spec.version = Nanoc::Graphviz::VERSION
|
9
|
+
spec.authors = ['tetor']
|
10
|
+
spec.email = ['akihatoetsu@gmail.com']
|
11
|
+
spec.summary = 'nanoc graphviz filter plugin'
|
12
|
+
spec.description = 'nanoc graphviz filter plugin'
|
13
|
+
spec.homepage = ''
|
14
|
+
spec.license = 'MIT'
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(/^bin\//) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(/^(test|spec|features)/)
|
19
|
+
spec.require_paths = ['lib']
|
20
|
+
|
21
|
+
spec.add_runtime_dependency('nanoc', '>= 3.6.7', '< 4.0.0')
|
22
|
+
|
23
|
+
spec.add_development_dependency 'bundler', '~> 1.6'
|
24
|
+
spec.add_development_dependency 'rake'
|
25
|
+
spec.add_development_dependency 'minitest'
|
26
|
+
spec.add_development_dependency 'minitest-rg', '~> 5.1.0'
|
27
|
+
spec.add_development_dependency 'rubocop'
|
28
|
+
spec.add_development_dependency 'yard'
|
29
|
+
spec.add_development_dependency 'redcarpet'
|
30
|
+
end
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# encoding: utf-8
|
2
|
+
#
|
3
|
+
# Graphviz filter test
|
4
|
+
|
5
|
+
require 'minitest_helper'
|
6
|
+
require 'tmpdir'
|
7
|
+
|
8
|
+
module Nanoc
|
9
|
+
module Graphviz
|
10
|
+
# nanoc-graphviz Filter's test
|
11
|
+
class FilterTest < MiniTest::Test
|
12
|
+
def setup
|
13
|
+
@filter_class = ::Nanoc::Graphviz::Filter
|
14
|
+
@filter = @filter_class.new
|
15
|
+
end
|
16
|
+
|
17
|
+
def test_ready
|
18
|
+
if system('which dot >/dev/null 2>&1')
|
19
|
+
assert @filter.ready?, 'Running environment is not ready.'
|
20
|
+
else
|
21
|
+
assert !@filter.ready?, 'Running environment check is failed.'
|
22
|
+
end
|
23
|
+
end
|
24
|
+
|
25
|
+
def test_from_binary
|
26
|
+
assert @filter_class.from_binary?, 'from setting is not correct.'
|
27
|
+
end
|
28
|
+
|
29
|
+
def test_to_binary
|
30
|
+
assert @filter_class.to_binary?, 'to binary setting is not correct.'
|
31
|
+
end
|
32
|
+
|
33
|
+
# run method test
|
34
|
+
def test_run
|
35
|
+
if @filter.ready?
|
36
|
+
tmp_dir, filename = generate_test_item
|
37
|
+
assert_equal 0, @filter.run("#{tmp_dir}/#{filename}")
|
38
|
+
FileUtils.remove_entry tmp_dir
|
39
|
+
else
|
40
|
+
check_run_error
|
41
|
+
end
|
42
|
+
end
|
43
|
+
|
44
|
+
private
|
45
|
+
|
46
|
+
def check_run_error
|
47
|
+
@filter.run('foo')
|
48
|
+
rescue RuntimeError
|
49
|
+
assert true
|
50
|
+
else
|
51
|
+
assert false, 'Envs is not ready but no Error raisen'
|
52
|
+
end
|
53
|
+
|
54
|
+
def generate_test_item
|
55
|
+
dot_lang = 'graph graphname {a -- b -- c;b -- d;}'
|
56
|
+
in_f_name = 'graphviz_test.dot'
|
57
|
+
|
58
|
+
tmp_dir = Dir.mktmpdir
|
59
|
+
open("#{tmp_dir}/#{in_f_name}", 'w') do |f|
|
60
|
+
f.puts(dot_lang)
|
61
|
+
end
|
62
|
+
[tmp_dir, in_f_name]
|
63
|
+
end
|
64
|
+
end
|
65
|
+
end
|
66
|
+
end
|
@@ -0,0 +1,16 @@
|
|
1
|
+
require 'minitest_helper'
|
2
|
+
|
3
|
+
module Nanoc
|
4
|
+
module Graphviz
|
5
|
+
# Test runner checker Class
|
6
|
+
class TestTest < MiniTest::Test
|
7
|
+
def test_tests_are_running
|
8
|
+
assert true
|
9
|
+
end
|
10
|
+
|
11
|
+
def test_that_it_has_a_version_number
|
12
|
+
refute_nil ::Nanoc::Graphviz::VERSION
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
end
|
metadata
ADDED
@@ -0,0 +1,180 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: nanoc-graphviz
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- tetor
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2014-06-29 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: nanoc
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - ">="
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 3.6.7
|
20
|
+
- - "<"
|
21
|
+
- !ruby/object:Gem::Version
|
22
|
+
version: 4.0.0
|
23
|
+
type: :runtime
|
24
|
+
prerelease: false
|
25
|
+
version_requirements: !ruby/object:Gem::Requirement
|
26
|
+
requirements:
|
27
|
+
- - ">="
|
28
|
+
- !ruby/object:Gem::Version
|
29
|
+
version: 3.6.7
|
30
|
+
- - "<"
|
31
|
+
- !ruby/object:Gem::Version
|
32
|
+
version: 4.0.0
|
33
|
+
- !ruby/object:Gem::Dependency
|
34
|
+
name: bundler
|
35
|
+
requirement: !ruby/object:Gem::Requirement
|
36
|
+
requirements:
|
37
|
+
- - "~>"
|
38
|
+
- !ruby/object:Gem::Version
|
39
|
+
version: '1.6'
|
40
|
+
type: :development
|
41
|
+
prerelease: false
|
42
|
+
version_requirements: !ruby/object:Gem::Requirement
|
43
|
+
requirements:
|
44
|
+
- - "~>"
|
45
|
+
- !ruby/object:Gem::Version
|
46
|
+
version: '1.6'
|
47
|
+
- !ruby/object:Gem::Dependency
|
48
|
+
name: rake
|
49
|
+
requirement: !ruby/object:Gem::Requirement
|
50
|
+
requirements:
|
51
|
+
- - ">="
|
52
|
+
- !ruby/object:Gem::Version
|
53
|
+
version: '0'
|
54
|
+
type: :development
|
55
|
+
prerelease: false
|
56
|
+
version_requirements: !ruby/object:Gem::Requirement
|
57
|
+
requirements:
|
58
|
+
- - ">="
|
59
|
+
- !ruby/object:Gem::Version
|
60
|
+
version: '0'
|
61
|
+
- !ruby/object:Gem::Dependency
|
62
|
+
name: minitest
|
63
|
+
requirement: !ruby/object:Gem::Requirement
|
64
|
+
requirements:
|
65
|
+
- - ">="
|
66
|
+
- !ruby/object:Gem::Version
|
67
|
+
version: '0'
|
68
|
+
type: :development
|
69
|
+
prerelease: false
|
70
|
+
version_requirements: !ruby/object:Gem::Requirement
|
71
|
+
requirements:
|
72
|
+
- - ">="
|
73
|
+
- !ruby/object:Gem::Version
|
74
|
+
version: '0'
|
75
|
+
- !ruby/object:Gem::Dependency
|
76
|
+
name: minitest-rg
|
77
|
+
requirement: !ruby/object:Gem::Requirement
|
78
|
+
requirements:
|
79
|
+
- - "~>"
|
80
|
+
- !ruby/object:Gem::Version
|
81
|
+
version: 5.1.0
|
82
|
+
type: :development
|
83
|
+
prerelease: false
|
84
|
+
version_requirements: !ruby/object:Gem::Requirement
|
85
|
+
requirements:
|
86
|
+
- - "~>"
|
87
|
+
- !ruby/object:Gem::Version
|
88
|
+
version: 5.1.0
|
89
|
+
- !ruby/object:Gem::Dependency
|
90
|
+
name: rubocop
|
91
|
+
requirement: !ruby/object:Gem::Requirement
|
92
|
+
requirements:
|
93
|
+
- - ">="
|
94
|
+
- !ruby/object:Gem::Version
|
95
|
+
version: '0'
|
96
|
+
type: :development
|
97
|
+
prerelease: false
|
98
|
+
version_requirements: !ruby/object:Gem::Requirement
|
99
|
+
requirements:
|
100
|
+
- - ">="
|
101
|
+
- !ruby/object:Gem::Version
|
102
|
+
version: '0'
|
103
|
+
- !ruby/object:Gem::Dependency
|
104
|
+
name: yard
|
105
|
+
requirement: !ruby/object:Gem::Requirement
|
106
|
+
requirements:
|
107
|
+
- - ">="
|
108
|
+
- !ruby/object:Gem::Version
|
109
|
+
version: '0'
|
110
|
+
type: :development
|
111
|
+
prerelease: false
|
112
|
+
version_requirements: !ruby/object:Gem::Requirement
|
113
|
+
requirements:
|
114
|
+
- - ">="
|
115
|
+
- !ruby/object:Gem::Version
|
116
|
+
version: '0'
|
117
|
+
- !ruby/object:Gem::Dependency
|
118
|
+
name: redcarpet
|
119
|
+
requirement: !ruby/object:Gem::Requirement
|
120
|
+
requirements:
|
121
|
+
- - ">="
|
122
|
+
- !ruby/object:Gem::Version
|
123
|
+
version: '0'
|
124
|
+
type: :development
|
125
|
+
prerelease: false
|
126
|
+
version_requirements: !ruby/object:Gem::Requirement
|
127
|
+
requirements:
|
128
|
+
- - ">="
|
129
|
+
- !ruby/object:Gem::Version
|
130
|
+
version: '0'
|
131
|
+
description: nanoc graphviz filter plugin
|
132
|
+
email:
|
133
|
+
- akihatoetsu@gmail.com
|
134
|
+
executables: []
|
135
|
+
extensions: []
|
136
|
+
extra_rdoc_files: []
|
137
|
+
files:
|
138
|
+
- ".gitignore"
|
139
|
+
- ".travis.yml"
|
140
|
+
- Gemfile
|
141
|
+
- LICENSE.txt
|
142
|
+
- README.md
|
143
|
+
- Rakefile
|
144
|
+
- lib/nanoc-graphviz.rb
|
145
|
+
- lib/nanoc/graphviz.rb
|
146
|
+
- lib/nanoc/graphviz/filter.rb
|
147
|
+
- lib/nanoc/graphviz/version.rb
|
148
|
+
- nanoc-graphviz.gemspec
|
149
|
+
- test/minitest_helper.rb
|
150
|
+
- test/nanoc-graphviz/test_filter.rb
|
151
|
+
- test/nanoc-graphviz/test_graphviz.rb
|
152
|
+
homepage: ''
|
153
|
+
licenses:
|
154
|
+
- MIT
|
155
|
+
metadata: {}
|
156
|
+
post_install_message:
|
157
|
+
rdoc_options: []
|
158
|
+
require_paths:
|
159
|
+
- lib
|
160
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
161
|
+
requirements:
|
162
|
+
- - ">="
|
163
|
+
- !ruby/object:Gem::Version
|
164
|
+
version: '0'
|
165
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
166
|
+
requirements:
|
167
|
+
- - ">="
|
168
|
+
- !ruby/object:Gem::Version
|
169
|
+
version: '0'
|
170
|
+
requirements: []
|
171
|
+
rubyforge_project:
|
172
|
+
rubygems_version: 2.2.2
|
173
|
+
signing_key:
|
174
|
+
specification_version: 4
|
175
|
+
summary: nanoc graphviz filter plugin
|
176
|
+
test_files:
|
177
|
+
- test/minitest_helper.rb
|
178
|
+
- test/nanoc-graphviz/test_filter.rb
|
179
|
+
- test/nanoc-graphviz/test_graphviz.rb
|
180
|
+
has_rdoc:
|