hyla 1.0

data/data/mime.types

@@ -0,0 +1,85 @@
+# These are the same MIME types that GitHub Pages uses as of 17 Mar 2013.
+
+text/html                             html htm shtml
+text/css                              css
+text/xml                              xml rss xsl
+image/gif                             gif
+image/jpeg                            jpeg jpg
+application/x-javascript              js
+application/atom+xml                  atom
+
+text/mathml                           mml
+text/plain                            txt
+text/vnd.sun.j2me.app-descriptor      jad
+text/vnd.wap.wml                      wml
+text/x-component                      htc
+text/cache-manifest                   manifest appcache
+text/coffeescript                     coffee
+text/plain                            pde
+text/plain                            md markdown
+
+image/png                             png
+image/svg+xml                         svg
+image/tiff                            tif tiff
+image/vnd.wap.wbmp                    wbmp
+image/x-icon                          ico
+image/x-jng                           jng
+image/x-ms-bmp                        bmp
+
+application/json                      json
+application/java-archive              jar ear
+application/mac-binhex40              hqx
+application/msword                    doc
+application/pdf                       pdf
+application/postscript                ps eps ai
+application/rdf+xml                   rdf
+application/rtf                       rtf
+text/vcard                            vcf vcard
+application/vnd.apple.pkpass          pkpass
+application/vnd.ms-excel              xls
+application/vnd.ms-powerpoint         ppt
+application/vnd.wap.wmlc              wmlc
+application/xhtml+xml                 xhtml
+application/x-chrome-extension        crx
+application/x-cocoa                   cco
+application/x-font-ttf                ttf
+application/x-java-archive-diff       jardiff
+application/x-java-jnlp-file          jnlp
+application/x-makeself                run
+application/x-ns-proxy-autoconfig     pac
+application/x-perl                    pl pm
+application/x-pilot                   prc pdb
+application/x-rar-compressed          rar
+application/x-redhat-package-manager  rpm
+application/x-sea                     sea
+application/x-shockwave-flash         swf
+application/x-stuffit                 sit
+application/x-tcl                     tcl tk
+application/x-web-app-manifest+json   webapp
+application/x-x509-ca-cert            der pem crt
+application/x-xpinstall               xpi
+application/x-zip                     war
+application/zip                       zip
+
+application/octet-stream              bin exe dll
+application/octet-stream              deb
+application/octet-stream              dmg
+application/octet-stream              eot
+application/octet-stream              iso img
+application/octet-stream              msi msp msm
+
+audio/midi                            mid midi kar
+audio/mpeg                            mp3
+audio/x-realaudio                     ra
+audio/ogg                             ogg
+
+video/3gpp                            3gpp 3gp
+video/mpeg                            mpeg mpg
+video/quicktime                       mov
+video/x-flv                           flv
+video/x-mng                           mng
+video/x-ms-asf                        asx asf
+video/x-ms-wmv                        wmv
+video/x-msvideo                       avi
+video/ogg                             ogv
+video/webm                            webm

data/data/toc.adoc

@@ -0,0 +1,63 @@
+= A. Introduction module
+
+>> This is the module 'A. Introduction'
+
+== 1. Chapter
+
+This is a chapter about ...
+
+== 2. Chapter
+
+This is a Chapter about ...
+
+=== 2.1. Section
+
+This is a Section about ...
+
+=== 2.2. Section
+
+This is a Section about ...
+
+== 3. Chapter
+
+This is a Chapter about ...
+
+=== 3.1. Section
+
+This is a Section about ...
+
+
+
+= B. Instruction module
+
+>> This is the module 'B. Instruction module'
+
+== 1. Chapter
+
+This is a Chapter about ...
+
+=== 1.1. Section
+
+This is a Section about ...
+
+
+
+= C. Installation module
+
+>> This is the module 'C. Installation module'
+
+== 1. Chapter
+
+This is a Chapter about ...
+
+=== 1.1. Section
+
+This is a Section about ...
+
+== 2. Chapter
+
+This is a Chapter about ...
+
+=== 2.1. Section
+
+This is a Section about ...

data/hyla.gemspec

@@ -0,0 +1,37 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'hyla/project'
+
+Gem::Specification.new do |s|
+  s.name          = 'hyla'
+  s.version       = Hyla::VERSION
+  s.authors       = ["Charles Mouliard"]
+  s.email         = ["ch007m@gmail.com"]
+  s.description   = Hyla::DESCRIPTION
+  s.summary       = Hyla::SUMMARY
+  s.homepage      = "https://github.com/cmoulliard/hyla"
+  s.license       = "Apache License 2.0"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|s|features)/})
+  s.require_paths = ['lib']
+
+  s.add_development_dependency 'bundler', '~> 1.3'
+  s.add_development_dependency 'rake', '~> 10.1'
+  s.add_development_dependency 'rdoc', '~> 3.11'
+  # TODO - Review if guard / listen are mandatory deps
+  # s.add_development_dependency 'guard', '~> 1.8.3'
+  s.add_development_dependency 'listen', '~> 2.0'
+
+  #  Ruby command-line executables
+  s.add_runtime_dependency 'commander', '~> 4.1.3'
+  s.add_runtime_dependency 'asciidoctor', '~> 0.1.4'
+  s.add_runtime_dependency 'em-websocket', '~> 0.5'
+  s.add_runtime_dependency 'multi_json',   '~> 1.8'
+
+  # Colorize Text Terminal
+  s.add_runtime_dependency 'colorator', '~> 0.1'
+
+end

data/lib/hyla.rb

@@ -0,0 +1,47 @@
+$:.unshift File.dirname(__FILE__) # For use/testing when no gem is installed
+
+# Require all of the Ruby files in the given directory.
+#
+# path - The String relative path from here to the directory.
+#
+# Returns nothing.
+def require_all(path)
+  glob = File.join(File.dirname(__FILE__), path, '*.rb')
+  Dir[glob].each do |f|
+    require f
+  end
+end
+
+# rubygems
+require 'rubygems'
+
+# 3rd party
+require 'colorator'
+require 'listen'
+require 'guard'
+require 'asciidoctor'
+require 'eventmachine'
+require 'em-websocket'
+require 'http/parser'
+require 'multi_json'
+require 'webrick'
+require 'find'
+
+# internal requires
+require 'hyla/logger'
+require 'hyla/training'
+require 'hyla/command'
+require 'hyla/configuration'
+require 'Hyla/WebSocket'
+require 'hyla/logger'
+
+# extensions
+require_all 'hyla/commands'
+
+module Hyla
+
+  def self.logger
+    @logger ||= Logger.new
+  end
+
+end

data/lib/hyla/command.rb

@@ -0,0 +1,21 @@
+module Hyla
+  class Command
+
+    def self.globs(source, destination)
+      Dir.chdir(source) do
+        dirs = Dir['*'].select { |x| File.directory?(x) }
+        dirs -= [destination, File.expand_path(destination), File.basename(destination)]
+        dirs = dirs.map { |x| "#{x}/**/*" }
+        dirs += ['*']
+      end
+    end
+
+    program :int_block do
+      # kill threads etc
+      # make sure to exit or abort, otherwise your program keeps running
+      Hyla::logger.warn "CTRL-C / Shutdown command received"
+      exit 1
+    end
+
+  end
+end

data/lib/hyla/commands/build.rb

@@ -0,0 +1,40 @@
+module Hyla
+  module Commands
+    class Build < Command
+
+      def process(options)
+        training = Hyla::Training.new(options)
+        build(training, options)
+      end
+
+      #
+      #
+      #
+      def build(training, options)
+        source = options['source']
+        destination = options['destination']
+        Hyla.logger.info "Source: ", source
+        Hyla.logger.info "Destination: ", destination
+        print Hyla.logger.formatted_topic "Generating..."
+        self.process_training(training)
+        puts "done."
+      end
+
+      # Static: Run Training#process and catch errors
+      #
+      # training - the Hyla::Training object
+      #
+      # Returns nothing
+      def self.process_training(training)
+        training.process
+      rescue Hyla::FatalException => e
+        puts
+        Hyla.logger.error "ERROR:", "YOUR TRAINING COULD NOT BE BUILT:"
+        Hyla.logger.error "", "------------------------------------"
+        Hyla.logger.error "", e.message
+        exit(1)
+      end
+
+    end # class
+  end # module Commands
+end # module Hyla

data/lib/hyla/commands/create.rb

@@ -0,0 +1,25 @@
+module Hyla
+  module Commands
+    class Create < Command
+
+      def self.process(args, options = {})
+
+          @config = Hyla::Configuration.new
+
+          destination = options[:destination]
+          artefact_type = options[:artefact_type]
+          type = options[:type]
+
+          copy_artefact(type, artefact_type, destination)
+      end
+
+      def self.copy_artefact(type, artefact_type, destination)
+        artefact_name = type + '_' + artefact_type + @config.ADOC_EXT
+        source = [@config.templates, 'sample', artefact_name] * '/'
+        destination = [destination] * '/'
+        FileUtils.cp(source, destination)
+      end
+
+    end # class
+  end # module Commands
+end # module Hyla

data/lib/hyla/commands/generate.rb

@@ -0,0 +1,264 @@
+module Hyla
+  module Commands
+    class Generate < Command
+
+      attr_reader :artefact
+
+      DEFAULT_OPTIONS = {
+          :watch_dir => '.',
+          :watch_ext => %w(ad adoc asc asciidoc txt index),
+          :run_on_start => false,
+          :backend => 'html5',
+          :eruby => 'erb',
+          :doctype => 'article',
+          :compact => false,
+          :attributes => {},
+          :always_build_all => false,
+          :safe => :unsafe,
+          :header_footer => true
+      }
+
+      def self.process(args, options = {})
+
+        @config = Hyla::Configuration.new
+
+        rendering = options[:rendering] if self.check_mandatory_option?('--r / --rendering', options[:rendering])
+
+        case rendering
+          when 'toc2html'
+
+            Hyla.logger.info "Rendering : Table of Content to HTML"
+            self.check_mandatory_option?('--t / --toc', options[:toc])
+            @toc_file = options[:toc]
+            @out_dir = options[:destination]
+            @project_name = options[:project_name]
+
+
+            self.table_of_content_to_asciidoc(@toc_file, @out_dir, @project_name)
+
+          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])
+            @destination = options[:destination]
+            @source = options[:source]
+
+            self.asciidoc_to_html(@source, @destination)
+
+          when 'adoc2slides'
+            Hyla.logger.info "Rendering : Asciidoc to SlideShow - NOT YET AVAILABLE"
+          else
+            Hyla.logger.error ">> Unknow rendering"
+            exit(1)
+        end
+
+        # From Table of Content File to Asciidoc directories and Files
+        # self.table_of_content_to_asciidoc(@toc_file, @out_dir, @project_name)
+      end
+
+      def self.asciidoc_to_html(source, destination)
+
+        options = DEFAULT_OPTIONS.clone
+
+        # Move to Source directory & Retrieve Asciidoctor files to be processed
+        source = File.expand_path source
+        @destination = File.expand_path destination
+        Hyla.logger.info ">>       Source dir: #{source}"
+        Hyla.logger.info ">>  Destination dir: #{@destination}"
+
+        Dir.chdir(source)
+        current_dir = Dir.pwd
+        Hyla.logger.info ">>       Current dir: #{current_dir}"
+
+        # Delete destination directory
+        FileUtils.rm_rf(Dir.glob(@destination))
+
+        # Search for Asciidoc files and do the rendering
+        adoc_file_paths = []
+        Find.find(current_dir) do |path|
+           if path =~ /.*\.(?:adoc|txt|index)$/
+             path1 = Pathname.new(source)
+             path2 = Pathname.new(path)
+             relative_path = path2.relative_path_from(path1).to_s
+             Hyla.logger.debug ">>       Relative path: #{relative_path}"
+             adoc_file_paths << relative_path
+
+             # Create directory in the destination directory
+             html_dir = @destination + '/' + File.dirname(relative_path)
+             Hyla.logger.info ">>        Dir of html: #{html_dir}"
+             FileUtils.mkdir_p html_dir
+
+             # Render asciidoc to HTML
+             Hyla.logger.info ">> File to be rendered : #{path}"
+             options[:to_dir] = html_dir
+             Asciidoctor.render_file(path, options)
+
+           end
+        end
+
+        # No asciidoc files retrieved
+        if adoc_file_paths.empty?
+          Hyla.logger.info "     >>   No asciidoc files retrieved."
+          exit(1)
+        end
+
+      end
+
+      #
+      # Method parsing TOC File to generate directories and files
+      # Each Level 1 entry will become a directory
+      # and each Level 2 a file created under the directory
+      #
+      # @param [File Containing the Table of Content] toc_file
+      # @param [Directory where asciidoc files will be generated] out_dir
+      # @param [Project name used to create parent of index files] project_name
+      #
+      def self.table_of_content_to_asciidoc(toc_file, out_dir, project_name)
+
+        Hyla.logger.info '>> Project Name : ' + project_name + ' <<'
+
+        # Open file & parse it
+        f = File.open(toc_file, 'r')
+
+        # Re Create Directory of generated content
+        if Dir.exist? out_dir
+          FileUtils.rm_rf out_dir
+          FileUtils.mkdir_p out_dir
+        else
+          FileUtils.mkdir_p out_dir
+        end
+
+        #
+        # Move to 'generated' directory as we will
+        # create content relative to this directory
+        #
+        Dir.chdir out_dir
+        out_dir = Pathname.pwd
+
+        # Create index file of all index files
+        @project_index_file = self.create_index_file(project_name, @config.LEVEL_1)
+
+
+        # File iteration
+        f.each do |line|
+
+          #
+          # Check level 1
+          # Create a directory where its name corresponds to 'Title Level 1' &
+          # where we have removed the leading '=' symbol and '.' and
+          # replaced ' ' by '_'
+          #
+          if line[/^=\s/]
+
+            # Create File
+            dir_name = remove_special_chars(2, line)
+            new_dir = [out_dir, dir_name].join('/')
+            Hyla.logger.info '>> Directory created : ' + new_dir + ' <<'
+            FileUtils.mkdir_p new_dir
+            Dir.chdir(new_dir)
+
+            # Add image directory
+            Dir.mkdir('image')
+
+            #
+            # Create an index file
+            # It is used to include files belonging to a module and will be used for SlideShows
+            # The file created contains a title (= Dir Name) and header with attributes
+            #
+            @index_file = create_index_file(dir_name, @config.LEVEL_2)
+
+            # Include index file created to parent index file
+            @project_index_file.puts @config.INCLUDE_PREFIX + dir_name + '/' + dir_name + @config.INDEX_SUFFIX + @config.INCLUDE_SUFFIX
+
+            # Move to next line record
+            next
+          end
+
+          #
+          # Check Level 2
+          # Create a file for each Title Level 2 where name corresponds to title (without '==' symbol) &
+          # where we have removed the leading '==' symbol  and '.' and replace ' ' by '_'
+          #
+          if line[/^==\s/]
+
+            # Close File created previously if it exists
+            if !@previous_f.nil?
+              @previous_f.close
+            end
+
+            # Create File
+            f_name = remove_special_chars(3, line)
+            Hyla.logger.info '   # File created : ' + f_name.to_s
+            f_name += '.adoc'
+            @new_f = File.new(f_name, 'w')
+            @new_f.puts @config.HEADER
+
+            @previous_f = @new_f
+
+            # Include file to index
+            @index_file.puts @config.INCLUDE_PREFIX + f_name + @config.INCLUDE_SUFFIX
+          end
+
+          #
+          # Add Content to file if it exists and line does not start with characters to be skipped
+          #
+          if !@new_f.nil? and !line.start_with?(@config.SKIP_CHARACTERS)
+            @new_f.puts line
+          end
+
+        end
+
+      end
+
+      # method parse_file(f)
+
+      #
+      # Remove space, dot from a String
+      #
+      def self.remove_special_chars(pos, text)
+        return text[pos, text.length].strip.gsub(/\s/, '_').gsub('.', '')
+      end
+
+      #
+      # Add '/' at the end of the target path
+      # if the target path provided doesn't contain it
+      #
+      def self.check_slash_end(out_dir)
+        last_char = out_dir.to_s[-1, 1]
+        Hyla.logger.info '>> Last char : ' + last_char
+        if !last_char.equal? '/\//'
+          temp_dir = out_dir.to_s
+          out_dir = temp_dir + '/'
+        end
+        out_dir
+      end
+
+      #
+      # Create ascidoc index file
+      # containing references to asciidoc files part of a module
+      #
+      def self.create_index_file(file_name, level)
+        n_file_name = file_name + @config.INDEX_SUFFIX
+        index_file = File.new(n_file_name, 'w')
+        index_file.puts level + file_name
+        index_file.puts @config.HEADER_INDEX
+
+        index_file
+      end
+
+      #
+      # Check mandatory options
+      #
+      def self.check_mandatory_option?(key, value)
+        if value.nil? or value.empty?
+          Hyla.logger.warn "Mandatory option missing: #{key}"
+          exit(1)
+        else
+          true
+        end
+      end
+
+    end # class
+  end # module Commands
+end # module Hyla