rdoc-readme 0.0.2
Sign up to get free protection for your applications and to get access to all the features.
- data/.gitignore +5 -0
- data/Gemfile +4 -0
- data/HISTORY +6 -0
- data/README.rdoc +16 -0
- data/Rakefile +2 -0
- data/bin/rdoc2readme +8 -0
- data/lib/rdoc-readme/version.rb +5 -0
- data/lib/rdoc-readme.rb +64 -0
- data/rdoc-readme.gemspec +21 -0
- metadata +57 -0
data/Gemfile
ADDED
data/HISTORY
ADDED
data/README.rdoc
ADDED
@@ -0,0 +1,16 @@
|
|
1
|
+
= RDoc::Readme - Extract high-level RDOC for use in a README file
|
2
|
+
|
3
|
+
== Usage
|
4
|
+
|
5
|
+
RDoc::Readme.new do |rdoc|
|
6
|
+
rdoc.from_file(file_name) # Prints to $stdout
|
7
|
+
rdoc.from_file_handle($stdin) # Prints to $stdout
|
8
|
+
end
|
9
|
+
|
10
|
+
== To Do
|
11
|
+
|
12
|
+
* Tests!
|
13
|
+
* Add Rake task
|
14
|
+
* Don't automagically print to +STDOUT+
|
15
|
+
* Use +RDoc+ and/or +YARD+ to handle the parsing.
|
16
|
+
|
data/Rakefile
ADDED
data/bin/rdoc2readme
ADDED
data/lib/rdoc-readme.rb
ADDED
@@ -0,0 +1,64 @@
|
|
1
|
+
module RDoc # :nodoc:
|
2
|
+
# = RDoc::Readme - Extract high-level RDOC for use in a README file
|
3
|
+
#
|
4
|
+
# == Usage
|
5
|
+
#
|
6
|
+
# RDoc::Readme.new do |rdoc|
|
7
|
+
# rdoc.from_file(file_name) # Prints to $stdout
|
8
|
+
# rdoc.from_file_handle($stdin) # Prints to $stdout
|
9
|
+
# end
|
10
|
+
#
|
11
|
+
# == To Do
|
12
|
+
#
|
13
|
+
# * Tests!
|
14
|
+
# * Add Rake task
|
15
|
+
# * Don't automagically print to +STDOUT+
|
16
|
+
# * Use +RDoc+ and/or +YARD+ to handle the parsing.
|
17
|
+
#
|
18
|
+
class Readme
|
19
|
+
|
20
|
+
# Create new +RDoc::Readme+ generator.
|
21
|
+
def initialize
|
22
|
+
yield self if block_given?
|
23
|
+
end
|
24
|
+
|
25
|
+
# Read RDoc from filehandle.
|
26
|
+
def from_file_handle(fh)
|
27
|
+
rdoc = false
|
28
|
+
|
29
|
+
fh.readlines.each do |line|
|
30
|
+
line.chomp!
|
31
|
+
|
32
|
+
if rdoc
|
33
|
+
comment?(line) ? ( puts sanitize(line) ) : rdoc = false
|
34
|
+
else
|
35
|
+
start?(line) ? ( rdoc = true ; puts sanitize(line) ) : rdoc = false
|
36
|
+
end
|
37
|
+
end
|
38
|
+
end
|
39
|
+
|
40
|
+
# Read RDoc from file.
|
41
|
+
def from_file(fn)
|
42
|
+
from_file_handle( File.open(fn) )
|
43
|
+
end
|
44
|
+
|
45
|
+
private
|
46
|
+
|
47
|
+
# Is this a comment?
|
48
|
+
def comment?(text)
|
49
|
+
text =~ /^\s*#\s*/
|
50
|
+
end
|
51
|
+
|
52
|
+
# Is this the start of RDoc markup?
|
53
|
+
def start?(text)
|
54
|
+
text =~ /^\s*#\s+=/
|
55
|
+
end
|
56
|
+
|
57
|
+
# Remove leading whitespace and comments from RDoc text.
|
58
|
+
def sanitize(text)
|
59
|
+
text.lstrip.gsub(/^#\s?/, '')
|
60
|
+
end
|
61
|
+
|
62
|
+
end
|
63
|
+
end
|
64
|
+
|
data/rdoc-readme.gemspec
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
# -*- encoding: utf-8 -*-
|
2
|
+
$:.push File.expand_path("../lib", __FILE__)
|
3
|
+
require "rdoc-readme/version"
|
4
|
+
|
5
|
+
Gem::Specification.new do |s|
|
6
|
+
s.name = 'rdoc-readme'
|
7
|
+
s.version = RDoc::Readme::VERSION
|
8
|
+
s.platform = Gem::Platform::RUBY
|
9
|
+
s.authors = ['Blair Christensen']
|
10
|
+
s.email = ['blair.christensen@gmail.com']
|
11
|
+
s.homepage = ""
|
12
|
+
s.summary = %q{Extract high-level RDoc for use in a README file}
|
13
|
+
s.description = %q{Extract high-level RDoc for use in a README file}
|
14
|
+
|
15
|
+
s.rubyforge_project = "rdoc-readme"
|
16
|
+
|
17
|
+
s.files = `git ls-files`.split("\n")
|
18
|
+
s.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
|
19
|
+
s.executables = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
|
20
|
+
s.require_paths = ['lib']
|
21
|
+
end
|
metadata
ADDED
@@ -0,0 +1,57 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: rdoc-readme
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.0.2
|
5
|
+
prerelease:
|
6
|
+
platform: ruby
|
7
|
+
authors:
|
8
|
+
- Blair Christensen
|
9
|
+
autorequire:
|
10
|
+
bindir: bin
|
11
|
+
cert_chain: []
|
12
|
+
date: 2011-04-01 00:00:00.000000000 -05:00
|
13
|
+
default_executable:
|
14
|
+
dependencies: []
|
15
|
+
description: Extract high-level RDoc for use in a README file
|
16
|
+
email:
|
17
|
+
- blair.christensen@gmail.com
|
18
|
+
executables:
|
19
|
+
- rdoc2readme
|
20
|
+
extensions: []
|
21
|
+
extra_rdoc_files: []
|
22
|
+
files:
|
23
|
+
- .gitignore
|
24
|
+
- Gemfile
|
25
|
+
- HISTORY
|
26
|
+
- README.rdoc
|
27
|
+
- Rakefile
|
28
|
+
- bin/rdoc2readme
|
29
|
+
- lib/rdoc-readme.rb
|
30
|
+
- lib/rdoc-readme/version.rb
|
31
|
+
- rdoc-readme.gemspec
|
32
|
+
has_rdoc: true
|
33
|
+
homepage: ''
|
34
|
+
licenses: []
|
35
|
+
post_install_message:
|
36
|
+
rdoc_options: []
|
37
|
+
require_paths:
|
38
|
+
- lib
|
39
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
40
|
+
none: false
|
41
|
+
requirements:
|
42
|
+
- - ! '>='
|
43
|
+
- !ruby/object:Gem::Version
|
44
|
+
version: '0'
|
45
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
46
|
+
none: false
|
47
|
+
requirements:
|
48
|
+
- - ! '>='
|
49
|
+
- !ruby/object:Gem::Version
|
50
|
+
version: '0'
|
51
|
+
requirements: []
|
52
|
+
rubyforge_project: rdoc-readme
|
53
|
+
rubygems_version: 1.6.0
|
54
|
+
signing_key:
|
55
|
+
specification_version: 3
|
56
|
+
summary: Extract high-level RDoc for use in a README file
|
57
|
+
test_files: []
|