marktag 0.0.1

data/.gitignore

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

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,32 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'minitest' do
+  # with Minitest::Unit
+  watch(%r|^test/(.*)\/?test_(.*)\.rb|)
+  watch(%r|^lib/marktag.rb|)     { |m| "test/test_marktag.rb" }
+  watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "test/#{m[1]}test_#{m[2]}.rb" }
+  watch(%r|^test/test_helper\.rb|)    { "test" }
+
+  # with Minitest::Spec
+  # watch(%r|^spec/(.*)_spec\.rb|)
+  # watch(%r|^lib/(.*)([^/]+)\.rb|)     { |m| "spec/#{m[1]}#{m[2]}_spec.rb" }
+  # watch(%r|^spec/spec_helper\.rb|)    { "spec" }
+
+  # Rails 3.2
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/controllers/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+  
+  # Rails
+  # watch(%r|^app/controllers/(.*)\.rb|) { |m| "test/functional/#{m[1]}_test.rb" }
+  # watch(%r|^app/helpers/(.*)\.rb|)     { |m| "test/helpers/#{m[1]}_test.rb" }
+  # watch(%r|^app/models/(.*)\.rb|)      { |m| "test/unit/#{m[1]}_test.rb" }  
+end
+
+guard :shell do
+  watch("lib/marktag.rb") { |m|
+    system "gem build marktag.gemspec"
+    system "gem install --no-ri --no-rdoc marktag-0.0.1.gem"
+  }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Taku Okawa
+
+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,81 @@
+# Marktag
+
+## What is this program for
+
+This is to hadd markdown support for Vim Tagbar plugin.
+It generates ctags file for markdown document. 
+
+![tagbar](https://github.com/t4ku/marktag/raw/master/screenshot.png "screenshot")
+
+## About Ctags and Vim Tagbar  plugin
+
+Tagbar is a vim plugin that helps navigating within file
+using ctags. Currently, Tagbar support markdown file through ctags language definition.
+And it doesn't support nesting headers.
+
+~/.ctags
+```
+--langdef=markdown
+--langmap=markdown:.mkd
+--regex-markdown=/^#[ \t]+(.*)/\1/h,Heading_L1/
+--regex-markdown=/^##[ \t]+(.*)/\1/i,Heading_L2/
+--regex-markdown=/^###[ \t]+(.*)/\1/k,Heading_L3/
+```
+
+~/.vimrc
+```
+let g:tagbar_type_markdown = {
+  \ 'ctagstype' : 'markdown',
+  \ 'kinds' : [
+    \ 'h:Heading_L1',
+    \ 'i:Heading_L2',
+    \ 'k:Heading_L3'
+  \ ]
+\ }
+```
+See [Support for additional types](https://github.com/majutsushi/tagbar/wiki)
+
+Since Tagbar can be conigured to use different 
+program to generate tag files, I made this script to 
+generate tag file Tabgar is happy with.
+
+## Install
+
+Install the gems.
+
+```
+    $ gem install marktag
+```
+
+Add following in your ~/.vimrc
+
+```
+if executable('marktag')
+    let g:tagbar_type_markdown = {
+        \ 'ctagstype' : 'markdown',
+        \ 'ctagsbin' : 'marktag',
+        \ 'kinds' : [
+            \ 'h:header'
+        \ ],
+        \ 'sro' : '.',
+        \ 'kind2scope' : {
+            \ 'h' : 'header'
+        \  },
+        \ 'scope2kind' : {
+            \ 'header' : 'h'
+        \ }
+    \ }
+end
+```
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+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 @@
+require "bundler/gem_tasks"

data/bin/marktag

@@ -0,0 +1,3 @@
+require "marktag"
+
+MarkTag.run(ARGV)

data/lib/marktag.rb

@@ -0,0 +1,111 @@
+require "marktag/version"
+require "redcarpet"
+
+module MarkTag
+  class << self
+    def get_renderer
+      return Redcarpet::Markdown.new(ParserProxy::HeaderFilter)
+    end
+
+    def run(args)
+      if args.size > 0
+        file = args.last
+        if File.exists?(file)
+          markdown = File.read(file)
+          renderer = get_renderer()
+          # get TagRenderer from Redcarpet postprocess hook
+          tag_renderer =  renderer.render(markdown)
+          # print tag file with given file path
+          print tag_renderer.render(file)
+        end
+      end
+    end
+  end
+
+  module ParserProxy
+    class HeaderProxy
+      class <<self
+        attr_accessor :headers
+        def init_document
+          @headers = []
+        end
+
+        def push(header_args)
+          @headers.push(header_args)
+        end
+      end
+    end
+    # 
+    # Redcarpet::Render::HTML
+    #
+    # https://github.com/vmg/redcarpet
+    # How to extend the redcarpet 2 Markdown library?
+    # http://dev.af83.com/2012/02/27/howto-extend-the-redcarpet2-markdown-lib.html
+
+    class HeaderFilter < Redcarpet::Render::HTML
+       def header(header,header_level)
+         unless @proxy
+           @proxy = HeaderProxy
+           @proxy.init_document
+         end
+         @proxy.push([header,header_level])
+         # unless we want html output, we don't have to return anything
+         nil
+       end
+
+       # RedCarpet Post-process hook
+       def postprocess(doc)
+         TagRenderer.new(@proxy.headers)
+       end
+    end
+  end
+
+  class TagRenderer
+    def initialize(headers)
+      @headers = headers
+    end
+
+    def render(file_path)
+      tag = ""
+      level_headers = []
+      @headers.each_with_index do |header,idx|
+        level = header.last - 1
+        level_headers[level] = header.first
+        name  = header.first
+
+        header_identifier = get_header_identifier(level_headers,level)
+        # esq_name = name.gsub(/\s/,"_")
+        esq_name = name
+
+        if (header_identifier)
+          tag += "#{esq_name}\t#{file_path}\t/^\\.\\*#{name}$/;\"\th\t#{header_identifier}"
+        else
+          tag += "#{esq_name}\t#{file_path}\t/^\\.\\*#{name}$/;\"\th"
+        end
+
+        tag += "\n"
+      end
+      return tag
+    end
+
+    def get_header_identifier(level_headers,target_level)
+      if (target_level) == 0
+        return nil
+      end
+
+      identifiers = []
+      (target_level -1).downto(0) do |l|
+        identifier = level_headers.values_at(l) != nil  ? level_headers[l] : "none"
+        identifiers.push(identifier)
+      end
+
+      ctag_class = "header:"
+      header_str = identifiers.reverse.map do |i|
+        i
+        #i.gsub(/\s/,"_")
+      end.join "."
+
+      return ctag_class + header_str
+    end
+  end
+end

data/lib/marktag/version.rb

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

data/marktag.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marktag/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = "marktag"
+  gem.version       = Marktag::VERSION
+  gem.authors       = ["Taku Okawa"]
+  gem.email         = ["taku.okawa@gmail.com"]
+  gem.description   = %q{Write a gem description}
+  gem.summary       = %q{Write a gem summary}
+  gem.homepage      = ""
+
+  gem.add_dependency('redcarpet')
+
+  gem.add_development_dependency('guard')
+  gem.add_development_dependency('guard-minitest')
+  gem.add_development_dependency('guard-shell')
+
+  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.require_paths = ["lib"]
+end

data/marktag.vim

@@ -0,0 +1,16 @@
+if executable('marktag')
+    let g:tagbar_type_markdown = {
+        \ 'ctagstype' : 'markdown',
+        \ 'ctagsbin' : 'marktag',
+        \ 'kinds' : [
+            \ 'h:header'
+        \ ],
+        \ 'sro' : '.',
+        \ 'kind2scope' : {
+            \ 'h' : 'header'
+        \  },
+        \ 'scope2kind' : {
+            \ 'header' : 'h'
+        \ }
+    \ }
+end

data/plugin/tagbar-markdown.vim

@@ -0,0 +1,9 @@
+if executable('marktag')
+  let g:tagbar_type_markdown = {
+    \ 'ctagsbin'  : 'marktag',
+    \ 'ctagstype' : 'markdown',
+    \ 'kinds' : [
+      \ 'h:Heading'
+    \ ]
+  \ }
+endif

data/test/test_marktag.rb

@@ -0,0 +1,82 @@
+require "marktag"
+require "minitest/autorun"
+
+
+class HeaderFilterTest < MiniTest::Unit::TestCase
+  def test_filter_capture_all_headers
+    md = Redcarpet::Markdown.new(MarkTag::ParserProxy::HeaderFilter)
+
+    md_text = <<-EOS
+first header
+============
+
+second header
+------------
+
+### third header
+EOS
+
+    md_tag = <<-EOS
+first_header lib/marktag.rb /^first header$/;" h
+second_header lib/marktag.rb /^second header$/;" h header:first_header
+third_header lib/marktag.rb /^third header$/;" h header:first_header:second_header
+EOS
+
+   # This is the tag file of this ruby script
+   # 
+   # Document  lib/marktag.rb  /^  module Document$/;" m class:MarkTag
+   # Element lib/marktag.rb  /^    class Element$/;" c class:MarkTag.Document
+   # MarkTag lib/marktag.rb  /^module MarkTag$/;"  m
+   # ...
+   # 
+   # In the case of 
+   # Markdown Title > Tutorial > ctags file format
+   # 
+   # Markdown Title   path/to/markdown  /^Markdown Title$/;" heading
+   # Tutorial  path/to/markdown  /^Tutorial$/;" h heading:Markdown Title
+   # ctags file format   path/to/markdown  /^ctags file format$/;" h heading:Markdown Title.Tutorial
+   # 
+   # Exuberant Ctags
+   # http://en.wikipedia.org/wiki/Ctags#Exuberant_Ctags_2
+   # {tagname}<Tab>{tagfile}<Tab>{tagaddress}[;"<Tab>{tagfield}...]
+
+    assert_equal  md_tag,md.render(md_text)
+   end
+
+  def test_headers_with_paragrahs
+    md = Redcarpet::Markdown.new(MarkTag::ParserProxy::HeaderFilter)
+
+    md_text = <<-EOS
+first header
+============
+
+first paragraph
+
+second header
+------------
+
+second paragraph
+
+### third header
+
+third paragraph
+
+EOS
+
+    md_tag = <<-EOS
+first_header lib/marktag.rb /^first header$/;" h
+second_header lib/marktag.rb /^second header$/;" h header:first_header
+third_header lib/marktag.rb /^third header$/;" h header:first_header:second_header
+EOS
+
+    assert_equal md_tag,md.render(md_text)
+  end
+
+  def test_invalid_sequence_of_headers
+  end
+end
+
+class RendererTest < MiniTest::Unit::TestCase
+  def setup
+  end
+end

metadata

@@ -0,0 +1,127 @@
+--- !ruby/object:Gem::Specification
+name: marktag
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Taku Okawa
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-04 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: '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: guard
+  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: guard-minitest
+  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: guard-shell
+  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: Write a gem description
+email:
+- taku.okawa@gmail.com
+executables:
+- marktag
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/marktag
+- lib/.marktag.rb.swp
+- lib/marktag.rb
+- lib/marktag/version.rb
+- marktag.gemspec
+- marktag.vim
+- plugin/tagbar-markdown.vim
+- screenshot.png
+- test/test_marktag.rb
+homepage: ''
+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: Write a gem summary
+test_files:
+- test/test_marktag.rb
+has_rdoc: