middleman-blog-drafts 0.0.1

data/.gitignore

@@ -0,0 +1,3 @@
+# Ignore bundler lock file
+Gemfile.lock
+/tmp

data/Gemfile

@@ -0,0 +1,18 @@
+source :rubygems
+
+# Specify your gem's dependencies in middleman-blog-drafts.gemspec
+gemspec
+
+group :development do
+  gem "rake",     "~> 0.9.2"
+  gem "rdoc",     "~> 3.9"
+  gem "yard",     "~> 0.8.0"
+  gem "guard-cucumber"
+end
+
+group :test do
+  gem "cucumber", "~> 1.2.0"
+  gem "fivemat"
+  gem "aruba",    "~> 0.4.11"
+  gem "rspec",    "~> 2.7"
+end

data/Guardfile

@@ -0,0 +1,7 @@
+guard 'cucumber' do
+  watch(%r{^features/.+\.feature$})
+  watch(%r{^features/support/.+$}) { 'features' }
+  watch(%r{^features/step_definitions/(.+)_steps\.rb$}) { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'features' }
+  watch(%r{^fixtures/.+$})
+  watch(%r{^lib/.+$})
+end

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'cucumber/rake/task'
+
+Cucumber::Rake::Task.new(:cucumber, 'Run features that should pass') do |t|
+  t.cucumber_opts = "--color --tags ~@wip --strict --format #{ENV['CUCUMBER_FORMAT'] || 'Fivemat'}"
+end
+
+require 'rake/clean'
+
+task :test => ["cucumber"]
+
+task :default => :test

data/features/build.feature

@@ -0,0 +1,5 @@
+Feature: Building the site
+  Scenario: Unpublished articles don't get built
+    Given a fixture app "draft-date-app"
+    When I run `middleman build`
+    Then the build directory should be empty

data/features/draft_cli.feature

@@ -0,0 +1,7 @@
+Feature: New draft CLI command
+ Scenario: Create a new blog draft article with the CLI
+   Given a fixture app "drafts-app"
+   And I run `middleman draft "My New Article"`
+   Then the exit status should be 0
+   Then the following files should exist:
+     | source/drafts/my-new-article.html.markdown |

data/features/draft_date.feature

@@ -0,0 +1,10 @@
+Feature: Derive draft date from today
+  Scenario: Drafts without dates
+    Given the Server is running at "draft-date-app"
+    When I go to "/drafts/new-draft.html"
+    Then I should see the current date
+
+  Scenario: Drafts without dates and using data store
+    Given the Server is running at "draft-date-app"
+    When I go to "/drafts/other-draft.html"
+    Then I should see the current date

data/features/publish_cli.feature

@@ -0,0 +1,17 @@
+Feature: Publish draft CLI command
+ Scenario: Publish a new blog draft article with the CLI
+   Given a fixture app "drafts-app"
+   And I run `middleman draft "My New Article"`
+   And I run `middleman publish source/drafts/my-new-article.html.markdown --date 2012-03-07`
+   Then the exit status should be 0
+   And the following files should exist:
+     | source/blog/2012-03-07-my-new-article.html.markdown |
+   And the following files should not exist:
+     | source/drafts/my-new-article.html.markdown |
+
+  Scenario: Viewing a published article
+   Given a fixture app "draft-date-app"
+   And I run `middleman publish source/drafts/new-draft.html.erb --date 2012-03-07`
+   When the Server is running at "draft-date-app"
+   And I go to "/2012/03/07/new-draft.html"
+   Then I should see '2012-03-07'

data/features/step_definitions/drafts_steps.rb

@@ -0,0 +1,7 @@
+Then /^I should see the current date/ do
+  step %Q{I should see "Date: #{Time.now.in_time_zone.iso8601}"}
+end
+
+Then /^the build directory should be empty/ do
+  in_current_dir { Dir['build/**/*'].should be_empty }
+end

data/features/support/env.rb

@@ -0,0 +1,4 @@
+PROJECT_ROOT_PATH = File.dirname(File.dirname(File.dirname(__FILE__)))
+require "middleman-core"
+require "middleman-core/step_definitions"
+require File.join(PROJECT_ROOT_PATH, 'lib', 'middleman-blog-drafts')

data/fixtures/draft-date-app/config.rb

@@ -0,0 +1,3 @@
+require 'middleman-blog'
+activate :blog
+activate :drafts

data/fixtures/draft-date-app/source/drafts/new-draft.html.erb

@@ -0,0 +1,2 @@
+<h1>New Draft Title</h1>
+<p>Date: <%= current_article.date.iso8601 %></p>

data/fixtures/draft-date-app/source/drafts/other-draft.html.erb

@@ -0,0 +1,2 @@
+<h1>Other Draft Title</h1>
+<p>Date: <%= current_article.data.date.iso8601 %></p>

data/fixtures/draft-date-app/source/layout.erb

@@ -0,0 +1,8 @@
+<!doctype html>
+<html>
+  <head>
+  </head>
+  <body>
+    <%= yield%>
+  </body>
+</html>

data/fixtures/drafts-app/config.rb

@@ -0,0 +1,5 @@
+require 'middleman-blog'
+activate :blog do |c|
+  c.prefix = 'blog'
+end
+activate :drafts

data/lib/middleman-blog-drafts/blog_data_extensions.rb

@@ -0,0 +1,84 @@
+module Middleman
+  module Blog
+    module Drafts
+      # An extension to let {Middleman::Blog::BlogData} know about all draft
+      # articles in the site.
+      module BlogDataExtensions
+        def drafts(app=nil, options=nil)
+          @_drafts ||= Middleman::Blog::Drafts::Data.new(self, app, options)
+        end
+
+        # A draft BlogArticle for the given path, or nil if one doesn't exist.
+        # @return [Middleman::Sitemap::Resource]
+        def draft(path)
+          article = drafts.options.app.sitemap.find_resource_by_path(path.to_s)
+          if article && article.is_a?(BlogArticle)
+            article
+          else
+            nil
+          end
+        end
+      end
+
+      # A store of all the draft articles in the site. Accessed via "blog.drafts" in
+      # templates.
+      class Data
+        attr_reader :options, :path_matcher, :matcher_indexes
+
+        # @private
+        def initialize(blog_data, app, options)
+          @blog_data = blog_data
+          @options   = options
+          @app       = app
+
+          # A list of resources corresponding to draft articles
+          @_drafts = []
+
+          matcher = Regexp.escape(options.sources).
+              sub(/^\//, "").
+              sub(":title", "([^/]+)")
+
+          @path_matcher = /^#{matcher}/
+
+          # Build a hash of part name to capture index, e.g. {"year" => 0}
+          @matcher_indexes = {}
+          options.sources.scan(/:title/).
+            each_with_index do |key, i|
+              @matcher_indexes[key[1..-1]] = i
+            end
+          # The path always appears at the end.
+          @matcher_indexes["path"] = @matcher_indexes.size
+        end
+
+        # Updates' blog draft articles destination paths to be the
+        # permalink.
+        # @return [void]
+        def manipulate_resource_list(resources)
+          @_drafts = []
+          used_resources = []
+
+          resources.each do |resource|
+            if resource.path =~ @path_matcher
+              resource.extend BlogArticle
+              resource.extend DraftArticle
+
+              next unless @app.environment == :development
+
+              # compute output path:
+              resource.destination_path = options.permalink.
+                sub(':title', resource.slug)
+
+              resource.destination_path = Middleman::Util.normalize_path(resource.destination_path)
+
+              @_drafts << resource
+            end
+
+            used_resources << resource
+          end
+
+          used_resources
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog-drafts/commands/draft.rb

@@ -0,0 +1,43 @@
+require 'middleman-core/cli'
+
+module Middleman
+  module Cli
+    # This class provides a "draft" command for the middleman CLI.
+    class Draft < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :draft
+
+      # Template files are relative to this file
+      # @return [String]
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "draft TITLE", "Create a new draft for a blog article"
+      def draft(title)
+        shared_instance = ::Middleman::Application.server.inst
+
+        # This only exists when the config.rb sets it!
+        if shared_instance.blog.respond_to? :drafts
+          @title = title
+          @slug = title.parameterize
+
+          draft_path = shared_instance.blog.drafts.options.sources.
+            sub(':title', @slug)
+
+          template "draft.tt", File.join(shared_instance.source_dir, draft_path + shared_instance.blog.options.default_extension)
+        else
+          raise Thor::Error.new "You need to activate the drafts extension in config.rb before you can create an article"
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog-drafts/commands/draft.tt

@@ -0,0 +1,9 @@
+---
+title: '<%= @title %>'
+# date: TBD When publishing
+tags:
+---
+
+# <%= @title %>
+
+Write a draft post :-)

data/lib/middleman-blog-drafts/commands/publish.rb

@@ -0,0 +1,57 @@
+require 'middleman-core/cli'
+
+module Middleman
+  module Cli
+    # This class provides a "publish" command for the middleman CLI.
+    class Publish < Thor
+      include Thor::Actions
+
+      check_unknown_options!
+
+      namespace :publish
+
+      # Template files are relative to this file
+      # @return [String]
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+
+      # Tell Thor to exit with a nonzero exit code on failure
+      def self.exit_on_failure?
+        true
+      end
+
+      desc "publish DRAFT_PATH", "Publish a draft"
+      method_option "date",
+        :aliases => "-d",
+        :desc => "The date to create the post with (defaults to now)"
+      def publish(draft_path)
+        shared_instance = ::Middleman::Application.server.inst
+
+        # This only exists when the config.rb sets it!
+        if shared_instance.blog.respond_to? :drafts
+          @slug = draft_path.split('/').last.split('.').first.parameterize
+          @date = options[:date] ? DateTime.parse(options[:date]) : DateTime.now
+
+          draft_path    = File.expand_path draft_path
+          extension     = File.extname draft_path
+
+          article_path = shared_instance.blog.options.sources.
+            sub(':year', @date.year.to_s).
+            sub(':month', @date.month.to_s.rjust(2,'0')).
+            sub(':day', @date.day.to_s.rjust(2,'0')).
+            sub(':title', @slug)
+          article_path = File.join(shared_instance.source_dir, article_path + extension)
+
+          data, content = shared_instance.frontmatter_manager.data(draft_path)
+          data = data.dup.tap { |d| d[:date] = Date.parse @date.strftime('%F') }
+
+          create_file article_path, "#{YAML::dump(data).sub(/^--- !ruby.*$/, '---')}---\n#{content}"
+          remove_file draft_path
+        else
+          raise Thor::Error.new "You need to activate the drafts extension in config.rb before you can publish an article"
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog-drafts/draft_article.rb

@@ -0,0 +1,38 @@
+module Middleman
+  module Blog
+    module Drafts
+      module DraftArticle
+        # The "slug" of the draft article that shows up in its URL.
+        # @return [String]
+        def slug
+          @_slug ||= path_part("title")
+        end
+
+        # Retrieve a section of the source path
+        # @param [String] The part of the path, e.g. "title"
+        # @return [String]
+        def path_part(part)
+          @_path_parts ||= app.blog.drafts.path_matcher.match(path).captures
+
+          @_path_parts[app.blog.drafts.matcher_indexes[part]]
+        end
+
+        # Returns current date as we can't guess when the article will be published
+        #
+        # We need this in place or the layout used for blog posts might blow up
+        #
+        # @return [TimeWithZone]
+        def date
+          Time.now.in_time_zone
+        end
+
+        # Extends resource data adding the date field
+        #
+        # @return [Thor::CoreExt::HashWithIndifferentAccess]
+        def data
+          super.dup.merge(date: date)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog-drafts/extension.rb

@@ -0,0 +1,54 @@
+module Middleman
+  module Blog
+    module Drafts
+      class Options
+        attr_accessor :sources, :layout, :permalink
+
+        def initialize(options={})
+          options.each do |k,v|
+            self.send(:"#{k}=", v)
+          end
+        end
+      end
+
+      class << self
+        # Called when user `activate`s your extension
+        def registered(app, options_hash={}, &block)
+          require 'middleman-blog/extension'
+          require 'middleman-blog/blog_data'
+          require 'middleman-blog-drafts/draft_article'
+          require 'middleman-blog-drafts/blog_data_extensions'
+
+          options = Options.new(options_hash)
+          yield options if block_given?
+
+          options.sources   ||= "drafts/:title.html"
+          options.permalink ||= "/drafts/:title.html"
+
+          ::Middleman::Blog::BlogData.send :include, BlogDataExtensions
+          app.send :include, Helpers
+
+          app.after_configuration do
+            options.layout = blog.options.layout
+            blog.drafts(self, options)
+
+            sitemap.register_resource_list_manipulator(
+                                                     :blog_drafts,
+                                                     blog.drafts,
+                                                     false
+                                                     )
+          end
+        end
+        alias :included :registered
+      end
+
+      module Helpers
+        # Get a {Resource} with mixed in {BlogArticle} methods representing the current article.
+        # @return [Middleman::Sitemap::Resource]
+        def current_article
+          super || blog.draft(current_resource.path)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog-drafts/version.rb

@@ -0,0 +1,7 @@
+module Middleman
+  module Blog
+    module Drafts
+      VERSION = "0.0.1"
+    end
+  end
+end

data/lib/middleman-blog-drafts.rb

@@ -0,0 +1,10 @@
+require "middleman-core"
+
+require "middleman-blog-drafts/commands/draft"
+require "middleman-blog-drafts/commands/publish"
+require "middleman-blog-drafts/version"
+
+::Middleman::Extensions.register(:drafts) do
+  require 'middleman-blog-drafts/extension'
+  ::Middleman::Blog::Drafts
+end

data/lib/middleman_extension.rb

@@ -0,0 +1 @@
+require "middleman-blog-drafts"

data/middleman-blog-drafts.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-blog-drafts/version"
+
+Gem::Specification.new do |s|
+  s.name        = "middleman-blog-drafts"
+  s.version     = Middleman::Blog::Drafts::VERSION
+  s.authors     = ["Fabio Rehm"]
+  s.email     = ["fgrehm@gmail.com"]
+  s.description = %q{middleman-blog extension for working with draft articles}
+  s.summary     = s.description
+  s.homepage    = "https://github.com/fgrehm/middleman-draft-articles"
+
+  s.files         = `git ls-files`.split($/)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency("middleman-core", [">= 3.0.9"])
+  s.add_runtime_dependency("middleman-blog")
+end

metadata

@@ -0,0 +1,115 @@
+--- !ruby/object:Gem::Specification
+name: middleman-blog-drafts
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Fabio Rehm
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: middleman-core
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.9
+    none: false
+  type: :runtime
+- !ruby/object:Gem::Dependency
+  prerelease: false
+  name: middleman-blog
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+    none: false
+  type: :runtime
+description: middleman-blog extension for working with draft articles
+email:
+- fgrehm@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- Rakefile
+- features/build.feature
+- features/draft_cli.feature
+- features/draft_date.feature
+- features/publish_cli.feature
+- features/step_definitions/drafts_steps.rb
+- features/support/env.rb
+- fixtures/draft-date-app/config.rb
+- fixtures/draft-date-app/source/drafts/new-draft.html.erb
+- fixtures/draft-date-app/source/drafts/other-draft.html.erb
+- fixtures/draft-date-app/source/layout.erb
+- fixtures/drafts-app/config.rb
+- lib/middleman-blog-drafts.rb
+- lib/middleman-blog-drafts/blog_data_extensions.rb
+- lib/middleman-blog-drafts/commands/draft.rb
+- lib/middleman-blog-drafts/commands/draft.tt
+- lib/middleman-blog-drafts/commands/publish.rb
+- lib/middleman-blog-drafts/draft_article.rb
+- lib/middleman-blog-drafts/extension.rb
+- lib/middleman-blog-drafts/version.rb
+- lib/middleman_extension.rb
+- middleman-blog-drafts.gemspec
+homepage: https://github.com/fgrehm/middleman-draft-articles
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3659966068752668471
+  none: false
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -3659966068752668471
+  none: false
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: middleman-blog extension for working with draft articles
+test_files:
+- features/build.feature
+- features/draft_cli.feature
+- features/draft_date.feature
+- features/publish_cli.feature
+- features/step_definitions/drafts_steps.rb
+- features/support/env.rb
+has_rdoc: