memorack 0.0.4 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: df0fc4ad433a14e26057d9581ce8cbfaea6935ff
-  data.tar.gz: f14cfd511ca13b7aeaad9c02033b453e865e01b1
+  metadata.gz: 86ce4cc169545b6c715a427e966be9ad7a3832a2
+  data.tar.gz: 03e628e48a3764a8ec1dc1636ea6f03b60d51b1b
 SHA512:
-  metadata.gz: d0c623c98371ea471b8d0a3cf1f59536adf2a8658454560f1018b33b5fb9e583ebc9909e67ada318b8570e5ec3f9b16ea7f14578e11d3f9a81ebafa6e13892fc
-  data.tar.gz: 73b25aac401e3243ea35267e0afdce120c984b923386a899605dcf8c60ad119efc0e0df0b56578449e44e3c1d6cdb11571a7d4d4fbd1828514c26018f94b12f7
+  metadata.gz: 0c3d8523641d17d57fee096e9c715330b64f3a85b8f0952606e9e9f6d302d5a16aa1b1eb0908fc4b566b225bf6e632c50ea1e837ac0f737a2033fb21dcafbc0d
+  data.tar.gz: eff59e8755ff34c51c5ad47ab2b92525a95b81628cbb0d1ef2c5c6edeb79ab83eca89313bb764c53b5c19ac7a0d1e62cbb74bdd4471d9b6b8f7e78fc18b9b3b9

data/.gitignore

@@ -1,4 +1,4 @@
-/VERSION
+/REVISION
 *.gem
 *.rbc
 .bundle

data/HISTORY.md

@@ -1,5 +1,11 @@
 ## History
 
+### v0.1.0 / 2013-04-15
+
+* generate HTMLs for static site
+* add config.json options(requires, public, site.url)
+* change basic theme directory structure
+
 ### v0.0.4 / 2013-04-12
 
 * fix link in content

data/README.md

@@ -23,6 +23,7 @@ Or install it yourself as:
 	$ memorack theme THEME				# Show theme info
 	$ memorack theme -c THEME			# Copy theme
 	$ memorack server PATH				# Instant Server
+	$ memorack build [PATH]				# Build static site
 
 Standard startup
 
@@ -49,6 +50,14 @@ OS X (Pow + powder)
 * [Pow: Zero-configuration Rack server for Mac OS X](http://pow.cx)
 * `gem install powder`
 
+Build static site
+
+	$ memorack create memo
+	$ cd memo
+	(Customizing...)
+	$ memorack build --url http://foo.bar.baz
+	Build 'content/' -> '_site'
+
 ## Directory
 
 Template
@@ -111,10 +120,25 @@ Add code to `index.html`
 	<script src="/highlight.js/highlight.pack.js"></script>
 	<script>hljs.initHighlightingOnLoad();</script>
 
+### org-mode
+
+Install
+
+	$ gem install org-ruby
+
+Edit `config.json`
+
+	{
+		"formats":		["markdown", "org"],
+		"requires":		["org-ruby"],
+		...
+	}
+
 #### mustache variables
 
 Basic variables -- `{{VAR}}`
 
+* `site.url`
 * `title`
 * `page.title`
 * `app.name`
@@ -131,9 +155,9 @@ Special variables -- `{{{VAR}}}`
 
 * Template comments translate english
 * Add customizing tips
-* Server test program
-* Generate HTMLs for static site
+* More test program
 * Plugin
+* Generate EPUB3
 
 ## Contributing
 

data/Rakefile

@@ -1,4 +1,4 @@
-require File.expand_path('../etc/tools/update_version', __FILE__)
+require File.expand_path('../etc/tools/update_revision', __FILE__)
 require "bundler/gem_tasks"
 
 # Spec

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/etc/tools/update_revision.rb

@@ -0,0 +1,14 @@
+def update_revision(path = 'REVISION')
+	rev = `git describe --dirty --long 2>/dev/null`.chomp
+	rev = `git describe --dirty --long --tags --always`.chomp if rev.empty?
+	rev.gsub!(/^v([0-9])/, '\1')
+	rev.gsub!(/(^|-)([a-z0-9]+(-dirty)?)$/, '/\2')
+	rev.gsub!(/^([0-9.]+)-0\//, '\1/')
+
+	return if File.exists?(path) && rev == open(path).read.chomp
+
+	open(path, 'w') { |f| f.puts rev }
+end
+
+
+update_revision

data/lib/memorack/builder.rb

@@ -0,0 +1,171 @@
+# -*- encoding: utf-8 -*-
+
+require 'set'
+require 'fileutils'
+require 'pathname'
+require 'rubygems'
+
+require 'memorack/core'
+
+module MemoRack
+	class Builder < Core
+
+		DEFAULT_BUILD_OPTIONS = {
+			output:		'_site',
+			prefix:		'/',
+			suffix:		'.html',
+			uri_escape:	true,
+		}
+
+		def generate(options = {}, &callback)
+			options = DEFAULT_BUILD_OPTIONS.merge(options)
+
+			url = @site[:url]
+			options[:prefix] = File.join(url, options[:prefix]) unless url.empty?
+
+			output = File.expand_path(options[:output])
+			dir_init(output)
+
+			@contents = contents(options)
+			@templates = Set.new @contents.files.collect { |file| file[:path] }
+
+			# トップページを作成する
+			content_write(:index, '.html', output) { |template|
+				render_with_mustache template, :markdown
+			}
+
+			suffix = options[:suffix]
+			suffix = '/index.html' if ['', '/'].member?(suffix)
+
+			# コンテンツのレンダリングを行う
+			@templates.each { |path|
+				callback.call(path) if callback
+
+				content_write(path, suffix, output) { |template|
+					render_content(template)
+				}
+			}
+
+			# テーマの公開ファイルをコピー
+			copy_public(@themes, output, &callback)
+
+			# 静的ファイルをコピーする
+			copy_statics(@root, output, &callback)
+		end
+
+		# ディレクトリを初期化する
+		def dir_init(dir)
+			if Dir.exists?(dir)
+				Dir.glob(File.join(dir, '*'), File::FNM_DOTMATCH) { |path|
+					next if /(^|\/)(\.|\.\.)$/ =~ path
+
+					FileUtils.remove_entry_secure(path)
+				}
+			else
+				FileUtils.mkpath(dir)
+			end
+		end
+
+		# テーマから公開用のファイルを収集する
+		def public_files
+			unless @public_files
+				@public_files = Set.new
+
+				@public.each { |path_info|
+					if path_info[-1] == '/'
+						@themes.each { |theme|
+							if Dir.exists?(File.join(theme, path_info))
+								Dir.chdir(theme) { |dir|
+									@public_files += Dir.glob(File.join(path_info, '**/*'))
+								}
+							end
+						}
+					else
+						@public_files << path_info
+					end
+				}
+			end
+
+			@public_files
+		end
+
+		# コンテンツをファイルに出力する
+		def content_write(template, suffix, output)
+			begin
+				content = yield(template)
+				return unless content
+
+				path = template
+				path = path.sub(/\.[^.]*$/, '') if path.kind_of?(String)
+
+				to = path.to_s + suffix
+				to = File.join(output, to)
+
+				FileUtils.mkpath(File.dirname(to))
+				File.write(to, content)
+			rescue
+			end
+		end
+
+		# ファイルをコピーする
+		def copy_file(path, output, &callback)
+			return if File.directory?(path)
+			return if @templates.include?(path)
+
+			callback.call(path) if callback
+
+			if output.kind_of?(Array)
+				to = File.join(*output)
+			else
+				to = File.join(output, path)
+			end
+
+			FileUtils.mkpath(File.dirname(to))
+			FileUtils.copy_entry(path, to)
+		end
+
+		# 静的ファイルをコピーする
+		def copy_statics(dir, output, &callback)
+			Dir.chdir(dir) { |dir|
+				Dir.glob('**/*') { |path|
+					copy_file(path, output, &callback)
+				}
+			}
+		end
+
+		# テーマの公開ファイルをコピーする
+		def copy_public(views, output, &callback)
+			public_files.each { |path_info|
+				callback.call(path_info) if callback
+
+				ext = split_extname(path_info)[1]
+
+				if css_exts.include?(ext)
+					content_write(path_info, '.css', output) { |template|
+						content = render_css(template)
+					}
+				else
+					fullpath = file_search(path_info, {views: views}, nil)
+					copy_file(fullpath, [output, path_info]) if fullpath
+				end
+			}
+		end
+
+		#### テンプレート
+
+		# インデックスを作成
+		template :index do
+			begin
+				render :markdown, 'index.md', {views: @themes}
+			rescue
+				''
+			end
+		end
+
+		# メニューを作成
+		template :menu do
+			@contents.generate(StringIO.new).string
+		end
+
+	end
+end

data/lib/memorack/cli.rb

@@ -28,6 +28,7 @@ module MemoRack
 						Usage: #{opts.program_name} create [options] PATH
 						       #{opts.program_name} theme  [options] [THEME]
 						       #{opts.program_name} server [options] PATH
+						       #{opts.program_name} build  [options] [PATH]
 					BANNER
 
 					opts.separator ""
@@ -174,6 +175,38 @@ module MemoRack
 			abort opts.help if argv.empty?
 		}
 
+		# 静的サイトのビルド
+		define_options(:build, '[options] [PATH]') { |opts, argv, options|
+			default_options = {
+					output:	'_site',
+					theme:	'custom',
+					url:	'',
+
+					local:		false,
+					prettify:	false,
+				}
+
+			options.merge!(default_options)
+
+			opts.separator ""
+			opts.on("-o", "--output DIRECTORY", String,
+				t(:output, options)) { |arg| options[:output] = arg }
+			opts.on("-t", "--theme THEME", String,
+				t(:theme, options)) { |arg| options[:theme] = arg }
+			opts.on("--url URL", String,
+				t(:url, options)) { |arg| options[:url] = arg }
+			opts.on("--local",
+				t(:local)) { options[:local] = true }
+			opts.on("--prettify",
+				t(:prettify)) { options[:prettify] = true }
+			opts.on("-h", "--help", t(:help)) { abort opts.help }
+
+			opts.parse!(argv)
+
+			options[:url] = 'file://' + File.expand_path(options[:output]) if options[:local]
+			options[:suffix] = '' if options[:prettify]
+		}
+
 
 		# サブコマンド
 
@@ -259,5 +292,25 @@ module MemoRack
 			server_options[:app] = app
 			Rack::Server.new(server_options).start
 		end
+
+		# 静的サイトのビルド
+		def memorack_build(options, *argv)
+			path = argv.shift
+			path = 'content/' unless path
+			abort "Directory not exists '#{path}'" unless File.exists?(path)
+
+			require 'memorack/builder'
+			require 'tmpdir'
+
+			Dir.mktmpdir do |tmpdir|
+				site = {}
+				site[:url] = File.join(options[:url], '').gsub(/\/$/, '') if options[:url]
+
+				builder = MemoRack::Builder.new(theme: options[:theme], root: path, tmpdir: tmpdir, site: site)
+				builder.generate(options)
+			end
+
+			puts "Build '#{path}' -> '#{options[:output]}'"
+		end
 	end
 end

data/lib/memorack/core.rb

@@ -0,0 +1,369 @@
+# -*- encoding: utf-8 -*-
+
+require 'pathname'
+require 'rubygems'
+
+require 'memorack/tilt-mustache'
+require 'memorack/locals'
+require 'memorack/mdmenu'
+
+module MemoRack
+	class Core
+		attr_reader :themes, :options_chain
+
+		DEFAULT_APP_OPTIONS = {
+			root:				'content/',
+			themes_folder:		'themes/',
+			tmpdir:				'tmp/',
+			theme:				'basic',
+			markdown:			'redcarpet',
+			formats:			['markdown'],
+			css:				nil,
+			suffix:				'',
+			public:				[],
+			site:				{},
+			requires:			[],
+			directory_watcher:	false
+		}
+
+		# テンプレートエンジンのオプション
+		DEFAULT_TEMPLATE_OPTIONS = {
+			tables:			true
+		}
+
+		# テンプレートで使用するローカル変数の初期値
+		DEFAULT_LOCALS = {
+			title:				'memo'
+		}
+
+		DEFAULT_OPTIONS = DEFAULT_APP_OPTIONS.merge(DEFAULT_TEMPLATE_OPTIONS).merge(DEFAULT_LOCALS)
+
+		def initialize(options={})
+			options = DEFAULT_OPTIONS.merge(to_sym_keys(options))
+
+			@themes_folders = [options[:themes_folder], File.expand_path('../themes/', __FILE__)]
+			read_config(options[:theme], options)
+			read_config(DEFAULT_APP_OPTIONS[:theme], options) if @themes.empty?
+
+			@options = options
+
+			# DEFAULT_APP_OPTIONS に含まれるキーをすべてインスタンス変数に登録する
+			DEFAULT_APP_OPTIONS.each { |key, item|
+				instance_variable_set("@#{key}".to_sym, options[key])
+
+				# @options からテンプレートで使わないものを削除
+				@options.delete(key)
+			}
+
+			@requires.each { |lib| require lib }
+			@locals = default_locals(@options)
+
+			use_engine(@markdown)
+		end
+
+		# テーマのパスを取得する
+		def theme_path(theme)
+			return nil unless theme
+
+			@themes_folders.each { |folder|
+				path = theme && File.join(folder, theme)
+				return path if File.exists?(path) && FileTest::directory?(path)
+			}
+
+			nil
+		end
+
+		# デフォルトの 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.define_key(:__menu__) { |hash, key|
+				@menu = nil unless @directory_watcher	# ファイル監視していない場合はメニューを初期化
+				@menu ||= render :markdown, :menu, @options
+			}
+
+			locals
+		end
+
+		# 設定ファイルを読込む
+		def read_config(theme, options = {})
+			@themes ||= []
+			@options_chain = []
+			@theme_chain = []
+
+			begin
+				require 'json'
+
+				while theme
+					dir = theme_path(theme)
+					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]
+				end
+			rescue
+			end
+
+			# オプションをマージ
+			@options_chain.reverse.each { |opts| options.merge!(opts) }
+			options
+		end
+
+		# テンプレートエンジンを使用できるようにする
+		def use_engine(engine)
+			require engine if engine
+
+			# Tilt で Redcarpet 2.x を使うためのおまじない
+			Object.send(:remove_const, :RedcarpetCompat) if defined?(RedcarpetCompat) == 'constant'
+		end
+
+		# css の拡張子リストを作成する
+		def css_exts
+			@css_exts ||= Set.new ['css', *@css]
+		end
+
+		# ファイルを探す
+		def file_search(template, options = {}, exts = enable_exts)
+			options = {views: @root}.merge(options)
+
+			if options[:views].kind_of?(Array)
+				err = nil
+
+				options[:views].each { |views|
+					options[:views] = views
+
+					begin
+						path = file_search(template, options, exts)
+						return path if path
+					rescue Errno::ENOENT => e
+						err = e
+					end
+				}
+
+				raise err if err
+				return nil
+			end
+
+			if exts
+				exts.each { |ext|
+					path = File.join(options[:views], "#{template}.#{ext}")
+					return path if File.exists?(path)
+				}
+			else
+				path = File.join(options[:views], template)
+				return path if File.exists?(path)
+			end
+
+			return nil
+		end
+
+		# テンプレートエンジンで render する
+		def render(engine, template, options = {}, locals = {})
+			options = {views: @root}.merge(options)
+
+			if template.kind_of?(Pathname)
+				path = template
+			elsif options[:views].kind_of?(Array)
+				err = nil
+
+				options[:views].each { |views|
+					options[:views] = views
+
+					begin
+						return render(engine, template, options, locals)
+					rescue Errno::ENOENT => e
+						err = e
+					end
+				}
+
+				raise err
+			else
+				fname = template.kind_of?(String) ? template : "#{template}.#{engine}"
+				path = File.join(options[:views], fname)
+			end
+
+			engine = Tilt.new(File.join(File.dirname(path), ".#{engine}"), options) {
+				method = MemoApp.template_method(template)
+
+				if method && respond_to?(method)
+					data = send(method)
+				else
+					data = File.binread(path)
+					data.force_encoding('UTF-8')
+				end
+
+				data
+			}
+			engine.render(options, locals).force_encoding('UTF-8')
+		end
+
+		# レイアウトに mustache を適用してテンプレートエンジンでレンダリングする
+		def render_with_mustache(template, engine = :markdown, options = {}, locals = {})
+			begin
+				mustache_templ = options[:mustache] || 'index.html'
+
+				options = @options.merge(options)
+				locals = @locals.merge(locals)
+
+				locals.define_key(:__content__) { |hash, key|
+					if engine
+						render engine, template, options
+					else
+						template
+					end
+				}
+
+				locals[:content] = true unless template == :index
+				locals[:page] = page = Locals[locals[:page] || {}]
+
+				page.define_key(:name) { |hash, key|
+					unless 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
+
+					page_title
+				}
+
+				render :mustache, mustache_templ, {views: @themes}, locals
+			rescue => e
+				e.to_s
+			end
+		end
+
+		# コンテンツをレンダリングする
+		def render_content(path_info, locals = {})
+			path, ext = split_extname(path_info)
+
+			if @suffix == ''
+				fullpath = file_search(path_info, @options)
+
+				if fullpath
+					path = path_info
+					ext = split_extname(fullpath)[1]
+				end
+			end
+
+			return nil unless ext && Tilt.registered?(ext)
+
+			template = fullpath ? Pathname.new(fullpath) : path.to_sym
+			content = render_with_mustache template, ext, {}, locals
+		end
+
+		# CSSをレンダリングする
+		def render_css(path_info, locals = {})
+			return unless @css
+
+			path, = split_extname(path_info)
+			options = {views: @themes}
+
+			fullpath = file_search(path, options, css_exts)
+			return nil unless fullpath
+
+			ext = split_extname(fullpath)[1]
+
+			case ext
+			when 'css'
+				return File.binread(fullpath)
+			when 'scss', 'sass'
+				options[:cache_location] = File.expand_path('sass-cache', @tmpdir)
+			end
+
+			render ext, Pathname.new(fullpath), options, locals
+		end
+
+		# 拡張子を取出す
+		def split_extname(path)
+			return [$1, $2] if /^(.+)\.([^.]+)/ =~ path
+
+			[path]
+		end
+
+		# キーをシンボルに変換する
+		def to_sym_keys(hash)
+			hash.inject({}) { |memo, entry|
+				key, value = entry
+				value = to_sym_keys(value) if value.kind_of?(Hash)
+
+				memo[key.to_sym] = value
+
+				memo
+			}
+		end
+
+		# Tilt に登録されている拡張子を集める
+		def extnames(extname)
+			klass = Tilt[extname]
+			Tilt.mappings.select { |key, value| value.member?(klass) }.collect { |key, value| key }
+		end
+
+		# 対応フォーマットを取得する
+		def collect_formats
+			unless @collect_formats
+				@collect_formats = {}
+
+				@formats.each { |item|
+					if item.kind_of?(Array)
+						@collect_formats[item.first] = item
+					elsif item.kind_of?(Hash)
+						@collect_formats.merge!(item)
+					else
+						@collect_formats[item] = extnames(item)
+					end
+				}
+			end
+
+			@collect_formats
+		end
+
+		# 対応している拡張子
+		def enable_exts
+			@enable_exts ||= collect_formats.values.flatten
+		end
+
+		# コンテンツファイルの収集する
+		def contents(options = {})
+			default_options = {prefix: '/', suffix: @suffix, uri_escape: true, formats: collect_formats}
+			options = default_options.merge(options)
+
+			mdmenu = MdMenu.new(options)
+			Dir.chdir(@root) { |path| mdmenu.collection('.') }
+			mdmenu
+		end
+
+		# テンプレート名
+		def self.template_method(name)
+			name.kind_of?(Symbol) && "template_#{name}".to_sym
+		end
+
+		# テンプレートを作成する
+		def self.template(name, &block)
+			define_method(self.template_method(name), &block)
+		end
+
+	end
+end