plate 0.6.0 → 0.6.1

data/CHANGELOG.md

@@ -1,4 +1,8 @@
-## Plate 0.6.0 (Unreleased)
+## Plate 0.6.1
+
+* Added basis support for asset partials with Sass and Less. When using watch mode, partials will reload any referencing files if they are modified.
+
+## Plate 0.6.0
 
 * Meta data can be read from the config file and used to store common site data such as title, description, author, etc.
 * Modified new site generator to use meta data structure

data/README.md

@@ -8,6 +8,8 @@ In addition to basic formatting with Markdown, Plate also supports generating mo
 
 Plate is a command line utility installed as a Ruby Gem. Installation requires Ruby 1.8.7, 1.9.2 or 1.9.3. For additional processing, install CoffeeScript, Sass, Haml and other formatters.
 
+Current version is **0.6.0**
+
 ## Installation
 
     gem install plate

data/lib/plate/builder.rb

@@ -232,7 +232,24 @@ module Plate
           end
         end
       else
-        log("Cannot render file, it doesn't exist. [#{relative_file_path}]")
+        # Check for partials, and run any files that reference it.
+        if File.basename(relative_file_path) =~ /^_/
+          partial_name = File.basename(relative_file_path, '.*').gsub(/^_/, '')
+
+          log("Partial modified. Reloading referencing files", :indent)
+
+          other_files = site.find_by_extension(File.extname(relative_file_path))
+
+          other_files.each do |file|
+            if Array === file.partials
+              if file.partials.include?(partial_name)
+                self.render_file!(file.relative_file)
+              end
+            end
+          end
+        else
+          log("Cannot render file, it doesn't exist. [#{relative_file_path}]")
+        end
       end
 
       true

data/lib/plate/dynamic_page.rb

@@ -1,24 +1,56 @@
 module Plate
-  class DynamicPage < Page    
-    attr_accessor :file_path, :locals
-    
+  # Allows the creation of one-off pages generated entirely from a dynamic source. The root
+  # content for a `DynamicPage` instance is not read from the source directory, as opposed
+  # to normal files. Instead, dynamic pages are typically used to create pages with dynamic
+  # data and content.
+  #
+  # Examples may include a blog archives page, list of tags, categories pages, etc.
+  #
+  # @example Generate a page with custom content
+  #
+  #     # This callback creates a tag index page for each tag in your posts.
+  #     callback :site, :after_render do |site|
+  #       site.tags.each do |tag|
+  #         tag_page = DynamicPage.new(site, "/tags/#{site.to_url(tag)}/index.html", :layout => 'tag')
+  #         tag_page.locals = { :tag => tag }
+  #         tag_page.write!
+  #       end
+  #     end
+  #
+  class DynamicPage < Page
+    # The full file system path of where this file will be written to. Set from the
+    # destination path on initialize.
+    attr_accessor :file_path
+
+    # Provides a hash to the page with variables that are accessible from with dynamic
+    # layouts or dynamic templates for this page.
+    attr_accessor :locals
+
+    # Set up a new instance of Dynamic Page
     def initialize(site, destination_path, meta = {})
       self.site = site
       self.file_path = destination_path
-      self.meta = meta      
+      self.meta = meta
       self.content = ""
       self.locals = {}
     end
-    
+
+    # Set the full hash to be provided to the view. Hash keys are symbolized before
+    # sending to the view.
     def locals=(hash)
       @locals = hash.symbolize_keys!
     end
-    
+
+    # Alias for the content that is provided
     def rendered_body
       self.content
     end
-    
-    # Check to see if a method called is in your locals.
+
+    # Check to see if a method called is in your locals. Allows the view to call variables in the locals
+    # hash directly without having to call `page.locals`.
+    #
+    # For example, in a view you can call `page.locals[:local_key]` `locals[:local_key]` or just `local_key`.
+    # They all will return the same value (provided :local_key exists in the locals of course)
     def method_missing(sym, *args)
       return locals[sym] if locals.has_key?(sym)
       super

data/lib/plate/errors.rb

@@ -1,13 +1,17 @@
 module Plate
+  # Raised if a given file by name is not found within the source tree.
   class FileNotFound < StandardError
   end
 
+  # Raised when a blog post does not contain a date within the meta data or within the file name.
   class NoPostDateProvided < StandardError
   end
 
+  # Raised if Plate is unable to read a plugin file from the lib directory.
   class PluginNotReadable < StandardError
   end
 
+  # Raised if the site's source directory was not found.
   class SourceNotFound < StandardError
   end
 end

data/lib/plate/less_template.rb

@@ -27,7 +27,9 @@ module Plate
         :paths => paths
       })
 
-      parser  = ::Less::Parser.new(less_options)
+      scope.partials = data.to_s.scan(/@import\s"_?(.*?)";/i).flatten
+
+      parser = ::Less::Parser.new(less_options)
       parser.parse(data).to_css
     end
   end

data/lib/plate/page.rb

@@ -6,6 +6,12 @@ module Plate
 
     attr_accessor :body, :content, :file, :meta, :site, :layout
 
+    # If set, will return an array of partial names used within this page.
+    #
+    # In watch mode, this allows the current page to be reloaded when any
+    # of its partials are reloaded.
+    attr_accessor :partials
+
     def initialize(site, file = nil, load_on_initialize = true)
       self.site = site
       self.file = file
@@ -55,6 +61,12 @@ module Plate
       @engines ||= self.extensions.reverse.collect { |e| self.site.registered_page_engines[e.gsub(/\./, '').to_sym] }.reject { |e| !e }
     end
 
+    # the last file extension for this page
+    def extension
+      extensions.last.gsub(/^\./, '')
+    end
+
+    # List of all extensions for this page
     def extensions
       @extensions ||= self.basename.scan(/\.[^.]+/)
     end

data/lib/plate/sass_template.rb

@@ -37,6 +37,8 @@ module Plate
         options[:cache_location] = File.join(scope.site.cache_location, 'sass-cache')
       end
 
+      scope.partials = data.to_s.scan(/@import\s"(.*?)";/i).flatten
+
       ::Sass::Engine.new(data, options).render
     end
   end

data/lib/plate/site.rb

@@ -1,136 +1,142 @@
 module Plate
   require 'tilt'
-  
+
   # This class contains everything you'll want to know about a site. It contains all data
   # about the site, including blog posts, content pages, static files, assets and anything else.
   class Site
     include Callbacks
-    
-    attr_accessor :assets, :build_destination, :cache_location, :destination, 
+
+    attr_accessor :assets, :build_destination, :cache_location, :destination,
                   :layouts, :logger, :metadata, :options, :pages, :posts, :source
-    
+
     def initialize(source, destination, options = {})
       # Setup source and destination for the site files
       self.source = source
       self.destination = destination
-      
+
       # By default, the build goes into the destination folder.
       # Override this to output to a different folder by default
       self.build_destination = destination
-      
+
       # Sanitize options
       self.options = Hash === options ? options.clone : {}
       self.options.symbolize_keys!
-            
+
       clear
     end
-    
+
     %w( assets layouts pages posts ).each do |group|
       class_eval "def #{group}; load!; @#{group}; end"
     end
-    
+
     def all_files
       @all_files ||= self.assets + self.layouts + self.pages + self.posts.to_a
     end
-    
+
     # All extensions that are registered, as strings.
     def asset_engine_extensions
       @asset_engine_extensions ||= self.registered_asset_engines.keys.collect { |e| ".#{e}" }
     end
-    
+
     # Alphabetical list of all blog post categories used.
     def categories
       @categories ||= self.posts.collect(&:category).uniq.sort
     end
-    
+
     # Clear out all data related to this site. Prepare for a reload, or first time load.
     def clear
       @loaded = false
       @tags_counts = nil
       @default_layout = nil
-      
+
       self.assets = []
       self.layouts = []
       self.pages = []
       self.posts = PostCollection.new
-      
+
       @metadata = {}
     end
-    
+
     # The default blog post category
     def default_category
       options[:default_category] || 'Posts'
     end
-    
+
     # The default layout for all pages that do not specifically name their own
     def default_layout
       return nil if self.layouts.size == 0
       return @default_layout if @default_layout
-      
+
       layout ||= self.layouts.reject { |l| !l.default?  }
       layout = self.layouts if layout.size == 0
-      
+
       if Array === layout and layout.size > 0
         layout = layout[0]
       end
-      
+
       @default_layout = layout
     end
-    
+
     # Find a page, asset or layout by source relative file path
     def find(search_path)
       self.all_files.find { |file| file == search_path }
     end
-    
+
+    # Find all registered files by the given file extension
+    def find_by_extension(extension)
+      extension = extension.to_s.downcase.gsub(/^\./, '')
+      self.all_files.select { |file| file.extension.to_s.downcase.gsub(/^\./, '') == extension }
+    end
+
     # Find all pages and posts with this layout
     def find_by_layout(layout_name)
       result = []
-      
+
       result += self.pages.find_all { |page| page.layout == layout_name }
       result += self.posts.find_all { |post| post.layout == layout_name }
-      
+
       result
     end
-    
-    # Find a specific layout by its file name. Any extensions are removed. 
+
+    # Find a specific layout by its file name. Any extensions are removed.
     def find_layout(layout_name)
       search_name = layout_name.to_s.downcase.strip.split('.')[0]
       matches = self.layouts.reject { |l| l.name != search_name }
       matches.empty? ? self.default_layout : matches[0]
     end
-    
+
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} source=#{source.to_s.inspect}>"
     end
-    
+
     # Load all data from the various source directories.
     def load!
       return if @loaded
-      
+
       log("Loading site from source [#{source}]")
-      
+
       run_callback :before_load
-      
+
       self.load_pages!
       self.load_layouts!
       self.load_posts!
-      
+
       run_callback :after_load
-      
+
       @loaded = true
     end
-    
+
     # Returns true if the site has been loaded from the source directories.
     def loaded?
       !!@loaded
     end
-    
+
     # Write to the log if enable_logging is enabled
     def log(message, style = :indent)
       logger.send(:log, message, style) if logger and logger.respond_to?(:log)
     end
-    
-    # Access to read all meta data for this site. Meta data can be set on the 
+
+    # Access to read all meta data for this site. Meta data can be set on the
     # site instance by passing in the `metadata` hash, or it can be pulled
     # from the config file under the heading of `meta`.
     #
@@ -149,43 +155,43 @@ module Plate
     def meta
       @meta ||= HashProxy.new(self.metadata)
     end
-    
+
     # Set the meta data hash object for this site.
     def meta=(hash)
       # Reset the meta hash proxy
       @meta = nil
-      
-      self.metadata = hash      
+
+      self.metadata = hash
     end
-    
+
     def page_engine_extensions
       @page_engine_extensions ||= self.registered_page_engines.keys.collect { |e| ".#{e}" }
     end
-    
+
     def relative_path(file_or_directory)
       file_or_directory.to_s.gsub(/^#{Regexp.quote(source)}(.*)$/, '\1')
     end
-    
+
     def reload!
       clear
       load!
     end
-    
+
     # Returns the asset engines that are available for use.
     def registered_asset_engines
       Plate.asset_engines
     end
-    
+
     # Returns the engines available for use in page and layout formatting.
     def registered_page_engines
-      Plate.template_engines     
+      Plate.template_engines
     end
-    
+
     # All tags used on this site
     def tags
       @tags ||= self.posts.tag_list
     end
-    
+
     def to_url(str)
       result = str.to_s.strip.downcase
       result = result.gsub(/[^-a-z0-9~\s\.:;+=_]/, '')
@@ -194,7 +200,7 @@ module Plate
       result
     end
     alias_method :sanitize_slug, :to_url
-    
+
     # The base URL for this site. The url can be set using the config option named `:base_url`.
     #
     # The base URL will not have any trailing slashes.
@@ -202,28 +208,28 @@ module Plate
       return '' unless self.options[:base_url]
       @url ||= self.options[:base_url].to_s.gsub(/(.*?)\/?$/, '\1')
     end
-    
+
     protected
       # Load all layouts from layouts/
       def load_layouts!(log = true)
         @layouts = []
-        
+
         Dir.glob(File.join(source, "layouts/**/*")).each do |file|
           # If this 'file' is a directory, just skip it. We only care about files.
-          unless File.directory?(file)          
+          unless File.directory?(file)
             @layouts << Layout.new(self, file)
           end
         end
 
         log("#{@layouts.size} layouts loaded") if log
-        
+
         @layouts
       end
-      
+
       def load_pages!(log = true)
         @assets = []
         @pages = []
-        
+
         # Load all pages, static pages and assets from content/
         Dir.glob(File.join(source, "content/**/*")).each do |file|
           # If this 'file' is a directory, just skip it. We only care about files.
@@ -252,14 +258,14 @@ module Plate
 
         log("#{@assets.size} assets loaded") if log
         log("#{@pages.size} pages and other files loaded") if log
-        
+
         @pages
       end
-      
+
       # Load blog posts from posts/
       def load_posts!(log = true)
         @posts = PostCollection.new
-        
+
         Dir.glob(File.join(source, "posts/**/*")).each do |file|
           # If this 'file' is a directory, just skip it. We only care about files.
           unless File.directory?(file)
@@ -270,13 +276,13 @@ module Plate
             if intro == "---"
               @posts.add(Post.new(self, file))
             end
-          end          
+          end
         end
-        
+
         @posts.sort!
-        
-        log("#{@posts.size} posts loaded") if log     
-        
+
+        log("#{@posts.size} posts loaded") if log
+
         @posts
       end
   end

data/lib/plate/version.rb

@@ -1,3 +1,3 @@
 module Plate
-  VERSION = "0.6.0" unless defined?(::Plate::VERSION)
+  VERSION = "0.6.1" unless defined?(::Plate::VERSION)
 end

data/lib/plate.rb

@@ -48,14 +48,14 @@ module Plate
   # https://github.com/sstephenson/sprockets
 
   # Assets
-  register_asset_engine :coffee,          Tilt::CoffeeScriptTemplate
-  register_asset_engine :less,            LessTemplate
-  register_asset_engine :sass,            SassTemplate
-  register_asset_engine :scss,            ScssTemplate
+  register_asset_engine :coffee,            Tilt::CoffeeScriptTemplate
+  register_asset_engine :less,              LessTemplate
+  register_asset_engine :sass,              SassTemplate
+  register_asset_engine :scss,              ScssTemplate
 
   # Layouts & Markup
-  register_template_engine :erb,          Tilt::ERBTemplate
-  register_template_engine :haml,         HamlTemplate
-  register_template_engine :md,           MarkdownTemplate
-  register_template_engine :markdown,     MarkdownTemplate
+  register_template_engine :erb,            Tilt::ERBTemplate
+  register_template_engine :haml,           HamlTemplate
+  register_template_engine :md,             MarkdownTemplate
+  register_template_engine :markdown,       MarkdownTemplate
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.6.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-04-10 00:00:00.000000000 Z
+date: 2012-05-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552834360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,15 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '3.2'
+  version_requirements: *70231552834360
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552833980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -37,15 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70231552833980
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552833440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -53,15 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '0.6'
+  version_requirements: *70231552833440
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552833020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70231552833020
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552832480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -85,15 +65,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '2'
+  version_requirements: *70231552832480
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70231552831980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -101,12 +76,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: '1.3'
+  version_requirements: *70231552831980
 description: Plate is a simple, static site generator and blog engine.
 email:
 - john@johntornow.com
@@ -174,7 +144,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.12
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.21
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: A static site generator and blog engine.