pretty_please 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 35a3e562b4bd340a6628de8a9c3533f2c28704b79df394864eadc91420a6dc01
+  data.tar.gz: b2ec7be1ae8b8f455a3571b2f5c98d2b83f876155013e2b72810a7bfc6a34e03
+SHA512:
+  metadata.gz: 24c75e11a326b3e29c5025cdc661f446c706785f7b6921aac96d9f4dbc9ce63ba75c1264e69ee0d76434de5f4f93d192ae7956e8f9cab2f296c8e603e5368dd7
+  data.tar.gz: fd7a14399e83fe7d9eb05807b3126174bc54c5af1eed65ac3dd655f5e193cb85403defecf123a8c804ec122df1c02982bb3ddf67444927929ed376507f804108

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Joel Drapper
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,73 @@
+## PrettyPlease - Pretty Print Ruby objects as Ruby
+
+PrettyPlease is a pretty-printing library for Ruby that formats objects in a readable and structured way.
+
+PrettyPlease ensures the output is **valid Ruby code**, making it human, machine, and [diff](https://github.com/joeldrapper/difftastic-ruby)-friendly.
+
+> [!NOTE]
+> PrettyPlease is used and was extracted from [`difftastic-ruby`](https://github.com/joeldrapper/difftastic-ruby).
+
+### Installation
+
+Install the gem and add it to the application's `Gemfile` by executing:
+
+```shell
+bundle add pretty_please
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```shell
+gem install pretty_please
+```
+
+### Usage
+
+`PrettyPlease.print(object)` prints the object with ANSI highlighting.
+
+The `PrettyPlease.inspect` method provides a structured and human-readable representation of Ruby objects by outputting valid Ruby code.
+
+It handles a variety of data types including Hashes, Arrays, Sets, Modules, and user-defined objects.
+
+#### Basic Usage
+
+```ruby
+require "pretty_please"
+
+puts PrettyPlease.inspect({ a: 1, b: [2, 3], c: { d: 4 } })
+```
+
+**Output:**
+
+```ruby
+{
+  a: 1,
+  b: [2, 3],
+  c: { d: 4 },
+}
+```
+
+**Options:**
+
+- `object`: (required) – The object to inspect and format.
+- `tab_width`: 2 (Integer) – The number of spaces (or tabs) per indentation level.
+- `max_width`: 60 (Integer) – The maximum width before elements are split into multiple lines.
+- `max_depth`: 5 (Integer) – The maximum depth of nested structures before truncation.
+- `max_instance_variables`: 10 (Integer) – The maximum number of instance variables to display for objects.
+
+### Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+### Contributing
+
+> [!WARNING]
+> Object diffs in `assert_equal` test output are self-hosted. That means if you mess up the output, the tests might not tell you since they are driven by the output. Most of the tests use `assert_equal_ruby`, which is not driven by PrettyPlease.
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/joeldrapper/pretty_please. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/joeldrapper/pretty_please/blob/main/CODE_OF_CONDUCT.md).
+
+### Code of Conduct
+
+Everyone interacting in the `PrettyPlease` project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/joeldrapper/pretty_please/blob/main/CODE_OF_CONDUCT.md).

data/lib/pretty_please/inspect.rb

@@ -0,0 +1,165 @@
+# frozen_string_literal: true
+
+class PrettyPlease::Inspect
+	Null = Object.new
+
+	def self.call(object, ...)
+		new(...).call(object)
+	end
+
+	def initialize(indent: 0, tab_width: 2, max_width: 30, max_items: 10, max_depth: 5)
+		@indent = indent
+		@tab_width = tab_width
+		@max_width = max_width
+		@max_items = max_items
+		@max_depth = max_depth
+		@indent_bytes = " " * @tab_width
+
+		@buffer = +""
+		@lines = 0 # note, this is not reset within a capture
+		@stack = []
+		@original_object = Null
+	end
+
+	def call(object)
+		inspect(object)
+		@buffer
+	end
+
+	def inspect(object)
+		original_object = @original_object
+
+		if original_object == Null
+			@original_object = object
+		else
+			if original_object.equal?(object)
+				push "self"
+				return
+			end
+		end
+
+		@stack.push(object)
+
+		if object.respond_to?(:pretty_please_inspect)
+			object.pretty_please_inspect(self)
+		else
+			case object
+			when Symbol, String, Integer, Float, Regexp, Range, Rational, Complex, TrueClass, FalseClass, NilClass
+				push object.inspect
+			when Module
+				push object.name
+			when Pathname, File
+				push %(#{object.class.name}("#{object.to_path}"))
+			when MatchData, (defined?(Date) && Date), (defined?(DateTime) && DateTime), (defined?(Time) && Time), (defined?(URI) && URI)
+				push %(#{object.class.name}("#{object}"))
+			when Array
+				push "["
+				map(object) { |it| capture { inspect(it) } }
+				push "]"
+			when Exception
+				push %(#{object.class.name}("#{object.message}"))
+			when Hash
+				push "{"
+				map(object, around_inline: " ") do |key, value|
+					case key
+					when Symbol
+						"#{key.name}: #{capture { inspect(value) }}"
+					else
+						key = capture { inspect(key) }
+						value = capture { inspect(value) }
+						"#{key} => #{value}"
+					end
+				end
+				push "}"
+			when Struct, defined?(Data) && Data
+				push "#{object.class.name}("
+				items = object.members.map { |key| [key, object.__send__(key)] }
+				map(items) { |key, value| "#{key}: #{capture { inspect(value) }}" }
+				push ")"
+			when defined?(Set) && Set
+				push "Set["
+				map(object.to_a.sort) { |it| capture { inspect(it) } }
+				push "]"
+			else
+				push "#{object.class.name}("
+				map(object.instance_variables) do |name|
+					"#{name} = #{capture { inspect(object.instance_variable_get(name)) }}"
+				end
+				push ")"
+			end
+		end
+
+		@stack.pop
+	end
+
+	def map(object, around_inline: nil)
+		if @stack.size >= @max_depth
+			push "..."
+			return
+		end
+
+		return unless object.any?
+
+		length = 0
+		length += around_inline.bytesize * 2 if around_inline
+
+		original_lines = @lines
+		exceeds_max_items = object.length > @max_items
+
+		items = indent do
+			object.take(@max_items).map do |item|
+				pretty_item = yield(item)
+				length += pretty_item.bytesize + 2 # for the ", "
+				pretty_item
+			end
+		end
+
+		if (@lines > original_lines) || (length > @max_width)
+			indent do
+				items.each do |item|
+					newline
+					push item
+					push ","
+				end
+
+				if exceeds_max_items
+					newline
+					push "..."
+				end
+			end
+			newline
+
+		else
+			push around_inline
+			push items.join(", ")
+			push ", ..." if exceeds_max_items
+			push around_inline
+		end
+	end
+
+	def indent
+		@indent += 1
+		value = yield
+		@indent -= 1
+		value
+	end
+
+	def newline
+		@lines += 1
+		push "\n#{@indent_bytes * @indent}"
+	end
+
+	def push(string)
+		return unless string
+		@buffer << string
+	end
+
+	def capture
+		original_buffer = @buffer
+		new_buffer = +""
+		@buffer = new_buffer
+		yield
+		@buffer = original_buffer
+		new_buffer
+	end
+end

data/lib/pretty_please/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PrettyPlease
+	VERSION = "0.1.0"
+end

data/lib/pretty_please.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "pretty_please/version"
+require "dispersion"
+
+module PrettyPlease
+	autoload :Inspect, "pretty_please/inspect"
+
+	def self.print(object)
+		puts Dispersion.ansi(inspect(object))
+	end
+
+	def self.inspect(...)
+		Inspect::(...)
+	end
+end

metadata

@@ -0,0 +1,65 @@
+--- !ruby/object:Gem::Specification
+name: pretty_please
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Joel Drapper
+- Marco Roth
+bindir: bin
+cert_chain: []
+date: 2025-02-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dispersion
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+description: Print Ruby objects as Ruby
+email:
+- joel@drapper.me
+- marco.roth@intergga.ch
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/pretty_please.rb
+- lib/pretty_please/inspect.rb
+- lib/pretty_please/version.rb
+homepage: https://github.com/joeldrapper/pretty_please
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/joeldrapper/pretty_please
+  source_code_uri: https://github.com/joeldrapper/pretty_please
+  funding_uri: https://github.com/sponsors/joeldrapper
+  rubygems_mfa_required: 'true'
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.1'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: Print Ruby objects as Ruby
+test_files: []