plate 0.6.3 → 0.7.0.pre

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## Plate 0.7.0 (Unreleased)
+
+* Added support for view partials
+* Reload page layout when re-rendering a page
+
 ## Plate 0.6.3
 
 * Pass through current site to Sass::Engine options for use within Sass plugins
@@ -6,48 +11,48 @@
 
 * Gem dependency updates
 * Upgraded Twitter Bootstrap to v2.0.3
-* Sass and Less partial modifications reload parent file regardless of file location and nesting.
+* Sass and Less partial modifications reload parent file regardless of file location and nesting
 
 ## Plate 0.6.1
 
-* Added basic support for asset partials with Sass and Less. When using watch mode, partials will reload any referencing files if they are modified.
+* Added basic 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.
+* 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
 * Added RSS feed as part of new site generation
 * Added helper for making relative links absolute for use within RSS feeds
 * Documentation updates
-* Added a new DSL for callbacks and other extensions. Files within `./lib` will now be evaluated using the DSL instead of just being required.
+* Added a new DSL for callbacks and other extensions. Files within `./lib` will now be evaluated using the DSL instead of just being required
 * Helpers have been moved to a separate directory in the site source root named `./helpers`.
-* Added new site template with some base CSS styles and helpful information to get started.
-* Allow a build destination to be set within the config.yml file.
+* Added new site template with some base CSS styles and helpful information to get started
+* Allow a build destination to be set within the config.yml file
 * Allow customization of Sass output style with config variable :sass_style
-* Added DSL methods to register asset and template engines.
-* Added engine for Less CSS processing. Install the less gem to use this engine.
+* Added DSL methods to register asset and template engines
+* Added engine for Less CSS processing. Install the less gem to use this engine
 
 ## Plate 0.5.4
 
-* Added config option to command line utility to load a specific config file.
-* Allowed new post command to have default options stored in config.yml file.
+* Added config option to command line utility to load a specific config file
+* Allowed new post command to have default options stored in config.yml file
 
 ## Plate 0.5.3
 
-* Added support for Sass @import statements.
-* Partial-style assets are not included in the build by default. Partial file names start with an underscore.
+* Added support for Sass @import statements
+* Partial-style assets are not included in the build by default. Partial file names start with an underscore
 
 ## Plate 0.5.2
 
-* Added `platify` command line utility to set up a new site.
+* Added `platify` command line utility to set up a new site
 
 ## Plate 0.5.1
 
-* Updates to new post command line utility. Pass in a category and layout to a new post.
+* Updates to new post command line utility (Pass in a category and layout to a new post)
 
 ## Plate 0.5.0
 
-* Initial build, basic site generation, asset compilation and template handling.
+* Initial build, basic site generation, asset compilation and template handling
 * Command line interface
 * Rebuilding site with changes on demand with the `--watch` parameter
 * Basic callbacks for manipulating page and site content

data/README.md

@@ -8,7 +8,7 @@ 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**
+Current version is **0.6.3**
 
 ## Installation
 
@@ -115,6 +115,10 @@ Then, in your `.erb` view you can call `sample_helper_method`.
 
 All files in the `helpers/` directory are assumed to be helper modules and will be loaded automatically at runtime.
 
+### Partials
+
+**Coming Soon.**
+
 ## Full Documentation
 
 View the [full documentation on rdoc.info](http://rdoc.info/gems/plate/frames)

data/lib/plate.rb

@@ -19,6 +19,7 @@ module Plate
 
   autoload :BloggingHelper,                 'plate/helpers/blogging_helper'
   autoload :MetaHelper,                     'plate/helpers/meta_helper'
+  autoload :PartialsHelper,                 'plate/helpers/partials_helper'
   autoload :URLHelper,                      'plate/helpers/url_helper'
 
   autoload :View,                           'plate/view'
@@ -28,6 +29,7 @@ module Plate
 
   autoload :Asset,                          'plate/asset'
   autoload :DynamicPage,                    'plate/dynamic_page'
+  autoload :Partial,                        'plate/partial'
   autoload :Page,                           'plate/page'
   autoload :Post,                           'plate/post'
   autoload :StaticPage,                     'plate/static_page'

data/lib/plate/builder.rb

@@ -235,16 +235,25 @@ module Plate
       else
         # 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))
+          name = Partial.name(site, relative_file_path.gsub(/^\/?content\//, ''))
+          partial = Partial.find(site, name)
 
-          other_files.each do |file|
-            if Array === file.partials
-              if file.partials.include?(partial_name)
-                self.render_file!(file.relative_file)
+          if partial
+            partial.reload!
+            partial.pages.each do |page|
+              self.render_file!(page.relative_file)
+            end
+          else
+            partial_name = File.basename(relative_file_path, '.*').gsub(/^_/, '')
+            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
           end

data/lib/plate/helpers/partials_helper.rb

@@ -0,0 +1,33 @@
+module Plate
+  # Allow for partials within views
+  module PartialsHelper
+    def render(options = {}, locals = {})
+      path = options
+
+      # If a hash is passed as the first option, use it for locals
+      if Hash === options
+        path = options.delete(:partial)
+        locals = options.clone
+      end
+
+      locals.symbolize_keys!
+
+      render_partial(path.to_s, locals)
+    end
+
+    protected
+      # Create a new partial with the given options, and return its content
+      def render_partial(path, locals)
+        partial_name = Partial.name(self.site, path, self.file)
+        partial = Partial.find(self.site, partial_name)
+
+        if partial
+          self.page.partials << partial unless self.page.partials.include?(partial)
+          partial.pages << self.page unless partial.pages.include?(self.page)
+          partial.render(locals)
+        else
+          nil
+        end
+      end
+  end
+end

data/lib/plate/less_template.rb

@@ -27,7 +27,8 @@ module Plate
         :paths => paths
       })
 
-      scope.partials = data.to_s.scan(/@import\s"(.*?)";/i).flatten.collect { |s| s.split('/').last.gsub(/^_/, '') }
+      partials = data.to_s.scan(/@import\s"(.*?)";/i).flatten.collect { |s| s.split('/').last.gsub(/^_/, '') }
+      scope.partials = scope.partials + partials
 
       parser = ::Less::Parser.new(less_options)
       parser.parse(data).to_css

data/lib/plate/page.rb

@@ -17,6 +17,7 @@ module Plate
       self.file = file
       self.meta = {}
       self.content = ""
+      self.partials = []
 
       load! if load_on_initialize and file?
     end
@@ -135,7 +136,7 @@ module Plate
     # 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 @layout if defined?(@layout)
+      return @layout if @layout
       self.layout = self.meta[:layout]
       @layout
     end
@@ -143,7 +144,7 @@ module Plate
     # Manually set the layout
     def layout=(value)
       if value == false
-        @layout = nil
+        @layout = :none
       elsif value
         @layout = self.site.find_layout(value)
       else
@@ -178,12 +179,15 @@ module Plate
     end
 
     def reload!
+      self.meta = {}
+      self.partials = []
+      self.content = nil
+
       @loaded = false
-      @content = nil
-      @meta = {}
-      @keywords = nil
       @rendered_content = nil
       @body = nil
+      @keywords = nil
+      @layout = nil
 
       load!
     end

data/lib/plate/partial.rb

@@ -0,0 +1,70 @@
+module Plate
+  # A partial is a special type of page that is not rendered on its own, but is called
+  # within another page. Just like partials in Rails, or server-side includes in other
+  # packages.
+  class Partial < Page
+    # The locals hash provided to the current render of this partial.
+    # Locals are reset after each render
+    attr_reader :locals
+
+    # All pages that are using this partial, so they can be reloaded if the partial changes.
+    attr_accessor :pages
+
+    def initialize(site, file)
+      @pages = []
+      super(site, file)
+    end
+
+    # Partial names are the relative filename, without any extensions
+    def name
+      @name ||= Partial.name(self.site, self.file, self.site.source)
+    end
+
+    # The content for the current partial using the given locals hash
+    def render(locals = {})
+      @locals = locals.symbolize_keys!
+      result = self.rendered_body
+      @locals = nil
+      @locals_proxy = nil
+      @body = nil
+
+      result
+    end
+
+    # Allow calls to locals hash via the locals proxy
+    def method_missing(method, *args)
+      return super unless locals_proxy
+      locals_proxy.send(method, *args)
+    end
+
+    class << self
+      # Find a partial based on the given path and site
+      def find(site, name)
+        site.partials.find { |partial| partial.name == name }
+      end
+
+      # Convert a file path into a partial name
+      def name(site, file, reference = nil)
+        unless File.exists?(file)
+          if (file =~ /^\.\.?\// or !file.include?('/')) and !reference.nil?
+            file = File.expand_path(File.join(File.dirname(reference), file))
+          else
+            file = File.expand_path(File.join(site.source, 'content', file))
+          end
+        end
+
+        base = File.basename(file).gsub(/^_/, '').split('.').first
+        dir = site.relative_path(File.dirname(file))
+
+        "#{dir}/#{base}".gsub(/^\/?content\//, '')
+      end
+    end
+
+    protected
+      # Set up a hash proxy that allows method calls for keys
+      def locals_proxy
+        return nil unless locals
+        @locals_proxy ||= HashProxy.new(locals)
+      end
+  end
+end

data/lib/plate/sass_template.rb

@@ -38,7 +38,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.collect { |s| s.split('/').last }
+      partials = data.to_s.scan(/@import\s"(.*?)";/i).flatten.collect { |s| s.split('/').last }
+      scope.partials = scope.partials + partials
 
       ::Sass::Engine.new(data, options).render
     end

data/lib/plate/site.rb

@@ -9,6 +9,9 @@ module Plate
     attr_accessor :assets, :build_destination, :cache_location, :destination,
                   :layouts, :logger, :metadata, :options, :pages, :posts, :source
 
+    # An array of all view partials available in this site.
+    attr_accessor :partials
+
     def initialize(source, destination, options = {})
       # Setup source and destination for the site files
       self.source = source
@@ -53,6 +56,7 @@ module Plate
       self.layouts = []
       self.pages = []
       self.posts = PostCollection.new
+      self.partials = []
 
       @metadata = {}
     end
@@ -211,7 +215,7 @@ module Plate
 
     protected
       # Load all layouts from layouts/
-      def load_layouts!(log = true)
+      def load_layouts!(verbose = true)
         @layouts = []
 
         Dir.glob(File.join(source, "layouts/**/*")).each do |file|
@@ -221,17 +225,21 @@ module Plate
           end
         end
 
-        log("#{@layouts.size} layouts loaded") if log
+        log("#{@layouts.size} layouts loaded") if verbose
 
         @layouts
       end
 
-      def load_pages!(log = true)
+      def load_pages!(verbose = true)
         @assets = []
         @pages = []
+        @partials = []
 
         # Load all pages, static pages and assets from content/
         Dir.glob(File.join(source, "content/**/*")).each do |file|
+          # Detect if this is a partial or not
+          partial = File.basename(file).start_with?('_')
+
           # If this 'file' is a directory, just skip it. We only care about files.
           unless File.directory?(file)
             # Check for assets that need to be compiled. Currently only looks to see if the file
@@ -239,31 +247,38 @@ module Plate
             #
             # Assets that start with _ are assumed to be partials and are not loaded.
             if asset_engine_extensions.include?(File.extname(file))
-              unless File.basename(file).start_with?('_')
+              unless partial
                 @assets << Asset.new(self, file)
               end
             else
-              # Check for YAML meta header. If it starts with ---, then process it as a page
-              intro = File.open(file) { |f| f.read(3) }
-
-              # If file contents start with ---, then it is something we should process as a page.
-              if intro == "---"
-                @pages << Page.new(self, file)
+              if partial
+                @partials << Partial.new(self, file)
               else
-                @pages << StaticPage.new(self, file)
+                # Check for YAML meta header. If it starts with ---, then process it as a page
+                intro = File.open(file) { |f| f.read(3) }
+
+                # If file contents start with ---, then it is something we should process as a page.
+                if intro == "---"
+                  @pages << Page.new(self, file)
+                else
+                  @pages << StaticPage.new(self, file)
+                end
               end
             end
           end
         end
 
-        log("#{@assets.size} assets loaded") if log
-        log("#{@pages.size} pages and other files loaded") if log
+        if verbose
+          log("#{@assets.size} assets loaded")
+          log("#{@pages.size} pages and other files loaded")
+          log("#{@partials.size} partials loaded")
+        end
 
         @pages
       end
 
       # Load blog posts from posts/
-      def load_posts!(log = true)
+      def load_posts!(verbose = true)
         @posts = PostCollection.new
 
         Dir.glob(File.join(source, "posts/**/*")).each do |file|
@@ -281,7 +296,7 @@ module Plate
 
         @posts.sort!
 
-        log("#{@posts.size} posts loaded") if log
+        log("#{@posts.size} posts loaded") if verbose
 
         @posts
       end

data/lib/plate/version.rb

@@ -1,3 +1,3 @@
 module Plate
-  VERSION = "0.6.3" unless defined?(::Plate::VERSION)
+  VERSION = "0.7.0.pre" unless defined?(::Plate::VERSION)
 end

data/lib/plate/view.rb

@@ -7,13 +7,14 @@ module Plate
   class View
     include BloggingHelper
     include MetaHelper
+    include PartialsHelper
     include URLHelper
 
     # @return [Page] The current page (or post) being rendered.
     attr_reader :page
 
     # @return [Site] The current site build.
-    attr_reader :site, :page
+    attr_reader :site
 
     # Create a new view by passing in the current {Plate::Site site} and {Plate::Page page}
     # instance.

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: plate
 version: !ruby/object:Gem::Version
-  version: 0.6.3
-  prerelease: 
+  version: 0.7.0.pre
+  prerelease: 6
 platform: ruby
 authors:
 - John Tornow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-16 00:00:00.000000000Z
+date: 2012-07-31 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70119662223360 !ruby/object:Gem::Requirement
+  requirement: &70256245018440 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662223360
+  version_requirements: *70256245018440
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: &70119662222940 !ruby/object:Gem::Requirement
+  requirement: &70256245018040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662222940
+  version_requirements: *70256245018040
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70119662222400 !ruby/object:Gem::Requirement
+  requirement: &70256245017460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662222400
+  version_requirements: *70256245017460
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70119662221980 !ruby/object:Gem::Requirement
+  requirement: &70256245017040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662221980
+  version_requirements: *70256245017040
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70119662221440 !ruby/object:Gem::Requirement
+  requirement: &70256245016500 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662221440
+  version_requirements: *70256245016500
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70119662220920 !ruby/object:Gem::Requirement
+  requirement: &70256245016000 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70119662220920
+  version_requirements: *70256245016000
 description: Plate is a simple, static site generator and blog engine.
 email:
 - john@johntornow.com
@@ -100,11 +100,13 @@ files:
 - lib/plate/hash_proxy.rb
 - lib/plate/helpers/blogging_helper.rb
 - lib/plate/helpers/meta_helper.rb
+- lib/plate/helpers/partials_helper.rb
 - lib/plate/helpers/url_helper.rb
 - lib/plate/layout.rb
 - lib/plate/less_template.rb
 - lib/plate/markdown_template.rb
 - lib/plate/page.rb
+- lib/plate/partial.rb
 - lib/plate/post.rb
 - lib/plate/post_collection.rb
 - lib/plate/sass_template.rb