awestruct 0.5.4.beta1 → 0.5.4.rc

data/lib/awestruct/frameworks/base_Rakefile

@@ -41,7 +41,7 @@
 # Now you're Awestruct with rake!
 
 $use_bundle_exec = true
-$install_gems = ['awestruct -v "~> 0.5.0"', 'rb-inotify -v "~> 0.9.0"']
+$install_gems = ['awestruct -v "~> 0.5.4.rc"', 'rb-inotify -v "~> 0.9.0"']
 $awestruct_cmd = nil
 task :default => :preview
 
@@ -161,8 +161,27 @@ task :check => :init do
 end
 
 # Execute Awestruct
-def run_awestruct(args)
-  system "#{$use_bundle_exec ? 'bundle exec ' : ''}awestruct #{args}" 
+def run_awestruct(args, opts = {})
+  cmd = "#{$use_bundle_exec ? 'bundle exec ' : ''}awestruct #{args}"
+  if RUBY_VERSION < '1.9'
+    opts[:spawn] = false
+  else
+    opts[:spawn] ||= true
+  end
+
+  puts "Running command: #{cmd}"
+  if opts[:spawn]
+    pid = spawn cmd
+    Signal.trap(:INT) {
+      # wait for rack server to receive signal and shutdown
+      Process.wait pid
+      # now we go down
+      exit
+    }
+    Process.wait pid
+  else
+    system cmd
+  end
 end
 
 # A cross-platform means of finding an executable in the $PATH.

data/lib/awestruct/handlers/asciidoctor_handler.rb

@@ -40,6 +40,7 @@ module Awestruct
       CHAIN = Awestruct::HandlerChain.new( Awestruct::Handlers::AsciidoctorTiltMatcher.new(),
         Awestruct::Handlers::FileHandler,
         Awestruct::Handlers::FrontMatterHandler,
+        Awestruct::Handlers::InterpolationHandler,
         Awestruct::Handlers::AsciidoctorHandler,
         Awestruct::Handlers::LayoutHandler
       )
@@ -47,13 +48,19 @@ module Awestruct
       def initialize(site, delegate)
         super( site, delegate )
 
+        @site = site
         @front_matter = {}
       end
 
 
       def front_matter
         parse_header()
-        @front_matter.merge @delegate.front_matter if @delegate
+        if @delegate
+          @front_matter.update @delegate.front_matter
+          # push front matter forward as well
+          @delegate.front_matter.replace @front_matter
+          @front_matter
+        end
       end
 
       def raw_content
@@ -68,29 +75,49 @@ module Awestruct
 
       def rendered_content(context, with_layouts)
         parse_header()
+        front_matter_ref = front_matter
         types = [String, Numeric, TrueClass, FalseClass, Array]
-        @front_matter.merge!(context.page.inject({}) do |hash, (k,v)|
+        front_matter_ref.update(context.page.inject({}) {|hash, (k,v)|
           hash[k.to_s] = v if not k.to_s.start_with?('__') and types.detect { |t| v.kind_of? t }
           hash
-        end)
+        })
         if with_layouts && !context.page.layout
-          @front_matter['header_footer'] = true
+          front_matter_ref['header_footer'] = true
         end
         super
       end
 
       def options
         opts = super
-        if opts[:attributes].nil?
-          opts[:attributes] = @front_matter 
-        else
-          opts[:attributes] = opts[:attributes].merge @front_matter
-        end
+        opts[:attributes] ||= {}
+        opts[:attributes].update(@front_matter.inject({}) {|collector, (key,val)|
+          collector["page-#{key}"] = "#{val}@"
+          collector
+        })
+        # Keep only values that can be coerced to as string
+        types = [String, Numeric, TrueClass, FalseClass, Date, Time]
+        opts[:attributes].update(@site.inject({}) {|collector, (key,val)|
+          collector["site-#{key}"] = "#{val}@" if types.detect {|t| val.kind_of? t }
+          collector
+        })
         opts[:attributes]['awestruct'] = true
         opts[:attributes]['awestruct-version'] = Awestruct::VERSION
         if @front_matter['header_footer']
           opts[:header_footer] = true
         end
+        path_expanded = File.expand_path path
+        opts[:attributes]['docdir'] = File.dirname path_expanded
+        opts[:attributes]['docfile'] = path_expanded
+        opts[:attributes]['docname'] = simple_name
+        path_mtime = path.mtime
+        opts[:attributes]['docdate'] = docdate = path_mtime.strftime('%Y-%m-%d')
+        opts[:attributes]['doctime'] = doctime = path_mtime.strftime('%H:%M:%S %Z')
+        opts[:attributes]['docdatetime'] = %(#{docdate} #{doctime})
+        # TODO once Asciidoctor 1.5.0 is release, we should set the base_dir as a jail
+        # we can't do this before 1.5.0 due to a bug in how includes are resolved
+        if (Object.const_defined? 'Asciidoctor') && Asciidoctor::VERSION >= '1.5.0'
+          opts[:base_dir] ||= @site.config.dir
+        end
         opts
       end
 
@@ -116,8 +143,9 @@ module Awestruct
       end
 
       def parse_document_attributes(content)
+        warned = false
         template = Tilt::new(delegate.path.to_s, delegate.content_line_offset + 1, options)
-        template.parse_headers(content, /^awestruct\-/).inject({}) do |hash, (k,v)|
+        template.parse_headers(content, /^(?:page|awestruct)\-(?=.)/).inject({'interpolate' => false}) do |hash, (k,v)|
           unless v.nil?
             hash[k] = v.empty? ? v : YAML.load(v)
             if hash[k].kind_of? Time

data/lib/awestruct/handlers/front_matter_handler.rb

@@ -51,35 +51,40 @@ module Awestruct
         dash_lines = 0
         mode = :yaml
 
-        @raw_content = ''
+        @raw_content = nil
         @content_line_offset = 0
 
+        first_line = true
         full_content.each_line do |line|
-          if ( line.strip == '---' )
-            dash_lines = dash_lines +1
+          if line.rstrip == '---' && mode == :yaml
+            unless first_line
+              @content_line_offset += 1
+              yaml_content << line
+              mode = :page
+              next
+            end
+          elsif first_line
+            mode = :page
           end
-          if ( mode == :yaml )
+
+          if mode == :yaml
             @content_line_offset += 1
             yaml_content << line
+          elsif @raw_content.nil?
+            @raw_content = line
           else
             @raw_content << line
           end
-          if ( dash_lines == 2 )
-            mode = :page
-          end
+          first_line = false
         end
   
-        if ( dash_lines == 0 )
-          @raw_content = yaml_content
-          yaml_content = ''
-          @content_line_offset = 0
-        elsif ( mode == :yaml )
+        if mode == :yaml
           @raw_content = nil
           @content_line_offset = -1
         end
 
         begin
-          @front_matter = YAML.load( yaml_content ) || {}
+          @front_matter = yaml_content.empty? ? {} : (YAML.load yaml_content)
         rescue => e
           $LOG.error "could not parse #{relative_source_path}" if $LOG.error?
           raise e

data/lib/awestruct/handlers/interpolation_handler.rb

@@ -13,7 +13,7 @@ module Awestruct
         content = delegate.raw_content
 
         return nil if content.nil?
-        return content unless site.interpolate
+        return content unless front_matter.fetch('interpolate', site.interpolate)
 
         content = content.gsub( /\\/, '\\\\\\\\' )
         content = content.gsub( /\\\\#/, '\\#' )

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

@@ -33,7 +33,28 @@ module Tilt
 
       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?
+      if (cnt = doc.attributes['authorcount'].to_i) > 1
+        authors = []
+        (1..cnt).each do |idx|
+          author = {}
+          author[:name] = doc.attributes["author_#{idx}"]
+          if doc.attributes.has_key? "email_#{idx}"
+            author[:email] = doc.attributes["email_#{idx}"]
+          end
+          authors << author
+        end
+        filtered['author'] = authors.first[:name]
+        filtered['email'] = authors.first[:email] if authors.first.has_key? :email
+        filtered['authors'] = authors.to_yaml
+      elsif !doc.attributes['author'].nil?
+        author = {}
+        author[:name] = doc.attributes['author']
+        if doc.attributes.has_key? 'email'
+          author[:email] = doc.attributes['email']
+        end
+        filtered['author'] = author[:name]
+        filtered['authors'] = [author].to_yaml
+      end
 
       filtered
     end

data/lib/awestruct/page_loader.rb

@@ -46,7 +46,7 @@ module Awestruct
         unless path.directory?
           $LOG.debug "loading #{relative_path}" if (site.config.verbose) if $LOG.debug?
           page = load_page( path, prepare )
-          if ( page && !page.draft )
+          if ( page && (!page.draft || @site.show_drafts) )
             $LOG.debug "loaded! #{path} and added to site" if $LOG.debug?
             #inherit_front_matter( page )
             site.send( @target ) << page

data/lib/awestruct/version.rb

@@ -1,4 +1,4 @@
 
 module Awestruct
-  VERSION='0.5.4.beta1'
+  VERSION='0.5.4.rc'
 end

data/spec/asciidoc_handler_spec.rb

@@ -15,6 +15,13 @@ verify_front_matter = lambda { |output, page|
 verify_headers = lambda { |output, page|
   extend RSpec::Matchers
   page.author.should == 'Stuart Rackham'
+  page.email.should == 'srackham@example.com'
+  page.authors.should_not be_nil
+  page.authors.size.should == 2
+  page.authors.first.name.should == 'Stuart Rackham'
+  page.authors.first.email.should == 'srackham@example.com'
+  page.authors.last.name.should == 'Dan Allen'
+  page.authors.last.email.should be_nil
   page.title.should == 'AsciiDoc'
   page.doctitle.should == 'AsciiDoc'
   page.name.should == 'Awestruct'
@@ -22,8 +29,28 @@ verify_headers = lambda { |output, page|
   page.tags.should be_a_kind_of(Array)
   page.tags.should == %w(a b c)
   page.date.should be_a_kind_of(Date)
-  output.should =~ %r(This is <strong>AsciiDoc</strong> in Awestruct.)
+  output.should =~ %r(This is <strong>AsciiDoc</strong> page named Awestruct in an Awestruct site.)
   output.should =~ %r(#{Awestruct::VERSION})
+  output.should =~ %r(UTF-8)
+}
+
+verify_attributes = lambda { |output, page|
+  extend RSpec::Matchers
+  expect(output).to RSpec::Matchers::BuiltIn::Include.new("docname=#{page.simple_name};")
+  expect(output).to RSpec::Matchers::BuiltIn::Include.new("docfile=#{File.expand_path page.source_path};")
+  expect(output).to RSpec::Matchers::BuiltIn::Include.new("docdir=#{File.expand_path File.dirname(page.source_path)};")
+}
+
+verify_interpolation = lambda { |output, page|
+  extend RSpec::Matchers
+  output.should =~ %r(UTF-8)
+  page.site.interpolate.should == true
+}
+
+verify_no_interpolation = lambda { |output, page|
+  extend RSpec::Matchers
+  output.should =~ %r(\#\{site\.encoding\})
+  page.site.interpolate.should == true
 }
 
 theories =
@@ -62,6 +89,29 @@ theories =
             :syntax => :asciidoc,
             :extension => '.html',
             :matcher => verify_headers
+        },
+        {
+            :page => 'asciidoc_with_attributes.ad',
+            :simple_name => 'asciidoc_with_attributes',
+            :syntax => :asciidoc,
+            :extension => '.html',
+            :matcher => verify_attributes
+        },
+        {
+            :page => 'asciidoc_with_interpolation.ad',
+            :simple_name => 'asciidoc_with_interpolation',
+            :syntax => :asciidoc,
+            :extension => '.html',
+            :matcher => verify_interpolation,
+            :site_overrides => { :interpolate => true }
+        },
+        {
+            :page => 'asciidoc_without_interpolation.ad',
+            :simple_name => 'asciidoc_without_interpolation',
+            :syntax => :asciidoc,
+            :extension => '.html',
+            :matcher => verify_no_interpolation,
+            :site_overrides => { :interpolate => true }
         }
     ]
 

data/spec/awestruct/scm/git_spec.rb

@@ -1,5 +1,5 @@
 require 'spec_helper'
-require 'awestruct/scm/git'
+require 'awestruct/deploy/base_deploy'
 
 describe Awestruct::Scm::Git do
   specify 'should respond_to :uncommitted_changes?' do
@@ -26,4 +26,4 @@ describe Awestruct::Scm::Git do
       expect(subject.uncommitted_changes? '.').to be_true
     end
   end
-end
+end

data/spec/coffeescript_handler_spec.rb

@@ -17,7 +17,5 @@ theories =
   ]
 
 describe Awestruct::Handlers::TiltHandler.to_s + "-CoffeeScript" do
-  
   it_should_behave_like "a handler", theories
-
-end
+end

data/spec/deploy_spec.rb

@@ -1,4 +1,4 @@
-
+require 'spec_helper'
 require 'awestruct/cli/deploy'
 
 describe Awestruct::CLI::Deploy do
@@ -38,4 +38,69 @@ describe Awestruct::CLI::Deploy do
     deployer.deploy_type.should == :github_pages
   end
 
+  it "should gzip if deploy['gzip'] is true" do
+    site_config = mock
+    site_config.stub(:output_dir).and_return '_site'
+
+    deploy_config = mock
+    deploy_config.stub(:[]).with('gzip').and_return true
+    deploy_config.stub(:[]).with('source_dir').and_return '.'
+    deploy_config.stub(:[]).with('scm').and_return nil
+    deploy_config.stub(:[]).with('uncommitted').and_return true
+
+    deployer = Awestruct::Deploy::Base.new(site_config, deploy_config)
+    deployer.should_receive(:gzip_site)
+    deployer.run
+  end
+
+  it "should only gzip html, css and js files" do
+    site_tmp_dir = Dir.mktmpdir("site_dir")
+    site_src_dir = File.join(File.dirname(__FILE__), 'test-data/gzip')
+    FileUtils.cp_r(site_src_dir, site_tmp_dir)
+    site_dir = "#{site_tmp_dir}/gzip"
+
+    site_config = mock
+    site_config.stub(:output_dir).and_return "#{site_dir}"
+
+    deploy_config = mock
+    deploy_config.stub(:[]).with('gzip').and_return true
+    deploy_config.stub(:[]).with('source_dir').and_return '.'
+    deploy_config.stub(:[]).with('scm').and_return nil
+    deploy_config.stub(:[]).with('uncommitted').and_return nil
+
+    deployer = Awestruct::Deploy::Base.new(site_config, deploy_config)
+    deployer.should_receive(:gzip_file).with("#{site_dir}/yes.html")
+    deployer.should_receive(:gzip_file).with("#{site_dir}/yes.js")
+    deployer.should_receive(:gzip_file).with("#{site_dir}/subdir/yes.css")
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/no.txt")
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/no.html.gz")
+    deployer.gzip_site(site_dir)
+  end
+
+  it "should gzip only once" do
+    site_tmp_dir = Dir.mktmpdir("site_dir")
+    site_src_dir = File.join(File.dirname(__FILE__), 'test-data/gzip')
+    FileUtils.cp_r(site_src_dir, site_tmp_dir)
+    site_dir = "#{site_tmp_dir}/gzip"
+
+    site_config = mock
+    site_config.stub(:output_dir).and_return "#{site_dir}"
+
+    deploy_config = mock
+    deploy_config.stub(:[]).with('gzip').and_return true
+    deploy_config.stub(:[]).with('source_dir').and_return '.'
+    deploy_config.stub(:[]).with('scm').and_return nil
+    deploy_config.stub(:[]).with('uncommitted').and_return nil
+
+    deployer = Awestruct::Deploy::Base.new(site_config, deploy_config)
+    deployer.gzip_site(site_dir)
+
+    # Gzip only once
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/yes.html")
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/yes.js")
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/subdir/yes.css")
+    deployer.should_not_receive(:gzip_file).with("#{site_dir}/no.txt")
+    deployer.gzip_site(site_dir)
+  end
+
 end

data/spec/engine_spec.rb

@@ -16,6 +16,7 @@ describe Awestruct::Engine do
     engine.site.asciidoctor.backend.should == 'html5'
     engine.site.asciidoctor.safe.should == 1
     engine.site.asciidoctor.attributes['imagesdir'].should == '/images'
+    engine.site.profiles.development.show_drafts.should == true
   end
 
   it "should be able to override default with site" do
@@ -25,12 +26,13 @@ describe Awestruct::Engine do
 
     engine = Awestruct::Engine.new(config)
     engine.load_default_site_yaml
-    engine.load_site_yaml( 'development' )
+    engine.load_user_site_yaml( 'development' )
 
     engine.site.asciidoctor.safe.should == 0
     engine.site.asciidoctor.eruby.should == 'erubis'
     engine.site.asciidoctor.attributes['imagesdir'].should == '/assets/images'
     engine.site.asciidoctor.attributes['idprefix'].should == ''
+    engine.site.show_drafts.should == false
   end
 
   it "should be able to load site.yml with the correct profile" do
@@ -40,17 +42,19 @@ describe Awestruct::Engine do
 
     engine = Awestruct::Engine.new(config)
     engine.load_default_site_yaml
-    engine.load_site_yaml( 'development' )
+    engine.load_user_site_yaml( 'development' )
     engine.site.cook.should == 'microwave'
     engine.site.title.should == 'Awestruction!'
+    engine.site.show_drafts.should == false
 
     engine = Awestruct::Engine.new(config)
     engine.load_default_site_yaml
-    engine.load_site_yaml( 'production' )
+    engine.load_user_site_yaml( 'production' )
     engine.site.cook.should == 'oven'
     engine.site.title.should == 'Awestruction!'
     engine.site.asciidoctor.eruby.should == 'erb'
     engine.site.asciidoctor.attributes['imagesdir'].should == '/img'
+    engine.site.show_drafts.should == true
   end
 
   it "should be able to load arbitrary _config/*.yml files" do
@@ -81,7 +85,7 @@ describe Awestruct::Engine do
     opts.source_dir = File.dirname(__FILE__) + '/test-data/engine'
     config = Awestruct::Config.new( opts )
     engine = Awestruct::Engine.new(config)
-    engine.load_site_yaml( 'production' )
+    engine.load_user_site_yaml( 'production' )
     Compass.stub(:configuration).and_return(compass)
     compass.should_receive(:line_comments=).with(false)
     compass.stub(:line_comments).and_return(false)
@@ -102,7 +106,7 @@ describe Awestruct::Engine do
     opts.source_dir = File.dirname(__FILE__) + '/test-data/engine'
     config = Awestruct::Config.new( opts )
     engine = Awestruct::Engine.new(config)
-    engine.load_site_yaml( 'development' )
+    engine.load_user_site_yaml( 'development' )
     Compass.stub(:configuration).and_return(compass)
     compass.should_receive(:line_comments=).with(true)
     compass.stub(:line_comments).and_return(true)
@@ -123,7 +127,7 @@ describe Awestruct::Engine do
     opts.source_dir = File.dirname(__FILE__) + '/test-data/engine'
     config = Awestruct::Config.new( opts )
     engine = Awestruct::Engine.new(config)
-    engine.load_site_yaml( 'staging' )
+    engine.load_user_site_yaml( 'staging' )
     Compass.stub(:configuration).and_return(compass)
     compass.should_receive(:line_comments=).with(false)
     compass.stub(:line_comments).and_return(false)