plate 0.7.0.pre → 0.7.0.pre2

data/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 * Added support for view partials
 * Reload page layout when re-rendering a page
+* Added support for draft posts. Draft posts are located in `drafts/`
 
 ## Plate 0.6.3
 

data/README.md

@@ -71,6 +71,7 @@ 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)
 * 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.
@@ -115,9 +116,13 @@ 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.
 
+### Draft Posts
+
+**In development -docs coming soon.**
+
 ### Partials
 
-**Coming Soon.**
+**In development -docs coming soon.**
 
 ## Full Documentation
 

data/lib/plate.rb

@@ -28,6 +28,7 @@ module Plate
   autoload :HashProxy,                      'plate/hash_proxy'
 
   autoload :Asset,                          'plate/asset'
+  autoload :Draft,                          'plate/draft'
   autoload :DynamicPage,                    'plate/dynamic_page'
   autoload :Partial,                        'plate/partial'
   autoload :Page,                           'plate/page'

data/lib/plate/builder.rb

@@ -215,6 +215,13 @@ module Plate
           end
 
           page.reload!
+
+          # If this page was a draft, and now is published. Reload the entire site
+          # and publish it.
+          if Draft === page and page.publish?
+            rebuild! and return
+          end
+
           page.write!
 
           # File should exist again, even though we just removed it since we re-wrote it.
@@ -439,6 +446,7 @@ module Plate
           paths += site.assets.collect(&:write!)
           paths += site.pages.collect(&:write!)
           paths += site.posts.collect(&:write!)
+          paths += site.drafts.collect(&:write!)
 
           @build_paths = paths
 

data/lib/plate/cli.rb

@@ -41,6 +41,10 @@ module Plate
           @destination = File.expand_path(d)
         end
 
+        opts.on("--[no-]draft", "Create a new post as a draft.") do |v|
+          options[:draft] = v
+        end
+
         opts.on('--layout [LAYOUT]', '-l', 'Pass in a layout for creating a new post.') do |l|
           options[:layout] = l
         end
@@ -163,6 +167,7 @@ module Plate
           /
           config
           content
+          drafts
           content/css
           layouts
           lib
@@ -209,14 +214,25 @@ module Plate
 
         category = options[:category] ? "\ncategory: #{options[:category]}" : ""
         layout = options[:layout] ? "\nlayout: #{options[:layout]}" : ""
+        publish = "\npublish: false"
+        label = "draft"
+
+        filename = File.join(self.source, 'drafts', "#{date.strftime('%Y-%m-%d')}-#{slug}.md")
+
+        # If drafts are disabled, just build the post and put it in its
+        # normal destination file.
+        if options[:draft] == false
+          filename = File.join(self.source, 'posts', date.strftime('%Y/%m'), "#{date.strftime('%Y-%m-%d')}-#{slug}.md")
+          publish = ""
+          label = "post"
+        end
 
-        filename = File.join(self.source, 'posts', date.strftime('%Y/%m'), "#{date.strftime('%Y-%m-%d')}-#{slug}.md")
-        content = %Q(---\ntitle: "#{title}"\ndate: #{date.strftime('%Y-%m-%d %H:%M:%S')}#{category}#{layout}\ntags: []\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: []#{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.)
 
         FileUtils.mkdir_p(File.dirname(filename))
         File.open(filename, 'w') { |f| f.write(content) }
 
-        puts "New post file added [#{filename}]"
+        puts "New #{label} file added [#{filename}]"
       end
 
       def create_template(path, template, root, root_path)

data/lib/plate/draft.rb

@@ -0,0 +1,33 @@
+module Plate
+  # Draft posts are located in the drafts/ folder and are not yet published.
+  #
+  # Add a publish: true meta flag to any draft post to publish it automatically
+  # on the next build.
+  class Draft < Post
+    # Draft posts are placed in the /_drafts/ directory
+    def file_path
+      "/_drafts#{permalink}/index.html"
+    end
+
+    # Is this post ready to be published? (assumes meta data value of publish: true)
+    def publish?
+      !!self.meta[:publish]
+    end
+
+    # If this post is ready to be published, move it to its proper place in posts/
+    def publish!
+      return unless publish?
+
+      new_file = File.join(self.site.source, 'posts', self.date.strftime('%Y/%m'), self.basename)
+
+      self.site.log("Publishing draft #{self.name}")
+
+      if File.exists?(self.file) and !File.exists?(new_file)
+        FileUtils.mkdir_p(File.dirname(new_file))
+        FileUtils.mv(self.file, new_file)
+      end
+
+      new_file
+    end
+  end
+end

data/lib/plate/site.rb

@@ -6,12 +6,45 @@ module Plate
   class Site
     include Callbacks
 
-    attr_accessor :assets, :build_destination, :cache_location, :destination,
-                  :layouts, :logger, :metadata, :options, :pages, :posts, :source
+    # [Array] An array of all dynamic assets for this site
+    attr_accessor :assets
 
-    # An array of all view partials available in this site.
+    # [String] The directory where the built site will be created for this site.
+    attr_accessor :build_destination
+
+    # [String] The file path of the cache directory for this site.
+    attr_accessor :cache_location
+
+    # [String] The destination directory file path for this site
+    attr_accessor :destination
+
+    # [Array] Any posts marked as drafts for this site
+    attr_accessor :drafts
+
+    # [Array] An array of all layout classes used for this site
+    attr_accessor :layouts
+
+    # [Object] The logger instance for this site.
+    attr_accessor :logger
+
+    # [Hash] A hash of all default meta data options for this site.
+    attr_accessor :metadata
+
+    # [Hash] A hash of configuration options for this site
+    attr_accessor :options
+
+    # [Array] An array of all non-blog post pages for this site
+    attr_accessor :pages
+
+    # [Array] An array of all view partials available in this site.
     attr_accessor :partials
 
+    # [PostCollection] All blog posts for this site
+    attr_accessor :posts
+
+    # [String] The source directory file path for building this site
+    attr_accessor :source
+
     def initialize(source, destination, options = {})
       # Setup source and destination for the site files
       self.source = source
@@ -28,12 +61,12 @@ module Plate
       clear
     end
 
-    %w( assets layouts pages posts ).each do |group|
+    %w( assets drafts 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
+      @all_files ||= self.assets + self.layouts + self.pages + self.posts.to_a + self.drafts
     end
 
     # All extensions that are registered, as strings.
@@ -57,6 +90,7 @@ module Plate
       self.pages = []
       self.posts = PostCollection.new
       self.partials = []
+      self.drafts = []
 
       @metadata = {}
     end
@@ -279,8 +313,10 @@ module Plate
 
       # Load blog posts from posts/
       def load_posts!(verbose = true)
+        @drafts = []
         @posts = PostCollection.new
 
+        # Load up all published posts from posts/ directory
         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)
@@ -294,6 +330,27 @@ module Plate
           end
         end
 
+        # Load up any drafts, and publish as needed
+        Dir.glob(File.join(source, "drafts/**/*")).each do |file|
+          # If this 'file' is a directory, just skip it. We only care about files.
+          unless File.directory?(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 == "---"
+              draft = Draft.new(self, file)
+
+              if draft.publish?
+                new_file = draft.publish!
+                @posts.add(Post.new(self, new_file))
+              else
+                @drafts << draft
+              end
+            end
+          end
+        end
+
         @posts.sort!
 
         log("#{@posts.size} posts loaded") if verbose

data/lib/plate/version.rb

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

data/lib/templates/config.yml

@@ -1,7 +1,31 @@
 # encoding: UTF-8
-
+#
+# Plate Configuration File
+# ========================
+#
+# The root domain and protocol for this website
 base_url: "http://example.com"
+
+# The default format for URL structure of blog posts.
+# Variables starting with a colon will be replaced with the value for that
+# post on build.
+#
+# Variable options are:
+# * `date`        - The date of this post, formatted as YYYY-MM-DD
+# * `title`       - The title of this post, formatted for URL
+# * `slug`        - The blog post URL slug (the name of the post)
+# * `year`        - The 4-digit year of this post
+# * `month`       - The 2-digit month for this post
+# * `day`         - The 2-digit day of month for this post
+# * `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
+
+# The default meta data for your site
 meta:
   title: "My New Site"
   description: "A really great site, generated with Plate!"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate
 version: !ruby/object:Gem::Version
-  version: 0.7.0.pre
+  version: 0.7.0.pre2
   prerelease: 6
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-07-31 00:00:00.000000000Z
+date: 2012-08-07 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70256245018440 !ruby/object:Gem::Requirement
+  requirement: &70317428454140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245018440
+  version_requirements: *70317428454140
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: &70256245018040 !ruby/object:Gem::Requirement
+  requirement: &70317428453760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245018040
+  version_requirements: *70317428453760
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70256245017460 !ruby/object:Gem::Requirement
+  requirement: &70317428453220 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245017460
+  version_requirements: *70317428453220
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70256245017040 !ruby/object:Gem::Requirement
+  requirement: &70317428452800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245017040
+  version_requirements: *70317428452800
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70256245016500 !ruby/object:Gem::Requirement
+  requirement: &70317428452260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245016500
+  version_requirements: *70317428452260
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70256245016000 !ruby/object:Gem::Requirement
+  requirement: &70317428451720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70256245016000
+  version_requirements: *70317428451720
 description: Plate is a simple, static site generator and blog engine.
 email:
 - john@johntornow.com
@@ -92,6 +92,7 @@ files:
 - lib/plate/builder.rb
 - lib/plate/callbacks.rb
 - lib/plate/cli.rb
+- lib/plate/draft.rb
 - lib/plate/dsl.rb
 - lib/plate/dynamic_page.rb
 - lib/plate/engine.rb