rhet-butler 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (69) hide show
  1. data/bin/rhet-butler +5 -0
  2. data/default-configuration/assets/apple-touch-icon-precomposed.png +0 -0
  3. data/default-configuration/assets/apple-touch-icon.png +0 -0
  4. data/default-configuration/assets/favicon.ico +0 -0
  5. data/default-configuration/assets/fonts/opensans/v6/MTP_ySUJH_bn48VBG8sNSonF5uFdDttMLvmWuJdhhgs.ttf +0 -0
  6. data/default-configuration/assets/fonts/opensans/v6/PRmiXeptR36kaC0GEAetxi8cqLH4MEiSE0ROcU-qHOA.ttf +0 -0
  7. data/default-configuration/assets/fonts/opensans/v6/cJZKeOuBrn4kERxqtaUH3aCWcynf_cDxXwCLxiixG1c.ttf +0 -0
  8. data/default-configuration/assets/fonts/opensans/v6/xjAJXh38I15wypJXxuGMBp0EAVxt0G0biEntp43Qt6E.ttf +0 -0
  9. data/default-configuration/assets/fonts/ptsans/v5/0XxGQsSc1g4rdRdjJKZrNC3USBnSvpkopQaUR-2r7iU.ttf +0 -0
  10. data/default-configuration/assets/fonts/ptsans/v5/FUDHvzEKSJww3kCxuiAo2A.ttf +0 -0
  11. data/default-configuration/assets/fonts/ptsans/v5/PIPMHY90P7jtyjpXuZ2cLKCWcynf_cDxXwCLxiixG1c.ttf +0 -0
  12. data/default-configuration/assets/fonts/ptsans/v5/lILlYDvubYemzYzN7GbLkInF5uFdDttMLvmWuJdhhgs.ttf +0 -0
  13. data/default-configuration/assets/fonts/ptserif/v5/03aPdn7fFF3H6ngCgAlQzC3USBnSvpkopQaUR-2r7iU.ttf +0 -0
  14. data/default-configuration/assets/fonts/ptserif/v5/EgBlzoNBIHxNPCMwXaAhYPesZW2xOQ-xsNqO47m55DA.ttf +0 -0
  15. data/default-configuration/assets/fonts/ptserif/v5/Foydq9xJp--nfYIx2TBz9fEr6Hm6RMS0v1dtXsGir4g.ttf +0 -0
  16. data/default-configuration/assets/fonts/ptserif/v5/QABk9IxT-LFTJ_dQzv7xpJ0EAVxt0G0biEntp43Qt6E.ttf +0 -0
  17. data/default-configuration/assets/javascript/highlight.js/LICENSE +24 -0
  18. data/default-configuration/assets/javascript/highlight.js/README.md +143 -0
  19. data/default-configuration/assets/javascript/highlight.js/README.ru.md +149 -0
  20. data/default-configuration/assets/javascript/highlight.js/classref.txt +568 -0
  21. data/default-configuration/assets/javascript/highlight.pack.js +1 -0
  22. data/default-configuration/assets/javascript/impress.js +800 -0
  23. data/default-configuration/assets/javascript/sockjs-0.2.1.js +2014 -0
  24. data/default-configuration/assets/javascript/sockjs-0.3.js +2314 -0
  25. data/default-configuration/assets/rhet-butler.jpg +0 -0
  26. data/default-configuration/assets/stylesheets/google-open-sans.css +72 -0
  27. data/default-configuration/assets/stylesheets/highlight/solarized_dark.css +88 -0
  28. data/default-configuration/assets/stylesheets/presentation.css +483 -0
  29. data/default-configuration/assets/stylesheets/presenter/presentation.css +477 -0
  30. data/default-configuration/assets/stylesheets/setup.css +0 -0
  31. data/default-configuration/common/config.yaml +4 -0
  32. data/default-configuration/common/templates/header-javascript.html +3 -0
  33. data/default-configuration/common/templates/presentation.html.erb +44 -0
  34. data/default-configuration/common/templates/presenter-qr.html.erb +77 -0
  35. data/default-configuration/common/templates/stylesheets.html.erb +3 -0
  36. data/default-configuration/presenter/config.yaml +7 -0
  37. data/default-configuration/presenter/templates/live-javascript.html.erb +26 -0
  38. data/default-configuration/presenter/templates/slide-notes.html.erb +3 -0
  39. data/default-configuration/presenter/templates/stylesheets.html.erb +3 -0
  40. data/default-configuration/viewer/config.yaml +7 -0
  41. data/default-configuration/viewer/templates/live-javascript.html.erb +16 -0
  42. data/default-configuration/viewer/templates/slide-notes.html.erb +0 -0
  43. data/lib/rhet-butler/arrangement.rb +78 -0
  44. data/lib/rhet-butler/command-line.rb +49 -0
  45. data/lib/rhet-butler/configuration.rb +76 -0
  46. data/lib/rhet-butler/file-manager.rb +126 -0
  47. data/lib/rhet-butler/html-generator.rb +29 -0
  48. data/lib/rhet-butler/layout-rule.rb +57 -0
  49. data/lib/rhet-butler/messaging.rb +58 -0
  50. data/lib/rhet-butler/slide-group.rb +56 -0
  51. data/lib/rhet-butler/slide-includer.rb +34 -0
  52. data/lib/rhet-butler/slide-loader.rb +361 -0
  53. data/lib/rhet-butler/slide.rb +164 -0
  54. data/lib/rhet-butler/static-generator.rb +44 -0
  55. data/lib/rhet-butler/web/assets-app.rb +40 -0
  56. data/lib/rhet-butler/web/main-app.rb +139 -0
  57. data/lib/rhet-butler/web/presentation-app.rb +50 -0
  58. data/lib/rhet-butler/web/qr-display-app.rb +37 -0
  59. data/lib/rhet-butler/yaml-schema.rb +9 -0
  60. data/lib/rhet-butler/yaml-type.rb +23 -0
  61. data/lib/rhet-butler.rb +2 -0
  62. data/spec/arrangements.rb +76 -0
  63. data/spec/html-generation.rb +48 -0
  64. data/spec/presentation-view.rb +72 -0
  65. data/spec/rhet-butler.rb +59 -0
  66. data/spec/slide-loader.rb +51 -0
  67. data/spec/slide-processing.rb +73 -0
  68. data/spec_support/gem_test_suite.rb +17 -0
  69. metadata +324 -0
@@ -0,0 +1,361 @@
1
+ require 'rhet-butler/slide-group'
2
+ require 'rhet-butler/slide'
3
+ require 'rhet-butler/slide-includer'
4
+ require 'rhet-butler/arrangement'
5
+
6
+ module RhetButler
7
+ class SlideLoader
8
+ def initialize(slide_files, configuration)
9
+ @file_set = slide_files
10
+ @default_slide_type = configuration.default_slide_type
11
+ @root_slide = configuration.root_slide
12
+ @root_group = SlideGroup.new
13
+ @blueprint = configuration.arrangement_blueprint
14
+ end
15
+
16
+ def load_slides
17
+ root_group = SlideGroup.new
18
+ includer = Includer.new
19
+ includer.path = @root_slide
20
+ root_group.slides = [includer]
21
+
22
+ loading = FileLoading.new(@file_set)
23
+ including = IncludeProcessor.new(loading)
24
+ including.root_group = root_group
25
+ including.traverse
26
+
27
+ processor = SlideProcessor.new
28
+ processor.root_group = root_group
29
+ processor.default_slide_type = @default_slide_type
30
+ processor.blueprint = @blueprint
31
+ processor.process
32
+ return processor.slides
33
+ end
34
+ end
35
+
36
+ require 'rhet-butler/yaml-schema'
37
+ class FileLoading
38
+ def initialize(file_set)
39
+ @file_set = file_set
40
+ @loaded_paths = {}
41
+ end
42
+ attr_reader :loaded_paths, :file_set
43
+
44
+ def initialize_copy(other)
45
+ @file_set = other.file_set
46
+ @loaded_paths = other.loaded_paths.dup
47
+ end
48
+
49
+ def load_file(rel_path)
50
+ file = @file_set.find(rel_path)
51
+
52
+ if @loaded_paths.has_key?(file.full_path)
53
+ raise "Circular inclusion of slides: >> #{file.full_path} << #{@loaded_paths.keys.inspect}"
54
+ else
55
+ @loaded_paths[file.full_path] = true
56
+ end
57
+
58
+ return YAML.load_stream(file.contents).flatten
59
+ end
60
+ end
61
+
62
+ class SlideProcessor
63
+ attr_accessor :root_group, :blueprint, :default_slide_type
64
+ attr_reader :slides
65
+
66
+ def process
67
+ rendering = SlideRendering.new
68
+ rendering.root_group = @root_group
69
+ rendering.default_type = @default_slide_type
70
+ rendering.traverse
71
+
72
+ finder = ArrangementFinder.new
73
+ finder.root_group = @root_group
74
+ finder.blueprint = @blueprint
75
+ finder.traverse
76
+
77
+ arranger = SlideArranger.new
78
+ arranger.root_arrangement = finder.root_arrangement
79
+ arranger.traverse
80
+
81
+ @slides = arranger.slides
82
+ end
83
+ end
84
+
85
+ class SlideTraverser
86
+ def initialize
87
+ @iter_stack = []
88
+ @target_stack = []
89
+ end
90
+
91
+ attr_reader :iter_stack, :target_stack
92
+
93
+ def on_group(group)
94
+ descend(group, group)
95
+ end
96
+
97
+ def ascend
98
+ target_stack.pop
99
+ iter_stack.pop
100
+ end
101
+
102
+ def descend(source, dest)
103
+ iter_stack.push source.each
104
+ target_stack.push dest
105
+ end
106
+
107
+ def traverse
108
+ setup
109
+ until iter_stack.empty?
110
+ begin
111
+ item = iter_stack.last.next
112
+ case item
113
+ when Slide
114
+ on_slide(item)
115
+ when Includer
116
+ on_include(item)
117
+ else
118
+ on_group(item)
119
+ end
120
+ rescue StopIteration
121
+ ascend
122
+ end
123
+ end
124
+ end
125
+ end
126
+
127
+ class ClassRegistry
128
+ def initialize
129
+ @classes = {}
130
+ end
131
+
132
+ def register(name, klass)
133
+ @classes[name.to_s] = klass
134
+ end
135
+
136
+ def fetch(name)
137
+ @classes.fetch(name.to_s)
138
+ end
139
+ alias [] fetch
140
+ end
141
+
142
+ class SlideRenderer
143
+ class << self
144
+ def registry
145
+ @registry ||= ClassRegistry.new
146
+ end
147
+
148
+ def register(name)
149
+ SlideRenderer.registry.register(name, self)
150
+ end
151
+
152
+ def for_type(type)
153
+ SlideRenderer.registry.fetch(type)
154
+ end
155
+
156
+ def process(type, options, slide)
157
+ for_type(type).new(options, slide).to_s
158
+ end
159
+ end
160
+
161
+ def initialize(options, slide)
162
+ @options = options
163
+ @slide_content = slide
164
+ end
165
+
166
+ def to_s
167
+ process(@slide_content)
168
+ end
169
+ end
170
+
171
+ class CodeRenderer < SlideRenderer
172
+ register :code
173
+
174
+ def process(string)
175
+ "<pre><code#{@options ? " class='#{@options}'" : ""}>#{string}</code></pre>"
176
+ end
177
+ end
178
+
179
+ require 'redcloth'
180
+ class TextileRenderer < SlideRenderer
181
+ register :textile
182
+ register :texttile
183
+
184
+ def process(string)
185
+ RedCloth.new(string).to_html
186
+ end
187
+ end
188
+
189
+ class SlideRendering < SlideTraverser
190
+ attr_accessor :root_group, :default_type
191
+
192
+ def setup
193
+ descend(@root_group, @root_group)
194
+ end
195
+
196
+ def on_slide(slide)
197
+ slide_type = slide.type || default_type
198
+ base_type,options = *(slide_type.split(":"))
199
+ slide.content = SlideRenderer.process(base_type, options, slide.content)
200
+ slide.notes = SlideRenderer.process("textile", nil, slide.notes) unless slide.notes.nil?
201
+ end
202
+ end
203
+
204
+ class IncludeProcessor < SlideTraverser
205
+ Collector = Struct.new(:group, :slides, :loader)
206
+ attr_accessor :root_group
207
+
208
+ def initialize(loader)
209
+ @loader = loader
210
+ super()
211
+ end
212
+
213
+ def current_loader
214
+ if target_stack.empty?
215
+ return @loader
216
+ else
217
+ return target_stack.last.loader
218
+ end
219
+ end
220
+
221
+ def setup
222
+ descend(@root_group, @root_group)
223
+ end
224
+
225
+ def descend(source, dest)
226
+ unless Collector === dest
227
+ dest = Collector.new(dest, [], current_loader)
228
+ end
229
+ super(source, dest)
230
+ end
231
+
232
+ def ascend
233
+ target = target_stack.pop
234
+ unless target == target_stack.last
235
+ target.group.slides = target.slides
236
+ end
237
+ iter_stack.pop
238
+ end
239
+
240
+ def on_include(includer)
241
+ loader = includer.load(current_loader)
242
+ collector = target_stack.last.dup
243
+ collector.loader = loader
244
+ descend(includer, collector)
245
+ end
246
+
247
+ def on_slide(slide)
248
+ target_stack.last.slides << slide
249
+ end
250
+
251
+ def on_group(group)
252
+ target_stack.last.slides << group
253
+ super
254
+ end
255
+ end
256
+
257
+ class ArrangementFinder < SlideTraverser
258
+ attr_accessor :root_arrangement, :root_group, :blueprint
259
+
260
+ def initialize
261
+ super
262
+ end
263
+
264
+ def setup
265
+ if @blueprint.empty?
266
+ raise "Empty blueprint - can't layout slides"
267
+ end
268
+
269
+ @blueprint.combination(2) do |first, second|
270
+ if first.match == second.match
271
+ if first.match == {}
272
+ raise "Two default rules (default or match: {}) - please fix"
273
+ end
274
+ warn "Blueprint rules with duplicate rules: will ignore the later one:"
275
+ warn second.inspect
276
+ end
277
+ end
278
+
279
+ unless @blueprint.last.match == {}
280
+ warn "Last blueprint rule not a default - fixing..."
281
+ defaults, rules = @blueprint.partition{|rule| rule.match == {}}
282
+ raise "Multiple default blueprint rules" unless defaults.length < 2
283
+ raise "No default blueprint rule" unless defaults.length > 0
284
+ @blueprint = rules + defaults
285
+ end
286
+
287
+ default_rule = @blueprint.last
288
+ @active_match = default_rule
289
+ @root_arrangement = default_rule.layout
290
+ descend(@root_group, @root_arrangement)
291
+ end
292
+
293
+ def on_slide(slide)
294
+ target_stack.last.slides << slide
295
+ end
296
+
297
+ def on_group(group)
298
+ arrangement = find_arrangement(group)
299
+ if arrangement != target_stack.last
300
+ target_stack.last.slides << arrangement
301
+ end
302
+ descend(group, arrangement)
303
+ end
304
+
305
+ def match?(filter, value)
306
+ return filter === value
307
+ end
308
+
309
+ def find_arrangement(group)
310
+ match = {}
311
+ template = nil
312
+ match = blueprint.find do |rule|
313
+ rule.match?(group)
314
+ end
315
+
316
+ if !match.nil? and match != @active_match
317
+ @active_match = match
318
+ return match.layout
319
+ else
320
+ return target_stack.last
321
+ end
322
+ end
323
+ end
324
+
325
+ class SlideArranger < SlideTraverser
326
+ attr_reader :slides, :current_slide
327
+ attr_accessor :root_arrangement
328
+
329
+ def setup
330
+ @slides = []
331
+ on_group(@root_arrangement)
332
+ end
333
+
334
+ def null_slide
335
+ @null_slide ||= Slide.new
336
+ end
337
+
338
+ def previous_slide
339
+ case @previous_slide
340
+ when Slide
341
+ @previous_slide
342
+ when nil
343
+ null_slide
344
+ else
345
+ @previous_slide.previous_slide
346
+ end
347
+ end
348
+
349
+ def on_slide(slide)
350
+ @current_slide = slide.dup
351
+ target_stack.last.arrange(self)
352
+ @slides.push @current_slide
353
+ @previous_slide = @current_slide
354
+ end
355
+
356
+ def ascend
357
+ @previous_slide = target_stack.last
358
+ super
359
+ end
360
+ end
361
+ end
@@ -0,0 +1,164 @@
1
+ require 'rhet-butler/yaml-type'
2
+
3
+ module RhetButler
4
+ class Slide
5
+ include YamlType
6
+ class << self
7
+ def optional_config
8
+ %w[
9
+ title html_id html_classes html_class
10
+ pos_x pos_y pos_z rot_x rot_y rot_z scale
11
+ notes type
12
+ ]
13
+ end
14
+
15
+ def required_config
16
+ %w[content]
17
+ end
18
+ end
19
+
20
+ class Position
21
+ def initialize
22
+ @x = 0
23
+ @y = 0
24
+ @z = 0
25
+ end
26
+
27
+ attr_accessor :x, :y, :z
28
+
29
+ def to_attrs
30
+ "data-x='#@x' data-y='#@y' data-z='#@z'"
31
+ end
32
+ end
33
+
34
+ class Rotation
35
+ def initialize
36
+ @x = 0
37
+ @y = 0
38
+ @z = 0
39
+ end
40
+
41
+ attr_accessor :x, :y, :z
42
+
43
+ def to_attrs
44
+ "data-rotate-x='#@x' data-rotate-y='#@y' data-rotate-z='#@z'"
45
+ end
46
+ end
47
+
48
+ def setup_defaults
49
+ @html_classes = ["step"]
50
+ @html_id = nil
51
+ @position = Position.new
52
+ @rotation = Rotation.new
53
+ @scale = 1.0
54
+ @notes = ""
55
+ @type = nil
56
+ end
57
+
58
+ def initialize
59
+ setup_defaults
60
+ end
61
+
62
+ def initialize_copy(source)
63
+ super
64
+ @config_hash = source.config_hash.dup unless source.config_hash.nil?
65
+ @content = source.content.dup unless source.content.nil?
66
+ @notes = source.notes.dup unless source.notes.nil?
67
+ @html_id = source.html_id.dup unless source.html_id.nil?
68
+ @position = source.position.dup unless source.position.nil?
69
+ @rotation = source.rotation.dup unless source.rotation.nil?
70
+ @type = source.type.dup unless source.type.nil?
71
+ @html_classes = source.html_classes.dup unless source.html_classes.nil?
72
+ end
73
+
74
+ def init_with(coder)
75
+ setup_defaults
76
+
77
+ @config_hash =
78
+ case coder.type
79
+ when :map
80
+ coder.map
81
+ when :scalar
82
+ { 'content' => coder.scalar.to_s }
83
+ when :seq
84
+ warn "Got a sequence for a slide - not sure how to parse that. Skipping"
85
+ end
86
+
87
+ check_config_hash(@config_hash)
88
+
89
+ value_from_config("title") do |title|
90
+ @html_id = title.downcase.split(/\s/).join("-")
91
+ end
92
+
93
+ value_from_config("content") do |content|
94
+ raise "Slide content needs to be a string, was: #{content.inspect}" unless String === content
95
+ @content = content
96
+ end
97
+
98
+ value_from_config("notes") do |notes|
99
+ raise "Slide notes needs to be a string, was: #{notes.inspect}" unless String === notes
100
+ @notes = notes
101
+ end
102
+
103
+ value_from_config("html_id") do |value|
104
+ @html_id = value
105
+ end
106
+
107
+ value_from_config("html_classes") do |value|
108
+ @html_classes += [*value]
109
+ end
110
+
111
+ value_from_config("html_class") do |value|
112
+ @html_classes << value
113
+ end
114
+
115
+ value_from_config("pos_x") do |value|
116
+ @position.x = value
117
+ end
118
+ value_from_config("pos_y") do |value|
119
+ @position.y = value
120
+ end
121
+ value_from_config("pos_z") do |value|
122
+ @position.z = value
123
+ end
124
+
125
+ value_from_config("rot_x") do |value|
126
+ @rotation.x = value
127
+ end
128
+ value_from_config("rot_y") do |value|
129
+ @rotation.y = value
130
+ end
131
+ value_from_config("rot_z") do |value|
132
+ @rotation.z = value
133
+ end
134
+
135
+ value_from_config("scale") do |value|
136
+ @scale = value
137
+ end
138
+
139
+ value_from_config("type") do |value|
140
+ @type = value
141
+ @html_classes << value
142
+ end
143
+ end
144
+
145
+ attr_reader :config_hash
146
+ attr_accessor :content, :html_classes, :html_id, :notes
147
+ attr_reader :position, :rotation, :type
148
+ attr_accessor :scale
149
+
150
+ def impress_attrs
151
+ attrs = []
152
+ unless @html_id.nil?
153
+ attrs << "id='#@html_id'"
154
+ end
155
+
156
+ attrs << "class='#{@html_classes.join(" ")}'"
157
+ attrs << @position.to_attrs
158
+ attrs << @rotation.to_attrs
159
+ attrs << "data-scale='#{"%0.2f" % scale}'"
160
+
161
+ attrs.join(" ")
162
+ end
163
+ end
164
+ end
@@ -0,0 +1,44 @@
1
+ require 'valise'
2
+ require 'rhet-butler/html-generator'
3
+ require 'rhet-butler/arrangement'
4
+ require 'rhet-butler/file-manager'
5
+ require 'rhet-butler/slide-loader'
6
+
7
+ module RhetButler
8
+ class StaticGenerator
9
+ def initialize(file_manager)
10
+ @configuration = file_manager.base_config
11
+ @base_valise = file_manager.slide_files
12
+ @target_valise = file_manager.target_valise
13
+ @root_slide = configuration.root_slide
14
+ @root_slide_template = configuration.root_slide_template
15
+ @template_handler = file_manager.aspect_templates(:viewer)
16
+ end
17
+
18
+ attr_accessor :target_directory, :root_slides
19
+ attr_reader :configuration, :template_handler, :target_valise
20
+
21
+ def html_document
22
+ html_generator = HTMLGenerator.new(configuration, template_handler)
23
+ html_generator.slides = SlideLoader.new(@base_valise, configuration).load_slides
24
+
25
+ return html_generator.render(@root_slide_template)
26
+ end
27
+
28
+ def populate_assets
29
+ @base_valise.sub_set("templates").glob("assets/**").map do |stack|
30
+ stack.segments[1..-2] +
31
+ [stack.segments.last.sub(/(.*(?:\..*)?).*/){|| $1}]
32
+ end.uniq.each do |target_file|
33
+ target_valise.get(target_file).writable.first.contents =
34
+ template_handler.render(target_file, nil)
35
+ end
36
+ end
37
+
38
+ def go!
39
+ target_valise.get("presentation.html").writable.first.contents = html_document
40
+
41
+ populate_assets
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,40 @@
1
+ module RhetButler
2
+ module Web
3
+ class AssetsApp
4
+ def initialize(file_manager)
5
+ @template_handler = file_manager.base_assets
6
+ end
7
+
8
+ attr_reader :template_handler
9
+
10
+ class AssetsContext
11
+ def render(path, locals = nil)
12
+ template = @template_handler.find(path).contents
13
+ if template.respond_to? :render
14
+ template.render(self, locals)
15
+ else
16
+ template
17
+ end
18
+ end
19
+ end
20
+
21
+ def assets_context
22
+ @context ||=
23
+ begin
24
+ context = AssetsContext.new
25
+ context.instance_variable_set("@template_handler", template_handler)
26
+ context
27
+ end
28
+ end
29
+
30
+ def call(env)
31
+ asset_path = env["PATH_INFO"]
32
+ asset_path.sub!(/^\//,"")
33
+ extension = asset_path.sub(/.*[.]/, ".")
34
+
35
+ mime_type = Rack::Mime.mime_type(extension, "text/plain")
36
+ [200, {'Content-Type' => mime_type}, [assets_context.render(asset_path)]]
37
+ end
38
+ end
39
+ end
40
+ end