awestruct 0.4.8 → 0.5.0.cr

data/lib/awestruct/handlers/layout_handler.rb

@@ -1,8 +1,6 @@
 
 require 'awestruct/handlers/base_handler'
 
-require 'haml'
-
 module Awestruct
   module Handlers
     class LayoutHandler < BaseHandler
@@ -33,21 +31,24 @@ module Awestruct
       end
 
       def for_layout_chain(page, &block)
-        # puts "for_layout_chain #{page.inspect}" 
         current_page = page 
+        $LOG.debug "layout_chain for #{current_page.source_path}" if $LOG.debug?
         while ( ! ( current_page.nil? || current_page.layout.nil? ) )
           current_page = site.layouts.find_matching( current_page.layout, current_page.output_extension )
-          # puts "layout #{current_page.inspect}" 
+          $LOG.debug "found matching layout for #{current_page}" if $LOG.debug?
           if ( ! current_page.nil? )
+            $LOG.debug "calling: #{block.inspect}" if $LOG.debug?
             block.call( current_page )
           end
         end
       end
 
       def rendered_content(context, with_layouts=true)
+        $LOG.debug "rendering content with layout #{with_layouts} for #{context}" if $LOG.debug?
         content = delegate.rendered_content( context, with_layouts )
 
         if ( with_layouts ) 
+          $LOG.debug "calling for_layout_chain" if $LOG.debug?
           for_layout_chain(context.__effective_page || context.page) do |layout|
             context.content = content
             context.__effective_page = layout
@@ -55,6 +56,7 @@ module Awestruct
            end
         end
 
+        $LOG.debug "finished rendering content for #{context}" if $LOG.debug?
         content
       end
 

data/lib/awestruct/handlers/restructuredtext_handler.rb

@@ -6,13 +6,13 @@ require 'awestruct/handlers/front_matter_handler'
 require 'awestruct/handlers/interpolation_handler'
 require 'awestruct/handlers/layout_handler'
 
-require 'hpricot'
+require 'nokogiri'
 
 module Awestruct
   module Handlers
     class RestructuredtextHandler < BaseHandler
 
-      CHAIN = Awestruct::HandlerChain.new( /\.(adoc|asciidoc)$/,
+      CHAIN = Awestruct::HandlerChain.new( /\.(rst)$/,
         Awestruct::Handlers::FileHandler,
         Awestruct::Handlers::FrontMatterHandler,
         Awestruct::Handlers::InterpolationHandler,
@@ -54,11 +54,11 @@ module Awestruct
                                  "--no-doc-title",
                                  " --initial-header-level=#{hl}" ].join(' '), 
                                  content )
-          content = Hpricot( doc ).at( '/html/body/div[@class="document"]' ).inner_html.strip
+          content = Nokogiri::HTML( doc ).at( '/html/body/div[@class="document"]' ).inner_html.strip
           content = content.gsub( "\r", '' )
         rescue => e
-          puts e
-          puts e.backtrace
+          $LOG.error e if $LOG.error?
+          $LOG.error e.backtrace.join( "\n" ) if $LOG.error?
         end
         content
       end

data/lib/awestruct/handlers/template/asciidoc.rb

@@ -0,0 +1,41 @@
+require 'tilt/template'
+
+module Tilt
+  class AsciidoctorTemplate < Template
+    self.default_mime_type = 'text/html'
+
+    def self.engine_initialized?
+      defined? ::Asciidoctor::Document
+    end
+
+    def initialize_engine
+      require_template_library 'asciidoctor'
+    end
+
+    def prepare
+      options[:header_footer] = false if options[:header_footer].nil?
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= Asciidoctor.render(data, options, &block)
+    end
+
+    def allows_script?
+      false
+    end
+
+    def parse_headers(content, filter = /.*/)
+      doc = Asciidoctor.load(content, {:parse_header_only => true})
+      filtered = doc.attributes.select{|k,v| k =~ filter}.inject({}) do |hash, (k,v)|
+        hash[k.gsub(filter, '')] = v
+        hash
+      end
+
+      filtered['title'] = filtered['doctitle'] = doc.doctitle
+      filtered['date'] ||= doc.attributes['revdate'] unless doc.attributes['revdate'].nil?
+      filtered['author'] = doc.attributes['author'] unless doc.attributes['author'].nil?
+
+      filtered
+    end
+  end
+end

data/lib/awestruct/handlers/template/mustache.rb

@@ -0,0 +1,25 @@
+require 'tilt/template'
+
+module Tilt
+  class MustacheTemplate < Template
+
+    def self.engine_initialized?
+      defined? ::Mustache
+    end
+
+    def initialize_engine
+      require_template_library 'mustache'
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      @output ||= Mustache.render(data, scope)
+    end
+
+    def allows_script?
+      false
+    end
+  end
+end

data/lib/awestruct/handlers/tilt_handler.rb

@@ -0,0 +1,73 @@
+
+require 'awestruct/handler_chain'
+require 'awestruct/handlers/base_tilt_handler'
+require 'awestruct/handlers/file_handler'
+require 'awestruct/handlers/front_matter_handler'
+require 'awestruct/handlers/interpolation_handler'
+require 'awestruct/handlers/layout_handler'
+
+require 'tilt'
+
+module Awestruct
+  module Handlers
+
+    class TiltMatcher
+      def match(path)
+        !Tilt[path].nil?
+      end
+    end
+
+    class NonInterpolatingTiltMatcher
+      EXT_REGEX = /\.(haml|slim|erb|mustache)$/
+
+      def match(path)
+        if match = EXT_REGEX.match(path)
+          if match[0] == '.slim' && Tilt[path].nil?
+            require 'slim'
+          end
+          true
+        else
+          false
+        end
+      end
+    end
+
+    class TiltHandler < BaseTiltHandler
+
+      INTERPOLATION_CHAIN = Awestruct::HandlerChain.new( Awestruct::Handlers::TiltMatcher.new(),
+        Awestruct::Handlers::FileHandler,
+        Awestruct::Handlers::FrontMatterHandler,
+        Awestruct::Handlers::InterpolationHandler,
+        Awestruct::Handlers::TiltHandler,
+        Awestruct::Handlers::LayoutHandler
+      )
+
+      NON_INTERPOLATION_CHAIN = Awestruct::HandlerChain.new( Awestruct::Handlers::NonInterpolatingTiltMatcher.new(),
+        Awestruct::Handlers::FileHandler,
+        Awestruct::Handlers::FrontMatterHandler,
+        Awestruct::Handlers::TiltHandler,
+        Awestruct::Handlers::LayoutHandler
+      )
+
+      def initialize(site, delegate)
+        super( site, delegate )
+      end
+
+    end
+
+  end
+end
+
+require 'awestruct/handlers/template/mustache'
+Tilt::register Tilt::MustacheTemplate, '.mustache'
+
+# As of Haml 4.0.0, Textile is no longer registered by default
+# Monkeypatch the Tilt templates to force Textile to be registered
+class Tilt::HamlTemplate
+  def initialize_engine
+    require_template_library 'haml'
+    if Haml::VERSION >= '4.0.0' && !Haml::Filters.constants.include?('Textile')
+      Haml::Filters.register_tilt_filter 'Textile'
+    end
+  end
+end

data/lib/awestruct/layouts.rb

@@ -4,7 +4,7 @@ module Awestruct
   class Layouts < Array
 
     def find_matching(simple_name, output_extension)
-      # puts "find matching ( #{simple_name}, #{output_extension} )"
+      $LOG.debug "find matching ( #{simple_name}, #{output_extension} )" if $LOG.debug?
       self.find{|e| 
         ( e.simple_name == simple_name ) && ( e.output_extension == output_extension )
       }

data/lib/awestruct/logger.rb

@@ -0,0 +1,59 @@
+require 'logger'
+
+module Awestruct
+  class AwestructLoggerMultiIO
+    def initialize(log_to_debug_io = false, *targets)
+      @targets = targets
+      @log_to_debug = log_to_debug_io
+    end
+
+    def write(*args)
+      @targets.each do |target|
+        if target.instance_of?(File) && @log_to_debug
+          target.write(*args)
+        end
+        if args[0] !~/\[/ && target.instance_of?(IO)
+          target.write(*args)
+        end
+      end
+    end
+
+    def close
+      @targs.each(&:close)
+    end
+  end
+
+  class AwestructLogFormatter < Logger::Formatter
+    attr_accessor :level
+    attr_accessor :progname
+
+    def call(severity, timestamp, who, object)
+      is_debug = $LOG.level == Logger::DEBUG
+      if is_debug
+        # callstack inspection, include our caller
+        # turn this: "/usr/lib/ruby/1.8/irb/workspace.rb:52:in `irb_binding'"
+        # into this: ["/usr/lib/ruby/1.8/irb/workspace.rb", "52", "irb_binding"]
+        #
+        # caller[3] is actually who invoked the Logger#<type>
+        # This only works if you use the severity methods
+        path, line, method = caller[3].split(/(?::in `|:|')/)
+        # Trim RUBYLIB path from 'file' if we can
+        #whence = $:.select { |p| path.start_with?(p) }[0]
+        whence = $:.detect { |p| path.start_with?(p) }
+        if !whence
+          # We get here if the path is not in $:
+          file = path
+        else
+          file = path[whence.length + 1..-1]
+        end
+        who = "#{file}:#{line}##{method}"
+      end
+
+      if severity =~ /DEBUG/
+        "[%s] %5s -- %s [%s]\n" % [timestamp.strftime('%Y-%m-%d %H:%M:%S'), severity, object, who]
+      else
+        "%s\n" % [object]
+      end
+    end
+  end
+end

data/lib/awestruct/page.rb

@@ -43,7 +43,7 @@ module Awestruct
 
     def inherit_front_matter_from(hash)
       hash.each do |k,v|
-        #puts "#{self.output_path} overwrite key: #{k}:#{self[k]} -> #{v}" if ( key?( k ) and !self[k].nil? and !self[k].eql? v)
+        $LOG.debug "#{self.output_path} overwrite key: #{k}:#{self[k]} -> #{v}" if ( key?( k ) and !self[k].nil? and !self[k].eql? v) if $LOG.debug?
         unless ( key?( k ) )
           self[k.to_sym] = v
         end
@@ -130,10 +130,23 @@ module Awestruct
       c = nil
 
       begin
+        $LOG.debug "calling rendered_content on handler for page #{self.output_path}" if $LOG.debug?
         c = handler.rendered_content( context, with_layouts )
         # c = site.engine.pipeline.apply_transformers( context.site, self, c )
-      rescue => e
-        raise $!, "Failed to render #{self.url}", $!.backtrace
+      rescue StandardError => e
+        lineno = nil
+        if e.respond_to?(:lineno)
+          lineno = e.lineno
+        elsif e.respond_to?(:line)
+          lineno = e.line
+        end
+        if lineno
+          if self.handler.respond_to?(:content_line_offset)
+            lineno += self.handler.content_line_offset
+          end
+        end
+        lineinfo = lineno ? " at line #{lineno}" : ''
+        raise StandardError, %(Failed to render #{self.relative_source_path}#{lineinfo}\n#{e.class}: #{e.message.rstrip}), e.backtrace.join("\n")
       end
 
       if context.site.config.track_dependencies

data/lib/awestruct/page_loader.rb

@@ -26,28 +26,28 @@ module Awestruct
       pages = []
       root_dir.find do |path|
         if ( path == root_dir )
-          puts "skip #{path}" if (site.config.verbose)
+          $LOG.debug "skip #{path}" if (site.config.verbose) if $LOG.debug?
           next
         end
         basename = File.basename( path )
         if ( basename == '.htaccess' )
           #special case
         elsif ( basename =~ /^[_.]/ )
-          puts "skip #{path} and prune" if (site.config.verbose)
+          $LOG.debug "skip #{path} and prune" if (site.config.verbose) if $LOG.debug?
           Find.prune
           next
         end
         relative_path = path.relative_path_from( root_dir ).to_s
         if ignore?(relative_path)
-          puts "skip ignored #{path} and prune" if (site.config.verbose)
+          $LOG.debug "skip ignored #{path} and prune" if (site.config.verbose) if $LOG.debug?
           Find.prune
           next
         end
         unless path.directory?
-          puts "loading #{relative_path}" if (site.config.verbose)
+          $LOG.debug "loading #{relative_path}" if (site.config.verbose) if $LOG.debug?
           page = load_page( path, prepare )
           if ( page && !page.draft )
-            #puts "loaded! #{path} and added to site"
+            $LOG.debug "loaded! #{path} and added to site" if $LOG.debug?
             #inherit_front_matter( page )
             site.send( @target ) << page
             pages << page

data/lib/awestruct/version.rb

@@ -1,4 +1,4 @@
 
 module Awestruct
-  VERSION='0.4.8'
+  VERSION='0.5.0.cr'
 end

data/man/awestruct.1

@@ -0,0 +1,163 @@
+'\" t
+.\"     Title: awestruct
+.\"    Author: [see the "AUTHORS" section]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 03/11/2013
+.\"    Manual: \ \&
+.\"    Source: \ \&
+.\"  Language: English
+.\"
+.TH "AWESTRUCT" "1" "03/11/2013" "\ \&" "\ \&"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+awestruct \- generates a static HTML site from templates in the current project
+.SH "SYNOPSIS"
+.sp
+\fBawestruct\fR [\fIOPTION\fR]\&...
+.SH "DESCRIPTION"
+.sp
+The awestruct(1) command generates a static HTML site for the current project\&. Awestruct recognizes a variety of templates supported by the Ruby ecosystem, many of which are handled by Tilt\&.
+.sp
+This command must be run from the root of the project\&.
+.SH "OPTIONS"
+.SS "Project Setup"
+.PP
+\fB\-i, \-\-init\fR
+.RS 4
+Initialize a new project in the
+\fIcurrent\fR
+directory\&.
+.RE
+.PP
+\fB\-f, \-\-framework\fR=\fIFRAMEWORK\fR
+.RS 4
+Specify a Compass framework during initialization to use in the project\&. (\fIbootstrap\fR,
+\fIblueprint\fR,
+\fI960\fR)
+.RE
+.PP
+\fB\-\-[no\-]scaffold\fR
+.RS 4
+Create scaffolding during initialization\&. (default: true)
+.RE
+.SS "Site Generation / Preview"
+.PP
+\fB\-d, \-\-dev\fR
+.RS 4
+Run in development mode\&. (implies
+\fB\-\-auto\fR,
+\fB\-\-server\fR,
+\fB\-\-port 4242\fR
+and
+\fB\-\-profile development\fR)
+.RE
+.PP
+\fB\-\-auto\fR
+.RS 4
+Auto\-generate files whenever changes are noticed\&.
+.RE
+.PP
+\fB\-p, \-\-port\fR=\fIPORT\fR
+.RS 4
+The server port to use when running a local server\&. (default: 4242)
+.RE
+.PP
+\fB\-b, \-\-bind\fR=\fIBIND\fR
+.RS 4
+The server address to use when running a local server\&. (default: 0\&.0\&.0\&.0)
+.RE
+.PP
+\fB\-g, \-\-[no\-]generate\fR
+.RS 4
+Generate the site\&.
+.RE
+.PP
+\fB\-P, \-\-profile\fR=\fIPROFILE\fR
+.RS 4
+Activate a configuration profile\&.
+.RE
+.PP
+\fB\-\-force\fR
+.RS 4
+Force a regeneration of all files\&.
+.RE
+.PP
+\fB\-s, \-\-server\fR
+.RS 4
+Serve the generated site from an embedded server\&.
+.RE
+.PP
+\fB\-u, \-\-url\fR=\fIURL\fR
+.RS 4
+Set the site\&.base_url property\&.
+.RE
+.SS "Site Deployment"
+.PP
+\fB\-\-deploy\fR
+.RS 4
+Deploy the site\&.
+.RE
+.SS "Processing Information"
+.PP
+\fB\-w, \-\-verbose\fR
+.RS 4
+Verbosely print processing information and configuration file checks to STDERR\&.
+.RE
+.SS "Program Information"
+.PP
+\fB\-h, \-\-help\fR
+.RS 4
+Show the help message\&.
+.RE
+.PP
+\fB\-v, \-\-version\fR
+.RS 4
+Print program version number\&.
+.RE
+.SH "EXIT STATUS"
+.PP
+\fB0\fR
+.RS 4
+Success
+.RE
+.PP
+\fB1\fR
+.RS 4
+Failure (syntax or usage error; configuration error; document processing failure; unexpected error)\&.
+.RE
+.SH "BUGS"
+.sp
+See the \fBAwestruct\fR issue tracker: <\fBhttps://github\&.com/awestruct/awestruct/issues?state=open\fR>
+.SH "AUTHORS"
+.sp
+\fBAwestruct\fR was created by Bob McWhirter and has received contributions from many other individuals\&. The tool was inspired by Jekyll in the same genre\&.
+.SH "RESOURCES"
+.sp
+Git source repository on GitHub: <\fBhttps://github\&.com/awestruct/awestruct\fR>
+.sp
+Project web site: <\fBhttp://awestruct\&.org\fR>
+.sp
+GitHub organization: <\fBhttp://github\&.com/awestruct\fR>
+.sp
+Mailinglist / forum: <\fBhttp://talk\&.awestruct\&.org\fR>
+.SH "COPYING"
+.sp
+Copyright (C) Bob McWhirter 2013\&. Free use of this software is granted under the terms of the MIT License\&.