CoffeeTags 0.0.1.1

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/CoffeeTags.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "CoffeeTags/version"
+
+Gem::Specification.new do |s|
+  s.name        = "CoffeeTags"
+  s.version     = Coffeetags::VERSION
+  s.authors     = ["Łukasz Korecki"]
+  s.email       = ["lukasz@coffeesounds.com"]
+  s.homepage    = "http://github.com/lukaszkorecki/CoffeeTags"
+  s.summary     = %q{Simple tags generator for CoffeeScript}
+  s.description = %q{CoffeeTags generates tag file for use with TagBar.vim}
+
+  s.rubyforge_project = "CoffeeTags"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/Gemfile

@@ -0,0 +1,18 @@
+source "http://rubygems.org"
+
+gem 'rake'
+# Specify your gem's dependencies in CoffeeTags.gemspec
+gemspec
+
+group :development do
+  gem 'guard'
+  gem 'growl'
+  gem 'guard-rspec'
+
+  # osx
+  gem 'rb-fsevent'
+end
+
+group :test do
+  gem 'rspec', '~> 2.6.0'
+end

data/Guardfile

@@ -0,0 +1,6 @@
+guard 'rspec', :version => 2, :bundler => true, :cli => ' --color', :all_on_start => false     do
+  watch(%r{^spec/(.*).rb$}) { |m| m[0] }
+  watch(%r{^lib/(.*).rb$}) do |m|
+    "spec/#{m[0].split('/').last.split('.').first}_spec.rb"
+  end
+end

data/README.md

@@ -0,0 +1,15 @@
+# CoffeeTags
+
+A tiny, simple tool for generating tags (Ctags compatible ) for use with Vim + [TagBar plugin](https://github.com/majutsushi/tagbar)
+
+It might work with other plugins/editors which can use Ctags (such as Emacs or
+TagList for Vim).
+
+
+# Installation
+
+`gem install CoffeeTags` (when it's released :-))
+
+# TODO
+
+- squash all bugs

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/bin/coffeetags

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'CoffeeTags'
+
+Coffeetags::Utils.option_parser ARGV

data/lib/CoffeeTags.rb

@@ -0,0 +1,73 @@
+# encoding: utf-8
+require "CoffeeTags/version"
+require "CoffeeTags/parser"
+require "CoffeeTags/formatter"
+
+class Object
+  def blank?
+    if self.respond_to? :"empty?"
+      self.nil? or self.empty?
+    else
+      self.nil?
+    end
+  end
+end
+
+module Coffeetags
+  AUTHOR = "Łukasz Korecki /lukasz@coffeesounds.com/"
+  NAME = "CoffeeTags"
+  URL = "https://github.com/lukaszkorecki/CoffeeTags"
+  TAGBAR_COFFEE_CONF = <<-CONF
+ let g:tagbar_type_coffee = {
+  \\ 'kinds' : [
+  \\   'f:functions',
+  \\   'o:object'
+  \\ ],
+  \\ 'kind2scope' : {
+  \\  'f' : 'object',
+  \\   'o' : 'object'
+  \\},
+  \\ 'sro' : ".",
+  \\ 'ctagsbin' : 'coffeetags',
+  \\ 'ctagsargs' : '',
+  \\}
+  CONF
+
+  class Utils
+
+    def self.option_parser args
+      puts "no args!" and return if args.empty?
+      case args.first
+      when /version/
+        STDOUT << Coffeetags::VERSION
+      when 'help'
+        STDOUT << 'coffeetags [version|vim_conf] or path to a coffeescript file'
+      when /vim_conf/
+        puts <<-HELP
+" Add this type definition to your vimrc
+" or do
+" coffeetags vim_conf >> <PATH TO YOUR VIMRC>
+        HELP
+        puts Coffeetags::TAGBAR_COFFEE_CONF
+      else
+        self.run args
+      end
+
+    end
+
+    def self.run files
+      files.each do |file|
+        sc = File.read file
+
+        parser = Coffeetags::Parser.new sc
+        parser.execute!
+
+        formatter = Coffeetags::Formatter.new file, parser.tree
+
+        formatter.parse_tree
+
+        STDOUT << formatter.to_file
+      end
+    end
+  end
+end

data/lib/CoffeeTags/formatter.rb

@@ -0,0 +1,63 @@
+module Coffeetags
+  class Formatter
+    def initialize  file, tree =[]
+      @file = file
+      @tree = tree
+
+      @header = [
+        "!_TAG_FILE_FORMAT	2	/extended format/",
+        "!_TAG_FILE_SORTED	0	/0=unsorted, 1=sorted, 2=foldcase/",
+        "!_TAG_PROGRAM_AUTHOR	#{Coffeetags::AUTHOR}",
+        "!_TAG_PROGRAM_NAME	#{Coffeetags::NAME}	//",
+        "!_TAG_PROGRAM_URL	#{Coffeetags::URL}	/GitHub repository/",
+        "!_TAG_PROGRAM_VERSION	#{Coffeetags::VERSION}	//"
+      ]
+
+      @types = {
+        'f' => 'type:function',
+        'c' => 'type:class',
+        'v' => 'type:var'
+      }
+    end
+
+    def regex_line line
+      "/^#{line}$/;\""
+    end
+
+    def line_to_string entry
+      namespace = (entry[:parent].blank?) ? entry[:name]: entry[:parent]
+      namespace =  namespace == entry[:name] ? '' : "object:#{namespace}"
+
+      [
+        entry[:name],
+        @file,
+        regex_line(entry[:source]),
+        entry[:kind],
+        "lineno:#{entry[:line]}",
+        namespace,
+        @types[entry[:kind]]
+      ].join("\t")
+    end
+
+    def parse_tree
+      @lines = @tree.map do | content|
+        line_to_string content if content[:kind] == 'f'
+      end.reject{|l| l.nil? }
+    end
+
+    def to_file
+      str = ""
+      @header.each do |header|
+        str << header
+        str << "\n"
+      end
+
+      @lines.each do |line|
+        str << line
+        str << "\n"
+      end
+
+      str
+    end
+  end
+end

data/lib/CoffeeTags/parser.rb

@@ -0,0 +1,77 @@
+require 'yaml'
+module Coffeetags
+  class Parser
+    attr_reader :tree
+    def initialize source
+      @source = source
+
+      # tree maps the ... tree :-)
+      @tree = []
+
+      # regexes
+      @class_regex = /^[ \t]*class\s*(\w*)/
+      @var_regex = /([@a-zA-Z0-9_]*)[ \t]*[=:][ \t]*$/
+      @token_regex = /[ \t]*([@a-zA-Z0-9_]*)[ \t]*[:=]/
+    end
+
+    def line_level line
+      line.match(/^[ \t]*/)[0].gsub("\t", " ").split('').length
+    end
+
+    def scope_path _el = nil, _tree = nil
+      bf = []
+      tree = (_tree || @tree)
+      element = (_el || tree.last)
+      idx = tree.index(element) || -1
+
+      current_level = element[:level]
+      tree[0..idx].reverse.each do |_el|
+        # uhmmmmmm
+        if _el[:level] != current_level and _el[:level] < current_level
+          bf << _el[:name]
+          current_level = _el[:level]
+        end
+      end
+      bf.uniq.reverse.join('.')
+
+    end
+
+    def execute!
+      line_n = 0
+      level = 0
+      sc = '__top__'
+      # indentify scopes
+      @source.each_line do |line|
+        line_n += 1
+        level = line_level line
+
+        if (_class = line.match @class_regex)
+          @tree << {
+            :name => _class[1], :level => level
+          }
+        end
+
+        if(var = line.match @var_regex)
+          @tree << {
+            :name => var[1], :level => level
+          }
+        end
+
+        token = line.match @token_regex
+        if not token.nil? and line =~ /-\>/
+          o = {
+              :name => token[1],
+              :level => level,
+              :parent => '',
+              :source => line.chomp,
+              :kind => 'f',
+              :line => line_n
+          }
+          o[:parent] =  scope_path o
+          @tree << o
+        end
+        @tree.uniq!
+      end
+    end
+  end
+end

data/lib/CoffeeTags/version.rb

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

data/spec/fixtures/campfire.coffee

@@ -0,0 +1,45 @@
+# this example is not complete, but shows how to
+# implement an API client using Request class
+class Campfire
+
+  # @api_key - Campfire API keys
+  # @host - your campifre host, for example if you're using trololo.campfirenow.com, then host is 'trololo
+  constructor: (api_key, host) ->
+    @url = "https://#{host}.campfirenow.com/"
+    @auth = { 'username' : api_key, 'password' : 'X'}
+    @headers = { 'Content-Type' : 'application/json' }
+
+  # private function used for parsing JSON responses
+  handlers: (callbacks) ->
+    resp =
+      onSuccess : (response) ->
+        try
+          obj = JSON.parse(response.responseText)
+        catch error
+          console.dir(error)
+          callbacks.onFailure(error)
+        callbacks.onSuccess(obj)
+
+      onFailure: (response) ->
+        console.dir(response)
+        callbacks.onFailure(response)
+
+  # get list of rooms
+  rooms: (callbacks) ->
+    new Request(@url, @headers, @auth).get 'rooms.json', this.handlers(callbacks)
+
+  # get information about a room
+  # @id - room id
+  roomInfo: (id, callbacks) ->
+    new Request(@url, @headers, @auth).get "room/#{id}.json", this.handlers(callbacks)
+
+  # get latest messages and events from a room
+  # @id - room id
+  # @since - optional since id parameter
+  recent: (id, since, callbacks) ->
+    url = "room/#{id}/recent.json"
+    url += "?since_message_id=#{since}" if since
+    new Request(@url, @headers, @auth).get url, this.handlers(callbacks)
+
+class Test
+  bump : ->

data/spec/fixtures/campfire.js

@@ -0,0 +1,49 @@
+(function() {
+  var Campfire;
+  window.Campfire = Campfire = (function() {
+    function Campfire(api_key, host) {
+      this.url = "https://" + host + ".campfirenow.com/";
+      this.auth = {
+        'username': api_key,
+        'password': 'X'
+      };
+      this.headers = {
+        'Content-Type': 'application/json'
+      };
+    }
+    Campfire.prototype.handlers = function(callbacks) {
+      var resp;
+      return resp = {
+        onSuccess: function(response) {
+          var obj;
+          try {
+            obj = JSON.parse(response.responseText);
+          } catch (error) {
+            console.dir(error);
+            callbacks.onFailure(error);
+          }
+          return callbacks.onSuccess(obj);
+        },
+        onFailure: function(response) {
+          console.dir(response);
+          return callbacks.onFailure(response);
+        }
+      };
+    };
+    Campfire.prototype.rooms = function(callbacks) {
+      return new Request(this.url, this.headers, this.auth).get('rooms.json', this.handlers(callbacks));
+    };
+    Campfire.prototype.roomInfo = function(id, callbacks) {
+      return new Request(this.url, this.headers, this.auth).get("room/" + id + ".json", this.handlers(callbacks));
+    };
+    Campfire.prototype.recent = function(id, since, callbacks) {
+      var url;
+      url = "room/" + id + "/recent.json";
+      if (since) {
+        url += "?since_message_id=" + since;
+      }
+      return new Request(this.url, this.headers, this.auth).get(url, this.handlers(callbacks));
+    };
+    return Campfire;
+  })();
+}).call(this);

data/spec/fixtures/campfire.js.tags

@@ -0,0 +1,13 @@
+!_TAG_FILE_FORMAT	2	/extended format/
+!_TAG_FILE_SORTED	0	/0=unsorted, 1=sorted, 2=foldcase/
+!_TAG_PROGRAM_AUTHOR	Patrick Walton	/pwalton@mozilla.com/
+!_TAG_PROGRAM_NAME	jsctags	//
+!_TAG_PROGRAM_URL	http://github.com/pcwalton/jsctags	/GitHub repository/
+!_TAG_PROGRAM_VERSION	0.1	//
+Campfire	examples/campfire.js	/^    function Campfire(api_key, host) {$/;"	f	lineno:4	type:void function(any, any)
+constructor	examples/campfire.js	/^    function Campfire(api_key, host) {$/;"	f	lineno:4	namespace:Campfire.prototype	type:void function(any, any)
+handlers	examples/campfire.js	/^    Campfire.prototype.handlers = function(callbacks) {$/;"	f	lineno:14	namespace:Campfire.prototype	type:Object function(any)
+prototype	examples/campfire.js	/^    Campfire.prototype.handlers = function(callbacks) {$/;"	v	lineno:14	namespace:Campfire	type:Campfire
+rooms	examples/campfire.js	/^    Campfire.prototype.rooms = function(callbacks) {$/;"	f	lineno:33	namespace:Campfire.prototype	type:any function(any)
+roomInfo	examples/campfire.js	/^    Campfire.prototype.roomInfo = function(id, callbacks) {$/;"	f	lineno:36	namespace:Campfire.prototype	type:any function(any, any)
+recent	examples/campfire.js	/^    Campfire.prototype.recent = function(id, since, callbacks) {$/;"	f	lineno:39	namespace:Campfire.prototype	type:any function(any, any, any)

data/spec/fixtures/test.coffee

@@ -0,0 +1,13 @@
+bump = (wat) ->
+  v = 'test'
+
+Wat =
+  ho : (x) ->
+    x = 'o'
+    console.log 'ahhhh'
+    @lolWat =
+      bump : ->
+        console.log 'bump'
+      bump_up : ->
+        console.log 'bump up'
+    @BOOO__up = -> z()

data/spec/fixtures/test_tree.yaml

@@ -0,0 +1,35 @@
+---
+- :source: bump = (wat) ->
+  :parent: ""
+  :kind: f
+  :name: bump
+  :line: 1
+  :level: 0
+- :name: Wat
+  :level: 0
+- :source: "  ho : (x) ->"
+  :parent: Wat
+  :kind: f
+  :name: ho
+  :line: 5
+  :level: 2
+- :name: '@lolWat'
+  :level: 4
+- :source: "      bump : ->"
+  :parent: 'Wat.ho.@lolWat'
+  :kind: f
+  :name: bump
+  :line: 9
+  :level: 6
+- :source: "      bump_up : ->"
+  :parent: 'Wat.ho.@lolWat'
+  :kind: f
+  :name: bump_up
+  :line: 11
+  :level: 6
+- :source: "    @BOOO__up = -> z()"
+  :parent: Wat.ho
+  :kind: f
+  :name: '@BOOO__up'
+  :line: 13
+  :level: 4

data/spec/fixtures/tree.yaml

@@ -0,0 +1,55 @@
+---
+- :name: Campfire
+  :level: 0
+- :parent: Campfire
+  :name: constructor
+  :line: 7
+  :kind: f
+  :source: "  constructor: (api_key, host) ->"
+  :level: 2
+- :parent: Campfire
+  :name: handlers
+  :line: 13
+  :kind: f
+  :source: '  handlers: (callbacks) ->'
+  :level: 2
+- :name: resp
+  :level: 4
+- :parent: Campfire.handlers.resp
+  :name: onSuccess
+  :line: 15
+  :kind: f
+  :source: '      onSuccess : (response) ->'
+  :level: 6
+- :parent: Campfire.handlers.resp
+  :name: onFailure
+  :line: 23
+  :kind: f
+  :source: '      onFailure: (response) ->'
+  :level: 6
+- :parent: Campfire
+  :name: rooms
+  :line: 28
+  :kind: f
+  :source: '  rooms: (callbacks) ->'
+  :level: 2
+- :parent: Campfire
+  :name: roomInfo
+  :line: 33
+  :kind: f
+  :source: '  roomInfo: (id, callbacks) ->'
+  :level: 2
+- :parent: Campfire
+  :name: recent
+  :line: 39
+  :kind: f
+  :source: '  recent: (id, since, callbacks) ->'
+  :level: 2
+- :name: Test
+  :level: 0
+- :parent: Test
+  :name: bump
+  :line: 45
+  :kind: f
+  :source: '  bump : ->'
+  :level: 2

data/spec/formatter_spec.rb

@@ -0,0 +1,26 @@
+require './lib/CoffeeTags'
+
+describe 'CoffeeTags::Formatter' do
+  before :each do
+    @tree = YAML::load_file './spec/fixtures/tree.yaml'
+  end
+
+  it "works!" do
+    lambda { Coffeetags::Formatter.new 'lol.coffee' }.should_not raise_exception
+  end
+
+  before :each do
+    @instance = Coffeetags::Formatter.new 'test.coffee', @tree
+  end
+
+  it "generates a line for method definition" do
+    exp = 'constructor	test.coffee	/^  constructor: (api_key, host) ->$/;"	f	lineno:7	object:Campfire	type:function'
+    @instance.parse_tree.first.should == exp
+  end
+
+  it "generates line for second class" do
+    exp = 'bump	test.coffee	/^  bump : ->$/;"	f	lineno:45	object:Test	type:function'
+    @instance.parse_tree.last.should == exp
+  end
+
+end

data/spec/parser_spec.rb

@@ -0,0 +1,86 @@
+require './lib/CoffeeTags'
+describe 'CoffeeTags::Parser' do
+  before :all do
+    @campfire_class = File.read File.expand_path('./spec/fixtures/campfire.coffee')
+    @test_file = File.read File.expand_path('./spec/fixtures/test.coffee')
+    @test_tree = YAML::load_file File.expand_path('./spec/fixtures/test_tree.yaml')
+    @cf_tree = YAML::load_file File.expand_path('./spec/fixtures/tree.yaml')
+
+  end
+
+  it "should work" do
+    lambda { Coffeetags::Parser.new "\n" }.should_not raise_exception
+  end
+
+
+  context 'detect item level' do
+    before :each do
+      @parser = Coffeetags::Parser.new ''
+    end
+
+    it 'gets level from a string with no indent' do
+      @parser.line_level("zooo").should == 0
+    end
+
+    it "gets level from spaces" do
+      @parser.line_level("    def lol").should == 4
+    end
+
+    it "gets level from tabs" do
+      @parser.line_level("\t\t\tdef lol").should == 3
+    end
+  end
+
+
+  context "Creating scope path" do
+    before(:each) do
+      @parser = Coffeetags::Parser.new ''
+    end
+    it 'gets the scope path for first function' do
+      @parser.scope_path(@cf_tree[1], @cf_tree[0...1] ).should == 'Campfire'
+    end
+
+    it 'gets the scope path for second function' do
+      @parser.scope_path(@cf_tree[2], @cf_tree[0..1] ).should == 'Campfire'
+    end
+
+    it "gets the scope for nested function" do
+      @parser.scope_path(@cf_tree[4], @cf_tree[0..3]).should == 'Campfire.handlers.resp'
+    end
+
+    it "gets the scope of a function which comes after nested function" do
+
+      @parser.scope_path(@cf_tree[6], @cf_tree[0..5]).should == 'Campfire'
+    end
+
+    it 'gets scope for last method defined in diff class' do
+      @parser.scope_path(@cf_tree.last, @cf_tree).should == 'Test'
+    end
+  end
+
+  context 'Parsing' do
+    context 'Scoping' do
+      before(:each) do
+        @coffee_parser = Coffeetags::Parser.new @campfire_class
+        @test_parser = Coffeetags::Parser.new @test_file
+      end
+
+      it "generates the scope list" do
+        @coffee_parser.execute!
+        @coffee_parser.tree.should == @cf_tree
+      end
+    end
+  end
+
+  context 'Test.coffee parsing' do
+    before(:each) do
+      @parser_test = Coffeetags::Parser.new @test_file
+      @parser_test.execute!
+    end
+
+    it "generates the tree for test.coffee" do
+      @parser_test.tree.should == @test_tree
+    end
+
+  end
+end

data/test.rb

@@ -0,0 +1,4 @@
+require './lib/CoffeeTags'
+require 'yaml'
+
+Coffeetags::Utils.option_parser ARGV

metadata

@@ -0,0 +1,80 @@
+--- !ruby/object:Gem::Specification
+name: CoffeeTags
+version: !ruby/object:Gem::Version
+  version: 0.0.1.1
+  prerelease: 
+platform: ruby
+authors:
+- Łukasz Korecki
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-09-22 00:00:00.000000000Z
+dependencies: []
+description: CoffeeTags generates tag file for use with TagBar.vim
+email:
+- lukasz@coffeesounds.com
+executables:
+- coffeetags
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- CoffeeTags.gemspec
+- Gemfile
+- Guardfile
+- README.md
+- Rakefile
+- bin/coffeetags
+- lib/CoffeeTags.rb
+- lib/CoffeeTags/formatter.rb
+- lib/CoffeeTags/parser.rb
+- lib/CoffeeTags/version.rb
+- spec/fixtures/campfire.coffee
+- spec/fixtures/campfire.js
+- spec/fixtures/campfire.js.tags
+- spec/fixtures/test.coffee
+- spec/fixtures/test_tree.yaml
+- spec/fixtures/tree.yaml
+- spec/formatter_spec.rb
+- spec/parser_spec.rb
+- test.rb
+homepage: http://github.com/lukaszkorecki/CoffeeTags
+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'
+      segments:
+      - 0
+      hash: 2103132400043761592
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 2103132400043761592
+requirements: []
+rubyforge_project: CoffeeTags
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Simple tags generator for CoffeeScript
+test_files:
+- spec/fixtures/campfire.coffee
+- spec/fixtures/campfire.js
+- spec/fixtures/campfire.js.tags
+- spec/fixtures/test.coffee
+- spec/fixtures/test_tree.yaml
+- spec/fixtures/tree.yaml
+- spec/formatter_spec.rb
+- spec/parser_spec.rb