middleman-tansu 0.0.1

data/lib/middleman-tansu/drawer.rb

@@ -0,0 +1,50 @@
+module Middleman
+  module Tansu
+    class Drawer
+      def initialize(app, options, exclude_path = [])
+        @config       = app.config
+        @options      = options
+        @dirs         = ["/"]
+        @exclude_path = exclude(exclude_path)
+        search_directory(@config.source)
+      end
+
+      def empty
+        empty     = []
+        @dirs.each do |dir|
+          glob_path = File.join(@config.source, dir, "#{@config.tansu[:default_document].strip}*")
+          if Dir.glob(glob_path).length == 0
+            empty.push(dir)
+          end
+        end
+        empty
+      end
+
+      def search_directory(dir)
+        regex = Regexp.new("^" + @config.source)
+        Dir.glob(File.join(dir, '*')).each do |path|
+          if File.ftype(path) == "directory" && !exclude?(path)
+            @dirs.push(path.gsub(regex, ""))
+            search_directory(path)
+          end
+        end
+      end
+
+      def exclude(path)
+        default = [
+          @config.images_dir,
+          @config.js_dir,
+          @config.css_dir,
+          @config.layouts_dir,
+          @options.templates_dir
+        ]
+        default | path
+      end
+
+      def exclude?(path)
+        regex = Regexp.new("^#{@config.source}/(#{@exclude_path.join("|")})")
+        regex =~ path
+      end
+    end
+  end
+end

data/lib/middleman-tansu/extension.rb

@@ -0,0 +1,34 @@
+require "middleman-tansu/drawer"
+require "middleman-tansu/helpers"
+
+module Middleman
+  module Tansu
+    class Extension < ::Middleman::Extension
+      option :exclude_path, %w(sitemap.xml), "Path list that you don't want to see"
+      option :templates_dir, "templates", "Path of template directory's path in source direcotry"
+      option :index_template_name, "index.html", "Name of index template"
+      option :default_document, "index.html", "Name of default document. When you use IIS, set 'default.html'"
+
+      # Helpers for use within templates and layouts.
+      self.defined_helpers = [ ::Middleman::Tansu::Helpers ]
+
+      def initialize(app, options_hash = {}, &block)
+        super
+        app.config.tansu = {
+          :exclude_path     => options[:exclude_path],
+          :templates_dir    => options[:templates_dir],
+          :default_document => options[:default_document]
+        }
+      end
+
+      def after_configuration
+        exclude_path = options.exclude_path || []
+        Drawer.new(app, options, exclude_path).empty.each do |path|
+          app.proxy(File.join(path, options[:default_document]),
+                    File.join("/", options.templates_dir, options.index_template_name),
+                    ignore: true)
+        end
+      end
+    end
+  end
+end

data/lib/middleman-tansu/helpers.rb

@@ -0,0 +1,96 @@
+module Middleman
+  module Tansu
+    module Helpers
+      def path_list(current_path)
+        paths = []
+        splited = current_path.split("/")
+        splited.each_with_index do |val, index|
+          path = File.join("/", splited[0..index])
+          path = path + "/" unless /\.html$/ =~ path
+          val  = val.sub(".html", "") if /\.html$/ =~ val
+          paths.push({path: path, name: val}) unless /^index$/ =~ val
+        end
+        paths
+      end
+
+      def breadcrumbs(klass = 'breadcrumbs', root = "Top")
+        li = []
+        li.push("<li class=\"root\">#{link_to(root, "/")}</li>")
+
+        paths = path_list(current_resource.path)
+        paths.each do |path|
+          if path == paths.last
+            li.push("<li class=\"current\">#{path[:name]}</li>")
+          else
+            li.push("<li>#{link_to(path[:name], path[:path])}</li>")
+          end
+        end
+        "<ul class=\"#{klass}\">\n#{li.join("\n")}\n</ul>"
+      end
+
+      def children_pages(key = :date, order_by = :asc)
+        dirs  = []
+        pages = []
+
+        current_resource.children.each do |page|
+          if !exclude?(page.path)
+            if /index\.html$/ =~ page.path
+              dirs.push(page)
+            else
+              pages.push(page)
+            end
+          end
+        end
+
+        # Sorting pages and dirs
+        if order_by == :desc
+          pages = pages.sort {|a, b|
+            b.data[key] <=> a.data[key]
+          }
+          dirs = dirs.sort {|a, b|
+            b.path <=> a.path
+          }
+        else
+          pages = pages.sort {|a, b|
+            a.data[key] <=> b.data[key]
+          }
+          dirs = dirs.sort {|a, b|
+            a.path <=> b.path
+          }
+        end
+
+        dirs | pages
+      end
+
+      def exclude?(path)
+        regex = Regexp.new("^(#{exclude(path).join("|")})")
+        regex =~ path
+      end
+
+      def exclude(path)
+        default = [
+          config.images_dir,
+          config.js_dir,
+          config.css_dir,
+          config.layouts_dir,
+          config.tansu[:templates_dir]
+        ]
+        dirs = default | config.tansu[:exclude_path]
+      end
+
+      def page_name(page)
+        if page.data.title
+          paths = page.path.split("/")
+          paths.pop
+          File.join(paths, page.data.title).gsub(/^\//, "")
+        else
+          page.path.gsub(/(\/index)?\.html$/, "")
+        end
+      end
+
+      def page_url(page)
+        File.join("/", page.path.gsub(/index\.html$/, ""))
+      end
+    end
+  end
+end

data/lib/middleman-tansu/template.rb

@@ -0,0 +1,42 @@
+require 'middleman-core/templates'
+
+module Middleman
+  module Tansu
+
+    class Template < Middleman::Templates::Base
+      class_option 'css_dir',
+        default: 'stylesheets',
+        desc: 'The path to the css files'
+      class_option 'js_dir',
+        default: 'javascripts',
+        desc: 'The path to the javascript files'
+      class_option 'images_dir',
+        default: 'images',
+        desc: 'The path to the image files'
+
+      def self.source_root
+        File.join(File.dirname(__FILE__), 'template')
+      end
+
+      def build_scaffold!
+        template 'shared/Gemfile.tt', File.join(location, 'Gemfile')
+        template 'shared/config.tt', File.join(location, 'config.rb')
+
+        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])
+        empty_directory File.join(location, 'source', 'templates')
+        empty_directory File.join(location, 'source', 'layouts')
+
+        copy_file 'source/sample.html.md', File.join(location, 'source/sample.html.md')
+
+        copy_file 'source/layouts/layout.slim', File.join(location, 'source/layouts/layout.slim')
+
+        copy_file 'source/stylesheets/all.css.sass', File.join(location, 'source', options[:css_dir], 'all.css.sass')
+        copy_file 'source/stylesheets/github-markdown.css', File.join(location, 'source', options[:css_dir], 'github-markdown.css')
+
+        copy_file 'source/templates/index.html.slim', File.join(location, 'source', 'templates', 'index.html.slim')
+      end
+    end
+  end
+end

data/lib/middleman-tansu/template/shared/Gemfile.tt

@@ -0,0 +1,22 @@
+# If you do not have OpenSSL installed, update
+# the following line to use "http://" instead
+source 'https://rubygems.org'
+
+gem "middleman", "~>3.3.7"
+
+gem "middleman-pure", :github => "yterajima/middleman-pure"
+gem "middleman-tansu", :github => "yterajima/middleman-tansu"
+gem "middleman-syntax"
+
+gem "redcarpet"
+gem "slim"
+gem "builder"
+
+# Live-reloading plugin
+gem "middleman-livereload", "~> 3.1.0"
+
+# For faster file watcher updates on Windows:
+gem "wdm", "~> 0.1.0", :platforms => [:mswin, :mingw]
+
+# Windows does not come with time zone data
+gem "tzinfo-data", platforms: [:mswin, :mingw]

data/lib/middleman-tansu/template/shared/config.tt

@@ -0,0 +1,84 @@
+require "slim"
+require "builder"
+
+# Tansu Settings
+set :site_title, "Middleman-Tansu"
+activate :tansu
+
+# Markdown Settings
+set :markdown_engine, :redcarpet
+set :markdown, :fenced_code_blocks => true, :smartypants => true, :with_toc_data => true
+activate :syntax, :inline_theme => 'github'
+
+###
+# Compass
+###
+
+# Change Compass configuration
+# compass_config do |config|
+#   config.output_style = :compact
+# end
+
+###
+# Page options, layouts, aliases and proxies
+###
+
+# Per-page layout changes:
+#
+# With no layout
+# page "/path/to/file.html", :layout => false
+#
+# With alternative layout
+# page "/path/to/file.html", :layout => :otherlayout
+#
+# A path which all have the same layout
+# with_layout :admin do
+#   page "/admin/*"
+# end
+
+# Proxy pages (http://middlemanapp.com/basics/dynamic-pages/)
+# proxy "/this-page-has-no-template.html", "/template-file.html", :locals => {
+#  :which_fake_page => "Rendering a fake page with a local variable" }
+
+###
+# Helpers
+###
+
+# Automatic image dimensions on image_tag helper
+# activate :automatic_image_sizes
+
+# Reload the browser automatically whenever files change
+# configure :development do
+#   activate :livereload
+# end
+
+# Methods defined in the helpers block are available in templates
+# helpers do
+#   def some_helper
+#     "Helping"
+#   end
+# end
+
+set :css_dir, 'stylesheets'
+
+set :js_dir, 'javascripts'
+
+set :images_dir, 'images'
+
+# 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 :asset_hash
+
+  # Use relative URLs
+  # activate :relative_assets
+
+  # Or use a different image path
+  # set :http_prefix, "/Content/images/"
+end

data/lib/middleman-tansu/template/source/layouts/layout.slim

@@ -0,0 +1,54 @@
+doctype html
+html
+  head
+    meta charset="utf-8"
+
+    /! Always force latest IE rendering engine or request Chrome Frame
+    meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible"
+
+    meta name="viewport" content="width=device-width,user-scalable=no,maximum-scale=1"
+
+    title
+      - if /^index.html$/ =~ current_resource.path
+        = config.site_title
+      - elsif data.page.title
+        = "#{data.page.title} - #{config.site_title}"
+      - else
+        = "#{current_resource.path.gsub(/index\.html$/, "")} - #{config.site_title}"
+
+    == stylesheet_link_tag "all"
+
+  body class="#{page_classes}"
+    main
+      header
+        nav.breadcrumbs
+          == breadcrumbs
+
+        h1
+          - if /^index.html$/ =~ current_resource.path
+            = config.site_title
+          - elsif data.page.title
+            = data.page.title
+          - else
+            = current_resource.path.gsub(/index\.html$/, "")
+
+      article.markdown-body
+        - if data.page.author || data.page.date
+            div.metadata
+              - if data.page.author
+                dl
+                  dt author
+                  dd
+                    - if data.page.author.instance_of?(Array)
+                      == data.page.author.join(", ")
+                    - else
+                      == data.page.author
+
+              - if data.page.date
+                dl
+                  dt date
+                  dd
+                    == data.page.date
+
+        == yield
+

data/lib/middleman-tansu/template/source/sample.html.md

@@ -0,0 +1,75 @@
+---
+title: middleman-tansu の簡単な紹介
+author: yterajima
+date: 2014-01-25 23:32:00 +0900
+---
+
+[middleman-tansu](https://github.com/yterajima/middleman-tansu) は Markdown ファイルをディレクトリを使って分類管理するために開発されているテンプレートです。例えるなら, 静的な wiki のようなものを目指しています。バラバラに管理される Markdown を tansu (箪笥) に入れてまとめて管理できるように工夫されています。
+
+## middleman-tansu が提供する機能
+
+1. `middleman tansu` コマンド
+2. 各ディレクトリに `index.html` を用意する機能
+3. 自動生成された `index.html` を活用するための Helper
+4. プロジェクトテンプレート
+
+### 1.`middleman tansu` コマンド
+
+[middleman-blog](https://github.com/middleman/middleman-blog) のようにコマンドラインからページのひな形を作成することができます。
+
+```sh
+$ middleman tansu path/to/ページ
+```
+
+このコマンドによって `source/path/to/ページ.html.md` が作成されます。同時にこのテンプレートに必要な Frontmatter を書き込みます。
+
+
+### 2.各ディレクトリに `index.html` を用意する機能
+
+大量の Markdown ファイルを管理するには工夫が必要です。
+
+`source` ディレクトリ以下に次のようにディレクトリとファイルが用意されているとしましょう。
+
+```
+- source
+    - ディレクトリ1
+        - ページ1.md.html
+        - ページ2.md.html
+    - ディレクトリ2
+        - index.html.slim
+    - templates
+        - index.html.slim
+```
+
+この状態で `$ middleman server` を実行した場合, `http://localhost:4567` にアクセスしても何も表示されます。また, `http://localhost:4567/ディレクトリ1/` にアクセスしても当然何も表示されません。このまま build & deploy した場合, それぞれのページにたどり着けません。
+
+そこで, middleman-tansu では `index.html` にあたるファイルがない場合, 動的にそのページを生成しそのディレクトリ中のページやディレクトリへのリンクを提供します。
+
+__NOTICE__: `index.html` として出力されるファイルが存在する場合は, middleman-tansu はそのディレクトリに元からあった `index.html` を採用します。
+
+このディレクトリ構成の場合, `source/index.html` と `source/ディレクトリ1/index.html` を自動的に用意します。用意すると言ってもファイルを直接ディレクトリの中に作成する訳ではありません。[動的ページ](https://middlemanapp.com/jp/basics/dynamic-pages/) つまりは `proxy` を使って `$ middleman server`, `$ middleman build` の際にページを出力します。
+
+### 3.自動生成された `index.html` を活用するための Helper
+
+いくつかの Helper を提供しています。主に使われるのは次の 2 つになるでしょう。
+
+- breadcrumbs
+    - 表示されているページまでのパンくずリストを表示する
+    - layout の中で使われることがほとんどです
+- children_pages
+    - 現在のページがあるディレクトリ中のファイル/ディレクトリ一覧
+    - この Helper は `index.html` になるファイルの中で使われます
+
+
+### 4.プロジェクトテンプレート
+
+middleman-tansu は拡張機能と同時にプロジェクトテンプレートを提供しています。次のコマンドで初期化できます。
+
+```sh
+$ middleman tansu PROJECT_NAME --template tansu
+```
+
+このまま `$ middleman server` すると基本的な機能が用意されたテンプレートを使うことができます。このテンプレートは github-flavored-markdown を使用することができます。もちろんコードの構文ハイライトも対応します。
+
+
+