awestruct 0.5.4.rc → 0.5.4.rc2

data/Gemfile

@@ -0,0 +1,29 @@
+source 'https://rubygems.org'
+
+group :development do
+  gem 'spectator', '>= 1.2.5'
+  gem 'hashery', '>= 2.1.0'
+  gem 'rspec', '>= 2.9'
+  gem 'rake', '>= 0.9.2'
+end
+
+group :test do
+  gem 'rb-inotify', '>= 0.9.0'
+  gem 'rack-test'
+  gem 'tilt', '>= 1.3.5'
+  gem 'coffee-script', '>= 2.2.0'
+  gem 'asciidoctor', '>= 0.1.3' # >= 0.1.1 is required for front matter integration
+  gem 'slim', '>= 1.3.6'
+  gem 'kramdown', '>= 0.14.2'
+  gem 'therubyracer', '0.10.0', :platforms => :ruby
+  gem 'therubyrhino', '~> 2.0.2', :platforms => :jruby
+  gem 'less', '>= 2.2.2' 
+  gem 'org-ruby', '>= 0.7'
+  gem 'RedCloth', '>= 4.2.9'
+  gem 'mustache', '>= 0.99.4'
+  gem 'uglifier', '>= 1.3.0'
+  gem 'htmlcompressor', '>= 0.0.7'
+  gem 'git', '~> 1.2.5'
+end
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,18 @@
+Copyright (c) 2010-2013 Bob McWhirter and contributors (see git log)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to
+deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+sell copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+  
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+   
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+[![Build Status](https://secure.travis-ci.org/awestruct/awestruct.png)](http://travis-ci.org/awestruct/awestruct)
+
+[![Build Status](https://buildhive.cloudbees.com/job/awestruct/job/awestruct/badge/icon)](https://buildhive.cloudbees.com/job/awestruct/job/awestruct/)
+
+# For more information
+
+Please see the complete site at <http://awestruct.org/>.
+
+# License
+
+    Copyright (c) 2010-2011 Bob McWhirter and contributors (see git log)
+
+    Permission is hereby granted, free of charge, to any person obtaining a copy
+    of this software and associated documentation files (the "Software"), to
+    deal in the Software without restriction, including without limitation the
+    rights to use, copy, modify, merge, publish, distribute, sublicense, and/or
+    sell copies of the Software, and to permit persons to whom the Software is
+    furnished to do so, subject to the following conditions:
+      
+    The above copyright notice and this permission notice shall be included in
+    all copies or substantial portions of the Software.
+       
+    THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+    IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+    FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
+    THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER 
+    IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+    CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+It also uses code from the Sequel project under the same license. 
+

data/Rakefile

@@ -0,0 +1,100 @@
+require 'rubygems'
+require 'date'
+require 'bundler/setup'
+require 'rspec/core/rake_task'
+
+def gem_name
+  @gem_name ||= Dir['*.gemspec'].first.split('.').first
+end
+
+def gem_version
+  line = File.read("lib/#{gem_name}/version.rb")[/^\s*VERSION\s*=\s*.*/]
+  line.match(/.*VERSION\s*=\s*['"](.*)['"]/)[1]
+end
+
+def date
+  Date.today.to_s
+end
+
+def gemspec_file
+  "#{gem_name}.gemspec"
+end
+
+def gem_file
+  "#{gem_name}-#{gem_version}.gem"
+end
+
+def version_tag
+  "v#{gem_version}"
+end
+
+def replace_header(head, header_name)
+  head.sub!(/(\.#{header_name}\s*= ').*'/) { "#{$1}#{send(header_name)}'"}
+end
+
+task :default => :build
+
+if !defined?(RSpec)
+  puts 'spec targets require RSpec'
+else
+  desc 'Run all specs'
+  RSpec::Core::RakeTask.new(:spec) do |t|
+    t.pattern = 'spec/**/*_spec.rb'
+    t.rspec_opts = ['-cfs']
+  end
+end
+
+desc "Run all specs and build #{gem_file} into the pkg directory"
+task :build => [:spec, :gemspec] do
+  sh "gem build #{gemspec_file}"
+  sh 'mkdir -p pkg'
+  sh "mv #{gem_file} pkg"
+end
+
+desc "Build #{gem_file} and install it locally"
+task :install => :build do
+  sh "gem install -l -f pkg/#{gem_file}"
+end
+
+desc "Update #{gemspec_file}"
+task :gemspec do
+  spec = File.read(gemspec_file)
+
+  # replace name version and date
+  replace_header(spec, :gem_name)
+  replace_header(spec, :date)
+
+  File.open(gemspec_file, 'w') { |io| io.write spec }
+  puts "Updated #{gemspec_file}"
+end
+
+desc "Create tag #{version_tag} and push repository to origin"
+task :tag do
+  unless `git branch` =~ / master$/
+    puts 'You must be on the master branch to release!'
+    exit!
+  end
+  if version_tag.end_with?('.dev')
+    puts 'You cannot tag and release a dev version!'
+    exit!
+  end
+
+  if `git tag`.split(/\n/).include?(version_tag)
+    puts "Tag #{version_tag} has already been created."
+  else
+    sh "git commit --allow-empty -a -m 'Release #{gem_version}'"
+    sh 'git push origin master'
+    sh "git tag #{version_tag}"
+    sh "git push origin #{version_tag}"
+  end
+end
+ 
+desc "Build #{gem_file}, create and push tag #{version_tag} and publish gem to RubyGems.org"
+task :release => [ :build, :tag ] do
+  sh "gem push pkg/#{gem_file}"
+end
+
+desc 'Run `spectator` to monitor changes and execute specs in TDD fashion'
+task :tdd do
+  sh 'spectator'
+end

data/awestruct.gemspec

@@ -0,0 +1,48 @@
+$:.push File.expand_path('../lib', __FILE__)
+require 'awestruct/version'
+
+spec = Gem::Specification.new do |s|
+  s.name          = 'awestruct'
+  s.version       = Awestruct::VERSION
+  s.date          = '2013-11-11'
+
+  s.authors       = ['Bob McWhirter', 'Jason Porter', 'Lance Ball', 'Dan Allen', 'Torsten Curdt', 'other contributors']
+  s.email         = ['bob@mcwhirter.org', 'lightguard.jp@gmail.com', 'lball@redhat.com', 'dan.j.allen@gmail.com', 'tcurdt@vafer.org']
+  s.homepage      = 'http://awestruct.org'
+  s.summary       = 'Static site baking and publishing tool'
+  s.description   = 'Awestruct is a static site baking and publishing tool. It supports an extensive list of both templating and markup languages via Tilt (Haml, Slim, AsciiDoc, Markdown, Sass via Compass, etc), provides mobile-first layout and styling via Bootstrap or Foundation, offers a variety of deployment options (rsync, git, S3), handles site optimizations (minification, compression, cache busting), includes built-in extensions such as blog post management and is highly extensible.'
+
+  s.rubyforge_project = s.name
+
+  s.license       = 'MIT'
+
+  s.platform      = Gem::Platform::RUBY
+
+  s.has_rdoc      = true
+  s.rdoc_options  = ['--charset=UTF-8']
+  s.extra_rdoc_files = 'README.md'
+
+  s.files         = `git ls-files -z -- {lib,man,spec}/* {README,LICENSE}* *{.gemspec,file}`.split("\0")
+  s.test_files    = s.files.select { |path| path =~ /^spec\/.*_spec\.rb/ }
+  s.executables   = `git ls-files -z -- bin/*`.split("\0").map {|f| File.basename f }
+  s.require_paths = ['lib']
+
+  s.requirements    = <<-EOS
+Any markup languages you are using and its dependencies.
+Haml and Markdown filters are touchy things. Redcarpet or Rdiscount work well if you're running on MRI. JRuby should be using haml 4.0.0+ with Kramdown.'
+  EOS
+
+  s.add_dependency 'haml', '~> 4.0.1'
+  s.add_dependency 'nokogiri', '1.5.10'
+  s.add_dependency 'tilt', '>= 1.3.6'
+  s.add_dependency 'compass', '>= 0.12.1'
+  s.add_dependency 'compass-960-plugin', '~> 0.10.4'
+  s.add_dependency 'bootstrap-sass', '>= 2.3.1.0'
+  s.add_dependency 'zurb-foundation', '>= 4.0.9'
+  s.add_dependency 'mime-types', '1.25'
+  s.add_dependency 'rest-client', '>= 1.6.7'
+  s.add_dependency 'ruby-s3cmd', '~> 0.1.5'
+
+  s.add_dependency 'listen', '~> 1.0'
+  s.add_dependency 'rack', '~> 1.5.2'
+end

data/lib/awestruct/cli/auto.rb

@@ -1,4 +1,5 @@
 #require 'guard/awestruct'
+require 'awestruct/util/exception_helper'
 
 require 'listen'
 
@@ -39,13 +40,11 @@ module Awestruct
                     engine.generate_page_by_output_path( path )
                     $LOG.info "Generating.... done!" if $LOG.info?
                   rescue => e
-                    $LOG.error e if $LOG.error?
-                    $LOG.error e.backtrace.join("\n") if $LOG.error?
+                    ExceptionHelper.log_building_error e, path
                   end
                 }
               rescue => e
-                $LOG.error e if $LOG.error?
-                $LOG.error e.backtrace.join("\n") if $LOG.error?
+                ExceptionHelper.log_building_error e, path
               end
             end
           end

data/lib/awestruct/cli/generate.rb

@@ -1,4 +1,5 @@
 require 'awestruct/engine'
+require 'awestruct/util/exception_helper'
 require 'compass'
 
 module Awestruct
@@ -19,8 +20,7 @@ module Awestruct
           $LOG.info "Generating site: #{base_url}" if $LOG.info?
           @engine.run( @profile, @base_url, @default_base_url, @force )
         rescue =>e
-          $LOG.error e if $LOG.error?
-          $LOG.error e.backtrace.join("\n") if $LOG.error?
+          ExceptionHelper.log_building_error e, ''
           return false
         end
       end

data/lib/awestruct/cli/manifest.rb

@@ -78,8 +78,8 @@ module Awestruct
           begin
             step.perform(dir)
           rescue => e
-            $LOG.error e if $LOG.error?
-            $LOG.error e.backtrace.join("\n") if $LOG.error?
+            ExceptionHelper.log_error e
+            ExceptionHelper.log_backtrace e
           end
         end
       end
@@ -89,8 +89,8 @@ module Awestruct
           begin
             step.unperform(dir)
           rescue => e
-            $LOG.error e if $LOG.error?
-            $LOG.error e.backtrace.join("\n") if $LOG.error?
+            ExceptionHelper.log_error e
+            ExceptionHelper.log_backtrace e
           end
         end
       end

data/lib/awestruct/deploy/base_deploy.rb

@@ -1,5 +1,7 @@
 require 'awestruct/deployers'
 require 'awestruct/compatibility'
+require 'awestruct/util/exception_helper'
+
 Dir[ File.join( File.dirname(__FILE__), '..', 'scm', '*.rb' ) ].each do |f|
   begin
     require f
@@ -18,6 +20,7 @@ module Awestruct
         # Add a single front slash at the end of output dir
         @site_path = File.join( site_config.output_dir, '/' ).gsub(/^\w:\//, '/')
         @gzip = deploy_config['gzip']
+        @gzip_level = deploy_config['gzip_level'] || Zlib::BEST_COMPRESSION
         @source_dir = deploy_config['source_dir'] || site_config.dir
         @ignore_uncommitted = deploy_config['uncommitted']
         init_scm(deploy_config['scm'] || 'git')
@@ -61,16 +64,16 @@ module Awestruct
             when :css, :js, :html
               require 'zlib'
               if !is_gzipped item
-                gzip_file item
+                gzip_file(item, @gzip_level)
               end
             end
           end
         end
       end
 
-      def gzip_file(filename)
+      def gzip_file(filename, level)
         $LOG.debug "Gzipping File #{filename}"
-        Zlib::GzipWriter.open("#{filename}.gz") do |gz|
+        Zlib::GzipWriter.open("#{filename}.gz", level) do |gz|
           gz.mtime = File.mtime(filename)
           gz.orig_name = filename
           gz.write File.binread(filename)
@@ -94,7 +97,7 @@ module Awestruct
           clazz = Object.const_get('Awestruct').const_get('Scm').const_get(type.capitalize)
           @scm = clazz.new
         rescue
-          $LOG.error( "Could not resolve class for scm type: #{type}" ) if $LOG.error?
+          ExceptionHelper.log_message( "Could not resolve class for scm type: #{type}" )
         end
       end
     end

data/lib/awestruct/deploy/github_pages_deploy.rb

@@ -1,4 +1,5 @@
 require 'awestruct/deploy/base_deploy'
+require 'awestruct/util/exception_helper'
 require 'git'
 
 module Awestruct
@@ -43,7 +44,7 @@ module Awestruct
           begin
             git.commit("Published #{@branch} to GitHub pages.")
           rescue ::Git::GitExecuteError => e
-            $LOG.error "Can't commit. #{e}." if $LOG.error?
+            ExceptionHelper.log_message "Can't commit. #{e}."
           end
         end
         git.reset_hard

data/lib/awestruct/engine.rb

@@ -327,6 +327,12 @@ module Awestruct
       full_path = File.join( '', path )
       page = site.pages.find{ |p| p.relative_source_path.to_s == full_path } ||
              site.layouts.find{ |p| p.relative_source_path.to_s == full_path }
+      #return if page.nil?
+
+      if ( page.nil? ) 
+        page = (site.partials||[]).find{ |p| p.relative_source_path.to_s == full_path }
+      end
+
       return if page.nil?
 
       if !page.output_path.nil?

data/lib/awestruct/extensions/partial.rb

@@ -18,6 +18,10 @@ module Awestruct
           page.send( "#{k}=", v )
         end if params
 
+        Awestruct::Dependencies.top_page.site.partials ||= []
+        Awestruct::Dependencies.top_page.site.partials << page
+        Awestruct::Dependencies.track_dependency( page )
+
         page.content
       end
 

data/lib/awestruct/extensions/relative.rb

@@ -1,3 +1,4 @@
+require 'awestruct/util/exception_helper'
 require 'pathname'
 
 module Awestruct
@@ -14,8 +15,7 @@ module Awestruct
           end
           result
         rescue Exception => e
-          $LOG.error "#{e}" if $LOG.error?
-          $LOG.error "#{e.backtrace.join("\n")}" if $LOG.error?
+          ExceptionHelper.log_building_error e, p.relative_source_path
         end
       end
 

data/lib/awestruct/extensions/sitemap.rb

@@ -3,6 +3,7 @@
 # Add a sitemap.yml file to add files that for one reason or
 # another won't be hanging off of site (e.g. they're in .htaccess)
 require 'ostruct'
+require 'awestruct/util/exception_helper'
 
 module Awestruct
   module Extensions
@@ -74,7 +75,7 @@ module Awestruct
               page.lastmod = date.strftime( "%Y-%m-%d" )
             end
           rescue Exception => e
-             $LOG.error "Cannot parse date #{date.to_s}: #{e}" if $LOG.error?
+            ExceptionHelper.log_building_error e, page.relative_source_path
           end
         else
           page.lastmod = Time.now.strftime( "%Y-%m-%d" )

data/lib/awestruct/handlers/base_tilt_handler.rb

@@ -1,3 +1,4 @@
+require 'awestruct/util/exception_helper'
 require 'awestruct/handlers/base_handler'
 
 require 'tilt'
@@ -118,21 +119,25 @@ module Awestruct
       end
 
       def rendered_content(context, with_layouts=true)
-        $LOG.debug "invoking tilt for #{delegate.path.to_s} with_layouts = #{with_layouts}" if $LOG.debug?
+        $LOG.debug "invoking tilt for #{delegate.path} with_layouts = #{with_layouts}" if $LOG.debug?
+
         begin
+          c = delegate.rendered_content(context, with_layouts)
+          return "" if c.nil? or c.empty?
           template = Tilt::new(delegate.path.to_s, delegate.content_line_offset + 1, options) { |engine|
-            delegate.rendered_content(context, with_layouts)
+            c
           }
           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>"
+          ExceptionHelper.log_message "Could not load template library required for rendering #{File.join site.dir, relative_source_path}."
+          ExceptionHelper.log_message "Please see #{File.join site.dir, output_path} for more information"
+          return ExceptionHelper.html_error_report e, relative_source_path
         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>"
+          ExceptionHelper.log_message "An error during rendering #{File.join site.dir, relative_source_path} occurred."
+          ExceptionHelper.log_message "Please see #{File.join site.dir, output_path} for more information"
+          return ExceptionHelper.html_error_report e, relative_source_path
         end
       end
-
     end
   end
 end