hyla 1.0 → 1.0.1

data/lib/hyla/commands/new.rb

@@ -3,20 +3,18 @@ module Hyla
     class New < Command
 
       def self.process(args, options = {})
-        raise ArgumentError.new('You must specify a destination.') if args.empty?
-
-        @config = Hyla::Configuration.new
+        raise ArgumentError.new('You must specify a project name to be created.') if args.empty?
 
         #
-        # Create Directory for the Project
+        # Calculate project path (rel/absolute)
         #
-        new_project_path = File.expand_path(args.join(" "), Dir.pwd)
+        new_project_path = File.expand_path(args[0], Dir.pwd)
 
         if Dir.exist? new_project_path
 
           Hyla.logger.debug("Dir exists: #{new_project_path}")
 
-          # If force is selected, then we delete & recreate it to clen content
+          # If force is selected, then we delete & recreate it to clean content
           if options[:force]
             Hyla.logger.debug("Force option selected")
             # DOES NOT WORK ON Mac OS X
@@ -24,7 +22,7 @@ module Hyla
             FileUtils.rm_rf new_project_path
             # Create Directory
             FileUtils.mkdir_p new_project_path
-            Hyla.logger.debug("Dir recreated it")
+            Hyla.logger.debug("Dir recreated")
           end
 
           # Preserve content if it exists
@@ -34,7 +32,7 @@ module Hyla
           end
 
         else
-          # Create Directory
+          # Create Directory when it does not exist
           FileUtils.mkdir_p new_project_path
         end
 
@@ -44,31 +42,54 @@ module Hyla
         #
         if options[:blank]
           create_blank_project new_project_path
+
+          # Add yaml config file
+          FileUtils.cp_r [Configuration::templates, Configuration::YAML_CONFIG_FILE_NAME] * '/', new_project_path
+
+          # Copy styles
+          FileUtils.cp_r Configuration::styles, new_project_path
+
+          Hyla.logger.info("Blank project created")
+
         else
           raise ArgumentError.new('You must specifiy a template type.') if options[:template_type].nil?
+
           create_sample_project(new_project_path, options[:template_type])
+
+          # Copy styles
+          FileUtils.cp_r Configuration::styles, new_project_path
+
+          Hyla.logger.info("Sample project created using template : #{options[:template_type]}")
         end
 
       end
 
       #
       # Create Blank Project
-      # with just a readme.adoc file
+      # with just a readme.adoc file and yaml config file
       def self.create_blank_project(path)
         Dir.chdir(path) do
-          f = File.open('sample.adoc', 'w')
-          f.puts "= Sample Asciidoctor Project"
-          f.puts "This is an empty AsciidocTor file."
+          f = File.open('readme.ad', 'w')
+          f.puts "= Readme Asciidoctor Project"
+          f.puts "This is an empty Asciidoctor readme file."
           f.puts "To create **asciidoc(tor)** content, more info are available http://asciidoctor.org/docs/user-manual[here]"
+          f.puts "otherwise, you can add content to this newly project created using this hyla command :"
+          f.puts "hyla create --t asciidoc --a xxx  --d pathToProjectCreated"
+          f.puts "where xxx can be article, book, source, audio, video, ..."
         end
       end
 
+      #
       # Create a Sample Project
-      # from a Template
+      # from a Template (asciidoc, slideshow)
+      # and add styles
+      #
       def self.create_sample_project(path, type)
-        # TODO Test with ['',''] * '/'
-        source = @config.templates + '/' + type + '/.'
+        source = [Configuration::templates, type] * '/' + '/.'
         FileUtils.cp_r source, path
+
+        # Add yaml config file
+        FileUtils.cp_r [Configuration::templates, Configuration::YAML_CONFIG_FILE_NAME] * '/', path
       end
 
       #

data/lib/hyla/commands/watch.rb

@@ -94,10 +94,12 @@ module Hyla
               Hyla.logger.info "File modified : #{modify}"
               call_asciidoctor(modify)
             end
+
             added.each do |add|
               Hyla.logger.info "File added : #{add}"
               call_asciidoctor(add)
             end
+
           end
         end # callback
 
@@ -126,10 +128,12 @@ module Hyla
         Hyla.logger.info ">> Extension of the file : #{@ext_name}"
 
         if @ext_name != '.html'
-          to_file = file_to_process.to_s.gsub('adoc', 'html')
+          # 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')
           @opts[:to_file] = to_file
 
-          # TODO Check why asciidoctor populates new attributes and remove to_dir
+          # TODO Check why asciidoctor populates new attributes and removes to_dir
           # TODO when it is called a second time
           # Workaround - reset list, add again :out_dir
           @opts[:attributes] = {}

data/lib/hyla/configuration.rb

@@ -1,47 +1,189 @@
 module Hyla
-  class Configuration
+  class Configuration < Hash
 
     attr_reader :HEADER, :INDEX_SUFFIX, :HEADER_INDEX, :INCLUDE_PREFIX, :INCLUDE_SUFFIX, :LEVEL_1, :LEVEL_2, :SKIP_CHARACTERS,
-                :ADOC_EXT, :PREFIX_ARTEFACT, :TEMPLATES
+                :ADOC_EXT, :PREFIX_ARTEFACT, :YAML_CONFIG_FILE_NAME, :DEFAULTS,
+                :templates, :samples, :resources, :styles, :backends
 
-    def initialize()
+    DEFAULTS = {
+        'source' => Dir.pwd,
+        'destination' => File.join(Dir.pwd, 'generated_content'),
 
-      @INCLUDE_PREFIX = 'include::'
-      @INCLUDE_SUFFIX = '[]'
+        # Asciidoctor
+        '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' => 'styles'
+        },
+        'always_build_all' => false,
+        'safe' => 'unsafe',
+        'header_footer' => true
 
-      @INDEX_SUFFIX = '_AllSlides.index'
+    }
 
-      @HEADER = ":data-uri:\n" +
-                ":icons: font\n" +
-                ":last-update-label!:\n" +
-                ":source-highlighter: coderay\n" +
-                ":toc: left\n" +
-                "\n"
+    INCLUDE_PREFIX = 'include::'
 
-      @HEADER_INDEX = ":data-uri:\n" +
-                      ":navigation:\n" +
-                      ":menu:\n" +
-                      ":status:\n" +
-                      "\n"
+    INCLUDE_SUFFIX = '[]'
 
-      @LEVEL_1 = '= '
+    INDEX_SUFFIX = '_AllSlides.index'
 
-      @LEVEL_2 = '== '
+    HEADER = ":data-uri:\n" +
+        ":icons: font\n" +
+        ":last-update-label!:\n" +
+        ":source-highlighter: coderay\n" +
+        ":toc: left\n" +
+        ":notitle: true\n" +
+        "\n"
 
-      @SKIP_CHARACTERS = '>>'
+    HEADER_INDEX = ":data-uri:\n" +
+        ":navigation:\n" +
+        ":menu:\n" +
+        ":status:\n" +
 
-      @ADOC_EXT = '.adoc'
+        "\n"
 
-      @PREFIX_ARTEFACT  = 'asciidoc_'
+    LEVEL_1 = '= '
 
-      @TEMPLATES = '../../lib/templates'
+    LEVEL_2 = '== '
 
-    end
+    SKIP_CHARACTERS = '>>'
+
+    ADOC_EXT = '.adoc'
+
+    PREFIX_ARTEFACT = 'asciidoc_'
+
+    TEMPLATES = '../../lib/templates'
+
+    RESOURCES = '../../lib/resources'
+
+    SAMPLES = '../../lib/templates/sample'
+
+    STYLES = '../../lib/resources/styles'
+
+    BACKENDS = '../../lib/resources/backends'
 
+    YAML_CONFIG_FILE_NAME = '_config.yml'
+
+    #
     # Templates Location
-    def templates
-      File.expand_path(@TEMPLATES, File.dirname(__FILE__))
+    #
+    def self.templates
+      File.expand_path(TEMPLATES, File.dirname(__FILE__))
+    end
+
+    #
+    # Resources Location
+    #
+    def self.resources
+      File.expand_path(RESOURCES, File.dirname(__FILE__))
+    end
+
+    #
+    # Stylesheets Location
+    #
+    def self.styles
+      File.expand_path(STYLES, File.dirname(__FILE__))
+    end
+
+    #
+    # Backends Location
+    #
+    def self.backends
+      File.expand_path(BACKENDS, File.dirname(__FILE__))
+    end
+
+    #
+    # Samples Location
+    #
+    def self.samples
+      File.expand_path(SAMPLES, File.dirname(__FILE__))
+    end
+
+    # Public: Generate a Hyla configuration Hash by merging the default
+    # options with anything in _config.yml, and adding the given options on top.
+    #
+    # override - A Hash of options that override any options in both
+    #            the defaults and the config file. See Hyla::Configuration::DEFAULTS for a
+    #            list of option names and their defaults.
+    #
+    # Returns the final configuration Hash.
+    def self.parse(override)
+      config = DEFAULTS
+      Hyla::logger.debug("DEFAULTS Keys: #{config.inspect}")
+      override = Configuration[override].stringify_keys
+      Hyla::logger.debug("OVERRIDE Keys: #{override.inspect}")
+
+      # Read 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?
+
+      # Merge DEFAULTS < _config.yml < override
+      config = config.deep_merge(override)
+      # Convert String Keys to Symbols Keys
+      config = Configuration[].transform_keys_to_symbols(config)
+      Hyla::logger.debug("Merged Keys: #{config.inspect}")
+      return config
+    end
+
+    #
+    # Read YAML Config file
+    #
+    def self.read_config_file(filename)
+      f = File.expand_path(filename)
+      Hyla::logger.info("Config file to be parsed : #{f}")
+      config = safe_load_file(f)
+      config
+    rescue SystemCallError
+      Hyla::logger.warn "No _config.yaml file retrieved"
+    end
+
+    #
+    # Load Safely YAML File
+    #
+    def self.safe_load_file(filename)
+      YAML.safe_load_file(filename)
+    end
+
+    # Public: Turn all keys into string
+    #
+    # Return a copy of the hash where all its keys are strings
+    def stringify_keys
+      reduce({}) { |hsh, (k, v)| hsh.merge(k.to_s => v) }
+    end
+
+    #
+    # Take keys of hash and transform those to a symbols
+    #
+    def transform_keys_to_symbols(hash)
+      return hash if not hash.is_a?(Hash)
+      hash.inject({}) { |result, (key, value)|
+        new_key = case key
+                    when String then key.to_sym
+                    else key
+                  end
+        new_value = case value
+                      when Hash
+                        if key.eql? 'attributes'
+                          value
+                        else
+                          transform_keys_to_symbols(value)
+                        end
+                      else value
+                    end
+        result[new_key] = new_value
+        result
+      }
     end
 
-  end # Class Artefact
+  end # Class Configuration
 end # module Hyla

data/lib/hyla/core_ext.rb

@@ -0,0 +1,24 @@
+
+class Hash
+
+  # Merges self with another hash, recursively.
+  #
+  # This code was lovingly stolen from some random gem:
+  # http://gemjack.com/gems/tartan-0.1.1/classes/Hash.html
+  #
+  # Thanks to whoever made it.
+  def deep_merge(hash)
+    target = dup
+
+    hash.keys.each do |key|
+      if hash[key].is_a? Hash and self[key].is_a? Hash
+        target[key] = target[key].deep_merge(hash[key])
+        next
+      end
+
+      target[key] = hash[key]
+    end
+
+    target
+  end
+end

data/lib/hyla/project.rb

@@ -1,5 +1,5 @@
 module Hyla
-    VERSION = '1.0'
+    VERSION = '1.0.1'
     DESCRIPTION = 'Asciidoctor Hyla - Command Line tool to create new project, watch modifications, generate content, publish or consult it live !'
     SUMMARY = 'Asciidoctor Hyla - builder/generator of HTML5, slideshow. Watch modifications, generate content, publish or consult it live !'
 end

data/lib/resources/backends/haml/deckjs/block_admonition.html.haml

@@ -0,0 +1,14 @@
+%div{:id=>@id, :class=>['admonitionblock', (attr :name), role]}
+  %table
+    %tr
+      %td.icon
+        - if @document.attr? :icons, 'font'
+          %i{:class=>"icon-#{attr :name}", :title=>@caption}
+        - elsif @document.attr? :icons
+          %img{:src=>icon_uri(attr :name), :alt=>@caption}
+        - else
+          .title=@caption
+      %td.content
+        - if title?
+          .title=title
+        =content.chomp

data/lib/resources/backends/haml/deckjs/block_audio.html.haml

@@ -0,0 +1,7 @@
+%div{:id=>@id, :class=>['audioblock', @style, role]}
+  - if title?
+    .title=captioned_title
+  .content
+    %audio{:src=>media_uri(attr :target), :autoplay=>(option? :autoplay),
+        :controls=>!(option? :nocontrols), :loop=>(option? :loop)}
+      Your browser does not support the audio tag.

data/lib/resources/backends/haml/deckjs/block_colist.html.haml

@@ -0,0 +1,21 @@
+%div{:id=>@id, :class=>['colist', @style, role]}
+  - if title?
+    .title=title
+  - if @document.attr? :icons
+    - font_icons = @document.attr? :icons, 'font'
+    %table
+      - items.each_with_index do |item, i|
+        - num = i + 1
+        %tr
+          %td<
+            - if font_icons
+              %i.conum{:data=>{:value=>num}}
+              %b=num
+            - else
+              %img{:src=>icon_uri("callouts/#{num}"), :alt=>num}
+          %td=item.text
+  - else
+    %ol
+      - items.each do |item|
+        %li
+          %p=item.text

data/lib/resources/backends/haml/deckjs/block_dlist.html.haml

@@ -0,0 +1,54 @@
+- case @style
+- when 'qanda'
+  %div{:id=>@id, :class=>['qlist', 'qanda', role]}
+    - if title?
+      .title=title
+    %ol
+      - items.each do |questions, answer|
+        %li
+          - [*questions].each do |question|
+            %p<
+              %em=question.text
+          - unless answer.nil?
+            - if answer.text?
+              %p<=answer.text
+            - if answer.blocks?
+              =answer.content.chomp
+- when 'horizontal'
+  %div{:id=>@id, :class=>['hdlist', role]}
+    - if title?
+      .title=title
+    %table
+      - if (attr? :labelwidth) || (attr? :itemwidth)
+        %colgroup
+          %col{:style=>((attr? :labelwidth) ? %(width:#{(attr :labelwidth).chomp '%'}%;) : nil)}
+          %col{:style=>((attr? :itemwidth) ? %(width:#{(attr :itemwidth).chomp '%'}%;) : nil)}
+      - items.each do |terms, dd|
+        %tr
+          %td{:class=>['hdlist1', ('strong' if (option? 'strong'))]}
+            - terms = [*terms]
+            - last_term = terms.last
+            - terms.each do |dt|
+              =dt.text
+              - if dt != last_term
+                %br
+          %td.hdlist2
+            - unless dd.nil?
+              - if dd.text?
+                %p<=dd.text
+              - if dd.blocks?
+                =dd.content.chomp
+- else
+  %div{:id=>@id, :class=>['dlist',@style,role]}
+    - if title?
+      .title=title
+    %dl
+      - items.each do |terms, dd|
+        - [*terms].each do |dt|
+          %dt{:class=>('hdlist1' unless @style)}=dt.text
+        - unless dd.nil?
+          %dd
+            - if dd.text?
+              %p<=dd.text
+            - if dd.blocks?
+              =dd.content.chomp