memorack 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6e66f5b1c38568ebc3011b2210c3b890fa0a8e36
-  data.tar.gz: 006b12c2a64d34170e3a7f3b1543c1dd61120222
+  metadata.gz: 86c45efe555619b9ccb0baf170a9ec452f0fa52e
+  data.tar.gz: b012723ff47cef6d9887501fd28c88d3d6a5fcfc
 SHA512:
-  metadata.gz: e6e4612436e39a618a59681f0db052f8069a05eb1d332ab754fddfc0cc4ba2371981ab77bf2e42f328d5f55e2025180ce73f0ad9d7370d4bb9bc28d65b3dfe81
-  data.tar.gz: 44cfe752ef03701a381582aa26a1020320a161eb061b06b1d6c2a5864f901dca55c145056b3ad12b395e655e12247eb99995ac378b242e8cdf63065e5c9612e8
+  metadata.gz: 5ca5bf21735546d0371a71efebad1c902b869283495a26b4c276442e0cb949169ddafd894479590c3d77bebf5c82479a9548346607f1f9321301a9e6f6390c21
+  data.tar.gz: dbfa869e5a135c9d5244d7b92cb65aab7634786b8a0361c643e2b9039de285074ab65f88834f60a3396d8a58013da548bf82c00517bb07c0d3d5ac0fad560f5b

data/HISTORY.md

@@ -1,5 +1,20 @@
 ## History
 
+### v0.2.0 / 2013-05-12
+
+* plugin
+* macro
+* pages
+* add `page.html` for content template
+* support user domain themes/plugins folder (ex. `~/.etc/memorack/themes/`)
+* yaml support for configuration (ex. `config.yml`)
+* page title from content headline (markdown/org only)
+* page title from locale (pages)
+* page created/modified time
+* to optional path of server subcommand (default: `content`)
+* add option `--index` of build subcommand
+* change default values
+
 ### v0.1.2 / 2013-05-06
 
 * build not remove .git/.hg/.svn/.cvs direcotry

data/README.md

@@ -22,8 +22,8 @@ Or install it yourself as:
 	$ memorack theme					# Show theme list
 	$ memorack theme THEME				# Show theme info
 	$ memorack theme -c THEME			# Copy theme
-	$ memorack server PATH				# Instant Server
-	$ memorack build [PATH]				# Build static site
+	$ memorack server [PATH]			# Instant Server
+	$ memorack build  [PATH]			# Build static site
 
 Standard startup
 
@@ -67,12 +67,16 @@ Template
 	├── .powenv                    -- for pow + rbenv
 	├── Gemfile                    -- `bundle install`
 	├── config.ru                  -- for rack application
-	├── content                    -- Content directory for memo
+	├── content/                   -- Content directory for memo
 	│   └── README.md              -- Sample file(remove it)
-	└── themes
-	    └── custom                 -- Default theme
+	├── plugins/					-- Plugins directory
+	└── themes/
+	    └── custom/                -- Default theme
 	        ├── config.json        -- Configuration
-	        └── index.md           -- Description(Show by top page)
+	        ├── index.md           -- Description(Show by top page)
+	        ├── locales/			-- Locales directory
+	        ├── macro.yml			-- Macro
+	        └── pages/				-- Pages directory
 
 ## Customization
 
@@ -87,18 +91,18 @@ Template
 
 Directory
 
-	└── themes
-	    └── custom
+	└── themes/
+	    └── custom/
 	        ├── config.json
 	        ├── index.html         <-- Edit layout
 	        └── index.md
 
 ### Logo
 
-	└── themes
-	    └── custom
+	└── themes/
+	    └── custom/
 	        ├── config.json        <-- Add "logo": "/img/logo.png"
-	        ├── img
+	        ├── img/
 	        │   └── logo.png       <-- Add image file
 	        ├── index.html         <-- Add <img id="logo" src="{{logo}}" />
 	        └── index.md
@@ -107,8 +111,8 @@ Directory
 
 Download [highlight.js](http://softwaremaniacs.org/soft/highlight/en/)
 
-	└── themes
-	    └── custom
+	└── themes/
+	    └── custom/
 	        ├── config.json
 	        ├── highlight.js       <-- `unzip highlight.zip`
 	        ├── index.html         <-- Add code
@@ -130,7 +134,6 @@ Edit `config.json`
 
 	{
 		"formats":		["markdown", "org"],
-		"requires":		["org-ruby"],
 		...
 	}
 
@@ -156,7 +159,6 @@ Special variables -- `{{{VAR}}}`
 * Template comments translate english
 * Add customizing tips
 * More test program
-* Plugin
 * Generate EPUB3
 
 ## Contributing

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.2.0

data/lib/memorack/builder.rb

@@ -15,6 +15,7 @@ module MemoRack
 			prefix:		'/',
 			suffix:		'.html',
 			uri_escape:	true,
+			env:		ENV,
 		}
 
 		DEFAULT_KEEPS = ['.git', '.hg', '.svn', '.csv']
@@ -25,12 +26,18 @@ module MemoRack
 
 			url = @site[:url]
 			options[:prefix] = File.join(url, options[:prefix]) unless url.empty?
+			@suffix = options[:suffix]
 
 			output = File.expand_path(options[:output])
 			dir_init(output, keeps)
 
 			@contents = contents(options)
 			@templates = Set.new @contents.files.collect { |file| file[:path] }
+			@directories = Set.new @templates.collect { |path| File.dirname(path) }
+			@directories.delete('.')
+
+			# ロケールの更新
+			update_locale(options[:env])
 
 			# トップページを作成する
 			content_write(:index, '.html', output) { |template|
@@ -40,12 +47,24 @@ module MemoRack
 			suffix = options[:suffix]
 			suffix = '/index.html' if ['', '/'].member?(suffix)
 
+			# サブディレクトリの index.html を出力する
+			build_index(@directories, output, &callback) if options[:index] || @options[:index]
+
+			# 固定ページのレンダリングを行う
+			pages.each { |path_info, path|
+				callback.call(path_info) if callback
+
+				content_write(path_info, suffix, output) { |template|
+					render_page template, {path_info: path_info}
+				}
+			}
+
 			# コンテンツのレンダリングを行う
 			@templates.each { |path|
 				callback.call(path) if callback
 
 				content_write(path, suffix, output) { |template|
-					render_content(template)
+					render_content template, {path_info: path}, nil
 				}
 			}
 
@@ -157,6 +176,21 @@ module MemoRack
 			}
 		end
 
+		# サブディレクトリの index.html を出力する
+		def build_index(directories, output, &callback)
+			# . は取除く
+			directories.delete('.')
+
+			# index.html を出力する
+			directories.each { |path|
+				callback.call(path) if callback
+
+				content_write(path, '/index.html', output) { |template|
+					render_content template, {path_info: path}, nil
+				}
+			}
+		end
+
 		#### テンプレート
 
 		# インデックスを作成
@@ -170,7 +204,7 @@ module MemoRack
 
 		# メニューを作成
 		template :menu do
-			@contents.generate(StringIO.new).string
+			@contents.generate(StringIO.new, &method(:content_name).to_proc).string
 		end
 
 	end

data/lib/memorack/cli.rb

@@ -27,7 +27,7 @@ module MemoRack
 					opts.banner = <<-BANNER.gsub(/^\t+/,'')
 						Usage: #{opts.program_name} create [options] PATH
 						       #{opts.program_name} theme  [options] [THEME]
-						       #{opts.program_name} server [options] PATH
+						       #{opts.program_name} server [options] [PATH]
 						       #{opts.program_name} build  [options] [PATH]
 					BANNER
 
@@ -150,9 +150,9 @@ module MemoRack
 		}
 
 		# サーバーの実行
-		define_options(:server, '[options] PATH') { |opts, argv, options|
+		define_options(:server, '[options] [PATH]') { |opts, argv, options|
 			default_options = {
-					theme: 'oreilly',
+					theme: 'custom',
 
 					server: {
 						environment:	ENV['RACK_ENV'] || 'development',
@@ -172,7 +172,6 @@ module MemoRack
 			opts.on("-h", "--help", t(:help)) { abort opts.help }
 
 			opts.parse!(argv)
-			abort opts.help if argv.empty?
 		}
 
 		# 静的サイトのビルド
@@ -184,6 +183,7 @@ module MemoRack
 
 					local:		false,
 					prettify:	false,
+					index:		false,
 				}
 
 			options.merge!(default_options)
@@ -199,6 +199,8 @@ module MemoRack
 				t(:local)) { options[:local] = true }
 			opts.on("--prettify",
 				t(:prettify)) { options[:prettify] = true }
+			opts.on("--index",
+				t(:index)) { options[:index] = true }
 			opts.on("-h", "--help", t(:help)) { abort opts.help }
 
 			opts.parse!(argv)
@@ -271,7 +273,8 @@ module MemoRack
 
 		# サーバーの実行
 		def memorack_server(options, *argv)
-			path = argv.shift
+			path ||= argv.shift
+			path ||= 'content'
 			abort "Directory not exists '#{path}'" unless File.exists?(path)
 			abort "Not directory '#{path}'" unless File.directory?(path)
 

data/lib/memorack/config/macro.yml

@@ -0,0 +1,2 @@
+page:
+  title: '{{#content?}}{{page.name}} | {{/content?}}{{title}}'

data/lib/memorack/core.rb

@@ -1,21 +1,25 @@
 # -*- encoding: utf-8 -*-
 
+require 'yaml'
 require 'pathname'
 require 'rubygems'
+require 'i18n'
 
 require 'memorack/tilt-mustache'
-require 'memorack/locals'
 require 'memorack/mdmenu'
+require 'memorack/locals'
+require 'memorack/locals/base'
+
 
 module MemoRack
 	class Core
-		attr_reader :themes, :options_chain
+		attr_reader :themes, :options_chain, :suffix, :root
 
 		DEFAULT_APP_OPTIONS = {
 			root:				'content/',
 			themes_folder:		'themes/',
 			tmpdir:				'tmp/',
-			theme:				'basic',
+			theme:				'oreilly',
 			markdown:			'redcarpet',
 			formats:			['markdown'],
 			css:				nil,
@@ -38,10 +42,19 @@ module MemoRack
 
 		DEFAULT_OPTIONS = DEFAULT_APP_OPTIONS.merge(DEFAULT_TEMPLATE_OPTIONS).merge(DEFAULT_LOCALS)
 
+		def self.app
+			@@app
+		end
+
 		def initialize(options={})
+			@@app = self
+
 			options = DEFAULT_OPTIONS.merge(to_sym_keys(options))
 
-			@themes_folders = [options[:themes_folder], File.expand_path('../themes/', __FILE__)]
+			@themes_folders = [options[:themes_folder], folder(:themes, :user), folder(:themes)]
+			@themes_folders.delete nil
+			@themes_folders.reject! { |folder| ! File.directory?(folder) }
+
 			read_config(options[:theme], options)
 			read_config(DEFAULT_APP_OPTIONS[:theme], options) if @themes.empty?
 
@@ -55,12 +68,38 @@ module MemoRack
 				@options.delete(key)
 			}
 
+			# プラグインの読込み
+			load_plugins
+
+			# ロケールの読込み
+			I18n.load_path = @locale_paths
+			I18n.backend.load_translations
+
 			@requires.each { |lib| require lib }
 			@locals = default_locals(@options)
 
 			use_engine(@markdown)
 		end
 
+		# フォルダ（ディレクトリ）を取得する
+		def folder(name, domain = :app)
+			@folders ||= {}
+			@folders[domain] ||= {}
+
+			unless @folders[domain][name]
+				case domain
+				when :user
+					dir = File.join(ENV['HOME'], '.etc/memorack')
+				when :app
+					dir = File.dirname(__FILE__)
+				else
+					return nil
+				end
+			end
+
+			@folders[domain][name] ||= File.expand_path(name.to_s, dir)
+		end
+
 		# テーマのパスを取得する
 		def theme_path(theme)
 			return nil unless theme
@@ -75,28 +114,44 @@ module MemoRack
 
 		# デフォルトの locals を生成する
 		def default_locals(locals = {})
-			locals = Locals[locals]
-
-			locals[:site]			||= @site
-
-			locals[:app]			||= Locals[]
-			locals[:app][:name]		||= MemoRack::name
-			locals[:app][:version]	||= MemoRack::VERSION
-			locals[:app][:url]		||= MemoRack::HOMEPAGE
+			locals = BaseLocals.new(self, locals)
+			locals[:site] ||= @site
+			locals
+		end
 
-			locals.define_key(:__menu__) { |hash, key|
-				@menu = nil unless @directory_watcher	# ファイル監視していない場合はメニューを初期化
-				@menu ||= render :markdown, :menu, @options
-			}
+		# json/yaml のデータを読込む
+		def read_data(name, exts = ['json', 'yml', 'yaml'])
+			begin
+				exts.each { |ext|
+					path = [name, ext].join('.')
+					if File.readable?(path)
+						data = File.read(path)
+
+						case ext
+						when 'json'
+							hash = JSON.parse(data)
+						when 'yml', 'yaml'
+							hash = YAML.load(data)
+						end
+
+						data = to_sym_keys(hash) if hash
+						return data
+					end
+				}
+			rescue
+			end
 
-			locals
+			nil
 		end
 
 		# 設定ファイルを読込む
 		def read_config(theme, options = {})
 			@themes ||= []
 			@options_chain = []
-			@theme_chain = []
+			@locale_paths = []
+			@macro_chain = []
+			@macro = {}
+			@plugins = Set.new
 
 			begin
 				require 'json'
@@ -106,26 +161,112 @@ module MemoRack
 					break unless dir
 					break if @themes.member?(dir)
 
-					# テーマ・チェインに追加
-					@themes << File.join(dir, '')
-
-					# config の読込み
-					path = File.join(dir, 'config.json')
-					break unless File.readable?(path)
-
-					data = File.read(path)
-					@options_chain << to_sym_keys(JSON.parse(data))
-
-					theme = @options_chain.last[:theme]
+					# 設定ファイルのデータをチェインに追加
+					theme = add_config_chain(dir, theme)
 				end
 			rescue
 			end
 
+			# デフォルトの設定をチェインに追加
+			add_config_chain(File.expand_path('../config', __FILE__))
+
+			# マクロをマージ
+			@macro_chain.reverse.each { |macro| @macro.merge!(macro) }
+
 			# オプションをマージ
 			@options_chain.reverse.each { |opts| options.merge!(opts) }
 			options
 		end
 
+		# 設定ファイルのデータをチェインに追加
+		def add_config_chain(dir, theme = nil)
+			# テーマ・チェインに追加
+			@themes << File.join(dir, '') if theme
+
+			# config の読込み
+			config = read_data(File.join(dir, 'config'))
+
+			if config
+				@options_chain << config
+				theme = config[:theme]
+			end
+
+			# macro の読込み
+			macro = read_data(File.join(dir, 'macro'))
+			@macro_chain << macro if macro && macro.kind_of?(Hash)
+
+			# locale の読込み
+			@locale_paths += Dir[File.expand_path('locales/*.yml', dir)]
+
+			theme
+		end
+
+		# locale を env情報で更新する
+		def update_locale(env = ENV)
+			locale ||= env['HTTP_ACCEPT_LANGUAGE']
+			locale ||= env['LANG'] if env['LANG']
+			locale = locale[0, 2].to_sym if locale
+			I18n.locale = locale if I18n.available_locales.include?(locale)
+		end
+
+		# プラグイン・フォルダを取得する
+		def plugins_folders
+			unless @plugins_folders
+				@plugins_folders = ['plugins/', folder(:plugins, :user), folder(:plugins)]
+				@plugins_folders.delete nil
+				@plugins_folders.reject! { |folder| ! File.directory?(folder) }
+
+				@themes.each { |theme|
+					path = File.join(theme, 'plugins/')
+					@plugins_folders.unshift path if File.directory?(path)
+				}
+			end
+
+			@plugins_folders
+		end
+
+		# プラグインを読込む
+		def load_plugins
+			plugins_folders.reverse.each { |folder|
+				Dir.glob(File.join(folder, '*')) { |path|
+					name = path.gsub(%r[^#{folder}/], '')
+					load_plugin(name, path)
+				}
+			}
+		end
+
+		# プラグインファイルを読込む
+		def load_plugin(name, path)
+			loaded = false
+
+			if File.directory?(path)
+				path = File.join(path, File.basename(path) + '.rb')
+
+				if File.exists?(path)
+					require_relative(path)
+					loaded = true
+				end
+			elsif path =~ /\.rb$/
+				require_relative(File.expand_path(path))
+				loaded = true
+			end
+
+			if loaded
+				@plugins << name
+			end
+		end
+
+		# プラグインを読込む（読込み済みのものは読込まない）
+		def require_plugin(plugin)
+			return if @plugins.include?(plugin)
+
+			plugins_folders.reverse.each { |folder|
+				path = File.join(folder, plugin)
+				load_plugin(folder, path) if File.exist?(path)
+				load_plugin(folder, path + '.rb') if File.exist?(path + '.rb')
+			}
+		end
+
 		# テンプレートエンジンを使用できるようにする
 		def use_engine(engine)
 			require engine if engine
@@ -139,6 +280,29 @@ module MemoRack
 			@css_exts ||= Set.new ['css', *@css]
 		end
 
+		# テーマから固定ページのファイルを収集する
+		def pages
+			unless @pages
+				@pages = {}
+
+				@themes.each { |theme|
+					folder = File.join(theme, 'pages/')
+
+					if Dir.exists?(folder)
+						Dir.chdir(folder) { |dir|
+							Dir.glob(File.join('**/*')) { |path|
+								path_info, ext = split_extname(path)
+								path_info = File.join('', path_info)
+								@pages[path_info] ||= File.expand_path(path)
+							}
+						}
+					end
+				}
+			end
+
+			@pages
+		end
+
 		# ファイルを探す
 		def file_search(template, options = {}, exts = enable_exts)
 			options = {views: @root}.merge(options)
@@ -161,13 +325,16 @@ module MemoRack
 				return nil
 			end
 
+			dir = options[:views]
+			dir = File.join(dir, options[:folder]) if options[:folder]
+
 			if exts
 				exts.each { |ext|
-					path = File.join(options[:views], "#{template}.#{ext}")
+					path = File.join(dir, "#{template}.#{ext}")
 					return path if File.exists?(path)
 				}
 			else
-				path = File.join(options[:views], template)
+				path = File.join(dir, template)
 				return path if File.exists?(path)
 			end
 
@@ -217,7 +384,8 @@ module MemoRack
 		# レイアウトに mustache を適用してテンプレートエンジンでレンダリングする
 		def render_with_mustache(template, engine = :markdown, options = {}, locals = {})
 			begin
-				mustache_templ = options[:mustache] || 'index.html'
+				mustache_templ = []
+				mustache_templ << options[:mustache] if options[:mustache]
 
 				options = @options.merge(options)
 				locals = @locals.merge(locals)
@@ -225,47 +393,160 @@ module MemoRack
 				locals.define_key(:__content__) { |hash, key|
 					if engine
 						render engine, template, options
+					elsif locals[:directory?]
+						# ディレクトリ
+						nil
 					else
 						template
 					end
 				}
 
-				locals[:content] = true unless template == :index
+				locals[:directory?] = true if template.kind_of?(Pathname) && template.directory?
+				locals[:content?] = true unless template == :index || locals[:directory?]
 				locals[:page] = page = Locals[locals[:page] || {}]
 
+				if template.kind_of?(Pathname)
+					path = template.to_s
+					plugin = PageInfo[path]
+					locals[:page] = page = plugin.new(path, page, locals) if plugin
+				end
+
 				page.define_key(:name) { |hash, key|
-					unless template == :index
+					if hash.kind_of?(PageInfo)
+						hash.value(:title)
+					elsif template != :index
 						fname = locals[:path_info]
 						fname ||= template.to_s.force_encoding('UTF-8')
 						File.basename(fname)
 					end
 				}
 
-				page.define_key(:title) { |hash, key|
-					page_title = home_title = locals[:title]
-					page_name = hash[:name]
-					page_title = "#{page_name} | #{home_title}" if page_name
+				# マクロを組込む
+				embed_macro(locals, @macro)
+
+				# HTMLページをレンダリングする
+				if engine && engine.to_sym == :html
+					unless template.kind_of?(Pathname)
+						path = file_search(template, @options, [engine])
+						return nil unless path
+						template = Pathname.new(path)
+					end
+
+					locals.define_key(:__content__) { |hash, key| }
+					return render :mustache, template, {views: @themes}, locals
+				end
+
+				mustache_templ << 'page.html' if locals[:content?]
+				mustache_templ << 'index.html'
 
-					page_title
+				mustache_templ.each { |templ|
+					path = file_search(templ, {views: @themes}, nil)
+					next unless path
+
+					path = Pathname.new(path)
+					return render :mustache, path, {views: @themes}, locals
 				}
 
-				render :mustache, mustache_templ, {views: @themes}, locals
+				raise "Not found template #{mustache_templ}"
 			rescue => e
 				e.to_s
 			end
 		end
 
+		# Localsクラス 変換する
+		def value_to_locals(value)
+			case value
+			when Locals
+			when Hash
+				value = Locals[value]
+			else
+				value = Locals[]
+			end
+
+			value
+		end
+
+		# マクロを組込む
+		def embed_macro(hash, macro, options = {}, locals = hash)
+			macro.each { |key, value|
+				case value
+				when Hash
+					if hash[key].kind_of?(Array)
+						embed_macro_for_array(hash[key], value, options, locals)
+					else
+						hash[key] = value_to_locals(hash[key])
+						embed_macro(hash[key], value, options, locals)
+					end
+				when Array
+					hash[key] = [] unless hash[key]
+					a = hash[key]
+
+					if a.kind_of?(Array)
+						value.each_with_index { |item, index|
+							if item.kind_of?(Hash)
+								a[index] = value_to_locals(a[index])
+								embed_macro(a[index], item, options, locals)
+							else
+								a[index] = item
+							end
+						}
+					end
+				else
+					hash.define_key(key) { |hash, key|
+						if value
+							#render :mustache, value, {}, locals
+
+							engine = Tilt.new('.mustache', {}) { value }
+							engine.render({}, locals).force_encoding('UTF-8')
+						end
+					}
+				end
+			}
+		end
+
+		# マクロを配列に組込む
+		def embed_macro_for_array(array, macro, options = {}, locals)
+			array.each_with_index { |item, index|
+				if item.kind_of?(Array)
+					embed_macro_for_array(item, macro, options, locals)
+				else
+					array[index] = value_to_locals(item)
+					embed_macro(array[index], macro, options)
+				end
+			}
+		end
+
+		# メニューをレンダリングする
+		def render_menu
+			@menu = nil unless @directory_watcher	# ファイル監視していない場合はメニューを初期化
+			@menu ||= render :markdown, :menu, @options
+		end
+
+		# 固定ページをレンダリングする
+		def render_page(path_info, locals = {})
+			path_info = path_info.gsub(%r[(/|.html)$], '')
+			path = pages[path_info]
+			return nil unless path
+
+			ext = split_extname(path)[1]
+			content = render_with_mustache Pathname.new(path), ext, {}, locals
+		end
+
 		# コンテンツをレンダリングする
-		def render_content(path_info, locals = {})
+		def render_content(path_info, locals = {}, exts = enable_exts)
+			path = File.join(@root, path_info)
+
+			if File.directory?(path)
+				return render_with_mustache Pathname.new(path), nil, {}, locals
+			end
+
 			path, ext = split_extname(path_info)
 
-			if @suffix == ''
-				fullpath = file_search(path_info, @options)
+			fullpath = file_search(path_info, @options, exts)
 
-				if fullpath
-					path = path_info
-					ext = split_extname(fullpath)[1]
-				end
+			if fullpath
+				path = path_info
+				ext = split_extname(fullpath)[1]
 			end
 
 			return nil unless ext && Tilt.registered?(ext)
@@ -355,6 +636,17 @@ module MemoRack
 			mdmenu
 		end
 
+		# パスからコンテント名を取得する
+		def content_name(path)
+			plugin = PageInfo[path]
+
+			if plugin
+				plugin.new(File.expand_path(path, @root))[:title]
+			else
+				File.basename(path, '.*')
+			end
+		end
+
 		# テンプレート名
 		def self.template_method(name)
 			name.kind_of?(Symbol) && "template_#{name}".to_sym