plate 0.7.0.pre5 → 0.7.0

data/README.md

@@ -2,13 +2,13 @@
 
 [![Build Status](https://secure.travis-ci.org/jdtornow/plate.png)](http://travis-ci.org/jdtornow/plate) [![Dependency Status](https://gemnasium.com/jdtornow/plate.png?travis)](https://gemnasium.com/jdtornow/plate)
 
-Plate is a super simple static site generator and blog engine. At its core, it takes a folder full of Markdown files and turns it into a static HTML site that you can host anywhere.
+Plate is a simple static site generator and blogging engine. At its core, it takes a folder full of Markdown files and turns it into a static HTML site that you can host anywhere.
 
-In addition to basic formatting with Markdown, Plate also supports generating more dynamic files with ERB or HAML, and compiling asset files with CoffeeScript, Sass and others.
+In addition to basic formatting with Markdown, Plate also supports generating more dynamic files with ERB or HAML, and compiling asset files with CoffeeScript, Sass and and Less.
 
-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.
+Plate is a command line utility installed as a Ruby Gem. Installation requires Ruby 1.8.7, 1.9.2 or 1.9.3.
 
-Current version is **0.6.3**
+Current version is **0.7.0**
 
 ## Installation
 
@@ -18,111 +18,85 @@ Or, create a `Gemfile` and add:
 
     gem 'plate'
 
-## Command line
+## Creating a new site
 
-Plate is designed to be a command-line utility. Here is a rundown of some of the basic commands:
-
-### Creating a new site
-
-To generate a new site with plate, run the following command:
+To generate a new site with plate, run the following command in the directory you want a new site in:
 
     platify .
 
-Or, with the normal `plate` command:
-
-    plate new .
-
-### Building a site
-
-To build your site, run:
-
-    plate build
+## Building a site
 
-Or, just run `plate` without any options to build the site.
+To build your entire site, just run
 
     plate
 
-To show details about the site build, enable verbose mode:
+Add a `--verbose` tag to show some additional output about what is happening behind the scenes.
 
-    plate --verbose
-
-### Creating a new post
+## Create a new blog post
 
 To create a new blog post with the default options, run:
 
-    plate post "New Post Name"
+    plate post "Your Post Name Here"
 
 You can also put default post options (such as a category or layout) into the command line:
 
-    plate post "New Post Name" --category Articles --layout post
-
-Or, if you always use the same default category and/or layout, you can put those options into your config file instead like so:
+    plate post "Your Post Name Here" --category Articles --layout post
 
-    # In config/plate.yml
-    ...
-    post_defaults:
-      category: Articles
-      layout: post
-    ...
+If you always end up using the same basic options for every new post, you can add these options as defaults in your [config file](https://github.com/jdtornow/plate/blob/master/doc/config.md#new-post-options).
 
 ## Directory Structure
 
 Plate observes the following folder structure in your site:
 
-* config/ - Put your global configuration settings here.
-* content/ - All custom content for the site, besides blog posts. Everything in this folder will be copied over to the published site.
-* drafts/ - All drafted blog posts. Posts in this directory are rendered into the `/_drafts` destination.
-* helpers/ - Helpers are loaded into views automatically and can be used within dynamically rendered pages using a template language. (Such as Erb or Haml)
+* config/ - Configuration options (see [config](https://github.com/jdtornow/plate/blob/master/doc/config.md))
+* content/ - All site pages and assets
+* drafts/ - Any drafted blog posts
+* helpers/ - Helpers used within dynamic templates (see [Helpers](https://github.com/jdtornow/plate/blob/master/doc/helpers.md))
 * layouts/ - Global layouts available for use on all content pages and posts.
-* lib/ - Extend the basic functionality of Plate with plugins in this directory. All `.rb` files run against the Plate DSL.
-* posts/ - All blog post content for the site. Posts can be organized into sub-directories if you like.
+* lib/ - Extend the basic functionality of Plate with plugins in this directory. (see [DSL](https://github.com/jdtornow/plate/blob/master/doc/dsl.md))
+* posts/ - All blog post content for the site.
 * public/ - This will be generated if it does not exist, contains the produced site. Set this as the web server root to your site for development mode.
 
 ## Extending Plate
 
-Plate is meant to be extended easily. You might want to extend the basic functionality of Plate to add additional functionality for your site. To get started, create a directory named `lib` in the root of your site. Any Ruby files (ending in `.rb`) will be automatically loaded into the stack when Plate is run.
-
-### Callbacks
-
-Callbacks are used to call certain blocks of code when an event happens in the lifecycle of building a site.
-
-The callbacks currently available are:
-
-* Site - `before_render`, `after_render`
-* Page/Post - `before_render`, `after_render`, `before_write`, `after_write`
-* Asset - `before_render`, `after_render`, `before_write`, `after_write`
+Plate is designed to be easily extended. To get started, create a directory named `lib` in the root of your site. Any Ruby files (ending in `.rb`) will be automatically loaded with the [Plate DSL](https://github.com/jdtornow/plate/blob/master/doc/dsl.md).
 
-Example of a callback to be run when a site completes the build:
+## Helpers
 
-    register_callback :site, :after_render do |site|
-       puts "the site finished rendering!"
-    end
+When using dynamic page templates, such as `erb` or `haml`, you can access Ruby helper methods that are baked in to Plate, or add your own. For more information about helpers, see the [helpers doc](https://github.com/jdtornow/plate/blob/master/doc/helpers.md).
 
-Put the above snippet in any file in the lib folder, and it will be registered when your site is compiled.
+## Draft Posts
 
-### Helpers
+When creating a new post, you can choose to put it in the *drafts* folder, instead of the posts folder, to hide it from display until the post is complete. Once the post is ready for publishing, just add the following line to the meta data section at the top of the post:
 
-Helpers are modules that are automatically loaded into views. Any methods in the module will be available when you render a page.
+```
+publish: true
+```
+    
+On the next site build, your post will automatically be moved to the appropriate spot in the *posts* folder.
 
-An example of a helper file located in `helpers/sample_helper.rb`
+By default, the `plate post [Title]` command does not use the drafts folder. To enable draft usage by default when a new post is generated, just change the following line in the `config/plate.yml` file to true:
 
-    module SampleHelper
-      def sample_helper_method
-        "yes"
-      end
-    end
+```yml
+posts:
+  draft: true
+```
 
-Then, in your `.erb` view you can call `sample_helper_method`.
+## Partials
 
-All files in the `helpers/` directory are assumed to be helper modules and will be loaded automatically at runtime.
+Plate supports basic partial usage within dynamic pages. If your page is using Erb or Haml, you'll have access to partials. Partial files begin with an underscore, but are referenced in the `render` command without the underscore.
 
-### Draft Posts
+To display the contents of a partial located in `content/partials/_header.html`, use the following syntax:
 
-**In development -docs coming soon.**
+```ruby
+render 'partials/header'
+```
 
-### Partials
+Partials also support local variables. To pass custom variables through to the partial view, just include a hash in the `render` call. Note that only dynamic template partials (such as those ending in .erb or .haml) will be able to take advantage of local variables.
 
-**In development -docs coming soon.**
+```ruby
+render 'partials/header', :my => 'local', :vars => 'here'
+```
 
 ## Full Documentation
 

data/lib/plate/cli.rb

@@ -208,12 +208,16 @@ module Plate
         date = Time.now
 
         # if there are any post defaults in the config file, use those as the default options
-        if builder.config.has_key?(:post_defaults)
-          options.reverse_merge!(builder.config[:post_defaults])
+        if builder.config.has_key?(:posts)
+          options.reverse_merge!(builder.config[:posts])
         end
 
         category = options[:category] ? "\ncategory: #{options[:category]}" : ""
+        body = options[:body] ? options[:body].to_s : "Lorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur."
         layout = options[:layout] ? "\nlayout: #{options[:layout]}" : ""
+        tags = options[:tags] ? options[:tags] : ""
+        tags = tags.join(', ') if Array === tags
+
         publish = "\npublish: false"
         label = "draft"
 
@@ -227,7 +231,7 @@ module Plate
           label = "post"
         end
 
-        content = %Q(---\ntitle: "#{title}"\ndate: #{date.strftime('%Y-%m-%d %H:%M:%S')}#{category}#{layout}\ntags: []#{publish}\n\n# #{title}\n\nLorem ipsum dolor sit amet, consectetur adipisicing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur.)
+        content = %Q(---\ntitle: "#{title}"\ndate: #{date.strftime('%Y-%m-%d %H:%M:%S')}#{category}#{layout}\ntags: [#{tags}]#{publish}\n\n# #{title}\n\n#{body})
 
         FileUtils.mkdir_p(File.dirname(filename))
         File.open(filename, 'w') { |f| f.write(content) }

data/lib/plate/dynamic_page.rb

@@ -33,6 +33,7 @@ module Plate
       self.meta = meta
       self.content = ""
       self.locals = {}
+      self.partials = []
     end
 
     # Set the full hash to be provided to the view. Hash keys are symbolized before

data/lib/plate/helpers/partials_helper.rb

@@ -11,8 +11,11 @@ module Plate
       end
 
       locals.symbolize_keys!
-
+      
       render_partial(path.to_s, locals)
+    rescue
+      site.log("Oops. There was a problem rendering the partial: #{path}")
+      ""
     end
 
     protected
@@ -20,9 +23,9 @@ module Plate
       def render_partial(path, locals)
         partial_name = Partial.name(self.site, path, self.file)
         partial = Partial.find(self.site, partial_name)
-
+      
         self.page.partials << partial_name unless self.page.partials.include?(partial_name)
-
+        
         if partial
           partial.pages << self.page unless partial.pages.include?(self.page)
           partial.render(locals)

data/lib/plate/post.rb

@@ -8,56 +8,56 @@ module Plate
     def category
       default = self.meta[:category] || self.site.default_category
     end
-    
+
     # Category for this post, formatted to be URL-friendly
     def category_for_url
       self.category.to_s.dasherize.parameterize
     end
-    
+
     # Returns the date for this post, either from the filename or meta hash.
     # If both are provided, the meta information takes precedence.
     def date
       result = nil
-      
+
       if self.meta[:date]
         result = self.meta[:date].to_s
       elsif self.basename =~ /^(\d{4}-\d{2}-\d{2})-/
         result = $1.to_s
       end
-      
+
       begin
         return Time.parse(result)
       rescue Exception => e
-        self.site.log("  ** Problem reading date for file #{relative_file} (#{e.message}). Post skipped.")        
+        self.site.log("  ** Problem reading date for file #{relative_file} (#{e.message}). Post skipped.")
       end
-      
+
       raise NoPostDateProvided
     end
-    
+
     def day
       date.strftime('%d')
     end
-    
+
     # The full file path of where this file will be written to. (Relative to site root)
     def file_path
       "#{permalink}/index.html"
     end
-    
+
     def inspect
       "#<#{self.class}:0x#{object_id.to_s(16)} name=#{name.to_s.inspect} date=#{date.to_s}>"
     end
-    
+
     def month
-      date.strftime('%m')  
+      date.strftime('%m')
     end
-    
+
     # Return the [relative] path for this post. Uses the +permalink_template+
     # variable as the method for converting post data into a URL.
     #
     # The permalink_template can be set in the global config named 'permalink'.
     #
     # Available options are:
-    # 
+    #
     # * `date` - The date of this post, formatted as YYYY-MM-DD
     # * `title` - The title of this post, formatted for URL
     # * `slug` - The filename slug
@@ -69,11 +69,11 @@ module Plate
     # All values are formatted to be URL-safe. (No spaces, underscores or weird characters.)
     def permalink(cache_buster = false)
       return @permalink if @permalink and !cache_buster
-      
+
       date = self.date
-  
+
       # All of these variables can be put into a URL
-      permalink_attributes = { 
+      permalink_attributes = {
         "date" => date.strftime('%Y-%m-%d'),
         "slug" => slug,
         "title" => title_for_url,
@@ -82,50 +82,50 @@ module Plate
         "day" => day,
         "category" => category_for_url
       }
-      
+
       # Copy the permalink template as a starting point
       result = permalink_template.clone
-      
+
       # Replace all variables from the attributes into the template
       permalink_attributes.each { |key, value| result.gsub!(/:#{Regexp.escape(key)}/, value) }
-       
+
       # Remove any double slashes
       result.gsub!(/\/\//, '/')
-      
+
       # Remove file extensions, and cleanup URL
       result = result.split('/').reject{ |segment| segment =~ /^\.+$/ }.join('/')
-      
+
       @permalink = result
     end
-    
+
     # The template to use when generating the permalink.
     def permalink_template
       self.site.options[:permalink] || '/:category/:year/:month/:slug'
     end
 
-    # Returns the URL slug to use for this blog post. 
+    # Returns the URL slug to use for this blog post.
     #
     # This will convert the file name from a format like:
     #
     #     2012-01-01-post-name.md
     #
     # To simply:
-    # 
+    #
     #     post-name
     def slug
       name = self.basename.to_s.downcase.gsub(/^(\d{4}-\d{2}-\d{2})-/, '').split('.')[0]
       name.dasherize.parameterize
     end
-    
+
     # Utility method to sanitize tags output. Tags are returned as an array.
     def tags
-      @tags ||= (Array === self.meta[:tags] ? self.meta[:tags] : self.meta[:tags].to_s.strip.split(',')).collect(&:strip).sort
+      @tags ||= (Array === self.meta[:tags] ? self.meta[:tags] : self.meta[:tags].to_s.strip.split(',')).collect { |s| s.to_s.strip }.sort
     end
-    
+
     def year
       date.strftime('%Y')
     end
-    
+
     # Compare two posts, by date.
     def <=>(other)
       self.date <=> other.date

data/lib/plate/version.rb

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

data/lib/templates/config.yml

@@ -20,10 +20,24 @@ base_url: "http://example.com"
 # * `category`    - The category for this post
 permalink: "/posts/:year/:month/:slug"
 
-# New posts generated with the `plate post 'Title'` command can be put into a draft
-# state by setting this to true. Once your post is ready, add `publish: true` to the
-# meta information for that post and it will be published on the next build.
-draft: false
+# Options available for new posts generated with `plate post [Title]`
+posts:
+  # New posts generated with the `plate post 'Title'` command can be put into a draft
+  # state by setting this to true. Once your post is ready, add `publish: true` to the
+  # meta information for that post and it will be published on the next build.
+  draft: false
+
+  # The default layout to use for new posts. This layout should exist in `layouts/`
+  #layout: "default"
+
+  # The default category to use for new posts
+  #category: "posts"
+
+  # The default tags to use for new posts
+  #tags: [ tag1, tag2, tag3 ]
+
+  # The default body content for new posts.
+  #body: "Lorem ipsum dolor sit amet, consectetur adipiscing elit."
 
 # The default meta data for your site
 meta:

data/lib/templates/index.html

@@ -25,7 +25,7 @@ title: "Home"
     <h2>Publish</h2>
     <p>To publish your site, just drop the <em>public</em> directory into the root of any major web hosting server.</p>
     <p>If you are on a Mac you can easily run your site with the built-in web server by changing your destination directory to your user account&#8217;s <em>Sites</em> directory. You can do so by putting the following line in the plate.yml configuration file.</p>
-    <pre>destination: ~/Sites/</pre>
+    <pre>destination: ~/Sites/my-site</pre>
     <p>Note: this will overwrite anything existing in that folder, so be careful.</p>
   </div>
 </div>

metadata

@@ -1,19 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: plate
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre5
-  prerelease: 6
+  version: 0.7.0
+  prerelease: 
 platform: ruby
 authors:
 - John Tornow
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-16 00:00:00.000000000Z
+date: 2012-08-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70224087615620 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,15 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087615620
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: &70224087615160 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +37,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087615160
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70224087614540 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +53,15 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087614540
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.6'
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70224087614060 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +69,15 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087614060
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70224087613420 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +85,15 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087613420
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2'
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70224087612880 !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +101,12 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70224087612880
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
 description: Plate is a simple, static site generator and blog engine.
 email:
 - john@johntornow.com
@@ -147,8 +177,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.8.12
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.15
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A static site generator and blog engine.
 test_files: []
+has_rdoc: