awestruct 0.5.3 → 0.5.4.beta1

data/lib/awestruct/deploy/github_pages_deploy.rb

@@ -1,12 +1,13 @@
 require 'awestruct/deploy/base_deploy'
+require 'git'
 
 module Awestruct
   module Deploy
     class GitHubPagesDeploy < Base
-      def initialize( site_config, deploy_config )
+      def initialize(site_config, deploy_config)
         @site_path = site_config.output_dir
-        @branch    = deploy_config[ 'branch' ] || 'gh-pages'
-        @repo      = deploy_config[ 'repository' ] || 'origin'
+        @branch = deploy_config['branch'] || 'gh-pages'
+        @repo = deploy_config['repository'] || 'origin'
       end
 
       def publish_site
@@ -16,15 +17,15 @@ module Awestruct
         if current_branch == '(no branch)'
           current_branch = git.revparse('HEAD')
         end
-        git.branch( @branch ).checkout
+        git.branch(@branch).checkout
         add_and_commit_site @site_path
-        git.push( @repo, @branch )
-        git.checkout( current_branch )
+        git.push(@repo, @branch)
+        git.checkout(current_branch)
       end
 
       private
-      def add_and_commit_site( path )
-        git.with_working( path ) do
+      def add_and_commit_site(path)
+        git.with_working(path) do
           git.add(".")
           begin
             git.commit("Published #{@branch} to GitHub pages.")
@@ -34,8 +35,12 @@ module Awestruct
         end
         git.reset_hard
       end
+
+      def git
+        @git ||= ::Git.open('.')
+      end
     end
   end
 end
 
-Awestruct::Deployers.instance[ :github_pages ] = Awestruct::Deploy::GitHubPagesDeploy
+Awestruct::Deployers.instance[:github_pages] = Awestruct::Deploy::GitHubPagesDeploy

data/lib/awestruct/engine.rb

@@ -24,6 +24,7 @@ module Awestruct
 
     attr_reader :site
     attr_reader :pipeline
+    attr_reader :config
 
     def self.instance
       @instance
@@ -39,6 +40,7 @@ module Awestruct
       @pipeline = Pipeline.new
       @site_page_loader = PageLoader.new( @site )
       @layout_page_loader = PageLoader.new( @site, :layouts )
+      @config = config
     end
 
     def config
@@ -46,29 +48,29 @@ module Awestruct
     end
 
     def run(profile, base_url, default_base_url, force=false)
-      $LOG.debug "adjust_load_path" if $LOG.debug?
+      $LOG.debug 'adjust_load_path' if $LOG.debug?
       adjust_load_path
-      $LOG.debug "load_default_site_yaml" if $LOG.debug?
+      $LOG.debug 'load_default_site_yaml' if $LOG.debug?
       load_default_site_yaml
-      $LOG.debug "load_site_yaml -- profile" if $LOG.debug?
+      $LOG.debug 'load_site_yaml -- profile' if $LOG.debug?
       load_site_yaml(profile)
-      $LOG.debug "set_base_url" if $LOG.debug?
+      $LOG.debug 'set_base_url' if $LOG.debug?
       set_base_url( base_url, default_base_url )
-      $LOG.debug "load_yamls" if $LOG.debug?
+      $LOG.debug 'load_yamls' if $LOG.debug?
       load_yamls
-      $LOG.debug "load_pipeline" if $LOG.debug?
+      $LOG.debug 'load_pipeline' if $LOG.debug?
       load_pipeline
-      $LOG.debug "load_pages" if $LOG.debug?
+      $LOG.debug 'load_pages' if $LOG.debug?
       load_pages
-      $LOG.debug "execute_pipeline" if $LOG.debug?
+      $LOG.debug 'execute_pipeline' if $LOG.debug?
       execute_pipeline
-      $LOG.debug "configure_compass" if $LOG.debug?
+      $LOG.debug 'configure_compass' if $LOG.debug?
       configure_compass
-      $LOG.debug "set_urls" if $LOG.debug?
+      $LOG.debug 'set_urls' if $LOG.debug?
       set_urls( site.pages )
-      $LOG.debug "build_page_index" if $LOG.debug?
+      $LOG.debug 'build_page_index' if $LOG.debug?
       build_page_index
-      $LOG.debug "generate_output" if $LOG.debug?
+      $LOG.debug 'generate_output' if $LOG.debug?
       generate_output
     end
 
@@ -233,6 +235,7 @@ module Awestruct
       Compass.configuration.project_type    = :standalone
       Compass.configuration.project_path    = site.config.dir
       Compass.configuration.sass_dir        = 'stylesheets'
+      Compass.configuration.http_path       = site.base_url
       
       site.images_dir      = File.join( site.config.output_dir, 'images' )
       site.fonts_dir       = File.join( site.config.output_dir, 'fonts' )
@@ -245,6 +248,8 @@ module Awestruct
       Compass.configuration.fonts_dir       = 'fonts'
       Compass.configuration.line_comments   = include_line_comments?
       Compass.configuration.output_style    = compress_css?
+      Compass.configuration.relative_assets = false
+      # TODO: Should we add an on_stylesheet_error block?
 
       # port old style configuration to new Tilt-based configuration
       # TODO consider deprecating the old config mechanism and move to default-site.yml

data/lib/awestruct/extensions/intense_debate.rb

@@ -26,7 +26,7 @@ module Awestruct
           html = %Q(<script>\n)
           html += %Q(  var idcomments_acct='#{site.intense_debate_acct}';\n)
           html += %Q(  var idcomments_post_id='#{post_id}';\n )
-          html += %Q(  var idcomments_post_url='#{self.url}';\n)
+          html += %Q(  var idcomments_post_url='#{site.intense_debate_base_url || site.base_url}#{self.url}';\n)
           html += %Q(</script>\n)
           html += %Q(<script type='text/javascript' src='http://www.intensedebate.com/js/genericLinkWrapperV2.js'></script>\n)
           html

data/lib/awestruct/extensions/minify.rb

@@ -117,7 +117,7 @@ module Awestruct
 
       def pngcrush(page, input)
         filename = page.source_path
-        cmd = Shellwords.escape("pngcrush #{filename} /tmp/pngcrush")
+        cmd = "pngcrush " + Shellwords.escape("#{filename}") + " /tmp/pngcrush"
         `#{cmd}`
         if $?.exitstatus != 0
           raise "Failed to execute pngcrush: #{cmd}"

data/lib/awestruct/extensions/pipeline.rb

@@ -3,9 +3,9 @@ Dir[ File.join( File.dirname(__FILE__), '*.rb' ) ].each do |f|
   begin
     require f
   rescue LoadError => e
-    puts "WARNING: Missing required dependency to activate optional built-in extension #{File.basename(f)}\n  #{e}"
+    puts "WARNING: Missing required dependency to activate optional built-in extension #{File.basename(f)}\n  #{e}" if $LOG.debug?
   rescue StandardError => e
-    puts "WARNING: Missing runtime configuration to activate optional built-in extension #{File.basename(f)}\n  #{e}"
+    puts "WARNING: Missing runtime configuration to activate optional built-in extension #{File.basename(f)}\n  #{e}" if $LOG.debug?
   end
 end
 

data/lib/awestruct/extensions/relative.rb

@@ -6,7 +6,13 @@ module Awestruct
 
       def relative(href, p = page)
         begin
-          Pathname.new(href).relative_path_from(Pathname.new(File.dirname(p.output_path))).to_s
+          # Ignore absolute links
+          if href.start_with?("http://") || href.start_with?("https://")
+            result = href
+          else
+            result = Pathname.new(href).relative_path_from(Pathname.new(File.dirname(p.output_path))).to_s
+          end
+          result
         rescue Exception => e
           $LOG.error "#{e}" if $LOG.error?
           $LOG.error "#{e.backtrace.join("\n")}" if $LOG.error?

data/lib/awestruct/frameworks/base_Gemfile

@@ -24,9 +24,13 @@
 
 source 'https://rubygems.org'                             # This tells Bundler where to look for gems
 
-gem 'awestruct', '>= 0.5.1'                               # Goes without saying
+gem 'awestruct', '>= 0.5.3'                               # Goes without saying
 gem 'rake', '>= 0.9.2'                                    # Needed for the Rakefile to work
 # gem 'coffee-script', '>= 2.2.0'                         # If using coffee-script or to remove the warning
+# gem 'rb-fsevent', '~> 0.9', :require => false           # to remove warning about pulling, Mac OSX
+# gem 'rb-inotify', '>= 0.9.0', :require => false         # to remove warning about pulling, Linux
+# gem 'wdm', :platforms => [:mswin, :mingw], :require => false # to remove warning about pulling, Windows (ruby 1.9+)
+# gem 'rb-fchange', '~> 0.0.6', :require => false         # to remove warning about pulling, Windows (ruby 1.8.7)
 # gem 'therubyracer', '0.10.0', :platforms => :ruby       # Javascript runtime on mri (needed for LESS and coffee-script)
 # gem 'therubyrhino', '~> 2.0.2', :platforms => :jruby    # Javascript runtime on jruby (needed for LESS and coffee-script)
 # gem 'less', '>= 2.2.2'                                  # If using LESS instead of sass 

data/lib/awestruct/frameworks/bootstrap/base_layout.html.haml

@@ -15,7 +15,7 @@
     .navbar.navbar-fixed-top
       .navbar-inner
         .container
-          %a.brand{ :href=>"#{site.base_url}" } Project Name
+          %a.brand{ :href=>"#{site.base_url}" } #{site.name}
           %ul.nav
             %li
               %a{ :href=>"#{site.base_url}" } Home
@@ -23,7 +23,7 @@
       ~ content
       %hr
       %footer
-        %p © Organization #{Date.today.year}
+        %p © #{site.org} #{Date.today.year}
     -# Uncomment script tags (remove leading -#) when you're ready to use behaviors
     -# %script{ :type=>'text/javascript', :src=>'//cdnjs.cloudflare.com/ajax/libs/jquery/1.9.1/jquery.min.js' }
     -# %script{ :type=>'text/javascript', :src=>"#{site.base_url}/javascripts/bootstrap-collapse.js" }

data/lib/awestruct/handler_chains.rb

@@ -1,5 +1,5 @@
 require 'awestruct/handler_chain'
-require 'awestruct/handlers/file_handler'
+require 'awestruct/handlers/verbatim_file_handler'
 require 'awestruct/handlers/css_tilt_handler'
 require 'awestruct/handlers/restructuredtext_handler'
 require 'awestruct/handlers/javascript_handler'
@@ -19,7 +19,7 @@ module Awestruct
       Awestruct::Handlers::AsciidoctorHandler::CHAIN,
       Awestruct::Handlers::TiltHandler::NON_INTERPOLATION_CHAIN,
       Awestruct::Handlers::TiltHandler::INTERPOLATION_CHAIN,
-      HandlerChain.new( /.*/, Awestruct::Handlers::FileHandler )
+      HandlerChain.new( /.*/, Awestruct::Handlers::VerbatimFileHandler )
     ]
 
     def initialize(include_defaults=true)

data/lib/awestruct/handlers/asciidoctor_handler.rb

@@ -10,16 +10,34 @@ require 'tilt'
 module Awestruct
   module Handlers
 
-    class AsciidoctorMatcher
+    class AsciidoctorTiltMatcher < TiltMatcher
+      # Use a lightweight lookup to avoid loading Tilt templates for
+      # non-matching paths. Once we are sure this is a match, then
+      # attempt to load the Tilt template for AsciiDoc files.
       def match(path)
-        engine = Tilt[path]
-        engine == Tilt::AsciidoctorTemplate
+        # formal lookup as implemented in Tilt
+        pattern = File.basename(path.downcase)
+        registered = false
+        until pattern.empty? || (registered = Tilt.registered?(pattern))
+          # shave pattern down to next extension
+          pattern = pattern.sub(/^[^.]*\.?/, '')
+        end
+        if registered && (Tilt.mappings[pattern] || []).include?(Tilt::AsciidoctorTemplate)
+          begin
+            Tilt[File.basename(path)]
+          rescue LoadError
+            # swallowing error as it will be picked up again by primary TiltHandler
+            false
+          end
+        else
+          false
+        end
       end
     end
 
     class AsciidoctorHandler < BaseTiltHandler
 
-      CHAIN = Awestruct::HandlerChain.new( Awestruct::Handlers::AsciidoctorMatcher.new(),
+      CHAIN = Awestruct::HandlerChain.new( Awestruct::Handlers::AsciidoctorTiltMatcher.new(),
         Awestruct::Handlers::FileHandler,
         Awestruct::Handlers::FrontMatterHandler,
         Awestruct::Handlers::AsciidoctorHandler,

data/lib/awestruct/handlers/base_tilt_handler.rb

@@ -4,10 +4,26 @@ require 'tilt'
 
 module Awestruct
   module Handlers
+
+    class TiltMatcher
+      # Returns the Tilt template class if a portion of the path is registered
+      # to a Tilt template and the Tilt template can be loaded. Returns false
+      # if no portions of the path are registered to a Tilt template or the
+      # Tilt template cannot be loaded.
+      def match(path)
+        begin
+          Tilt[File.basename(path)]
+        rescue LoadError => e
+          $LOG.warn(%(Copying #{path} to generated site without processing; missing required gem -- #{e.message.split(/ *-- */).last} (or equivalent)))
+          false
+        end
+      end
+    end
+
     class BaseTiltHandler < BaseHandler
 
       def initialize(site, delegate)
-        super( site, delegate )
+        super(site, delegate)
       end
 
       def source_file_name
@@ -22,8 +38,8 @@ module Awestruct
       end
 
       def simple_name
-        base = File.basename( source_file_name, File.extname( source_file_name ))
-        return File.basename( base, File.extname( base ) ) if double_extension?
+        base = File.basename(source_file_name, File.extname(source_file_name))
+        return File.basename(base, File.extname(base)) if double_extension?
         return base
       end
 
@@ -32,11 +48,11 @@ module Awestruct
       end
 
       def input_extension
-        File.extname( source_file_name )
+        File.extname(source_file_name)
       end
 
       def output_extension
-        return File.extname( File.basename( source_file_name, File.extname( source_file_name ))) if double_extension?
+        return File.extname(File.basename(source_file_name, File.extname(source_file_name))) if double_extension?
 
         template = Tilt[path]
         if !template.nil?
@@ -55,7 +71,7 @@ module Awestruct
       def content_syntax
         # Check configuration for override, else convert extension to sym
         extension = input_extension[1..-1]
-        if ( !site[:content_syntax].nil? && !site[:content_syntax].empty?) 
+        if (!site[:content_syntax].nil? && !site[:content_syntax].empty?)
           syntax = site[:content_syntax][extension]
           return syntax.to_sym unless syntax.nil? or syntax.empty?
         end
@@ -103,10 +119,18 @@ module Awestruct
 
       def rendered_content(context, with_layouts=true)
         $LOG.debug "invoking tilt for #{delegate.path.to_s} with_layouts = #{with_layouts}" if $LOG.debug?
-        template = Tilt::new(delegate.path.to_s, delegate.content_line_offset + 1, options) { |engine|
-          delegate.rendered_content( context, with_layouts )
-        }
-        template.render( context )
+        begin
+          template = Tilt::new(delegate.path.to_s, delegate.content_line_offset + 1, options) { |engine|
+            delegate.rendered_content(context, with_layouts)
+          }
+          return template.render(context)
+        rescue LoadError => e
+          $LOG.error "Could not load template library required for rendering #{delegate.path.to_s}, please see rendered output for more information" if $LOG.error?
+          return "<h1>#{e.message}</h1><h2>Rendering file #{delegate.path.to_s} resulted in a failure.</h2><p>Backtrace: #{e.backtrace.join '<br>'}</p>"
+        rescue Exception => e
+          $LOG.error "An error during rendering #{delegate.path.to_s} occurred, please see rendered output for more information"  if $LOG.error?
+          return "<h1>#{e.message}</h1><h2>Rendering file #{delegate.path.to_s} resulted in a failure.</h2><h3>Line: #{e.line if e.respond_to?(:line)}</h3><p>Backtrace: #{e.backtrace.join '<br>'}</p>"
+        end
       end
 
     end

data/lib/awestruct/handlers/file_handler.rb

@@ -43,27 +43,23 @@ module Awestruct
       end
 
       def raw_content
-        read
-        @content
+        load_content
       end
 
       def rendered_content(context, with_layouts=true)
         raw_content
       end
+      
+      def read_content
+        File.open(@path, 'r') {|is| is.read }
+      end
 
       private 
 
-      def read
-        ( @content = open ) if stale?
+      def load_content
+        ( @content = read_content ) if stale?
         @mtime = File.mtime( @path )
-        return @content
-      end
-      
-      def open
-        input_stream = IO.open(IO.sysopen(@path, "rb"), "rb" )
-        result = input_stream.read
-        input_stream.close
-        return result
+        @content
       end
 
     end

data/lib/awestruct/handlers/front_matter_handler.rb

@@ -44,7 +44,7 @@ module Awestruct
         full_content = delegate.raw_content
 
         #if force_encoding is supported then set to charset defined in site config
-        full_content.force_encoding(site.encoding) if (full_content.respond_to?(:force_encoding) && site.encoding)
+        full_content.force_encoding(site.encoding) if (site.encoding && full_content.respond_to?(:force_encoding))
 
         yaml_content = ''
 

data/lib/awestruct/handlers/interpolation_handler.rb

@@ -17,7 +17,7 @@ module Awestruct
 
         content = content.gsub( /\\/, '\\\\\\\\' )
         content = content.gsub( /\\\\#/, '\\#' )
-        content = content.gsub( Regexp.new('#(?!{)'), '\#' ) if ruby_19?
+        content = content.gsub( /#(?!\{)/, '\#' )
         content = content.gsub( '@', '\@' )
         content = "%@#{content}@"
         begin
@@ -30,11 +30,6 @@ module Awestruct
         c
 
       end
-
-      def ruby_19?
-        @is_ruby_19 ||= RUBY_VERSION >= '1.9'
-      end
-
     end
   end
 end

data/lib/awestruct/handlers/tilt_handler.rb

@@ -11,18 +11,12 @@ 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?
+          if match[0] == '.slim' && !Tilt.registered?('slim')
             require 'slim'
           end
           true

data/lib/awestruct/handlers/verbatim_file_handler.rb

@@ -0,0 +1,12 @@
+require 'awestruct/handlers/file_handler'
+
+module Awestruct
+  module Handlers
+    class VerbatimFileHandler < FileHandler
+      # Read file in binary mode so that it can be copied to the generated site as is
+      def read_content
+        File.open(@path, 'rb') {|is| is.read }
+      end
+    end
+  end
+end