Merge pull request #97 from tmm1/tag-relative-compat

Support `--tag-relative=always|never`

Author: mislav

lib/ripper-tags.rb

@@ -94,8 +94,8 @@ def self.option_parser(options)
       opts.on("-a", "--append[=yes|no]", "Append tags to existing file") do |value|
         options.tag_file_append = value != "no"
       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("--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
@@ -194,6 +194,12 @@ def self.process_args(argv, run = method(:run))
       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

lib/ripper-tags/default_formatter.rb

@@ -56,16 +56,23 @@ def with_output
     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)

test/test_cli.rb

@@ -118,17 +118,26 @@ def test_tag_relative_off_by_default
   def test_tag_relative_on
     options = process_args(%w[--tag-relative hello.rb])
     assert_equal true, options.tag_relative
-    assert_equal %w[hello.rb], options.files
   end
 
   def test_tag_relative_explicit_yes
     options = process_args(%w[-R --tag-relative=yes])
-    assert_equal true, options.tag_relative
+    assert_equal 'yes', options.tag_relative
   end
 
   def test_tag_relative_explicit_no
     options = process_args(%w[-R --tag-relative=no])
-    assert_equal false, options.tag_relative
+    assert_equal 'no', options.tag_relative
+  end
+
+  def test_tag_relative_explicit_always
+    options = process_args(%w[-R --tag-relative=always])
+    assert_equal 'always', options.tag_relative
+  end
+
+  def test_tag_relative_explicit_never
+    options = process_args(%w[-R --tag-relative=never])
+    assert_equal 'never', options.tag_relative
   end
 
   def test_tag_relative_on_for_emacs

test/test_formatters.rb

@@ -218,6 +218,24 @@ def test_relative_with_common_prefix
     assert_equal 'to/script.rb', formatter.relative_path(tag)
   end
 
+  def test_relative_with_absolute_source_path
+    formatter = formatter_for(:format => 'custom', :tag_file_name => '/tmp/tags', :tag_relative => true)
+    tag = build_tag(:path => '/path/to/script.rb')
+    assert_equal '/path/to/script.rb', formatter.relative_path(tag)
+  end
+
+  def test_relative_always_with_absolute_source_path
+    formatter = formatter_for(:format => 'custom', :tag_file_name => '/tmp/tags', :tag_relative => 'always')
+    tag = build_tag(:path => '/path/to/script.rb')
+    assert_equal '../path/to/script.rb', formatter.relative_path(tag)
+  end
+
+  def test_relative_never_with_relative_source_path
+    formatter = formatter_for(:format => 'custom', :tag_file_name => 'tags', :tag_relative => 'never')
+    tag = build_tag(:path => 'path/to/script.rb')
+    assert_equal "#{Dir.pwd}/path/to/script.rb", formatter.relative_path(tag)
+  end
+
   def test_no_relative
     formatter = formatter_for(:format => 'custom', :tag_file_name => '.git/tags')
     tag = build_tag(:path => 'path/to/script.rb')