hyla 1.0.2 → 1.0.3

data/documentation/scripts/create_adoc_from_toc.sh

@@ -0,0 +1,20 @@
+#!/bin/sh
+
+# ./create_adoc_from_toc.sh ~/MyProjects/hyla/data/toc.adoc MyTocProject
+
+source remove_temp_directories.sh
+
+if [ "$#" == "0" ]; then
+    echo "No arguments provided"
+    echo "Usage : ./create_adoc_from_toc.sh path_to_toc_file project_name"
+    exit 1
+fi
+
+echo "TOC file location : $1"
+echo "Project Name : $2"
+
+hyla generate -r toc2adoc -p my-project -d ~/hyla/$2/ --toc $1
+hyla generate -r adoc2html -s ~/hyla/$2/ -d ~/hyla/$2/generated_content
+
+echo "Project created"
+ls -la ~/hyla/$2

data/documentation/scripts/create_adoc_from_toc_config.sh

@@ -0,0 +1,24 @@
+#!/bin/sh
+
+# ./create_adoc_from_toc.sh ~/MyProjects/hyla/data/toc.adoc MyTocProject
+
+source remove_temp_directories.sh
+
+if [ "$#" == "0" ]; then
+    echo "No arguments provided"
+    echo "Usage : ./create_adoc_from_toc.sh path_to_toc_file project_name"
+    exit 1
+fi
+
+echo "TOC file location : $1"
+echo "Project Name : $2"
+
+echo "Create a $2 using --force option"
+cd ~/hyla
+rm -rf $2/
+
+hyla generate -r toc2adoc -p my-project -d ~/hyla/$2/ --toc $1
+hyla generate -r adoc2html -s ~/hyla/$2/ -d ~/hyla/$2/generated_content
+
+echo "Project created"
+ls -la ~/hyla/$2

data/documentation/scripts/create_myblankproject.sh

@@ -0,0 +1,12 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyBlankProject"
+hyla new --blank -d ~/hyla/MyBlankProject
+
+echo "Create a MyBlankProject using --force option"
+hyla new -b -d ~/hyla/MyBlankProject --force
+
+echo "Project created"
+ls -la ~/hyla/MyBlankProject

data/documentation/scripts/create_myblankproject_add_artefacts.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyBlankProject and add artefacts"
+cd ~/hyla
+
+echo "Create a new Blank project"
+hyla new -b -d MyBlankProject --force
+
+echo "Add asciidoc files using artefacts and template"
+hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a book --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a image --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a audio --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a video --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a source --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a table --d ~/hyla/MyBlankProject
+
+echo "Project created"
+ls -la ~/hyla/MyBlankProject
+
+

data/documentation/scripts/create_myblankproject_add_artefacts_config.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a Blank project but containing the yaml config file"
+cd ~/hyla
+hyla new -b -d MyBlankProject --force
+cd MyBlankProject
+
+echo "Change destination parameter"
+ruby -i.bak -pe 'sub(%r{destination: generated_content},"destination: .")' _config.yaml
+
+hyla create --a article
+hyla create --a book
+hyla create --a image
+hyla create --a audio
+hyla create --a video
+hyla create --a source
+hyla create --a table
+
+echo "Project created"
+ls -la ~/hyla/MyBlankProject
+
+echo "Revert destination parameter"
+ruby -i.bak -pe 'sub(%r{destination: .},"destination: generated_content")' _config.yaml
+
+
+

data/documentation/scripts/create_mytemplateproject.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyBookProject using template book"
+cd ~/hyla
+hyla new --t book -d MyBookProject
+
+echo "Project created"
+ls -la ~/hyla/MyBookProject

data/documentation/scripts/create_mytrainingproject.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyTrainingProject using template book"
+cd ~/hyla
+hyla new --t training -d MyTrainingProject
+
+echo "Project created"
+ls -la ~/hyla/MyTrainingProject

data/documentation/scripts/generate_content_myblankproject.sh

@@ -0,0 +1,25 @@
+#!/bin/sh
+
+echo "Create Project"
+rm -rf ~hyla/MyBlankProject
+hyla new -b -d ~/hyla/MyBlankProject --force
+
+echo "Generate HTML Content of MyBlank project"
+cd ~/hyla/MyBlankProject
+
+echo "Backup _config.yaml file as we don't use it here"
+mv _config.yaml _config.yaml.bk
+
+echo "Add asciidoc files"
+hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a book --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a image --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a audio --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a video --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a source --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a table --d ~/hyla/MyBlankProject
+
+hyla generate -r adoc2html -s ~/hyla/MyBlankProject/ -d ~/hyla/MyBlankProject/generated_content
+
+echo "Revert _config.yaml file"
+mv _config.yaml.bk _config.yaml

data/documentation/scripts/generate_content_myblankproject_config.sh

@@ -0,0 +1,28 @@
+#!/bin/sh
+
+echo "Generate HTML Content of MyBlank project"
+echo "Styles availables : liberation, asciidoctor, colony, foundation, foundation-lime, foundation-potion, github, golo, iconic, maker, readthedocs, riak, rocket-panda, rubygems"
+
+echo "Create Project"
+rm -rf ~hyla/MyBlankProject
+hyla new -b -d ~/hyla/MyBlankProject --force
+cd ~/hyla/MyBlankProject
+
+echo "Add asciidoc files"
+hyla new -b -d MyBlankProject --force
+hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a book --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a image --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a audio --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a video --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a source --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a table --d ~/hyla/MyBlankProject
+
+echo "Change style in the _config.yaml file"
+ruby -i.bak -pe 'sub(%r{style: liberation},"style: foundation")' _config.yaml
+
+echo "Generate HTML content"
+hyla generate
+
+echo "Revert style"
+ruby -i.bak -pe 'sub(%r{style: foundation},"style: liberation")' _config.yaml

data/documentation/scripts/generate_content_myblankproject_other_style.sh

@@ -0,0 +1,29 @@
+#!/bin/sh
+
+echo "Generate HTML Content of MyBlank project - Style Foundation"
+
+echo "Create Project"
+rm -rf ~hyla/MyBlankProject
+hyla new -b -d ~/hyla/MyBlankProject --force
+
+cd ~/hyla/MyBlankProject
+
+echo "Add asciidoc files"
+hyla new -b -d MyBlankProject --force
+hyla create --t asciidoc --a article --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a book --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a image --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a audio --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a video --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a source --d ~/hyla/MyBlankProject
+hyla create --t asciidoc --a table --d ~/hyla/MyBlankProject
+
+echo "Change style in the _config.yaml file"
+ruby -i.bak -pe 'sub(%r{style: liberation},"style: foundation")' _config.yaml
+
+#hyla generate -r adoc2html -s ~/hyla/MyBlankProject/ -d ~/hyla/MyBlankProject/generated_content --style liberation
+#hyla generate -r adoc2html -s ~/hyla/MyBlankProject/ -d ~/hyla/MyBlankProject/generated_content --style github
+hyla generate -r adoc2html -s ~/hyla/MyBlankProject/ -d ~/hyla/MyBlankProject/generated_content -y foundation
+
+echo "Revert _config.yaml file"
+mv _config.yaml.bk _config.yaml

data/documentation/scripts/generate_pdf_from_html.sh

@@ -0,0 +1,36 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyPdfProject"
+cd ~/hyla
+hyla new --blank -d MyPdfProject --force
+cd MyPdfProject
+
+echo "Create one Asciidoc file from sample (book)"
+
+hyla create -a book --t asciidoc -d .
+
+echo "Generate HTML content using foundation stylesheet"
+
+hyla generate --style foundation
+
+echo "We change the rendering from adoc2html to html2pdf"
+
+ruby -i.bak -pe 'sub(%r{rendering: adoc2html},"rendering: html2pdf")' _config.yaml
+
+echo "Adapt source directory & destination directory"
+
+ruby -i.bak -pe 'sub(%r{source: .},"source: ./generated_content")' _config.yaml
+ruby -i.bak -pe 'sub(%r{destination: generated_content},"destination: ./generated_content/pdf")' _config.yaml
+
+echo "Generate the PDF file for the image and book"
+
+hyla generate -f asciidoc_book.html
+#hyla generate -f asciidoc_image.html
+
+echo "Result can be opened and viewed"
+
+open generated_content/pdf/asciidoc_book.pdf
+#open generated_content/pdf/asciidoc_image.pdf
+

data/documentation/scripts/generate_slideshow_deckjs.sh

@@ -0,0 +1,18 @@
+#!/bin/sh
+
+echo "Remove MyDeckSlideShow"
+rm -rf  ~/hyla/MyDeckSlideShow
+cd ~/hyla
+
+echo "Create a blank project"
+hyla new -b -d MyDeckSlideShow
+
+echo "Create from slideshow template a DeckJS  file"
+hyla create --t slideshow -a deckjs -d MyDeckSlideShow
+
+echo "Generate HTML5 Slideshow content"
+hyla generate --backend deckjs -s ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide -a deckjs_theme=swiss,deckjs_transition=fade
+
+# hyla generate --backend deckjs -s  ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide
+# hyla generate --backend deckjs -s  ~/hyla/MyDeckSlideShow -d ~/hyla/MyDeckSlideShow/generated_content -r adoc2htmlslide -a deckjs_theme=web-2.0,deckjs_transition=horizontal-slide
+

data/documentation/scripts/generate_slideshow_mytoc_all.sh

@@ -0,0 +1,17 @@
+#!/bin/sh
+
+#./generate_slideshow_mytoc_all.sh ~/MyProjects/hyla/data/toc.adoc MyTocProject
+echo "Create MyToc Project"
+echo "Using parameters"
+source create_adoc_from_toc.sh $1 $2
+
+cd ~/hyla/MyTocProject
+
+# echo "Generate slideshow for a module using deckjs as backend"
+hyla generate --backend deckjs -s  . -d generated_content_deckjs -r index2htmlslide
+open ~/hyla/MyTocProject/generated_content_deckjs/my-project_AllSlides.html
+
+# echo "Generate slideshow for a module using revealjs as backend"
+hyla generate --backend revealjs -s  . -d generated_content_reveal -r index2htmlslide
+
+open ~/hyla/MyTocProject/generated_content_reveal/my-project_AllSlides.html

data/documentation/scripts/generate_slideshow_mytoc_module.sh

@@ -0,0 +1,10 @@
+#!/bin/sh
+
+#./generate_slideshow_mytoc_module.sh  ~/MyProjects/hyla/data/toc.adoc MyTocProject
+echo "Create MyToc Project"
+echo "Using parameters"
+source create_adoc_from_toc.sh $1 $2
+
+echo "Generate slideshow for a module using deckjs as backend"
+cd ~/hyla/MyTocProject
+hyla generate --backend deckjs -s  A_Introduction_module/ -d A_Introduction_module/generated_content -r index2htmlslide

data/documentation/scripts/generate_slideshow_revealjs.sh

@@ -0,0 +1,23 @@
+#!/bin/sh
+
+echo "Remove MyRevealJS"
+rm -rf ~/hyla/MyRevealSlideShow
+cd ~/hyla
+
+echo "Create a blank project"
+hyla new --blank -d MyRevealSlideShow
+
+echo "Create from slideshow template a RevealJS  file"
+hyla create --t slideshow -a revealjs -d MyRevealSlideShow
+
+echo "Generate HTML5 Slideshow content"
+cd MyRevealSlideShow
+
+hyla generate --backend revealjs -s . -d generated_content -r adoc2htmlslide
+
+echo "Open the slideshow using your web browser"
+open http://localhost:4000/hyla/slideshow_revealjs.html &
+
+echo "Start web server"
+hyla serve -P 4000 -H localhost -b /hyla/ -d generated_content/
+

data/documentation/scripts/generate_watch_mytrainingproject.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyTrainingProject using template book"
+cd ~/hyla
+hyla new --t training -d MyTrainingProject
+
+echo "Project created"
+ls -la ~/hyla/MyTrainingProject
+
+cd ~/hyla/MyTrainingProject
+echo "Geerate content"
+hyla generate
+
+ls -la ~/hyla/MyTrainingProject/generate_content
+
+echo "Watch content"
+hyla watch -s ~/hyla/MyTrainingProject/ -d ~/hyla/MyTrainingProject/generated_content

data/documentation/scripts/remove_temp_directories.sh

@@ -0,0 +1,16 @@
+#!/bin/sh
+
+echo "Remove temp directories"
+rm -rf ~/hyla/MyBlankProject/
+rm -rf ~/hyla/MyBookProject
+rm -rf ~/hyla/MyPdfProject/
+rm -rf ~/hyla/MyTocProject/
+rm -rf ~/hyla/MyTrainingProject/
+rm -rf ~/hyla/MyTrainingExercisesProject/
+rm -rf ~/hyla/MyDeckSlideShow/
+rm -rf ~/hyla/MyRevealSlideShow/
+rm -rf ~/hyla/MyEmailProject/
+
+ls -la ~/hyla
+
+echo "Temp directories removed"

data/documentation/scripts/sendmail.sh

@@ -0,0 +1,19 @@
+#!/bin/sh
+
+source remove_temp_directories.sh
+
+echo "Create a MyEmailProject"
+hyla new -b -d ~/hyla/MyEmailProject --force
+
+cd ~/hyla/MyEmailProject
+
+echo "Add an artefact - asciidoc with images"
+hyla create --a image --d ~/hyla/MyEmailProject
+
+echo "Generate HTML content"
+hyla generate -r adoc2html -s ~/hyla/MyEmailProject/ -d ~/hyla/MyEmailProject/generated_content
+
+# ?? Find a way to add SMTP Server, user, password ??
+echo "Send email"
+#hyla sendmail
+

data/hyla.gemspec

@@ -26,10 +26,10 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency 'commander', '~> 4.1', '>= 4.1.3'
   s.add_runtime_dependency 'asciidoctor', '~> 0.1', '>= 0.1.4'
   s.add_runtime_dependency 'em-websocket', '~> 0.5'
-  s.add_runtime_dependency 'multi_json',   '~> 1.8'
-  s.add_runtime_dependency 'tilt'
-  s.add_runtime_dependency 'haml'
-  s.add_runtime_dependency 'slim'
+  s.add_runtime_dependency 'multi_json',   '~> 1.8', '>= 1.8.4'
+  s.add_runtime_dependency 'tilt', '~> 1.4', '>= 1.4.1'
+  s.add_runtime_dependency 'haml', '~> 4.0', '>= 4.0.4'
+  s.add_runtime_dependency 'slim', '~> 2.0', '>= 2.0.2'
   s.add_runtime_dependency 'guard', '~> 1.8', '>= 1.8.3'
   s.add_runtime_dependency 'listen', '~> 1.3', '>= 1.3.1'
   s.add_runtime_dependency 'safe_yaml', '~> 1.0', '>= 1.0.0'

data/lib/hyla/commands/create.rb

@@ -3,9 +3,9 @@ module Hyla
     class Create < Command
 
       def self.process(args, options)
-        destination = options[:destination] if check_mandatory_option?('--d / --destination', options[:destination])
-        artefact_type = options[:artefact_type] if check_mandatory_option?('--a / --artefact_type', options[:artefact_type])
-        type = options[:type] if check_mandatory_option?('--t / --type', options[:type])
+        destination = options[:destination] if check_mandatory_option?('-d / --destination', options[:destination])
+        artefact_type = options[:artefact_type] if check_mandatory_option?('-a / --artefact_type', options[:artefact_type])
+        type = options[:type] if check_mandatory_option?('-t / --type', options[:type])
 
         copy_artefact(type, artefact_type, destination)
       end
@@ -23,7 +23,7 @@ module Hyla
         Hyla::logger.info ">>   Artefact #{artefact_file_name} added to project #{destination}"
 
         case artefact_type
-          when 'image','audio','video'
+          when 'image','audio','video','source'
            source_dir = [Configuration::samples, artefact_type] * '/'
            FileUtils.cp_r(source_dir,destination)
         end

data/lib/hyla/commands/generate.rb

@@ -4,7 +4,7 @@ module Hyla
 
       def self.process(args, options = {})
 
-        rendering = options[:rendering] if self.check_mandatory_option?('--r / --rendering', options[:rendering])
+        rendering = options[:rendering] if self.check_mandatory_option?('-r / --rendering', options[:rendering])
 
         case rendering
 
@@ -21,7 +21,7 @@ module Hyla
           when 'toc2adoc'
 
             Hyla.logger.info "Rendering : Table of Content to Asciidoc"
-            self.check_mandatory_option?('--t / --toc', options[:toc])
+            self.check_mandatory_option?('-t / --toc', options[:toc])
             @toc_file = options[:toc]
             @out_dir = options[:destination]
             @project_name = options[:project_name]
@@ -31,8 +31,8 @@ module Hyla
           when 'adoc2html'
 
             Hyla.logger.info "Rendering : Asciidoc to HTML"
-            self.check_mandatory_option?('--s / --source', options[:source])
-            self.check_mandatory_option?('--d / --destination', options[:destination])
+            self.check_mandatory_option?('-s / --source', options[:source])
+            self.check_mandatory_option?('-d / --destination', options[:destination])
 
             @destination = options[:destination]
             @source = options[:source]
@@ -50,10 +50,10 @@ module Hyla
 
             self.asciidoc_to_html(@source, @destination, extensions, merged_options)
 
-          when 'index2slide'
+          when 'index2htmlslide'
             Hyla.logger.info "Rendering : Asciidoctor Indexed Files to SlideShow"
-            self.check_mandatory_option?('--s / --source', options[:source])
-            self.check_mandatory_option?('--d / --destination', options[:destination])
+            self.check_mandatory_option?('-s / --source', options[:source])
+            self.check_mandatory_option?('-d / --destination', options[:destination])
 
             @destination = options[:destination]
             @source = options[:source]
@@ -72,10 +72,10 @@ module Hyla
 
             self.asciidoc_to_html(@source, @destination, extensions, merged_options)
 
-          when 'adoc2slide'
+          when 'adoc2htmlslide'
             Hyla.logger.info "Rendering : Asciidoc to SlideShow"
-            self.check_mandatory_option?('--s / --source', options[:source])
-            self.check_mandatory_option?('--d / --destination', options[:destination])
+            self.check_mandatory_option?('-s / --source', options[:source])
+            self.check_mandatory_option?('-d / --destination', options[:destination])
 
             @destination = options[:destination]
             @source = options[:source]
@@ -99,8 +99,10 @@ module Hyla
         end
       end
 
+      #
       # Return backend directory
       # containing templates (haml, slim)
+      #
       def self.backend_dir(backend)
         case backend
           when 'deckjs'
@@ -110,6 +112,9 @@ module Hyla
         end
       end
 
+      #
+      # Call Asciidoctor.render function
+      #
       def self.asciidoc_to_html(source, destination, extensions, options)
 
         # Move to Source directory & Retrieve Asciidoctor files to be processed
@@ -125,24 +130,31 @@ module Hyla
           exit(1)
         end
 
+        # Move to source directory
         Dir.chdir(source)
         current_dir = Dir.pwd
         Hyla.logger.info ">>       Current dir: #{current_dir}"
 
-        # Delete destination directory
-        FileUtils.rm_rf(Dir.glob(@destination))
+        # Delete destination directory (generated_content, ...)
+        # FileUtils.rm_rf(Dir.glob(@destination))
 
         # Search for files using extensions parameter and do the rendering
         adoc_file_paths = []
-        Find.find(current_dir) do |path|
-          if path =~ /.*\.(?:#{extensions})$/
-            path1 = Pathname.new(source)
-            path2 = Pathname.new(path)
-            relative_path = path2.relative_path_from(path1).to_s
+        Find.find(current_dir) do |f|
+          if f =~ /.*\.(?:#{extensions})$/
+
+            path_to_source = Pathname.new(source)
+            path_to_adoc_file = Pathname.new(f)
+            relative_path = path_to_adoc_file.relative_path_from(path_to_source).to_s
             Hyla.logger.debug ">>       Relative path: #{relative_path}"
             adoc_file_paths << relative_path
 
-            # Create dir
+            # Get asciidoc file name
+            file_name_processed = path_to_adoc_file.basename
+
+            #
+            # Create destination dir relative to the path calculated
+            #
             html_dir = @destination + '/' + File.dirname(relative_path)
             Hyla.logger.info ">>        Dir of html: #{html_dir}"
             FileUtils.mkdir_p html_dir
@@ -157,9 +169,13 @@ module Hyla
             end
 
             # Render asciidoc to HTML
-            Hyla.logger.info ">> File to be rendered : #{path}"
+            Hyla.logger.info ">> File to be rendered : #{f}"
+
+            # Convert asciidoc file name to html file name
+            html_file_name = file_name_processed.to_s.gsub(/.adoc$|.ad$|.asciidoc$|.index$|.txt$/, '.html')
             options[:to_dir] = html_dir
-            Asciidoctor.render_file(path, options)
+            options[:to_file] = html_file_name
+            Asciidoctor.render_file(f, options)
 
           end
         end
@@ -219,7 +235,7 @@ module Hyla
           FileUtils.mkdir_p @out_dir
         end
 
-        # Copy YAML Config file
+        # Copy YML Config file
         FileUtils.cp_r [Configuration::templates, Configuration::YAML_CONFIG_FILE_NAME] * '/', @out_dir
 
         # Copy styles
@@ -376,7 +392,7 @@ module Hyla
         # TODO - until now we cannot use level 0 for parent/children files
         # even if doctype: book
         # This is why the level for each index file title is '=='
-        index_file.puts '==' + file_name
+        index_file.puts '== ' + file_name
         index_file.puts "\n"
 
         index_file