ripper-tags 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: d6621fd0e6fae8e6399e7f861ee28a3e0e5482c4
-  data.tar.gz: b24806fab7cddd6f245a121b5083b987c9f55e19
+SHA256:
+  metadata.gz: af186884f47d60d67bc23e0bc85ceee5109a89c6bd60cb92024003803e11f87f
+  data.tar.gz: 6dbdd9ad152c076acb592533704df108ba38c582f75287e396fc57e439a2c525
 SHA512:
-  metadata.gz: 8ff50b98643eaf25b4cc7f7ce6244486366b6ac5662d3bff378b65c892fe1a8725780ad8dddd4c1e04ecc8309dd4871e56795c862029c472e3239566a189e16f
-  data.tar.gz: 55fd3694353f4491629fe173142363be315acb17c0695b232efc83351898168c1f7a3fa0254d0bd7451d115e7a11d0baf595f856d2a1eafaf9c4fdd44ca8d058
+  metadata.gz: 44316dc2bf8a70f9b00a9da621533f41b63b83ad91da0cfa768db558c920d222cdf7656e4454099a4e29ca4cb0ff82086f613eb491160f697d52d1174d4f142d
+  data.tar.gz: e209fcd4873a3a98bf69d03d0205506ad9ed4615e0fa4017476fe54e3b66df7aa2548b41dc7bc63b83e3ce2b2863f36150c6f97985a739db0a767c6d82c6372f

data/lib/ripper-tags.rb

@@ -5,19 +5,23 @@ require 'ripper-tags/parser'
 require 'ripper-tags/data_reader'
 require 'ripper-tags/default_formatter'
 require 'ripper-tags/emacs_formatter'
+require 'ripper-tags/emacs_append_formatter'
 require 'ripper-tags/vim_formatter'
+require 'ripper-tags/vim_append_formatter'
 require 'ripper-tags/json_formatter'
 
 module RipperTags
-  def self.version() "0.7.0" end
+  def self.version() "0.8.0" end
 
   FatalError = Class.new(RuntimeError)
 
   def self.default_options
     OpenStruct.new \
       :format => nil,
+      :formatter => nil,
       :extra_flags => Set.new,
       :tag_file_name => nil,
+      :tag_file_append => false,
       :tag_relative => nil,
       :debug => false,
       :verbose_debug => false,
@@ -87,8 +91,11 @@ module RipperTags
              '"-" outputs to standard output') do |fname|
         options.tag_file_name = fname
       end
-      opts.on("--tag-relative[=OPTIONAL]", "Make file paths relative to the directory of the tag file") do |value|
-        options.tag_relative = value != "no"
+      opts.on("-a", "--append[=yes|no]", "Append tags to existing file") do |value|
+        options.tag_file_append = value != "no"
+      end
+      opts.on("--tag-relative[=yes|no|always|never]", "Make file paths relative to the directory of the tag file") do |value|
+        options.tag_relative = value || true
       end
       opts.on("-L", "--input-file=FILE", "File to read paths to process trom (use `-` for stdin)") do |file|
         options.input_file = file
@@ -103,7 +110,7 @@ module RipperTags
           options.exclude << pattern
         end
       end
-      opts.on("--excmd=number", "Use EX number command to locate tags.") do |excmd|
+      opts.on("--excmd=(number|pattern|mixed|combined)", "Type of EX command to find tags in vim with (default: pattern)") do |excmd|
         options.excmd = excmd
       end
       opts.on("-n", "Equivalent to --excmd=number.") do
@@ -187,19 +194,36 @@ module RipperTags
       options.format ||= File.basename(options.tag_file_name) == 'TAGS' ? 'emacs' : 'vim'
       options.tag_relative = options.format == "emacs" if options.tag_relative.nil?
 
+      case options.tag_relative
+      when true, false, 'yes', 'no', 'always', 'never'
+      else
+        raise OptionParser::InvalidOption, 'unsupported value for --tag-relative: %p' % options.tag_relative
+      end
+
       return run.call(options)
     end
   end
 
   def self.formatter_for(options)
-    options.formatter ||
-    case options.format
-    when "vim"    then RipperTags::VimFormatter
-    when "emacs"  then RipperTags::EmacsFormatter
-    when "json"   then RipperTags::JSONFormatter
-    when "custom" then RipperTags::DefaultFormatter
-    else raise FatalError, "unknown format: #{options.format.inspect}"
-    end.new(options)
+    return options.formatter unless options.formatter.nil?
+
+    if options.tag_file_append
+      case options.format
+      when "vim"   then RipperTags::VimAppendFormatter.new(RipperTags::VimFormatter.new(options))
+      when "emacs" then RipperTags::EmacsAppendFormatter.new(RipperTags::EmacsFormatter.new(options))
+      else
+        raise FatalError, "--append is only supported for vim/emacs; got #{options.format.inspect}"
+      end
+    else
+      case options.format
+      when "vim"    then RipperTags::VimFormatter.new(options)
+      when "emacs"  then RipperTags::EmacsFormatter.new(options)
+      when "json"   then RipperTags::JSONFormatter.new(options)
+      when "custom" then RipperTags::DefaultFormatter.new(options)
+      else
+        raise FatalError, "unknown format: #{options.format.inspect}"
+      end
+    end
   end
 
   def self.run(options)

data/lib/ripper-tags/default_formatter.rb

@@ -56,16 +56,23 @@ module RipperTags
     end
 
     def tag_file_dir
-      @tag_file_dir ||= Pathname.new(options.tag_file_name).dirname.expand_path
+      @tag_file_dir ||= stdout? ?
+        Pathname.pwd :
+        Pathname.new(options.tag_file_name).dirname.expand_path
     end
 
     def relative_path(tag)
       path = tag.fetch(:path)
-      if options.tag_relative && !stdout? && path.index('/') != 0
-        Pathname.new(path).expand_path.relative_path_from(tag_file_dir).to_s
-      else
-        path
+      case options.tag_relative
+      when true, 'yes', 'always'
+        filepath = Pathname.new(path)
+        if options.tag_relative == 'always' || filepath.relative?
+          path = filepath.expand_path.relative_path_from(tag_file_dir).to_s
+        end
+      when 'never'
+        path = File.expand_path(path)
       end
+      path
     end
 
     def constant?(tag)

data/lib/ripper-tags/emacs_append_formatter.rb

@@ -0,0 +1,43 @@
+require 'set'
+
+module RipperTags
+  class EmacsAppendFormatter
+    # Wraps an EmacsFormatter
+    def initialize(fmt)
+      raise 'append is only possible to a file' if fmt.stdout?
+      @formatter = fmt
+    end
+
+    def with_output
+      old_sections = parse_tag_file
+      @seen_filenames = Set.new
+
+      @formatter.with_output do |out|
+        yield out
+        @formatter.flush_file_section(out)
+
+        old_sections.each do |filename, data|
+          next if @seen_filenames.include?(filename)
+          @formatter.write_section(filename, data, out)
+        end
+      end
+    end
+
+    def write(tag, out)
+      @formatter.write(tag, out)
+      @seen_filenames << @formatter.relative_path(tag)
+    end
+
+    def parse_tag_file
+      section_map = {}
+      File.open(@formatter.options.tag_file_name) do |old_file|
+        while line = old_file.read(2)
+          raise 'expected "\f\n", got %p' % line unless "\x0C\n" == line
+          filename, length = old_file.gets.chomp.split(',')
+          section_map[filename] = old_file.read(length.to_i)
+        end
+      end
+      section_map
+    end
+  end
+end

data/lib/ripper-tags/emacs_formatter.rb

@@ -11,12 +11,6 @@ module RipperTags
   # new source file is encountered or when `with_output` block finishes. This
   # assumes that incoming tags are ordered by source file.
   class EmacsFormatter < DefaultFormatter
-    def initialize(*)
-      super
-      @current_file = nil
-      @section_io = nil
-    end
-
     def supported_flags() ['q'] end
 
     def include_qualified_names?
@@ -25,6 +19,9 @@ module RipperTags
     end
 
     def with_output
+      @current_file = nil
+      @section_io = nil
+
       super do |io|
         begin
           yield io
@@ -43,21 +40,24 @@ module RipperTags
       end
     end
 
+    def write_section(filename, data, io)
+      io.write format_section_header(filename, data)
+      io.write data
+    end
+
     def start_file_section(filename, io)
       if filename != @current_file
         flush_file_section(io)
         @current_file = filename
         @section_io = StringIO.new
-      else
-        @section_io
       end
+      @section_io
     end
 
     def flush_file_section(out)
       if @section_io
-        data = @section_io.string
-        out.write format_section_header(@current_file, data)
-        out.write data
+        write_section(@current_file, @section_io.string, out)
+        @section_io = nil
       end
     end
 

data/lib/ripper-tags/parser.rb

@@ -36,7 +36,13 @@ class Parser < Ripper
     [:defs, receiver && receiver[0], *method]
   end
   def on_alias(lhs, rhs)
-    [:alias, lhs[0], rhs[0], rhs[1]] if lhs && rhs
+    if lhs && rhs
+      name, other = lhs[0], rhs[0]
+      name = name[0] if Array === name
+      other = other[0] if Array === other
+      line = rhs[1]
+      [:alias, name, other, line]
+    end
   end
   def on_assign(lhs, rhs)
     return if lhs.nil?
@@ -169,9 +175,11 @@ class Parser < Ripper
       name, line = call[1]
       case name
       when "alias_method"
-        [:alias, args[1][0], args[2][0], line] if args[1] && args[2]
+        if args[1] && String === args[1][0] && args[2] && String === args[2][0]
+          [:alias, args[1][0], args[2][0], line]
+        end
       when "define_method"
-        [:def, args[1][0], line]
+        [:def, args[1][0], line] if String === args[1][0]
       when "public_class_method", "private_class_method", "protected_class_method", "private", "public", "protected"
         access = name.sub("_class_method", "")
         klass = name == access ? nil : 'self'

data/lib/ripper-tags/vim_append_formatter.rb

@@ -0,0 +1,35 @@
+require 'set'
+
+module RipperTags
+  class VimAppendFormatter
+    # Wraps a VimFormatter
+    def initialize(fmt)
+      raise 'append is only possible to a file' if fmt.stdout?
+      @formatter = fmt
+    end
+
+    def with_output
+      orig_lines = File.readlines(@formatter.options.tag_file_name)
+      @seen_filenames = Set.new
+
+      @formatter.with_output do |out|
+        yield out
+
+        orig_lines.each do |line|
+          f1, f2, = line.split("\t", 3)
+          # skip repeating header entries
+          next if f1 == '!_TAG_FILE_FORMAT' || f1 == '!_TAG_FILE_SORTED'
+          # skip old tags for newly processed files
+          next if f1.index('!_TAG_') != 0 && @seen_filenames.include?(f2)
+          # preserve other tags from original file
+          @formatter.write_line(line)
+        end
+      end
+    end
+
+    def write(tag, out)
+      @formatter.write(tag, out)
+      @seen_filenames << @formatter.relative_path(tag)
+    end
+  end
+end

data/lib/ripper-tags/vim_formatter.rb

@@ -30,21 +30,33 @@ module RipperTags
     end
 
     def write(tag, out)
-      @queued_write << format(tag)
+      write_line(format(tag))
       if include_qualified_names? && tag[:full_name] != tag[:name] && constant?(tag)
-        @queued_write << format(tag, :full_name)
+        write_line(format(tag, :full_name))
       end
     end
 
+    def write_line(line)
+      @queued_write << line
+    end
+
     def display_constant(const)
       const.to_s.gsub('::', '.')
     end
 
     def display_excmd_info(tag)
-      if options.excmd == "number"
+      case options.excmd
+      when 'n', 'number'
         "%d;\"" % tag.fetch(:line)
-      else
+      when nil, 'p', 'pattern', 'm', 'mixed'
         "/^%s$/;\"" % tag.fetch(:pattern).to_s.gsub('\\','\\\\\\\\').gsub('/','\\/')
+      when 'c', 'combined'
+        "%d;/^%s$/;\"" % [
+          tag.fetch(:line) - 1,
+          tag.fetch(:pattern).to_s.gsub('\\','\\\\\\\\').gsub('/','\\/')
+        ]
+      else
+        raise 'invalid excmd value: %p', options.excmd
       end
     end
 

metadata

@@ -1,17 +1,19 @@
 --- !ruby/object:Gem::Specification
 name: ripper-tags
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.8.0
 platform: ruby
 authors:
+- Mislav Marohnić
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-12-11 00:00:00.000000000 Z
+date: 2019-11-26 00:00:00.000000000 Z
 dependencies: []
 description: fast, accurate ctags generator for ruby source code using Ripper
 email:
+- mislav.marohnic@gmail.com
 - aman@tmm1.net
 executables:
 - ripper-tags
@@ -24,11 +26,13 @@ files:
 - lib/ripper-tags.rb
 - lib/ripper-tags/data_reader.rb
 - lib/ripper-tags/default_formatter.rb
+- lib/ripper-tags/emacs_append_formatter.rb
 - lib/ripper-tags/emacs_formatter.rb
 - lib/ripper-tags/json_formatter.rb
 - lib/ripper-tags/parser.rb
+- lib/ripper-tags/vim_append_formatter.rb
 - lib/ripper-tags/vim_formatter.rb
-homepage: http://github.com/tmm1/ripper-tags
+homepage: https://github.com/tmm1/ripper-tags
 licenses:
 - MIT
 metadata: {}
@@ -47,8 +51,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: ctags generator for ruby code