octopress 3.0.0.rc.18 → 3.0.0.rc.19

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e06beb1aacea443d9b080887b53f8b9b7a705a47
-  data.tar.gz: 236b3fbb3766813875bf93391bcfd62603a88430
+  metadata.gz: 289b5305d8acc880d13c4fa6a1d38a380c832f89
+  data.tar.gz: 8276219b3fce82545abaa5f55f31299c344794e5
 SHA512:
-  metadata.gz: b6f281eb30ffe7a95d4226474f5dc34d0ac36f7d06210a31f2303f083f78921c9b5402ca567d2bbb785e1f3ef6cc7251053cacda7741850f0e34d2d4c4a833a6
-  data.tar.gz: 73ca967e81a63cc7ae0eea83c8a916269be385f6d8d8f57750df4df18df46623164df3220b72dedbdfac65bb7c7e6fb45d4a942c4d033007702bd6a5be4ed444
+  metadata.gz: d12b6c564acff5052258b854f43e050bd7e21645f60591396adc9299ca2754cdcdb5e75c7d328bc68da92d27092ec443075d2a3164438d5e1c5a88bccab9009e
+  data.tar.gz: 4e4474c9b455b185140eec13076c2149c45130e27e5760f48c64c4d22795b7727a58238d69d7167c83ce065919816b3e2755830637b87c86efa5b8f3799e3cdf

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Octopress Changelog
 
+### 3.0.0 RC19 - 2014-12-09
+
+- Improvements to configuration management.
+- Now using _config.yml for configuration instead of _octopress.yml
+
 ### 3.0.0 RC18 - 2014-12-08
 
 - Loads site plugins before creating new pages, posts and drafts, allowing liquid tag processing in _template files.

data/assets/docs/index.md

@@ -42,8 +42,8 @@ $ octopress init <PATH> [options]
 This will copy Octopress's scaffolding into the specified directory. Use the `--force` option to overwrite existing files. The scaffolding is pretty simple:
 
 ```
-_octopress.yml
 _templates/
+  draft
   post
   page
 ```
@@ -149,15 +149,32 @@ Octopress post and page templates look like this.
 layout: {{ layout }}
 title: {{ title }}
 ---
-
 ```
 
-The YAML variables will be replaced with the correct content when you create a page or post. To modify this template create a `_templates/post` file and change it as you wish. You can add additional YAML front-matter or content, and you can even create multiple templates. Choose a custom template when creating a new post or page like this.
+Dates get automatically added to a template for posts, and for pages if a --date option is set.
+
+You can add to the YAML front matter, add content below and even even use liquid tags and filters from your site's plugins. There are
+a handful of local variables you can use when working with templates.
+
+| Variable           | Description                               |
+|:-------------------|:------------------------------------------|
+| `date`             | The date (if set) or Time.now.iso8601     |
+| `title`            | The title of the page (if set)            |
+| `slug`             | The title in slug form                    |
+| `ymd`              | The date string, YYYY/MM/DD format        |
+| `year`             | The date's year                           |
+| `month`            | The date's month, MM                      |
+| `day`              | The date's day, DD                        |
+
+By default Octopress has templates for pages, posts and drafts. You can change them or create new ones for different types of content.
+To create linkposts template, add a file at `_templates/linkpost` and use it with a new post like this:
 
 ```sh
 $ octopress new post --template _templates/linkpost
 ```
 
+File name extensions are unnecessary since they're just plain text anyway.
+
 ## Isolate
 
 If your site is taking a while to build, but you want to preview a post quickly, you can isolate that post temporarily with the isolate command. Here's the syntax:
@@ -176,7 +193,7 @@ To reintegrate all exiled posts, run `octopress integrate` which will restore al
 
 ## Configuration
 
-Octopress reads its configurations from `_octopress.yml`. Here's what the configuration looks like by default.
+Octopress reads its configurations from `_config.yml`. Here's what the configuration looks like by default.
 
 ```yaml
 # Default extension for new posts and pages

data/lib/octopress/commands/helpers.rb

@@ -8,15 +8,6 @@ module Octopress
 
     def self.add_common_options(c)
       c.option 'config',           '--config <CONFIG_FILE>[,CONFIG_FILE2,...]', Array, 'Custom Jekyll configuration file'
-      c.option 'octopress-config', '--octopress-config <CONFIG_FILE>', 'Custom Octopress configuration file'
-    end
-
-    def self.site(options)
-      options = {'config' => options['config']}
-      Jekyll.logger.log_level = :error
-      site = Jekyll::Site.new(Jekyll.configuration(options))
-      Jekyll.logger.log_level = :info
-      site
     end
   end
 end

data/lib/octopress/commands/new.rb

@@ -25,7 +25,7 @@ module Octopress
 
           c.action do |args, options|
             options['path'] = args.first
-            Page.new(CommandHelpers.site(options), options).write
+            Page.new(Octopress.site(options), options).write
           end
         end
 
@@ -39,7 +39,7 @@ module Octopress
 
           c.action do |args, options|
             options['title'] = args.first
-            Post.new(CommandHelpers.site(options), options).write
+            Post.new(Octopress.site(options), options).write
           end
         end
 
@@ -52,7 +52,7 @@ module Octopress
 
           c.action do |args, options|
             options['title'] = args.first
-            Draft.new(CommandHelpers.site(options), options).write
+            Draft.new(Octopress.site(options), options).write
           end
         end
       end

data/lib/octopress/commands/publish.rb

@@ -13,7 +13,7 @@ module Octopress
           abort "You must specify a path." if args.empty?
           options['path'] = args.first
           options['type'] = 'post from draft'
-          Draft.new(CommandHelpers.site(options), options).publish
+          Draft.new(Octopress.site(options), options).publish
         end
       end
     end

data/lib/octopress/page.rb

@@ -13,7 +13,7 @@ module Octopress
 
     def initialize(site, options)
       @site = site
-      @site.plugin_manager.conscientious_require
+      site.plugin_manager.conscientious_require
       @config = DEFAULT_OPTIONS.merge(site.config)
       @options = options
       set_default_options
@@ -29,6 +29,10 @@ module Octopress
       @content = options['content'] || content
     end
 
+    def site
+      @site
+    end
+
     def write
       if File.exist?(path) && !@options['force']
         raise "File #{relative_path(path)} already exists. Use --force to overwrite."
@@ -70,10 +74,6 @@ module Octopress
       path.sub(local, '')
     end
 
-    def site
-      @site
-    end
-
     def path
       return @path if @path
       file = @options['path']
@@ -107,15 +107,16 @@ module Octopress
     def convert_date(date)
       date ||= 'now'
       if date == 'now'
-        @options['date'] = Time.now.iso8601
+        date = Time.now.iso8601
       else
         begin
-          Time.parse(date.to_s, Time.now).iso8601
+          date = Time.parse(date.to_s, Time.now).iso8601
         rescue => error
           puts 'Could not parse date. Try formatting it like YYYY-MM-DD HH:MM'
           abort error.message
         end
       end
+      date
     end
 
     # Load the user provided or default template for a new post or page.
@@ -148,9 +149,19 @@ module Octopress
     # Render Liquid vars in YAML front-matter.
     def parse_template(input)
 
+      vars = @options.dup
+
       if @config['titlecase']
-        @options['title'].titlecase!
+        vars['title'].titlecase!
       end
+
+      vars['slug'] = title_slug
+      date = Time.parse(vars['date'] || Time.now.iso8601)
+      vars['year'] = date.year
+      vars['month'] = date.strftime('%m')
+      vars['day'] = date.strftime('%d')
+      vars['ymd'] = date.strftime('%D')
+
       # If possible only parse the YAML front matter.
       # If YAML front-matter dashes aren't present parse the whole 
       # template and add dashes.
@@ -159,20 +170,33 @@ module Octopress
       parsed = if input =~ /\A-{3}\s+(.+?)\s+-{3}(.+)?/m
         input = $1
         content = $2
-        if @options['date'] && !(input =~ /date:/)
-          input += "\ndate: #{@options['date']}"
+        if vars['date'] && !(input =~ /date:/)
+          input += "\ndate: #{vars['date']}"
         end
       else
         content = ''
       end
 
       template = Liquid::Template.parse(input)
-      "---\n#{template.render(@options).strip}\n---\n#{content}"
+      "---\n#{template.render(vars).strip}\n---\n#{content}"
     end
 
     def date_slug
       @options['date'].split('T')[0]
     end
+    
+    # Returns a string which is url compatible.
+    #
+    def title_slug
+      value = (@options['slug'] || @options['title']).downcase
+      value.gsub!(/[^\x00-\x7F]/u, '')
+      value.gsub!(/(&|&)+/, 'and')
+      value.gsub!(/[']+/, '')
+      value.gsub!(/\W+/, ' ')
+      value.strip!
+      value.gsub!(' ', '-')
+      value
+    end
 
     def front_matter(vars)
       fm = []

data/lib/octopress/post.rb

@@ -27,18 +27,5 @@ module Octopress
       front_matter %w{layout title date}
     end
 
-    # Returns a string which is url compatible.
-    #
-    def title_slug
-      value = (@options['slug'] || @options['title']).downcase
-      value.gsub!(/[^\x00-\x7F]/u, '')
-      value.gsub!(/(&|&)+/, 'and')
-      value.gsub!(/[']+/, '')
-      value.gsub!(/\W+/, ' ')
-      value.strip!
-      value.gsub!(' ', '-')
-      value
-    end
-
   end
 end

data/lib/octopress/version.rb

@@ -1,3 +1,3 @@
 module Octopress
-  VERSION = "3.0.0.rc.18"
+  VERSION = "3.0.0.rc.19"
 end

data/lib/octopress.rb

@@ -2,7 +2,6 @@ require 'mercenary'
 require 'titlecase'
 
 module Octopress
-  require 'octopress/configuration'
   require 'octopress/command'
   require 'octopress/version'
   require 'octopress/commands/new'
@@ -28,8 +27,25 @@ module Octopress
     @logger
   end
 
-  def self.config(options={})
-    @config ||= Configuration.config(options)
+  # Cache Jekyll's site configuration
+  #
+  def self.configuration(options={})
+    if @site
+      @site.config
+    else
+      @config ||= Jekyll.configuration({'config' => options['config']})
+    end
+  end
+
+  # Cache Jekyll's site
+  #
+  def self.site(options={})
+    if !@site
+      Jekyll.logger.log_level = :error
+      @site = Jekyll::Site.new(configuration(options))
+      Jekyll.logger.log_level = :info
+    end
+    @site
   end
 
   def self.gem_dir(dir='')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: octopress
 version: !ruby/object:Gem::Version
-  version: 3.0.0.rc.18
+  version: 3.0.0.rc.19
 platform: ruby
 authors:
 - Brandon Mathis
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: mercenary
@@ -178,7 +178,6 @@ files:
 - lib/octopress/commands/isolate.rb
 - lib/octopress/commands/new.rb
 - lib/octopress/commands/publish.rb
-- lib/octopress/configuration.rb
 - lib/octopress/draft.rb
 - lib/octopress/isolate.rb
 - lib/octopress/page.rb
@@ -187,14 +186,12 @@ files:
 - lib/octopress/utils.rb
 - lib/octopress/version.rb
 - octopress.gemspec
-- scaffold/_octopress.yml
 - scaffold/_templates/draft
 - scaffold/_templates/page
 - scaffold/_templates/post
 - test/Gemfile
 - test/_config.yml
 - test/_expected/blank/_config.yml
-- test/_expected/blank/_octopress.yml
 - test/_expected/blank/_templates/draft
 - test/_expected/blank/_templates/page
 - test/_expected/blank/_templates/post
@@ -226,10 +223,6 @@ files:
 - test/_expected/publish-draft/_posts/2014-03-10-some-cool-idea.markdown
 - test/_layouts/page.html
 - test/_layouts/post.html
-- test/_octopress.yml
-- test/_templates/draft
-- test/_templates/page
-- test/_templates/post
 homepage: http://octopress.org
 licenses:
 - MIT
@@ -259,7 +252,6 @@ test_files:
 - test/Gemfile
 - test/_config.yml
 - test/_expected/blank/_config.yml
-- test/_expected/blank/_octopress.yml
 - test/_expected/blank/_templates/draft
 - test/_expected/blank/_templates/page
 - test/_expected/blank/_templates/post
@@ -291,7 +283,3 @@ test_files:
 - test/_expected/publish-draft/_posts/2014-03-10-some-cool-idea.markdown
 - test/_layouts/page.html
 - test/_layouts/post.html
-- test/_octopress.yml
-- test/_templates/draft
-- test/_templates/page
-- test/_templates/post

data/lib/octopress/configuration.rb

@@ -1,54 +0,0 @@
-module Octopress
-  module Configuration
-
-    DEFAULTS = {
-      'post_ext' => 'markdown',
-      'page_ext' => 'html',
-      'post_layout' => 'post',
-      'page_layout' => 'page',
-      'titlecase' => true
-    }
-
-    # Read _octopress.yml and merge with defaults
-    #
-    def self.config(options={})
-
-      # Cache loading the config file
-      unless @user_config
-        file = options['octopress-config'] || '_octopress.yml'
-
-        if File.exist? file
-          config = SafeYAML.load_file(file) || {}
-        else
-          config = {}
-        end
-        
-        # Allow cli extensioins to override default user configuration
-        if options['override']
-          config = Jekyll::Utils.deep_merge_hashes(config, options['override'])
-        end
-
-        # Merge Octopress defaults
-        @user_config = Jekyll::Utils.deep_merge_hashes(DEFAULTS, config)
-      end
-
-      @user_config
-    end
-
-    # Read Jekyll's _config.yml merged with Jekyll's defaults
-    #
-    def self.jekyll_config(options={})
-      return @jekyll_config if @jekyll_config
-
-      configs = Jekyll::Configuration::DEFAULTS
-
-      (options['config'] || ['_config.yml']).each do |file|
-        if File.exist? file
-          configs = Jekyll::Utils.deep_merge_hashes(configs, SafeYAML.load_file(file) || {})
-        end
-      end
-
-      @jekyll_config = configs
-    end
-  end
-end

data/scaffold/_octopress.yml

@@ -1,11 +0,0 @@
-# Default extension for new posts and pages
-post_ext: markdown
-page_ext: html
-
-# Default templates for posts and pages
-# Found in _templates/
-post_layout: post
-page_layout: page
-
-# Format titles with titlecase?
-titlecase: true

data/test/_expected/blank/_octopress.yml

@@ -1,11 +0,0 @@
-# Default extension for new posts and pages
-post_ext: markdown
-page_ext: html
-
-# Default templates for posts and pages
-# Found in _templates/
-post_layout: post
-page_layout: page
-
-# Format titles with titlecase?
-titlecase: true

data/test/_octopress.yml

@@ -1,11 +0,0 @@
-# Default extension for new posts and pages
-post_ext: markdown
-page_ext: html
-
-# Default templates for posts and pages
-# Found in _templates/
-post_layout: post
-page_layout: page
-
-# Format titles with titlecase?
-titlecase: true

data/test/_templates/draft

@@ -1,4 +0,0 @@
----
-layout: {{ layout }}
-title: {{ title }}
----

data/test/_templates/page

@@ -1,4 +0,0 @@
----
-layout: {{ layout }}
-title: {{ title }}
----

data/test/_templates/post

@@ -1,5 +0,0 @@
----
-layout: {{ layout }}
-title: {{ title }}
-date: {{ date }}
----