rake task for upgrading your ruhoh blog from v0.3.0 to v1.0.0-alpha

Rakefile

require 'rubygems'
require 'ruhoh'
require 'yaml'

# ruhoh Upgrade Script
# ruhoh gem upgrade from 0.3.0 to 1.0.0-alpha
# ruhohSpec upgrade from  0.2 to 1.0
#
# How to Use:
# Create a file named 'Rakefile' in the root of your blog directory and place the full contents of this gist inside.
# Using the command-line, navigate to your blog directory and execute:
#
#   $ rake upgrade
#
task :upgrade do
  NewSitePath = 'new-site'
  puts "Generating new site into: #{NewSitePath}"
  FileUtils.mkdir_p NewSitePath
  
  # Extract _config.yml
  config_file = "_config.yml"
  config = {}
  puts "Parsing _config.yml"
  if File.exist? config_file
    if Ruhoh::Utils.respond_to?(:parse_yaml_file)
      config = Ruhoh::Utils.parse_yaml_file(config_file)
    else
      config = Ruhoh::Utils.parse_file_as_yaml(config_file)
    end
  end
  
  # config.ru
  # -------------------------------------------------------------
  puts "Copying config.ru"
  FileUtils.cp 'config.ru', File.join(NewSitePath, 'config.ru') if File.exist? 'config.ru'
  
  # site.yml
  # -------------------------------------------------------------
  puts "Copying _site.yml"
  FileUtils.cp '_site.yml', File.join(NewSitePath, 'site.yml') if File.exist? '_site.yml'

  # Main Directories
  # -------------------------------------------------------------
  puts "Copying main directories..."
  ['_media', '_pages', '_plugins', '_posts'].each do |name|
    if FileTest.directory? name
      FileUtils.cp_r name, File.join(NewSitePath, name.gsub('_', ''))
    end
  end
  
  # analytics
  # -------------------------------------------------------------
  puts "Updating analytics to widget"
  analytics = File.join(NewSitePath, 'widgets', 'analytics', 'config.yml')
  if config['analytics']
    config['analytics']['layout'] = config['analytics']['provider']
    config['analytics'].delete('provider')
  end
  FileUtils.mkdir_p File.dirname(analytics)
  File.open(analytics, 'w:UTF-8') do |file|
    file.puts config['analytics'].to_yaml
  end
  config.delete('analytics')

  # comments
  # -------------------------------------------------------------
  puts "Updating comments to widget"
  comments = File.join(NewSitePath, 'widgets', 'comments', 'config.yml')
  if config['comments']
    config['comments']['layout'] = config['comments']['provider']
    config['comments'].delete('provider')
  end
  FileUtils.mkdir_p File.dirname(comments)
  File.open(comments, 'w:UTF-8') do |file|
    file.puts config['comments'].to_yaml
  end
  config.delete('comments')
  
  # google_prettify
  # -------------------------------------------------------------
  puts "Updating syntax to google_prettify widget"
  google_prettify = File.join(NewSitePath, 'widgets', 'google_prettify', 'config.yml')
  FileUtils.mkdir_p File.dirname(google_prettify)
  
  linenums = config['syntax']['google_prettify']['linenums'] rescue nil
  linenums ||= false
  File.open(google_prettify, 'w:UTF-8') do |file|
    linenums = {"linenums" => linenums }.to_yaml
    file.puts linenums
  end
  config.delete('syntax')

  # config.yml
  # Generate this after widgets so widget config objects are removed.
  # -------------------------------------------------------------
  puts "Updating config.yml parameters"
  config['RuhohSpec'] = '1.0'
  config['posts'] = {
    "permalink" => config['permalink'],
    "exclude" => config['exclude']
  }
  config.delete('permalink')
  config.delete('exclude')
  
  File.open(File.join(NewSitePath, "config.yml"), 'w:UTF-8') do |file|
    file.puts config.to_yaml
  end
  
  
  # Themes
  # -------------------------------------------------------------
  puts "Moving themes folder"
  themes = File.join(Dir.pwd, "_templates", "themes")
  FileUtils.cp_r themes, NewSitePath
  
  # Partials
  # -------------------------------------------------------------
  puts "Moving partials folder"
  partials = File.join(Dir.pwd, "_templates", "partials")
  FileUtils.cp_r partials, NewSitePath


  # Adding New Theme
  # -------------------------------------------------------------
  git_url = 'https://github.com/ruhoh/twitter.git'
  new_theme_path = File.join(NewSitePath, 'themes', 'twitter-for-1.0')
  puts "Trying to git clone #{git_url} into #{new_theme_path}"
  puts "  If this fails, you can always try it manually."
  system('git', 'clone', git_url , new_theme_path)
end

release notes

The new stock twitter theme is provided at themes/twitter-for-1.0. You can optionally set this to your theme in config.yml in order to check out the changes.

Any reason not to do it by default? Migration is a tad hairy:

Mustache::Parser::SyntaxError at /my-post
Unclosed tag Line 91 {{> categories_list }} ^

Fix:

new-site/config.yml
-theme: twitter
+theme: twitter-for-1.0

rm -r themes/twitter

@mockturtl I have no guarantees that the user has not otherwise customized the default twitter theme, making automatic theme resetting a bit unintuitive perhaps? I did wrestle with the idea since upon reload you'd be able to have a functioning blog once again.

Regarding the mustache error, is the unclosed tag in theme-for-1.0 or in a file on your end?

I did wrestle with the idea since upon reload you'd be able to have a functioning blog once again.

I guess the question is where to pay the cost of breaking changes, in duplicating design effort, or debugging. I think you can assume users know git (to recover customization), but not necessarily how to fix server errors.

Regarding the mustache error, is the unclosed tag in theme-for-1.0 or in a file on your end?

That's the twitter theme, unmodified -- it's the first {{> partial in the post layout.

A fix, as you mentioned, is s/{{ content }}/{{{ content }}}/, but the CSS is still broken.

(I was diagnosing that when I realized I was supposed to upgrade to twitter-for-1.0, which works perfectly.)