middleman-blog 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.DS_Store

data/.rvmrc

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

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in middleman-blog.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,123 @@
+= 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/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/lib/middleman-blog.rb

@@ -0,0 +1,3 @@
+require "middleman-blog/separator"
+require "middleman-blog/tilt"
+require "middleman-blog/blog_engine"

data/lib/middleman-blog/blog_engine.rb

@@ -0,0 +1,108 @@
+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

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

data/lib/middleman-blog/tilt.rb

@@ -0,0 +1,54 @@
+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

data/lib/middleman-blog/version.rb

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

data/middleman-blog.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "middleman-blog/version"
+
+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.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"]
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: middleman-blog
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.0.1
+platform: ruby
+authors: 
+- "Matthias D\xC3\xB6ring"
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: middleman
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.2.0
+  type: :runtime
+  version_requirements: *id001
+description: Create a blog with Middleman
+email: 
+- matt@foryourcontent.de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- .rvmrc
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/middleman-blog.rb
+- lib/middleman-blog/blog_engine.rb
+- lib/middleman-blog/separator.rb
+- lib/middleman-blog/tilt.rb
+- lib/middleman-blog/version.rb
+- middleman-blog.gemspec
+has_rdoc: true
+homepage: http://rubygems.org/gems/middleman-blog
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: middleman-blog
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Create a blog with Middleman
+test_files: []
+