ripper-tags 0.3.5 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b7f252249e97f4fc155fc6fc24a0e1bd15a76b16
-  data.tar.gz: 988fad9d5795bffab282f8725698c4399b79b324
+  metadata.gz: 52c268f393b07f8fa528f4886a5c5c3d39fa712f
+  data.tar.gz: 7ea8519875252ee44f554ad3021d02a29e482970
 SHA512:
-  metadata.gz: feacc50ba4dee2e08023a4a2a0c1fa7bdb66b71952999ea3f11118fd0d97e5efb8004200e1939b03d71ea039d86a0763b4ad7fdebb85254130b3156ce0e4cdfe
-  data.tar.gz: 43eda4fcf9d254eaf133ea2ee3db1475925ae37c016db3c5cd4c7ff1a145be7fbd06d2ce6061ac84028e7ce0508214d6c48b72a8da60db3ff7bf5d8ce5fdfeb4
+  metadata.gz: ed66eb27100243fe6766f609f2ac3aa6f9f556a01f7c3f995fb663e973ef36fc7ab35e46eadf64e448ee75d133c96aa6177fa8a508548ab27fdce7268ade9ca0
+  data.tar.gz: 504ecdbdbb6315116d0d12d70827597c1f565fe08034d0201498ac5d878888c9e96bb7e7c750db79fd3f95798508493f1bdf9f0c00da9c07129eb3c84863aba7

data/lib/ripper-tags.rb

@@ -9,7 +9,7 @@ require 'ripper-tags/vim_formatter'
 require 'ripper-tags/json_formatter'
 
 module RipperTags
-  def self.version() "0.3.5" end
+  def self.version() "0.4.0" end
 
   FatalError = Class.new(RuntimeError)
 
@@ -26,11 +26,51 @@ module RipperTags
       :files => %w[.],
       :recursive => false,
       :exclude => %w[.git],
-      :all_files => false
+      :all_files => false,
+      :fields => Set.new,
+      :excmd => nil,
+      :input_file => nil
+  end
+
+  class ForgivingOptionParser < OptionParser
+    attr_accessor :ignore_unsupported_options
+
+    def parse(argv)
+      argv = argv.dup
+      exceptions = []
+      remaining = []
+
+      while argv.size > 0
+        begin
+          remaining = super(argv)
+          break
+        rescue OptionParser::InvalidOption => err
+          argv -= err.args
+          exceptions << err
+        end
+      end
+
+      if exceptions.any? && !ignore_unsupported_options
+        raise exceptions.first
+      end
+
+      remaining
+    end
   end
 
   def self.option_parser(options)
-    OptionParser.new do |opts|
+    flags_string_to_set = lambda do |string, set|
+      flags = string.split("")
+      operation = :add
+      if flags[0] == "+" || flags[0] == "-"
+        operation = :delete if flags.shift == "-"
+      else
+        set.clear
+      end
+      flags.each { |f| set.send(operation, f) }
+    end
+
+    ForgivingOptionParser.new do |opts|
       opts.banner = "Usage: #{opts.program_name} [options] FILES..."
       opts.version = version
 
@@ -43,6 +83,9 @@ module RipperTags
       opts.on("--tag-relative[=OPTIONAL]", "Make file paths relative to the directory of the tag file") do |value|
         options.tag_relative = value != "no"
       end
+      opts.on("-L", "--input-file=FILE", "File to read paths to process trom (use `-` for stdin)") do |file|
+        options.input_file = file
+      end
       opts.on("-R", "--recursive", "Descend recursively into subdirectories") do
         options.recursive = true
       end
@@ -53,7 +96,16 @@ module RipperTags
           options.exclude << pattern
         end
       end
-      opts.on("--all-files", "Parse all files as ruby files, not just `*.rb' ones") do
+      opts.on("--excmd=number", "Use EX number command to locate tags.") do |excmd|
+        options.excmd = excmd
+      end
+      opts.on("-n", "Equivalent to --excmd=number.") do
+        options.excmd = "number"
+      end
+      opts.on("--fields=+n", "Include line number information in the tag") do |flags|
+        flags_string_to_set.call(flags, options.fields)
+      end
+      opts.on("--all-files", "Parse all files in recursive mode (default: parse `*.rb' files)") do
         options.all_files = true
       end
 
@@ -66,14 +118,7 @@ module RipperTags
         options.format = "emacs"
       end
       opts.on("--extra=FLAGS", "Specify extra flags for the formatter") do |flags|
-        flags = flags.split("")
-        operation = :add
-        if flags[0] == "+" || flags[0] == "-"
-          operation = :delete if flags.shift == "-"
-        else
-          options.extra_flags.clear
-        end
-        flags.each { |f| options.extra_flags.send(operation, f) }
+        flags_string_to_set.call(flags, options.extra_flags)
       end
 
       opts.separator ""
@@ -106,6 +151,9 @@ module RipperTags
           exit 1
         end
       end
+      opts.on_tail("--ignore-unsupported-options", "Don't fail when unsupported options given, just skip them") do
+        opts.ignore_unsupported_options = true
+      end
       opts.on_tail("-v", "--version", "Print version information") do
         puts opts.ver
         exit
@@ -118,14 +166,17 @@ module RipperTags
   def self.process_args(argv, run = method(:run))
     option_parser(default_options) do |optparse, options|
       file_list = optparse.parse(argv)
+
       if !file_list.empty?
         options.files = file_list
-      elsif !options.recursive
-        raise OptionParser::InvalidOption, "needs either a list of files or `-R' flag"
+      elsif !(options.recursive || options.input_file)
+        raise OptionParser::InvalidOption, "needs either a list of files, `-L`, or `-R' flag"
       end
+
       options.tag_file_name ||= options.format == 'emacs' ? './TAGS' : './tags'
       options.format ||= File.basename(options.tag_file_name) == 'TAGS' ? 'emacs' : 'vim'
       options.tag_relative = options.format == "emacs" if options.tag_relative.nil?
+
       return run.call(options)
     end
   end

data/lib/ripper-tags/data_reader.rb

@@ -49,8 +49,8 @@ module RipperTags
       file.end_with?(RUBY_EXT)
     end
 
-    def include_file?(file)
-      (options.all_files || ruby_file?(file)) && !exclude_file?(file)
+    def include_file?(file, depth)
+      (depth == 0 || options.all_files || ruby_file?(file)) && !exclude_file?(file)
     end
 
     def resolve_file(file, depth = 0, &block)
@@ -66,8 +66,8 @@ module RipperTags
         end
       elsif depth > 0 || File.exist?(file)
         file = clean_path(file) if depth == 0
-        yield file if include_file?(file)
-      elsif
+        yield file if include_file?(file, depth)
+      else
         $stderr.puts "%s: %p: no such file or directory" % [
           File.basename($0),
           file
@@ -81,19 +81,32 @@ module RipperTags
 
     def each_file(&block)
       return to_enum(__method__) unless block_given?
-      options.files.each do |file|
+      each_input_file do |file|
         resolve_file(file, &block)
       end
     end
+
+    def each_input_file(&block)
+      if options.input_file
+        io = options.input_file == "-" ? $stdin : File.new(options.input_file, DataReader::READ_MODE)
+        begin
+          io.each_line { |line| yield line.chomp }
+        ensure
+          io.close
+        end
+      else
+        options.files.each(&block)
+      end
+    end
   end
 
   class DataReader
     attr_reader :options
-    attr_accessor :read_mode
+
+    READ_MODE = 'r:utf-8'
 
     def initialize(options)
       @options = options
-      @read_mode = defined?(::Encoding) ? 'r:utf-8' : 'r'
     end
 
     def file_finder
@@ -101,7 +114,7 @@ module RipperTags
     end
 
     def read_file(filename)
-      str = File.open(filename, read_mode) {|f| f.read }
+      str = File.open(filename, READ_MODE) {|f| f.read }
       normalize_encoding(str)
     end
 

data/lib/ripper-tags/default_formatter.rb

@@ -9,11 +9,15 @@ module RipperTags
 
     def initialize(options)
       @options = options
+      check_supported_flags(@options.extra_flags, supported_flags)
+      check_supported_flags(@options.fields, supported_fields)
+    end
 
-      if @options.extra_flags
-        unsupported = @options.extra_flags - supported_flags.to_set
+    def check_supported_flags(set, supported)
+      if set
+        unsupported = set - supported.to_set
         if unsupported.any?
-          raise FatalError, "these flags are not supported in the '%s' format: %s" % [
+          raise FatalError, "these fields are not supported in the '%s' format: %s" % [
             options.format,
             unsupported.to_a.join(", ")
           ]
@@ -27,6 +31,12 @@ module RipperTags
       options.extra_flags && options.extra_flags.include?(flag)
     end
 
+    def supported_fields() [] end
+
+    def field?(field)
+      options.fields && options.fields.include?(field)
+    end
+
     def stdout?
       '-' == options.tag_file_name
     end
@@ -35,9 +45,9 @@ module RipperTags
       if stdout?
         begin
           yield $stdout
-	rescue Errno::EINVAL
-	  raise BrokenPipe
-	end
+        rescue Errno::EINVAL
+          raise BrokenPipe
+        end
       else
         File.open(options.tag_file_name, 'w+') do |outfile|
           yield outfile

data/lib/ripper-tags/parser.rb

@@ -71,8 +71,16 @@ class Parser < Ripper
          "has_one", "has_many",
          "belongs_to", "has_and_belongs_to_many",
          "scope", "named_scope",
+         "public_class_method", "private_class_method",
+         "public", "protected", "private",
          /^attr_(accessor|reader|writer)$/
       on_method_add_arg([:fcall, name], args[0])
+    when "delegate"
+      on_delegate(*args[0][1..-1])
+    when "def_delegator", "def_instance_delegator"
+      on_def_delegator(*args[0][1..-1])
+    when "def_delegators", "def_instance_delegators"
+      on_def_delegators(*args[0][1..-1])
     end
   end
   def on_bodystmt(*args)
@@ -95,11 +103,38 @@ class Parser < Ripper
     end
   end
 
+  def on_array(args)
+    if args.is_a?(Array) && args[0] == :args
+      args[1..-1]
+    end
+  end
+
+  def on_hash(args)
+    return unless args
+
+    args.select { |arg| arg.is_a?(Array) && arg[0] == :assoc }.map { |_assoc, k, _v| k }
+  end
+
   undef on_tstring_content
   def on_tstring_content(str)
     str
   end
 
+  def on_string_add(*args)
+    [args[1], lineno]
+  end
+
+  def on_string_embexpr(*)
+    :string_embexpr
+  end
+  def on_string_dvar(*)
+    :string_embexpr
+  end
+  def on_string_literal(*args)
+    args = args.flatten
+    args unless args.include?(:string_embexpr)
+  end
+
   def on_xstring_add(first, arg)
     arg if first.nil?
   end
@@ -109,7 +144,7 @@ class Parser < Ripper
   end
 
   def on_vcall(name)
-    [name[0].to_sym] if name[0].to_s =~ /^(private|protected|public)$/
+    [name[0].to_sym] if name[0].to_s =~ /^(private|protected|public|private_class_method|public_class_method)$/
   end
 
   def on_call(lhs, op, rhs)
@@ -136,6 +171,18 @@ class Parser < Ripper
         [:alias, args[1][0], args[2][0], line] if args[1] && args[2]
       when "define_method"
         [:def, args[1][0], line]
+      when "public_class_method", "private_class_method", "private", "public", "protected"
+        access = name.sub("_class_method", "")
+
+        if args[1][1] == 'self'
+          klass = 'self'
+          method_name = args[1][2]
+        else
+          klass = nil
+          method_name = args[1][1]
+        end
+
+        [:def_with_access, klass, method_name, access, line]
       when "scope", "named_scope"
         [:rails_def, :scope, args[1][0], line]
       when /^attr_(accessor|reader|writer)$/
@@ -218,6 +265,43 @@ class Parser < Ripper
       super
     end
   end
+
+  # Otherwise hashes and keyword arguments turn into a list of their keys only
+  def on_assoc_new(key, value)
+    [:assoc, key, value]
+  end
+
+  def on_delegate(*args)
+    method_names = args.select { |arg| arg.first.is_a? String }
+    options = args.select { |arg| arg.first.is_a?(Array) && arg.first.first == :assoc }.flatten(1)
+    options = Hash[options.map { |_assoc, key, val| [key.first, val.first] }]
+
+    target = options["to:"] || options["to"] # When using hashrocket syntax there is no ':'
+    prefix = options["prefix:"] || options["prefix"]
+    method_prefix = if prefix.is_a?(Array) && prefix.first == "true"
+                      "#{target}_"
+                    elsif prefix.is_a? String
+                      "#{prefix}_"
+                    else
+                      ""
+                    end
+
+    method_names.map do |name, lineno|
+      [:def, "#{method_prefix}#{name}", lineno]
+    end
+  end
+
+  def on_def_delegator(*args)
+    name, lineno = args.last
+    [:def, name, lineno]
+  end
+
+  def on_def_delegators(*args)
+    _target, *names = args
+    names.map do |name, lineno|
+      [:def, name, lineno]
+    end
+  end
 end
 
   class Visitor
@@ -254,7 +338,10 @@ end
         sexp.each{ |child| process(child) }
       when Symbol
         name, *args = sexp
-        __send__("on_#{name}", *args) unless name.to_s.index("@") == 0
+        name = name.to_s
+        if name.index("@") != 0 && name.index("-@") != 0
+          __send__("on_#{name}", *args)
+        end
       when String, nil
         # nothing
       end
@@ -297,9 +384,11 @@ end
       on_module_or_class(:class, name, superclass, *body)
     end
 
-    def on_private()   @current_access = 'private'   end
-    def on_protected() @current_access = 'protected' end
-    def on_public()    @current_access = 'public'    end
+    def on_private()              @current_access = 'private'   end
+    def on_protected()            @current_access = 'protected' end
+    def on_public()               @current_access = 'public'    end
+    def on_private_class_method() @current_access = 'private'   end
+    def on_public_class_method()  @current_access = 'public'    end
 
     # Ripper trips up on keyword arguments in pre-2.1 Ruby and supplies extra
     # arguments that we just ignore here
@@ -320,6 +409,8 @@ end
         namespace = namespace + parts
       end
 
+      process(rhs)
+
       emit_tag :constant, line,
         :name => name,
         :full_name => (namespace + [name]).join('::'),
@@ -354,6 +445,18 @@ end
         :class => ns.join('::')
     end
 
+    def on_def_with_access(klass, name, access, line)
+      ns = (@namespace.empty? ? 'Object' : @namespace.join('::'))
+      singleton = @is_singleton || klass == 'self'
+      kind = singleton ? 'singleton method' : 'method'
+
+      emit_tag kind, line,
+        :name => name,
+        :full_name => "#{ns}#{singleton ? '.' : '#'}#{name}",
+        :class => ns,
+        :access => access
+    end
+
     def on_rails_def(kind, name, line)
       ns = (@namespace.empty?? 'Object' : @namespace.join('::'))
 

data/lib/ripper-tags/vim_formatter.rb

@@ -3,6 +3,7 @@ require 'ripper-tags/default_formatter'
 module RipperTags
   class VimFormatter < DefaultFormatter
     def supported_flags() ['q'] end
+    def supported_fields() ['n'] end
 
     def include_qualified_names?
       return @include_qualified_names if defined? @include_qualified_names
@@ -39,8 +40,12 @@ module RipperTags
       const.to_s.gsub('::', '.')
     end
 
-    def display_pattern(tag)
-      tag.fetch(:pattern).to_s.gsub('\\','\\\\\\\\').gsub('/','\\/')
+    def display_excmd_info(tag)
+      if options.excmd == "number"
+        "%d;\"" % tag.fetch(:line)
+      else
+        "/^%s$/;\"" % tag.fetch(:pattern).to_s.gsub('\\','\\\\\\\\').gsub('/','\\/')
+      end
     end
 
     def display_class(tag)
@@ -59,6 +64,14 @@ module RipperTags
       end
     end
 
+    def display_line_number(tag)
+      if field?('n') && tag[:line]
+        "\tline:%s" % tag[:line]
+      else
+        ""
+      end
+    end
+
     def display_kind(tag)
       case tag.fetch(:kind)
       when 'method' then 'f'
@@ -71,11 +84,12 @@ module RipperTags
     end
 
     def format(tag, name_field = :name)
-      "%s\t%s\t/^%s$/;\"\t%s%s%s" % [
+      "%s\t%s\t%s\t%s%s%s%s" % [
         tag.fetch(name_field),
         relative_path(tag),
-        display_pattern(tag),
+        display_excmd_info(tag),
         display_kind(tag),
+        display_line_number(tag),
         name_field == :full_name ? nil : display_class(tag),
         display_inheritance(tag),
       ]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ripper-tags
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.4.0
 platform: ruby
 authors:
 - Aman Gupta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-07-24 00:00:00.000000000 Z
+date: 2017-09-27 00:00:00.000000000 Z
 dependencies: []
 description: fast, accurate ctags generator for ruby source code using Ripper
 email:
@@ -40,7 +40,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="