yard-serverspec-plugin 0.0.1
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +14 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +69 -0
- data/Rakefile +2 -0
- data/lib/yard-serverspec-plugin.rb +1 -0
- data/lib/yard/serverspec/plugin.rb +9 -0
- data/lib/yard/serverspec/plugin/handler.rb +51 -0
- data/lib/yard/serverspec/plugin/version.rb +7 -0
- data/yard-serverspec-plugin.gemspec +24 -0
- metadata +111 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: b3e37f5ebfdba1bad7c77509d7822ac58eb5d4f6
|
4
|
+
data.tar.gz: d6ac0e811c7614a9bb304256476b1790151163b6
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 694b76b28c87ac1033fb7d6361727b78373f54c97846f6608f358143ad12a9344c0c8a0baf44b78cfb1e044ebf13835d235b90ce8b2212811eb90dc29f0211f2
|
7
|
+
data.tar.gz: fcdbbf51807dee7e80a10a9421fedf8aa7ba115ae0fde3fadbbf1d1d30cafc7406c55cafeda95ed9ee1575c5f48183f71af4db21e38088b5a20238bc1e215bb4
|
data/.gitignore
ADDED
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2015 YOSHIKAWA Ryota
|
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,69 @@
|
|
1
|
+
# Yard::Serverspec::Plugin
|
2
|
+
|
3
|
+
This plugin adds [Serverspec](http://serverspec.org/) specs to YARD output.
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'yard-serverspec-plugin'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install yard-serverspec-plugin
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
Add comments to your specs.
|
24
|
+
|
25
|
+
```
|
26
|
+
# @param kernel.panic Kernel behaviour on panic: delay
|
27
|
+
# @note default: 0 (wait forever). Check 30 seconds before rebooting.
|
28
|
+
context linux_kernel_parameter('kernel.panic') do
|
29
|
+
its(:value) { should <= 30 }
|
30
|
+
end
|
31
|
+
```
|
32
|
+
|
33
|
+
You're ready to go:
|
34
|
+
|
35
|
+
```
|
36
|
+
yardoc -e yard-serverspec spec/*_spec.rb
|
37
|
+
```
|
38
|
+
|
39
|
+
or You can do this by adding the following to your ``Rakefile``:
|
40
|
+
|
41
|
+
```
|
42
|
+
namespace :doc do
|
43
|
+
begin
|
44
|
+
require 'yard'
|
45
|
+
require 'yard/rake/yardoc_task'
|
46
|
+
require 'yard/serverspec/plugin'
|
47
|
+
rescue LoadError
|
48
|
+
raise 'YARD is not available. Try installing it.'
|
49
|
+
end
|
50
|
+
YARD::Config.load_plugin('serverspec-plugin')
|
51
|
+
YARD::Rake::YardocTask.new do |t|
|
52
|
+
t.files = ['spec/*_spec.rb']
|
53
|
+
end
|
54
|
+
end
|
55
|
+
```
|
56
|
+
|
57
|
+
and type:
|
58
|
+
|
59
|
+
```
|
60
|
+
rake doc:yard
|
61
|
+
```
|
62
|
+
|
63
|
+
## Contributing
|
64
|
+
|
65
|
+
1. Fork it ( https://github.com/rrreeeyyy/yard-serverspec-plugin/fork )
|
66
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
67
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
68
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
69
|
+
5. Create a new Pull Request
|
data/Rakefile
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
require 'yard/serverspec/plugin/handler.rb'
|
@@ -0,0 +1,51 @@
|
|
1
|
+
require 'yard'
|
2
|
+
|
3
|
+
module YARD
|
4
|
+
module CodeObjects
|
5
|
+
# SpecObjectClass
|
6
|
+
class SpecObject < MethodObject
|
7
|
+
attr_accessor :target
|
8
|
+
def type
|
9
|
+
:method
|
10
|
+
end
|
11
|
+
end
|
12
|
+
end
|
13
|
+
|
14
|
+
module Handlers
|
15
|
+
module Serverspec
|
16
|
+
# AbstractSpecHandler
|
17
|
+
module AbstractSpecHandler
|
18
|
+
def process
|
19
|
+
register_spec(target)
|
20
|
+
parse_block(statement.last.last)
|
21
|
+
end
|
22
|
+
|
23
|
+
def register_file
|
24
|
+
file_name = parser.file.split('/').last.gsub('_spec.rb', '')
|
25
|
+
CodeObjects::ClassObject.new(namespace, file_name)
|
26
|
+
end
|
27
|
+
|
28
|
+
def register_spec(target, _doc = nil)
|
29
|
+
register CodeObjects::SpecObject.new(register_file, target.source, :instance) do |o|
|
30
|
+
o.visibility = 'public'
|
31
|
+
o.source = statement.source
|
32
|
+
o.signature = target.source
|
33
|
+
o.explicit = true
|
34
|
+
o.docstring = statement.comments
|
35
|
+
end
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# Describe handler for YARD's source parser.
|
40
|
+
class DescribeHandler < Ruby::Base
|
41
|
+
include AbstractSpecHandler
|
42
|
+
handles method_call(:describe)
|
43
|
+
handles method_call(:context)
|
44
|
+
|
45
|
+
def target
|
46
|
+
statement.parameters.first
|
47
|
+
end
|
48
|
+
end
|
49
|
+
end
|
50
|
+
end
|
51
|
+
end
|
@@ -0,0 +1,24 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'yard/serverspec/plugin/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "yard-serverspec-plugin"
|
8
|
+
spec.version = Yard::Serverspec::Plugin::VERSION
|
9
|
+
spec.authors = ["YOSHIKAWA Ryota"]
|
10
|
+
spec.email = ["yoshikawa@topotal.com"]
|
11
|
+
spec.summary = %q{Displays Serverspec specs in YARD output.}
|
12
|
+
spec.description = %q{Displays Serverspec specs in YARD output.}
|
13
|
+
spec.homepage = "http://github.com/rrreeeyyy/#{spec.name}"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
18
|
+
spec.require_paths = ["lib"]
|
19
|
+
|
20
|
+
spec.add_dependency "yard", "~> 0.7"
|
21
|
+
spec.add_development_dependency "rspec", "~> 2.6"
|
22
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
23
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
24
|
+
end
|
metadata
ADDED
@@ -0,0 +1,111 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: yard-serverspec-plugin
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.1
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- YOSHIKAWA Ryota
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-02-16 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: yard
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - "~>"
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: '0.7'
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - "~>"
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: '0.7'
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: rspec
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - "~>"
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: '2.6'
|
34
|
+
type: :development
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - "~>"
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: '2.6'
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.7'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.7'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: rake
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '10.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '10.0'
|
69
|
+
description: Displays Serverspec specs in YARD output.
|
70
|
+
email:
|
71
|
+
- yoshikawa@topotal.com
|
72
|
+
executables: []
|
73
|
+
extensions: []
|
74
|
+
extra_rdoc_files: []
|
75
|
+
files:
|
76
|
+
- ".gitignore"
|
77
|
+
- Gemfile
|
78
|
+
- LICENSE.txt
|
79
|
+
- README.md
|
80
|
+
- Rakefile
|
81
|
+
- lib/yard-serverspec-plugin.rb
|
82
|
+
- lib/yard/serverspec/plugin.rb
|
83
|
+
- lib/yard/serverspec/plugin/handler.rb
|
84
|
+
- lib/yard/serverspec/plugin/version.rb
|
85
|
+
- yard-serverspec-plugin.gemspec
|
86
|
+
homepage: http://github.com/rrreeeyyy/yard-serverspec-plugin
|
87
|
+
licenses:
|
88
|
+
- MIT
|
89
|
+
metadata: {}
|
90
|
+
post_install_message:
|
91
|
+
rdoc_options: []
|
92
|
+
require_paths:
|
93
|
+
- lib
|
94
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
95
|
+
requirements:
|
96
|
+
- - ">="
|
97
|
+
- !ruby/object:Gem::Version
|
98
|
+
version: '0'
|
99
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - ">="
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '0'
|
104
|
+
requirements: []
|
105
|
+
rubyforge_project:
|
106
|
+
rubygems_version: 2.2.2
|
107
|
+
signing_key:
|
108
|
+
specification_version: 4
|
109
|
+
summary: Displays Serverspec specs in YARD output.
|
110
|
+
test_files: []
|
111
|
+
has_rdoc:
|