marsdawn 0.0.1

data/lib/marsdawn/storage/base.rb

@@ -0,0 +1,44 @@
+# encoding: utf-8
+
+class Marsdawn::Storage::Base
+
+  def initialize config, opts
+    @config = config
+    @opts = opts
+  end
+
+  def key
+    @opts[:key]
+  end
+
+  def lang
+    @opts[:lang]
+  end
+
+  def version
+    @opts[:version]
+  end
+
+  def finalize
+  end
+
+  def clean_up
+  end
+
+  def set_document_info doc_info
+    raise NotImplementedError.new("#{self.class.name}#set_document_info() is not implemented.")
+  end
+
+  def set uri, content, exvars, sysinfo
+    raise NotImplementedError.new("#{self.class.name}#set() is not implemented.")
+  end
+
+  def get_document_info
+    raise NotImplementedError.new("#{self.class.name}#get_document_info() is not implemented.")
+  end
+
+  def get uri
+    raise NotImplementedError.new("#{self.class.name}#get() is not implemented.")
+  end
+
+end

data/lib/marsdawn/storage/file_system.rb

@@ -0,0 +1,83 @@
+# encoding: utf-8
+
+require 'marsdawn/storage/base'
+require 'yaml'
+
+class Marsdawn::Storage::FileSystem < Marsdawn::Storage::Base
+
+  def initialize config, opts={}
+    @config = {
+      tmp_dir: '/tmp',
+      mode_dir: 0755,
+      mode_file: 0644
+    }.merge(config)
+    raise "Not specify the local storage path name." unless @config.key?(:path)
+    @path = File.absolute_path(@config[:path])
+    raise "There is no directory to build to '#{@path}'." unless File.exists?(@path)
+    @opts = {
+      key: '-',
+      lang: 'en',
+      version: '0.0.1'
+    }.merge(opts)
+    set_target_path
+  end
+
+  def prepare
+    setup_tmp_dir
+  end
+
+  def finalize
+    target_dir = File.dirname(@target_path)
+    FileUtils.mkdir_p target_dir, :mode => @config[:mode_dir] unless File.exists?(target_dir)
+    FileUtils.remove_entry_secure @target_path if File.exists?(@target_path)
+    FileUtils.mv @tmproot, @target_path
+  end
+
+  def clean_up
+    FileUtils.remove_entry_secure @tmproot
+  end
+
+  def set_document_info doc_info
+    File.write @tmp_doc_info_file, YAML.dump(doc_info)
+  end
+
+  def set uri, content, front_matter, sysinfo
+    fullpath = tmp_page_file(uri)
+    dir = File.dirname(fullpath)
+    FileUtils.mkdir_p dir, :mode => @config[:mode_dir] unless File.exists?(dir)
+    data = {content: content, front_matter: front_matter, sysinfo: sysinfo}
+    File.write fullpath, YAML.dump(data)
+  end
+
+  def get_document_info
+    YAML.load_file @doc_info_file
+  end
+
+  def get uri
+    fullpath = page_file(uri)
+    YAML.load_file fullpath if File.exists?(fullpath)
+  end
+
+  private
+  def set_target_path
+    @target_path = File.join(@path, key, lang, version)
+    @doc_info_file = File.join(@target_path, '.info.yml')
+  end
+
+  def setup_tmp_dir
+    tmp_dir = @config[:tmp_dir]
+    "The work directory '#{tmp_dir}' does not exist." unless File.exists?(tmp_dir)
+    @tmproot = File.join(tmp_dir, "__tmp_#{$$}_#{Time.now.to_i}")
+    Dir.mkdir @tmproot, @config[:mode_dir]
+    @tmp_doc_info_file = File.join(@tmproot, '.info.yml')
+  end
+
+  def tmp_page_file uri
+    File.join(@tmproot, "#{uri}_.mdd")
+  end
+
+  def page_file uri
+    File.join(@target_path, "#{uri}_.mdd")
+  end
+
+end

data/lib/marsdawn/storage/test.rb

@@ -0,0 +1,20 @@
+# encoding: utf-8
+
+require "marsdawn/storage/base"
+
+class Marsdawn::Storage::Test < Marsdawn::Storage::Base
+
+  def initialize config, opts
+    super
+    @storage = {}
+  end
+
+  def set path, page, exvars, sysinfo
+    @storage[path] = {:page => page, :exvars => exvars, :sysinfo => sysinfo}
+  end
+
+  def get path
+    @storage[path]
+  end
+
+end

data/lib/marsdawn/storage/test_not_implemented_error.rb

@@ -0,0 +1,6 @@
+# encoding: utf-8
+
+require "marsdawn/storage/base"
+
+class Marsdawn::Storage::TestNotImplementedError < Marsdawn::Storage::Base
+end

data/lib/marsdawn/storage.rb

@@ -0,0 +1,22 @@
+# encoding: utf-8
+
+class Marsdawn::Storage
+
+  def self.get config, opts={}
+    opts = {key: 'default', lang: 'en', version: '0.0.1'}.merge(opts)
+    config = handle_config(config, opts)
+    raise "No storage type is specified." unless config.key?(:type)
+    class_name = config[:type]
+    @@base_path ||= File.join(File.dirname(__FILE__), 'storage')
+    Marsdawn::Util.adapter(self, class_name, @@base_path).new config, opts
+  end
+
+  def self.handle_config config, opts
+    if config.nil?
+      Marsdawn::Config.new.get(opts[:key], :storage)
+    else
+      Marsdawn::Util.hash_symbolize_keys(config)
+    end
+  end
+
+end

data/lib/marsdawn/util.rb

@@ -0,0 +1,39 @@
+# encoding: utf-8
+
+class Marsdawn::Util
+
+  def self.hash_symbolize_keys hash, deep=false
+    hash.each_with_object({}) do |(key, val), ret|
+      val = hash_symbolize_keys(val, deep) if deep && val.kind_of?(Hash)
+      ret[key.to_sym] = val
+    end
+  end
+
+  def self.hash_symbolize_keys_deep hash
+    hash_symbolize_keys hash, true
+  end
+
+  def self.class_to_underscore class_name
+      class_name.gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').gsub(/([a-z\d])([A-Z])/,'\1_\2').tr('-','_').downcase
+  end
+
+  def self.strip_tags text
+    text.gsub(/<[^>]*>/ui, '')
+  end
+
+  def self.html_escape str
+    CGI.escapeHTML str
+  end
+
+  def self.attr_escape str
+    str.gsub(/"/, '\"')
+  end
+
+  def self.adapter namespace, class_name, base_path
+    unless namespace.const_defined?(class_name, false)
+      require File.join(base_path, class_to_underscore(class_name))
+    end
+    namespace.const_get(class_name)
+  end
+
+end

data/lib/marsdawn/version.rb

@@ -0,0 +1,3 @@
+module Marsdawn
+  VERSION = "0.0.1"
+end

data/lib/marsdawn.rake

@@ -0,0 +1,9 @@
+require 'rubygems'
+require 'rake'
+
+namespace 'marsdawn' do
+  desc 'build MarsDawn document.'
+  task :build => :environment do
+    Marsdawn.build
+  end
+end

data/lib/marsdawn.rb

@@ -0,0 +1,55 @@
+# encoding: utf-8
+
+load "marsdawn.rake"
+require "marsdawn/version"
+require "marsdawn/util"
+require "marsdawn/config"
+require "marsdawn/storage"
+require "marsdawn/site"
+require "marsdawn/search"
+
+module Marsdawn
+
+  # load lib file from lib/marsdawn directory
+  # @param [String] require file under lib/marsdawn directory
+  def self.require_lib path
+    @@base_path ||= File.expand_path(File.join(File.dirname(__FILE__), 'marsdawn'))
+    require File.join(@@base_path, path)
+  end
+
+  # build document source
+  # @param [String] key of config file entry
+  def self.build *keys
+    require "marsdawn/builder"
+    if block_given?
+      conf = {}
+      yield conf
+      configs = [conf]
+    else
+      configs = configs_from_file(keys)
+    end
+    configs.each do |conf|
+      Marsdawn::Builder.build conf
+    end
+    puts "[MarsDawn] Build complete."
+  rescue => e
+    puts "[MarsDawn] ERROR: #{e.message}"
+  end
+
+  private
+  def self.configs_from_file keys
+    [].tap do |ret|
+      config = Marsdawn::Config.new
+      if keys.size > 0
+        keys.each do |key|
+          ret << config.to_hash(key)
+        end
+      else
+        config.each do |key, conf|
+          ret << conf
+        end
+      end
+    end
+  end
+
+end

data/marsdawn.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marsdawn/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "marsdawn"
+  spec.version       = Marsdawn::VERSION
+  spec.authors       = ["Naohiko MORI"]
+  spec.email         = ["naohiko.mori@gmail.com"]
+  spec.summary       = %q{Easy static document builder & traverser.}
+  spec.description   = %q{Make it easy to create static document site by building markdown documents and traverse them.}
+  spec.homepage      = "https://github.com/nao58/marsdawn"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake", "~> 10.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_dependency "kramdown", "~> 1.3"
+end

data/spec/_test_doc/config.yml

@@ -0,0 +1,10 @@
+test_docs01:
+  source: /path/to/source01
+  storage:
+    type: FileSystem
+    path: /path/to/storage01
+test_docs02:
+  source: /path/to/source02
+  storage:
+    type: FileSystem
+    path: /path/to/storage02

data/spec/_test_doc/docs01/.index.md

@@ -0,0 +1 @@
+{::front_matter title="Test Document 01" link_key="top" /}

data/spec/_test_doc/docs01/.marsdawn.yml

@@ -0,0 +1,4 @@
+key: "test_docs01"
+lang: "en"
+title: "Test Document"
+version: "0.0.1"

data/spec/_test_doc/docs01/010_about.md

@@ -0,0 +1,4 @@
+About
+======
+
+This is the documents for spec test.

data/spec/_test_doc/docs01/020_tutorial/010_install.md

@@ -0,0 +1,6 @@
+Install
+=======
+
+This is the test page.
+
+You should use [Each] method.

data/spec/_test_doc/docs01/020_tutorial/020_getting_start.md

@@ -0,0 +1,9 @@
+---
+title: Getting start using MarsDawn
+link_key: Start MarsDawn
+---
+
+Get the start
+=============
+
+lorem ipsum

data/spec/_test_doc/docs01/040_appendix.md

@@ -0,0 +1,3 @@
+# Appendix
+
+hoge

data/spec/_test_doc/no_key/.marsdawn.yml

@@ -0,0 +1,3 @@
+lang: "en"
+title: "Test Document"
+version: "0.0.1"

data/spec/_test_doc/samples/010_sample-document.md

@@ -0,0 +1,4 @@
+---
+link_key: Test Document
+---
+lorem ipsum dolor sit amet

data/spec/_test_doc/samples/test_document.md

@@ -0,0 +1 @@
+lorem ipsum dolor sit amet

data/spec/lib/marsdawn/command_spec.rb

@@ -0,0 +1,144 @@
+# encoding: utf-8
+
+require File.expand_path(File.join('../../', 'spec_helper'), File.dirname(__FILE__))
+Marsdawn.require_lib 'command'
+
+describe Marsdawn::Command do
+
+  def command argv
+    Marsdawn::Command.exec(argv)
+  end
+
+  def cmd
+    @cmd ||= Marsdawn::Command.new
+  end
+
+  def chdir path
+    Dir.chdir File.expand_path(path)
+  end
+
+  def file_exists? path
+    File.exists?(File.expand_path(path))
+  end
+
+  before :each do
+    Dir.chdir($TMP_DIR)
+    Dir.glob("*").each do |entry|
+      path = File.expand_path(entry)
+      FileUtils.remove_entry(path, true) if File.exists?(path)
+    end
+    @cmd = nil
+  end
+
+  context '#exec' do
+    it 'should parse rightly.' do
+      expect(command(%w(debug options --num 100 -e))).to eq(num:'100', edit:true)
+      expect(command(%w(debug options num 100 -e))).to eq(num:'100', edit:true)
+      expect(command(%w(debug options -n 100 -e))).to eq(num:'100', edit:true)
+      expect(command(%w(debug options --num 200 -n 100 -e))).to eq(num:'100', edit:true)
+      expect(command(%w(debug options))).to eq({})
+      expect(command(%w(debug))).to be_nil
+    end
+    it 'should raise error when option is invalid.' do
+      expect{command(%w(debug options --foo bar))}.to raise_error(Marsdawn::Command::ParamError)
+    end
+    it 'should raise error when command is invalid.' do
+      expect{command(%w(foo))}.to raise_error(Marsdawn::Command::ParamError)
+    end
+    it 'should raise error when command is not given.' do
+      expect{command(%w())}.to raise_error(Marsdawn::Command::ParamError)
+    end
+  end
+
+  context 'with command .create' do
+    it 'should create new directory, .marsdawn.yml and .index.md' do
+      cmd.create 'Test Document'
+      expect(file_exists?('test-document')).to be_truthy
+      expect(file_exists?('test-document/.marsdawn.yml')).to be_truthy
+      expect(file_exists?('test-document/.index.md')).to be_truthy
+    end
+  end
+
+  context 'with command .page' do
+    before :each do
+      cmd.create 'Test Document'
+      chdir './test-document'
+    end
+    it 'should create new page.' do
+      cmd.page 'About this test document'
+      cmd.page 'Getting Start'
+      expect(file_exists?('about-this-test-document.md')).to be_truthy
+      expect(file_exists?('getting-start.md')).to be_truthy
+    end
+    it 'should create new page.' do
+      cmd.page 'About this test document', num: true
+      cmd.page 'Getting Start', num: true
+      cmd.page 'Appendix 1', num: "100", file: 'omake'
+      cmd.page 'Appendix 2', num: true, file: 'furoku'
+      expect(file_exists?('010_about-this-test-document.md')).to be_truthy
+      expect(file_exists?('020_getting-start.md')).to be_truthy
+      expect(file_exists?('100_omake.md')).to be_truthy
+      expect(file_exists?('110_furoku.md')).to be_truthy
+    end
+  end
+
+  context 'with command .dir' do
+    before :each do
+      cmd.create 'Test Document'
+      chdir './test-document'
+    end
+    it 'should create new directory.' do
+      cmd.page 'About this test document'
+      cmd.dir  'Getting Start'
+      expect(file_exists?('about-this-test-document.md')).to be_truthy
+      expect(file_exists?('getting-start')).to be_truthy
+      expect(file_exists?('getting-start/.index.md')).to be_truthy
+    end
+    it 'should create new page.' do
+      cmd.page 'About this test document', num: true
+      cmd.dir  'Getting Start', num: true
+      cmd.dir  'Appendix 1', num: "100", file: 'omake'
+      cmd.page 'Appendix 2', num: true, step: 5, file: 'furoku'
+      expect(file_exists?('010_about-this-test-document.md')).to be_truthy
+      expect(file_exists?('020_getting-start')).to be_truthy
+      expect(file_exists?('020_getting-start/.index.md')).to be_truthy
+      expect(file_exists?('100_omake')).to be_truthy
+      expect(file_exists?('100_omake/.index.md')).to be_truthy
+      expect(file_exists?('105_furoku.md')).to be_truthy
+    end
+  end
+
+  context 'with command .renum' do
+    before :each do
+      cmd.create 'Test Document'
+      chdir './test-document'
+    end
+    it 'should do re-numbering.' do
+      cmd.page 'About this test document', num: "15"
+      cmd.dir  'Getting Start', num: "20"
+      cmd.dir  'Appendix 1', num: "100"
+      cmd.page 'Appendix 2', num: true, step: 5
+      cmd.renum nil
+      expect(file_exists?('010_about-this-test-document.md')).to be_truthy
+      expect(file_exists?('020_getting-start')).to be_truthy
+      expect(file_exists?('020_getting-start/.index.md')).to be_truthy
+      expect(file_exists?('030_appendix-1')).to be_truthy
+      expect(file_exists?('030_appendix-1/.index.md')).to be_truthy
+      expect(file_exists?('040_appendix-2.md')).to be_truthy
+    end
+    it 'should do re-numbering with step.' do
+      cmd.page 'About this test document', num: "15"
+      cmd.dir  'Getting Start', num: "20"
+      cmd.dir  'Appendix 1', num: "100"
+      cmd.page 'Appendix 2', num: true, step: 5
+      cmd.renum "15"
+      expect(file_exists?('015_about-this-test-document.md')).to be_truthy
+      expect(file_exists?('030_getting-start')).to be_truthy
+      expect(file_exists?('030_getting-start/.index.md')).to be_truthy
+      expect(file_exists?('045_appendix-1')).to be_truthy
+      expect(file_exists?('045_appendix-1/.index.md')).to be_truthy
+      expect(file_exists?('060_appendix-2.md')).to be_truthy
+    end
+  end
+
+end

data/spec/lib/marsdawn/config_spec.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+
+require File.expand_path(File.join('../../', 'spec_helper'), File.dirname(__FILE__))
+
+describe Marsdawn::Config do
+
+  before do
+    @conf_data = {
+      'test_docs01' => {
+        source: '/path/to/source01',
+        storage: {type: 'FileSystem', path: '/path/to/storage01'}
+      },
+      'test_docs02' => {
+        source: '/path/to/source02',
+        storage: {type: 'FileSystem', path: '/path/to/storage02'}
+      }
+    }
+  end
+
+  def config
+    @config ||= Marsdawn::Config.new(File.join($TEST_DOC_DIR, 'config.yml'))
+  end
+
+  it 'should raise error when the config file does not exist.' do
+    expect{Marsdawn::Config.new}.to raise_error(/^Cannot find a config file for marsdawn./)
+  end
+
+  it 'should raise errro when the config key does not exist in the yaml.' do
+    expect{config.to_hash('no_exists')}.to raise_error(/^Cannot find the configuration/)
+  end
+
+  it 'should raise errro when the config entry does not exist at the config.' do
+    expect{config.get('test_docs01', :no_exists)}.to raise_error(/^No entry 'no_exists' in the setting file/)
+  end
+
+  it 'should return the config data from key.' do
+    expect(config.get('test_docs01', :source)).to eq(@conf_data['test_docs01'][:source])
+    expect(config.get('test_docs02', :storage)).to eq(@conf_data['test_docs02'][:storage])
+  end
+
+end