plate 0.5.4 → 0.6.0

data/lib/plate/less_template.rb

@@ -0,0 +1,34 @@
+module Plate
+  # Slightly modified from the Tilt default to just use the Less::Parse instead of Engine.
+  #
+  # Also adds support for paths
+  #
+  # Original source: https://github.com/rtomayko/tilt/blob/master/lib/tilt/css.rb
+  class LessTemplate < Tilt::Template
+    self.default_mime_type = 'text/css'
+
+    def self.engine_initialized?
+      defined? ::Less
+    end
+
+    def initialize_engine
+      require_template_library 'less'
+    end
+
+    def prepare
+    end
+
+    def evaluate(scope, locals, &block)
+      paths = [ scope.pathname, File.join(scope.site.source, 'content') ]
+
+      less_options = options.merge({
+        :filename => eval_file,
+        :line => line,
+        :paths => paths
+      })
+
+      parser  = ::Less::Parser.new(less_options)
+      parser.parse(data).to_css
+    end
+  end
+end

data/lib/plate/page.rb

@@ -3,46 +3,46 @@ require 'digest'
 module Plate
   class Page
     include Callbacks
-    
-    attr_accessor :body, :content, :file, :meta, :site
-    
+
+    attr_accessor :body, :content, :file, :meta, :site, :layout
+
     def initialize(site, file = nil, load_on_initialize = true)
       self.site = site
       self.file = file
       self.meta = {}
       self.content = ""
-          
+
       load! if load_on_initialize and file?
     end
-    
+
     # Setup some shortcut getters for meta attributes
     %w( title description tags category ).each do |meta_attribute|
       class_eval <<-META
         def #{meta_attribute}                         # def title
           self.meta[:#{meta_attribute}]               #   self.meta[:title]
         end                                           # end
-        
+
         def #{meta_attribute}=(value)                 # def title=(value)
           self.meta[:#{meta_attribute}] = value       #   self.meta[:title] = value
         end                                           # end
       META
     end
-    
+
     # The name of the file, without any path data
     def basename
       File.basename(self.file)
     end
     alias_method :name, :basename
-    
+
     # The directory this page is located in, relative to the site root.
     def directory
       return @directory if @directory
-      
+
       base = Pathname.new(File.join(self.site.source, 'content'))
       current = Pathname.new(self.file)
-      
+
       dirs = current.relative_path_from(base).to_s.split('/')
-      
+
       if dirs.size > 1
         dirs.pop
         @directory = "/#{dirs.join('/')}"
@@ -50,131 +50,147 @@ module Plate
         @directory = "/"
       end
     end
-    
+
     def engines
       @engines ||= self.extensions.reverse.collect { |e| self.site.registered_page_engines[e.gsub(/\./, '').to_sym] }.reject { |e| !e }
     end
-    
+
     def extensions
       @extensions ||= self.basename.scan(/\.[^.]+/)
     end
-    
-    # Does the file exist or not. 
+
+    # Does the file exist or not.
     def file?
       return false if self.file.nil?
       File.exists?(self.file)
     end
-    
+
     # Returns just the file name, no extension.
     def file_name
       File.basename(self.file, '.*')
     end
-    
+
     # The full file path of where this file will be written to. (Relative to site root)
     def file_path
-      return self.meta[:path] if self.meta.has_key?(:path)
       return @file_path if @file_path
-      
-      result = directory
-      result << '/' unless result =~ /\/$/    
-      result << slug unless slug == "index"
-      
-      # Remove any double slashes
-      result.gsub!(/\/\//, '/')
-      
-      # Remove file extensions, and cleanup URL
-      result = result.split('/').reject{ |segment| segment =~ /^\.+$/ }.join('/')
-      
-      # Add a trailing slash
-      result << '/' unless result =~ /\/$/
-      
-      # Tack on index.html for the folder
-      result << "index.html"
+
+      result = nil
+
+      if self.meta.has_key?(:path)
+        result = self.meta[:path]
+        result = "/#{result}" unless result.start_with?('/')
+      else
+        result = directory
+        result << '/' unless result =~ /\/$/
+        result << slug unless slug == 'index'
+
+        # Remove any double slashes
+        result.gsub!(/\/\//, '/')
+
+        # Remove file extensions, and cleanup URL
+        result = result.split('/').reject{ |segment| segment =~ /^\.+$/ }.join('/')
+
+        # Add a trailing slash
+        result << '/' unless result =~ /\/$/
+
+        # Tack on index.html for the folder
+        result << 'index.html'
+      end
+
       @file_path = result
     end
-    
-    def format_extension      
+
+    def format_extension
       format = self.extensions.reverse.detect() { |e| !self.site.page_engine_extensions.include?(e) }
       format = ".html" if format.nil?
       format
     end
 
     # A unique ID for this page.
-    def id      
+    def id
       @id ||= Digest::MD5.hexdigest(relative_file)
     end
-    
+
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} name=#{name.to_s.inspect}>"
     end
-    
+
     # Utility method to sanitize keywords output. Keywords are returned as an array.
     def keywords
       @keywords ||= (Array === self.meta[:keywords] ? self.meta[:keywords] : self.meta[:keywords].to_s.strip.split(',').collect(&:strip))
     end
-    
+
     # The layout to use when rendering this page. Returns nil if no default layout is available,
     # or the layout has specifically been turned off within the config.
     def layout
-      return nil if self.meta[:layout] == false
-      return @layout if @layout
-      
-      if self.meta[:layout]
-        @layout = self.site.find_layout(self.meta[:layout])
+      return @layout if defined?(@layout)
+      self.layout = self.meta[:layout]
+      @layout
+    end
+
+    # Manually set the layout
+    def layout=(value)
+      if value == false
+        @layout = nil
+      elsif value
+        @layout = self.site.find_layout(value)
       else
         @layout = self.site.default_layout
       end
-      
-      @layout
     end
-    
+
     # Has this page been loaded from file?
     def loaded?
       !!@loaded
     end
-    
+
     # Read the file data for this page
     def load!
-      return if @loaded      
+      return if @loaded
       raise FileNotFound unless file?
-      
+
       read_file!
       read_metadata!
-      
+
       @loaded = true
     end
-    
+
     def path
       return '/' if self.file_path == '/index.html'
-      @path ||= self.file_path.sub(/(.*?)\/index\.html$/i, '\1')      
+      @path ||= self.file_path.sub(/(.*?)\/index\.html$/i, '\1')
     end
-    
+
     # The file's source path, relative to site root.
     def relative_file
       @relative_file ||= self.site.relative_path(self.file)
     end
-    
+
     def reload!
-      @layout = nil
       @loaded = false
       @content = nil
       @meta = {}
       @keywords = nil
       @rendered_content = nil
       @body = nil
-      
+
       load!
     end
-    
+
     # Returns the rendered body of this page, without the layout.
+    #
+    # The callbacks `before_render` and `after_render` are called here. To perform
+    # custom actions before or after a page file is written to disk, use these callback
+    # methods.
+    #
+    # See {Plate::Callbacks} for more information on setting up callbacks.
     def rendered_body
       return @body if @body
-      
+
       result = ""
-      
+
       around_callback :render do
         result = self.content
-        
+
         view = View.new(self.site, self)
 
         self.engines.each do |engine|
@@ -183,67 +199,75 @@ module Plate
         end
 
         view = nil
-        
+
         @body = result
       end
-      
+
       @body
     end
-    
+
     def rendered_content
       @rendered_content ||= self.apply_layout_to(rendered_body)
     end
-    
+
     # Name of the file to be saved. Just takes the current file name and removes any extensions.
     def slug
       self.basename.to_s.downcase.split('.')[0].dasherize.parameterize
     end
-    
+
     # The title from this page's meta data, turned into a parameter for use in a url.
     def title_for_url
       self.title.to_s.dasherize.parameterize
     end
-    
+
     # Returns this page's content
     def to_s
       self.inspect
     end
-    
+
     # The full URL of this page. Depends on the site's URL attribute and a config option of `:base_url`
     def url
       @url ||= "#{site.url}#{path}"
     end
-    
-    # Write this compiled page to its destination file.
-    def write!      
+
+    # Write the compiled page file to the destination. The content is written to disk
+    # using the path designated in `file_path` and the content from `rendered_content`.
+    #
+    # The callbacks `before_write` and `after_write` are included here. To perform
+    # custom actions before or after a page file is written to disk, use these callback
+    # methods.
+    #
+    # See {Plate::Callbacks} for more information on setting up callbacks.
+    def write!
       path = File.join(site.build_destination, file_path)
-      
       FileUtils.mkdir_p(File.dirname(path))
-      
-      File.open(path, 'w') do |f|
-        f.write(self.rendered_content)
+
+      around_callback :write do
+        File.open(path, 'w') do |f|
+          f.write(self.rendered_content)
+        end
       end
-      
+
       path
     end
-    
+
     # Is this page equal to another page being sent?
     def ==(other)
       other = other.relative_file if other.respond_to?(:relative_file)
       self.id == other or self.relative_file == other
     end
-    
+
     # Compare two posts, by date.
     def <=>(other)
       self.path <=> other.path
     end
-    
+
     protected
       def apply_layout_to(content)
         return content unless Layout === self.layout
         self.layout.render(content, self)
       end
-    
+
       # Reading page details
       # #####################################################################
 
@@ -255,7 +279,7 @@ module Plate
       # Reads all content from a page's meta data
       #
       # Meta data is stored in YAML format within the head of a page after the -- declaration like so:
-      # 
+      #
       #     ---
       #     title: "Hello"
       #     description: "This is some meta data"
@@ -267,7 +291,7 @@ module Plate
       #     # Start of actual content
       def read_metadata!
         return unless self.content
-        
+
         begin
           if matches = /^(---\n)(.*?)^\s*?$/m.match(self.content)
             if matches.size == 3
@@ -275,7 +299,7 @@ module Plate
               self.meta = YAML.load(matches[2])
               self.meta.symbolize_keys!
             end
-          end        
+          end
         rescue Exception => e
           self.meta = {}
           self.site.log("  ** Problem reading YAML for file #{relative_file} (#{e.message}). Meta data skipped")

data/lib/plate/sass_template.rb

@@ -1,8 +1,8 @@
 module Plate
-  # Mostly lifted from the default SassTemplate class at 
+  # Extended from the base Tilt::Template class at:
   # https://github.com/rtomayko/tilt/blob/master/lib/tilt/css.rb
   #
-  # Modifications have been made to use the site caching folder 
+  # Modifications have been made to use the site caching folder.
   class SassTemplate < Tilt::Template
     self.default_mime_type = 'text/css'
 
@@ -14,26 +14,29 @@ module Plate
       require_template_library 'sass'
     end
 
-    def prepare      
+    def prepare
     end
-    
+
     def syntax
       :sass
     end
-  
+
     def evaluate(scope, locals, &block)
+      paths = [ scope.pathname, File.join(scope.site.source, 'content') ]
+      style = scope.site.options[:sass_style] || 'expanded'
+
       options = {
-        :filename => eval_file, 
-        :line => line, 
+        :filename => eval_file,
+        :line => line,
         :syntax => syntax,
-        :style => :expanded,
-        :load_paths => [ scope.pathname ]
+        :style => style.to_sym,
+        :load_paths => paths
       }
-      
+
       if scope.site.cache_location
         options[:cache_location] = File.join(scope.site.cache_location, 'sass-cache')
-      end      
-      
+      end
+
       ::Sass::Engine.new(data, options).render
     end
   end