easy-doc 1.0.0

data/README.mkd

@@ -0,0 +1,93 @@
+# easy-doc - Write a document easily
+
+## Requirements
+
+* Ruby (I'm debugging in 1.9.1)
+* rpeg-markdown
+
+## Install
+
+__Not available yet. I'll push soon :)__
+
+### Using rubygem
+
+    gem install easy-doc
+
+__NOTE:__ Gemcutter is needed.
+
+### Using git
+
+    git clone git://github.com/sorah/easy-doc.git
+
+and write following line your shell's rc-file:
+
+    export RUBYLIB=/path/to/easy-doc/lib:$RUBYLIB
+
+## Usage
+
+### Simple
+
+Simple directory structure:
+
+    doc/              -- documentation directory
+      mkd/            -- markdown directory
+        index.mkd     -- index
+        index.ja.mkd  -- index(ja)
+
+and run following command in doc directory:
+
+    easy-doc mkd html
+
+the easy-doc command render a markdown (in mkd directory) files to html directory.
+
+And new directory structure:
+
+    doc/              -- documentation directory
+      mkd/            -- markdown directory
+        index.mkd     -- index
+        index.ja.mkd  -- index(ja)
+        checksums     -- checksum data for re-rendering
+      html/           -- html directory. html is generate by easy-doc command.
+        index.html    -- index(rendered)
+        index.ja.html -- index(rendered)
+
+## Licence
+
+MIT Licence.
+
+(c) Sora Harakami
+
+>The MIT Licence {{{
+>
+>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.
+>
+>}}}
+
+## Develop
+
+### Requirements
+
+* Ruby 1.8.7+
+* RSpec
+
+### Usage
+
+You can run spec by this command:
+
+    spec ./spec/easy_doc_spec.rb

data/Rakefile

@@ -0,0 +1,14 @@
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "easy-doc"
+    gemspec.summary = "Write a document easily"
+    gemspec.email = "sora134@gmail.com"
+    gemspec.homepage = "http://github.com/sorah/easy-doc"
+    gemspec.description = "Write a document easily. Write a document, run command to rendering."
+    gemspec.authors = ["Sora Harakami"]
+    gemspec.add_dependency 'rpeg-markdown'
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/bin/easy-doc

@@ -0,0 +1,57 @@
+#!/usr/bin/env ruby
+#-*- coding: utf-8 -*-
+# vim: filetype=ruby
+require File.dirname(__FILE__) + '/../lib/easy_doc.rb'
+
+def show_help_and_exit
+  puts <<-EOH
+Usage: #{$0} [--force] [--quiet] [--help] [-f] [-q] [-h] (MARKDOWN_DIR HTML_DIR|MARKDOWN_AND_HTML_DIR)
+
+    --force, -f           | Force update
+    --quiet, -q           | Don't put anything
+    --help ,-h            | Show this message
+    MARKDOWN_AND_HTML_DIR | Read markdown file and export html file here.
+    MARKDOWN_DIR          | Read markdown files from here.
+    HTML_DIR              | Export html files here.
+  EOH
+  exit
+end
+
+def option_loop(arg,options={})
+  case arg
+  when '--force','-f'
+    options[:force] = true
+  when '--quiet','-q'
+    options[:quiet] = true
+  when '--help' ,'-h', nil
+    show_help_and_exit
+  else
+    if options[:mkd_dir].nil?
+      options[:mkd_dir] = arg
+      abort "ERROR: markdown dir not exist!" unless File.exist?(options[:mkd_dir])
+    elsif options[:html_dir].nil?
+      options[:html_dir] = arg
+    end
+  end
+
+  na = ARGV.shift
+  unless na.nil? # loop
+    option_loop(na,options)
+  else # exit loop
+    unless options[:mkd_dir]
+      abort "ERROR: markdown dir not specified."
+    end
+    options[:html_dir] = options[:mkd_dir] unless options[:html_dir]
+    options
+  end
+end
+
+# kick loop
+o = option_loop(ARGV.shift,
+                {
+                  :force => false,
+                  :quiet => false
+                })
+# Run
+e = EasyDoc.new(o[:mkd_dir],o[:html_dir])
+e.render(o[:quiet],o[:force])

data/easy-doc.gemspec

@@ -0,0 +1,51 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{easy-doc}
+  s.version = "1.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Sora Harakami"]
+  s.date = %q{2010-03-17}
+  s.default_executable = %q{easy-doc}
+  s.description = %q{Write a document easily. Write a document, run command to rendering.}
+  s.email = %q{sora134@gmail.com}
+  s.executables = ["easy-doc"]
+  s.extra_rdoc_files = [
+    "README.mkd"
+  ]
+  s.files = [
+    "README.mkd",
+     "Rakefile",
+     "VERSION",
+     "bin/easy-doc",
+     "easy-doc.gemspec",
+     "lib/easy_doc.rb",
+     "spec/easy_doc_spec.rb"
+  ]
+  s.homepage = %q{http://github.com/sorah/easy-doc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{Write a document easily}
+  s.test_files = [
+    "spec/easy_doc_spec.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rpeg-markdown>, [">= 0"])
+    else
+      s.add_dependency(%q<rpeg-markdown>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rpeg-markdown>, [">= 0"])
+  end
+end
+

data/lib/easy_doc.rb

@@ -0,0 +1,288 @@
+#
+# easy-doc
+# Author: Sora Harakami
+# Licence: MIT Licence
+# The MIT Licence {{{
+#   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.
+# }}}
+#
+require 'rubygems'
+require 'markdown' # rpeg-markdown
+require 'yaml'
+require 'digest/md5'
+require 'erb'
+require 'pathname'
+require 'fileutils'
+
+class EasyDoc
+  class MakeDirectoryError < Exception; end
+
+  def initialize(mkd_path,html_path)
+    raise ArgumentError, 'mkd_path is invalid' unless File.directory?(mkd_path) && html_path.kind_of?(String)
+    raise ArgumentError, 'html_path is invalid' unless html_path.kind_of?(String)
+    @mkd_path  = File.expand_path(mkd_path ).gsub(/\/$/,"")
+    @html_path = File.expand_path(html_path).gsub(/\/$/,"")
+    init_config
+  end
+
+  def init_config
+    @config    = { #Default config
+                   :default_lang => "default"
+                 }
+    @changed_config = changed_config
+    @config.merge!(load_config)
+  end
+
+  def render(quiet=true,force=false)
+    puts "Checking changed markdown files..." unless quiet
+    f = (force || @changed_config.include?(:default_lang)) ? markdown_files : changed_markdown_files
+    f.each do |n|
+      puts "Rendering: #{n}" unless quiet
+      render_file(n)
+    end
+    self
+  end
+
+  def layout
+    if File.exist?("#{@mkd_path}/layout.erb")
+      File.read("#{@mkd_path}/layout.erb")
+    else
+      ### Default layout  ###
+      return <<-EOB
+<html>
+  <head>
+    <title><%= title %></title>
+    <style type="text/css">
+      body {
+        font-family: sans-serif;
+        font-size: 18px;
+      }
+
+      h1 { font-size: 28px; }
+      h2 { font-size: 26px; }
+      h3 { font-size: 24px; }
+      h4 { font-size: 22px; }
+      h5 { font-size: 20px; }
+      h6 { font-size: 17px; }
+
+      .header {
+        padding-bottom: 10px;
+        border-bottom: 1px solid gray;
+        margin-bottom: 10px;
+      }
+
+      .lang_bar {
+        text-align: right;
+        font-size: 13px;
+      }
+
+      .title {
+        font-size: 24px;
+        margin-top: 5px;
+      }
+    </style>
+  </head>
+  <body>
+    <!-- Document rendered by easy_doc http://github.com/sorah/easy-doc -->
+    <div class="header">
+      <div class="lang_bar">
+        <%= lang_bar %>
+      </div>
+      <!--<div class="title"><%= title %></div>-->
+    </div>
+    <div class="doc_body">
+      <%= body %>
+    </div>
+  </body>
+</html>
+      EOB
+      ######### End #########
+    end
+  end
+
+  def markdown_files(lp=true)
+    Dir.glob("#{@mkd_path}/**/*.mkd").map{|x| lp ? mkd_local_path(x) : x }
+  end
+
+  def delete_htmls(quiet=true)
+    fs = deleted_markdown_files
+    fs.each do |f|
+      h = f.gsub(/\.mkd$/,'.html')
+      puts "Removing: #{h}" unless quiet
+      FileUtils.remove(html_expand_path(h))
+    end
+  end
+
+  attr_reader :config
+
+private
+
+  def html_create_dir(p)
+    FileUtils.mkdir_p(html_expand_path(p).gsub(/\/[^\/]+$/,""))
+  end
+
+  def render_file(f,force_other_lang=false)
+    mkd      = File.read(mkd_expand_path(f))
+    title    = mkd.scan(/^# (.+)/).flatten[0]
+    body     = Markdown.new(mkd).to_html
+    body.gsub!(/<a href="(.+)">/) do |s|
+      u = $1
+      nu =
+        if /^\// =~ u
+          Pathname(mkd_expand_path(u)) \
+            .relative_path_from( \
+              Pathname(mkd_expand_path(File.dirname(f)
+                                       .gsub(/\/\.$/,'')))).to_s \
+            .gsub(/\.mkd$/,'.html')
+        else
+          u
+        end
+      "<a href='#{nu}'>"
+    end
+    t = File.basename(f)
+    lang_bar_ary = []
+     unless force_other_lang
+      Dir.glob("#{mkd_expand_path(File.dirname(f))}/*.mkd") \
+         .delete_if{|m| mkd_local_path(m) == f ||
+                        /^#{Regexp.escape(t.gsub(/\..*mkd/,""))}/ !~ mkd_local_path(m)} \
+         .each do |m|
+        render_file(mkd_local_path(m),true)
+      end
+     end
+    Dir.glob("#{mkd_expand_path(File.dirname(f))}/*.mkd") \
+       .map{|m| File.basename(m) } \
+       .delete_if{|m| /^#{Regexp.escape(t.gsub(/\..*mkd/,""))}/ !~ m}.each do |m|
+      la = m.scan(/(\..+)?\.mkd$/).flatten
+      l = la.include?(nil) ? @config[:default_lang] : la[0].gsub(/^\./,"")
+      ls  = ""
+      unless t == m
+        ls += '<a href="'
+        ls += m.gsub(/\.mkd/,".html")
+        ls += '">'
+      end
+      ls += l
+      unless t == m
+        ls += '</a>'
+      end
+      lang_bar_ary << ls
+    end
+    lang_bar = lang_bar_ary.join(' | ')
+    hl = f.gsub(/\.mkd$/,'.html')
+
+    html_create_dir(hl)
+    open(html_expand_path(hl),'w') do |f|
+      f.puts ERB.new(layout()).result(binding)
+    end
+  end
+
+  def calcuate_checksums
+    a = markdown_files(false)
+    h = {}
+    a.each do |f|
+      h[mkd_local_path(f)] = Digest::MD5.new.update(File.read(f)).to_s
+    end
+    h
+  end
+
+  def save_checksums(h=nil)
+    if h.nil?
+      h = calcuate_checksums
+    end
+    open("#{@mkd_path}/.easy-doc_checksums",'w') do |f|
+      f.puts h.to_yaml
+    end
+    self
+  end
+
+  def load_checksums
+    if File.exist?("#{@mkd_path}/.easy-doc_checksums")
+      YAML.load_file("#{@mkd_path}/.easy-doc_checksums")
+    else
+      {}
+    end
+  end
+
+
+  def mkd_local_path(path)
+    path.gsub(/^#{Regexp.escape(@mkd_path)}\//,'').gsub(/^\.\//,"")
+  end
+
+  def mkd_expand_path(path)
+    @mkd_path + '/' + path.gsub(/^\//,'')
+  end
+
+  def html_local_path(path)
+    path.gsub(/^#{Regexp.escape(@html_path)}\//,'')
+  end
+
+  def html_expand_path(path)
+    @html_path + '/' + path.gsub(/^\//,'')
+  end
+
+  def changed_markdown_files(sv=true)
+    n = calcuate_checksums
+    o = load_checksums
+    r = []
+    n.each do |f,c| # exists file
+      if o[f] != c
+        r << f
+      end
+    end
+    save_checksums(n) if sv
+    @changed_config.include?(:default_lang) ? markdown_files : r + (n.keys - o.keys)
+  end
+
+  def old_load_config
+    h = {}
+    if File.exist?(mkd_expand_path('.bup_config.yml'))
+      YAML.load_file(mkd_expand_path('.bup_config.yml')).each do |k,v|
+        h[k.to_sym] = v
+      end
+    end
+    h
+  end
+
+  def changed_config
+    o = old_load_config
+    n = load_config(false)
+    a = []
+    n.each do |k,v|
+      a << k unless v == o[k]
+    end
+    a
+  end
+
+  def load_config(s=true)
+    h = {}
+    if File.exist?(mkd_expand_path('config.yml'))
+      YAML.load_file(mkd_expand_path('config.yml')).each do |k,v|
+        h[k.to_sym] = v
+      end
+      FileUtils.copy(mkd_expand_path('config.yml'),mkd_expand_path('.bup_config.yml')) if s
+    end
+    h
+  end
+
+  def deleted_markdown_files(sv=false)
+    n = calcuate_checksums
+    o = load_checksums
+    save_checksums(n) if sv
+    o.keys - n.keys
+  end
+end

data/spec/easy_doc_spec.rb

@@ -0,0 +1,139 @@
+require File.dirname(__FILE__) + '/../lib/easy_doc.rb'
+require 'tmpdir'
+require 'fileutils'
+require 'thread'
+
+describe EasyDoc do
+  before(:all) do
+    @mpath = Dir.mktmpdir("easy_doc_spec_mkd" )
+    @hpath = Dir.mktmpdir("easy_doc_spec_html")
+    open(@mpath+'/index.mkd','w') {|f| f.puts "# hi" }
+  end
+
+  before do
+    @e = EasyDoc.new(@mpath,@hpath)
+  end
+
+  describe '#markdown_files' do
+    it 'take markdown files' do
+      @e.markdown_files.should include('index.mkd')
+    end
+  end
+
+  describe '#init_config' do
+    it 'reload config' do
+      open(@mpath+"/config.yml",'w') do |f|
+        f.puts 'piyo: foobar'
+      end
+      @e.init_config
+      @e.config[:piyo].should == 'foobar'
+    end
+  end
+
+  describe '#render' do
+    it 'render markdown file' do
+      @e.render
+      File.exist?(@hpath+'/index.html').should be_true
+      File.read(@hpath+'/index.html').should   match('<h1>hi</h1>')
+    end
+
+    it 'must save checksums' do
+      File.exist?(@mpath+'/.easy-doc_checksums').should be_true
+    end
+
+    it 'must not render not edited markdown file' do
+      t = File.mtime("#{@hpath}/index.html")
+      sleep 1 # TODO: Refactoring this.
+      @e.render
+      t.should == File.mtime("#{@hpath}/index.html")
+    end
+
+    it 're-render edited markdown files' do
+      open(@mpath+'/index.mkd','w') {|f| f.puts "# hi\n\n('.v.')" }
+      @e.render
+      File.read(@hpath+'/index.html').should match("<p>\\('\\.v\\.'\\)</p>")
+    end
+
+    it 'force render' do
+      t = File.mtime("#{@hpath}/index.html")
+      sleep 1 # TODO: Refactoring this.
+      @e.render(true,true)
+      t.should < File.mtime("#{@hpath}/index.html")
+    end
+
+    it 'render with layout file' do
+      open(@mpath+'/layout.erb','w') do |f|
+        f.puts <<-EOF
+<html>
+<body>
+^q^<br>
+<%=body%>
+</body>
+</html>
+      EOF
+      end
+      @e.render(true,true)
+      File.read(@hpath+'/index.html').should match("\\^q\\^")
+      FileUtils.rm(@mpath+'/layout.erb')
+    end
+
+    it 'put messages' do
+      g, $stdout = IO.pipe
+      t = Thread.new do
+        ["Checking changed markdown files","Rendering: index.mkd"].each do |m|
+          s = g.gets
+          s.should match(m)
+        end
+      end
+      @e.render(false,true)
+      t.join
+      $stdout = STDOUT
+    end
+
+    it 'render multiple languages' do
+      open(@mpath+'/index.ja.mkd','w') do |f|
+        f.puts "# Konnnitiha."
+      end
+      @e.render
+      File.read(@hpath+'/index.ja.html').should match('<a href="index.html">default</a>')
+      File.read(@hpath+'/index.html').should match('<a href="index.ja.html">ja</a>')
+    end
+
+    it 'set default languages' do
+      open(@mpath+'/config.yml','w') do |f|
+        f.puts "default_lang: en"
+      end
+      @e.init_config
+      @e.render
+      File.read(@hpath+'/index.ja.html').should match('<a href="index.html">en</a>')
+      File.read(@hpath+'/index.html').should match('en')
+    end
+
+    it 'generate relative path in <a>' do
+      Dir.mkdir(@mpath+'/foo').should == 0
+      File.exist?(@mpath+'/foo').should be_true
+      open(@mpath+'/foo/bar.mkd','w') do |f|
+        f.puts "# Foo\n\n# bar\n\n cool"
+      end
+      open(@mpath+'/index.mkd','w') {|f| f.puts "# hi\n\n[foobar!](/foo/bar.mkd)" }
+      @e.render(true,true)
+      File.read(@hpath+'/index.html').should match("<a href='foo/bar.html'>")
+    end
+  end
+
+  describe '#delete_htmls' do
+    it 'deletes deleted markdown file\'s html' do
+      open(@mpath+'/hoge.mkd','w') {|f| f.puts "# hi"}
+      @e.render
+      File.exist?(@hpath+'/hoge.html').should be_true
+      FileUtils.remove(@mpath+'/hoge.mkd')
+      @e.delete_htmls
+      File.exist?(@hpath+'/hoge.html').should be_false
+    end
+  end
+
+  after(:all) do
+    FileUtils.remove_entry_secure @mpath
+    FileUtils.remove_entry_secure @hpath
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification 
+name: easy-doc
+version: !ruby/object:Gem::Version 
+  version: 1.0.0
+platform: ruby
+authors: 
+- Sora Harakami
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-03-17 00:00:00 +09:00
+default_executable: easy-doc
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rpeg-markdown
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Write a document easily. Write a document, run command to rendering.
+email: sora134@gmail.com
+executables: 
+- easy-doc
+extensions: []
+
+extra_rdoc_files: 
+- README.mkd
+files: 
+- README.mkd
+- Rakefile
+- VERSION
+- bin/easy-doc
+- easy-doc.gemspec
+- lib/easy_doc.rb
+- spec/easy_doc_spec.rb
+has_rdoc: true
+homepage: http://github.com/sorah/easy-doc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Write a document easily
+test_files: 
+- spec/easy_doc_spec.rb