kui-md 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*~
+.rbenv-version

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in md.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Keiichiro Ui
+
+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,28 @@
+kui-md
+====================================
+
+自分向けの markdown 変換器。Graphviz によるグラフ作成や、Pygments.rb による
+コードのシンタックスハイライトもできる。
+
+
+インストール
+----------------------------------
+
+下記のコマンドを実行する。
+
+~~~~~~~~~~~~~~~~~sh
+$ gem install kui-md
+~~~~~~~~~~~~~~~~~
+
+
+使い方
+----------------------------------
+
+こんな感じで markdown の変換ができる。
+
+~~~~~~~~~~~~~~~~~sh
+$ md -h
+$ md foo.markdown
+$ md foo.markdown output.html
+~~~~~~~~~~~~~~~~~
+

data/Rakefile

@@ -0,0 +1,12 @@
+#!/usr/bin/env rake
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require "bundler/gem_tasks"
+require "rspec/core"
+require "rspec/core/rake_task"
+
+desc "Run all specs in spec/*_spec.rb"
+RSpec::Core::RakeTask.new :spec
+
+task :build => :spec
+task :default => :spec

data/bin/md

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require 'rubygems'
+require 'md'
+
+Md::CLI::run *ARGV

data/example/config.rb

@@ -0,0 +1,26 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+title_format "%s - メモ"
+
+# see https://github.com/tanoku/redcarpet
+enable_markdown_opts :fenced_code_blocks, :tables, :no_intra_emphasis, :autolink,
+:strikethrough, :space_after_headers, :superscript
+enable_html_opts
+
+# see `pygmentize -H formatter html`
+pygments_opts({
+    :cssclass => 'hll',
+    :classprefix => 'pyg',
+    #:linenos => 'table',
+    #:linenos => 'inline',
+    :linenos => nil,
+    :style => 'native',
+  })
+
+css <<EOS
+h1, h2, h3, h4, h5, h6, p, ul, ol, pre, div {
+  color: #333;
+}
+EOS
+
+script "// foo"

data/lib/md.rb

@@ -0,0 +1,12 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require 'md/version'
+require 'md/configure'
+require 'md/renderer'
+require 'md/cli'
+
+module Md
+  USAGE = <<EOS
+Usage: #{$0} SOURCE_FILE [ DEST_FILE ]
+EOS
+end

data/lib/md/cli.rb

@@ -0,0 +1,110 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require 'optparse'
+
+module Md
+
+  # a command line interface
+  class CLI
+
+    DEFAULT_CONFIG_NAME = ".md/config.rb"
+    DEFAULT_CONFIG_PATH = File.join ENV['HOME'], DEFAULT_CONFIG_NAME
+
+    def self.run *args
+      new.run *args
+    end
+
+    # a configure file path
+    attr_reader :config_file
+
+    # a render options
+    attr_reader :opts
+
+    # a command which will be executed
+    attr_reader :cmd
+
+    # a usage message
+    attr_reader :usage
+
+    def initialize
+      @config_file = DEFAULT_CONFIG_PATH
+      @cmd = :render
+      @usage = USAGE
+      @opts = {}
+    end
+
+    def run *args
+      load_config
+      parse_opts args
+      begin
+        method(@cmd).call(args[0], args[1])
+      rescue Exception => e
+        if $DEBUG
+          raise e
+        else
+          err 1, "ERROR: #{e.message}"
+        end
+      end
+    end
+
+    def parse_opts args
+      opt = OptionParser.new USAGE
+
+      opt.on('-c VAL', '--config VAL',
+        "specify a configure file. (default: '#{DEFAULT_CONFIG_PATH}')") do |v|
+        @config_file = v
+      end
+
+      opt.on('--with-wrapping-html',
+        'wrap the converted html with html and body elements') do
+        @opts[:wrapping_html] = true
+      end
+      opt.on('--without-wrapping-html',
+        'do not wrap the converted html with html and body elements') do
+        @opts[:wrapping_html] = false
+      end
+
+      opt.parse! args
+      @usage = opt.help
+    end
+
+    def err code = 1, msg = nil
+      puts msg if msg
+      puts @usage
+      exit code
+    end
+
+    def load_config
+      if not File.exists? @config_file
+        require 'fileutils'
+        FileUtils.mkdir_p File.dirname @config_file
+        FileUtils.touch @config_file
+      end
+      config = Configure.new(@config_file)
+      @opts.merge! config[:html]
+
+      [:markdown, :pygments, :css, :script, :wrapping_html, :title_format].each do |s|
+        @opts[s] = config[s] if config[s]
+      end
+    end
+
+    # a default command
+    def render src, dest
+      if not src
+        raise ArgumentError, "expect to specify a src file"
+      end
+
+      renderer = Md::Renderer.new @opts
+      open src do |f|
+        result = Redcarpet::Markdown.new(renderer, @opts[:markdown]).render f.read
+        if dest
+          open dest, 'w' do |w|
+            w.write result
+          end
+        else
+          print result
+        end
+      end
+    end
+  end
+end

data/lib/md/configure.rb

@@ -0,0 +1,143 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require 'forwardable'
+
+module Md
+
+  # a config DSL parser
+  class Configure
+
+    # options for Redcarpet::Render::HTML
+    KNOWN_HTML_OPTS = [
+      :filter_html,
+      :no_images,
+      :no_links,
+      :no_styles,
+      :safe_links_only,
+      :with_toc_data,
+      :hard_wrap,
+      :xhtml,
+    ]
+
+    # options for Redcarpet::Markdown
+    KNOWN_MARKDOWN_OPTS = [
+      :no_intra_emphasis,
+      :tables,
+      :fenced_code_blocks,
+      :autolink,
+      :strikethrough,
+      :lax_html_blocks,
+      :space_after_headers ,
+      :superscript,
+    ]
+
+    KNOWN_PYGMENTS_OPTS = [
+      # specify a formatter
+      # see `pygmentize -L formatters`
+      #:formatter,
+
+      # options for HtmlFormatter
+      # see `pygmentize -H formatter html`
+      :nowrap,
+      :full,
+      :title,
+      :style,
+      :noclasses,
+      :classprefix,
+      :cssclass,
+      :cssstyles,
+      :prestyles,
+      :cssfile,
+      :noclobber_cssfile,
+      :linenos,
+      :hl_lines,
+      :linenostart,
+      :linenostep,
+      :linenospecial,
+      :nobackground,
+      :lineseparator,
+      :lineanchors,
+      :anchorlinenos,
+    ]
+
+    extend Forwardable
+    def_delegators :@map, :[]
+
+    def initialize file_path = nil
+      @map = {}
+      @map[:html] = Hash[*KNOWN_HTML_OPTS.map{|o|[o,false]}.flatten]
+      @map[:markdown] = Hash[*KNOWN_MARKDOWN_OPTS.map{|o|[o,false]}.flatten]
+      @map[:pygments] = {}
+      @map[:css] = []
+      @map[:script] = []
+      @renderer = nil
+      include file_path if file_path
+    end
+
+    def include file_path
+      open file_path do |f|
+        eval f.read
+      end
+    end
+
+    def wrapping_html bool
+      @map[:wrapping_html] = bool
+    end
+
+    def css style
+      raise "expect a String" if not style.kind_of? String
+      @map[:css].push style
+    end
+
+    def script src
+      raise "expect a String" if not src.kind_of? String
+      @map[:script].push src
+    end
+
+    def title_format format
+      if not format.kind_of? String
+        raise "expect a String"
+      end
+      @map[:title_format] = format
+    end
+
+    def enable_html_opts *opts
+      opts.each {|o| html_opt o, true }
+    end
+
+    def disable_html_opts *opts
+      opts.each {|o| html_opt o, false }
+    end
+
+    def enable_markdown_opts *opts
+      opts.each {|o| markdown_opt o, true}
+    end
+
+    def disable_markdown_opts *opts
+      opts.each {|o| markdown_opt o, false}
+    end
+
+    def pygments_opts *args
+      if args.first.kind_of? Hash
+        @map[:pygments].merge! args.first
+      else
+        if args.length != 2
+          raise 'expect a hash or a pair with an option name and a value'
+        end
+        o, v = args
+        raise "unknown pygments option (#{o})" if not KNOWN_PYGMENTS_OPTS.include? o
+        @map[:pygments][o] = v
+      end
+    end
+
+    def html_opt o, v
+      raise "unknown html option (#{o})" if not KNOWN_HTML_OPTS.include? o
+      @map[:html][o] = v
+    end
+
+    def markdown_opt o, v
+      raise "unknown markdown option (#{o})" if not KNOWN_MARKDOWN_OPTS.include? o
+      @map[:markdown][o] = v
+    end
+  end
+end

data/lib/md/renderer.rb

@@ -0,0 +1,114 @@
+# -*- coding:utf-8; mode:ruby; -*-
+
+require 'redcarpet'
+require 'pygments'
+require 'graphviz'
+
+module Md
+  class Renderer < Redcarpet::Render::HTML
+
+    attr_accessor :opts
+
+    def initialize opts = {}
+      super
+      @opts = opts
+      @opts[:pygments] ||= {}
+      @opts[:graphviz] ||= {
+        :format => :svg
+      }
+      @opts[:graphviz][:format] ||= :svg
+      @opts[:wrapping_html] = true if not @opts.key? :wrapping_html
+      @opts[:css] ||= []
+      @opts[:script] ||= []
+      @opts[:title_format] ||= "%s"
+
+      @opts[:css].push Pygments.css @opts[:pygments]
+    end
+
+    def block_code code, lang
+      if lang.casecmp('graphviz') == 0
+        block_code_graphviz code
+      elsif lang.casecmp('graph') == 0
+        block_code_graph code
+      elsif lang.casecmp('digraph') == 0
+        block_code_digraph code
+      else
+        block_code_default code, lang
+      end
+    end
+
+    def block_code_default code, lang
+      @opts[:pygments][:full] = false
+      opts = {:lexer => lang, :options => @opts[:pygments]}
+      return Pygments.highlight code, opts
+    end
+
+    def block_code_digraph code
+      block_code_digraph "digraph g { #{code} }"
+    end
+
+    def block_code_graph code
+      block_code_graphviz "graph g { #{code} }"
+    end
+
+    def block_code_graphviz code
+      opts = {:svg => String}
+      block_code_svg GraphViz.parse_string(code).output(opts)
+    end
+
+    def block_code_svg code
+      remove_doctype_declaration remove_xml_declaration code
+    end
+
+    def remove_doctype_declaration code
+      code.sub(/<!DOCTYPE .+?>/im,'')
+    end
+
+    def remove_xml_declaration code
+      code.sub(/<\?xml .+?\?>/im,'')
+    end
+
+    def postprocess html
+      html = wrapp_with_html html if @opts[:wrapping_html]
+      return html
+    end
+
+    def wrapp_with_html html
+      return "<!DOCTYPE html>\n" +
+        "<html><head>\n" +
+        head_element_content(html) +
+        "</head>\n"+
+        "<body>#{html}</body></html>\n"
+    end
+
+    def head_element_content html
+      content = ""
+
+      content << %{<meta charset="utf-8" />\n}
+
+      title = scrape_title html
+      content << "<title>#{@opts[:title_format]}</title>\n" % title if title
+
+      @opts[:css].each do |style|
+        content << "<style>#{minify_css style}</style>\n"
+      end if @opts[:css]
+
+      @opts[:script].each do |src|
+        content << "<script>\n#{src}\n</script>\n"
+      end if @opts[:script]
+
+      return content
+    end
+
+    # get first h1, h2 or h3 element content
+    def scrape_title html
+      m = html.match(/<h[1-3][^>]*>(.+?)<\/h[1-3]>/)
+      return (m and m[1])
+    end
+
+    # remove space and new line code
+    def minify_css text
+      text.gsub(%r{/\*.+?\*/}, '').gsub(/\s+/,'')
+    end
+  end
+end

data/lib/md/version.rb

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

data/md.gemspec

@@ -0,0 +1,25 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require File.expand_path('../lib/md/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Keiichiro Ui"]
+  gem.email         = ["keiichiro.ui@gmail.com"]
+  gem.summary       = "a markdown engine which makes you to describe a graph with Graphviz and highlight codes"
+  gem.description   = nil
+  gem.homepage      = "http://k-ui.jp/"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "kui-md"
+  gem.require_paths = ["lib"]
+  gem.version       = Md::VERSION
+
+  gem.add_runtime_dependency 'redcarpet', '>= 2'
+  gem.add_runtime_dependency 'pygments.rb'
+  gem.add_runtime_dependency 'ruby-graphviz'
+  gem.add_development_dependency 'rake'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'bundler'
+end

data/spec/cli_spec.rb

@@ -0,0 +1,20 @@
+# -*- coding:utf-8-unix; mode:ruby; -*-
+
+require 'md'
+
+include Md
+
+describe CLI do
+
+  before do
+    @src_file_path = 'foo'
+    @src_file_content = 'foo content'
+    @src_file = mock File
+
+    @renderer = mock Renderer
+    Renderer.stub(:new){ @renderer }
+
+    @cli = CLI.new
+  end
+
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: kui-md
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Keiichiro Ui
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: pygments.rb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: ruby-graphviz
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: ''
+email:
+- keiichiro.ui@gmail.com
+executables:
+- md
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/md
+- example/config.rb
+- lib/md.rb
+- lib/md/cli.rb
+- lib/md/configure.rb
+- lib/md/renderer.rb
+- lib/md/version.rb
+- md.gemspec
+- spec/cli_spec.rb
+homepage: http://k-ui.jp/
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: a markdown engine which makes you to describe a graph with Graphviz and highlight
+  codes
+test_files:
+- spec/cli_spec.rb