dokkit 0.3.0 → 0.4.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.
Files changed (180) hide show
  1. data/History.txt +5 -0
  2. data/Manifest.txt +90 -105
  3. data/README.txt +27 -7
  4. data/Rakefile +2 -3
  5. data/bin/dokkit +3 -2
  6. data/lib/dokkit/application.rb +159 -0
  7. data/lib/dokkit/cache/cache.rb +53 -0
  8. data/lib/dokkit/{models/simpledocument/model/Rakefile → cache.rb} +3 -15
  9. data/lib/dokkit/environment/basic.rb +156 -0
  10. data/lib/dokkit/environment/helpers/extmap.rb +29 -0
  11. data/lib/dokkit/environment/helpers/fileselection.rb +53 -0
  12. data/lib/dokkit/environment/helpers.rb +20 -0
  13. data/{spec/data/test_build/Rakefile → lib/dokkit/environment.rb} +4 -15
  14. data/lib/dokkit/factory/factory.rb +56 -0
  15. data/lib/dokkit/factory.rb +9 -0
  16. data/lib/dokkit/filters/deplate.rb +25 -20
  17. data/lib/dokkit/filters/maruku.rb +6 -5
  18. data/lib/dokkit/filters/nil.rb +7 -6
  19. data/lib/dokkit/filters.rb +5 -27
  20. data/lib/dokkit/hash.rb +82 -0
  21. data/lib/dokkit/{logger.rb → logging/logger.rb} +30 -24
  22. data/lib/dokkit/logging/observers/console.rb +52 -0
  23. data/lib/dokkit/{extension/extension.rb → logging/observers.rb} +7 -5
  24. data/lib/dokkit/logging.rb +11 -0
  25. data/lib/dokkit/models/simple/Rakefile +6 -0
  26. data/lib/dokkit/models/simple/doc/data/html/css/style.css +3 -0
  27. data/lib/dokkit/models/simple/doc/data/latex/deplate.sty +46 -0
  28. data/lib/dokkit/models/simple/doc/layouts/simple.html +9 -0
  29. data/lib/dokkit/models/simple/doc/layouts/simple.latex +11 -0
  30. data/lib/dokkit/models/simple/doc/pages/simple.deplate +80 -0
  31. data/lib/dokkit/models/simple/setup/setup.rb +10 -0
  32. data/lib/dokkit/resource/data.rb +36 -0
  33. data/lib/dokkit/resource/document.rb +385 -0
  34. data/lib/dokkit/resource/extensions/builtin.rb +19 -0
  35. data/lib/dokkit/resource/extensions/html.rb +22 -0
  36. data/lib/dokkit/resource/extensions/url.rb +25 -0
  37. data/lib/dokkit/{filters/base.rb → resource/extensions.rb} +7 -8
  38. data/lib/dokkit/resource/filenamehelper.rb +28 -0
  39. data/lib/dokkit/resource.rb +11 -0
  40. data/lib/dokkit/tasklib/clean.rb +73 -0
  41. data/lib/dokkit/tasklib/render.rb +137 -0
  42. data/lib/dokkit/tasklib.rb +11 -0
  43. data/lib/dokkit.rb +26 -29
  44. data/spec/dokkit/application_spec.rb +141 -0
  45. data/spec/dokkit/cache/cache_spec.rb +87 -0
  46. data/spec/dokkit/dokkit_spec.rb +20 -0
  47. data/spec/dokkit/environment/basic_spec.rb +135 -0
  48. data/spec/dokkit/environment/helpers/extmap_spec.rb +52 -0
  49. data/spec/dokkit/environment/helpers/fileselection_spec.rb +80 -0
  50. data/spec/dokkit/environment/test_data/doc/pages/document_1.yaml +3 -0
  51. data/spec/dokkit/factory/factory_spec.rb +69 -0
  52. data/spec/{filter_deplate_spec.rb → dokkit/filters/deplate_spec.rb} +7 -8
  53. data/spec/{filter_maruku_spec.rb → dokkit/filters/maruku_spec.rb} +3 -4
  54. data/spec/{filter_nil_spec.rb → dokkit/filters/nil_spec.rb} +3 -4
  55. data/spec/{recursivemerge_spec.rb → dokkit/hash_spec.rb} +25 -27
  56. data/spec/{logger_spec.rb → dokkit/logging/logger_spec.rb} +35 -47
  57. data/spec/{consolelog_spec.rb → dokkit/logging/observers/console_spec.rb} +14 -15
  58. data/spec/dokkit/resource/data_spec.rb +32 -0
  59. data/spec/dokkit/resource/document_spec.rb +485 -0
  60. data/spec/dokkit/resource/extensions/html_spec.rb +35 -0
  61. data/spec/dokkit/resource/extensions/url_spec.rb +29 -0
  62. data/spec/{filehelper_spec.rb → dokkit/resource/filenamehelper_spec.rb} +12 -13
  63. data/spec/dokkit/resource/test_data/doc/configs/config_1.yaml +3 -0
  64. data/spec/dokkit/resource/test_data/doc/configs/config_2.yaml +3 -0
  65. data/spec/dokkit/resource/test_data/doc/configs/required.yaml +3 -0
  66. data/spec/dokkit/resource/test_data/doc/configs/subdir/document.yaml +3 -0
  67. data/spec/dokkit/resource/test_data/doc/layouts/container.html +6 -0
  68. data/spec/dokkit/resource/test_data/doc/layouts/layout.html +6 -0
  69. data/spec/{data/test_build/doc/layouts → dokkit/resource/test_data/doc/layouts/nested}/nested.html +2 -1
  70. data/spec/dokkit/resource/test_data/doc/layouts/subdir/document.html +6 -0
  71. data/spec/dokkit/resource/test_data/doc/pages/COMMON.yaml +4 -0
  72. data/spec/dokkit/resource/test_data/doc/pages/document_with_many_config.ext +7 -0
  73. data/spec/dokkit/resource/test_data/doc/pages/document_with_many_errors.ext +12 -0
  74. data/spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext +19 -0
  75. data/spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext +13 -0
  76. data/spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext +5 -0
  77. data/spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext +6 -0
  78. data/spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext +8 -0
  79. data/spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml +3 -0
  80. data/spec/dokkit/resource/test_data/doc/pages/subdir/document.ext +8 -0
  81. data/spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml +5 -0
  82. data/spec/dokkit/tasklib/clean_spec.rb +75 -0
  83. data/spec/dokkit/tasklib/render_spec.rb +125 -0
  84. data/spec/dokkit/tasklib/test_data/doc/pages/document_2 +0 -0
  85. data/spec/dokkit/test_data/dokkit/models/model1/doc/pages/model1 +0 -0
  86. data/spec/dokkit/test_data/dokkit/models/model2/doc/pages/model2 +0 -0
  87. data/spec/spec.opts +4 -0
  88. data/spec/spec_helper.rb +120 -47
  89. metadata +94 -117
  90. data/lib/dokkit/app.rb +0 -131
  91. data/lib/dokkit/builtintask.rb +0 -85
  92. data/lib/dokkit/cachemanager.rb +0 -61
  93. data/lib/dokkit/cleantask.rb +0 -51
  94. data/lib/dokkit/consolelog.rb +0 -42
  95. data/lib/dokkit/defaults.rb +0 -19
  96. data/lib/dokkit/deplate/fmt/html-notemplate.rb +0 -21
  97. data/lib/dokkit/deplate/fmt/latex-notemplate.rb +0 -24
  98. data/lib/dokkit/document.rb +0 -221
  99. data/lib/dokkit/dokkitlib.rb +0 -68
  100. data/lib/dokkit/extension/filehelper.rb +0 -25
  101. data/lib/dokkit/fileselection.rb +0 -44
  102. data/lib/dokkit/filters/all.rb +0 -18
  103. data/lib/dokkit/model.rb +0 -34
  104. data/lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.html +0 -9
  105. data/lib/dokkit/models/simpledocument/model/doc/pages/simpledocument.deplate +0 -102
  106. data/lib/dokkit/models/simpledocument/model/tasks/all.rb +0 -3
  107. data/lib/dokkit/models/simpledocument/model/tasks/clean.rake +0 -3
  108. data/lib/dokkit/models/simpledocument/model/tasks/render.rake +0 -8
  109. data/lib/dokkit/models/simpledocument/model/tasks/setup.rb +0 -9
  110. data/lib/dokkit/modeltask.rb +0 -83
  111. data/lib/dokkit/pathhelper.rb +0 -46
  112. data/lib/dokkit/recursivemerge.rb +0 -59
  113. data/lib/dokkit/rendertask.rb +0 -101
  114. data/lib/dokkit/resourcemanager.rb +0 -177
  115. data/lib/dokkit/taskconfig.rb +0 -39
  116. data/lib/dokkit/templatetask.rb +0 -37
  117. data/spec/app_spec.rb +0 -55
  118. data/spec/builtintask_spec.rb +0 -114
  119. data/spec/cachemanager_spec.rb +0 -107
  120. data/spec/cleantask_spec.rb +0 -72
  121. data/spec/data/test_build/doc/configs/document_1.yaml +0 -3
  122. data/spec/data/test_build/doc/configs/required.yaml +0 -3
  123. data/spec/data/test_build/doc/configs/subdir/document_4.yaml +0 -3
  124. data/spec/data/test_build/doc/layouts/document_1.html +0 -9
  125. data/spec/data/test_build/doc/layouts/document_with_partials.html +0 -9
  126. data/spec/data/test_build/doc/layouts/layout.html +0 -8
  127. data/spec/data/test_build/doc/layouts/layout.html.backup +0 -8
  128. data/spec/data/test_build/doc/layouts/partials/partial.html +0 -4
  129. data/spec/data/test_build/doc/pages/COMMON.yaml +0 -6
  130. data/spec/data/test_build/doc/pages/document_1 +0 -20
  131. data/spec/data/test_build/doc/pages/document_1.dep +0 -4
  132. data/spec/data/test_build/doc/pages/document_1.yaml +0 -11
  133. data/spec/data/test_build/doc/pages/document_2 +0 -9
  134. data/spec/data/test_build/doc/pages/document_2.yaml +0 -6
  135. data/spec/data/test_build/doc/pages/document_3 +0 -13
  136. data/spec/data/test_build/doc/pages/document_7 +0 -4
  137. data/spec/data/test_build/doc/pages/document_7.yaml +0 -5
  138. data/spec/data/test_build/doc/pages/document_extended +0 -1
  139. data/spec/data/test_build/doc/pages/document_nested +0 -6
  140. data/spec/data/test_build/doc/pages/document_nested.yaml +0 -5
  141. data/spec/data/test_build/doc/pages/document_nolayout.ext +0 -3
  142. data/spec/data/test_build/doc/pages/document_nolayout.yaml +0 -2
  143. data/spec/data/test_build/doc/pages/document_with_partials +0 -3
  144. data/spec/data/test_build/doc/pages/document_with_partials.yaml +0 -2
  145. data/spec/data/test_build/doc/pages/partials/COMMON.yaml +0 -5
  146. data/spec/data/test_build/doc/pages/partials/circular_partial +0 -2
  147. data/spec/data/test_build/doc/pages/partials/circular_partial.yaml +0 -3
  148. data/spec/data/test_build/doc/pages/partials/partial +0 -2
  149. data/spec/data/test_build/doc/pages/subdir/COMMON.yaml +0 -2
  150. data/spec/data/test_build/doc/pages/subdir/document_4 +0 -11
  151. data/spec/data/test_build/doc/pages/subdir/subdir/COMMON.yaml +0 -2
  152. data/spec/data/test_build/doc/pages/subdir/subdir/document_6 +0 -3
  153. data/spec/data/test_build/tasks/all.rb +0 -3
  154. data/spec/data/test_build/tasks/clean.rake +0 -3
  155. data/spec/data/test_build/tasks/render.rake +0 -8
  156. data/spec/data/test_build/tasks/setup.rb +0 -9
  157. data/spec/data/test_build/tasks/template.rake +0 -3
  158. data/spec/document_spec.rb +0 -321
  159. data/spec/dokkitlib_spec.rb +0 -63
  160. data/spec/fileselection_spec.rb +0 -101
  161. data/spec/filter_base_spec.rb +0 -29
  162. data/spec/filters_spec.rb +0 -37
  163. data/spec/model_spec.rb +0 -45
  164. data/spec/pathhelper_spec.rb +0 -62
  165. data/spec/rendertask_spec.rb +0 -374
  166. data/spec/taskconfig_spec.rb +0 -45
  167. data/spec/templatetask_spec.rb +0 -72
  168. /data/lib/dokkit/models/{simpledocument/model/doc/configs/simpledocument.yaml → simple/doc/configs/simple.yaml} +0 -0
  169. /data/lib/dokkit/models/{simpledocument/model/doc/layouts/simpledocument.text → simple/doc/layouts/simple.text} +0 -0
  170. /data/{lib/dokkit/models/simpledocument/model/doc/data/css/style.css → spec/dokkit/environment/helpers/test_data/doc/pages/document_1.ext_1} +0 -0
  171. /data/spec/{data/test_build/doc/data/resource → dokkit/environment/helpers/test_data/doc/pages/document_2} +0 -0
  172. /data/spec/{data/test_build/doc/data/resource.exclude → dokkit/environment/helpers/test_data/doc/pages/document_3.ext_3} +0 -0
  173. /data/spec/{data/test_build/doc/data/subdir/resource.insubdir → dokkit/environment/test_data/doc/data/data} +0 -0
  174. /data/spec/{data/test_build/doc/layouts/layout → dokkit/environment/test_data/doc/pages/document_1} +0 -0
  175. /data/spec/{data/test_build/doc/pages/document_2.dep → dokkit/environment/test_data/doc/pages/document_2} +0 -0
  176. /data/spec/{data/test_build/doc/pages/document_5.exclude → dokkit/environment/test_data/doc/pages/subdir/document_1} +0 -0
  177. /data/{lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.latex → spec/dokkit/resource/test_data/doc/layouts/layout.latex} +0 -0
  178. /data/spec/{data/test_build/doc/layouts/document_1.latex → dokkit/resource/test_data/doc/layouts/subdir/document.latex} +0 -0
  179. /data/spec/{data/test_build/templates/layouts/layout → dokkit/tasklib/test_data/doc/data/data_1} +0 -0
  180. /data/spec/{data/test_build/templates/pages/template → dokkit/tasklib/test_data/doc/pages/document_1} +0 -0
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: dokkit
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.3.0
4
+ version: 0.4.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Andrea Fazzi
@@ -9,7 +9,7 @@ autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
11
 
12
- date: 2008-03-31 00:00:00 +02:00
12
+ date: 2008-07-18 00:00:00 +00:00
13
13
  default_executable:
14
14
  dependencies:
15
15
  - !ruby/object:Gem::Dependency
@@ -39,7 +39,7 @@ dependencies:
39
39
  - !ruby/object:Gem::Version
40
40
  version: "0"
41
41
  version:
42
- description: "== DESCRIPTION: dokkit is a document generator. It was inspired by rote but now it is completely independent from it. dokkit uses filters like deplate to generate output in a large variety of formats (tex, html, docbook, plain text, ...)."
42
+ description: "== DESCRIPTION: dokkit is a document generator. It was inspired by rote but now it is completely independent from it. dokkit uses filters like deplate and maruku to generate output in a large variety of formats (tex, html, docbook, plain text, ...)."
43
43
  email: andrea.fazzi@alca.le.it
44
44
  executables:
45
45
  - dokkit
@@ -49,15 +49,6 @@ extra_rdoc_files:
49
49
  - History.txt
50
50
  - README.txt
51
51
  - bin/dokkit
52
- - lib/dokkit/models/simpledocument/model/Rakefile
53
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.html
54
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.latex
55
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.text
56
- - lib/dokkit/models/simpledocument/model/doc/pages/simpledocument.deplate
57
- - lib/dokkit/models/simpledocument/model/doc/configs/simpledocument.yaml
58
- - lib/dokkit/models/simpledocument/model/doc/data/css/style.css
59
- - lib/dokkit/models/simpledocument/model/tasks/clean.rake
60
- - lib/dokkit/models/simpledocument/model/tasks/render.rake
61
52
  files:
62
53
  - History.txt
63
54
  - Manifest.txt
@@ -65,115 +56,101 @@ files:
65
56
  - Rakefile
66
57
  - bin/dokkit
67
58
  - lib/dokkit.rb
68
- - lib/dokkit/app.rb
69
- - lib/dokkit/builtintask.rb
70
- - lib/dokkit/cachemanager.rb
71
- - lib/dokkit/cleantask.rb
72
- - lib/dokkit/consolelog.rb
73
- - lib/dokkit/defaults.rb
74
- - lib/dokkit/deplate/fmt/html-notemplate.rb
75
- - lib/dokkit/deplate/fmt/latex-notemplate.rb
76
- - lib/dokkit/document.rb
77
- - lib/dokkit/dokkitlib.rb
78
- - lib/dokkit/extension/extension.rb
79
- - lib/dokkit/extension/filehelper.rb
80
- - lib/dokkit/fileselection.rb
59
+ - lib/dokkit/application.rb
60
+ - lib/dokkit/cache.rb
61
+ - lib/dokkit/cache/cache.rb
62
+ - lib/dokkit/environment.rb
63
+ - lib/dokkit/environment/basic.rb
64
+ - lib/dokkit/environment/helpers.rb
65
+ - lib/dokkit/environment/helpers/extmap.rb
66
+ - lib/dokkit/environment/helpers/fileselection.rb
67
+ - lib/dokkit/factory.rb
68
+ - lib/dokkit/factory/factory.rb
81
69
  - lib/dokkit/filters.rb
82
- - lib/dokkit/filters/all.rb
83
- - lib/dokkit/filters/base.rb
84
70
  - lib/dokkit/filters/deplate.rb
85
71
  - lib/dokkit/filters/maruku.rb
86
72
  - lib/dokkit/filters/nil.rb
87
- - lib/dokkit/logger.rb
88
- - lib/dokkit/model.rb
89
- - lib/dokkit/models/simpledocument/model/Rakefile
90
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.html
91
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.latex
92
- - lib/dokkit/models/simpledocument/model/doc/layouts/simpledocument.text
93
- - lib/dokkit/models/simpledocument/model/doc/pages/simpledocument.deplate
94
- - lib/dokkit/models/simpledocument/model/doc/configs/simpledocument.yaml
95
- - lib/dokkit/models/simpledocument/model/doc/data/css/style.css
96
- - lib/dokkit/models/simpledocument/model/tasks/all.rb
97
- - lib/dokkit/models/simpledocument/model/tasks/clean.rake
98
- - lib/dokkit/models/simpledocument/model/tasks/render.rake
99
- - lib/dokkit/models/simpledocument/model/tasks/setup.rb
100
- - lib/dokkit/modeltask.rb
101
- - lib/dokkit/pathhelper.rb
102
- - lib/dokkit/recursivemerge.rb
103
- - lib/dokkit/rendertask.rb
104
- - lib/dokkit/resourcemanager.rb
105
- - lib/dokkit/taskconfig.rb
106
- - lib/dokkit/templatetask.rb
107
- - spec/app_spec.rb
108
- - spec/builtintask_spec.rb
109
- - spec/cachemanager_spec.rb
110
- - spec/cleantask_spec.rb
111
- - spec/consolelog_spec.rb
112
- - spec/data/test_build/Rakefile
113
- - spec/data/test_build/doc/configs/document_1.yaml
114
- - spec/data/test_build/doc/configs/required.yaml
115
- - spec/data/test_build/doc/configs/subdir/document_4.yaml
116
- - spec/data/test_build/doc/data/resource
117
- - spec/data/test_build/doc/data/resource.exclude
118
- - spec/data/test_build/doc/data/subdir/resource.insubdir
119
- - spec/data/test_build/doc/layouts/document_1.html
120
- - spec/data/test_build/doc/layouts/document_1.latex
121
- - spec/data/test_build/doc/layouts/document_with_partials.html
122
- - spec/data/test_build/doc/layouts/layout
123
- - spec/data/test_build/doc/layouts/layout.html
124
- - spec/data/test_build/doc/layouts/layout.html.backup
125
- - spec/data/test_build/doc/layouts/nested.html
126
- - spec/data/test_build/doc/layouts/partials/partial.html
127
- - spec/data/test_build/doc/pages/COMMON.yaml
128
- - spec/data/test_build/doc/pages/document_1
129
- - spec/data/test_build/doc/pages/document_1.dep
130
- - spec/data/test_build/doc/pages/document_1.yaml
131
- - spec/data/test_build/doc/pages/document_2
132
- - spec/data/test_build/doc/pages/document_2.dep
133
- - spec/data/test_build/doc/pages/document_2.yaml
134
- - spec/data/test_build/doc/pages/document_3
135
- - spec/data/test_build/doc/pages/document_5.exclude
136
- - spec/data/test_build/doc/pages/document_7
137
- - spec/data/test_build/doc/pages/document_7.yaml
138
- - spec/data/test_build/doc/pages/document_extended
139
- - spec/data/test_build/doc/pages/document_nested
140
- - spec/data/test_build/doc/pages/document_nested.yaml
141
- - spec/data/test_build/doc/pages/document_nolayout.ext
142
- - spec/data/test_build/doc/pages/document_nolayout.yaml
143
- - spec/data/test_build/doc/pages/document_with_partials
144
- - spec/data/test_build/doc/pages/document_with_partials.yaml
145
- - spec/data/test_build/doc/pages/partials/COMMON.yaml
146
- - spec/data/test_build/doc/pages/partials/circular_partial
147
- - spec/data/test_build/doc/pages/partials/circular_partial.yaml
148
- - spec/data/test_build/doc/pages/partials/partial
149
- - spec/data/test_build/doc/pages/subdir/COMMON.yaml
150
- - spec/data/test_build/doc/pages/subdir/document_4
151
- - spec/data/test_build/doc/pages/subdir/subdir/COMMON.yaml
152
- - spec/data/test_build/doc/pages/subdir/subdir/document_6
153
- - spec/data/test_build/tasks/all.rb
154
- - spec/data/test_build/tasks/clean.rake
155
- - spec/data/test_build/tasks/render.rake
156
- - spec/data/test_build/tasks/setup.rb
157
- - spec/data/test_build/tasks/template.rake
158
- - spec/data/test_build/templates/layouts/layout
159
- - spec/data/test_build/templates/pages/template
160
- - spec/document_spec.rb
161
- - spec/dokkitlib_spec.rb
162
- - spec/filehelper_spec.rb
163
- - spec/fileselection_spec.rb
164
- - spec/filter_base_spec.rb
165
- - spec/filter_deplate_spec.rb
166
- - spec/filter_maruku_spec.rb
167
- - spec/filter_nil_spec.rb
168
- - spec/filters_spec.rb
169
- - spec/logger_spec.rb
170
- - spec/model_spec.rb
171
- - spec/pathhelper_spec.rb
172
- - spec/recursivemerge_spec.rb
173
- - spec/rendertask_spec.rb
73
+ - lib/dokkit/hash.rb
74
+ - lib/dokkit/logging.rb
75
+ - lib/dokkit/logging/logger.rb
76
+ - lib/dokkit/logging/observers.rb
77
+ - lib/dokkit/logging/observers/console.rb
78
+ - lib/dokkit/models/simple/Rakefile
79
+ - lib/dokkit/models/simple/doc/configs/simple.yaml
80
+ - lib/dokkit/models/simple/doc/data/html/css/style.css
81
+ - lib/dokkit/models/simple/doc/data/latex/deplate.sty
82
+ - lib/dokkit/models/simple/doc/layouts/simple.html
83
+ - lib/dokkit/models/simple/doc/layouts/simple.latex
84
+ - lib/dokkit/models/simple/doc/layouts/simple.text
85
+ - lib/dokkit/models/simple/doc/pages/simple.deplate
86
+ - lib/dokkit/models/simple/setup/setup.rb
87
+ - lib/dokkit/resource.rb
88
+ - lib/dokkit/resource/data.rb
89
+ - lib/dokkit/resource/document.rb
90
+ - lib/dokkit/resource/extensions.rb
91
+ - lib/dokkit/resource/extensions/builtin.rb
92
+ - lib/dokkit/resource/extensions/html.rb
93
+ - lib/dokkit/resource/extensions/url.rb
94
+ - lib/dokkit/resource/filenamehelper.rb
95
+ - lib/dokkit/tasklib.rb
96
+ - lib/dokkit/tasklib/clean.rb
97
+ - lib/dokkit/tasklib/render.rb
98
+ - spec/dokkit/application_spec.rb
99
+ - spec/dokkit/cache/cache_spec.rb
100
+ - spec/dokkit/dokkit_spec.rb
101
+ - spec/dokkit/environment/basic_spec.rb
102
+ - spec/dokkit/environment/helpers/extmap_spec.rb
103
+ - spec/dokkit/environment/helpers/fileselection_spec.rb
104
+ - spec/dokkit/environment/helpers/test_data/doc/pages/document_1.ext_1
105
+ - spec/dokkit/environment/helpers/test_data/doc/pages/document_2
106
+ - spec/dokkit/environment/helpers/test_data/doc/pages/document_3.ext_3
107
+ - spec/dokkit/environment/test_data/doc/data/data
108
+ - spec/dokkit/environment/test_data/doc/pages/document_1
109
+ - spec/dokkit/environment/test_data/doc/pages/document_1.yaml
110
+ - spec/dokkit/environment/test_data/doc/pages/document_2
111
+ - spec/dokkit/environment/test_data/doc/pages/subdir/document_1
112
+ - spec/dokkit/factory/factory_spec.rb
113
+ - spec/dokkit/filters/deplate_spec.rb
114
+ - spec/dokkit/filters/maruku_spec.rb
115
+ - spec/dokkit/filters/nil_spec.rb
116
+ - spec/dokkit/hash_spec.rb
117
+ - spec/dokkit/logging/logger_spec.rb
118
+ - spec/dokkit/logging/observers/console_spec.rb
119
+ - spec/dokkit/resource/data_spec.rb
120
+ - spec/dokkit/resource/document_spec.rb
121
+ - spec/dokkit/resource/extensions/html_spec.rb
122
+ - spec/dokkit/resource/extensions/url_spec.rb
123
+ - spec/dokkit/resource/filenamehelper_spec.rb
124
+ - spec/dokkit/resource/test_data/doc/configs/config_1.yaml
125
+ - spec/dokkit/resource/test_data/doc/configs/config_2.yaml
126
+ - spec/dokkit/resource/test_data/doc/configs/required.yaml
127
+ - spec/dokkit/resource/test_data/doc/configs/subdir/document.yaml
128
+ - spec/dokkit/resource/test_data/doc/layouts/container.html
129
+ - spec/dokkit/resource/test_data/doc/layouts/layout.html
130
+ - spec/dokkit/resource/test_data/doc/layouts/layout.latex
131
+ - spec/dokkit/resource/test_data/doc/layouts/nested/nested.html
132
+ - spec/dokkit/resource/test_data/doc/layouts/subdir/document.html
133
+ - spec/dokkit/resource/test_data/doc/layouts/subdir/document.latex
134
+ - spec/dokkit/resource/test_data/doc/pages/COMMON.yaml
135
+ - spec/dokkit/resource/test_data/doc/pages/document_with_many_config.ext
136
+ - spec/dokkit/resource/test_data/doc/pages/document_with_many_errors.ext
137
+ - spec/dokkit/resource/test_data/doc/pages/document_with_many_targets.ext
138
+ - spec/dokkit/resource/test_data/doc/pages/document_with_nested_layout.ext
139
+ - spec/dokkit/resource/test_data/doc/pages/document_with_nil_target.ext
140
+ - spec/dokkit/resource/test_data/doc/pages/document_with_not_defined_target.ext
141
+ - spec/dokkit/resource/test_data/doc/pages/document_with_one_target.ext
142
+ - spec/dokkit/resource/test_data/doc/pages/subdir/COMMON.yaml
143
+ - spec/dokkit/resource/test_data/doc/pages/subdir/document.ext
144
+ - spec/dokkit/resource/test_data/doc/pages/subdir/document.yaml
145
+ - spec/dokkit/tasklib/clean_spec.rb
146
+ - spec/dokkit/tasklib/render_spec.rb
147
+ - spec/dokkit/tasklib/test_data/doc/data/data_1
148
+ - spec/dokkit/tasklib/test_data/doc/pages/document_1
149
+ - spec/dokkit/tasklib/test_data/doc/pages/document_2
150
+ - spec/dokkit/test_data/dokkit/models/model1/doc/pages/model1
151
+ - spec/dokkit/test_data/dokkit/models/model2/doc/pages/model2
152
+ - spec/spec.opts
174
153
  - spec/spec_helper.rb
175
- - spec/taskconfig_spec.rb
176
- - spec/templatetask_spec.rb
177
154
  - tasks/annotations.rake
178
155
  - tasks/doc.rake
179
156
  - tasks/gem.rake
@@ -206,7 +183,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
206
183
  requirements: []
207
184
 
208
185
  rubyforge_project: dokkit
209
- rubygems_version: 1.1.0
186
+ rubygems_version: 1.1.1
210
187
  signing_key:
211
188
  specification_version: 2
212
189
  summary: dokkit is an open source document generator
data/lib/dokkit/app.rb DELETED
@@ -1,131 +0,0 @@
1
- #
2
- # File 'app.rb' created on 09 ott 2007 at 16:00:28.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- require 'optparse'
10
- require 'rake'
11
- require 'dokkit/model'
12
- require 'dokkit/logger'
13
- require 'dokkit/consolelog'
14
- require 'dokkit/builtintask'
15
-
16
- module Dokkit
17
- # Master Dokkit version. Manage this from the Rake release support.
18
- DOKKITVERSION = '0.3.0'
19
- class << self
20
- def application
21
- @application ||= Application.new
22
- end
23
- def release
24
- @application = Rake.application = nil
25
- end
26
- end
27
- class Application
28
- DEFAULT_MODEL = 'simpledocument'
29
- USAGE_PREAMBLE = <<-EOU
30
- Usage: dokkit [options] [task1] .. [taskN]
31
-
32
- Where [taskN] is a valid task or target name for the current model.
33
- dokkit generates defines a number of top-level tasks for various
34
- things. Use the '--tasks' option to get a list of valid tasks.
35
-
36
- In addition to the standard tasks and those provided by any
37
- local configuration, the following builtin tasks are recognised:
38
-
39
- create[model] modeldir Create a blank project based on model template.
40
- list List the models available.
41
-
42
- In non-standard environments, it may be necessary to set the DOKKIT_LIB
43
- variable to point to the location of Dokkit libraries.
44
-
45
- EOU
46
- OPTIONS = [
47
- [ "--usage", "-u", GetoptLong::NO_ARGUMENT,
48
- "Display usage information." ],
49
- [ "--help", "-h", GetoptLong::NO_ARGUMENT,
50
- "Synonim for usage."],
51
- [ "--version", "-V", GetoptLong::NO_ARGUMENT,
52
- "Display the version number and quit." ],
53
- [ "--trace", "-t", GetoptLong::NO_ARGUMENT,
54
- "Enable trace-level output (debugging)"],
55
- [ "--tasks", "-T", GetoptLong::NO_ARGUMENT,
56
- "Display the list of the tasks available."],
57
- ]
58
- attr_reader :builtintask, :logger
59
- def initialize
60
- @rake = Rake.application
61
- @logger = Log::ConsoleLog.consolelog
62
- @builtintask = Dokkit::BuiltinTask.new(self)
63
- end
64
- def do_option(option, value)
65
- case option
66
- when '--usage'
67
- help
68
- exit
69
- when '--help'
70
- help
71
- exit
72
- when '--version'
73
- print "dokkit, version #{DOKKITVERSION}\n"
74
- exit
75
- when '--tasks'
76
- @rake.do_option('--tasks', value)
77
- end
78
- end
79
- def run
80
- process_args
81
- @rake.init('dokkit')
82
- @rake.load_rakefile if search_for_rakefile
83
- @rake.top_level
84
- end
85
-
86
- private
87
-
88
- def command_line_options
89
- OPTIONS.collect { |lst| lst[0..-2] }
90
- end
91
- def process_args
92
- opts = GetoptLong.new(*command_line_options)
93
- opts.each { |opt, value| do_option(opt, value) }
94
- end
95
- def version
96
- DOKKITVERSION
97
- end
98
- def help
99
- puts USAGE_PREAMBLE
100
- puts "Recognized options are:"
101
- puts
102
- OPTIONS.sort.each do |long, short, mode, desc|
103
- if mode == GetoptLong::REQUIRED_ARGUMENT
104
- if desc =~ /\b([A-Z]{2,})\b/
105
- long = long + "=#{$1}"
106
- end
107
- end
108
- printf " %-20s (%s)\n", long, short
109
- printf " %s\n", desc
110
- end
111
- end
112
- # check if a Rakefile exists in the current directory or in any parent directory.
113
- def have_rakefile
114
- @rake.have_rakefile
115
- end
116
- # search for a Rakefile in the current directory and in all parent directory.
117
- def search_for_rakefile
118
- initial_dir = here = Dir.pwd
119
- while ! have_rakefile
120
- Dir.chdir("..")
121
- if Dir.pwd == here
122
- Dir.chdir(initial_dir)
123
- return false
124
- end
125
- here = Dir.pwd
126
- end
127
- Dir.chdir(initial_dir)
128
- true
129
- end
130
- end
131
- end
@@ -1,85 +0,0 @@
1
- #
2
- # File 'modeltask.rb' created on 23 feb 2008 at 20:45:10.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- require 'yaml'
10
- require 'dokkit'
11
-
12
- module Dokkit
13
- class BuiltinTask
14
- attr_reader :models, :local_dir, :search_in
15
- def initialize(application)
16
- @application = application
17
- @local_dir = DEFAULT_LOCAL_DIR
18
- @search_in = [:dokkit_dir, :local_dir]
19
- @logger = @application.logger
20
- @models = fetch_models
21
- define_builtin_tasks
22
- end
23
- def dokkit_dir
24
- lib = nil
25
- unless lib = ENV['DOKKIT_LIB']
26
- $:.each do |it|
27
- if File.exists?(File.join(it, 'dokkit/app.rb'))
28
- lib = it
29
- break
30
- end
31
- end
32
- end
33
- lib
34
- end
35
- def builtin_model_dir
36
- File.join(dokkit_dir, 'dokkit/models')
37
- end
38
-
39
- private
40
-
41
- def define_builtin_tasks
42
- define_list_model_task
43
- define_create_task
44
- end
45
- def from_location(location)
46
- return builtin_model_dir if location == :dokkit_dir
47
- return File.join(((ENV['HOMEPATH'] if RUBY_PLATFORM =~ /win32/) || ENV['HOME']), @local_dir) if location == :local_dir
48
- end
49
- def fetch_models
50
- models = { }
51
- @search_in.each do |location|
52
- Dir.glob(File.join(from_location(location), '**/model/Rakefile')).each do |model|
53
- models[model.scan(/models\/(.*)\/model\/Rakefile/).flatten.to_s] = File.expand_path(File.join(File.dirname(model), '..'))
54
- end
55
- end
56
- models
57
- end
58
- def define_list_model_task
59
- desc 'List the installed models'
60
- task 'list' do
61
- @models.each do |modelname, path|
62
- @logger.info("Found model '#{modelname}' in #{path}")
63
- end
64
- end
65
- end
66
- def define_create_task
67
- desc 'Bootstrap a new documentation project'
68
- task 'create', :model do |t, args|
69
- model = args.model || DEFAULT_MODEL
70
- if ARGV.size == 2
71
- dest_dir = t.application.top_level_tasks.pop
72
- else
73
- @logger.error('A target directory must be provided.')
74
- end
75
- @logger.error("Directory '#{dest_dir}' exists.") if File.exists?(dest_dir)
76
- @logger.error("Model '#{model}' not found.") unless @models[model]
77
- @logger.info("Create '#{dest_dir}' based on '#{model}' model.")
78
- cp_r(File.join(@models[model], 'model'), dest_dir, :verbose => false)
79
- File.open(File.join(dest_dir, 'doc/configs/model.yaml'), 'w') do |file|
80
- file << { 'name' => model, 'from' => @models[model] }.to_yaml
81
- end
82
- end
83
- end
84
- end
85
- end
@@ -1,61 +0,0 @@
1
- #
2
- # File 'cachemanager.rb' created on 28 gen 2008 at 18:31:05.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2006, 2007 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- require 'singleton'
10
- require 'rake'
11
- require 'yaml'
12
-
13
- module Dokkit
14
- class CacheManager
15
- include Singleton
16
- def init(cache_filename = 'deps.yaml', cache_dir = '.cache')
17
- @cache_filename = cache_filename
18
- @cache_dir = cache_dir
19
- @complete_cache_filename = File.join(cache_dir, cache_filename)
20
- @deps = {}
21
- load if File.exists?(@complete_cache_filename)
22
- at_exit { save }
23
- end
24
- def add_dependency(task_name, dep)
25
- @deps[task_name] ||= []
26
- @deps[task_name] << dep unless (dep.nil? or @deps[task_name].include?(dep))
27
- end
28
- def load
29
- File.open(@complete_cache_filename) do |file|
30
- @deps = YAML::load(file)
31
- @deps.each do |task, dep|
32
- file task => dep
33
- end
34
- end
35
- end
36
- def save
37
- unless @deps.empty?
38
- mkdir_p(cache_dir, :verbose => false) unless File.exists?(cache_dir)
39
- File.open(@complete_cache_filename, 'w') do |file|
40
- file.write YAML::dump(@deps)
41
- end
42
- end
43
- end
44
- def clean_deps
45
- @deps.clear
46
- end
47
- def clean
48
- clean_deps
49
- rm_rf(cache_dir, :verbose => false) unless cache_dir == '.'
50
- end
51
- def deps
52
- @deps
53
- end
54
- def cache_dir
55
- @cache_dir
56
- end
57
- def cache_filename
58
- @cache_filename
59
- end
60
- end
61
- end
@@ -1,51 +0,0 @@
1
- #
2
- # File 'cleantask.rb' created on 19 feb 2008 at 19:33:03.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- require 'rake/clean'
10
- require 'dokkit/dokkitlib'
11
-
12
- module Dokkit
13
- class CleanTask < DokkitLib
14
- def initialize(model, namespace = 'clean')
15
- super(model, namespace)
16
- end
17
-
18
- private
19
-
20
- def pre_block_configuration
21
- @config.output_dir ||= Dokkit::DEFAULT_OUTPUT_DIR
22
- @config.cache_dir ||= Dokkit::DEFAULT_CACHE_DIR
23
- end
24
- def define_dokkit_clean_output
25
- desc 'Remove output directory'
26
- dokkit_task :output do
27
- if File.exists?(@config.output_dir)
28
- @logger.info('Removing output directory')
29
- rm_rf(@config.output_dir, :verbose => false)
30
- end
31
- end
32
- end
33
- def define_dokkit_clean_cache
34
- desc 'Remove cache directory'
35
- dokkit_task :cache do
36
- if File.exists?(@model.cache.cache_dir)
37
- @logger.info('Removing cache directory')
38
- @model.cache.clean
39
- end
40
- end
41
- end
42
- def define_dokkit_clean_backup
43
- desc 'Remove backup files (invoke rake:clean)'
44
- dokkit_task :backup => ['rake:clean']
45
- end
46
- def define_dokkit_clean_all
47
- desc 'Clobber all generated output and cache'
48
- dokkit_task :all => [:output, :cache, :backup]
49
- end
50
- end
51
- end
@@ -1,42 +0,0 @@
1
- #
2
- # File 'consolelog.rb' created on 23 feb 2008 at 16:39:59.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- require 'dokkit/logger'
10
-
11
- module Dokkit
12
- module Log
13
- class ConsoleLog
14
- class << self
15
- def consolelog
16
- @consolelog ||= ConsoleLog.new(Logger.logger)
17
- @consolelog.logger
18
- end
19
- end
20
- attr_reader :logger
21
- def initialize(logger)
22
- @logger = logger
23
- logger.attach(self)
24
- end
25
- def update
26
- message = @logger.last_message
27
- case message[:level]
28
- when Log::ERROR
29
- fail "[#{Time.now.asctime}][ERROR] #{message[:text]}"
30
- when Log::WARNING
31
- warn "[#{Time.now.asctime}][WARNING] #{message[:text]}"
32
- when Log::INFO
33
- puts "[#{Time.now.asctime}][INFO] #{message[:text]}"
34
- when Log::DEBUG
35
- puts "[#{Time.now.asctime}][DEBUG] #{message[:text]}"
36
- end
37
- message
38
- end
39
- end
40
- end
41
- end
42
-
@@ -1,19 +0,0 @@
1
- #
2
- # File 'defaults.rb' created on 20 feb 2008 at 19:31:57.
3
- #
4
- # See 'dokkit.rb' or +LICENSE+ for licence information.
5
- #
6
- # (C) 2008 Andrea Fazzi <andrea.fazzi@alca.le.it> (and contributors).
7
- #
8
-
9
- module Dokkit
10
- DEFAULT_DOCUMENT_DIR = 'doc/pages'
11
- DEFAULT_DATA_DIR = 'doc/data'
12
- DEFAULT_OUTPUT_DIR = 'output'
13
- DEFAULT_LAYOUT_DIR = 'doc/layouts'
14
- DEFAULT_CONFIG_DIR = 'doc/configs'
15
- DEFAULT_TEMPLATE_DIR = 'templates'
16
- DEFAULT_CACHE_DIR = '.cache'
17
- DEFAULT_LOCAL_DIR = '.dokkit/models'
18
- DEFAULT_MODEL = 'simpledocument'
19
- end