RubyGems - difftastic - Versions diffs - 0.2.0 → 0.3.0 - Mend

difftastic 0.2.0 → 0.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

checksums.yaml CHANGED Viewed

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 31125243809498f1920e30f4c8f2dc681e6862a2c06f4c7c9314eb717f30bdfb
-  data.tar.gz: ae9612238b4267ada429d79611ec0dcbfe694b319d601dac4a402e9212b0c372
+  metadata.gz: 207e850cc699486c73de8d32b74bd42cb3d13f2a67027038bef770483d24b0e7
+  data.tar.gz: 43ade182f9cedb9203a02afaab34f814ea4f38f6c38f3bbadefca756a23674d6
 SHA512:
-  metadata.gz: feef6a85bb995f6678115c0edfafc41a73b19c2927466790eb75151010c526968d1881a9e84bfe02793516028d8325eb41747219de1ac1af1363c7057533fa2a
-  data.tar.gz: a53103ffbcc0fcbf5e074c13a91b6da0c965d8a50b48304f65a42137dd3334612f90f5b3e42ea0668b37b895af4bcfdc316dcaaf78c8f8f4f6461db85a995791
+  metadata.gz: 786f0f2ad6ca34147d93a21d12df4bcf084f8468b82052ea047206cbe3be69c6814f3c7911aabba1d8b17b27fc2b9b5e8f3e6a9a3f0c60d359c60eb0e4f2b624
+  data.tar.gz: bae8870b2892c9398eca3a196446c208fe581f65c0ef58e1f271f41bb1a46aa87279ad96b2ead45d4b97093ae8865d878fa766a2830f2bdc6b5a51bebec37446

data/README.md CHANGED Viewed

@@ -1 +1,104 @@
 # Difftastic Ruby
+A Ruby interface and wrapper for the wonderful [Difftastic](https://difftastic.wilfred.me.uk) CLI tool.
+## Creating a Differ
+First, create a differ with your configuration:
+```ruby
+MY_DIFFER = Difftastic::Differ.new(
+  background: :dark,
+  color: :always,
+  left_label: "Expected",
+  right_label: "Actual"
+)
+```
+## Diffing Objects
+You can diff objects with different configurations:
+```ruby
+a = { foo: 1, bar: [2, 3, 4] }
+b = { foo: 1, bar: [2, 4, 3] }
+puts MY_DIFFER.diff_objects(a, b)
+```
+## Diffing Ruby Code
+You can diff Ruby code:
+```ruby
+a = <<~RUBY
+  def hello
+    puts "Hello, world!"
+  end
+RUBY
+b = <<~RUBY
+  def hello
+    puts "Goodbye, world!"
+  end
+RUBY
+puts MY_DIFFER.diff_ruby(a, b)
+```
+## Additional File Type Methods
+You can also diff other file types using the following methods:
+```ruby
+a = "<html>\n\t<body>\n\t\t<h1>Hello, world!</h1>\n\t</body>\n</html>"
+b = "<html>\n\t<body>\n\t\t<h1>Goodbye, world!</h1>\n\t</body>\n</html>"
+puts MY_DIFFER.diff_html(a, b)
+a = '{ "foo": 1, "bar": 2 }'
+b = '{ "foo": 1, "bar": 3 }'
+puts MY_DIFFER.diff_json(a, b)
+a = "body { color: red; }"
+b = "body { color: blue; }"
+puts MY_DIFFER.diff_css(a, b)
+a = "<note><to>Tove</to><from>Jani</from></note>"
+b = "<note><to>Tove</to><from>John</from></note>"
+puts MY_DIFFER.diff_xml(a, b)
+a = "foo: 1\nbar: 2"
+b = "foo: 1\nbar: 3"
+puts MY_DIFFER.diff_yaml(a, b)
+```
+## Configuring Difftastic::Differ
+You can configure the `Difftastic::Differ` instance with various options:
+- `background`: Set the background color (`:dark` or `:light`).
+- `color`: Set the color mode (`:always`, `:never`, or `:auto`).
+- `syntax_highlight`: Enable or disable syntax highlighting (`:on` or `:off`).
+- `context`: Set the number of context lines to display.
+- `width`: Use this many columns when calculating line wrapping. If not specified, difftastic will detect the terminal width.
+- `tab_width`: Set the tab width for indentation.
+- `parse_error_limit`: Set the limit for parse errors.
+- `underline_highlights`: Enable or disable underlining highlights (`true` or `false`).
+- `left_label`: Set the label for the left side of the diff.
+- `right_label`: Set the label for the right side of the diff.
+- `display`: Set the display mode (`"side-by-side-show-both"`, `"side-by-side"`, or `"inline"`).
+## Pretty Method
+The `Difftastic` module includes a `pretty` method for formatting objects:
+```ruby
+object = { foo: 1, bar: [2, 3, 4] }
+formatted_object = Difftastic.pretty(object)
+puts formatted_object
+```

data/lib/difftastic/differ.rb CHANGED Viewed

@@ -1,22 +1,28 @@
 # frozen_string_literal: true
 class Difftastic::Differ
-	def initialize(background: nil, color: nil, syntax_highlight: nil, context: nil, tab_width: nil, parse_error_limit: nil, underline_highlights: true, left_label: nil, right_label: nil)
+	DEFAULT_TAB_WIDTH = 2
+	def initialize(background: nil, color: nil, syntax_highlight: nil, context: nil, width: nil, tab_width: nil, parse_error_limit: nil, underline_highlights: true, left_label: nil, right_label: nil, display: "side-by-side-show-both")
 		@show_paths = false
 		@background = background => :dark | :light | nil
 		@color = color => :always | :never | :auto | nil
 		@syntax_highlight = syntax_highlight => :on | :off | nil
 		@context = context => Integer | nil
+		@width = width => Integer | nil
 		@tab_width = tab_width => Integer | nil
 		@parse_error_limit = parse_error_limit => Integer | nil
 		@underline_highlights = underline_highlights => true | false
 		@left_label = left_label => String | nil
 		@right_label = right_label => String | nil
+		@display = display
 	end
 	def diff_objects(old, new)
-		old = Difftastic.pretty(old)
-		new = Difftastic.pretty(new)
+		tab_width = @tab_width || DEFAULT_TAB_WIDTH
+		old = Difftastic.pretty(old, tab_width:)
+		new = Difftastic.pretty(new, tab_width:)
 		diff_strings(old, new, file_extension: "rb")
 	end
@@ -290,6 +296,8 @@ class Difftastic::Differ
 			("--background=#{@background}" if @background),
 			("--syntax-highlight=#{@syntax_highlight}" if @syntax_highlight),
 			("--tab-width=#{@tab_width}" if @tab_width),
+			("--display=#{@display}" if @display),
+			("--width=#{@width}" if @width),
 		].compact!
 		result = Difftastic.execute(options.join(" "))
@@ -341,10 +349,15 @@ class Difftastic::Differ
 	private
 	def right_label_offset(line)
+		tab_width = @tab_width || DEFAULT_TAB_WIDTH
 		stripped_line = ::Difftastic::ANSI.strip_formatting(line)
-		_lhs, rhs = stripped_line.split(/\s{#{@tab_width},}/, 2)
+		_lhs, rhs = stripped_line.split(/\s{#{tab_width},}/, 2)
+		index = stripped_line.index("#{' ' * tab_width}#{rhs}")
+		index = @width / 2 if @width && index.nil?
+		index = 0 if index.nil?
-		offset = (stripped_line.index("#{' ' * @tab_width}#{rhs}") || 0) + @tab_width
+		offset = index + tab_width
 		minimum_offset = 29
 		[minimum_offset, offset].max

data/lib/difftastic/version.rb CHANGED Viewed

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 module Difftastic
-	VERSION = "0.2.0"
+	VERSION = "0.3.0"
 end

data/lib/difftastic.rb CHANGED Viewed

@@ -11,6 +11,9 @@ module Difftastic
 	GEM_NAME = "difftastic"
 	DEFAULT_DIR = File.expand_path(File.join(__dir__, "..", "exe"))
+	class ExecutableNotFoundException < StandardError
+	end
 	def self.execute(command)
 		`#{executable} #{command}`
 	end
@@ -71,33 +74,44 @@ module Difftastic
 		exe_file
 	end
-	def self.pretty(object, indent: 0, indent_width: 2, max_width: 80, indentation_bytes: "\t")
+	def self.pretty(object, indent: 0, tab_width: 2, max_width: 60, max_depth: 5, max_instance_variables: 10, original_object: nil)
+		return "self" if object && object == original_object
+		original_object ||= object
 		case object
 		when Hash
+			return "{}" if object.empty?
 			buffer = +"{\n"
 			indent += 1
 			object.each do |key, value|
-				buffer << ("	" * indent)
-				buffer << pretty(key, indent:)
-				buffer << " => "
-				buffer << pretty(value, indent:)
+				buffer << ("\t" * indent)
+				case key
+				when Symbol
+					buffer << "#{key.name}: "
+				else
+					buffer << pretty(key, indent:, original_object:)
+					buffer << " => "
+				end
+				buffer << pretty(value, indent:, original_object:)
 				buffer << ",\n"
 			end
 			indent -= 1
-			buffer << ("	" * indent)
+			buffer << ("\t" * indent)
 			buffer << "}"
 		when Array
 			new_lines = false
 			length = 0
 			items = object.map do |item|
-				pretty_item = pretty(item, indent: indent + 1)
+				pretty_item = pretty(item, indent: indent + 1, original_object:)
 				new_lines = true if pretty_item.include?("\n")
 				length += pretty_item.bytesize
 				pretty_item
 			end
-			if new_lines || length > max_width - (indent * indent_width)
-				"[\n#{indentation_bytes * (indent + 1)}#{items.join(",\n#{indentation_bytes * (indent + 1)}")},\n#{indentation_bytes * indent}]"
+			if new_lines || length > max_width - (indent * tab_width)
+				"[\n#{"\t" * (indent + 1)}#{items.join(",\n#{"\t" * (indent + 1)}")},\n#{"\t" * indent}]"
 			else
 				"[#{items.join(', ')}]"
 			end
@@ -105,36 +119,54 @@ module Difftastic
 			new_lines = false
 			length = 0
 			items = object.to_a.sort!.map do |item|
-				pretty_item = pretty(item, indent: indent + 1)
+				pretty_item = pretty(item, indent: indent + 1, original_object:)
 				new_lines = true if pretty_item.include?("\n")
 				length += pretty_item.bytesize
 				pretty_item
 			end
-			if new_lines || length > max_width - (indent * indent_width)
-				"Set[\n#{indentation_bytes * (indent + 1)}#{items.join(",\n#{indentation_bytes * (indent + 1)}")},\n#{indentation_bytes * indent}]"
+			if new_lines || length > max_width - (indent * tab_width)
+				"Set[\n#{"\t" * (indent + 1)}#{items.join(",\n#{"\t" * (indent + 1)}")},\n#{"\t" * indent}]"
 			else
 				"Set[#{items.join(', ')}]"
 			end
 		when Module
 			object.name
+		when Pathname
+			%(Pathname("#{object.to_path}"))
 		when Symbol, String, Integer, Float, Regexp, Range, Rational, Complex, true, false, nil
 			object.inspect
 		else
 			buffer = +""
 			instance_variables = object.instance_variables
-			if instance_variables.length > 0
+			if instance_variables.length > 0 && indent < max_depth
 				buffer << "#{object.class.name}(\n"
 				indent += 1
-				object.instance_variables.each do |name|
-					buffer << ("	" * indent)
-					buffer << ":#{name} => "
-					buffer << pretty(object.instance_variable_get(name), indent:)
-					buffer << ",\n"
+				if indent < max_depth
+					object.instance_variables.take(max_instance_variables).each do |name|
+						buffer << ("\t" * indent)
+						buffer << name.name
+						buffer << " = "
+						buffer << pretty(object.instance_variable_get(name), indent:, original_object:)
+						buffer << ",\n"
+					end
+					if object.instance_variables.count > max_instance_variables
+						buffer << ("\t" * indent)
+						buffer << "...\n"
+					end
+				else
+					buffer << ("\t" * indent)
+					buffer << "...\n"
 				end
 				indent -= 1
-				buffer << ("	" * indent)
+				buffer << ("\t" * indent)
 				buffer << ")"
+			elsif indent >= max_depth
+				buffer << "#{object.class.name}(...)"
 			else
 				buffer << "#{object.class.name}()"
 			end

metadata CHANGED Viewed

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: difftastic
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joel Drapper
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-01-30 00:00:00.000000000 Z
 dependencies: []
 email:
 - joel@drapper.me