CoffeeTags 0.0.1.8 → 0.0.2.0

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/Gemfile

@@ -14,5 +14,5 @@ group :development do
 end
 
 group :test do
-  gem 'rspec', '~> 2.6.0'
+  gem 'rspec', '2.8.0'
 end

data/lib/CoffeeTags/parser.rb

@@ -12,7 +12,7 @@ module Coffeetags
 
       # regexes
       @block = /^\s*(if|unless|switch|loop|do)/
-      @class_regex = /^\s*class\s*(\w*)/
+      @class_regex = /^\s*class\s*([\w\.]*)/
       @proto_meths = /^\s*([A-Za-z]*)::([@a-zA-Z0-9_]*)/
       @var_regex = /([@a-zA-Z0-9_]*)\s*[=:]{1}\s*$/
       @token_regex = /([@a-zA-Z0-9_]*)\s*[:=]{1}/
@@ -49,8 +49,12 @@ module Coffeetags
         line_n += 1
         level = line_level line
 
-        if (_class = line.match @class_regex)
-          @tree << { :name => _class[1], :level => level }
+        # ignore comments!
+        next if  line =~ /^\s*#/
+
+          # FIXME this could be DRYied
+          if (_class = line.match @class_regex)
+            @tree << { :name => _class[1], :level => level }
         end
 
         if(_proto  = line.match @proto_meths)
@@ -70,19 +74,19 @@ module Coffeetags
 
         if not token.nil?
           o = {
-              :name => token[1],
-              :level => level,
-              :parent => '',
-              :source => line.chomp,
-              :line => line_n
+            :name => token[1],
+            :level => level,
+            :parent => '',
+            :source => line.chomp,
+            :line => line_n
           }
 
           # remove edge cases for now
           # - 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] =~ /\.$/

data/lib/CoffeeTags/version.rb

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

data/lib/CoffeeTags.rb

@@ -2,6 +2,7 @@
 require "CoffeeTags/version"
 require "CoffeeTags/parser"
 require "CoffeeTags/formatter"
+require 'optparse'
 
 class Object
   def blank?
@@ -18,22 +19,10 @@ module Coffeetags
   NAME = "CoffeeTags"
   URL = "https://github.com/lukaszkorecki/CoffeeTags"
 
-  STRINGS = {
-    'version' => "#{NAME} #{Coffeetags::VERSION} by #{AUTHOR} ( #{URL} )",
-    'help' => <<-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
-HELP
-  }
   class Utils
     def self.tagbar_conf include_vars
       <<-CONF
 " Add this type definition to your vimrc
-" or do
 " coffeetags --vim-conf >> <PATH TO YOUR VIMRC>
 " if you want your tags to include vars/objects do:
 " coffeetags --vim-conf --include-vars
@@ -54,36 +43,59 @@ HELP
     end
 
     def self.option_parser args
-      args = ['--version', '--help'] if args.empty?
+      args << '-h' if args.empty?
+      options = {}
+      optparse = OptionParser.new do |opts|
 
-      include_vars = ! args.delete('--include-vars').nil?
-      recursive = ! args.delete('-R').nil?
+        opts.banner  = (<<-BAN
+          #{NAME} #{Coffeetags::VERSION}
+          by #{AUTHOR} ( #{URL} )
+          Usage:
+          coffeetags [OPTIONS] <list of files>
+          BAN
+                       ).gsub(/^\s*/,'')
 
-      output = nil
+        opts.on('-i', '--include-vars', "Include variables in generated tags") do |o|
+          options[:include_vars] = true
+        end
+
+        opts.on('-f', '--file FILE', 'Write tags to FILE (use - for std out)') do |o|
+          options[:output] = o unless o == '-'
+
+        end
+
+        opts.on('-R', '--recursive', 'Process current directory recursively') do |o|
+          options[:recur] = true
+        end
+
+        opts.on('-v', '--version', 'Current version') do
+          puts Coffeetags::VERSION
+          exit
+
+        end
+
+        opts.on('-h','--help','HALP') do
+          puts opts
+          exit
+        end
 
-      unless args.index( '-f').nil?
-        output = args[ args.index('-f') + 1]
-        args.delete '-f'
-        args.delete output
-        output = nil if output == '-'
       end
 
-      to_print = [].tap do |_to_print|
-        _to_print << args.delete( '--version')
-        _to_print << args.delete( '--help')
-      end.reject { |i| i.nil? }.map { |i| i.sub '--', ''}.map { |s| STRINGS[s] }
-      ( to_print << tagbar_conf(include_vars) ) unless  args.delete('--vim-conf').nil?
+      optparse.parse! args
+
+      options[:files]  = args.to_a
+      options[:files] += Dir['./**/*.coffee', './**/Cakefile'] if options[:recur]
 
-      to_print.each {  |str| puts str  }
+      [
+        options[:output],
+        options[:include_vars],
+        options[:files]
+      ]
 
-      args += Dir['./**/*.coffee', './**/Cakefile'] if recursive
-      [output, include_vars, args] unless args.empty?
     end
 
 
     def self.run output, include_vars,  files
-
-      files = [files] if files.is_a? String
       __out = if output.nil?
                 STDOUT
               else
@@ -92,6 +104,8 @@ HELP
 
       __out  << Coffeetags::Formatter.header
 
+      files = [ files] if files.is_a? String
+
       files.reject { |f| f =~ /^-/}.each do |file|
         sc = File.read file
         parser = Coffeetags::Parser.new sc, include_vars

data/spec/coffeetags_spec.rb

@@ -1,13 +1,16 @@
-require  File.expand_path('lib/CoffeeTags')
+require 'spec_helper'
 include Coffeetags
 describe Utils do
   context 'Argument parsing' do
     it "returns nil when nothing is passed" do
-      Utils.option_parser( []).should == nil
+      expect {
+      Utils.option_parser( [])
+      }.to raise_error SystemExit
+
     end
 
     it "returns files list" do
-      Utils.option_parser( [ 'lol.coffee']).should == [ nil, false,  ['lol.coffee']]
+      Utils.option_parser([  'lol.coffee']).should == [ nil, nil,  ['lol.coffee']]
     end
 
     it "parses --include-vars option" do
@@ -15,7 +18,7 @@ describe Utils do
     end
 
     it "parses -f <file> option" do
-      Utils.option_parser( [ '-f','tags' ,'lol.coffee']).should == [ 'tags', false,  ['lol.coffee']]
+      Utils.option_parser( [ '-f','tags' ,'lol.coffee']).should == [ 'tags', nil,  ['lol.coffee']]
     end
 
   end
@@ -85,7 +88,6 @@ FF
 
     end
     after :each do
-      STDERR << "DELETING!"
       `rm test.out`
     end
   end

data/spec/fixtures/class_with_dot.coffee

@@ -0,0 +1,2 @@
+class App.Campfire
+  constructor: ->

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.7	//
+!_TAG_PROGRAM_VERSION	0.0.1.8	//
 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
@@ -11,6 +11,7 @@ bump_up	spec/fixtures/test.coffee	/bump_up/;"	f	lineno:12	object:Wat.ho.@lolWat
 @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

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.7	//
+!_TAG_PROGRAM_VERSION	0.0.1.8	//
 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
@@ -11,3 +11,4 @@ bump_up	spec/fixtures/test.coffee	/bump_up/;"	f	lineno:12	object:Wat.ho.@lolWat
 @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/fixtures/test.coffee

@@ -39,3 +39,6 @@ for f in dir
     zorb = get['x=\\/f'].getLast('/woot$')
 
 bound_func = (ok) => wat(ok)
+
+# TODO: beam_shield -> deployed(true)
+beam_magnum : -> deployed(true)

data/spec/fixtures/test_tree.yaml

@@ -62,3 +62,10 @@
   :kind: f
   :name: 'bound_func'
   :parent: window
+- :source: 'beam_magnum : -> deployed(true)'
+  :line: 44
+  :level: 0
+  :kind: f
+  :name: 'beam_magnum'
+  :parent: window
+

data/spec/fixtures/tree.yaml

@@ -58,6 +58,15 @@
   :line: 41
   :level: 4
 
+- :name: App.Campfire
+  :level: 0
+- :source: "  constructor: ->"
+  :parent: App.Campfire
+  :kind: f
+  :name: constructor
+  :line: 8
+  :level: 2
+
 
 - :name: Test
   :level: 0

data/spec/formatter_spec.rb

@@ -1,5 +1,4 @@
-require './lib/CoffeeTags'
-
+require 'spec_helper'
 describe 'CoffeeTags::Formatter' do
   before :each do
     @tree = YAML::load_file './spec/fixtures/tree.yaml'

data/spec/parser_spec.rb

@@ -1,7 +1,8 @@
-require './lib/CoffeeTags'
+require 'spec_helper'
 describe 'CoffeeTags::Parser' do
   before :all do
     @campfire_class = File.read File.expand_path('./spec/fixtures/campfire.coffee')
+    @class_with_dot = File.read File.expand_path('./spec/fixtures/class_with_dot.coffee')
     @test_file = File.read File.expand_path('./spec/fixtures/test.coffee')
 
     @cf_tree = YAML::load_file File.expand_path('./spec/fixtures/tree.yaml')
@@ -76,6 +77,14 @@ describe 'CoffeeTags::Parser' do
         c.should == @cf_tree.find {|i| i[:name] == 'Test'}
       end
 
+      it "parses the class with dot in name" do
+        @coffee_parser = Coffeetags::Parser.new @class_with_dot, true
+        @coffee_parser.execute!
+
+        c = @coffee_parser.tree.find { |i| i[:name] == 'App.Campfire'}
+        c.should == @cf_tree.find {|i| i[:name] == 'App.Campfire'}
+      end
+
       it "parses the instance variable" do
         c =@coffee_parser.tree.find { |i| i[:name] == '@url'}
         c.should == @cf_tree.find {|i| i[:name] == '@url'}
@@ -122,11 +131,10 @@ describe 'CoffeeTags::Parser' do
 
     end
       it "detects a fat arrow function" do
-        c =@parser_test.tree.find { |i| i[:name] == 'bound_func'}
+        c = @parser_test.tree.find { |i| i[:name] == 'bound_func'}
         c.should == @test_tree.find {|i| i[:name] == 'bound_func'}
 
       end
-
     it "extracts a method defined in a prototype" do
       pending 'methods defined on prototype needs implementing'
       pro = @parser_test.tree.find { |i| i[:name] == '_loop'}
@@ -135,6 +143,11 @@ describe 'CoffeeTags::Parser' do
       pro.should == exp
     end
 
+    it 'Ignores #TODO: -> (and any other comment line)' do
+      @parser_test.tree.find { |i| i[:name] == 'TODO' }.should be_nil
+
+    end
+
     context 'for loop' do
       subject {
         @parser_test = Coffeetags::Parser.new @test_file, true

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require 'yaml'
+require './lib/CoffeeTags'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification 
 name: CoffeeTags
 version: !ruby/object:Gem::Version 
-  hash: 91
+  hash: 71
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  - 8
-  version: 0.0.1.8
+  - 2
+  - 0
+  version: 0.0.2.0
 platform: ruby
 authors: 
 - "\xC5\x81ukasz Korecki"
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-01-02 00:00:00 +00:00
+date: 2012-02-28 00:00:00 +00:00
 default_executable: 
 dependencies: []
 
@@ -31,6 +31,7 @@ extra_rdoc_files: []
 
 files: 
 - .gitignore
+- .rspec
 - .rvmrc
 - .travis.yml
 - CoffeeTags.gemspec
@@ -47,6 +48,7 @@ files:
 - spec/fixtures/campfire.coffee
 - spec/fixtures/campfire.js
 - spec/fixtures/campfire.js.tags
+- spec/fixtures/class_with_dot.coffee
 - spec/fixtures/out.test-two.ctags
 - spec/fixtures/out.test.ctags
 - spec/fixtures/test.coffee
@@ -54,6 +56,7 @@ files:
 - spec/fixtures/tree.yaml
 - spec/formatter_spec.rb
 - spec/parser_spec.rb
+- spec/spec_helper.rb
 - test.rb
 has_rdoc: true
 homepage: http://github.com/lukaszkorecki/CoffeeTags
@@ -94,6 +97,7 @@ test_files:
 - spec/fixtures/campfire.coffee
 - spec/fixtures/campfire.js
 - spec/fixtures/campfire.js.tags
+- spec/fixtures/class_with_dot.coffee
 - spec/fixtures/out.test-two.ctags
 - spec/fixtures/out.test.ctags
 - spec/fixtures/test.coffee
@@ -101,3 +105,4 @@ test_files:
 - spec/fixtures/tree.yaml
 - spec/formatter_spec.rb
 - spec/parser_spec.rb
+- spec/spec_helper.rb