CoffeeTags 0.0.2.0 → 0.0.2.2

data/README.md

@@ -1,20 +1,23 @@
 # CoffeeTags
 
-A  simple tool for generating CoffeeScript tags (Ctags compatible ).
-
-Showing only functions (right) or with variables included (left)
+A  simple tool for generating CoffeeScript tags (Ctags compatible).
 
 
-<div class="thumbnail">
+### Example + Screenshot
+Showing only functions (right) or with variables included (left)
 
 <a href="http://skitch.com/plugawy/gyfnb/1-coffeetags-1-vim-unicorn.local-tmux"><img src="http://img.skitch.com/20111012-8cjesum8ru8usqusra4yppj5cc.preview.png" alt="1. CoffeeTags:1:vim - "unicorn.local" (tmux)" /></a><br /><span>Uploaded with <a href="http://skitch.com">Skitch</a>!</span>
 
-</div>
+## Huh?
 
-Designed for use with Vim + [TagBar plugin](https://github.com/majutsushi/tagbar) but also works without it. Simply configure your Vim for use with a regular tags file and generate them with the following command:
+CoffeeTags was created for use with Vim and [TagBar plugin](https://github.com/majutsushi/tagbar), however it
+accepts most common ctags arguments, therefore the following:
 
 `coffeetags -R -f TAGS`
 
+
+will generate standard TAGS file which later can be used with Vim (standard `:tag` command works as expected)
+
 # Requirements
 
 * ruby (either 1.8.7 or 1.9.2)
@@ -22,29 +25,62 @@ Designed for use with Vim + [TagBar plugin](https://github.com/majutsushi/tagbar
 
 ### optional
 
-* [TagBar plugin](https://github.com/majutsushi/tagbar)
+* [TagBar](https://github.com/majutsushi/tagbar)
 
 # Halp!
 
-`coffeetags --help`
-
-    -R - process current directory recursively and look for all *.coffee files
-    --f  <file> - save tags to <file>, if <file> == '-' tags get print out to STDOUT (jscatgs style)
-    --version - coffeetags version
-    --vim-conf - print out tagbar config for vim
-    --include-vars - include objects/variables in generated tags
-    combine --vim-conf and --include-vars to create a config which adds '--include-vars' option
+Just use `coffeetags --help`
 
 # Installation
 
-* get the `coffeetags` tool
+* get `coffeetags`
 
     `gem install CoffeeTags`
 
 
 * add TagBar config to your .vimrc
 
-    `coffeetags --vim-conf >> ~/.vimrc` (or `coffeetags --vim-conf --include-vars >> ~/.vimrc`)
+`coffeetags --vim-conf >> ~/.vimrc`
+
+
+## Config types
+
+CoffeeTags can work in 2 modes:
+
+- tags only for functions (default)
+- tags for functions and objects containing them
+
+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.
 
@@ -53,3 +89,8 @@ Done!
 # TODO
 
 - squash all bugs
+
+
+# License
+
+MIT

data/lib/CoffeeTags/version.rb

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

data/lib/CoffeeTags.rb

@@ -3,6 +3,7 @@ require "CoffeeTags/version"
 require "CoffeeTags/parser"
 require "CoffeeTags/formatter"
 require 'optparse'
+require 'erb'
 
 class Object
   def blank?
@@ -21,41 +22,33 @@ module Coffeetags
 
   class Utils
     def self.tagbar_conf include_vars
-      <<-CONF
-" Add this type definition to your vimrc
-" coffeetags --vim-conf >> <PATH TO YOUR VIMRC>
-" if you want your tags to include vars/objects do:
-" coffeetags --vim-conf --include-vars
- let g:tagbar_type_coffee = {
-  \\ 'kinds' : [
-  \\   'f:functions',
-  \\   'o:object'
-  \\ ],
-  \\ 'kind2scope' : {
-  \\  'f' : 'object',
-  \\   'o' : 'object'
-  \\},
-  \\ 'sro' : ".",
-  \\ 'ctagsbin' : 'coffeetags',
-  \\ 'ctagsargs' : '#{include_vars ?   "--include-vars" : "" } ',
-  \\}
-  CONF
+      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?
       options = {}
       optparse = OptionParser.new do |opts|
-
         opts.banner  = (<<-BAN
+          ---------------------------------------------------------------------
           #{NAME} #{Coffeetags::VERSION}
+          ---------------------------------------------------------------------
           by #{AUTHOR} ( #{URL} )
           Usage:
           coffeetags [OPTIONS] <list of files>
+
+          CoffeeTags + TagBar + Vim ---> https://gist.github.com/1935512
+          ---------------------------------------------------------------------
           BAN
                        ).gsub(/^\s*/,'')
 
-        opts.on('-i', '--include-vars', "Include variables in generated tags") do |o|
+
+        opts.on('--include-vars', "Include variables in generated tags") do |o|
           options[:include_vars] = true
         end
 
@@ -68,10 +61,14 @@ module Coffeetags
           options[:recur] = 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
-
         end
 
         opts.on('-h','--help','HALP') do

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.0.1.8	//
+!_TAG_PROGRAM_VERSION	0.0.2.2	//
 bump	spec/fixtures/test.coffee	/bump/;"	f	lineno:1	object:window	type:function
 ho	spec/fixtures/test.coffee	/ho/;"	f	lineno:5	object:Wat	type:function
 bump	spec/fixtures/test.coffee	/bump/;"	f	lineno:10	object:Wat.ho.@lolWat	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.0.1.8	//
+!_TAG_PROGRAM_VERSION	0.0.2.2	//
 bump	spec/fixtures/test.coffee	/bump/;"	f	lineno:1	object:window	type:function
 ho	spec/fixtures/test.coffee	/ho/;"	f	lineno:5	object:Wat	type:function
 bump	spec/fixtures/test.coffee	/bump/;"	f	lineno:10	object:Wat.ho.@lolWat	type:function

data/tagbar-info.markdown

@@ -0,0 +1,40 @@
+# How to use CoffeeTags with [TagBar ](https://github.com/majutsushi/tagbar)
+
+## Config types
+
+CoffeeTags can work in 2 modes:
+
+- tags only for functions (default)
+- tags for functions and objects containing them
+
+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
+

data/vim/tagbar-coffee.vim.erb

@@ -0,0 +1,15 @@
+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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: CoffeeTags
 version: !ruby/object:Gem::Version 
-  hash: 71
+  hash: 67
   prerelease: 
   segments: 
   - 0
   - 0
   - 2
-  - 0
-  version: 0.0.2.0
+  - 2
+  version: 0.0.2.2
 platform: ruby
 authors: 
 - "\xC5\x81ukasz Korecki"
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-28 00:00:00 +00:00
+date: 2012-03-06 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -57,7 +57,9 @@ files:
 - spec/formatter_spec.rb
 - spec/parser_spec.rb
 - spec/spec_helper.rb
+- tagbar-info.markdown
 - test.rb
+- vim/tagbar-coffee.vim.erb
 has_rdoc: true
 homepage: http://github.com/lukaszkorecki/CoffeeTags
 licenses: []