docdiff 0.6.7 → 0.7.0

data/lib/docdiff/cli.rb

@@ -7,6 +7,12 @@ class DocDiff
         o = base_options.dup
 
         option_parser = OptionParser.new do |parser|
+          parser.summary_width = 20
+          parser.summary_indent = "  "
+
+          parser.banner =
+            "#{File.basename($PROGRAM_NAME)} [options] file1 file2"
+
           parser.on(
             "--resolution=RESOLUTION",
             resolutions = ["line", "word", "char"],
@@ -54,8 +60,9 @@ class DocDiff
             "--format=FORMAT",
             formats = ["tty", "manued", "html", "wdiff", "stat", "user"],
             "specify output format",
-            "#{formats.join("|")} (default: html) (stat is deprecated)",
-            "(user tags can be defined in config file)",
+            "#{formats.join("|")} (default: tty)",
+            "(stat is deprecated)",
+            "(user tags can be defined in configuration file)",
           ) { |s| o[:format] = (s || "manued") }
           parser.on("--tty", "same as --format=tty") { o[:format] = "tty" }
           parser.on("--manued", "same as --format=manued") { o[:format] = "manued" }
@@ -66,7 +73,8 @@ class DocDiff
           parser.on(
             "--label LABEL",
             "-L LABEL",
-            "use label instead of file name (not implemented; exists for compatibility with diff)",
+            "use label instead of file name",
+            "(not implemented; exists for compatibility with diff)",
           ) do |s|
             o[:label] ||= []
             o[:label] << s
@@ -78,22 +86,24 @@ class DocDiff
           parser.on(
             "--display=DISPLAY",
             display_types = ["inline", "block", "multi"],
-            "specify presentation type (effective only with digest; experimental feature)",
-            "#{display_types.join("|")} (default: inline) (multi is deprecated)",
+            "specify presentation type (effective only with digest)",
+            "#{display_types.join("|")} (default: inline)",
+            "(experimental feature) (multi is deprecated)",
           ) { |s| o[:display] ||= s.downcase }
 
           parser.on("--cache", "use file cache (not implemented) (deprecated)") { o[:cache] = true }
           parser.on(
             "--pager=PAGER",
             String,
-            "specify pager (if available, $DOCDIFF_PAGER is used by default)",
+            "specify pager",
+            "(falls back to $DOCDIFF_PAGER, $PAGER, or none)",
           ) { |s| o[:pager] = s }
           parser.on("--no-pager", "do not use pager") { o[:pager] = false }
-          parser.on("--config-file=FILE", String, "specify config file to read") { |s| o[:config_file] = s }
-          parser.on("--no-config-file", "do not read config files") { o[:no_config_file] = true }
+          parser.on("--config-file=FILE", String, "specify configuration file to read") { |s| o[:config_file] = s }
+          parser.on("--no-config-file", "do not read configuration files") { o[:no_config_file] = true }
           parser.on("--verbose", "run verbosely (not well-supported) (deprecated)") { o[:verbose] = true }
 
-          parser.on("--help", "show this message") do
+          parser.on("--help", "show help message") do
             puts parser
             exit(0)
           end
@@ -112,7 +122,8 @@ class DocDiff
 
           parser.on_tail(
             "When invoked as worddiff or chardiff, resolution will be set accordingly.",
-            "Config files: /etc/docdiff/docdiff.conf, ~/.config/docdiff/docdiff.conf (or ~/etc/docdiff/docdiff.conf (deprecated))",
+            "Configuration files: /etc/docdiff/docdiff.conf, ~/.config/docdiff/docdiff.conf, ",
+            "or ~/etc/docdiff/docdiff.conf (deprecated)",
           )
         end
 
@@ -246,6 +257,8 @@ class DocDiff
         config_from_env_vars = {}
         if (pager = ENV["DOCDIFF_PAGER"]) && !pager.empty?
           config_from_env_vars[:pager] = pager
+        elsif (pager = ENV["PAGER"]) && !pager.empty?
+          config_from_env_vars[:pager] = pager
         end
 
         config_in_effect = DocDiff::DEFAULT_CONFIG.dup

data/lib/docdiff/document.rb

@@ -54,92 +54,92 @@ class DocDiff
       @body.eol = eolstr
     end
 
-    def split_to_line
-      @body.split_to_line
+    def to_lines
+      @body.to_lines
     end
 
-    def split_to_word
-      @body.split_to_word
+    def to_words
+      @body.to_words
     end
 
-    def split_to_char
-      @body.split_to_char
+    def to_chars
+      @body.to_chars
     end
 
-    def split_to_byte
-      @body.split_to_byte
+    def to_bytes
+      @body.to_bytes
     end
 
-    def count_line
-      @body.count_line
+    def count_lines
+      @body.count_lines
     end
 
-    def count_blank_line
-      @body.count_blank_line
+    def count_blank_lines
+      @body.count_blank_lines
     end
 
-    def count_empty_line
-      @body.count_empty_line
+    def count_empty_lines
+      @body.count_empty_lines
     end
 
-    def count_graph_line
-      @body.count_graph_line
+    def count_graph_lines
+      @body.count_graph_lines
     end
 
-    def count_word
-      @body.count_word
+    def count_words
+      @body.count_words
     end
 
-    def count_latin_word
-      @body.count_latin_word
+    def count_latin_words
+      @body.count_latin_words
     end
 
-    def count_ja_word
-      @body.count_ja_word
+    def count_ja_words
+      @body.count_ja_words
     end
 
-    def count_valid_word
-      @body.count_valid_word
+    def count_valid_words
+      @body.count_valid_words
     end
 
-    def count_latin_valid_word
-      @body.count_latin_valid_word
+    def count_latin_valid_words
+      @body.count_latin_valid_words
     end
 
-    def count_ja_valid_word
-      @body.count_ja_valid_word
+    def count_ja_valid_words
+      @body.count_ja_valid_words
     end
 
-    def count_char
-      @body.count_char
+    def count_chars
+      @body.count_chars
     end
 
-    def count_blank_char
-      @body.count_blank_char
+    def count_blank_chars
+      @body.count_blank_chars
     end
 
-    def count_graph_char
-      @body.count_graph_char
+    def count_graph_chars
+      @body.count_graph_chars
     end
 
-    def count_latin_blank_char
-      @body.count_latin_blank_char
+    def count_latin_blank_chars
+      @body.count_latin_blank_chars
     end
 
-    def count_latin_graph_char
-      @body.count_latin_graph_char
+    def count_latin_graph_chars
+      @body.count_latin_graph_chars
     end
 
-    def count_ja_blank_char
-      @body.count_ja_blank_char
+    def count_ja_blank_chars
+      @body.count_ja_blank_chars
     end
 
-    def count_ja_graph_char
-      @body.count_ja_graph_char
+    def count_ja_graph_chars
+      @body.count_ja_graph_chars
     end
 
-    def count_byte
-      @body.count_byte
+    def count_bytes
+      @body.count_bytes
     end
 
     def eol_char

data/lib/docdiff/encoding/en_ascii.rb

@@ -53,22 +53,22 @@ class DocDiff
       ].join
 
       # override default method, as ASCII has no Japanese in it
-      def count_ja_graph_char
+      def count_ja_graph_chars
         0
       end
 
       # override default method, as ASCII has no Japanese in it
-      def count_ja_blank_char
+      def count_ja_blank_chars
         0
       end
 
       # override default method, as ASCII has no Japanese in it
-      def count_ja_word
+      def count_ja_words
         0
       end
 
       # override default method, as ASCII has no Japanese in it
-      def count_ja_valid_word
+      def count_ja_valid_words
         0
       end
 

data/lib/docdiff/version.rb

@@ -1,3 +1,3 @@
 module Docdiff
-  VERSION = "0.6.7"
+  VERSION = "0.7.0"
 end

data/lib/docdiff/view.rb

@@ -107,6 +107,20 @@ class DocDiff
       nil
     end
 
+    def format_line_number(n1, n2 = nil, paren: false)
+      content =
+        if n2
+          "LL#{n1}-#{n2}"
+        else
+          "L#{n1}"
+        end
+      if paren
+        "(#{content})"
+      else
+        content
+      end
+    end
+
     CONTEXT_PRE_LENGTH  = 32
     CONTEXT_POST_LENGTH = 32
     def apply_style_digest(tags, headfoot = true)
@@ -180,17 +194,17 @@ class DocDiff
         when :change_elt
           range1 =
             if span1 > 1
-              "#{d1l}-#{d1l + span1 - 1}"
+              format_line_number(d1l, (d2l + span1 - 1))
             else
-              d1l.to_s
+              format_line_number(d1l)
             end
           range2 =
             if span2 > 1
-              "#{d2l}-#{d2l + span2 - 1}"
+              format_line_number(d2l, (d2l + span2 - 1))
             else
-              d2l.to_s
+              format_line_number(d2l)
             end
-          pos_str = "#{range1},#{range2}"
+          pos_str = "#{range1}, #{range2}"
           case display
           when "inline"
             result << (e_head.call(pos_str) + e_cxt_pre + e_chg + e_cxt_post + e_foot)
@@ -202,13 +216,13 @@ class DocDiff
         when :del_elt
           range1 =
             if span1 > 1
-              "#{d1l}-#{d1l + span1 - 1}"
+              format_line_number(d1l, (d1l + span1 - 1))
             else
-              d1l.to_s
+              format_line_number(d1l)
             end
           range2 =
-            "(#{d2l})"
-          pos_str = "#{range1},#{range2}"
+            format_line_number(d2l, paren: true)
+          pos_str = "#{range1}, #{range2}"
           case display
           when "inline"
             result << (e_head.call(pos_str) + e_cxt_pre + e_del + e_cxt_post + e_foot)
@@ -219,14 +233,14 @@ class DocDiff
           end
         when :add_elt
           range1 =
-            "(#{d1l})"
+            format_line_number(d1l, paren: true)
           range2 =
             if span2 > 1
-              "#{d2l}-#{d2l + span2 - 1}"
+              format_line_number(d2l, (d2l + span2 - 1))
             else
-              d2l.to_s
+              format_line_number(d2l)
             end
-          pos_str = "#{range1},#{range2}"
+          pos_str = "#{range1}, #{range2}"
           case display
           when "inline"
             result << (e_head.call(pos_str) + e_cxt_pre + e_add + e_cxt_post + e_foot)