Module: Scms

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

Defined Under Namespace

Classes: PageOptions, ScmsParser

Constant Summary collapse

VERSION = 
"4.2.4"

Class Method Summary collapse

Class Method Details

.build(website, settings, options) ⇒ Object 



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 32

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.generatePages(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 



348
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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
 
# File 'lib/scms.rb', line 348

def Scms.bundle(settings, website)
    Scms.bundler()

    if settings != nil
        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
end

.bundler(bundle = nil) ⇒ Object 



340
341
342
343
344
345
346
 
# File 'lib/scms.rb', line 340

def Scms.bundler(bundle = nil)
    if bundle == nil
        ScmsBundler.run()
    else
        ScmsBundler.bundle(bundle)
    end
end

.copyWebsite(website, pub) ⇒ Object 



462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/scms.rb', line 462

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

.generatePages(website, settings, options) ⇒ Object 



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

def Scms.generatePages(website, settings, options)
    # build pages defined in config file

    Scms.generatePagesFromSettings(website, settings, options)
    # build pages pased on _pages folder

    Scms.generatePagesFromFolder(website, settings, options)
end

.generatePagesFromFolder(website, settings, options) ⇒ Object 



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

def Scms.generatePagesFromFolder(website, settings, options)
    pagesFolder = File.join(website, "_pages")
    Dir.glob("#{pagesFolder}/**/*/").each do |pageFolder|
        pagename = File.basename(pageFolder, ".*")
        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
            viewmodel = Scms.getViewModel(viewname, viewpath, website, pageOptions, options)
            views[viewname] = Scms.renderView(viewpath, viewmodel)
        end
        Scms.savePage(settings, website, pageOptions, views, options)
    end
end

.generatePagesFromSettings(website, settings, options) ⇒ Object 



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

def Scms.generatePagesFromSettings(website, settings, options)
    if settings["pages"] != nil
        ScmsUtils.log("Compiling Pages:")
        settings["pages"].each do |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.savePage(settings, website, pageOptions, views, options)
                end
            end
        end
    end
end

.getBundleModel(website, settings, options) ⇒ Object 



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
 
# File 'lib/scms.rb', line 307

def Scms.getBundleModel(website, settings, options)
    bundleModel = Hash.new {}
    websiteroot = '/'
    websiteroot = settings["rooturl"] unless settings["rooturl"] == nil
    websiteroot = ScmsUtils.uriEncode("file:///#{website}/") if options[:mode] == "cms"
    
    Dir.glob('**/*.bundle').each do|bundle|
        getGeneratedBundleName = ScmsBundler.getGeneratedBundleName(bundle)
        stub = ScmsBundler.toStub(bundle)
        bundleModel[bundle] = getGeneratedBundleName
        bundleModel[stub] = getGeneratedBundleName #Access bundle model without bundle extention

    end 

    bundleConfig = settings["bundles"]
    if bundleConfig != nil
        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"])
                bundleModel[name] = bundleName.gsub("~/", websiteroot)
            end
        end
    end
    # puts "Bundle model:"

    # puts bundleModel

    # puts "----------------------------"

    return bundleModel
end

.getNavModel(website, settings, options) ⇒ Object 



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
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
 
# File 'lib/scms.rb', line 254

def Scms.getNavModel(website, settings, options)
    websiteroot = '/'
    websiteroot = settings["rooturl"] unless settings["rooturl"] == nil
    websiteroot = ScmsUtils.uriEncode("file:///#{website}/") if options[:mode] == "cms"
    #websiteroot = "" 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

                    #pageUrlExt = File.extname(pageurl) 

                    #puts "pageUrlExt: #{pageUrlExt}"

                    #puts "No extension" if pageUrlExt == ""

                    if options[:mode] == "cms"
                        pageurl += "index.html"  if pageurl.match(/\/$/)
                    end

                    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

.getSettings(configdir) ⇒ Object 



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

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 



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

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]
            viewData = Hash[viewqs.split('&').map{ |q| q.split('=') }] if viewqs != nil

            viewmodel = Scms.getViewModel(viewname, viewpath, website, pageOptions, options, viewData)
            views[viewname] = Scms.renderView(viewpath, viewmodel)
        end
    end
    return views
end

.getViewModel(viewname, viewpath, website, pageOptions, options, viewData = nil) ⇒ Object 



130
131
132
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
 
# File 'lib/scms.rb', line 130

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


    viewmodel = Hash.new {}
    viewfullpath = File.join(website, viewpath)

    if File.exists?(viewfullpath)
        viewmodel = { 
            :name => pageOptions.name,
            :title => pageOptions.title,
            :url => pageOptions.url,
            :resource => pageOptions.resource,
            :rootdir => website,
            :mode =>  options[:mode],
            :allowEdit => pageOptions.allowEdit,
            :view => {
                :name => viewname,
                :path => viewpath,
                :data => viewData
            }
        }
    else
        ScmsUtils.errLog("View not found: #{viewname} [#{viewpath}]")
        ScmsUtils.writelog("::View not found: #{viewname} [#{viewpath}]", website)
        ScmsUtils.writelog("type NUL > #{viewpath}", website)
    end

    return viewmodel
end

.packr(asset) ⇒ Object 



445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
 
# File 'lib/scms.rb', line 445

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

.renderView(viewpath, hash = Hash.new) ⇒ Object 



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
 
# File 'lib/scms.rb', line 160

def Scms.renderView(viewpath, hash = Hash.new)
    #puts "** Rendering: #{viewpath} **"


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

    template = ""

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

    parser = ScmsParser.new(template, hash)
    return parser.parse(viewpath)
end

.sass(asset) ⇒ Object 



423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
 
# File 'lib/scms.rb', line 423

def Scms.sass(asset)
    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}")
    end
end

.sassall(website) ⇒ Object 



414
415
416
417
418
419
420
421
 
# File 'lib/scms.rb', line 414

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

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



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
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/scms.rb', line 195

def Scms.savePage(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)
        bundleModel = Scms.getBundleModel(website, settings, options)# Build bundle model

        navModel = Scms.getNavModel(website, settings, options)# Build navigation model


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

        monkeyhook = "";
        monkeyhook = "<script src='~/scripts/air-monkey-hook.js'></script>".gsub("~/", websiteroot) 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
        }

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

        erbtemplate = File.read(erb)

        parser = ScmsParser.new(erbtemplate, pagemodel)
        html = parser.parse()
        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