Module: Scms

Includes:
YAML
Defined in:
lib/scms.rb,
lib/scms/version.rb,
lib/scms/scms-pageoptions.rb

Defined Under Namespace

Classes: PageOptions

Constant Summary collapse

VERSION = 
"4.0.1"

Class Method Summary collapse

Class Method Details

.build(website, settings, options) ⇒ Object 



30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/scms.rb', line 30

def Scms.build(website, settings, options)

    
    ScmsUtils.boldlog("Compiling #{website}")
    
    if settings           
        #Bootstrap here
        if settings["bootstrap"] != nil
            bootstrap = File.join(website, settings["bootstrap"])
            #ScmsUtils.log("Bootstrap is: #{settings["bootstrap"]}")
            if File.exists?(bootstrap)
                begin
                    require_relative bootstrap
                rescue Exception=>e
                    ScmsUtils.errLog(e.message)
                    ScmsUtils.log(e.backtrace.inspect)
                end
            else
                ScmsUtils.errLog("Bootstrap does not exist #{settings["bootstrap"]}")
                ScmsUtils.writelog("::Bootstrap does not exist #{settings["bootstrap"]}", website)
                ScmsUtils.writelog("type NUL > #{bootstrap}", website)
            end
        end 
        Scms.parsePages(website, settings, options)
    else
        ScmsUtils.errLog("Config is empty")
    end

    ScmsUtils.boldlog("Built website:")
    ScmsUtils.log(ScmsUtils.uriEncode("file:///#{website}"))
end

.bundle(settings, website) ⇒ Object 



413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
 
# File 'lib/scms.rb', line 413

def Scms.bundle(settings, website)
    bundleConfig = settings["bundles"]
    if bundleConfig != nil
        ScmsUtils.boldlog("Bundeling:")

        bundleConfig.each do |bundle|
            #ScmsUtils.log( "bundle (#{bundle.class}) = #{bundle}" )
            bundle.each do |option|
                name = option[0]
                config = option[1]

                bundleName = File.join(config["generate"].gsub("~/",""))
                

                content = ""
                assetList = ""
                files = config["files"]
                if files != nil
                    files.each do |asset|
                        assetList += " - #{asset}\n" 
                        assetdir = File.join(website, asset)
                        if File::exists?(assetdir)
                            #try catch for permisions
                            begin
                                content = content + "\n\n" + File.read(assetdir)
                            rescue Exception=>e
                                ScmsUtils.errLog(e.message)
                                ScmsUtils.log(e.backtrace.inspect)

                                ScmsUtils.log("#{assetList}")
                            end
                        else
                            ScmsUtils.errLog("Asset file doesn't exists: #{asset}")
                            ScmsUtils.writelog("::Asset file doesn't exists: #{asset}", website)
                            ScmsUtils.writelog("type NUL > #{assetdir}", website)
                        end
                    end
                    
                else
                    ScmsUtils.errLog("No files in bundle"); 
                end

                bundleFullPath = File.join(website, bundleName)
                bundleDir = File.dirname(File.join(website, bundleName))
                begin
                    Dir.mkdir(bundleDir, 755) unless File::directory?(bundleDir)
                    File.open(bundleFullPath, 'w') {|f| f.write(content) }
                    ScmsUtils.successLog("Created: #{bundleName}")
                rescue Exception=>e
                    ScmsUtils.errLog("Error creating bundle: #{bundleName}")
                    ScmsUtils.errLog(e.message)
                    ScmsUtils.log(e.backtrace.inspect)
                end
                if File.extname(bundleName) == ".js"
                    #puts "Minifing: #{bundleName}"
                    Scms.packr(bundleFullPath) unless /(-min)|(\.min)/.match(bundleName)
                end
            end
        end
    end
end

.bundleModel(website, settings, options) ⇒ Object 



390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/scms.rb', line 390

def Scms.bundleModel(website, settings, options)
    bundleModel = Hash.new
    bundleConfig = settings["bundles"]
    if bundleConfig != nil
        bundleConfig.each do |bundle|
            #ScmsUtils.log( "bundle (#{bundle.class}) = #{bundle}" )

            websiteroot = '/'
            websiteroot = settings["rooturl"] unless settings["rooturl"] == nil
            websiteroot = ScmsUtils.uriEncode("file:///#{website}/") if options[:mode] == "cms"

            bundle.each do |option|
                name = option[0]
                config = option[1]

                bundleName = File.join(config["generate"])
                bundleModel[name] = bundleName.gsub("~/", websiteroot)
            end
        end
    end
    return bundleModel
end

.copyWebsite(website, pub) ⇒ Object 



525
526
527
528
529
530
531
532
533
534
535
536
537
538
 
# File 'lib/scms.rb', line 525

def Scms.copyWebsite(website, pub)
    if pub.to_s.strip.length != 0
        FileUtils.mkdir pub unless Dir.exists? pub
        source = File.join(website)
        Dir.chdir(source) do          
            Dir.glob("**/*").reject{|f| f['.svn']}.each do |oldfile|
              newfile = File.join(pub, oldfile.sub(source, ''))
              #puts newfile
              File.file?(oldfile) ? FileUtils.copy(oldfile, newfile) : FileUtils.mkdir(newfile) unless File.exist? newfile
            end
        end
        ScmsUtils.log("Output to: #{ScmsUtils.uriEncode("file:///#{pub}")}")
    end
end

.getSettings(configdir) ⇒ Object 



20
21
22
23
24
25
26
27
28
 
# File 'lib/scms.rb', line 20

def Scms.getSettings(configdir)
    yamlpath=File.join(configdir, "_config.yml")
    settings = ScmsUtils.readyaml(yamlpath)
    if settings           
        return settings
    else
        ScmsUtils.errLog("Config is empty")
    end
end

.getSettingsViews(settingsViews, website, pageOptions, options) ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
 
# File 'lib/scms.rb', line 93

def Scms.getSettingsViews(settingsViews, website, pageOptions, options)
    views = Hash.new
    if settingsViews != nil
        settingsViews.each do |view| 
            viewname = view[0]
            viewparts = view[1].split("?") # This allows views to have a query string in the config
            viewpath = viewparts[0]
            viewqs = viewparts[1]

            viewModel = Hash.new
            viewModel = Hash[viewqs.split('&').map{ |q| q.split('=') }] if viewqs != nil
            views[viewname] = Scms.parseView(viewname, viewpath, website, pageOptions, options, viewModel)
        end
    end
    return views
end

.navModel(website, settings, options) ⇒ Object 



349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
 
# File 'lib/scms.rb', line 349

def Scms.navModel(website, settings, options)
    websiteroot = '/'
    websiteroot = settings["rooturl"] unless settings["rooturl"] == nil
    websiteroot = ScmsUtils.uriEncode("file:///#{website}/") if options[:mode] == "cms"

    navModel = Array.new
    if settings["pages"] != nil
        settings["pages"].each do |pagedata|
            if pagedata != nil
                pagedata.each do |pageoptions|
                    pagename =  pageoptions[0]
                    pageconfig = pageoptions[1]
                    pageurl = "about:blank"
                    pageurl = pageconfig["generate"]
                    pageurl = pageconfig["url"] unless pageconfig["url"] == nil
                    navtext = pageconfig["navigation"]
                    navmeta = pageconfig["navigation_meta"]
                    navModel.push({"text" => navtext, "url" => pageurl.gsub("~/", websiteroot), "pagename" => pagename, "meta" => navmeta}) unless navtext == nil
                end
            end
        end
    end
    if settings["nav"] != nil
        settings["nav"].each do |pagedata|
            if pagedata != nil
                pagedata.each do |pageoptions|
                    pagename =  pageoptions[0]
                    pageconfig = pageoptions[1]
                    pageurl = "about:blank"
                    pageurl = pageconfig["url"] unless pageconfig["url"] == nil
                    navtext = pagename
                    navtext = pageconfig["text"]
                    navmeta = pageconfig["meta"]
                    navModel.push({"text" => navtext, "url" => pageurl.gsub("~/", websiteroot), "pagename" => pagename, "meta" => navmeta})
                end
            end
        end
    end
    return navModel
end

.packr(asset) ⇒ Object 



508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/scms.rb', line 508

def Scms.packr(asset)
    #puts "Trying to pack: #{asset}"
    if File.exists?(asset)
        begin
            code = File.read(asset)
            compressed = Packr.pack(code)
            File.open(asset, 'w') { |f| f.write(compressed) }
            ScmsUtils.log("Minified #{File.basename(asset)}")
        rescue Exception => e  
            ScmsUtils.errLog("Error processing: #{asset}")
            ScmsUtils.errLog(e.message)
        end
    else
        ScmsUtils.errLog("Can't minify asset because file doesn't exist: #{asset}")
    end
end

.parseFolderPages(website, settings, options) ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/scms.rb', line 110

def Scms.parseFolderPages(website, settings, options)
    pagesFolder = File.join(website, "_pages")
    Dir.glob("#{pagesFolder}/**/*/").each do |pageFolder|
        pagename = File.basename(pageFolder, ".*")
        #puts "pagename: #{pagename}"

        pageconfig = nil
        pageconfig = Scms.getSettings(pageFolder) if File.exists?(File.join(pageFolder, "_config.yml"))
        pageOptions = PageOptions.new(pagename, website, pageconfig, settings)
        views = Hash.new
        if pageconfig != nil
            views = Scms.getSettingsViews(pageconfig["views"], website, pageOptions, options) if pageconfig["views"] != nil
        end
        
        Dir.glob(File.join(pageFolder, "*")).reject { |f| f =~ /\.yml$/ || File.directory?(f) }.each do |view|
            viewname = File.basename(view, ".*")
            viewpath = Pathname.new(view).relative_path_from(Pathname.new(website)).to_s
            views[viewname] = Scms.parseView(viewname, viewpath, website, pageOptions, options)
        end
        Scms.save(settings, website, pageOptions, views, options)
    end
end

.parsePages(website, settings, options) ⇒ Object 



62
63
64
65
66
67
 
# File 'lib/scms.rb', line 62

def Scms.parsePages(website, settings, options)
    # build pages defined in config file
    Scms.parseSettingsPages(website, settings, options)
    # build pages pased on _pages folder
    Scms.parseFolderPages(website, settings, options)
end

.parseSettingsPages(website, settings, options) ⇒ Object 



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/scms.rb', line 69

def Scms.parseSettingsPages(website, settings, options)
    if settings["pages"] != nil

        ScmsUtils.log("Compiling Pages:")
        settings["pages"].each do |pagedata|
            #puts "pagedata: #{pagedata}"
            if pagedata != nil
                pagedata.each do |pageOptions|
                    pagename =  pageOptions[0]
                    pageconfig = pageOptions[1]

                    pageOptions = PageOptions.new(pagename, website, pageconfig, settings)
                    views = Scms.getSettingsViews(pageconfig["views"], website, pageOptions, options)

                    # Dont save a page if no views have been defined (so the config han have pages for nav building)
                    break if views.length < 1
                    Scms.save(settings, website, pageOptions, views, options)
                end
            end
            #ScmsUtils.log( out )
        end
    end
end

.parsetemplate(template, hash = Hash.new) ⇒ Object 



230
231
232
 
# File 'lib/scms.rb', line 230

def Scms.parsetemplate(template, hash = Hash.new)
    return Scms.render(template, hash)
end

.parseView(viewname, viewpath, website, pageOptions, options, viewModel = nil) ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/scms.rb', line 133

def Scms.parseView(viewname, viewpath, website, pageOptions, options, viewModel = nil)
    #puts "parsing view: #{viewname}"

    viewhtml = ""
    viewfullpath = File.join(website, viewpath)

    if File.exists?(viewfullpath)
        begin
            htmlsnipet = File.read(viewfullpath)
        rescue Exception=>e
            ScmsUtils.errLog(e.message)
            ScmsUtils.log(e.backtrace.inspect)
        end
        
        if htmlsnipet.empty?
            ScmsUtils.log("Empty view: #{viewpath}")
        end

        hasHandler = false
        if pageOptions.handler != nil
            handlerpath = File.join(website, pageOptions.handler)
            if File.exists?(handlerpath)
                ScmsUtils.log( "Handler found: #{pageOptions.handler}" )
                hasHandler = true
                begin
                     require handlerpath
                #     #hasHandler = ScmsHandler.instance_methods(false).include? :render
                #     hasHandler = ScmsHandler.method_defined?(:render)
                #     puts "has render method: #{hasHandler}"
                #     if !hasHandler
                #         ScmsUtils.errLog( "Handler doesnt have a render method" )
                #     end
                rescue Exception => e 
                    ScmsUtils.errLog( "Problem running: ScmsHandler: #{e.message}" )
                end
            else
                ScmsUtils.errLog("Handler not found: #{pageOptions.handler}")
                ScmsUtils.writelog("::Handler not found #{pageOptions.handler}", website)
                ScmsUtils.writelog("type NUL > #{handlerpath}", website)
            end
        end

        if hasHandler
            ScmsUtils.log("Rendering with handler")
            begin
                viewSnippet = ScmsHandler.render(viewpath)
            rescue Exception=>e
                ScmsUtils.errLog(e.message)
                ScmsUtils.log(e.backtrace.inspect)
            end
        else
            case File.extname(viewpath)
            when ".xml"
                viewSnippet = ScmsXmlHandler.transform(htmlsnipet)
            when ".md"
                begin  
                    htmlsnipet = htmlsnipet.encode('UTF-8', :invalid => :replace, :undef => :replace)
                    doc = Maruku.new(htmlsnipet)
                    viewSnippet = doc.to_html
                rescue Exception => e  
                    viewSnippet = htmlsnipet
                    ScmsUtils.errLog(e.message)
                    ScmsUtils.log(e.backtrace.inspect)
                end
            else
              viewSnippet = htmlsnipet
            end
        end

        viewmodel = Hash.new
        viewmodel = { 
            :name => pageOptions.name,
            :title => pageOptions.title,
            :url => pageOptions.url,
            :resource => pageOptions.resource,
            :rootdir => website, 
            :view => {
                :name => viewname,
                :path => viewfullpath,
                :model => viewModel
            }
        }
        
        if options[:mode] == "cms"
            viewhtml = "<div class='cms' data-view='#{viewpath}' data-page='#{pageOptions.url}'>#{Scms.render(viewSnippet, viewmodel)}</div>"
        else
            viewhtml = Scms.render(viewSnippet, viewmodel)
        end
    else
        ScmsUtils.errLog("View not found: #{viewname} [#{viewpath}]")
        ScmsUtils.writelog("::View not found: #{viewname} [#{viewpath}]", website)
        ScmsUtils.writelog("type NUL > #{viewpath}", website)
    end

    return viewhtml
end

.render(template, hash = Hash.new) ⇒ Object 



234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/scms.rb', line 234

def Scms.render(template, hash = Hash.new)
    result = ""
    if template != nil
        begin 
            if hash.class == OpenStruct 
                page = hash 
            else
                page = OpenStruct.new(hash)
            end

            erb = ERB.new(template)
            result = erb.result(page.instance_eval { binding })
        rescue StandardError => e
            puts "page: #{page}"
            ScmsUtils.errLog("Critical Error: Could not parse template")
            ScmsUtils.errLog(e.message)

            result = "<code style='border: 1px solid #666; background-color: light-yellow;'><pre>"
            result += e.message
            result += "\n\n"
            result += e.inspect
            result += "\n\n"
            result += "Invalid Keys in Template\n\n"
            result += "Valid Keys are:\n"
            hash.each do |key, value|
                result += "- page.#{key}\n"
                puts "nil value foy key: #{key}" if value == nil
                singleton_class.send(:define_method, key) { value }
            end
            result = "</code></pre>"

            
            result += "\n\n"
            result += template
        rescue Exception => e  
            puts "Problem with template - check property exists"
        end
    else
        ScmsUtils.log("Error: Can not parse template.  Template is empty")
    end
    
    return result
end

.sass(asset, website) ⇒ Object 



484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/scms.rb', line 484

def Scms.sass(asset, website)
    if File.exists?(asset)
        begin
            template = File.read(asset)
            sass_engine = Sass::Engine.new(template, {
                                                      :style => :compressed,
                                                      :cache => false,
                                                      :syntax => :scss
                                                     }.freeze)
            output = sass_engine.to_css
            css_file = "#{File.dirname(asset)}/#{File.basename(asset,'.*')}.css"
            File.open(css_file, 'w') { |file| file.write(output) }
            ScmsUtils.log( "CSS minified (sassed): #{css_file}" )
        rescue Exception => e  
            ScmsUtils.errLog("Error processing: #{asset}")
            ScmsUtils.errLog(e.message)
        end
    else
        ScmsUtils.errLog("Sass file doesn't exists: #{asset}")
        ScmsUtils.writelog("::Sass file doesn't exist #{asset}", website)
        ScmsUtils.writelog("type NUL > #{asset}", website)
    end
end

.sassall(website) ⇒ Object 



475
476
477
478
479
480
481
482
 
# File 'lib/scms.rb', line 475

def Scms.sassall(website)
    ScmsUtils.log("Minimising Sass Files (.scss)")
    Dir.chdir(website) do
        Dir.glob("**/*.{scss}").each do |asset|
            Scms.sass(asset, website)
        end
    end
end

.save(settings, website, pageOptions, views, options) ⇒ Object 



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/scms.rb', line 278

def Scms.save(settings, website, pageOptions, views, options)

    fileName = File.join(website, File.join(pageOptions.url.sub('~/',''))) 
    erb = File.join(website, pageOptions.template)
    #ScmsUtils.log("Generating: #{fileName} with #{pageOptions.template}")

    if File.exists?(erb)

        # Build bundle model
        bundleModel = Scms.bundleModel(website, settings, options)
        # Build navigation model
        navModel = Scms.navModel(website, settings, options)
        #puts "navModel: #{navModel}"

        monkeyhook = "";
        monkeyhook = "<script src='scripts/air-monkey-hook.js'></script>" if options[:mode] == "cms"

        livereload = ""
        if options[:watch]
            livereload = "<script async='true' defer='true'>document.write('<script src=\"http://' + (location.host || 'localhost').split(':')[0] + ':35729/livereload.js?snipver=1\"></' + 'script>')</script>" if options[:mode] != "cms"
        end
        
        pagemodel = Hash.new
        pagemodel = { 
            :name => pageOptions.name,
            :title => pageOptions.title,
            :description => pageOptions.description,
            :keywords => pageOptions.keywords,
            :url => pageOptions.url,
            :resource => pageOptions.resource, 
            :bundles => bundleModel,
            :navigation => navModel,
            :views => views, 
            :rootdir => website, 
            :monkeyhook => monkeyhook,
            :livereload => livereload
        }

        #puts "pagemodel:"
        #puts pagemodel

        pubsubdir = File.dirname(fileName)
        Dir.mkdir(pubsubdir, 755) unless File::directory?(pubsubdir)

        erbtemplate = File.read(erb)

        #puts "pagemodel: #{pagemodel}"
        #html = ""
        html = Scms.render(erbtemplate, pagemodel)

        
        websiteroot = '/'
        websiteroot = settings["rooturl"] if settings["rooturl"] != nil
        #puts "On save mode: #{options[:mode]}"
        websiteroot = ScmsUtils.uriEncode("file:///#{website}/") if options[:mode] == "cms"

        html = html.gsub('~/', websiteroot)
        begin
            File.open(fileName, 'w') {|f| f.write(html) }
            ScmsUtils.successLog("Generated: #{pageOptions.url}")
        rescue Exception=>e
            ScmsUtils.errLog(e.message)
            ScmsUtils.log(e.backtrace.inspect)
        end
    else
        ScmsUtils.errLog("Template doesn't exist: #{pageOptions.template}")
        ScmsUtils.writelog("::Template doesn't exist #{pageOptions.template}", website)
        ScmsUtils.writelog("type NUL > #{erb}", website)
    end
end