plate 0.5.3 → 0.5.4

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 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.
+
 ## Plate 0.5.3
 
 * Added support for Sass @import statements.

data/README.md

@@ -2,9 +2,11 @@
 
 [![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. It takes a folder full of Markdown files and turns it into a site that you can host anywhere. The output is a plain old static HTML site. In addition to basic formatting with Markdown, Plate also supports generating asset files with CoffeeScript, Sass and others.
+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. 
 
-Requires Ruby 1.9.2 or 1.9.3. For additional processing, install CoffeeScript, Sass, Haml and other formatters.
+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.
+
+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.
 
 ## Installation
 
@@ -16,10 +18,20 @@ Or, create a `Gemfile` and add:
 
 ## Command line
 
+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:
 
     platify .
     
+Or, with the normal `plate` command:
+
+    plate new .
+    
+### Building a site
+     
 To build your site, run:
 
     plate build
@@ -31,6 +43,29 @@ Or, just run `plate` without any options to build the site.
 To show details about the site build, enable verbose mode:
 
     plate --verbose
+    
+When writing a post, it is sometimes helpful to watch the site for changes and just reload content after each file save. To enable this mode, run the build command with the `--watch` option. Every time a file is saved, the utility will rebuild that file so you can simply hit refresh in your browser to see the changes without rebuilding the entire site.
+
+    plate --watch
+    
+### Creating a new post
+    
+To create a new blog post with the default options, run:
+
+    plate post "New Post Name"
+    
+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:
+
+    # In config/plate.yml
+    ...
+    post_defaults:
+      category: Articles
+      layout: post
+    ...
 
 ## Directory Structure
 
@@ -76,6 +111,10 @@ An example of a helper file located in `lib/sample_helper.rb`
     
 Then, in your `.erb` view you can call `sample_helper_method`.
 
+## Full Documentation
+
+View the [full documentation on rdoc.info](http://rdoc.info/gems/plate/frames)
+
 ## Issues
 
 If you have any issues or find bugs running Plate, please [report them on Github](https://github.com/jdtornow/plate/issues). While most functions should be stable, Plate is still in its infancy and certain issues may be present.

data/lib/plate/builder.rb

@@ -33,6 +33,12 @@ module Plate
       @loaded = false
     end
     
+    # Returns the options for this site.
+    def config
+      self.load!
+      @options
+    end
+    
     # A unique id for this site, based off of the source directory
     def id
       check_source!
@@ -223,6 +229,12 @@ module Plate
       # option:
       #
       #     Builder.new(source, destination, :config => 'config/other-file.yml')
+      # 
+      # On the command line when building a site, or creating a new post, you can specify the 
+      # custom config file as a command line option as well:
+      #
+      #     plate build --config config/other-file.yml
+      # 
       def load_config_file!
         config_file = 'config/plate.yml'
         
@@ -249,6 +261,7 @@ module Plate
 
             if yml
               yml.symbolize_keys!
+              yml.values.select { |value| Hash === value }.each { |hash| hash.symbolize_keys! }
               @options = @options.reverse_merge(yml)
               log("Options loaded from file", :indent)
             end

data/lib/plate/cli.rb

@@ -33,6 +33,10 @@ module Plate
           options[:category] = c
         end
         
+        opts.on('--config [PATH]', '-C', 'Set the config file location for the site.') do |c|
+          options[:config] = c
+        end
+        
         opts.on('--destination [PATH]', '-d', 'Set the destination directory for this build.') do |d|
           @destination = File.expand_path(d)
         end
@@ -184,11 +188,17 @@ module Plate
         title = args.size == 0 ? "" : args[0]
         slug = title.parameterize
         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])
+        end
+        
         category = options[:category] ? "\ncategory: #{options[:category]}" : ""
         layout = options[:layout] ? "\nlayout: #{options[:layout]}" : ""
         
         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\n)
+        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.)
         
         FileUtils.mkdir_p(File.dirname(filename))
         File.open(filename, 'w') { |f| f.write(content) }

data/lib/plate/helpers/blogging_helper.rb

@@ -57,6 +57,11 @@ module Plate
       @post_index ||= self.posts.index(self.post)
     end
     
+    # Find all posts for the given category
+    def posts_for_category(category)
+      self.posts.select { |p| p.category == category }
+    end
+    
     # Find all posts for the given year, month and optional category.
     def posts_for_month(year, month, category = nil)
       result = []

data/lib/plate/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plate
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-03-12 00:00:00.000000000Z
+date: 2012-03-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
-  requirement: &70129250117980 !ruby/object:Gem::Requirement
+  requirement: &70215040139900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '3.2'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250117980
+  version_requirements: *70215040139900
 - !ruby/object:Gem::Dependency
   name: directory_watcher
-  requirement: &70129250117600 !ruby/object:Gem::Requirement
+  requirement: &70215040141660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250117600
+  version_requirements: *70215040141660
 - !ruby/object:Gem::Dependency
   name: i18n
-  requirement: &70129250117060 !ruby/object:Gem::Requirement
+  requirement: &70215040157640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: '0.6'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250117060
+  version_requirements: *70215040157640
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70129250116640 !ruby/object:Gem::Requirement
+  requirement: &70215040166620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250116640
+  version_requirements: *70215040166620
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: &70129250116100 !ruby/object:Gem::Requirement
+  requirement: &70215040168380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: '2'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250116100
+  version_requirements: *70215040168380
 - !ruby/object:Gem::Dependency
   name: tilt
-  requirement: &70129250115600 !ruby/object:Gem::Requirement
+  requirement: &70215040167820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -76,7 +76,7 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70129250115600
+  version_requirements: *70215040167820
 description: Plate is a simple, static site generator and blog engine.
 email:
 - john@johntornow.com