middleman-blog-drafts 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+0.3.0
+====
+* Add support to override blog-wide `build` config in draft's frontmatter
+
 0.2.0
 ====
 * Middleman 3.2 compatible release, complete overhaul

data/Gemfile

@@ -19,4 +19,5 @@ group :development do
   gem "rdoc",   "~> 3.9"
   gem "yard",   "~> 0.8.0"
   gem "guard-cucumber"
+  gem 'pry'
 end

data/Gemfile.lock

@@ -17,7 +17,7 @@ GIT
 PATH
   remote: .
   specs:
-    middleman-blog-drafts (0.2.0)
+    middleman-blog-drafts (0.3.0)
       middleman-blog (~> 3.5.1)
       middleman-core (~> 3.2.2)
 
@@ -123,6 +123,7 @@ DEPENDENCIES
   kramdown
   middleman-blog-drafts!
   middleman-core!
+  pry
   rake (~> 10.1.0)
   rdoc (~> 3.9)
   sass

data/README.md

@@ -44,13 +44,18 @@ middleman publish source/drafts/my-awesome-new-blog-post.markdown
 <% end %>
 ```
 
-As drafts won't be be available in the generated page by default, checking whether there are any is enough to decide whether to render the listing or not.
+As drafts won't be be available in the generated page by default, checking
+whether there are any is enough to decide whether to render the listing or not.
 
 ## Configuration options
 
-`build`: when `true`, the drafts will be available unconditionally. If not given, the drafts will be available in middlemans development mode and unavailable in `middleman build`.
+`build`: when `true`, the drafts will be available unconditionally. If not
+given, the drafts will be available in middleman's development mode and
+unavailable in `middleman build`.
 
-This allows you to control the behaviour, for example if you have a preview instance of your blog. One way to do so would be to set it based on an environment variable:
+This allows you to control the behaviour, for example if you have a preview
+instance of your blog. One way to do so would be to set it based on an
+environment variable:
 
 ```ruby
 activate :drafts do |drafts|
@@ -58,16 +63,36 @@ activate :drafts do |drafts|
 end
 ```
 
-This activates drafts in any environment where `SHOW_DRAFTS` is given and uses the default otherwise.
+This activates drafts in any environment where `SHOW_DRAFTS` is given and uses
+the default otherwise.
+
+## Frontmatter options
+
+`build` can be overriden on a per-draft basis. For example if you want to make
+a draft available to a small audience for proofreading, you may force the build
+of that one draft with the following frontmatter:
+
+```yaml
+---
+title: "Example blog post"
+build: true
+---
+```
+
+Likewise if you configure `build` to `true` for your entire blog, you may still
+withhold single drafts from being built by setting `build: false` in the
+frontmatter.
 
 ## Learn More
 
-See the [blog extension guide](http://middlemanapp.com/basics/blogging/) for detailed
+See the [blog extension guide](http://middlemanapp.com/basics/blogging/) for
+detailed
 information on configuring and using the blog extension.
 
 ## Credits
 
-Most of the code was based on the [middleman-blog](https://github.com/middleman/middleman-blog)
+Most of the code was based on the
+[middleman-blog](https://github.com/middleman/middleman-blog)
 gem itself, so many thanks to everyone that helped out with it.
 
 ## Contributing

data/features/build.feature

@@ -1,5 +1,17 @@
 Feature: Building the site
-  Scenario: Unpublished articles don't get built
+
+  Scenario: Default config builds only drafts with frontmatter build=true
     Given a fixture app "drafts-app"
     When I run `middleman build`
-    Then the build directory should be empty
+    Then the following files should not exist:
+      | build/drafts/new-draft.html |
+    And the following files should exist:
+      | build/drafts/draft-build-true.html |
+
+  Scenario: Config build=true does not build drafts with frontmatter build=false
+    Given a fixture app "drafts-build-true-app"
+    When I run `middleman build`
+    Then the following files should exist:
+      | build/drafts/new-draft.html |
+    And the following files should not exist:
+      | build/drafts/draft-build-false.html |

data/fixtures/drafts-app/source/drafts/draft-build-false.html.erb

@@ -0,0 +1,6 @@
+---
+title: "Draft with build = false"
+build: false
+---
+<h1>Draft with build = false</h1>
+<p>Date: <%= current_article.date.iso8601 %></p>

data/fixtures/drafts-app/source/drafts/draft-build-true.html.erb

@@ -0,0 +1,6 @@
+---
+title: "Draft with build = true"
+build: true
+---
+<h1>Draft with build = true</h1>
+<p>Date: <%= current_article.date.iso8601 %></p>

data/fixtures/drafts-build-true-app/config.rb

@@ -0,0 +1,9 @@
+require 'middleman-blog'
+
+activate :blog do |b|
+  b.prefix = 'blog'
+end
+
+activate :drafts do |d|
+  d.build = true
+end

data/fixtures/drafts-build-true-app/source/drafts/draft-build-false.html.erb

@@ -0,0 +1,6 @@
+---
+title: "Draft with build = false"
+build: false
+---
+<h1>Draft with build = false</h1>
+<p>Date: <%= current_article.date.iso8601 %></p>

data/fixtures/drafts-build-true-app/source/drafts/draft-build-true.html.erb

@@ -0,0 +1,6 @@
+---
+title: "Draft with build = true"
+build: true
+---
+<h1>Draft with build = true</h1>
+<p>Date: <%= current_article.date.iso8601 %></p>

data/fixtures/drafts-build-true-app/source/drafts/listing_drafts.html.erb

@@ -0,0 +1,11 @@
+---
+title: "Drafts List"
+---
+
+<% if settings[:environment] == :development %>
+  <ul>
+    <% drafts.each do |draft| %>
+      <li><%= draft.title %></li>
+    <% end %>
+  </ul>
+<% end %>

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

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

data/fixtures/drafts-build-true-app/source/layout.erb

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

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

@@ -83,7 +83,9 @@ module Middleman
         # @param [DraftArticle] draft A draft article
         # @return [Boolean] Whether it should be built
         def build?(draft)
-          @app.environment == :development || @options.build
+          build = draft.data["build"]
+          build = @options.build if build == nil
+          @app.environment == :development || build
         end
 
         private

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

@@ -1,7 +1,7 @@
 module Middleman
   module Blog
     module Drafts
-      VERSION = "0.2.0"
+      VERSION = "0.3.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: middleman-blog-drafts
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-12 00:00:00.000000000 Z
+date: 2014-02-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: middleman-core
@@ -69,10 +69,18 @@ files:
 - features/step_definitions/drafts_steps.rb
 - features/support/env.rb
 - fixtures/drafts-app/config.rb
+- fixtures/drafts-app/source/drafts/draft-build-false.html.erb
+- fixtures/drafts-app/source/drafts/draft-build-true.html.erb
 - fixtures/drafts-app/source/drafts/listing_drafts.html.erb
 - fixtures/drafts-app/source/drafts/new-draft.html.erb
 - fixtures/drafts-app/source/drafts/other-draft.html.erb
 - fixtures/drafts-app/source/layout.erb
+- fixtures/drafts-build-true-app/config.rb
+- fixtures/drafts-build-true-app/source/drafts/draft-build-false.html.erb
+- fixtures/drafts-build-true-app/source/drafts/draft-build-true.html.erb
+- fixtures/drafts-build-true-app/source/drafts/listing_drafts.html.erb
+- fixtures/drafts-build-true-app/source/drafts/new-draft.html.erb
+- fixtures/drafts-build-true-app/source/layout.erb
 - lib/middleman-blog-drafts.rb
 - lib/middleman-blog-drafts/blog_data_extensions.rb
 - lib/middleman-blog-drafts/commands/draft.rb
@@ -105,7 +113,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4520017841201487203
+      hash: 2863171145305893052
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -121,8 +129,16 @@ test_files:
 - features/step_definitions/drafts_steps.rb
 - features/support/env.rb
 - fixtures/drafts-app/config.rb
+- fixtures/drafts-app/source/drafts/draft-build-false.html.erb
+- fixtures/drafts-app/source/drafts/draft-build-true.html.erb
 - fixtures/drafts-app/source/drafts/listing_drafts.html.erb
 - fixtures/drafts-app/source/drafts/new-draft.html.erb
 - fixtures/drafts-app/source/drafts/other-draft.html.erb
 - fixtures/drafts-app/source/layout.erb
+- fixtures/drafts-build-true-app/config.rb
+- fixtures/drafts-build-true-app/source/drafts/draft-build-false.html.erb
+- fixtures/drafts-build-true-app/source/drafts/draft-build-true.html.erb
+- fixtures/drafts-build-true-app/source/drafts/listing_drafts.html.erb
+- fixtures/drafts-build-true-app/source/drafts/new-draft.html.erb
+- fixtures/drafts-build-true-app/source/layout.erb
 has_rdoc: