guard-rdoc 1.0.1

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml ADDED
@@ -0,0 +1,7 @@
1
+ ---
2
+ SHA1:
3
+ metadata.gz: 00f16c80e9d41f763e367b494b7f1af4cc176ff6
4
+ data.tar.gz: cdc28213a2217791d8e16a32186352cd937ccbb5
5
+ SHA512:
6
+ metadata.gz: be8c4b9e086248471cf6980382ae0bdb483d37f420711482917a1b42ee0a30163942ed067e2ffcd3b87b31d3b9ad8fcbf0a80335189087390a0fc79669d03241
7
+ data.tar.gz: 7402f434da5179bc4d803f69afaa4316b5503773adde0ee276f9b9865c648f5076def606f00561d0d5bf8471f4a402b8713d1691fbb643b11c7e7a6619e1adc0
data/.gitignore ADDED
@@ -0,0 +1,17 @@
1
+ *.gem
2
+ *.rbc
3
+ .bundle
4
+ .config
5
+ .yardoc
6
+ Gemfile.lock
7
+ InstalledFiles
8
+ _yardoc
9
+ coverage
10
+ doc/
11
+ lib/bundler/man
12
+ pkg
13
+ rdoc
14
+ spec/reports
15
+ test/tmp
16
+ test/version_tmp
17
+ tmp
data/Gemfile ADDED
@@ -0,0 +1,4 @@
1
+ source 'https://rubygems.org'
2
+
3
+ # Specify your gem's dependencies in guard-rdoc.gemspec
4
+ gemspec
data/LICENSE.txt ADDED
@@ -0,0 +1,22 @@
1
+ Copyright (c) 2014 Bradley J. Spaulding
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,35 @@
1
+ # Guard::Rdoc
2
+
3
+ RDoc plugin for guard. Automatically rebuild rdoc on code changes.
4
+
5
+ ## Installation
6
+
7
+ Add this line to your application's Gemfile:
8
+
9
+ gem 'guard-rdoc'
10
+
11
+ And then execute:
12
+
13
+ $ bundle
14
+
15
+ Or install it yourself as:
16
+
17
+ $ gem install guard-rdoc
18
+
19
+ ## Usage
20
+
21
+ Add `guard-rdoc` to your Guardfile:
22
+
23
+ ```ruby
24
+ guard(:rdoc, format: :sdoc) { watch(/^app\/.*/) }
25
+ ```
26
+
27
+ Any options will be passed to RDoc, see the RDoc documentation for details.
28
+
29
+ ## Contributing
30
+
31
+ 1. Fork it ( http://github.com/<my-github-username>/guard-rdoc/fork )
32
+ 2. Create your feature branch (`git checkout -b my-new-feature`)
33
+ 3. Commit your changes (`git commit -am 'Add some feature'`)
34
+ 4. Push to the branch (`git push origin my-new-feature`)
35
+ 5. Create new Pull Request
data/Rakefile ADDED
@@ -0,0 +1 @@
1
+ require "bundler/gem_tasks"
@@ -0,0 +1,26 @@
1
+ # coding: utf-8
2
+ lib = File.expand_path('../lib', __FILE__)
3
+ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
4
+ require 'guard/rdoc/version'
5
+
6
+ Gem::Specification.new do |spec|
7
+ spec.name = "guard-rdoc"
8
+ spec.version = Guard::RdocVersion::VERSION
9
+ spec.authors = ["Bradley J. Spaulding"]
10
+ spec.email = ["bspaulding@dataxu.com"]
11
+ spec.summary = %q{Automatically rebuild rdoc on code changes.}
12
+ spec.description = %q{}
13
+ spec.homepage = "https://rubygems.org/gems/guard-rdoc"
14
+ spec.license = "MIT"
15
+
16
+ spec.files = `git ls-files -z`.split("\x0")
17
+ spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
18
+ spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
19
+ spec.require_paths = ["lib"]
20
+
21
+ spec.add_dependency "guard"
22
+
23
+ spec.add_development_dependency "bundler", "~> 1.5"
24
+ spec.add_development_dependency "rake"
25
+ spec.add_development_dependency "sdoc"
26
+ end
@@ -0,0 +1,5 @@
1
+ module Guard
2
+ module RdocVersion
3
+ VERSION = "1.0.1"
4
+ end
5
+ end
data/lib/guard/rdoc.rb ADDED
@@ -0,0 +1,22 @@
1
+ require "guard/rdoc/version"
2
+ require "guard"
3
+ require "guard/plugin"
4
+ require "rdoc"
5
+
6
+ module Guard
7
+ class Rdoc < Plugin
8
+ def run_on_changes(paths)
9
+ rdoc.document(rdoc_options + paths)
10
+ end
11
+
12
+ def rdoc_options
13
+ options.map {|k,v| "--#{k}=#{v}" }
14
+ end
15
+
16
+ private
17
+
18
+ def rdoc
19
+ @rdoc ||= RDoc::RDoc.new
20
+ end
21
+ end
22
+ end
data/test/Gemfile ADDED
@@ -0,0 +1,5 @@
1
+ source 'https://rubygems.org'
2
+
3
+ gem 'guard-rdoc', path: '../'
4
+ gem 'sdoc'
5
+
data/test/Guardfile ADDED
@@ -0,0 +1,2 @@
1
+ guard(:rdoc, format: :sdoc) { watch(/^app\/.*/) }
2
+
@@ -0,0 +1,7 @@
1
+ class Greeter
2
+ attr_accessor :first_name, :last_name
3
+
4
+ def name
5
+ [first_name, last_name].join(' ')
6
+ end
7
+ end
metadata ADDED
@@ -0,0 +1,114 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: guard-rdoc
3
+ version: !ruby/object:Gem::Version
4
+ version: 1.0.1
5
+ platform: ruby
6
+ authors:
7
+ - Bradley J. Spaulding
8
+ autorequire:
9
+ bindir: bin
10
+ cert_chain: []
11
+ date: 2014-04-25 00:00:00.000000000 Z
12
+ dependencies:
13
+ - !ruby/object:Gem::Dependency
14
+ name: guard
15
+ requirement: !ruby/object:Gem::Requirement
16
+ requirements:
17
+ - - '>='
18
+ - !ruby/object:Gem::Version
19
+ version: '0'
20
+ type: :runtime
21
+ prerelease: false
22
+ version_requirements: !ruby/object:Gem::Requirement
23
+ requirements:
24
+ - - '>='
25
+ - !ruby/object:Gem::Version
26
+ version: '0'
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.5'
34
+ type: :development
35
+ prerelease: false
36
+ version_requirements: !ruby/object:Gem::Requirement
37
+ requirements:
38
+ - - ~>
39
+ - !ruby/object:Gem::Version
40
+ version: '1.5'
41
+ - !ruby/object:Gem::Dependency
42
+ name: rake
43
+ requirement: !ruby/object:Gem::Requirement
44
+ requirements:
45
+ - - '>='
46
+ - !ruby/object:Gem::Version
47
+ version: '0'
48
+ type: :development
49
+ prerelease: false
50
+ version_requirements: !ruby/object:Gem::Requirement
51
+ requirements:
52
+ - - '>='
53
+ - !ruby/object:Gem::Version
54
+ version: '0'
55
+ - !ruby/object:Gem::Dependency
56
+ name: sdoc
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
+ description: ''
70
+ email:
71
+ - bspaulding@dataxu.com
72
+ executables: []
73
+ extensions: []
74
+ extra_rdoc_files: []
75
+ files:
76
+ - .gitignore
77
+ - Gemfile
78
+ - LICENSE.txt
79
+ - README.md
80
+ - Rakefile
81
+ - guard-rdoc.gemspec
82
+ - lib/guard/rdoc.rb
83
+ - lib/guard/rdoc/version.rb
84
+ - test/Gemfile
85
+ - test/Guardfile
86
+ - test/app/models/greeter.rb
87
+ homepage: https://rubygems.org/gems/guard-rdoc
88
+ licenses:
89
+ - MIT
90
+ metadata: {}
91
+ post_install_message:
92
+ rdoc_options: []
93
+ require_paths:
94
+ - lib
95
+ required_ruby_version: !ruby/object:Gem::Requirement
96
+ requirements:
97
+ - - '>='
98
+ - !ruby/object:Gem::Version
99
+ version: '0'
100
+ required_rubygems_version: !ruby/object:Gem::Requirement
101
+ requirements:
102
+ - - '>='
103
+ - !ruby/object:Gem::Version
104
+ version: '0'
105
+ requirements: []
106
+ rubyforge_project:
107
+ rubygems_version: 2.0.14
108
+ signing_key:
109
+ specification_version: 4
110
+ summary: Automatically rebuild rdoc on code changes.
111
+ test_files:
112
+ - test/Gemfile
113
+ - test/Guardfile
114
+ - test/app/models/greeter.rb