middleman-blog 0.0.1 → 0.1.0

data/.gitignore

@@ -2,4 +2,5 @@
 .bundle
 Gemfile.lock
 pkg/*
-.DS_Store
+.rvmrc
+.DS_Store

data/lib/middleman-blog.rb

@@ -1,3 +1,2 @@
-require "middleman-blog/separator"
-require "middleman-blog/tilt"
-require "middleman-blog/blog_engine"
+require "middleman-blog/feature"
+require "middleman-blog/template"

data/lib/middleman-blog/feature.rb

@@ -0,0 +1,155 @@
+module Middleman
+  module Features
+    module Blog
+      class << self
+        def registered(app)
+          # Include helpers
+          app.helpers Middleman::Features::Blog::Helpers
+
+          app.after_configuration do
+            if !app.settings.respond_to? :blog_permalink
+              app.set :blog_permalink, ":year/:month/:day/:title.html"
+            end
+
+            if !app.settings.respond_to? :blog_taglink
+              app.set :blog_taglink, "tags/:tag.html"
+            end
+
+            if !app.settings.respond_to? :blog_layout
+              app.set :blog_layout, "layout"
+            end
+
+            if !app.settings.respond_to? :blog_summary_separator
+              app.set :blog_summary_separator, /READMORE/
+            end
+
+            if !app.settings.respond_to? :blog_summary_length
+              app.set :blog_summary_length, 250
+            end
+
+            if !app.settings.respond_to? :blog_layout_engine
+              app.set :blog_layout_engine, "erb"
+            end
+
+            if !app.settings.respond_to? :blog_index_template
+              app.set :blog_index_template, "index_template"
+            end
+
+            if !app.settings.respond_to? :blog_article_template
+              app.set :blog_article_template, "article_template"
+            end
+
+            if !app.build?
+              $stderr.puts "== Blog: #{app.settings.blog_permalink}"
+            end
+            
+            app.get("/#{app.blog_permalink}") do
+              process_request({
+                :layout        => app.blog_layout,
+                :layout_engine => app.blog_layout_engine
+              })
+
+              # No need for separator on permalink page
+              body body.gsub!(app.blog_summary_separator, "")
+            end
+          end
+          
+          app.before_processing do
+            articles_glob = File.join(app.views, app.settings.blog_permalink.gsub(/(:\w+)/, "*") + ".*")
+
+            articles = Dir[articles_glob].map do |article|
+              template_content = File.read(article)
+              data, content = app.parse_front_matter(template_content)
+              data["date"] = Date.parse(data["date"])
+
+              data["raw"] = content
+              data["url"] = article.gsub(app.views, "").split(".html").first + ".html"
+
+              all_content = Tilt.new(article).render
+              data["body"] = all_content.gsub!(app.settings.blog_summary_separator, "")
+
+              sum = if data["raw"] =~ app.settings.blog_summary_separator
+                data["raw"].split(app.settings.blog_summary_separator).first
+              else
+                data["raw"].match(/(.{1,#{app.settings.blog_summary_length}}.*?)(\n|\Z)/m).to_s
+              end
+
+              engine = app.settings.markdown_engine.new { sum }
+              data["summary"] = engine.render
+              data
+            end.sort { |a, b| b["date"] <=> a["date"] }
+
+            tags = {}
+            articles.each do |article|
+              article["tags"] ||= ""
+              if !article["tags"].empty?
+                tags_array = article["tags"].split(',').map{|t| t.strip}
+                tags_array.each do |tag_title|
+                  tag_key = tag_title.parameterize
+                  tag_path = blog_taglink.gsub(/(:\w+)/, tag_key)
+                  (tags[tag_path] ||= {})["title"] = tag_title
+                  tags[tag_path]["ident"] = tag_key
+                  (tags[tag_path]["pages"] ||= {})[article["title"]] = article["url"]
+                end
+              end
+            end
+
+            app.data_content("blog", { :articles => articles, :tags => tags })
+            true
+          end
+        end
+        alias :included :registered
+      end
+
+      module Helpers
+        def is_blog_article?
+          !current_article_title.blank?
+        end
+
+        def blog_title
+        end
+
+        def current_article_date
+          DateTime.parse(current_article_metadata.date)
+        end
+
+        def current_article_title
+          current_article_metadata.title
+        end
+
+        def current_article_metadata
+          data.page
+        end
+
+        def current_article_tags
+          article_tags_hash = {}
+          if is_blog_article? && current_article_metadata.tags
+            article_tags = current_article_metadata.tags.split(',').map{|t| t.strip}
+            article_tags.each do |tag_title|
+              article_tags_hash[tag_title] = self.class.blog_taglink.gsub(/(:\w+)/, tag_title.parameterize)
+            end
+          end
+          article_tags_hash
+        end
+
+        def blog_tags
+          data.blog.tags
+        end
+
+        def current_tag_data
+          data.blog.tags[request.path]
+        end
+
+        def current_tag_articles
+          data.blog.articles.map do |article|
+            article if current_tag_data.pages.has_value?(article.url)
+          end.compact
+        end
+
+        def current_tag_title
+          current_tag_data[:title]
+        end
+      end
+    end
+  end
+end

data/lib/middleman-blog/template.rb

@@ -0,0 +1,24 @@
+module Middleman
+  module Blog
+    class Template < Middleman::Templates::Base
+      def self.source_root
+        File.dirname(__FILE__)
+      end
+  
+      def build_scaffold
+        template "template/config.tt", File.join(location, "config.rb")
+        directory "template/source", File.join(location, "source")
+    
+        empty_directory File.join(location, "source", options[:css_dir])
+        empty_directory File.join(location, "source", options[:js_dir])
+        empty_directory File.join(location, "source", options[:images_dir])
+      end
+  
+      def generate_rack
+        template "template/config.ru", File.join(location, "config.ru")
+      end
+    end
+  end
+end
+
+Middleman::Templates.register(:blog, Middleman::Blog::Template)

data/lib/middleman-blog/template/config.ru

@@ -0,0 +1,9 @@
+# Rack config
+
+# Look for index files in folders like Apache
+require "rack/contrib/try_static"
+use Rack::TryStatic, :root => "build", :urls => %w[/], :try => ['.html', 'index.html', '/index.html']
+
+# Cache static assets
+require "rack/contrib/static_cache"
+use Rack::StaticCache, :urls => ['/'], :root => 'build'

data/lib/middleman-blog/template/config.tt

@@ -0,0 +1,18 @@
+activate :blog
+# set :blog_permalink, ":year/:month/:day/:title.html"
+# set :blog_summary_separator, /READMORE/
+# set :blog_summary_length, 500
+
+page "/feed.xml", :layout => false
+
+# Build-specific configuration
+configure :build do
+  # For example, change the Compass output style for deployment
+  # activate :minify_css
+  
+  # Minify Javascript on build
+  # activate :minify_javascript
+  
+  # Enable cache buster
+  # activate :cache_buster
+end

data/lib/middleman-blog/template/source/2011/01/01/new-article.html.markdown

@@ -0,0 +1,6 @@
+--- 
+title: "New Article title"
+date: 01/01/2011
+---
+
+Content of my article

data/lib/middleman-blog/template/source/archives/index.html.erb

@@ -0,0 +1,10 @@
+<h1>Archive: <%# @path %></h1>
+<ul class="archives">
+  <% for entry in data.blog.articles %>
+    <li>
+      <a href="<%= entry.url %>"><%= entry.title %></a>
+      <span><%= entry.date.strftime('%b %e') %></span>
+    </li>
+  <% end %>
+</ul>
+

data/lib/middleman-blog/template/source/feed.xml.builder

@@ -0,0 +1,23 @@
+xml.instruct!
+xml.feed "xmlns" => "http://www.w3.org/2005/Atom" do
+  xml.title "Blog Name"
+  xml.subtitle "Blog subtitle"
+  xml.id "http://blog.url.com/"
+  xml.link "href" => "http://blog.url.com/"
+  xml.link "href" => "http://blog.url.com/feed.xml", "rel" => "self"
+  xml.updated data.blog.articles.first.date.to_time.iso8601
+  xml.author { xml.name "Blog Author" }
+
+  data.blog.articles.each do |article|
+    xml.entry do
+      xml.title article.title
+      xml.link "rel" => "alternate", "href" => article.url
+      xml.id article.url
+      xml.published article.date.to_time.iso8601
+      xml.updated article.date.to_time.iso8601
+      xml.author { xml.name "Article Author" }
+      xml.summary article.summary, "type" => "html"
+      xml.content article.body, "type" => "html"
+    end
+  end
+end

data/lib/middleman-blog/template/source/index.html.erb

@@ -0,0 +1,9 @@
+<% data.blog.articles[0...5].each_with_index do |article, i| %>
+  <article class="<%= (i == 0) ? 'first' : '' %>">
+    <h1><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e %Y') %></span></h1>
+    
+    <%= article.summary %>
+    
+    <div class="more"><a href="<%= article.url %>">read on &raquo;</a></div>
+  </article>
+<% end %>

data/lib/middleman-blog/template/source/layout.erb

@@ -0,0 +1,30 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv='X-UA-Compatible' content='IE=edge;chrome=1' />
+  </head>
+  <body>
+    
+    <div id="main" role="main">
+      <% if is_blog_article? %>
+        <% content_for :blog_article, yield %>
+        <%= partial settings.blog_article_template %>
+      <% else %>
+        <%= yield %>
+      <% end %>
+    </div>
+    
+    <aside>
+      <h2>
+        Recent Articles
+        <a href="/archives">Archive</a>
+      </h2>
+      <ol>
+        <% data.blog.articles[0...10].each do |article| %>
+          <li><a href="<%= article.url %>"><%= article.title %></a> <span><%= article.date.strftime('%b %e') %></span></li>
+        <% end %>
+      </li>
+    </aside>
+  </body>
+</html>

data/lib/middleman-blog/version.rb

@@ -1,5 +1,5 @@
 module Middleman
   module Blog
-    VERSION = "0.0.1"
+    VERSION = "0.1.0"
   end
 end

data/lib/middleman_init.rb

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

data/middleman-blog.gemspec

@@ -6,18 +6,18 @@ Gem::Specification.new do |s|
   s.name        = "middleman-blog"
   s.version     = Middleman::Blog::VERSION
   s.platform    = Gem::Platform::RUBY
-  s.authors     = ["Matthias Döring"]
-  s.email       = ["matt@foryourcontent.de"]
-  s.homepage    = "http://rubygems.org/gems/middleman-blog"
-  s.summary     = %q{Create a blog with Middleman}
-  s.description = %q{Create a blog with Middleman}
+  s.authors     = ["Thomas Reynolds"]
+  s.email       = ["me@tdreyno.com"]
+  s.homepage    = "https://github.com/tdreyno/middleman-blog"
+  s.summary     = %q{A blog foundation using Middleman}
+  s.description = %q{A blog foundation using Middleman}
 
   s.rubyforge_project = "middleman-blog"
 
-  s.add_dependency "middleman", "~> 1.2.0"
-
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  
+  s.add_runtime_dependency("middleman", ["~> 2.0.2"])
 end

metadata

@@ -1,17 +1,21 @@
 --- !ruby/object:Gem::Specification 
 name: middleman-blog
 version: !ruby/object:Gem::Version 
+  hash: 27
   prerelease: 
-  version: 0.0.1
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
-- "Matthias D\xC3\xB6ring"
+- Thomas Reynolds
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 +02:00
-default_executable: 
+date: 2011-08-20 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: middleman
@@ -21,12 +25,17 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 1.2.0
+        hash: 11
+        segments: 
+        - 2
+        - 0
+        - 2
+        version: 2.0.2
   type: :runtime
   version_requirements: *id001
-description: Create a blog with Middleman
+description: A blog foundation using Middleman
 email: 
-- matt@foryourcontent.de
+- me@tdreyno.com
 executables: []
 
 extensions: []
@@ -35,18 +44,24 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
-- .rvmrc
 - Gemfile
-- README.rdoc
 - Rakefile
+- lib/.DS_Store
 - lib/middleman-blog.rb
-- lib/middleman-blog/blog_engine.rb
-- lib/middleman-blog/separator.rb
-- lib/middleman-blog/tilt.rb
+- lib/middleman-blog/.DS_Store
+- lib/middleman-blog/feature.rb
+- lib/middleman-blog/template.rb
+- lib/middleman-blog/template/config.ru
+- lib/middleman-blog/template/config.tt
+- lib/middleman-blog/template/source/2011/01/01/new-article.html.markdown
+- lib/middleman-blog/template/source/archives/index.html.erb
+- lib/middleman-blog/template/source/feed.xml.builder
+- lib/middleman-blog/template/source/index.html.erb
+- lib/middleman-blog/template/source/layout.erb
 - lib/middleman-blog/version.rb
+- lib/middleman_init.rb
 - middleman-blog.gemspec
-has_rdoc: true
-homepage: http://rubygems.org/gems/middleman-blog
+homepage: https://github.com/tdreyno/middleman-blog
 licenses: []
 
 post_install_message: 
@@ -59,19 +74,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 requirements: []
 
 rubyforge_project: middleman-blog
-rubygems_version: 1.6.2
+rubygems_version: 1.8.6
 signing_key: 
 specification_version: 3
-summary: Create a blog with Middleman
+summary: A blog foundation using Middleman
 test_files: []
 

data/.rvmrc

@@ -1 +0,0 @@
-rvm ruby-1.9.2-p180@middleman-blog

data/README.rdoc

@@ -1,123 +0,0 @@
-= middleman-blog
-
-Create a blog with Middleman
-
-== Features
-
-- metadata (yaml) for your post templates (similar to https://github.com/mojombo/jekyll/wiki/YAML-Front-Matter)
-- helper methods to access the metadata from every template/layout file
-- template languages: markdown, textile, rdoc
-
-== TODO
-
-- test suite
-- better documentation
-- installer/generator
-- more helpers
-- more build-in features (releated posts, tags etc.)
-
-== Usage
-
-Example: https://github.com/matt-hh/middleman-blog-example
-
-1. Install
-
-    gem install middleman-blog
-    
-   Additionally you need one of the following gems for your post templates: Kramdown, Maruku, RedCloth, BlueCloth, RDiscount ...
-
-2. Create your project
-
-    mm-init your-middleman-project
-
-3. Create config/blogs.yml with default values 
-
-    blog:
-      title: My Blog
-      author: your name
-      mail: your mail
-      whatever: a value
-    another-blog:
-      title: My second Blog
-
-   Yes, you can define default values for more than one blog...
-
-4. Create layout files:
-
-   blog_index.haml:
-
-    %h1= current_blog_value('title')
-    = yield
-
-   blog_post.haml:
-
-    %h1= current_post_value('title')
-    = yield
-
-5. Activate feature in config.rb
-
-    require "middleman-blog"
-    activate :blog_engine
-    
-    page "/blog/index.html", :layout => :blog_index, :layout_engine => 'haml'
-    page "/blog/*", :layout => :blog_post, :layout_engine => 'haml'
-    
-    page "/another-blog/index.html", :blog_post => :blog_index, :layout_engine => 'haml'
-    page "/another-blog/*", :blog_post => :blog_post, :layout_engine => 'haml'
-
-6. Create directories in your source folder
-
-    mkdir blog
-    mkdir my-second-blog
-
-   In these folders you can create your posts.
-
-   blog/my-first-post.html.md
-
-    title: Title of my first post
-    date: 2011-06-05
-    ----
-    
-    
-    My first blog post...
-
-   Important: 2 newlines between "----" and "My first..."
-
-== Metadata
-
-- "----\n\n\n" separates the metadata from your post data.
-- metadata supports ERB
-- you can define whatever you want
-- special keys for blogs.yml: 
-  sort_by: name of another key (default is date)
-  sort_direction: normal | reverse (default is reverse)
-- special keys for yaml header: 
-  date: default is mtime for template file
-
-== Helper methods
-
-- current_blog
-- current_blog_meta(key) or current_blog[key]
-- current_post
-- current_post_meta(key) or current_post[key]
-- next_post
-- prev_post
-- current_blog_ident
-- current_post_ident
-- current_post_index
-
-=== Examples
-
-- Link to the next post
-
-    link_to next_post['title'], next_post['link']
-
-- List of 10 last posts
-
-    %ul
-      - current_blog["posts"][0,10].each do |post|
-        %li= link_to post['title'], post['link']
-
-== Links
-
-* https://github.com/tdreyno/middleman

data/lib/middleman-blog/blog_engine.rb

@@ -1,108 +0,0 @@
-module Middleman
-  module Features
-    module BlogEngine
-
-      class << self
-        def registered(app)
-          app.helpers BlogEngine::Helpers
-        end
-        alias :included :registered
-      end
-
-      module Helpers
-        def blog(blog_ident)
-          blogs[blog_ident] || {"posts" => []}
-        end
-        def current_blog
-          blog(current_blog_ident)
-        end
-        def blog_meta(blog_ident, key)
-          blog(blog_ident)[key] || no_value
-        end
-        def current_blog_meta(key)
-          blog_meta(current_blog_ident,key)
-        end
-        def blog_post(blog_ident, post_ident)
-          blog(blog_ident)["posts"].find {|post| post["ident"] == post_ident } || {}
-        end
-        def current_post
-          blog_post(current_blog_ident, current_post_ident)
-        end
-        def blog_post_meta(blog_ident, post_ident, key)
-          blog_post(blog_ident, post_ident)[key] || blog_meta(blog_ident, key) || no_value
-        end
-        def current_post_meta(key)
-          blog_post_meta(current_blog_ident, current_post_ident, key)
-        end
-        def next_post
-          current_blog["posts"][current_post_index + 1]
-        end
-        def prev_post
-          current_blog["posts"][current_post_index - 1]
-        end
-        def current_blog_ident
-          (File.dirname request_path).gsub(%r{^/}, '') || "blog"
-        end
-        def current_post_ident
-          File.basename(request_path).split(".", 2)[0]
-        end
-        def current_post_index
-          current_blog["posts"].index current_post
-        end
-
-        def blogs
-          Middleman::Features::BlogEngine::Meta.new(self).data
-        end
-
-        private
-          def request_path
-            self.env['REQUEST_PATH'] || ""
-          end
-          def no_value
-            "-- no value --"
-          end
-
-      end
-
-      class Meta
-        attr_reader :data
-
-        def initialize(app)
-          @app = app
-
-          config_file = File.join(@app.class.root, "config", "blogs.yml")
-          raise "could not find \"#{config_file}\" " unless File.exists?(config_file)
-          blog_config = YAML.load_file(config_file)
-          @data = blog_config
-
-          blog_config.each do |blog_ident,blog_values|
-            blog_source_dir = File.join(@app.class.views, blog_ident)
-            @data[blog_ident]["posts"] = []
-            Dir["#{blog_source_dir}/*.html.*"].each do |file|
-              if file =~ /.*\.html\.(markdown|mkd|md|textile|rdoc)$/
-                post_ident = File.basename(file).split(".", 2)[0]
-
-                post_meta_yml = ERB.new( (File.read(file).split(/#{Middleman::Blog::SEPARATOR}/, 2))[0] || "" ).result
-                post_meta = YAML.load(post_meta_yml) || {}
-                post_meta["ident"] = post_ident
-                post_meta["link"] = "/%s" % File.join( blog_ident, File.basename(file, '.*') )
-                post_meta["date"] = File.mtime(file).to_s unless post_meta["date"]
-                @data[blog_ident]["posts"] << post_meta
-              end
-            end
-
-            sort_key = @data[blog_ident]["sort_key"] || "date"
-            @data[blog_ident]["posts"].sort_by! { |post| post[sort_key] }
-            sort_direction = @data[blog_ident]["sort_direction"] || "reverse"
-            @data[blog_ident]["posts"].reverse! if sort_direction == "reverse"
-          end
-
-        end
-
-      end
-
-
-
-    end
-  end
-end

data/lib/middleman-blog/separator.rb

@@ -1,5 +0,0 @@
-module Middleman
-  module Blog
-    SEPARATOR = '----\n\n\n'
-  end
-end

data/lib/middleman-blog/tilt.rb

@@ -1,54 +0,0 @@
-module Tilt
-
-  module MiddlemanBlogTemplate
-    def prepare
-      @data = data.gsub(/^.*?#{Middleman::Blog::SEPARATOR}/m, '')
-      super
-    end
-  end
-
-
-  # MARKDOWN
-
-  class MarukuMiddlemanBlogTemplate < MarukuTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register MarukuMiddlemanBlogTemplate, 'markdown', 'mkd', 'md'
-
-  class KramdownMiddlemanBlogTemplate < KramdownTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register KramdownMiddlemanBlogTemplate, 'markdown', 'mkd', 'md'
-
-  class BlueClothMiddlemanBlogTemplate < BlueClothTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register BlueClothMiddlemanBlogTemplate, 'markdown', 'mkd', 'md'
-
-  class RedcarpetMiddlemanBlogTemplate < RedcarpetTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register RedcarpetMiddlemanBlogTemplate, 'markdown', 'mkd', 'md'
-
-  class RDiscountMiddlemanBlogTemplate < RDiscountTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register RDiscountMiddlemanBlogTemplate, 'markdown', 'mkd', 'md'
-
-  # TEXTILE
-
-  class RedClothMiddlemanBlogTemplate < RedClothTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register RedClothMiddlemanBlogTemplate, 'textile'
-
-  # RDOC
-
-  class RDocMiddlemanBlogTemplate < RDocTemplate
-    include Tilt::MiddlemanBlogTemplate
-  end
-  register RDocMiddlemanBlogTemplate, 'rdoc'
-
-
-
-end