CoffeeTags 0.1.7 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 --- 
 SHA512: 
-  data.tar.gz: 6ee24af2dd8c15390bc9b048cd457a2b71cf56f9bb0713a1bb63939a798c28c858d727598339c6dc2fe4b817d678bcb3b27c5ab3e4973c81ca803ffd39807844
-  metadata.gz: 1789f5571bfb2dc03298b58f9b09a0f385f1111dffdce7263e492aa4f0929cc8e429512eaefde3472bec0ef73a0c310ecee35fb9f959f43f00a2653489c2da96
+  metadata.gz: 91f1d33e4b9f60700b8ad9f8c08623dc40c4430261779c8f96af4727ff8c9c2f7b61747f8c2e6554c47d14cdd8a4dec31cd3e7a74484ea9c835386fcb056902f
+  data.tar.gz: 2ca1695728468889e80d42e6af100d5be7529ca4d35c7427e908861f5c5aafdcffbe3c0a342a783031b205a2da78e745f903320c9a5284f01b408c537218c01f
 SHA1: 
-  data.tar.gz: e8a6231fd6be1aeab2c16585f4cc31ee0aef9933
-  metadata.gz: 000e886c5bb3b70edab1dfd8b20d455a7a55e85c
+  metadata.gz: 09f5e25db80c8a227e51a6c0e17014419c7c5e73
+  data.tar.gz: 36379f4c63b53f19c6864533135ab9b4e7bb1950

data/.gitignore

@@ -5,3 +5,4 @@ pkg/*
 vendor
 testout/
 test.out
+tags

data/README.md

@@ -1,12 +1,11 @@
 # CoffeeTags
 
-### Latest version: `0.1.7`
+### Latest version: `0.2.1`
 
 A  simple tool for generating CoffeeScript tags (Ctags compatible).
 
 [![Build Status](https://secure.travis-ci.org/lukaszkorecki/CoffeeTags.png?branch=master)](http://travis-ci.org/lukaszkorecki/CoffeeTags)
 
-
 ### [Watch a quick demo](http://ascii.io/a/26)
 
 ### Example + Screenshot
@@ -38,23 +37,46 @@ will generate standard TAGS file which later can be used with Vim (standard `:ta
 
 Just use `coffeetags --help`
 
-# Installation
+# Ruby Gem
+
+## Installation
+
+`gem install CoffeeTags`
+
+## Usage
+
+`$ coffeetags --help`
+
+# Vim
+
+This can also be used as a vim plugin that will update tag files on save, and support visualization with [TagBar](https://github.com/majutsushi/tagbar). You will still need to install the gem as described above as well as install the plugin to vim. You can install it via:
 
-* get `coffeetags`
+## Install
 
-    `gem install CoffeeTags`
+*  [Pathogen](https://github.com/tpope/vim-pathogen)
+  *  `git clone https://github.com/lukaszkorecki/CoffeeTags ~/.vim/bundle/CoffeeTags`
+*  [NeoBundle](https://github.com/Shougo/neobundle.vim)
+  *  `NeoBundle 'lukaszkorecki/CoffeeTags'`
+*  [Vundle](https://github.com/gmarik/vundle)
+  *  `Bundle 'lukaszkorecki/CoffeeTags'`
+*  manual
+  *  copy all of the files into your `~/.vim` directory
 
+## Configuration
 
-## Vim installation
-* add TagBar config to your .vimrc
+In you `~/.vimrc` you can configure the plugin with:
 
-`coffeetags --vim-conf >> ~/.vimrc`
+```
+let g:CoffeeAutoDisabled=<0 or 1>        " Disables autotaging on save (Default: 0 [false])
+let g:CoffeeAutoTagFile=<filename>       " Name of the generated tag file (Default: ./tags)
+let g:CoffeeAutoTagIncludeVars=<0 or 1>  " Includes variables (Default: 0 [false])
+let g:CoffeeAutoTagTagRelative=<0 or 1>  " Sets file names to the relative path from the tag file location to the tag file location (Default: 1 [true])
+```
 
 ## Sublime Text
 
 *TODO* - I don't use ST myself, but PRs with HOWTO are welcomed
 
-
 ## Config types
 
 CoffeeTags can work in 2 modes:
@@ -64,49 +86,13 @@ CoffeeTags can work in 2 modes:
 
 Second mode is activated by adding `--include-vars` to command line arguments
 
-#   CoffeeTags + TagBar + Vim
-
-## Config in  vimrc
-
-You can add the config to your .vimrc (making sure that the old one is removed)
-by:
-
-    coffeetags --vim-conf >> ~/.vimrc
-
-or (for 2nd mode)
-
-    coffeetags --include-vars --vim-conf >> ~/.vimrc
-
-
-## Config as a filetype plugin
-
-You can generate a special filetype plugin and tagbar will use that
-automatically.
-
-This option is preferable if you want to keep your vimrc short.
-
-    coffeetags --vim-conf > ~/.vim/ftplugin/coffee/tagbar-coffee.vim
-    coffeetags [--include-vars] --vim-conf > ~/.vim/ftplugin/coffee/tagbar-coffee.vim
-
-or if you're using pathogen
-
-    coffeetags [--include-vars] --vim-conf > ~/.vim/bundle/coffeetags/ftplugin/coffee/tagbar-coffee.vim
-    coffeetags --vim-conf > ~/.vim/bundle/coffeetags/ftplugin/coffee/tagbar-coffee.vim
-
-
-* open your coffeescript file and open TagBar.
-
-Done!
-
 # TODO
 
 - squash all bugs
 
-
 # License
 
 MIT
 
-
 [![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/lukaszkorecki/coffeetags/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
 

data/lib/CoffeeTags/version.rb

@@ -1,4 +1,4 @@
 # encoding: utf-8
 module Coffeetags
-  VERSION = "0.1.7"
+  VERSION = "0.2.1"
 end

data/lib/CoffeeTags.rb

@@ -22,14 +22,6 @@ module Coffeetags
   URL = "https://github.com/lukaszkorecki/CoffeeTags"
 
   class Utils
-    def self.tagbar_conf include_vars
-      include_vars_opt = include_vars ? "--include-vars" : ''
-
-      tmpl_file = File.read(File.expand_path("../../vim/tagbar-coffee.vim.erb", __FILE__))
-      tmpl = ERB.new(tmpl_file)
-
-      tmpl.result(binding)
-    end
 
     def self.option_parser args
       args << '-h' if args.empty?
@@ -69,11 +61,6 @@ module Coffeetags
           options[:tag_relative] = true
         end
 
-        opts.on('--vim-conf', 'Generate TagBar config (more info https://gist.github.com/1935512 )') do
-          puts tagbar_conf options[:include_vars]
-          exit
-        end
-
         opts.on('-v', '--version', 'Current version') do
           puts Coffeetags::VERSION
           exit

data/plugin/coffee-autotag.vim

@@ -0,0 +1,82 @@
+if exists("g:loaded_coffee_autotag")
+  finish
+endif
+
+let g:loaded_coffee_autotag=1
+
+if !has("ruby")
+  echohl WarningMsg
+  echo "Coffee auto tag requires Vim to be compiled with Ruby support"
+  echohl none
+  finish
+endif
+
+let s:CoffeeAutoTagFile="./tags"
+let s:CoffeeAutoTagIncludeVars=0
+let s:CoffeeAutoTagTagRelative=1
+
+if !exists("g:CoffeeAutoTagDisabled")
+  let g:CoffeeAutoTagDisabled = 0
+endif
+
+if exists("g:CoffeeAutoTagFile")
+  let s:CoffeeAutoTagFile = g:CoffeeAutoTagFile
+endif
+
+if exists("g:CoffeeAutoTagIncludeVars")
+  let s:CoffeeAutoTagIncludeVars = g:CoffeeAutoTagIncludeVars
+endif
+
+if exists("g:CoffeeAutoTagTagRelative")
+  let s:CoffeeAutoTagTagRelative = g:CoffeeAutoTagTagRelative
+endif
+
+if s:CoffeeAutoTagIncludeVars
+  let s:raw_args="--include-vars"
+else
+  let s:raw_args=""
+endif
+
+let g:tagbar_type_coffee = {
+      \   'ctagsbin' : 'coffeetags',
+      \   'ctagsargs' : s:raw_args,
+      \   'kinds' : [
+      \     'f:functions',
+      \     'o:object',
+      \   ],
+      \   'sro' : ".",
+      \   'kind2scope' : {
+      \     'f' : 'object',
+      \     'o' : 'object',
+      \   }
+      \ }
+
+
+function! CoffeeAutoTag()
+  if g:CoffeeAutoTagDisabled
+    finish
+  endif
+
+  let cmd = 'coffeetags --append -f ' . s:CoffeeAutoTagFile . ' '
+
+  if s:CoffeeAutoTagIncludeVars
+    let cmd .= '--include-vars '
+  endif
+
+  if s:CoffeeAutoTagTagRelative
+    let cmd .= '--tag-relative '
+  endif
+
+  let cmd .= expand("%:p")
+
+  let output = system(cmd)
+
+  if exists(":TlistUpdate")
+    TlistUpdate
+  endif
+endfunction
+
+augroup CoffeeAutoTag
+  au!
+  autocmd BufWritePost,FileWritePost *.coffee call CoffeeAutoTag()
+augroup END

data/spec/fixtures/append-expected.ctags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 @filter	spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function
 baz	spec/fixtures/blockcomment.coffee	/^baz : (x, y) ->$/;"	f	lineno:15	object:window	type:function

data/spec/fixtures/append.ctags

@@ -3,8 +3,8 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 !_THIS_LINE_SHOULD_GET_REMOVED	Nothing to see here	//
 @filter	spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function

data/spec/fixtures/blockcomment.ctags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 baz	spec/fixtures/blockcomment.coffee	/^baz : (x, y) ->$/;"	f	lineno:15	object:window	type:function
 echo2	spec/fixtures/blockcomment.coffee	/^echo2 :-> console.log 'echo'$/;"	f	lineno:7	object:window	type:function
 echo3	spec/fixtures/blockcomment.coffee	/^echo3 :-> console.log 'echo'$/;"	f	lineno:23	object:window	type:function

data/spec/fixtures/campfire.js.tags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 bump	spec/fixtures/campfire.coffee	/^  bump : ->$/;"	f	lineno:46	object:Test	type:function
 constructor	spec/fixtures/campfire.coffee	/^  constructor: (api_key, host) ->$/;"	f	lineno:8	object:Campfire	type:function
 handlers	spec/fixtures/campfire.coffee	/^  handlers: (callbacks) ->$/;"	f	lineno:14	object:Campfire	type:function

data/spec/fixtures/out.test-relative-append.ctags

@@ -3,8 +3,8 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 !_THIS_LINE_SHOULD_GET_REMOVED	Nothing to see here	//
 @filter	../spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	../spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function

data/spec/fixtures/out.test-relative.ctags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 @filter	../spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	../spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function
 beam_magnum	../spec/fixtures/test.coffee	/^beam_magnum : -> deployed(true)$/;"	f	lineno:44	object:window	type:function

data/spec/fixtures/out.test-two.ctags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 @filter	spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function
 beam_magnum	spec/fixtures/test.coffee	/^beam_magnum : -> deployed(true)$/;"	f	lineno:44	object:window	type:function

data/spec/fixtures/out.test.ctags

@@ -3,7 +3,7 @@
 !_TAG_PROGRAM_AUTHOR	Łukasz Korecki /lukasz@coffeesounds.com/
 !_TAG_PROGRAM_NAME	CoffeeTags	//
 !_TAG_PROGRAM_URL	https://github.com/lukaszkorecki/CoffeeTags	/GitHub repository/
-!_TAG_PROGRAM_VERSION	0.1.7	//
+!_TAG_PROGRAM_VERSION	0.2.1	//
 @filter	spec/fixtures/test.coffee	/^    @filter = ->$/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/^_loop = (x) ->$/;"	f	lineno:19	object:window	type:function
 beam_magnum	spec/fixtures/test.coffee	/^beam_magnum : -> deployed(true)$/;"	f	lineno:44	object:window	type:function

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: CoffeeTags
 version: !ruby/object:Gem::Version 
-  version: 0.1.7
+  version: 0.2.1
 platform: ruby
 authors: 
 - "\xC5\x81ukasz Korecki"
@@ -38,6 +38,7 @@ files:
 - lib/CoffeeTags/formatter.rb
 - lib/CoffeeTags/parser.rb
 - lib/CoffeeTags/version.rb
+- plugin/coffee-autotag.vim
 - spec/coffeetags_spec.rb
 - spec/fixtures/append-expected.ctags
 - spec/fixtures/append.ctags
@@ -61,7 +62,6 @@ files:
 - spec/spec_helper.rb
 - tagbar-info.markdown
 - test.rb
-- vim/tagbar-coffee.vim.erb
 homepage: http://github.com/lukaszkorecki/CoffeeTags
 licenses: 
 - MIT

data/vim/tagbar-coffee.vim.erb

@@ -1,15 +0,0 @@
-if executable('coffeetags')
-  let g:tagbar_type_coffee = {
-        \ 'ctagsbin' : 'coffeetags',
-        \ 'ctagsargs' : '<%= include_vars_opt %>',
-        \ 'kinds' : [
-        \ 'f:functions',
-        \ 'o:object',
-        \ ],
-        \ 'sro' : ".",
-        \ 'kind2scope' : {
-        \ 'f' : 'object',
-        \ 'o' : 'object',
-        \ }
-        \ }
-endif