octopress 3.0.0.alpha1

data/lib/octopress/version.rb

@@ -0,0 +1,3 @@
+module Octopress
+  VERSION = '3.0.0.alpha1'
+end

data/lib/rake/clean.rake

@@ -0,0 +1,8 @@
+desc "Clean out caches: .pygments-cache, .gist-cache, .sass-cache, and Compass-generated files."
+task :clean do
+  rm_rf [".pygments-cache", ".gist-cache", File.join(Octopress.configuration[:source], "javascripts", "build")]
+  if Dir.exists? "stylesheets"
+    system "compass clean"
+    puts "## Cleaned Compass-generated files, and various caches ##"
+  end
+end

data/lib/rake/clobber.rake

@@ -0,0 +1,5 @@
+desc "Remove generated files (#{Octopress.configuration[:destination]} directory)."
+task :clobber do
+  rm_rf [Octopress.configuration[:destination]]
+  puts "## Cleaned generated site in #{Octopress.configuration[:destination]} ##"
+end

data/lib/rake/console.rake

@@ -0,0 +1,5 @@
+desc "Open Octopress console"
+task :console do
+  prompt = `which pry`.strip.empty? ? "irb" : "pry"
+  sh "#{prompt} -r./lib/octopress.rb", verbose: false
+end

data/lib/rake/deploy.rake

@@ -0,0 +1,4 @@
+desc "Default deploy task"
+task :deploy do
+  Rake::Task["#{Octopress.configuration[:deploy_default]}"].execute
+end

data/lib/rake/gen_deploy.rake

@@ -0,0 +1,2 @@
+desc "Generate website and deploy"
+task :gen_deploy => [:integrate, :generate, :deploy]

data/lib/rake/generate.rake

@@ -0,0 +1,4 @@
+desc "Generate Jekyll site"
+task :generate do
+  Octopress::Commands::Build.process(nil, nil)
+end

data/lib/rake/generate_only.rake

@@ -0,0 +1,14 @@
+# usage rake generate_only[my-post]
+desc "Generate only the specified post (much faster)"
+task :generate_only, :filename do |t, args|
+  if args.filename
+    filename = args.filename
+  else
+    filename = get_stdin("Enter a post file name: ")
+  end
+  puts "## Stashing other posts"
+  Rake::Task["isolate"].invoke(filename)
+  Rake::Task["generate"].execute
+  puts "## Restoring stashed posts"
+  Rake::Task["integrate"].execute
+end

data/lib/rake/hygiene.rake

@@ -0,0 +1,29 @@
+namespace :hygiene do
+  desc "Tidy up whitespace in all non-vendored files."
+  task :whitespace do
+    FileList[
+      "lib/**/*.{rb,rake,ru,feature,yml,md,markdown}",
+      "{Gemfile,Rakefile,*.md,*.markdown,*.ru,*.rb,.powrc,.rspec,.travis.yml,.slugignore,.gitignore,.gitattributes,.editorconfig}"
+    ].each do |fname|
+      next if(File.directory?(fname))
+      printf "Processing #{fname}..."
+      raw_contents = File.read(fname)
+      new_contents = raw_contents.
+        rstrip.        # Strip ALL trailing newlines.
+        split(/\n/).   # Now look at it per-line...
+        map(&:rstrip). # ... strip trailing WS per-line.
+        join("\n") +   # Now put it back together into one string.
+        "\n"           # And ensure EXACTLY one trailing newline.
+      if(raw_contents != new_contents)
+        printf " Cleaned!"
+        File.open(fname, "w") { |fh| fh.write(new_contents) }
+      end
+      printf "\n"
+    end
+  end
+
+  desc "Run the Rubocop static analyzer against Cthulhu."
+  task :rubocop do
+    sh 'rubocop -d Rakefile Gemfile lib'
+  end
+end

data/lib/rake/install.rake

@@ -0,0 +1,8 @@
+desc "Initial setup for Octopress: copies the default theme into the path of Jekyll's generator. Rake install defaults to rake install[classic] to install a different theme run rake install[some_theme_name]"
+task :install, :plugin do |t, args|
+  plugin = args.plugin
+  if plugin.nil? || plugin == ""
+    plugin = "classic-theme"
+  end
+  Octopress::DependencyInstaller.install_all(plugin)
+end

data/lib/rake/integrate.rake

@@ -0,0 +1,4 @@
+desc "Move all stashed posts back into the posts directory, ready for site generation."
+task :integrate do
+  FileUtils.mv Dir.glob("#{full_stash_dir}/*.*"), "#{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}/"
+end

data/lib/rake/isolate.rake

@@ -0,0 +1,13 @@
+# usage rake isolate[my-post]
+desc "Move all other posts than the one currently being worked on to a temporary stash location (stash) so regenerating the site happens much more quickly."
+task :isolate, :filename do |t, args|
+  if args.filename
+    filename = args.filename
+  else
+    filename = get_stdin("Enter a post file name: ")
+  end
+  FileUtils.mkdir(full_stash_dir) unless File.exist?(full_stash_dir)
+  Dir.glob("#{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}/*.*") do |post|
+    FileUtils.mv post, full_stash_dir unless post.include?(filename)
+  end
+end

data/lib/rake/list_drafts.rake

@@ -0,0 +1,7 @@
+# usage rake list_posts or rake list_posts[pub|unpub]
+desc "List all unpublished/draft posts"
+task :list_drafts do
+  posts = Dir.glob("#{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}/*.*")
+  unpublished = get_unpublished(posts)
+  puts unpublished.empty? ? "There are no posts currently in draft" : unpublished
+end

data/lib/rake/new.rake

@@ -0,0 +1,7 @@
+task :install, :plugin do |t, args|
+  plugin = args.plugin
+  if plugin.nil? || plugin == ""
+    plugin = "classic-theme"
+  end
+  Octopress::DependencyInstaller.install_all(plugin)
+end

data/lib/rake/new_page.rake

@@ -0,0 +1,49 @@
+# usage rake new_page[my-new-page] or rake new_page[my-new-page.html] or rake new_page (defaults to "new-page/index.html")
+desc "Create a new page in #{Octopress.configuration[:source]}/(filename)/index.#{Octopress.configuration[:new_page_ext]}"
+task :new_page, :filename do |t, args|
+  args.with_defaults(:filename => 'new-page')
+
+  if args.filename.downcase =~ /(^.+\/)?(.+?)\/?$/
+    page_dir = [Octopress.configuration[:source]]
+    filename, dot, extension = $2.rpartition('.').reject(&:empty?)         # Get filename and extension
+    page_dir.concat($1.downcase.sub(/^\//, '').split('/')) unless $1.nil?  # Add path to page_dir Array
+    title = filename
+
+    if extension.nil?
+      page_dir << filename
+      filename = "index"
+    end
+
+    page_dir = page_dir.map! { |d| d = d.to_url }.join('/')                # Sanitize path
+    filename = filename.downcase.to_url
+
+    page_template = Octopress.configuration[:templates][:page]
+    ext = page_template.delete :extension
+
+    extension ||= ext
+
+    file = "#{page_dir}/#{filename}.#{extension}"
+
+    if File.exist?(file)
+      abort("rake aborted!") if ask("#{file} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
+    end
+
+    mkdir_p page_dir unless Dir.exists? page_dir
+
+    page_template[:date] = time.iso8601 if page_template[:date]
+    page_template[:title] = title.gsub(/&/,'&amp;') if page_template[:title]
+
+    begin
+      time = now_in_timezone(Octopress.configuration[:timezone])
+      open(file, 'w') do |page|
+        page.puts page_template.to_yaml.gsub(/^:/m,'')
+        page.puts "---"
+      end
+    rescue
+      raise "Failed to create page: #{filename}"
+    end
+    puts "New page created: #{file}"
+  else
+    puts "Syntax error: #{args.filename} contains unsupported characters"
+  end
+end

data/lib/rake/new_post.rake

@@ -0,0 +1,32 @@
+# usage rake new_post[my-new-post] or rake new_post['my new post'] or rake new_post (defaults to "new-post")
+desc "Begin a new post in #{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}"
+task :new_post, :title do |t, args|
+  if args.title
+    title = args.title
+  else
+    title = get_stdin("Enter a title for your post: ")
+  end
+  title = title.titlecase if Octopress.configuration[:titlecase]
+  time = now_in_timezone(Octopress.configuration[:timezone])
+
+  posts_dir = "#{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}"
+  mkdir_p posts_dir unless Dir.exists? posts_dir
+  post_template = Octopress.configuration[:templates][:post]
+  filename = "#{Octopress.configuration[:source]}/#{Octopress.configuration[:posts_dir]}/#{time.strftime('%Y-%m-%d')}-#{title.to_url}.#{post_template.delete(:extension)}"
+
+  if File.exist?(filename)
+    abort("rake aborted!") if ask("#{filename} already exists. Do you want to overwrite?", ['y', 'n']) == 'n'
+  end
+
+  begin
+    post_template[:date] = time.iso8601 if post_template[:date]
+    post_template[:title] = title.gsub(/&/,'&') if post_template[:title]
+    open(filename, 'w') do |post|
+      post.puts post_template.to_yaml.gsub(/^:/m,'')
+      post.puts "---"
+    end
+  rescue
+    Raise "Failed to create post: #{filename}"
+  end
+  puts "Created new post: #{filename}"
+end

data/lib/rake/nuke.rake

@@ -0,0 +1,4 @@
+desc "Destroy your entire site."
+task :nuke do
+  rm_rf %w[.plugins _site config javascripts plugins public source stylesheets]
+end

data/lib/rake/preview.rake

@@ -0,0 +1,4 @@
+desc "preview the site in a web browser."
+task :preview do
+  Octopress::Commands::Serve.process([], {})
+end

data/lib/rake/push.rake

@@ -0,0 +1,37 @@
+desc "deploy public directory to github pages"
+multitask :push do
+  if File.directory?(Octopress.configuration[:deploy_dir])
+    puts "## Deploying branch to GitHub Pages "
+    (Dir["#{Octopress.configuration[:deploy_dir]}/*"]).each { |f| rm_rf(f) }
+    puts "Attempting pull, to sync local deployment repository"
+    cd "#{Octopress.configuration[:deploy_dir]}" do
+      system "git pull origin #{Octopress.configuration[:deploy_branch]}"
+    end
+    puts "\n## copying #{Octopress.configuration[:destination]} to #{Octopress.configuration[:deploy_dir]}"
+    cp_r "#{Octopress.configuration[:destination]}/.", Octopress.configuration[:deploy_dir]
+    cd "#{Octopress.configuration[:deploy_dir]}" do
+      File.new(".nojekyll", "w").close
+      system "git add -A"
+      message = "Site updated at #{Time.now.utc}"
+      puts "\n## Committing: #{message}"
+      system "git commit -m \"#{message}\""
+      puts "\n## Pushing generated #{Octopress.configuration[:deploy_dir]} website"
+      if system "git push origin #{Octopress.configuration[:deploy_branch]}"
+        puts "\n## GitHub Pages deploy complete"
+      else
+        remote = `git remote -v`
+        repo_url = case remote
+                   when /(http[^\s]+)/
+                     $1
+                   when /(git@[^\s]+)/
+                     $1
+                   else
+                     ""
+                   end
+        raise "\n## Octopress could not push to #{repo_url}"
+      end
+    end
+  else
+    puts "This project isn't configured for deploying to GitHub Pages\nPlease run `rake setup_github_pages[your-deployment-repo-url]`."
+  end
+end

data/lib/rake/rsync.rake

@@ -0,0 +1,20 @@
+desc "Deploy website via rsync"
+task :rsync do
+  exclude = ""
+  if File.exists?('./rsync-exclude')
+    exclude = "--exclude-from '#{File.expand_path('./rsync-exclude')}'"
+  end
+  puts "## Deploying website via Rsync"
+  ssh_key = if(!Octopress.configuration[:ssh_key].nil? && !Octopress.configuration[:ssh_key].empty?)
+    "-i #{ENV['HOME']}/.ssh/#{Octopress.configuration[:ssh_key]}"
+  else
+    ""
+  end
+  document_root = ensure_trailing_slash(Octopress.configuration[:document_root])
+  exit system("rsync -avze 'ssh -p #{Octopress.configuration[:ssh_port]} #{ssh_key}' #{exclude} #{Octopress.configuration[:rsync_args]} #{"--delete-after" unless !Octopress.configuration[:rsync_delete]} #{ensure_trailing_slash(Octopress.configuration[:destination])} #{Octopress.configuration[:ssh_user]}:#{document_root}")
+end
+
+def ensure_trailing_slash(val)
+  val = "#{val}/" unless(val.end_with?('/'))
+  return val
+end

data/lib/rake/set_root_dir.rake

@@ -0,0 +1,35 @@
+desc "Update configurations to support publishing to root or sub directory"
+task :set_root_dir, :dir do |t, args|
+  path = args.dir || nil
+  if path.nil?
+    path = get_stdin("Please provide a directory: ")
+  end
+  if path
+    if path == "/"
+      path = ""
+    else
+      path = "/" + path.sub(/(\/*)(.+)/, "\\2").sub(/\/$/, '');
+    end
+    # update personal configuration
+    site_configs = Octopress.configurator.read_config('site.yml')
+    site_configs[:destination] = "public#{path}"
+    root = "/#{path.sub(/^\//, '')}"
+    url = $1 if site_configs[:url] =~ /(https?:\/\/[^\/]+)/i
+    site_configs[:url] = url + path
+    site_configs[:subscribe_rss] = "#{path}/atom.xml"
+    site_configs[:root] = "#{root}"
+    Octopress.configurator.write_config('site.yml', site_configs)
+
+    rm_rf Octopress.configuration[:destination]
+    mkdir_p site_configs[:destination]
+    puts "\nYour _config/site.yml has been updated to the following"
+    output = <<-EOF
+
+  url: #{url + path}
+  destination: public#{path}
+  subscribe_rss: #{path}/atom.xml
+  root: #{root}
+EOF
+    puts output.yellow
+  end
+end

data/lib/rake/setup_github_pages.rake

@@ -0,0 +1,115 @@
+desc "Set up _deploy folder and deploy branch for GitHub Pages deployment"
+task :setup_github_pages, :repo do |t, args|
+  puts Octopress.configuration
+  if args.repo
+    repo_url = args.repo
+  else
+    puts "Enter the read/write url for your repository"
+    puts "(For example, 'git@github.com:your_username/your_username.github.io)"
+    repo_url = get_stdin("Repository url: ")
+  end
+  unless repo_url[-4..-1] == ".git"
+    repo_url << ".git"
+  end
+  raise "!! The repo URL that was input was malformed." unless (repo_url =~ /https:\/\/github\.(?:io|com)\/[^\/]+\/[^\/]+/).nil? or (repo_url =~ /git@github\.(?:io|com):[^\/]+\/[^\/]+/).nil?
+  user_match = repo_url.match(/(:([^\/]+)|(github\.(?:io|com)\/([^\/]+)))/)
+  user = user_match[2] || user_match[4]
+  branch = (repo_url =~ /\/[\w-]+\.github\.(?:io|com)/).nil? ? 'gh-pages' : 'master'
+  project = (branch == 'gh-pages') ? repo_url.match(/\/(.+)(\.git)/)[1] : ''
+  url = "http://#{user}.github.io"
+  url += "/#{project}" unless project == ''
+  unless (`git remote -v` =~ /origin.+?octopress(?:\.git)?/).nil?
+    # If octopress is still the origin remote (from cloning) rename it to octopress
+    system "git remote rename origin octopress"
+    if branch == 'master'
+      # If this is a user/organization pages repository, add the correct origin remote
+      # and checkout the source branch for committing changes to the website's source.
+      system "git remote add origin #{repo_url}"
+      puts "Added remote #{repo_url} as origin"
+      system "git config branch.master.remote origin"
+      puts "Set origin as default remote"
+      system "git branch -m master source"
+      puts "Master branch renamed to 'source' for committing your website's source files"
+    else
+      unless !Octopress.configuration[:destination].match("#{project}").nil?
+        Rake::Task[:set_root_dir].invoke(project)
+      end
+    end
+  end
+
+  # Configure deployment repository
+  rm_rf Octopress.configuration[:deploy_dir], :verbose=>false
+  cmd = "git clone #{repo_url} --branch #{branch} #{Octopress.configuration[:deploy_dir]}"
+  Open3.popen2e(cmd) do |stdin, stdout_err, wait_thr|
+    exit_status = wait_thr.value
+    unless exit_status.success?
+      error = ''
+      while line = stdout_err.gets do error << line end
+      puts "Be sure your repo (#{repo_url}) is set up properly and try again".red
+      abort error
+    end
+  end
+  cd "#{Octopress.configuration[:deploy_dir]}", :verbose=>false do
+    unless File.exist?('index.html')
+      `echo 'My Octopress Page is coming soon &hellip;' > index.html`
+      `git add . && git commit -m 'Octopress init'`
+      `git branch -m gh-pages` unless branch == 'master'
+    end
+  end
+
+  # Configure deployment setup in deploy.yml
+  deploy_configuration = Octopress.configurator.read_config('deploy.yml')
+  config_message = ""
+
+  unless deploy_configuration[:deploy_default] == "push"
+    deploy_configuration[:deploy_default] = "push"
+    config_message << "\n  deploy_default: push"
+  end
+
+  unless deploy_configuration[:deploy_branch] == branch
+    deploy_configuration[:deploy_branch] = branch
+    config_message << "\n  deploy_branch: #{branch}"
+  end
+
+  # Mention updated configs if any
+  unless config_message.empty?
+    deploy_configuration = Octopress.configurator.read_config('defaults/deploy/gh_pages.yml').deep_merge(deploy_configuration)
+    Octopress.configurator.write_config('deploy.yml', deploy_configuration)
+    puts "\nYour deployment configuration (_config/deploy.yml) has been updated to:"
+    puts config_msg.yellow
+  end
+
+  # Configure published url
+  site_configuration = Octopress.configurator.read_config('site.yml')
+  if !site_configuration.has_key?(:url) or site_configuration[:url] == 'http://yoursite.com'
+    site_configuration[:url] = url
+    Octopress.configurator.write_config('site.yml', site_configuration)
+    puts "\nYour site configuration (_config/site.yml) has been updated to:"
+    puts "\n  url: #{url}".yellow
+  end
+  jekyll_configuration = Octopress.configurator.read_config('defaults/jekyll.yml').deep_merge(site_configuration)
+
+  cname_path = "#{jekyll_configuration[:source]}/CNAME"
+  has_cname = File.exists?(cname_path)
+  output = ""
+  if has_cname
+    cname = IO.read(cname_path).chomp
+    current_url = site_configuration[:url]
+    if cname != current_short_url
+      output << "\nYour CNAME points to #{cname} but your _config/site.yml is setting the url to #{current_short_url}".red
+      output << "\nIf you need help, get it here: https://help.github.com/articles/setting-up-a-custom-domain-with-pages"
+    else
+      url = cname
+    end
+  else
+    output << "\nTo use a custom domain:".bold
+    output << "\n  Follow this guide: https://help.github.com/articles/setting-up-a-custom-domain-with-pages"
+    output << "\n  Then remember to update the url in _config/site.yml from #{url} to http://your-domain.com"
+  end
+
+  puts "Configured successfully:".green.bold
+  puts "  Github Pages will host your site at #{url}.".green
+  puts "\nTo deploy:".bold
+  puts "  Run `rake deploy` which will copy your site to _deploy/, commit then push to #{repo_url}"
+  puts output
+end