awestruct 0.5.7 → 0.6.0.RC1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 24c840fbe2701d3bc0b3d4d123511d086c984959
-  data.tar.gz: ef9ff0655b1c9c8641b59a9b97900de62b40f8c8
+  metadata.gz: '0399037b69ee735bc1afbad093fdc95faa02c153'
+  data.tar.gz: 5bd7ff867e171dd6d96ff218438a5ef0e5b66f53
 SHA512:
-  metadata.gz: d9bcb190ec4213a565778883fe1bc9ae656439ae27ae096cf6185bd48e5b5f9b6c0e8ece38767d543242c5625e22915cbe3e1a30a7e29dde46312f0fce413859
-  data.tar.gz: 3444c4427e1101927cc7cd7e9bdaf193dac163bf8ed52a7ef264aad4b809d93c07ca9b5ba8e5111374f5d0a34665031627b41ede42a77f4a0eb2e876da0c86f1
+  metadata.gz: ab3587a8d9d0bf6d8c129476e2ae598452e5952ba0bea7dfabd603fcd8732974da8db6742864d6fa167bd339d7db73a642b01cf4b23fb5a2d0283d32feae2c12
+  data.tar.gz: 9bd1ab9df76ea3c7fb2feb6ef1b4822fa2c19c2f3b52544dc0fbdbf72ad94a6b4eadeba6d482f533868adfcd3c4714473eabed9db0ee328c0f0fc8d32048cbd0

data/Gemfile

@@ -1,4 +1,5 @@
 source 'https://rubygems.org'
+ruby '>= 2.4.0'
 
 group :development do
   gem 'hashery', '~> 2.1.1'
@@ -29,6 +30,8 @@ group :test do
   gem 'sass'
   gem 'bootstrap-sass'
   gem 'zurb-foundation'
+  gem 'rspec'
+  gem 'rspec_runner'
   gem "win32-open3-19", :platforms => :mingw # htmlcompressor depends on old yui compressor, that needs this on win32
 end
 

data/LICENSE.txt

@@ -1,18 +1,21 @@
-Copyright (c) 2010-2014 Bob McWhirter and contributors (see git log)
+MIT License
+
+Copyright (c) 2010-2019 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
+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 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.
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS 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

@@ -1,12 +1,21 @@
-[![Build Status](https://secure.travis-ci.org/awestruct/awestruct.png)](http://travis-ci.org/awestruct/awestruct)
+# Awestruct
+[![Gem](https://img.shields.io/gem/v/awestruct)](https://rubygems.org/gems/awestruct)
+[![Gem](https://img.shields.io/gem/dt/awestruct?color=blue)](https://rubygems.org/gems/awestruct)
+[![Build Status](https://secure.travis-ci.org/awestruct/awestruct.png)](https://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/)
+## Requirements
 
-# For more information
+Ruby 2.4 or later
+
+## Getting started
+
+Install Awestruct using `gem install awestruct`. Then you can initialize an Awestruct projet by running `awestruct --init`. To generate the static site use `awestruct generate`.
+
+## For more information
 
 Please see the complete site at <http://awestruct.org/>.
 
-# License
+## License
 
     Copyright (c) 2010-2014 Bob McWhirter and contributors (see git log)
 

data/awestruct.gemspec

@@ -4,7 +4,7 @@ require 'awestruct/version'
 spec = Gem::Specification.new do |s|
   s.name          = 'awestruct'
   s.version       = Awestruct::VERSION
-  s.date          = '2016-02-09'
+  s.date          = '2020-01-21'
 
   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']
@@ -17,13 +17,13 @@ spec = Gem::Specification.new do |s|
   s.license       = 'MIT'
 
   s.platform      = Gem::Platform::RUBY
-  s.required_ruby_version = '>= 2.0'
+  s.required_ruby_version = '>= 2.4.0'
 
   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.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']
@@ -34,25 +34,24 @@ Haml and Markdown filters are touchy things. Redcarpet or Rdiscount work well if
 Compass and sass are no longer hard dependencies. You'll need too add them on your own should you want them. We also should be able to work with sassc.
   EOS
 
-  s.add_dependency 'haml', '~> 4.0', '>= 4.0.5'
+  s.add_dependency 'haml', '>= 4.0.5', '< 6.0'
   s.add_dependency 'asciidoctor', '~> 1.5', '>= 1.5.2'
   s.add_dependency 'tilt', '~> 2.0', '>= 2.0.1'
-  s.add_dependency 'mime-types', '~> 2.1'
-  s.add_dependency 'rest-client', '~> 1.7', '>= 1.7.2'
-  s.add_dependency 'listen', '>= 2.7.1', '<= 4.0'
-  s.add_dependency 'rack', '~> 1.5', '>= 1.5.2'
+  s.add_dependency 'mime-types', '~> 3.0'
+  s.add_dependency 'rest-client', '~> 2.0'
+  s.add_dependency 'listen', '~> 3.1'
+  s.add_dependency 'rack', '~> 2.0'
   s.add_dependency 'git', '~> 1.2', '>= 1.2.6'
-  s.add_dependency 'guard', '~> 2.13', '>= 2.13.0'
-  s.add_dependency 'guard-livereload', '~> 2.1', '>= 2.1.2'
-  # s.add_dependency 'colorize', '~> 0.7', '>= 0.7.1'
-  s.add_dependency 'logging', '~> 2.0'
-  s.add_dependency 'oga', '~> 1.3'
-  s.add_dependency 'parallel', '~> 1.1', '> 1.1.1'
-
-  s.add_development_dependency 'nokogiri', '~> 1.5.0','>= 1.5.10'
+  s.add_dependency 'guard', '~> 2.0', '>= 2.13.0'
+  s.add_dependency 'guard-livereload', '~> 2.0', '>= 2.1.2'
+  s.add_dependency 'logging', '~> 2.2'
+  s.add_dependency 'oga', '~> 2.0'
+  s.add_dependency 'parallel', '~> 1.0', '> 1.1.1'
+
+  s.add_development_dependency 'nokogiri', '>= 1.5.10'
   s.add_development_dependency 'compass-960-plugin', '~> 0.10','>= 0.10.4'
-  s.add_development_dependency 'bootstrap-sass', '~> 3', '>= 3.2.0.2'
-  s.add_development_dependency 'zurb-foundation', '~> 4.3.2', '>= 4.3.2'
-  s.add_development_dependency 'rspec', '~> 3.0'
-  s.add_development_dependency 'guard-rspec', '~> 4.0'
+  s.add_development_dependency 'bootstrap-sass', '>= 3.2.0.2'
+  s.add_development_dependency 'zurb-foundation', '>= 4.3.2'
+  s.add_development_dependency 'rspec', '>= 3.0'
+  s.add_development_dependency 'guard-rspec', '>= 4.0'
 end

data/lib/awestruct/cli/invoker.rb

@@ -97,7 +97,7 @@ module Awestruct
           abort( "No config file at #{site_yaml_file}" )
         end
 
-        site_yaml = YAML.load( ERB.new(File.read( site_yaml_file )).result )
+        site_yaml = YAML.load( ERB.new(File.read( site_yaml_file ), nil, '<>').result )
 
         if ( !site_yaml )
           abort( "Failed to parse #{site_yaml_file}" )
@@ -130,7 +130,9 @@ module Awestruct
         @config = Awestruct::Config.new( @options )
         @config.track_dependencies = true if ( @options.auto )
         @config.verbose = true if ( @options.verbose )
-        @config.quiet = true if ( @options.quiet )
+        @config.debug = @options.debug
+        @config.quiet = true if @options.quiet
+        @config.perf = true if @options.perf_log
       end
 
       def invoke_init()

data/lib/awestruct/cli/manifest.rb

@@ -77,8 +77,7 @@ module Awestruct
 
       def load_gem(add_compass = false)
         spec = {:dependencies => {}}
-        gem_spec = Gem::Specification::load(
-          File.join(File.dirname(__FILE__), "../../../", "awestruct.gemspec"))
+        gem_spec = Gem::Specification.find_all_by_name('awestruct').last # Make sure we have the latest version
 
         if add_compass
           gem_spec.add_dependency('compass', '>= 1.0.1')

data/lib/awestruct/cli/options.rb

@@ -36,7 +36,7 @@ module Awestruct
       def initialize(opts = {})
         default_opts = { server: false, port: DEFAULT_PORT, bind_addr: DEFAULT_BIND_ADDR, auto: false, force: false,
                          init: false, framework: 'compass', scaffold: true, base_url: DEFAULT_BASE_URL, deploy: false,
-                         verbose: false, quiet: false, livereload: false, source_dir: Dir.pwd,
+                         verbose: false, quiet: false, livereload: false, source_dir: Dir.pwd, debug: false,
                          output_dir: File.expand_path('_site'), generate_on_access: DEFAULT_GENERATE_ON_ACCESS,
                          perf_log: false
                        }.merge opts
@@ -60,6 +60,7 @@ module Awestruct
         @output_dir = default_opts[:output_dir]
         @generate_on_access = default_opts[:generate_on_access]
         @perf_log = default_opts[:perf_log]
+        @debug = default_opts[:debug]
       end
 
       def self.parse!(args)

data/lib/awestruct/config.rb

@@ -21,6 +21,8 @@ module Awestruct
     attr_accessor :verbose
     attr_accessor :quiet
     attr_accessor :options
+    attr_accessor :debug
+    attr_accessor :perf
 
     def initialize(opts = Awestruct::CLI::Options.new)
       @dir             = Pathname.new(File.expand_path(Pathname.new( opts.source_dir )))
@@ -35,6 +37,9 @@ module Awestruct
       @stylesheets_dir = Pathname.new( File.join(@dir, 'stylesheets') )
 
       @options = opts
+      @verbose = opts.verbose
+      @debug = opts.debug
+      @perf = opts.perf_log
 
       # Dir[] doesn't like empty list
       ignore_file = File.join(@dir, ".awestruct_ignore")

data/lib/awestruct/config/default-site.yml

@@ -42,8 +42,7 @@ asciidoctor:
 textile:
   :no_span_caps: true
 
-generation:
-  :in_theads: <%= Parallel.processor_count * 10 %>
+generation: {}
 
 profiles:
   development:

data/lib/awestruct/context_helper.rb

@@ -40,10 +40,10 @@ module Awestruct
 
     def fully_qualify_urls(base_url, text)
       begin
-        doc = Oga.parse_html text
+        doc = Oga.parse_xml text
 
         doc.each_node do |elem|
-          if elem.is_a?(Oga::XML::Element) && elem.html?
+          if elem.is_a?(Oga::XML::Element)
             case elem.name
             when 'a'
               elem.set 'href', fix_url(base_url, elem.get('href')) if elem.get('href')

data/lib/awestruct/engine.rb

@@ -54,72 +54,72 @@ module Awestruct
 
     def run(profile, base_url, default_base_url, force=false, generate=true)
       start_time = DateTime.now
-      $LOG.verbose 'adjust_load_path'
+      $LOG.verbose 'adjust_load_path' if config.verbose
       adjust_load_path
-      $LOG.trace "Total time in adjust_load_path: #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in adjust_load_path: #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'load_default_site_yaml'
+      $LOG.verbose 'load_default_site_yaml' if config.verbose
       start_time = DateTime.now
       load_default_site_yaml( profile )
-      $LOG.trace "Total time in load_default_site_yaml #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in load_default_site_yaml #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'load_user_site_yaml -- profile'
+      $LOG.verbose 'load_user_site_yaml -- profile' if config.verbose
       start_time = DateTime.now
       load_user_site_yaml( profile )
-      $LOG.trace "Total time in load_user_site_yaml #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in load_user_site_yaml #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'set_base_url'
+      $LOG.verbose 'set_base_url' if config.verbose
       start_time = DateTime.now
       set_base_url( base_url, default_base_url )
-      $LOG.trace "Total time in set_base_url #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in set_base_url #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'load_yamls'
+      $LOG.verbose 'load_yamls' if config.verbose
       start_time = DateTime.now
       load_yamls
-      $LOG.trace "Total time in load_yamls #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in load_yamls #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'load_pipeline'
+      $LOG.verbose 'load_pipeline' if config.verbose
       start_time = DateTime.now
       load_pipeline
-      $LOG.trace "Total time in load_pipeline #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in load_pipeline #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'load_pages'
+      $LOG.verbose 'load_pages' if config.verbose
       start_time = DateTime.now
       load_pages
-      $LOG.trace "Total time in load_pages #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in load_pages #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'execute_pipeline'
-      $LOG.info 'Excecuting pipeline...'
+      $LOG.verbose 'execute_pipeline' if config.verbose
+      $LOG.info 'Executing pipeline...'
       start_time = DateTime.now
       execute_pipeline(false)
-      $LOG.trace "Total time in execute_pipeline #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in execute_pipeline #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
       begin
         if defined?(::Compass)
-          $LOG.verbose 'configure_compass'
+          $LOG.verbose 'configure_compass' if config.verbose
           start_time = DateTime.now
           configure_compass
-          $LOG.trace "Total time in configure_compass #{DateTime.now.to_time - start_time.to_time} seconds"
+          $LOG.trace "Total time in configure_compass #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
         end
       rescue LoadError
         # doesn't matter if we can't load it
       end
-      $LOG.verbose 'set_urls'
+      $LOG.verbose 'set_urls' if config.verbose
       start_time = DateTime.now
       set_urls( site.pages )
-      $LOG.trace "Total time in set_urls #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in set_urls #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
-      $LOG.verbose 'build_page_index'
+      $LOG.verbose 'build_page_index' if config.verbose
       start_time = DateTime.now
       build_page_index
-      $LOG.trace "Total time in build_page_index #{DateTime.now.to_time - start_time.to_time} seconds"
+      $LOG.trace "Total time in build_page_index #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
 
       if generate
-        $LOG.debug 'generate_output'
+        $LOG.debug 'generate_output' if config.debug
         $LOG.info 'Generating pages...'
         start_time = DateTime.now
         generate_output
-        $LOG.trace "Total time in generate_output #{DateTime.now.to_time - start_time.to_time} seconds"
+        $LOG.trace "Total time in generate_output #{DateTime.now.to_time - start_time.to_time} seconds" if config.perf
       end
       Awestruct::ExceptionHelper::EXITCODES[:success]
     end
@@ -181,7 +181,7 @@ module Awestruct
     def load_site_yaml(yaml_path, profile = nil)
       if File.exist?(yaml_path)
         begin
-          data = YAML.load( ERB.new(File.read( yaml_path, :encoding => 'bom|utf-8' )).result )
+          data = YAML.load( ERB.new(File.read( yaml_path, :encoding => 'bom|utf-8' ), nil, '<>').result )
           if profile
             # JP: Interpolation now turned off by default, turn it per page if needed
             site.interpolate = false
@@ -211,7 +211,7 @@ module Awestruct
 
     def load_yaml(yaml_path)
       begin
-        data = YAML.load( ERB.new(File.read( yaml_path )).result )
+        data = YAML.load( ERB.new(File.read( yaml_path ), nil, '<>').result )
       rescue Exception => e
         ExceptionHelper.log_building_error e, yaml_path
         ExceptionHelper.mark_failed
@@ -267,7 +267,7 @@ module Awestruct
 
     def set_urls(pages)
       pages.each do |page|
-        $LOG.debug "relative_source_path #{page.relative_source_path}"
+        $LOG.debug "relative_source_path #{page.relative_source_path}" if config.debug
         page_path = page.output_path
         if page_path =~ /^\//
           page.url = page_path
@@ -324,21 +324,21 @@ module Awestruct
         config.environment = site.profile
         config.project_path = site.config.dir
         config.sass_path = File.join(config.project_path, 'stylesheets')
-        config.http_path = site.base_url || site.config.options.base_url || '/'
+        config.asset_host = lambda { |_| site.base_url || site.config.options.base_url || '/' }
         config.css_path = File.join(site.output_dir, 'stylesheets')
         config.javascripts_path = File.join(site.output_dir, 'javascripts')
-        config.http_javascripts_dir = File.join(config.http_path, 'javascripts')
-        config.http_stylesheets_dir = File.join(config.http_path, 'stylesheets')
+        config.http_javascripts_dir = 'javascripts'
+        config.http_stylesheets_dir = 'stylesheets'
         config.sprite_load_path = [config.images_path]
-        config.http_images_dir = File.join(config.http_path, 'images')
+        config.http_images_dir = 'images'
         config.images_path = File.join(config.project_path, 'images')
         config.fonts_dir = 'fonts'
         config.fonts_path = File.join(config.project_path, 'fonts')
-        config.http_fonts_dir = File.join(config.http_path, 'fonts')
+        config.http_fonts_dir = 'fonts'
 
         if config.generated_images_dir == config.default_for('generated_images_dir')
           config.generated_images_dir = File.join(site.output_dir, 'images')
-          config.http_generated_images_dir = File.join(config.http_path, 'images')
+          config.http_generated_images_dir = 'images'
         end
 
         config.line_comments = lambda do
@@ -388,9 +388,9 @@ module Awestruct
     end
 
     def load_pages
-      $LOG.debug "layout_page_loader.load_all :post"
+      $LOG.debug "layout_page_loader.load_all :post" if config.debug
       @layout_page_loader.load_all( :post )
-      $LOG.debug "site_page_loader.load_all :inline"
+      $LOG.debug "site_page_loader.load_all :inline" if config.debug 
       @site_page_loader.load_all( :inline )
     end
 
@@ -398,10 +398,11 @@ module Awestruct
       FileUtils.mkdir_p( site.config.output_dir )
       return_value = [Awestruct::ExceptionHelper::EXITCODES[:success]]
       begin
+        $LOG.verbose "Using the following options from site.generation: #{site.generation}" if config.verbose
         return_value = Parallel.map(@site.pages, site.generation) do |page|
           start_time = DateTime.now
           return_value = generate_page( page )
-          $LOG.trace "Total time generating #{page.output_path} #{DateTime.now.to_time - start_time.to_time} seconds" if site.config.verbose
+          $LOG.trace "Total time generating #{page.output_path} #{DateTime.now.to_time - start_time.to_time} seconds" if config.verbose && config.perf
 
           return_value
         end
@@ -420,7 +421,7 @@ module Awestruct
     def generate_page(page, produce_output=true)
       if produce_output
         generated_path = File.join( site.config.output_dir, page.output_path )
-        $LOG.debug "Generating: #{generated_path}" if config.verbose
+        $LOG.debug "Generating: #{generated_path}" if config.verbose && config.debug
 
         c = ''
         begin
@@ -434,15 +435,16 @@ module Awestruct
           end
         rescue Exception => e
           Awestruct::ExceptionHelper.log_building_error e, page.relative_source_path
+          return Awestruct::ExceptionHelper::EXITCODES[:generation_error]
         ensure
           return Awestruct::ExceptionHelper::EXITCODES[:generation_error] if c.include? 'Backtrace:'
         end
         Awestruct::ExceptionHelper::EXITCODES[:success]
       elsif site.config.track_dependencies
         if page.dependencies.load!
-          $LOG.debug "Cached:     #{generated_path}"
+          $LOG.debug "Cached:     #{generated_path}" if config.debug
         else
-          $LOG.debug "Analyzing:  #{generated_path}"
+          $LOG.debug "Analyzing:  #{generated_path}" if config.debug
           page.rendered_content
         end
         return Awestruct::ExceptionHelper::EXITCODES[:success]
@@ -472,7 +474,7 @@ module Awestruct
 
       regen_pages = page_dependencies( page )
 
-      $LOG.debug 'Starting regeneration of content dependent pages:' if regen_pages.size > 0
+      $LOG.debug 'Starting regeneration of content dependent pages:' if regen_pages.size > 0 && config.debug
 
       regen_pages.each do |p|
         $LOG.info "Regenerating page #{p.output_path}"