hyla 1.0.1 → 1.0.2

data/lib/hyla.rb

@@ -22,7 +22,6 @@ require 'guard'
 require 'safe_yaml'
 require 'asciidoctor'
 require 'asciidoctor/backends/html5'
-
 # require 'asciidoctor/backends/_stylesheets'
 require 'eventmachine'
 require 'em-websocket'
@@ -30,13 +29,16 @@ require 'http/parser'
 require 'multi_json'
 require 'webrick'
 require 'find'
+require 'mail'
+require 'mime/types'
+require 'pdfkit'
 
 # internal requires
 require 'hyla/logger'
 require 'hyla/core_ext'
 require 'hyla/command'
 require 'hyla/configuration'
-require 'Hyla/WebSocket'
+require 'hyla/websocket'
 require 'hyla/logger'
 
 # extensions

data/lib/hyla/commands/generate.rb

@@ -2,35 +2,22 @@ module Hyla
   module Commands
     class Generate < Command
 
-      DEFAULT_OPTIONS = {
-
-          :source           => Dir.pwd,
-          :destination      => File.join(Dir.pwd, 'generated_content'),
-
-          :watch_dir         => '.',
-          :watch_ext         => %w(ad adoc asciidoc txt index),
-          :run_on_start      => false,
-          :backend           => 'html5',
-          :eruby             => 'erb',
-          :doctype           => 'article',
-          :compact           => false,
-          :attributes        => {
-              'source-highlighter'  => 'coderay',
-              'linkcss!'            => 'true',
-              'data-uri'            => 'true',
-              'stylesheet'          => 'asciidoctor.css',
-              'stylesdir'           => Configuration::styles
-          },
-          :always_build_all  => false,
-          :safe              => 'unsafe',
-          :header_footer     => true
-      }
-
       def self.process(args, options = {})
 
         rendering = options[:rendering] if self.check_mandatory_option?('--r / --rendering', options[:rendering])
 
         case rendering
+
+          when 'html2pdf'
+
+            Hyla.logger.info "Rendering : Generate PDF from HTML file"
+
+            source_dir = options[:source] if self.check_mandatory_option?('-s / --source', options[:source])
+            out_dir = options[:destination] if self.check_mandatory_option?('-d / --destination', options[:destination])
+            file_name = options[:file] if self.check_mandatory_option?('-f / --file', options[:file])
+
+            self.html_to_pdf(source_dir, out_dir, file_name)
+
           when 'toc2adoc'
 
             Hyla.logger.info "Rendering : Table of Content to Asciidoc"
@@ -46,61 +33,70 @@ module Hyla
             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]
 
-            extensions = 'adoc|ad|txt'
+            # Check Style to be used
+            new_asciidoctor_option = {
+                :attributes => {
+                    'stylesheet' => self.check_style(options[:style])
+                }
+            }
 
-            self.asciidoc_to_html(@source, @destination, extensions, options)
+            merged_options = Configuration[options].deep_merge(new_asciidoctor_option)
 
-          when 'adoc2slide'
-            Hyla.logger.info "Rendering : Asciidoc to SlideShow"
+            extensions = 'adoc|ad|asciidoc'
+
+            self.asciidoc_to_html(@source, @destination, extensions, merged_options)
+
+          when 'index2slide'
+            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])
 
-            # Assign by default backend as HTML5 if not provided by command line
-            backend = options[:backend]? options[:backend] : 'html5'
+            @destination = options[:destination]
+            @source = options[:source]
+
+            new_asciidoctor_option = {
+                :template_dirs => [self.backend_dir(options[:backend])],
+                :attributes => {
+                    'stylesheet' => self.check_style(options[:style])
+                }
+            }
 
-            #
-            # Retrieve asciidoctor attributes
-            # Could be an Arrays of Strings key=value,key=value
-            # or
-            # Could be a Hash (DEFAULTS, CONFIG_File)
-            attributes = options[:attributes]
-            override_attrs = case attributes
-                        when Hash then attributes
-                        when String then
-                          result = attributes.split(',')
-                          attributes = Hash.new
-                          result.each do |entry|
-                            words = entry.split('=')
-                            attributes[words[0]] = words[1]
-                          end
-                          attributes
-                        else {}
-                      end
+            merged_options = Configuration[options].deep_merge(new_asciidoctor_option)
+
+            # Extension(s) of the files containing include directives
+            extensions = 'txt'
+
+            self.asciidoc_to_html(@source, @destination, extensions, merged_options)
+
+          when 'adoc2slide'
+            Hyla.logger.info "Rendering : Asciidoc to SlideShow"
+            self.check_mandatory_option?('--s / --source', options[:source])
+            self.check_mandatory_option?('--d / --destination', options[:destination])
 
             @destination = options[:destination]
             @source = options[:source]
-            options = {
-                :backend => backend,
-                :template_dirs => [
-                    self.backend_dir(options[:backend])
-                ],
-                :watch_ext => %w(index),
-                :attributes => override_attrs
+
+            new_asciidoctor_option = {
+                :template_dirs => [self.backend_dir(options[:backend])],
+                :attributes => {
+                    'stylesheet' => self.check_style(options[:style])
+                }
             }
 
-            extensions = 'index|adoc|ad|asciidoc'
+            merged_options = Configuration[options].deep_merge(new_asciidoctor_option)
 
-            self.asciidoc_to_html(@source, @destination, extensions, options)
+            # Extension(s) of the files to be parsed
+            extensions = 'adoc|ad|asciidoc'
+
+            self.asciidoc_to_html(@source, @destination, extensions, merged_options)
           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
 
       # Return backend directory
@@ -116,17 +112,6 @@ module Hyla
 
       def self.asciidoc_to_html(source, destination, extensions, options)
 
-        # CSS Style to be applied
-        css_style = self.check_style(options[:style])
-
-        override = {
-            :attributes => {
-                'stylesheet'  => css_style
-            }
-        }
-
-        @options = Configuration[options].deep_merge(override)
-
         # Move to Source directory & Retrieve Asciidoctor files to be processed
         source = File.expand_path source
         @destination = File.expand_path destination
@@ -173,8 +158,8 @@ module Hyla
 
             # Render asciidoc to HTML
             Hyla.logger.info ">> File to be rendered : #{path}"
-            @options[:to_dir] = html_dir
-            Asciidoctor.render_file(path, @options)
+            options[:to_dir] = html_dir
+            Asciidoctor.render_file(path, options)
 
           end
         end
@@ -269,8 +254,8 @@ module Hyla
             FileUtils.mkdir_p new_dir
             Dir.chdir(new_dir)
 
-            # Add image directory
-            Dir.mkdir('image')
+            # Add image, audio, video directory
+            self.create_asset_directory(['image', 'audio', 'video'])
 
             #
             # Create an index file
@@ -281,6 +266,7 @@ module Hyla
 
             # Include index file created to parent index file
             @project_index_file.puts Configuration::INCLUDE_PREFIX + dir_name + '/' + dir_name + Configuration::INDEX_SUFFIX + Configuration::INCLUDE_SUFFIX
+            @project_index_file.puts "\n"
 
             # Move to next line record
             next
@@ -304,11 +290,13 @@ module Hyla
             f_name += '.adoc'
             @new_f = File.new(f_name, 'w')
             @new_f.puts Configuration::HEADER
+            @new_f.puts "\n"
 
             @previous_f = @new_f
 
             # Include file to index
             @index_file.puts Configuration::INCLUDE_PREFIX + f_name + Configuration::INCLUDE_SUFFIX
+            @index_file.puts "\n"
           end
 
           #
@@ -322,6 +310,38 @@ module Hyla
 
       end
 
+      #
+      # Generate PDF
+      #
+      def self.html_to_pdf(source, destination, html_file_name)
+        file_path = [source, html_file_name] * '/'
+        html_file = File.new(file_path)
+        kit = PDFKit.new(html_file,
+                         :page_size     => 'A4',
+                         :toc           => true,
+                         :page_offset   => 1,
+                         :footer_center => 'Page [page]')
+
+        # Create destination directory if it does not exist
+        unless File.directory?(destination)
+          FileUtils.mkdir_p(destination)
+        end
+
+        # Save PDF to a file
+        pdf_file_name = [destination, html_file_name.sub(/html|htm/,'pdf')] * '/'
+        kit.to_file(pdf_file_name)
+        Hyla.logger.info ">> PDF file generated and saved : #{pdf_file_name} "
+      end
+
+      #
+      # Create Asset Directory
+      #
+      def self.create_asset_directory(assets = [])
+        assets.each do |asset|
+          Dir.mkdir(asset) if !Dir.exist? asset
+        end
+      end
+
       #
       # Remove space, dot from a String
       #
@@ -350,8 +370,14 @@ module Hyla
       def self.create_index_file(file_name, level)
         n_file_name = file_name + Configuration::INDEX_SUFFIX
         index_file = File.new(n_file_name, 'w')
-        index_file.puts level + file_name
+
         index_file.puts Configuration::HEADER_INDEX
+        index_file.puts "\n"
+        # 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 "\n"
 
         index_file
       end

data/lib/hyla/commands/sendmail.rb

@@ -0,0 +1,97 @@
+module Hyla
+  module Commands
+    class Sendmail < Command
+
+      def self.process(args, options)
+
+        location = options[:location] if check_mandatory_option?('-s / --location', options[:location])
+        file_name = options[:file] if check_mandatory_option?('-f / --file', options[:file])
+        email_attributes = options[:email_attributes] if check_mandatory_option?('-e / --email_attributes', options[:email_attributes])
+
+        sender = email_attributes[:from]
+        recipients = email_attributes[:to]
+        subject = email_attributes[:subject]
+        file_path = [location, file_name] * '/'
+
+        # Parameters used to connect to the SMTP Server
+        @smtp_server = email_attributes[:smtp_server] if check_mandatory_option?(':smtp_server not defined in _config.yaml file', email_attributes[:smtp_server])
+        @port_number = email_attributes[:port] if check_mandatory_option?(':port not defined in _config.yaml file', email_attributes[:port])
+        @user = email_attributes[:user]
+        @password = email_attributes[:password]
+        @authentication = email_attributes[:authentication]
+        @enable_starttls = email_attributes[:enable_starttls] if check_mandatory_option?(':enable_start_tls not defined in _config.yaml file', email_attributes[:enable_starttls])
+
+        body = <<-EOS
+        <html>
+        <head>
+            <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
+            <title>REPORT</title>
+            <link type="text/css" rel="stylesheet" href="http://cdn.jsdelivr.net/foundation/5.0.3/css/foundation.min.css" />
+            <link type="text/css" rel="stylesheet" href="http://cdn.jsdelivr.net/normalize/2.1.3/normalize.min.css" />
+        </head>
+        <body>
+         <div class="row">
+            <!-- Main Content -->
+            <div class="large-9 columns" role="content">
+              <article>
+                <h4>#{subject}</h4>
+                <p>Attached as <a href=\'#{file_name}'>HTML file to this email</a></p>
+                <p>Generated by Hyla Tool</p>
+                </p>
+                <p>Remark : html Link works with Thunderbird, Gmail clients but not using Zimbra Web Client</p>
+              </article>
+            </div>
+        </div>
+        </body>
+        </html>
+        EOS
+
+        mail = Mail.new do
+          to recipients
+          from sender
+          subject subject
+          content_type 'multipart/related'
+        end
+
+        attachment = File.read(file_path)
+        mail.attachments[file_name] = {
+            :mime_type => 'application/x-html',
+            :content => attachment}
+
+        inline_html = inline_body_with_attachments(body, mail.attachments)
+
+        html_part = Mail::Part.new do
+          content_type 'text/html; charset=UTF-8'
+          body inline_html
+        end
+
+        mail.html_part = html_part
+
+        mail.delivery_method :smtp, parameters()
+        mail.deliver!
+        Hyla.logger.info "Email send to SMTP server from #{sender} with this subject : #{subject}"
+      end
+
+      def self.parameters()
+        parameters = {}
+        parameters[:address] = @smtp_server unless @smtp_server.nil?
+        parameters[:port] = @port_number unless @port_number.nil?
+        parameters[:enable_starttls] = @enable_starttls unless @enable_starttls.nil?
+        parameters[:user_name] = @user unless @user.nil?
+        parameters[:password] = @password unless @password.nil?
+        parameters[:authentication] = @authentication unless @authentication.nil?
+        return parameters
+      end
+
+      def self.inline_body_with_attachments(html, attachments)
+        attachments.each do |attachment|
+          if (html =~ /#{attachment.filename}/)
+            html = html.sub(attachment.filename, "cid:#{attachment.cid}")
+          end
+        end
+        return html
+      end
+
+    end # class
+  end # module Commands
+end # module Hyla

data/lib/hyla/commands/watch.rb

@@ -123,11 +123,13 @@ module Hyla
         dir_file = File.dirname(f)
         file_to_process = Pathname.new(f).basename
         @ext_name = File.extname(file_to_process)
-        Hyla.logger.info ">> Directory of the file to be processed : #{dir_file}"
-        Hyla.logger.info ">> File to be processed : #{file_to_process}"
-        Hyla.logger.info ">> Extension of the file : #{@ext_name}"
 
-        if @ext_name != '.html'
+        if [".adoc",".ad",".asciidoc",".txt",".index"].include? @ext_name
+
+          Hyla.logger.info ">> Directory containing file(s) to be processed : #{dir_file}"
+          Hyla.logger.info ">> File to be processed : #{file_to_process}"
+          Hyla.logger.info ">> Extension of the file : #{@ext_name}"
+
           # Generate File name
           # Rename xxx.adoc, xxx.asciidoc, xxx.ad, xxx.index to xxx.html
           to_file = file_to_process.to_s.gsub(/.adoc|.ad|.asciidoc|.index/, '.html')

data/lib/hyla/configuration.rb

@@ -6,26 +6,22 @@ module Hyla
                 :templates, :samples, :resources, :styles, :backends
 
     DEFAULTS = {
-        'source' => Dir.pwd,
-        'destination' => File.join(Dir.pwd, 'generated_content'),
+        'source'        => Dir.pwd,
+        'destination'   => File.join(Dir.pwd, 'generated_content'),
 
         # Asciidoctor
-        'watch_dir' => '.',
-        'watch_ext' => %w(ad adoc asciidoc txt index),
-        'run_on_start' => false,
-        'backend' => 'html5',
-        'eruby' => 'erb',
-        'doctype' => 'article',
-        'compact' => false,
-        'attributes' => {
+        'backend'       => 'html5',
+        'eruby'         => 'erb',
+        'doctype'       => 'article',
+        'compact'       => false,
+        'attributes'    => {
             'source-highlighter' => 'coderay',
-            'linkcss!' => 'true',
-            'data-uri' => 'true',
-            'stylesheet' => 'asciidoctor.css',
-            'stylesdir' => 'styles'
+            'linkcss!'           => 'true',
+            'data-uri'           => 'true',
+            'stylesheet'         => 'asciidoctor.css',
+            'stylesdir'          => 'styles'
         },
-        'always_build_all' => false,
-        'safe' => 'unsafe',
+        'safe'          => 'unsafe',
         'header_footer' => true
 
     }
@@ -34,22 +30,19 @@ module Hyla
 
     INCLUDE_SUFFIX = '[]'
 
-    INDEX_SUFFIX = '_AllSlides.index'
+    INDEX_SUFFIX = '_AllSlides.txt'
 
     HEADER = ":data-uri:\n" +
         ":icons: font\n" +
         ":last-update-label!:\n" +
-        ":source-highlighter: coderay\n" +
-        ":toc: left\n" +
-        ":notitle: true\n" +
-        "\n"
+        ":source-highlighter: coderay\n"
 
     HEADER_INDEX = ":data-uri:\n" +
         ":navigation:\n" +
         ":menu:\n" +
         ":status:\n" +
-
-        "\n"
+        ":goto:\n" +
+        ":notitle:\n"
 
     LEVEL_1 = '= '
 
@@ -117,12 +110,27 @@ module Hyla
     #
     # Returns the final configuration Hash.
     def self.parse(override)
-      config = DEFAULTS
-      Hyla::logger.debug("DEFAULTS Keys: #{config.inspect}")
+
+
+      # Extract Asciidoctor attributes received from hyla command line '--a key=value,key=value'
+      # Convert them to a Hash of attributes 'attributes' => { 'backend' => html5 ... }
+      # Assign hash to override[:attributes]
+      extracted_attributes = self.extract_attributes(override[:attributes]) if override[:attributes]
+      override[:attributes] = extracted_attributes if extracted_attributes
+
+      extracted_email_attributes = self.extract_attributes(override[:email_attributes]) if override[:email_attributes]
+      override[:email_attributes] = extracted_email_attributes if extracted_email_attributes
+
+      # Stringify keys of the hash what we receive from Hyla as override
       override = Configuration[override].stringify_keys
       Hyla::logger.debug("OVERRIDE Keys: #{override.inspect}")
 
-      # Read config file if it exists and merge content with DEFAULT config
+      # Clone DEFAULTS
+      config = DEFAULTS
+      Hyla::logger.debug("DEFAULTS Keys: #{config.inspect}")
+
+      # Read YAML config file IF it exists and
+      # Merge content with DEFAULT config
       new_config = read_config_file(YAML_CONFIG_FILE_NAME)
       Hyla::logger.debug("OVERRIDE Keys: #{new_config.inspect}") if !new_config.nil?
       config = config.deep_merge(new_config) if !new_config.nil?
@@ -185,5 +193,20 @@ module Hyla
       }
     end
 
+    #
+    # Retrieve asciidoctor attributes
+    # Could be an Arrays of Strings key=value,key=value
+    # or
+    # Could be a Hash (DEFAULTS, CONFIG_File)
+    def self.extract_attributes(attributes)
+      result = attributes.split(',')
+      attributes = Hash.new
+      result.each do |entry|
+        words = entry.split('=')
+        attributes[words[0]] = words[1]
+      end
+      return attributes
+    end
+
   end # Class Configuration
 end # module Hyla