RubyGems - marsdawn - Versions diffs - 0.0.1 - Mend

marsdawn 0.0.1

Files changed (71) hide show

checksums.yaml +15 -0
data/.coveralls.yml +2 -0
data/.gitignore +20 -0
data/.travis.yml +7 -0
data/Gemfile +8 -0
data/LICENSE.txt +22 -0
data/README.md +119 -0
data/Rakefile +12 -0
data/bin/marsdawn +6 -0
data/lib/marsdawn/builder.rb +35 -0
data/lib/marsdawn/command.rb +154 -0
data/lib/marsdawn/config.rb +31 -0
data/lib/marsdawn/search/rroonga.rb +83 -0
data/lib/marsdawn/search.rb +16 -0
data/lib/marsdawn/site/breadcrumb.rb +30 -0
data/lib/marsdawn/site/indexer.rb +78 -0
data/lib/marsdawn/site/link.rb +28 -0
data/lib/marsdawn/site/page.rb +118 -0
data/lib/marsdawn/site/page_nav.rb +24 -0
data/lib/marsdawn/site/search_box.rb +27 -0
data/lib/marsdawn/site/search_page.rb +35 -0
data/lib/marsdawn/site.rb +70 -0
data/lib/marsdawn/source/document.rb +36 -0
data/lib/marsdawn/source/front_matter.rb +25 -0
data/lib/marsdawn/source/kramdown/parser.rb +56 -0
data/lib/marsdawn/source.rb +164 -0
data/lib/marsdawn/storage/active_record/marsdawn.rb +20 -0
data/lib/marsdawn/storage/active_record.rb +83 -0
data/lib/marsdawn/storage/base.rb +44 -0
data/lib/marsdawn/storage/file_system.rb +83 -0
data/lib/marsdawn/storage/redis.rb +0 -0
data/lib/marsdawn/storage/test.rb +20 -0
data/lib/marsdawn/storage/test_not_implemented_error.rb +6 -0
data/lib/marsdawn/storage.rb +22 -0
data/lib/marsdawn/util.rb +39 -0
data/lib/marsdawn/version.rb +3 -0
data/lib/marsdawn.rake +9 -0
data/lib/marsdawn.rb +55 -0
data/marsdawn.gemspec +25 -0
data/spec/_compiled_doc/.gitkeep +0 -0
data/spec/_test_doc/config.yml +10 -0
data/spec/_test_doc/docs01/.index.md +1 -0
data/spec/_test_doc/docs01/.marsdawn.yml +4 -0
data/spec/_test_doc/docs01/010_about.md +4 -0
data/spec/_test_doc/docs01/020_tutorial/.index.md +0 -0
data/spec/_test_doc/docs01/020_tutorial/010_install.md +6 -0
data/spec/_test_doc/docs01/020_tutorial/020_getting_start.md +9 -0
data/spec/_test_doc/docs01/030_reference/1up.md +0 -0
data/spec/_test_doc/docs01/030_reference/each.md +0 -0
data/spec/_test_doc/docs01/030_reference/z-index.md +0 -0
data/spec/_test_doc/docs01/040_appendix.md +3 -0
data/spec/_test_doc/no_config/.gitkeep +0 -0
data/spec/_test_doc/no_key/.marsdawn.yml +3 -0
data/spec/_test_doc/samples/010_sample-document.md +4 -0
data/spec/_test_doc/samples/test_document.md +1 -0
data/spec/_tmp/.gitkeep +0 -0
data/spec/lib/marsdawn/command_spec.rb +144 -0
data/spec/lib/marsdawn/config_spec.rb +41 -0
data/spec/lib/marsdawn/site/page_spec.rb +122 -0
data/spec/lib/marsdawn/site_spec.rb +67 -0
data/spec/lib/marsdawn/source/document_spec.rb +178 -0
data/spec/lib/marsdawn/source/front_matter_spec.rb +55 -0
data/spec/lib/marsdawn/source_spec.rb +40 -0
data/spec/lib/marsdawn/storage/active_record_spec.rb +47 -0
data/spec/lib/marsdawn/storage/file_system_spec.rb +46 -0
data/spec/lib/marsdawn/storage_spec.rb +29 -0
data/spec/lib/marsdawn/util_spec.rb +57 -0
data/spec/spec_helper.rb +12 -0
data/spec/stubs/groonga.rb +17 -0
data/spec/stubs/marsdawn_docs.rb +40 -0
metadata +203 -0

data/lib/marsdawn/site/page.rb ADDED Viewed

@@ -0,0 +1,118 @@
+# encoding: utf-8
+require 'marsdawn/site/breadcrumb'
+require 'marsdawn/site/page_nav'
+require 'marsdawn/site/search_box'
+class Marsdawn::Site
+  class Page
+    attr_reader :site, :uri, :title, :content, :type, :level, :sysinfo
+    def initialize doc_info, page, site
+      @doc_info = doc_info
+      @site = site
+      front_matter = page[:front_matter]
+      @sysinfo = page[:sysinfo]
+      @uri = @sysinfo[:uri]
+      @title = front_matter[:title]
+      @content = page[:content]
+      @type = @sysinfo[:type]
+      @level = @sysinfo[:level]
+      @search_word = ''
+    end
+    def breadcrumb
+      @breadcrumb ||= Marsdawn::Site::Breadcrumb.new(@site, @sysinfo[:breadcrumb])
+    end
+    def neighbor
+      @neighbor ||= @site.index.neighbor(@uri)
+    end
+    def top
+      @site.top
+    end
+    def parent
+      @parent ||= Marsdawn::Site::Link.new(@site, @sysinfo[:parent]) unless @sysinfo[:parent].nil?
+    end
+    def under
+      @under ||= @site.index.under(@uri)
+    end
+    def page_nav
+      @page_nav ||= Marsdawn::Site::PageNav.new(@site, @sysinfo[:prev_page], @sysinfo[:next_page])
+    end
+    def link
+      @link ||= Marsdawn::Site::Link.new(@site, @uri, @title)
+    end
+    def search_box
+      @search_box ||= Marsdawn::Site::SearchBox.new(@site, @search_word)
+    end
+    def to_s
+      to_html
+    end
+    def to_html options={}
+      <<-"EOS"
+      <div class="main-container">
+      <div class="container">
+        <div class="row">
+          <div class="col-lg-3 sidebar">
+            <nav>#{neighbor}</nav>
+          </div>
+          <div class="col-lg-9 content">
+            <p>contents</p>
+          </div>
+        </div>
+      </div>
+      </div>
+      EOS
+    end
+    def to_page_html options={}
+      opts = {
+        css: ['http://dev.screw-axis.com/marsdawn/style.css'],
+        js: [],
+        title: CGI.escapeHTML(@title),
+        title_suffix: " | #{CGI.escapeHTML(@site.title)}",
+        lang: @doc_info[:lang],
+        charset: @doc_info[:encoding]
+      }.merge(options)
+      css_html = opts[:css].map{|file| %!<link rel="stylesheet" href="#{file}" type="text/css" />!}.join("\n")
+      js_html = opts[:js].map{|file| %!<script src="#{file}"></script>!}.join("\n")
+      %|<!DOCTYPE html>
+      <html lang="#{opts[:lang]}">
+      <head>
+        <meta charset="#{opts[:encoding]}" />
+        <title>#{opts[:title]}#{opts[:title_suffix]}</title>
+        #{css_html}
+        #{js_html}
+      </head>
+      <body>
+        <div id="container">
+          <div id="site-header"><h1 id="site-title">#{@site.title_link}</h1></div>
+          <div id="side-menu">
+            #{search_box}
+            <nav>#{neighbor}</nav>
+          </div>
+          <div id="site-body">
+            <div id="main-content">
+              <div id="breadcrumb"><nav>#{breadcrumb}</nav></div>
+              <div id="page-content">#{@content}</div>
+              <div id="under-index">#{under}</div>
+              <div id="page-nav">#{page_nav}</div>
+            </div>
+            <div class="clear"></div>
+          </div>
+        </div>
+      </body>
+      </html>|
+    end
+  end
+end

data/lib/marsdawn/site/page_nav.rb ADDED Viewed

@@ -0,0 +1,24 @@
+# encoding: utf-8
+class Marsdawn::Site
+  class PageNav < Hash
+    def initialize site, prev_page, next_page
+      @site = site
+      self[:prev_page] = @site.index[prev_page] unless prev_page.nil?
+      self[:next_page] = @site.index[next_page] unless next_page.nil?
+    end
+    def to_s
+      to_html
+    end
+    def to_html
+      %!<ul>
+      <li id="nav-prev-page">#{self[:prev_page]}</li>
+      <li id="nav-next-page">#{self[:next_page]}</li>
+      </ul>!
+    end
+  end
+end

data/lib/marsdawn/site/search_box.rb ADDED Viewed

@@ -0,0 +1,27 @@
+# encoding: utf-8
+class Marsdawn::Site
+  class SearchBox
+    def initialize site, word
+      @site = site
+      @word = word
+    end
+    def to_s
+      to_html
+    end
+    def to_html
+      if @site.searchable?
+        %|<div id="search-box">
+          <form action="#{@site.search_path}" method="get">
+            <input type="search" name="search" value="#{Marsdawn::Util.html_escape(@word)}" />
+          </form>
+        </div>|
+      end
+    end
+  end
+end

data/lib/marsdawn/site/search_page.rb ADDED Viewed

@@ -0,0 +1,35 @@
+# encoding: utf-8
+class Marsdawn::Site
+  class SearchPage < Page
+    def initialize doc_info, site, search_word, search_results
+      @word = search_word
+      @results = search_results
+      exvars = {title: 'Search Results'}
+      sysinfo = {
+        uri: site.search_path,
+        breadcrumb: [],
+        prev_page: nil,
+        next_page: nil
+      }
+      page = {
+        content: content,
+        exvars: exvars,
+        sysinfo: sysinfo
+      }
+      super doc_info, page, site
+      @search_word = search_word
+    end
+    def content
+      ret = %!<h1>Search Results for '#{Marsdawn::Util.html_escape(@word)}'</h1>!
+      @content ||= @results.each_with_object ret do |res, ret|
+        ret << %!<h4><a href=".#{res[:uri]}">#{res[:title]}</a></h4>!
+        blocks = res[:results].join(' ... ')
+        ret << %!<div class="search-result">#{blocks}</div>!
+      end
+    end
+  end
+end

data/lib/marsdawn/site.rb ADDED Viewed

@@ -0,0 +1,70 @@
+# encoding: utf-8
+require 'marsdawn/site/page'
+require 'marsdawn/site/search_page'
+require 'marsdawn/site/link'
+require 'marsdawn/site/indexer'
+require 'cgi'
+class Marsdawn::Site
+  def initialize opts, config=nil
+    @key = opts[:key]
+    if block_given?
+      config = {}
+      yield config
+    elsif config.nil?
+      config = Marsdawn::Config.new.to_hash(@key)
+    end
+    @config = config
+    @storage = Marsdawn::Storage.get(@config[:storage], opts)
+    @doc_info = @storage.get_document_info
+    @opts = opts
+    @base_path = (opts.key?(:base_path) ? opts[:base_path] : '')
+  end
+  def top
+    @top ||= page('/')
+  end
+  def page uri
+    Marsdawn::Site::Page.new @doc_info, @storage.get(uri), self
+  end
+  def full_path uri
+    File.join @base_path, uri
+  end
+  def index
+    @index ||= Marsdawn::Site::Indexer.new(self, @doc_info[:site_index])
+  end
+  def page_title uri
+    @doc_info[:site_index][uri] if @doc_info[:site_index].key?(uri)
+  end
+  def title
+    @doc_info[:title]
+  end
+  def title_link
+    @title_link ||= Marsdawn::Site::Link.new(self, "#{@base_path}/", title)
+  end
+  def searchable?
+    @config.key?(:search)
+  end
+  def search_path
+    uri = @opts[:search_uri] || '/'
+    full_path uri
+  end
+  def search keyword, opts={}
+    raise "No search settings for this document." unless searchable?
+    se = Marsdawn::Search.get(@storage, @config[:search])
+    results = se.search(keyword, opts)
+    Marsdawn::Site::SearchPage.new @doc_info, self, keyword, results
+  end
+end

data/lib/marsdawn/source/document.rb ADDED Viewed

@@ -0,0 +1,36 @@
+# encoding: utf-8
+require 'kramdown'
+require 'marsdawn/source/front_matter'
+require 'marsdawn/source/kramdown/parser'
+class Marsdawn::Source
+  class Document < Kramdown::Document
+    attr_accessor :front_matter
+    def self.read path, title=nil, options={}
+      text = open(path).read
+      new(text, options).tap do |doc|
+        title = File.basename(path, '.*') if title.nil?
+        title = title.gsub(/^\d+_/, '').gsub(/_|-/, ' ').capitalize
+        doc.front_matter[:title] ||= title
+        doc.front_matter[:link_key] ||= title
+      end
+    end
+    def initialize text, options={}
+      doc = FrontMatter.new(text)
+      @front_matter = {}
+      options[:input] = 'Marsdawn'
+      super doc.content, options
+      @front_matter.merge! Kramdown::Parser::Marsdawn.front_matter
+      @front_matter.merge! doc.attr
+    end
+    def front_matter
+      @front_matter
+    end
+  end
+end

data/lib/marsdawn/source/front_matter.rb ADDED Viewed

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require 'yaml'
+module Marsdawn
+  class Source
+    class FrontMatter
+      attr_reader :attr, :content
+      def initialize text
+        m = text.match(/\A---*\n(?<attr>.*?)\n---*\n(?<content>.*)$/m)
+        if m.nil?
+          @attr = {}
+          @content = text
+        else
+          @attr = Marsdawn::Util.hash_symbolize_keys_deep(YAML.load(m[:attr]))
+          raise 'Invalid front-matter format.' unless @attr.kind_of?(Hash)
+          @content = m[:content]
+        end
+      end
+    end
+  end
+end

data/lib/marsdawn/source/kramdown/parser.rb ADDED Viewed

@@ -0,0 +1,56 @@
+# encoding: utf-8
+class Kramdown::Parser::Marsdawn < Kramdown::Parser::Kramdown
+  def self.front_matter
+    @@front_matter
+  end
+  def parse
+    @@front_matter = {}
+    super
+  end
+  def parse_setext_header
+    ret = super
+    handle_header @src[1], @src[3].to_i
+    ret
+  end
+  def parse_atx_header
+    ret = super
+    handle_header @src[2].to_s.strip, @src[1].length
+    ret
+  end
+  def handle_extension(name, opts, body, type)
+    case name
+    when 'front_matter'
+      opts.each do |key, val|
+        @@front_matter[key.to_sym] = val
+        @@front_matter[:link_key] = val if key == 'title'
+      end
+      true
+    else
+      super name, opts, body, type
+    end
+  end
+  private
+  def handle_header title, level
+    add_title_vars title
+    insert_title_anchor title if level < 4
+  end
+  def add_title_vars title
+    @@front_matter[:title] = title unless @@front_matter.key?(:title)
+    @@front_matter[:link_key] = title unless @@front_matter.key?(:link_key)
+  end
+  def insert_title_anchor title
+    anchor_name = title.downcase.gsub(' ', '-')
+    @tree.children.last.children.insert 0, Element.new(:raw, %!<a name="#{anchor_name}"></a>!, 'type' => 'html')
+    @@front_matter[:anchors] ||= {}
+    @@front_matter[:anchors][title] = anchor_name
+  end
+end

data/lib/marsdawn/source.rb ADDED Viewed

@@ -0,0 +1,164 @@
+# encoding: utf-8
+require 'yaml'
+require 'marsdawn/source/document'
+class Marsdawn::Source
+  attr_reader :doc_info, :local2uri
+  def initialize path
+    @path = File.expand_path(path)
+    raise "No source directory '#{@path}'." unless File.exists?(@path)
+    @doc_info = {
+      key: nil,
+      lang: 'en',
+      title: '',
+      version: '0.0.0',
+      markdown_extname: '.md',
+      directory_index: '.index.md',
+      encoding: 'utf-8',
+      link_defs: {},
+      kramdown_options: {}
+    }
+    load_doc_info
+    investigate
+  end
+  def each_contents options
+    @local2uri.each do |file, uri|
+      yield uri, markdown(file, uri, options), @front_matter[uri], @sysinfo[uri]
+    end
+  end
+  protected
+  def load_doc_info
+    doc_info_file = File.join(@path, '.marsdawn.yml')
+    raise "There is no doc_info file '.marsdawn.yml' in '#{@path}'" unless File.exists?(doc_info_file)
+    conf = Marsdawn::Util.hash_symbolize_keys(YAML.load_file(doc_info_file))
+    @doc_info.merge! conf
+    @doc_key = @doc_info[:key]
+    raise "The document key should be specified in .marsdawn.yml." if @doc_key.nil? || @doc_key.empty?
+  end
+  def investigate
+    @local2uri = {}
+    @front_matter = {}
+    @sysinfo = {}
+    digg @path
+    update_sysinfo
+    update_docinfo
+  end
+  def link_defs base_uri
+    ret = relative_link_defs_from_front_matter base_uri
+    base_path = Pathname(File.dirname(base_uri))
+    @doc_info[:link_defs].each do |key, link|
+      uri, title = link
+      if uri.start_with?('/')
+        rel_path = Pathname(uri).relative_path_from(base_path).to_s
+      else
+        rel_path = uri
+      end
+      ret[key] = [rel_path, title]
+    end
+    ret
+  end
+  def relative_link_defs_from_front_matter base_uri
+    base_path = Pathname(File.dirname(base_uri))
+    @front_matter.each_with_object({}) do |(uri, vars), defs|
+      if vars.key?(:link_key)
+        rel_path = Pathname(uri).relative_path_from(base_path).to_s
+        defs[vars[:link_key]] = [rel_path, vars[:title]]
+        if vars.key?(:anchors)
+          vars[:anchors].each do |title, anchor_name|
+            defs["#{vars[:link_key]} - #{title}"] = ["#{rel_path}\##{anchor_name}", title]
+            defs[title] = ["\##{anchor_name}", title] if base_uri == uri
+          end
+        end
+      end
+    end
+  end
+  def markdown file, uri, opts
+    opts[:link_defs] = link_defs(uri)
+    Document.read(file, @front_matter[uri][:title], opts).to_html
+  end
+  def digg path, uri=''
+    items = Dir.glob(File.join(path,'*')).map{|f| File.basename(f)}.sort
+    read_directory_index path, uri
+    items.each do |item|
+      fullpath = File.join(path, item)
+      uri_item = (item =~ /^\d+_(.*)/ ? $1 : item)
+      if File.directory?(fullpath)
+        digg fullpath, "#{uri}/#{uri_item}"
+      elsif uri_item != @doc_info[:directory_index]
+        set_page_info fullpath, uri, uri_item
+      end
+    end
+  end
+  def set_page_info fullpath, uri, uri_item
+    extname = File.extname(uri_item)
+    if extname == @doc_info[:markdown_extname]
+      uri_item = File.basename(uri_item, extname)
+      fulluri = "#{uri}/#{uri_item}"
+      @local2uri[fullpath] = fulluri
+      @front_matter[fulluri] = read_front_matter(fullpath, uri_item)
+      @sysinfo[fulluri] = {:type => 'folder'}
+    end
+  end
+  def read_directory_index path, uri
+    indexfile = File.join(path, @doc_info[:directory_index])
+    if File.exists?(indexfile)
+      uri = (uri == '' ? '/' : uri)
+      @local2uri[indexfile] = uri
+      @front_matter[uri] = read_front_matter(indexfile, File.basename(uri))
+      @sysinfo[uri] = {:type => 'page'}
+    end
+  end
+  def read_front_matter file, name
+    doc = Document.read(file, name, @doc_info[:kramdown_options])
+    doc.front_matter
+  end
+  def update_sysinfo
+    prev_page = nil
+    @sysinfo.each do |uri, info|
+      @sysinfo[uri][:uri] = uri
+      @sysinfo[uri][:level] = uri.count('/')
+      @sysinfo[uri][:breadcrumb] = create_breadcrumb(uri)
+      @sysinfo[uri][:parent] = @sysinfo[uri][:breadcrumb].last
+      @sysinfo[uri][:prev_page] = nil
+      @sysinfo[uri][:next_page] = nil
+      unless prev_page.nil?
+        @sysinfo[uri][:prev_page] = prev_page
+        @sysinfo[prev_page][:next_page] = uri
+      end
+      prev_page = uri
+    end
+  end
+  def update_docinfo
+    @doc_info[:site_index] = create_site_index
+  end
+  def create_breadcrumb uri
+    uri.split('/').each_with_object([]) do |dir, ret|
+      parent = (ret.last == '/' ? '' : ret.last)
+      path = "#{parent}/#{dir}"
+      ret << path unless uri == path
+    end
+  end
+  def create_site_index
+    @front_matter.each_with_object({}) do |(uri, vars), ret|
+      ret[uri] = vars[:title]
+    end
+  end
+end

data/lib/marsdawn/storage/active_record/marsdawn.rb ADDED Viewed

@@ -0,0 +1,20 @@
+# encoding: utf-8
+class Marsdawn::Storage::ActiveRecord::Marsdawn < ActiveRecord::Base
+  self.table_name = 'marsdawn'
+  attr_accessor :doc, :lang, :version, :uri, :data
+  def self.create_unless_exists
+    unless ActiveRecord::Base.connection.table_exists? self.table_name
+      ActiveRecord::Migration.create_table :marsdawn do |t|
+        t.string :doc, :null => false
+        t.string :lang, :null => false
+        t.string :version, :null => false
+        t.string :uri, :null => false
+        t.text   :data
+      end
+      ActiveRecord::Migration.add_index :marsdawn, [:doc, :lang, :version, :uri], :unique => true
+    end
+  end
+end

data/lib/marsdawn/storage/active_record.rb ADDED Viewed

@@ -0,0 +1,83 @@
+# encoding: utf-8
+require 'marsdawn/storage/base'
+require 'json'
+require 'zlib'
+class Marsdawn::Storage::ActiveRecord < Marsdawn::Storage::Base
+  def initialize config, opts={}
+    unless Module.const_defined?('ActiveRecord')
+      raise "Gem 'active_record' should be installed to use ActiveRecord storage for MarsDawn." unless require 'active_record'
+    end
+    #require 'marsdawn/storage/active_record/marsdawn'
+    @opts = {
+      key: '-',
+      lang: 'en',
+      version: '0.0.1'
+    }.merge(opts)
+  end
+  def prepare
+    #Marsdawn.create_unless_exists
+    @stack = {}
+  end
+  def finalize
+    MarsdawnDocs.transaction do
+      MarsdawnDocs.where(selector).each do |page|
+        MarsdawnDocs.delete_all(selector(uri: page.uri)) unless @stack.key?(page.uri)
+      end
+      @stack.each do |uri, data|
+        rec = MarsdawnDocs.where(selector(uri: uri))
+        if rec.size > 0
+          rec.first.update_attributes! data: compress(data)
+        else
+          MarsdawnDocs.create selector(uri: uri, data: compress(data))
+        end
+      end
+    end
+  rescue => e
+    raise e
+  end
+  def clean_up
+    @stack = {}
+  end
+  def set_document_info doc_info
+    @stack['doc_info'] = doc_info
+  end
+  def set uri, content, front_matter, sysinfo
+    @stack[uri] = {content: content, front_matter: front_matter, sysinfo: sysinfo}
+  end
+  def get_document_info
+    Marsdawn::Util.hash_symbolize_keys(get_data('doc_info'))
+  end
+  def get uri
+    data = get_data(uri)
+    Marsdawn::Util.hash_symbolize_keys_deep(data) unless data.nil?
+  end
+  private
+  def compress data
+    Zlib::Deflate.deflate(JSON.generate(data))
+  end
+  def decompress data
+    JSON.parse(Zlib::Inflate.inflate(data))
+  end
+  def get_data uri
+    page = MarsdawnDocs.where(selector(uri: uri)).first
+    decompress(page.data) unless page.nil?
+  end
+  def selector additional={}
+    {key: @opts[:key], lang: @opts[:lang], version: @opts[:version]}.merge(additional)
+  end
+end