CoffeeTags 0.0.2.2 → 0.0.2.4

data/README.md

@@ -2,6 +2,8 @@
 
 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)
+
 
 ### Example + Screenshot
 Showing only functions (right) or with variables included (left)

data/lib/CoffeeTags/formatter.rb

@@ -1,5 +1,7 @@
 module Coffeetags
   class Formatter
+    # Generates CTAGS header
+    # @returns [String] ctags header
     def self.header
       return [
         "!_TAG_FILE_FORMAT	2	/extended format/",
@@ -11,6 +13,10 @@ module Coffeetags
       ].map { |h| "#{h}\n"}.join ''
     end
 
+    # New Formatter class
+    #
+    # @param [String] file file name
+    # @param [Array] tree parse tree for given file generated by Coffeetags::Parser
     def initialize  file, tree =[]
       @file = file
       @tree = tree
@@ -26,6 +32,7 @@ module Coffeetags
     end
 
 
+    # Helper function for formatting a source line into regex
     def regex_line line
       "/#{line}/;\""
     end
@@ -47,8 +54,9 @@ module Coffeetags
 
     def parse_tree
       @lines = @tree.map do | content|
-      line_to_string content  unless content[:line].nil? or content[:name].blank?
-      end.reject{|l| l.nil? }
+        line_to_string content  unless content[:line].nil? or content[:name].blank?
+      end
+      @lines.reject{|l| l.nil? }
     end
 
 

data/lib/CoffeeTags/parser.rb

@@ -1,6 +1,11 @@
 module Coffeetags
   class Parser
     attr_reader :tree
+    # Creates a new parser
+    #
+    # @param [String] source source of the CoffeeScript file
+    # @param [Bool] include_vars include objects in generated tree (default false)
+    # @return [Coffeetags::Parser]
     def initialize source, include_vars = false
       @include_vars = include_vars
       @source = source
@@ -17,12 +22,46 @@ module Coffeetags
       @var_regex = /([@a-zA-Z0-9_]*)\s*[=:]{1}\s*$/
       @token_regex = /([@a-zA-Z0-9_]*)\s*[:=]{1}/
       @iterator_regex = /^\s*for\s*([a-zA-Z0-9_]*)\s*/
+      @comment_regex = /^\s*#/
+      @block_comment_regex = /^\s*###/
+      @comment_lines = mark_commented_lines
     end
 
+
+    # Mark line numbers as commented out
+    # either by single line comment (#)
+    # or block comments (###~###)
+    def mark_commented_lines
+      [].tap do |reg|
+        in_block_comment = false
+        @source.each_with_index do |line, index|
+          line_no = index+1
+
+          in_block_comment =  !(in_block_comment) if line =~ @block_comment_regex
+          reg << line_no if in_block_comment
+          reg << line_no if line =~ @comment_regex and not in_block_comment
+        end
+      end
+    end
+
+    # Detect current line level based on indentation
+    # very useful in parsing, since CoffeeScript's syntax
+    # depends on whitespace
+    # @param [String] line currently parsed line
+    # @return  [Integer]
     def line_level line
       line.match(/^[ \t]*/)[0].gsub("\t", " ").split('').length
     end
 
+    # Generate current scope path, for example:
+    #   e  ->
+    #     f ->
+    #       z ->
+    # Scope path for function z would be:
+    # window.e.f
+    # @param [Hash, nil] _el element of a prase tree (last one for given tree is used by default)
+    # @param [Array, nil] _tree parse tree (or currently built)
+    # @returns [String] string representation of scope for given element
     def scope_path _el = nil, _tree = nil
       bf = []
       tree = (_tree || @tree)
@@ -38,40 +77,63 @@ module Coffeetags
         end
       end
       bf.uniq.reverse.join('.')
+    end
 
+    # Helper function for generating parse tree elements for given
+    # line and regular expression
+    #
+    # @param [String] line source line currently being parsed
+    # @param [RegExp] regex regular expression for matching a syntax element
+    # @param [Integer] level current indentation/line level
+    # @param [Hash, {}] additional_fields additional fields which need to be added to generated element
+    # @returns [Hash,nil] returns a parse tree element consiting of:
+    #   :name of the element
+    #   indentation :level of the element
+    def item_for_regex line,  regex, level, additional_fields={}
+      if item = line.match(regex)
+        entry_for_item = {
+          :name => item[1],
+          :level => level
+        }
+        entry_for_item.merge(additional_fields)
+      end
     end
 
+    # Parse the source and create a tags tree
+    # @note this method mutates @tree instance variable of Coffeetags::Parser instance
+    # @returns self it can be chained
     def execute!
       line_n = 0
       level = 0
-      # indentify scopes
       @source.each_line do |line|
         line_n += 1
+        # indentify scopes
         level = line_level line
 
         # ignore comments!
-        next if  line =~ /^\s*#/
-
-          # FIXME this could be DRYied
-          if (_class = line.match @class_regex)
-            @tree << { :name => _class[1], :level => level }
+        next if @comment_lines.include? line_n
+
+        # extract elements for given line
+        [
+          @class_regex,
+          @proto_meths,
+          @var_regex
+        ].each do |regex|
+          mt = item_for_regex line, regex, level
+          @tree << mt unless mt.nil?
         end
 
-        if(_proto  = line.match @proto_meths)
-          @tree << { :name => _proto[1], :level => level }
-        end
 
-        if(var = line.match @var_regex)
-          @tree << { :name => var[1], :level => level }
-        end
+        # does this line contain a block?
+        mt = item_for_regex line, @block, level, :kind => 'b'
+        @tree << mt unless mt.nil?
 
-        if(_block = line.match @block)
-          @tree << { :name => _block[1], :level => level , :kind => 'b'}
-        end
 
+        # instance variable or iterator (for/in)?
         token = line.match(@token_regex )
         token ||=  line.match(@iterator_regex)
 
+        # we have found something!
         if not token.nil?
           o = {
             :name => token[1],
@@ -85,8 +147,8 @@ module Coffeetags
           # - if a line containes a line like:  element.getElement('type=[checkbox]').lol()
           is_in_string = line =~ /.*['"].*#{token[1]}.*=.*["'].*/
 
-            # - scope access and comparison in if x == 'lol'
-            is_in_comparison = line =~ /::|==/
+          # - scope access and comparison in if x == 'lol'
+          is_in_comparison = line =~ /::|==/
 
           # - objects with blank parent (parser bug?)
           has_blank_parent = o[:parent] =~ /\.$/
@@ -95,7 +157,7 @@ module Coffeetags
           is_previous_not_the_same = !(@tree.last and @tree.last[:name] == o[:name] and  @tree.last[:level] == o[:level])
 
           if is_in_string.nil? and is_in_comparison.nil? and has_blank_parent.nil? and is_previous_not_the_same
-            o[:kind] =  line =~ /[:=]{1}.*[-=]\>/ ? 'f' : 'o'
+            o[:kind]   =  line =~ /[:=]{1}.*[-=]\>/ ? 'f' : 'o'
             o[:parent] =  scope_path o
             o[:parent] = @fake_parent if o[:parent].empty?
 
@@ -103,7 +165,9 @@ module Coffeetags
             @tree << o if o[:kind] == 'o' and @include_vars
           end
         end
+        # get rid of duplicate entries
         @tree.uniq!
+        self # chain!
       end
     end
   end

data/lib/CoffeeTags/version.rb

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

data/spec/fixtures/blockcomment.coffee

@@ -0,0 +1,7 @@
+###
+Lol wut
+echo : ->
+echoes
+###
+
+echo2 :-> console.log 'echo'

data/spec/fixtures/blockcomment.ctags

@@ -0,0 +1,7 @@
+!_TAG_FILE_FORMAT	2	/extended format/
+!_TAG_FILE_SORTED	0	/0=unsorted, 1=sorted, 2=foldcase/
+!_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.2.4	//
+echo2	spec/fixtures/blockcomment.coffee	/echo2/;"	f	lineno:7	object:window	type:function

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

@@ -3,20 +3,29 @@
 !_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.2.2	//
+!_TAG_PROGRAM_VERSION	0.0.2.4	//
 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
 bump_up	spec/fixtures/test.coffee	/bump_up/;"	f	lineno:12	object:Wat.ho.@lolWat	type:function
 @filter	spec/fixtures/test.coffee	/@filter/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/_loop/;"	f	lineno:19	object:window	type:function
+
+
+
+
 bound_func	spec/fixtures/test.coffee	/bound_func/;"	f	lineno:41	object:window	type:function
 beam_magnum	spec/fixtures/test.coffee	/beam_magnum/;"	f	lineno:44	object:window	type:function
+
 constructor	spec/fixtures/campfire.coffee	/constructor/;"	f	lineno:8	object:Campfire	type:function
 handlers	spec/fixtures/campfire.coffee	/handlers/;"	f	lineno:14	object:Campfire	type:function
+
 onSuccess	spec/fixtures/campfire.coffee	/onSuccess/;"	f	lineno:16	object:Campfire.handlers.resp	type:function
 onFailure	spec/fixtures/campfire.coffee	/onFailure/;"	f	lineno:24	object:Campfire.handlers.resp	type:function
 rooms	spec/fixtures/campfire.coffee	/rooms/;"	f	lineno:29	object:Campfire	type:function
 roomInfo	spec/fixtures/campfire.coffee	/roomInfo/;"	f	lineno:34	object:Campfire	type:function
 recent	spec/fixtures/campfire.coffee	/recent/;"	f	lineno:40	object:Campfire	type:function
+
 bump	spec/fixtures/campfire.coffee	/bump/;"	f	lineno:46	object:Test	type:function

data/spec/fixtures/out.test.ctags

@@ -3,12 +3,18 @@
 !_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.2.2	//
+!_TAG_PROGRAM_VERSION	0.0.2.4	//
 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
 bump_up	spec/fixtures/test.coffee	/bump_up/;"	f	lineno:12	object:Wat.ho.@lolWat	type:function
 @filter	spec/fixtures/test.coffee	/@filter/;"	f	lineno:14	object:Wat.ho	type:function
 _loop	spec/fixtures/test.coffee	/_loop/;"	f	lineno:19	object:window	type:function
+
+
+
+
 bound_func	spec/fixtures/test.coffee	/bound_func/;"	f	lineno:41	object:window	type:function
 beam_magnum	spec/fixtures/test.coffee	/beam_magnum/;"	f	lineno:44	object:window	type:function

data/spec/parser_spec.rb

@@ -167,5 +167,43 @@ describe 'CoffeeTags::Parser' do
         subject[:parent].should == '_loop'
       end
     end
+    context 'Block comments' do
+      let(:bc_file) { 'spec/fixtures/blockcomment.coffee'}
+      let(:bc_ctags_file) { 'spec/fixtures/blockcomment.ctags'}
+      let(:blockcomment_file) { File.read(bc_file)}
+      let(:blockcomment_tree) {
+        [{:level=>0,
+          :parent=>"window",
+          :source=>"echo2 :-> console.log 'echo'",
+          :line=>7,
+          :kind=>"f",
+          :name=>"echo2"}]
+      }
+
+      subject {
+        parser = Coffeetags::Parser.new(blockcomment_file, true)
+        parser.execute!
+        parser
+      }
+
+      it 'ignores block comments when parsing the contents' do
+        subject.tree.first.should == blockcomment_tree.first
+      end
+
+
+      context 'top-down test' do
+        let(:blockcomment_ctags){ File.read(bc_ctags_file) }
+        subject {
+          Coffeetags::Utils.run 'test_bc.out', nil, bc_file
+          File.read 'test_bc.out'
+        }
+
+        after(:all) { `rm test_bc.out` }
+
+        it 'ignores block comments in output' do
+          subject.should == blockcomment_ctags
+        end
+      end
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: CoffeeTags
 version: !ruby/object:Gem::Version 
-  hash: 67
+  hash: 79
   prerelease: 
   segments: 
   - 0
   - 0
   - 2
-  - 2
-  version: 0.0.2.2
+  - 4
+  version: 0.0.2.4
 platform: ruby
 authors: 
 - "\xC5\x81ukasz Korecki"
@@ -16,8 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-03-06 00:00:00 +00:00
-default_executable: 
+date: 2012-03-12 00:00:00 Z
 dependencies: []
 
 description: CoffeeTags generates ctags compatibile tags for CoffeeScript.
@@ -45,6 +44,8 @@ files:
 - lib/CoffeeTags/parser.rb
 - lib/CoffeeTags/version.rb
 - spec/coffeetags_spec.rb
+- spec/fixtures/blockcomment.coffee
+- spec/fixtures/blockcomment.ctags
 - spec/fixtures/campfire.coffee
 - spec/fixtures/campfire.js
 - spec/fixtures/campfire.js.tags
@@ -60,7 +61,6 @@ files:
 - tagbar-info.markdown
 - test.rb
 - vim/tagbar-coffee.vim.erb
-has_rdoc: true
 homepage: http://github.com/lukaszkorecki/CoffeeTags
 licenses: []
 
@@ -90,12 +90,14 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: CoffeeTags
-rubygems_version: 1.5.0
+rubygems_version: 1.8.16
 signing_key: 
 specification_version: 3
 summary: tags generator for CoffeeScript
 test_files: 
 - spec/coffeetags_spec.rb
+- spec/fixtures/blockcomment.coffee
+- spec/fixtures/blockcomment.ctags
 - spec/fixtures/campfire.coffee
 - spec/fixtures/campfire.js
 - spec/fixtures/campfire.js.tags