pretty_please 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35a3e562b4bd340a6628de8a9c3533f2c28704b79df394864eadc91420a6dc01
-  data.tar.gz: b2ec7be1ae8b8f455a3571b2f5c98d2b83f876155013e2b72810a7bfc6a34e03
+  metadata.gz: 365d9e2915676455efdca0dd386d189d4df6f7d325e3221b02e111eb8dbc5d9a
+  data.tar.gz: 33194dec65f5ac364c5b57d52f6ae8e8c52c5fde43a5b74fbbc2c05c52ed7e58
 SHA512:
-  metadata.gz: 24c75e11a326b3e29c5025cdc661f446c706785f7b6921aac96d9f4dbc9ce63ba75c1264e69ee0d76434de5f4f93d192ae7956e8f9cab2f296c8e603e5368dd7
-  data.tar.gz: fd7a14399e83fe7d9eb05807b3126174bc54c5af1eed65ac3dd655f5e193cb85403defecf123a8c804ec122df1c02982bb3ddf67444927929ed376507f804108
+  metadata.gz: 284a2deff3f55ad2164a3e3129509f6911941ad14c0de62910fab2c95249e3f3537fcebc80d674a62c8a0a3df37b06b012df0f08e6c075468016bdf0912cbb71
+  data.tar.gz: f50010b485d24b5bd81c168bf9e5bed082283f5473ca4b87d79b9b341928fbe236a9477b57ecb07b654273f37e4262d88877c5b8433a078feea28cdeb2f3d088

data/README.md

@@ -25,7 +25,7 @@ gem install pretty_please
 
 `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.
+The `PrettyPlease.prettify` 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.
 
@@ -34,7 +34,7 @@ It handles a variety of data types including Hashes, Arrays, Sets, Modules, and
 ```ruby
 require "pretty_please"
 
-puts PrettyPlease.inspect({ a: 1, b: [2, 3], c: { d: 4 } })
+puts PrettyPlease.prettify({ a: 1, b: [2, 3], c: { d: 4 } })
 ```
 
 **Output:**
@@ -49,11 +49,11 @@ puts PrettyPlease.inspect({ a: 1, b: [2, 3], c: { d: 4 } })
 
 **Options:**
 
-- `object`: (required) – The object to inspect and format.
+- `object`: (required) – The object to prettify 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.
+- `max_items`: 10 (Integer) – The maximum number of instance variables to display for objects.
 
 ### Development
 

data/lib/pretty_please/{inspect.rb → prettifier.rb}

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-class PrettyPlease::Inspect
+class PrettyPlease::Prettifier
 	Null = Object.new
 
 	def self.call(object, ...)
@@ -22,11 +22,11 @@ class PrettyPlease::Inspect
 	end
 
 	def call(object)
-		inspect(object)
+		prettify(object)
 		@buffer
 	end
 
-	def inspect(object)
+	def prettify(object)
 		original_object = @original_object
 
 		if original_object == Null
@@ -40,8 +40,8 @@ class PrettyPlease::Inspect
 
 		@stack.push(object)
 
-		if object.respond_to?(:pretty_please_inspect)
-			object.pretty_please_inspect(self)
+		if object.respond_to?(:pretty_please)
+			object.pretty_please(self)
 		else
 			case object
 			when Symbol, String, Integer, Float, Regexp, Range, Rational, Complex, TrueClass, FalseClass, NilClass
@@ -54,7 +54,7 @@ class PrettyPlease::Inspect
 				push %(#{object.class.name}("#{object}"))
 			when Array
 				push "["
-				map(object) { |it| capture { inspect(it) } }
+				map(object) { |it| capture { prettify(it) } }
 				push "]"
 			when Exception
 				push %(#{object.class.name}("#{object.message}"))
@@ -63,10 +63,10 @@ class PrettyPlease::Inspect
 				map(object, around_inline: " ") do |key, value|
 					case key
 					when Symbol
-						"#{key.name}: #{capture { inspect(value) }}"
+						"#{key.name}: #{capture { prettify(value) }}"
 					else
-						key = capture { inspect(key) }
-						value = capture { inspect(value) }
+						key = capture { prettify(key) }
+						value = capture { prettify(value) }
 						"#{key} => #{value}"
 					end
 				end
@@ -74,16 +74,16 @@ class PrettyPlease::Inspect
 			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) }}" }
+				map(items) { |key, value| "#{key}: #{capture { prettify(value) }}" }
 				push ")"
 			when defined?(Set) && Set
 				push "Set["
-				map(object.to_a.sort) { |it| capture { inspect(it) } }
+				map(object.to_a.sort) { |it| capture { prettify(it) } }
 				push "]"
 			else
 				push "#{object.class.name}("
 				map(object.instance_variables) do |name|
-					"#{name} = #{capture { inspect(object.instance_variable_get(name)) }}"
+					"#{name} = #{capture { prettify(object.instance_variable_get(name)) }}"
 				end
 				push ")"
 			end

data/lib/pretty_please/version.rb

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

data/lib/pretty_please.rb

@@ -4,13 +4,18 @@ require "pretty_please/version"
 require "dispersion"
 
 module PrettyPlease
-	autoload :Inspect, "pretty_please/inspect"
+	autoload :Prettifier, "pretty_please/prettifier"
 
 	def self.print(object)
 		puts Dispersion.ansi(inspect(object))
 	end
 
 	def self.inspect(...)
-		Inspect::(...)
+		warn "PrettyPlease.inspect is deprecated. Use PrettyPlease.prettify instead."
+		prettify(...)
+	end
+
+	def self.prettify(...)
+		Prettifier::(...)
 	end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pretty_please
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Joel Drapper
 - Marco Roth
 bindir: bin
 cert_chain: []
-date: 2025-02-04 00:00:00.000000000 Z
+date: 2025-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dispersion
@@ -35,7 +35,7 @@ files:
 - LICENSE.txt
 - README.md
 - lib/pretty_please.rb
-- lib/pretty_please/inspect.rb
+- lib/pretty_please/prettifier.rb
 - lib/pretty_please/version.rb
 homepage: https://github.com/joeldrapper/pretty_please
 licenses: