Merge pull request #2 from BennyHallett/commands

Author: parkr

lib/jekyll/commands/draft.rb

@@ -0,0 +1,53 @@
+module Jekyll
+  module Commands
+    class Draft < Command
+      def self.init_with_program(prog)
+        prog.command(:draft) do |c|
+          c.syntax 'draft NAME'
+          c.description 'Creates a new draft post with the given NAME'
+
+          c.option 'type', '-t TYPE', '--type TYPE', 'Specify the content type'
+          c.option 'layout', '-l LAYOUT', '--layout LAYOUT', 'Specify the post layout'
+          c.option 'force', '-f', '--force', 'Overwrite a draft if it already exists'
+
+          c.action do |args, options|
+            Jekyll::Commands::Draft.process(args, options)
+          end
+        end
+      end
+
+      def self.process(args, options = {})
+        raise ArgumentError.new('You must specify a name.') if args.empty?
+        
+        type = options["type"].nil? ? "markdown" : options["type"]
+        layout = options["layout"].nil? ? "post" : options["layout"]
+
+        title = args.shift
+        name = title.gsub(' ', '-').downcase
+
+        draft_path = draft_name(name, type)
+
+        raise ArgumentError.new("A draft already exists at ./#{draft_path}") if File.exist?(draft_path) and !options["force"]
+
+        File.open(draft_path, "w") do |f|
+          f.puts(front_matter(layout, title))
+        end
+
+        puts "New draft created at ./#{draft_path}.\n"
+      end 
+      # Internal: Gets the filename of the draft to be created
+      #
+      # Returns the filename of the draft, as a String
+      def self.draft_name(name, ext='markdown')
+        "_drafts/#{name}.#{ext}"
+      end
+
+      def self.front_matter(layout, title)
+        "---
+layout: #{layout}
+title: #{title}
+---"
+      end
+    end
+  end
+end

lib/jekyll/commands/post.rb

@@ -0,0 +1,56 @@
+module Jekyll
+  module Commands
+    class Post < Command
+      def self.init_with_program(prog)
+        prog.command(:post) do |c|
+          c.syntax 'post NAME'
+          c.description 'Creates a new post with the given NAME'
+
+          c.option 'type', '-t TYPE', '--type TYPE', 'Specify the content type'
+          c.option 'layout', '-t LAYOUT', '--layout LAYOUT', 'Specify the post layout'
+          c.option 'date', '-d DATE', '--date DATE', 'Specify the post date'
+          c.option 'force', '-f', '--force', 'Overwrite a post if it already exists'
+
+          c.action do |args, options|
+            Jekyll::Commands::Post.process(args, options)
+          end
+        end
+      end
+
+      def self.process(args, options = {})
+        raise ArgumentError.new('You must specify a name.') if args.empty?
+        
+        type = options["type"].nil? ? "markdown" : options["type"]
+        layout = options["layout"].nil? ? "post" : options["layout"]
+
+        date = options["date"].nil? ? Time.now : DateTime.parse(options["date"])
+
+        title = args.shift
+        name = title.gsub(' ', '-').downcase
+
+        post_path = file_name(name, type, date)
+
+        raise ArgumentError.new("A post already exists at ./#{post_path}") if File.exist?(post_path) and !options["force"]
+
+        File.open(post_path, "w") do |f|
+          f.puts(front_matter(layout, title))
+        end
+
+        puts "New post created at ./#{post_path}.\n"
+      end 
+      # Internal: Gets the filename of the draft to be created
+      #
+      # Returns the filename of the draft, as a String
+      def self.file_name(name, ext, date)
+        "_posts/#{date.strftime('%Y-%m-%d')}-#{name}.#{ext}"
+      end
+
+      def self.front_matter(layout, title)
+        "---
+layout: #{layout}
+title: #{title}
+---"
+      end
+    end
+  end
+end

lib/jekyll/commands/publish.rb

@@ -0,0 +1,42 @@
+module Jekyll
+  module Commands
+    class Publish < Command
+      def self.init_with_program(prog)
+        prog.command(:publish) do |c|
+          c.syntax 'publish NAME'
+          c.description 'Moves a draft into the _posts directory and sets the date'
+
+          c.option 'date', '-d DATE', '--date DATE', 'Specify the post date'
+
+          c.action do |args, options|
+            Jekyll::Commands::Publish.process(args, options)
+          end
+        end
+      end
+
+      def self.process(args, options = {})
+        raise ArgumentError.new('You must specify a name.') if args.empty?
+        
+        date = options["date"].nil? ? Date.today : Date.parse(options["date"])
+        file = args.shift
+
+        post_path = post_name(date, file)
+        FileUtils.mv(draft_name(file), post_path)
+
+        puts "Draft #{file} was published to ./#{post_path}"
+      end 
+
+      # Internal: Gets the filename of the post to be created
+      #
+      # Returns the filename of the post, as a String
+      def self.post_name(date, name)
+        "_posts/#{date.strftime('%Y-%m-%d')}-#{name}"
+      end
+
+      def self.draft_name(name)
+        "_drafts/#{name}"
+      end
+
+    end
+  end
+end

test/test_draft_command.rb

@@ -0,0 +1,77 @@
+require 'helper'
+require 'jekyll/commands/draft'
+
+class TestDraftCommand < Test::Unit::TestCase
+
+  context 'when no flags are given' do
+    setup do
+      @name = 'A test post'
+      @args = [@name]
+      @drafts_dir = '_drafts'
+      @path = File.join(@drafts_dir, 'a-test-post.markdown')
+      stub(Jekyll).configuration { Jekyll::Configuration::DEFAULTS }
+      @site = Site.new(Jekyll.configuration)
+      FileUtils.mkdir @drafts_dir
+    end
+
+    teardown do
+      FileUtils.rm_r @drafts_dir
+    end
+
+    should 'create a new draft post' do
+      assert !File.exist?(@path)
+      capture_stdout { Jekyll::Commands::Draft.process(@args) }
+      assert File.exist?(@path)
+    end
+
+    should 'write a success message' do
+      output = capture_stdout { Jekyll::Commands::Draft.process(@args) }
+      success_message = "New draft created at ./#{@path}.\n"
+      assert_equal success_message, output
+    end
+  end
+
+  context 'when the draft already exists' do
+    setup do
+      @name = 'An existing draft'
+      @args = [@name]
+      @drafts_dir = '_drafts'
+      @path = File.join(@drafts_dir, 'an-existing-draft.markdown')
+      stub(Jekyll).configuration { Jekyll::Configuration::DEFAULTS }
+      @site = Site.new(Jekyll.configuration)
+      FileUtils.mkdir @drafts_dir
+      FileUtils.touch @path
+    end
+
+    teardown do
+      FileUtils.rm_r @drafts_dir
+    end
+
+    should 'raise an ArgumentError' do
+      exception = assert_raise ArgumentError do
+        capture_stdout { Jekyll::Commands::Draft.process(@args) }
+      end
+      assert_equal "A draft already exists at ./#{@path}", exception.message
+    end
+
+    should 'overwrite the existing draft if --force is given' do
+      capture_stdout { Jekyll::Commands::Draft.process(@args, { "force" => true  }) }
+      assert File.readlines(@path).grep(/layout: post/).any?
+    end
+      
+  end
+
+  context 'when no args are given' do
+    setup do
+      @empty_args = []
+    end
+
+    should 'raise an ArgumentError' do
+      exception = assert_raise ArgumentError do
+        Jekyll::Commands::Draft.process(@empty_args)
+      end
+      assert_equal 'You must specify a name.', exception.message
+    end
+  end
+
+end

test/test_post_command.rb

@@ -0,0 +1,73 @@
+require 'helper'
+require 'jekyll/commands/post'
+
+class TestPostCommand < Test::Unit::TestCase
+
+  context 'when no flags are given' do
+    setup do
+      @name = 'A test post'
+      @args = [@name]
+      @posts_dir = '_posts'
+      @path = File.join(@posts_dir, "#{Time.now.strftime('%Y-%m-%d')}-a-test-post.markdown")
+      FileUtils.mkdir @posts_dir
+    end
+
+    teardown do
+      FileUtils.rm_r @posts_dir
+    end
+
+    should 'create a new post' do
+      assert !File.exist?(@path)
+      capture_stdout { Jekyll::Commands::Post.process(@args) }
+      assert File.exist?(@path)
+    end
+
+    should 'write a success message' do
+      output = capture_stdout { Jekyll::Commands::Post.process(@args) }
+      success_message = "New post created at ./#{@path}.\n"
+      assert_equal success_message, output
+    end
+  end
+
+  context 'when the post already exists' do
+    setup do
+      @name = 'An existing post'
+      @args = [@name]
+      @posts_dir = '_posts'
+      @path = File.join(@posts_dir, "#{Time.now.strftime('%Y-%m-%d')}-an-existing-post.markdown")
+      FileUtils.mkdir @posts_dir
+      FileUtils.touch @path
+    end
+
+    teardown do
+      FileUtils.rm_r @posts_dir
+    end
+
+    should 'raise an ArgumentError' do
+      exception = assert_raise ArgumentError do
+        capture_stdout { Jekyll::Commands::Post.process(@args) }
+      end
+      assert_equal "A post already exists at ./#{@path}", exception.message
+    end
+
+    should 'overwrite the existing post if --force is given' do
+      capture_stdout { Jekyll::Commands::Post.process(@args, { "force" => true  }) }
+      assert File.readlines(@path).grep(/layout: post/).any?
+    end
+      
+  end
+
+  context 'when no args are given' do
+    setup do
+      @empty_args = []
+    end
+
+    should 'raise an ArgumentError' do
+      exception = assert_raise ArgumentError do
+        Jekyll::Commands::Post.process(@empty_args)
+      end
+      assert_equal 'You must specify a name.', exception.message
+    end
+  end
+
+end

test/test_publish.rb

@@ -0,0 +1,52 @@
+require 'helper'
+require 'date'
+require 'jekyll/commands/publish'
+
+class TestPublishCommand < Test::Unit::TestCase
+
+  context 'when no flags are given' do
+    setup do
+      @name = 'a-test-post.markdown'
+      @args = [@name]
+      @drafts_dir = '_drafts'
+      @posts_dir = '_posts'
+      @draft_path = File.join(@drafts_dir, 'a-test-post.markdown')
+      @post_path = File.join(@posts_dir, "#{Time.now.strftime('%Y-%m-%d')}-#{@name}")
+      FileUtils.mkdir @drafts_dir
+      FileUtils.mkdir @posts_dir
+      FileUtils.touch @draft_path
+    end
+
+    teardown do
+      FileUtils.rm_r @drafts_dir
+      FileUtils.rm_r @posts_dir
+    end
+
+    should 'publish a draft post' do
+      assert !File.exist?(@post_path), 'Post already exists'
+      assert File.exist?(@draft_path), 'Draft does not exist'
+      capture_stdout { Jekyll::Commands::Publish.process(@args) }
+      assert File.exist?(@post_path), 'Post does not exist'
+    end
+
+    should 'write a success message' do
+      output = capture_stdout { Jekyll::Commands::Publish.process(@args) }
+      success_message = "Draft #{@name} was published to ./#{@post_path}\n"
+      assert_equal success_message, output
+    end
+  end
+
+  context 'when no args are given' do
+    setup do
+      @empty_args = []
+    end
+
+    should 'raise an ArgumentError' do
+      exception = assert_raise ArgumentError do
+        Jekyll::Commands::Publish.process(@empty_args)
+      end
+      assert_equal 'You must specify a name.', exception.message
+    end
+  end
+
+end