string-format 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: b29841a689a4ec3e6fba4c7aad34fd683db3ed2b0b012ddd6e63d16b009a1ec4
+  data.tar.gz: a1b5eba4869899ce137f364b0508d6d4606b13f2d3a940646887272b8080a3c6
+SHA512:
+  metadata.gz: fd7c94eb13f3809660790154f460c869d21c760d33f941b2e812d22cb66fc037ef182d5eb74e640d64c2fa26476d8ec08e2e7793095b08f867dfa4ea0c775c23
+  data.tar.gz: 6cbf6163f08194f0b56df5ba03f63d6a2c4aaaaf0b4d614de8626e8cb8ce9a58e9df6046fa4fe6572c86009711d823620ba87cea3ee6d1479518f1a23822b723

data/lib/string/format/count.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	UNITS = [nil, "K", "M", "B", "T", "P", "E", "Z", "Y"]
+	
+	# Format a count into a human-readable string.
+	# @parameter value [Numeric] The count to format.
+	# @parameter units [Array] The units to use for formatting (default: UNITS).
+	# @parameter scale [Numeric] The scaling factor between units (default: 1000).
+	# @returns [String] A formatted string representing the count.
+	def count(value, units = UNITS, scale: 1000)
+		value = value
+		index = 0
+		limit = units.size - 1
+		
+		# Handle negative numbers by working with absolute value:
+		negative = value < 0
+		value = value.abs
+		
+		while value >= scale and index < limit
+			value = value / scale.to_f
+			index += 1
+		end
+		
+		result = String.new
+		result << "-" if negative
+		result << value.round(2).to_s
+		result << units[index].to_s if units[index]
+		
+		return result
+	end
+	
+	module_function :count
+end

data/lib/string/format/decimal.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	# Format a numeric value as a decimal with specified precision.
+	# @parameter value [Numeric] The numeric value to format.
+	# @parameter precision [Integer] Number of decimal places (default: 2).
+	# @returns [String] A formatted decimal string.
+	def decimal(value, precision: 2)
+		value.round(precision).to_s
+	end
+	
+	module_function :decimal
+end

data/lib/string/format/ratio.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	# Format a ratio as "current/total" with human-readable counts.
+	# @parameter current [Numeric] The current value.
+	# @parameter total [Numeric] The total value.
+	# @returns [String] A formatted ratio string.
+	def ratio(current, total)
+		"#{count(current)}/#{count(total)}"
+	end
+	
+	module_function :ratio
+end

data/lib/string/format/snake_case.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	# Convert a string to `snake_case`.
+	# @parameter string [String] The string to convert.
+	# @returns [String] A snake_cased string.
+	def snake_case(string)
+		string = string.gsub("::", "")
+		string.gsub!(/(?<=[a-z])(?=[A-Z])|(?<=[A-Z])(?=[A-Z][a-z])/, "_")
+		string.downcase!
+		string.sub!(/^_+/, "")
+		
+		return string
+	end
+	
+	module_function :snake_case
+end

data/lib/string/format/statistics.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	# Format multiple statistics into a compact string.
+	# @parameter pairs [Hash] Hash of statistic names to values or [current, total] arrays.
+	# @returns [String] A formatted statistics string.
+	def statistics(**pairs)
+		pairs.map do |key, value|
+			case value
+			when Array
+				value = value.map(&method(:count)).join("/")
+			when Numeric
+				value = count(value)
+			end
+			
+			"#{key.to_s.upcase}=#{value}"
+		end.join(" ")
+	end
+	
+	module_function :statistics
+end

data/lib/string/format/title_case.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+module String::Format
+	# Convert a string to title case.
+	# @parameter string [String] The string to convert.
+	# @returns [String] A title-cased string.
+	def title_case(string)
+		string = string.gsub(/(^|[ \-_])(.)/){" " + $2.upcase}
+		string.strip!
+		
+		return string
+	end
+	
+	module_function :title_case
+end

data/lib/string/format/version.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+# @namespace
+class String
+	# @namespace
+	module Format
+		VERSION = "0.1.0"
+	end
+end

data/lib/string/format.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+# Released under the MIT License.
+# Copyright, 2025, by Samuel Williams.
+
+require_relative "format/version"
+require_relative "format/count"
+require_relative "format/ratio"
+require_relative "format/decimal"
+require_relative "format/title_case"
+require_relative "format/snake_case"
+require_relative "format/statistics"
+
+module String::Format
+end

data/license.md

@@ -0,0 +1,21 @@
+# MIT License
+
+Copyright, 2025, by Samuel Williams.  
+
+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,35 @@
+# String::Format
+
+Formatting utilities for strings, providing consistent human-readable formatting for numbers, counts, ratios, and statistics.
+
+[![Development Status](https://github.com/socketry/string-format/workflows/Test/badge.svg)](https://github.com/socketry/string-format/actions?workflow=Test)
+
+## Usage
+
+Please see the [project documentation](https://socketry.github.io/string-format/) for more details.
+
+  - [Getting Started](https://socketry.github.io/string-format/guides/getting-started/index) - This guide explains how to get started with `string-format` to format numbers, ratios, and strings for display purposes.
+
+## Releases
+
+Please see the [project releases](https://socketry.github.io/string-format/releases/index) for all releases.
+
+### v0.1.0
+
+## Contributing
+
+We welcome contributions to this project.
+
+1.  Fork it.
+2.  Create your feature branch (`git checkout -b my-new-feature`).
+3.  Commit your changes (`git commit -am 'Add some feature'`).
+4.  Push to the branch (`git push origin my-new-feature`).
+5.  Create new Pull Request.
+
+### Developer Certificate of Origin
+
+In order to protect users of this project, we require all contributors to comply with the [Developer Certificate of Origin](https://developercertificate.org/). This ensures that all contributions are properly licensed and attributed.
+
+### Community Guidelines
+
+This project is best served by a collaborative and respectful environment. Treat each other professionally, respect differing viewpoints, and engage constructively. Harassment, discrimination, or harmful behavior is not tolerated. Communicate clearly, listen actively, and support one another. If any issues arise, please inform the project maintainers.

data/releases.md

@@ -0,0 +1,3 @@
+# Releases
+
+## v0.1.0

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification
+name: string-format
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Williams
+bindir: bin
+cert_chain:
+- |
+  -----BEGIN CERTIFICATE-----
+  MIIE2DCCA0CgAwIBAgIBATANBgkqhkiG9w0BAQsFADBhMRgwFgYDVQQDDA9zYW11
+  ZWwud2lsbGlhbXMxHTAbBgoJkiaJk/IsZAEZFg1vcmlvbnRyYW5zZmVyMRIwEAYK
+  CZImiZPyLGQBGRYCY28xEjAQBgoJkiaJk/IsZAEZFgJuejAeFw0yMjA4MDYwNDUz
+  MjRaFw0zMjA4MDMwNDUzMjRaMGExGDAWBgNVBAMMD3NhbXVlbC53aWxsaWFtczEd
+  MBsGCgmSJomT8ixkARkWDW9yaW9udHJhbnNmZXIxEjAQBgoJkiaJk/IsZAEZFgJj
+  bzESMBAGCgmSJomT8ixkARkWAm56MIIBojANBgkqhkiG9w0BAQEFAAOCAY8AMIIB
+  igKCAYEAomvSopQXQ24+9DBB6I6jxRI2auu3VVb4nOjmmHq7XWM4u3HL+pni63X2
+  9qZdoq9xt7H+RPbwL28LDpDNflYQXoOhoVhQ37Pjn9YDjl8/4/9xa9+NUpl9XDIW
+  sGkaOY0eqsQm1pEWkHJr3zn/fxoKPZPfaJOglovdxf7dgsHz67Xgd/ka+Wo1YqoE
+  e5AUKRwUuvaUaumAKgPH+4E4oiLXI4T1Ff5Q7xxv6yXvHuYtlMHhYfgNn8iiW8WN
+  XibYXPNP7NtieSQqwR/xM6IRSoyXKuS+ZNGDPUUGk8RoiV/xvVN4LrVm9upSc0ss
+  RZ6qwOQmXCo/lLcDUxJAgG95cPw//sI00tZan75VgsGzSWAOdjQpFM0l4dxvKwHn
+  tUeT3ZsAgt0JnGqNm2Bkz81kG4A2hSyFZTFA8vZGhp+hz+8Q573tAR89y9YJBdYM
+  zp0FM4zwMNEUwgfRzv1tEVVUEXmoFCyhzonUUw4nE4CFu/sE3ffhjKcXcY//qiSW
+  xm4erY3XAgMBAAGjgZowgZcwCQYDVR0TBAIwADALBgNVHQ8EBAMCBLAwHQYDVR0O
+  BBYEFO9t7XWuFf2SKLmuijgqR4sGDlRsMC4GA1UdEQQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MC4GA1UdEgQnMCWBI3NhbXVlbC53aWxs
+  aWFtc0BvcmlvbnRyYW5zZmVyLmNvLm56MA0GCSqGSIb3DQEBCwUAA4IBgQB5sxkE
+  cBsSYwK6fYpM+hA5B5yZY2+L0Z+27jF1pWGgbhPH8/FjjBLVn+VFok3CDpRqwXCl
+  xCO40JEkKdznNy2avOMra6PFiQyOE74kCtv7P+Fdc+FhgqI5lMon6tt9rNeXmnW/
+  c1NaMRdxy999hmRGzUSFjozcCwxpy/LwabxtdXwXgSay4mQ32EDjqR1TixS1+smp
+  8C/NCWgpIfzpHGJsjvmH2wAfKtTTqB9CVKLCWEnCHyCaRVuKkrKjqhYCdmMBqCws
+  JkxfQWC+jBVeG9ZtPhQgZpfhvh+6hMhraUYRQ6XGyvBqEUe+yo6DKIT3MtGE2+CP
+  eX9i9ZWBydWb8/rvmwmX2kkcBbX0hZS1rcR593hGc61JR6lvkGYQ2MYskBveyaxt
+  Q2K9NVun/S785AP05vKkXZEFYxqG6EW012U4oLcFl5MySFajYXRYbuUpH6AY+HP8
+  voD0MPg1DssDLKwXyt1eKD/+Fq0bFWhwVM/1XiAXL7lyYUyOq24KHgQ2Csg=
+  -----END CERTIFICATE-----
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies: []
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/string/format.rb
+- lib/string/format/count.rb
+- lib/string/format/decimal.rb
+- lib/string/format/ratio.rb
+- lib/string/format/snake_case.rb
+- lib/string/format/statistics.rb
+- lib/string/format/title_case.rb
+- lib/string/format/version.rb
+- license.md
+- readme.md
+- releases.md
+homepage: https://github.com/socketry/string-format
+licenses:
+- MIT
+metadata:
+  documentation_uri: https://socketry.github.io/string-format/
+  source_code_uri: https://github.com/socketry/string-format.git
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '3.2'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.9
+specification_version: 4
+summary: Formatting utilities for strings.
+test_files: []