marsdawn 0.0.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NTI0YWM4Nzg0OWIxYTBiZmM3MjIyZjVjN2U0Yjg3N2FhY2YzZWMzYg==
+  data.tar.gz: !binary |-
+    NzAzOTEyZTkwNWNkZjQ2ZjQwMGExOTk1YzNmYTA2MGJlNTNhOTE2OQ==
+SHA512:
+  metadata.gz: !binary |-
+    MTJiMDlmODk3MGU5MmI1OTRmOWQ2NWE3MjA4YmUyODA5MDIzNGEzODU3OGU3
+    ZjE2Mzg5OTk1MDRjZTY0YWI4NTI2YTVlMDZhN2EzMmVjYzZlNmQ0OTZmYWVi
+    Nzg1YzEzMTc0YWMxYjBlZGY5ZjZiYmU0Y2U1YTRmNWFiMjA5ZDY=
+  data.tar.gz: !binary |-
+    OGE0YzBiYmFiYzY1NGEyMzAzOTc5ZjU1Mzg1Y2Y1ZjNjZDJmZjI2MGNhZTJi
+    OWJmOWVhZGQ4ODgwYjljNzc2ZmUzYWZhZGNhZTM0OGVkOTE1MDU3NzhhYjAx
+    Y2FjNmI5MWUwYjNkMDE4OWRlMGVkNTczZGU5ODJiZTk0MDMxMDY=

data/.coveralls.yml

@@ -0,0 +1,2 @@
+service_name: travis-ci
+repo_token: rh7Ee5DRpsg5CVHPPCrj07cAUyIqsnWiI

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor
+spec/_compiled_doc/*/
+spec/_tmp/*/

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 1.9.3
+addons:
+  code_climate:
+    repo_token: 1ba540ca1a06382432295a8c6afa3d6ffccda11fa9b43a429db604545a5c3ee4 

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marsdawn.gemspec
+gemspec
+
+group :test do
+  gem 'coveralls', :require => false
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 TODO: Write your name
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,119 @@
+[![Build Status](https://travis-ci.org/nao58/marsdawn.svg?branch=master)](https://travis-ci.org/nao58/marsdawn)
+[![Coverage Status](https://coveralls.io/repos/nao58/marsdawn/badge.png?branch=master)](https://coveralls.io/r/nao58/marsdawn?branch=master)
+[![Code Climate](https://codeclimate.com/github/nao58/marsdawn.png)](https://codeclimate.com/github/nao58/marsdawn)
+
+# Marsdawn
+
+MarsDawn is simple static document builder and traverser. You can create your own document site easily using this gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'marsdawn'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marsdawn
+
+## Usage
+
+### Create your document source
+
+Use marsdawn command.
+
+~~~
+marsdawn create "My Document"
+~~~
+
+Then the document and files will be created like below.
+
+~~~
+└── my_document
+    ├── .marsdawn.yml
+    └── .index.md
+~~~
+
+The file `.marsdawn.yml` includes the information of whole document set. `.index.md` is the top page. You can edit the file to add your content.
+
+To create new page.
+
+~~~
+marsdawn page "About the document"
+~~~
+
+~~~
+└── my_document
+    ├── .marsdawn.yml
+    ├── .index.md
+    └── 010_about-the-document.md
+~~~
+
+To create new directory.
+
+~~~
+marsdawn dir "Tutorial"
+~~~
+
+~~~
+└── my_document
+    ├── .marsdawn.yml
+    ├── .index.md
+    ├── 010_about-the-document.md
+    └── 020_tutorial
+        └── .index.md
+~~~
+
+### Build the documents
+
+Setting config file is the easiest way to build the document.
+
+Create config file names "marsdawn.yml" under "config" directory of your framework.
+
+~~~config/marsdawn.yml
+your_document_key:
+  source: path/to/your/source/documents
+  storage:
+    path: path/to/build/directory
+~~~
+
+This time we will build the document onto the file system. You can choose RDBMS storage instead.
+
+Then simply hit the rake command.
+
+~~~
+rake marsdawn:build
+~~~
+
+### Traverse the documents
+
+Once you have built the document, you can traverse the document easily from your own site.
+
+This is a sample controller for Padrino.
+
+~~~ruby
+YourWeb::App.controllers :docs do
+
+  get :index, :map => '/docs/*path' do
+    docset = Marsdawn::Site.new(key: 'your_document_key', lang: 'en', version: '1.0.0', base_path: '/docs')
+    @page = docset.page("/#{params[:path].join('/')}")
+    @title = @page.title
+    render 'docs'
+  end
+
+end
+~~~
+
+Now you can create your templete for the document page.
+
+## Contributing
+
+1. Fork it ( http://github.com/nao58/marsdawn/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,12 @@
+require "bundler/gem_tasks"
+
+task :default => [:spec]
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec) do |spec|
+    spec.pattern = 'spec/**/*_spec.rb'
+    spec.rspec_opts = ['-cfd']
+  end
+rescue LoadError => e
+  p e
+end

data/bin/marsdawn

@@ -0,0 +1,6 @@
+#!/usr/bin/ruby
+
+require 'marsdawn/command'
+
+command = Marsdawn::Command.exec(ARGV)
+exec command unless command.nil?

data/lib/marsdawn/builder.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+require "marsdawn/source"
+
+class Marsdawn::Builder
+
+  def self.build config
+    raise "No specification for source path." unless config.key?(:source)
+    raise "No specification for storage config." unless config.key?(:storage)
+    source = Marsdawn::Source.new(config[:source])
+    storage = Marsdawn::Storage.get(config[:storage], source.doc_info)
+    build_source source, storage, config[:build_options]
+    create_search_index storage, config[:search] if config.key?(:search)
+  end
+
+  def self.build_source source, storage, options
+    options ||= {}
+    kramdown_options = options[:kramdown] || {}
+    storage.prepare
+    storage.set_document_info source.doc_info
+    source.each_contents(kramdown_options) do |uri, content, front_matter, sysinfo|
+      storage.set uri, content, front_matter, sysinfo
+    end
+    storage.finalize
+  rescue => ex
+    storage.clean_up
+    raise ex
+  end
+
+  def self.create_search_index storage, options
+    options ||= {}
+    Marsdawn::Search.create_index storage, options
+  end
+
+end

data/lib/marsdawn/command.rb

@@ -0,0 +1,154 @@
+# encoding: utf-8
+
+require 'yaml'
+
+module Marsdawn
+  class Command
+    attr_accessor :editor, :auto_editor
+
+    class ParamError < Exception; end
+    class RuntimeError < Exception; end
+
+    def self.exec argv
+      raise ParamError.new("No command is specified.") if argv.empty?
+      cmd = new
+      command = argv.shift.to_sym
+      raise ParamError.new("Unknown command '#{command}'.") unless cmd.respond_to?(command)
+      value = (argv.size > 0 ? argv.shift : nil)
+      opts = parse_options(argv)
+      cmd.__send__ command, value, opts
+    end
+
+    def initialize
+      @editor = 'vim'
+      @auto_editor = true
+      read_dot_marsdawn
+    end
+
+    def create title, opts={}
+      key = (opts.key?(:file) ? opts[:file] : file_namize(title))
+      path = File.expand_path(key)
+      raise "The directory '#{doc_name}' already exists." if File.exists?(path)
+      Dir.mkdir path
+      data = {key: key, title: title, lang: 'en', version: '0.0.1'}
+      dot_file = File.join(path, '.marsdawn.yml')
+      index_file = File.join(path, '.index.md')
+      File.write dot_file, YAML.dump(data)
+      create_page index_file, title, 'title' => title
+      edit_cmd dot_file, index_file if @auto_editor || opts[:edit]
+    end
+
+    def dir title, opts={}
+      dir = (opts.key?(:file) ? opts[:file] : file_namize(title))
+      dir = add_num(dir, opts)
+      path = File.expand_path(dir)
+      Dir.mkdir path
+      index_file = File.join(path, '.index.md')
+      create_page index_file, title, 'title' => title
+      edit_cmd index_file if @auto_editor || opts[:edit]
+    end
+
+    def page title, opts={}
+      file = (opts.key?(:file) ? "#{opts[:file]}.md" : file_namize(title, '.md'))
+      file = File.expand_path(add_num(file, opts))
+      create_page file, title, 'title' => title
+      edit_cmd file if @auto_editor || opts[:edit]
+    end
+
+    def renum step, opts={}
+      step = (step.nil? ? 10 : step.to_i)
+      num = 0
+      list = Dir.glob('*').sort.each_with_object({}) do |item, ret|
+        num += step
+        ret[item] = add_num(item, num: num, step: step)
+      end
+      list.each do |src, dest|
+        FileUtils.mv src, dest unless src == dest
+      end
+      'ls -1'
+    end
+
+    def debug type, opts={} 
+      case type
+      when 'options'
+        opts
+      end
+    end
+
+    private
+    def self.parse_options argv
+      opts = {}
+      while argv.size > 0 do
+        key = opt_key(argv.shift)
+        val = true
+        val = argv.shift if argv.size > 0 && !argv.first.start_with?('-')
+        opts[key] = val
+      end
+      opts
+    end
+
+    def self.opt_key switch
+      opt_keys = {
+        'e' => 'edit',
+        'f' => 'file',
+        'n' => 'num',
+        'o' => 'no-num',
+        's' => 'step'
+      }
+      key = switch
+      if key =~ /^--(.+)$/
+        key = $1
+      elsif key =~ /^-(.+)$/
+        key = opt_keys[$1]
+      end
+      raise ParamError.new("Unknown option '#{switch}'.") unless opt_keys.values.include?(key)
+      key.to_sym
+    end
+
+    def read_dot_marsdawn
+      dotfile = File.expand_path("#{ENV['HOME']}/.marsdawn")
+      instance_eval(open(dotfile).read) if File.exists?(dotfile)
+    end
+
+    def file_namize title, ext=''
+      "#{title.downcase.gsub(' ', '-')}#{ext}"
+    end
+
+    def create_page path, title, front_matter={}
+      File.write(path, "#{YAML.dump(front_matter)}---\n\n# #{title}\n\n")
+    end
+
+    def file_num file
+      file =~ /^(\d+)_(.+)$/ ? $1.to_i : 0
+    end
+
+    def file_name file
+      file =~ /^(\d+)_(.+)$/ ? $2 : file
+    end
+
+
+    def step opts
+      opts.key?(:step) ? opts[:step] : 10
+    end
+
+    def add_num file, opts
+      if opts.key?(:num)
+        num = opts[:num]
+        num = max_num + step(opts) if num.is_a?(TrueClass)
+        num = "000#{num}".slice(-3, 3)
+        file = "#{num}_#{file_name(file)}"
+      end
+      file
+    end
+
+    def max_num
+      list = Dir.glob('*')
+      list.size > 0 ? list.map{|item| file_num(item)}.max : 0
+    end
+
+    def edit_cmd *args
+      "#{@editor} #{args.join(" ")}"
+    end
+
+  end
+end

data/lib/marsdawn/config.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+class Marsdawn::Config
+
+  def initialize file='./config/marsdawn.yml'
+    file = File.absolute_path(file)
+    raise "Cannot find a config file for marsdawn." unless File.exists?(file)
+    @config = YAML.load_file(file)
+  end
+
+  def get key, entry, default=nil
+    conf = to_hash(key)
+    conf[entry] = default if !default.nil? && !conf.key?(entry)
+    raise "No entry '#{entry}' in the setting file of marsdawn." unless conf.key?(entry)
+    ret = conf[entry]
+    ret = Marsdawn::Util.hash_symbolize_keys(ret) if ret.kind_of?(Hash)
+    ret
+  end
+
+  def to_hash key
+    raise "Cannot find the configuration for '#{key}' in marsdawn.yml." unless @config.key?(key)
+    Marsdawn::Util.hash_symbolize_keys(@config[key])
+  end
+
+  def each
+    @config.keys.each do |key|
+      yield key, to_hash(key)
+    end
+  end
+
+end

data/lib/marsdawn/search/rroonga.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+class Marsdawn::Search::Rroonga
+
+  def initialize opts, storage
+    unless Module.const_defined?('Groonga')
+      raise "Gem 'rroonga' should be installed." unless require 'groonga'
+    end
+    raise "The groonga database path should be specified" unless opts.key?(:path)
+    @opts = {
+      index_table: {}
+    }.merge(opts)
+    @storage = storage
+    Groonga::Database.open(opts[:path])
+    @table_prefix = "#{@storage.key}-#{@storage.lang}-#{@storage.version.tr('.','_')}"
+  end
+
+  def create_tables
+    index_table = {
+      :type => :patricia_trie,
+      :normalizer => :NormalizerAuto,
+      :default_tokenizer => 'TokenBigram'
+    }.merge(@opts[:index_table])
+    Groonga::Schema.create_table(table_name('documents'), :type => :hash) do |tbl|
+      tbl.text('title')
+      tbl.text('content')
+    end
+    Groonga::Schema.create_table(table_name('terms'), index_table) do |tbl|
+      tbl.index(col_name('documents', 'title'))
+      tbl.index(col_name('documents', 'content'))
+    end
+  end
+
+  def drop_tables
+    Groonga::Schema.remove_table(table_name('documents'))
+    Groonga::Schema.remove_table(table_name('terms'))
+  rescue Groonga::Schema::TableNotExists
+  end
+
+  def create_index
+    drop_tables
+    create_tables
+    docs = table('documents')
+    index = @storage.get_document_info[:site_index]
+    index.each do |uri, title|
+      page = @storage.get(uri)
+      docs.add(uri, :title => title, :content => Marsdawn::Util.strip_tags(page[:content]))
+    end
+  end
+
+  def search keyword, opts={}
+    snippet = Groonga::Snippet.new(html_escape: true, default_open_tag: '<strong>', default_close_tag: '</strong>', normalize: true)
+    words = keyword.scan(/(?:\w|"[^"]*")+/).map{|w| w.delete('"')}
+    words.each{|word| snippet.add_keyword(word, opts)}
+    docs = table('documents')
+    docs.select do |rec|
+      expression = nil
+      words.each do |word|
+        sub_exp = (rec.content =~ word)
+        if expression.nil?
+          expression = sub_exp
+        else
+          expression &= sub_exp
+        end
+      end
+      expression
+    end.map{|rec| {uri: rec.key.key, title: rec.title, results: snippet.execute(rec.content)}}
+  end
+
+  private
+  def table_name name
+    "#{@table_prefix}-#{name}"
+  end
+
+  def table name
+    Groonga[table_name(name)]
+  end
+
+  def col_name table, column
+    "#{table_name(table)}.#{column}"
+  end
+
+end

data/lib/marsdawn/search.rb

@@ -0,0 +1,16 @@
+# encoding: utf-8
+
+class Marsdawn::Search
+
+  def self.create_index storage, opts
+    self.get(storage, opts).create_index
+  end
+
+  def self.get storage, opts
+    opts = Marsdawn::Util.hash_symbolize_keys(opts)
+    key = opts[:type]
+    @@base_path ||= File.join(File.dirname(__FILE__), 'search')
+    Marsdawn::Util.adapter(self, class_name, @@base_path).new config, opts
+  end
+
+end

data/lib/marsdawn/site/breadcrumb.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+class Marsdawn::Site
+  class Breadcrumb < Hash
+
+    def initialize site, crumb
+      @site = site
+      crumb.each do |path|
+        self[path] = Marsdawn::Site::Link.new(@site, path)
+      end
+    end
+
+    def to_s
+      to_html
+    end
+
+    def to_html
+      words = []
+      if self.size > 0
+        words << '<ul>'
+        self.each do |uri, link|
+          words << "<li>#{link.to_html}</li>"
+        end
+        words << '</ul>'
+      end
+      words.join('')
+    end
+
+  end
+end

data/lib/marsdawn/site/indexer.rb

@@ -0,0 +1,78 @@
+# encoding: utf-8
+
+class Marsdawn::Site
+  class Indexer < Hash
+
+    def initialize site, index={}
+      @site = site
+      @current_page = nil
+      index.each do |uri, title|
+        self[uri] = Marsdawn::Site::Link.new(@site, uri, title)
+      end
+    end
+
+    def current_page path
+      @current_page = path
+      self
+    end
+
+    #def parent path
+    #  parent_path = "#{File.dirname(path)}/"
+    #  self.each_with_object(Marsdawn::Site::Indexer.new(@site).current_page(path)) do |(uri, link), ret|
+    #    ret[uri] = link if uri == parent_path
+    #  end
+    #end
+
+    def under path
+      base = path + (path == '/' ? '' : '/')
+      self.each_with_object(Marsdawn::Site::Indexer.new(@site).current_page(path)) do |(uri, link), ret|
+        ret[uri] = link if uri.start_with?(base) && uri != base
+      end
+    end
+
+    def neighbor path
+      level = path.count('/')
+      base = File.dirname(path)
+      base = "#{base}/" if base != '/'
+      self.each_with_object(Marsdawn::Site::Indexer.new(@site).current_page(path)) do |(uri, link), ret|
+        ret[uri] = link if uri.start_with?(base) && uri.count('/') == level && uri != base
+      end
+    end
+
+    def to_s
+      to_html
+    end
+
+    def to_html options={}
+      if self.size > 0
+        opts = {
+        }.merge(options)
+        create_link_html File.dirname(self.keys.first), opts
+      else
+        ""
+      end
+    end
+
+    private
+    def create_link_html path, opts={}
+      base_level = path.count('/')
+      words = []
+      words << '<ul>'
+      self.each do |uri, link|
+        next unless uri.start_with?(path)
+        level = uri.count('/')
+        if base_level < level
+          words.insert -2, create_link_html(uri)
+        elsif base_level == level
+          attr = (uri == @current_page ? ' class="current-page"' : '')
+          words << "<li#{attr}>"
+          words << link.to_html
+          words << '</li>'
+        end
+      end
+      words << '</ul>'
+      words.size > 2 ? words.join('') : ""
+    end
+
+  end
+end

data/lib/marsdawn/site/link.rb

@@ -0,0 +1,28 @@
+# encoding: utf-8
+
+class Marsdawn::Site
+  class Link
+    attr_reader :uri, :title, :site, :full_path
+
+    def initialize site, uri, title=nil
+      @uri = uri
+      @title = (title.nil? ? site.page_title(uri) : title)
+      @site = site
+      @full_path = @site.full_path(@uri)
+    end
+
+    def page
+      @site.page @uri
+    end
+
+    def to_s
+      to_html
+    end
+
+    def to_html
+      t = CGI.escapeHTML(@title)
+      %!<a href="#{@full_path}" title="#{t}">#{t}</a>!
+    end
+
+  end
+end