morph-sdoc 0.2.21

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.
Files changed (53) hide show
  1. data/.rvmrc +2 -0
  2. data/LICENSE +21 -0
  3. data/README.rdoc +37 -0
  4. data/Rakefile +51 -0
  5. data/VERSION.yml +5 -0
  6. data/bin/sdoc +11 -0
  7. data/bin/sdoc-merge +12 -0
  8. data/lib/rdoc/discover.rb +1 -0
  9. data/lib/sdoc.rb +16 -0
  10. data/lib/sdoc/c_parser_fix.rb +31 -0
  11. data/lib/sdoc/generator/shtml.rb +352 -0
  12. data/lib/sdoc/generator/template/direct/_context.rhtml +172 -0
  13. data/lib/sdoc/generator/template/direct/class.rhtml +40 -0
  14. data/lib/sdoc/generator/template/direct/file.rhtml +30 -0
  15. data/lib/sdoc/generator/template/direct/index.rhtml +14 -0
  16. data/lib/sdoc/generator/template/direct/resources/apple-touch-icon.png +0 -0
  17. data/lib/sdoc/generator/template/direct/resources/css/main.css +278 -0
  18. data/lib/sdoc/generator/template/direct/resources/css/panel.css +383 -0
  19. data/lib/sdoc/generator/template/direct/resources/css/reset.css +53 -0
  20. data/lib/sdoc/generator/template/direct/resources/favicon.ico +0 -0
  21. data/lib/sdoc/generator/template/direct/resources/i/arrows.png +0 -0
  22. data/lib/sdoc/generator/template/direct/resources/i/results_bg.png +0 -0
  23. data/lib/sdoc/generator/template/direct/resources/i/tree_bg.png +0 -0
  24. data/lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js +19 -0
  25. data/lib/sdoc/generator/template/direct/resources/js/jquery-effect.js +593 -0
  26. data/lib/sdoc/generator/template/direct/resources/js/main.js +22 -0
  27. data/lib/sdoc/generator/template/direct/resources/js/searchdoc.js +628 -0
  28. data/lib/sdoc/generator/template/direct/resources/panel/index.html +71 -0
  29. data/lib/sdoc/generator/template/merge/index.rhtml +14 -0
  30. data/lib/sdoc/generator/template/shtml/_context.rhtml +164 -0
  31. data/lib/sdoc/generator/template/shtml/class.rhtml +46 -0
  32. data/lib/sdoc/generator/template/shtml/file.rhtml +37 -0
  33. data/lib/sdoc/generator/template/shtml/index.rhtml +14 -0
  34. data/lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png +0 -0
  35. data/lib/sdoc/generator/template/shtml/resources/css/main.css +191 -0
  36. data/lib/sdoc/generator/template/shtml/resources/css/panel.css +383 -0
  37. data/lib/sdoc/generator/template/shtml/resources/css/reset.css +53 -0
  38. data/lib/sdoc/generator/template/shtml/resources/favicon.ico +0 -0
  39. data/lib/sdoc/generator/template/shtml/resources/i/arrows.png +0 -0
  40. data/lib/sdoc/generator/template/shtml/resources/i/results_bg.png +0 -0
  41. data/lib/sdoc/generator/template/shtml/resources/i/tree_bg.png +0 -0
  42. data/lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js +19 -0
  43. data/lib/sdoc/generator/template/shtml/resources/js/main.js +34 -0
  44. data/lib/sdoc/generator/template/shtml/resources/js/searchdoc.js +628 -0
  45. data/lib/sdoc/generator/template/shtml/resources/panel/index.html +71 -0
  46. data/lib/sdoc/github.rb +61 -0
  47. data/lib/sdoc/helpers.rb +26 -0
  48. data/lib/sdoc/json_backend.rb +15 -0
  49. data/lib/sdoc/merge.rb +217 -0
  50. data/lib/sdoc/options.rb +329 -0
  51. data/lib/sdoc/templatable.rb +58 -0
  52. data/sdoc.gemspec +93 -0
  53. metadata +151 -0
@@ -0,0 +1,58 @@
1
+ require "sdoc"
2
+
3
+ module SDoc::Templatable
4
+ ### Load and render the erb template in the given +templatefile+ within the
5
+ ### specified +context+ (a Binding object) and return output
6
+ ### Both +templatefile+ and +outfile+ should be Pathname-like objects.
7
+ def eval_template(templatefile, context)
8
+ template_src = templatefile.read
9
+ template = ERB.new( template_src, nil, '<>' )
10
+ template.filename = templatefile.to_s
11
+
12
+ begin
13
+ template.result( context )
14
+ rescue NoMethodError => err
15
+ raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
16
+ templatefile.to_s,
17
+ err.message,
18
+ eval( "_erbout[-50,50]", context )
19
+ ], err.backtrace
20
+ end
21
+ end
22
+
23
+ ### Load and render the erb template with the given +template_name+ within
24
+ ### current context. Adds all +local_assigns+ to context
25
+ def include_template(template_name, local_assigns = {})
26
+ source = local_assigns.keys.map { |key| "#{key} = local_assigns[:#{key}];" }.join
27
+ eval("#{source};templatefile = @template_dir + template_name;eval_template(templatefile, binding)")
28
+ end
29
+
30
+ ### Load and render the erb template in the given +templatefile+ within the
31
+ ### specified +context+ (a Binding object) and write it out to +outfile+.
32
+ ### Both +templatefile+ and +outfile+ should be Pathname-like objects.
33
+ def render_template( templatefile, context, outfile )
34
+ output = eval_template(templatefile, context)
35
+
36
+ # TODO delete this dirty hack when documentation for example for GeneratorMethods will not be cutted off by <script> tag
37
+ begin
38
+ if output.respond_to? :force_encoding
39
+ encoding = output.encoding
40
+ output = output.force_encoding('ASCII-8BIT').gsub('<script>', '&lt;script;&gt;').force_encoding(encoding)
41
+ else
42
+ output = output.gsub('<script>', '&lt;script&gt;')
43
+ end
44
+ rescue Exception => e
45
+
46
+ end
47
+
48
+ unless $dryrun
49
+ outfile.dirname.mkpath
50
+ outfile.open( 'w', 0644 ) do |file|
51
+ file.print( output )
52
+ end
53
+ else
54
+ debug_msg " would have written %d bytes to %s" %
55
+ [ output.length, outfile ]
56
+ end
57
+ end
58
+ end
data/sdoc.gemspec ADDED
@@ -0,0 +1,93 @@
1
+ # Generated by jeweler
2
+ # DO NOT EDIT THIS FILE DIRECTLY
3
+ # Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
4
+ # -*- encoding: utf-8 -*-
5
+
6
+ Gem::Specification.new do |s|
7
+ s.name = %q{sdoc}
8
+ s.version = "0.2.21"
9
+
10
+ s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
11
+ s.authors = ["Volodya Kolesnikov"]
12
+ s.date = %q{2011-05-06}
13
+ s.email = %q{voloko@gmail.com}
14
+ s.executables = ["sdoc-merge", "sdoc"]
15
+ s.extra_rdoc_files = [
16
+ "LICENSE",
17
+ "README.rdoc"
18
+ ]
19
+ s.files = [
20
+ ".rvmrc",
21
+ "LICENSE",
22
+ "README.rdoc",
23
+ "Rakefile",
24
+ "VERSION.yml",
25
+ "bin/sdoc",
26
+ "bin/sdoc-merge",
27
+ "lib/rdoc/discover.rb",
28
+ "lib/sdoc.rb",
29
+ "lib/sdoc/c_parser_fix.rb",
30
+ "lib/sdoc/generator/shtml.rb",
31
+ "lib/sdoc/generator/template/direct/_context.rhtml",
32
+ "lib/sdoc/generator/template/direct/class.rhtml",
33
+ "lib/sdoc/generator/template/direct/file.rhtml",
34
+ "lib/sdoc/generator/template/direct/index.rhtml",
35
+ "lib/sdoc/generator/template/direct/resources/apple-touch-icon.png",
36
+ "lib/sdoc/generator/template/direct/resources/css/main.css",
37
+ "lib/sdoc/generator/template/direct/resources/css/panel.css",
38
+ "lib/sdoc/generator/template/direct/resources/css/reset.css",
39
+ "lib/sdoc/generator/template/direct/resources/favicon.ico",
40
+ "lib/sdoc/generator/template/direct/resources/i/arrows.png",
41
+ "lib/sdoc/generator/template/direct/resources/i/results_bg.png",
42
+ "lib/sdoc/generator/template/direct/resources/i/tree_bg.png",
43
+ "lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js",
44
+ "lib/sdoc/generator/template/direct/resources/js/jquery-effect.js",
45
+ "lib/sdoc/generator/template/direct/resources/js/main.js",
46
+ "lib/sdoc/generator/template/direct/resources/js/searchdoc.js",
47
+ "lib/sdoc/generator/template/direct/resources/panel/index.html",
48
+ "lib/sdoc/generator/template/merge/index.rhtml",
49
+ "lib/sdoc/generator/template/shtml/_context.rhtml",
50
+ "lib/sdoc/generator/template/shtml/class.rhtml",
51
+ "lib/sdoc/generator/template/shtml/file.rhtml",
52
+ "lib/sdoc/generator/template/shtml/index.rhtml",
53
+ "lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png",
54
+ "lib/sdoc/generator/template/shtml/resources/css/main.css",
55
+ "lib/sdoc/generator/template/shtml/resources/css/panel.css",
56
+ "lib/sdoc/generator/template/shtml/resources/css/reset.css",
57
+ "lib/sdoc/generator/template/shtml/resources/favicon.ico",
58
+ "lib/sdoc/generator/template/shtml/resources/i/arrows.png",
59
+ "lib/sdoc/generator/template/shtml/resources/i/results_bg.png",
60
+ "lib/sdoc/generator/template/shtml/resources/i/tree_bg.png",
61
+ "lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js",
62
+ "lib/sdoc/generator/template/shtml/resources/js/main.js",
63
+ "lib/sdoc/generator/template/shtml/resources/js/searchdoc.js",
64
+ "lib/sdoc/generator/template/shtml/resources/panel/index.html",
65
+ "lib/sdoc/github.rb",
66
+ "lib/sdoc/helpers.rb",
67
+ "lib/sdoc/json_backend.rb",
68
+ "lib/sdoc/merge.rb",
69
+ "lib/sdoc/options.rb",
70
+ "lib/sdoc/templatable.rb",
71
+ "sdoc.gemspec"
72
+ ]
73
+ s.homepage = %q{http://github.com/voloko/sdoc}
74
+ s.require_paths = ["lib"]
75
+ s.rubygems_version = %q{1.5.2}
76
+ s.summary = %q{rdoc html with javascript search index.}
77
+
78
+ if s.respond_to? :specification_version then
79
+ s.specification_version = 3
80
+
81
+ if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
82
+ s.add_runtime_dependency(%q<rdoc>, ["= 2.4.3"])
83
+ s.add_runtime_dependency(%q<json>, [">= 1.1.3"])
84
+ else
85
+ s.add_dependency(%q<rdoc>, ["= 2.4.3"])
86
+ s.add_dependency(%q<json>, [">= 1.1.3"])
87
+ end
88
+ else
89
+ s.add_dependency(%q<rdoc>, ["= 2.4.3"])
90
+ s.add_dependency(%q<json>, [">= 1.1.3"])
91
+ end
92
+ end
93
+
metadata ADDED
@@ -0,0 +1,151 @@
1
+ --- !ruby/object:Gem::Specification
2
+ name: morph-sdoc
3
+ version: !ruby/object:Gem::Version
4
+ hash: 61
5
+ prerelease:
6
+ segments:
7
+ - 0
8
+ - 2
9
+ - 21
10
+ version: 0.2.21
11
+ platform: ruby
12
+ authors:
13
+ - Volodya Kolesnikov
14
+ autorequire:
15
+ bindir: bin
16
+ cert_chain: []
17
+
18
+ date: 2011-05-06 00:00:00 +08:00
19
+ default_executable:
20
+ dependencies:
21
+ - !ruby/object:Gem::Dependency
22
+ name: rdoc
23
+ prerelease: false
24
+ requirement: &id001 !ruby/object:Gem::Requirement
25
+ none: false
26
+ requirements:
27
+ - - "="
28
+ - !ruby/object:Gem::Version
29
+ hash: 25
30
+ segments:
31
+ - 2
32
+ - 4
33
+ - 3
34
+ version: 2.4.3
35
+ type: :runtime
36
+ version_requirements: *id001
37
+ - !ruby/object:Gem::Dependency
38
+ name: json
39
+ prerelease: false
40
+ requirement: &id002 !ruby/object:Gem::Requirement
41
+ none: false
42
+ requirements:
43
+ - - ">="
44
+ - !ruby/object:Gem::Version
45
+ hash: 21
46
+ segments:
47
+ - 1
48
+ - 1
49
+ - 3
50
+ version: 1.1.3
51
+ type: :runtime
52
+ version_requirements: *id002
53
+ description:
54
+ email: voloko@gmail.com
55
+ executables:
56
+ - sdoc-merge
57
+ - sdoc
58
+ extensions: []
59
+
60
+ extra_rdoc_files:
61
+ - LICENSE
62
+ - README.rdoc
63
+ files:
64
+ - .rvmrc
65
+ - LICENSE
66
+ - README.rdoc
67
+ - Rakefile
68
+ - VERSION.yml
69
+ - bin/sdoc
70
+ - bin/sdoc-merge
71
+ - lib/rdoc/discover.rb
72
+ - lib/sdoc.rb
73
+ - lib/sdoc/c_parser_fix.rb
74
+ - lib/sdoc/generator/shtml.rb
75
+ - lib/sdoc/generator/template/direct/_context.rhtml
76
+ - lib/sdoc/generator/template/direct/class.rhtml
77
+ - lib/sdoc/generator/template/direct/file.rhtml
78
+ - lib/sdoc/generator/template/direct/index.rhtml
79
+ - lib/sdoc/generator/template/direct/resources/apple-touch-icon.png
80
+ - lib/sdoc/generator/template/direct/resources/css/main.css
81
+ - lib/sdoc/generator/template/direct/resources/css/panel.css
82
+ - lib/sdoc/generator/template/direct/resources/css/reset.css
83
+ - lib/sdoc/generator/template/direct/resources/favicon.ico
84
+ - lib/sdoc/generator/template/direct/resources/i/arrows.png
85
+ - lib/sdoc/generator/template/direct/resources/i/results_bg.png
86
+ - lib/sdoc/generator/template/direct/resources/i/tree_bg.png
87
+ - lib/sdoc/generator/template/direct/resources/js/jquery-1.3.2.min.js
88
+ - lib/sdoc/generator/template/direct/resources/js/jquery-effect.js
89
+ - lib/sdoc/generator/template/direct/resources/js/main.js
90
+ - lib/sdoc/generator/template/direct/resources/js/searchdoc.js
91
+ - lib/sdoc/generator/template/direct/resources/panel/index.html
92
+ - lib/sdoc/generator/template/merge/index.rhtml
93
+ - lib/sdoc/generator/template/shtml/_context.rhtml
94
+ - lib/sdoc/generator/template/shtml/class.rhtml
95
+ - lib/sdoc/generator/template/shtml/file.rhtml
96
+ - lib/sdoc/generator/template/shtml/index.rhtml
97
+ - lib/sdoc/generator/template/shtml/resources/apple-touch-icon.png
98
+ - lib/sdoc/generator/template/shtml/resources/css/main.css
99
+ - lib/sdoc/generator/template/shtml/resources/css/panel.css
100
+ - lib/sdoc/generator/template/shtml/resources/css/reset.css
101
+ - lib/sdoc/generator/template/shtml/resources/favicon.ico
102
+ - lib/sdoc/generator/template/shtml/resources/i/arrows.png
103
+ - lib/sdoc/generator/template/shtml/resources/i/results_bg.png
104
+ - lib/sdoc/generator/template/shtml/resources/i/tree_bg.png
105
+ - lib/sdoc/generator/template/shtml/resources/js/jquery-1.3.2.min.js
106
+ - lib/sdoc/generator/template/shtml/resources/js/main.js
107
+ - lib/sdoc/generator/template/shtml/resources/js/searchdoc.js
108
+ - lib/sdoc/generator/template/shtml/resources/panel/index.html
109
+ - lib/sdoc/github.rb
110
+ - lib/sdoc/helpers.rb
111
+ - lib/sdoc/json_backend.rb
112
+ - lib/sdoc/merge.rb
113
+ - lib/sdoc/options.rb
114
+ - lib/sdoc/templatable.rb
115
+ - sdoc.gemspec
116
+ has_rdoc: true
117
+ homepage: http://github.com/voloko/sdoc
118
+ licenses: []
119
+
120
+ post_install_message:
121
+ rdoc_options: []
122
+
123
+ require_paths:
124
+ - lib
125
+ required_ruby_version: !ruby/object:Gem::Requirement
126
+ none: false
127
+ requirements:
128
+ - - ">="
129
+ - !ruby/object:Gem::Version
130
+ hash: 3
131
+ segments:
132
+ - 0
133
+ version: "0"
134
+ required_rubygems_version: !ruby/object:Gem::Requirement
135
+ none: false
136
+ requirements:
137
+ - - ">="
138
+ - !ruby/object:Gem::Version
139
+ hash: 3
140
+ segments:
141
+ - 0
142
+ version: "0"
143
+ requirements: []
144
+
145
+ rubyforge_project:
146
+ rubygems_version: 1.5.2
147
+ signing_key:
148
+ specification_version: 3
149
+ summary: rdoc html with javascript search index.
150
+ test_files: []
151
+