philiprehberger-string_kit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5860e5af85b84c9b5febcb56424bed3960dc4d26d193b2edf748f3138a59f2db
+  data.tar.gz: a84f3f30e15ea382ebd28f89ea9bb61120dce7e8c403d970a0b1f2963b505ab9
+SHA512:
+  metadata.gz: 8622621d3904e9425ea98f91598aecaa4749c81dd9be692ced0503202e21690310138928af2e1cb742160a4569156fab435e8abf31111f4302fc26a1f59b054b
+  data.tar.gz: 7cfa9aa53ecc255ae7bca4e10755f5da08eec04587fd4185ff74a51a6619c4b4c1734aa4bb7d4cea37cead99ffa1e06e0fd917ef884875913a781a732923d7a9

data/CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+All notable changes to this gem will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this gem adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.0] - 2026-03-22
+
+### Added
+
+- Initial release
+- Case conversion: titlecase, kebab_case, camel_case, pascal_case, snake_case, constant_case
+- HTML stripping and whitespace normalization
+- Word counting and reading time estimation
+- Excerpt extraction around a phrase
+- String squeeze, indent, and dedent utilities

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 philiprehberger
+
+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,87 @@
+# philiprehberger-string_kit
+
+[![Tests](https://github.com/philiprehberger/rb-string-kit/actions/workflows/ci.yml/badge.svg)](https://github.com/philiprehberger/rb-string-kit/actions/workflows/ci.yml)
+[![Gem Version](https://badge.fury.io/rb/philiprehberger-string_kit.svg)](https://rubygems.org/gems/philiprehberger-string_kit)
+[![License](https://img.shields.io/github/license/philiprehberger/rb-string-kit)](LICENSE)
+
+Comprehensive string utilities without ActiveSupport dependency
+
+## Requirements
+
+- Ruby >= 3.1
+
+## Installation
+
+Add to your Gemfile:
+
+```ruby
+gem 'philiprehberger-string_kit'
+```
+
+Or install directly:
+
+```bash
+gem install philiprehberger-string_kit
+```
+
+## Usage
+
+```ruby
+require 'philiprehberger/string_kit'
+
+Philiprehberger::StringKit.titlecase('hello world')       # => "Hello World"
+Philiprehberger::StringKit.kebab_case('helloWorld')        # => "hello-world"
+Philiprehberger::StringKit.camel_case('hello world')       # => "helloWorld"
+Philiprehberger::StringKit.pascal_case('hello world')      # => "HelloWorld"
+Philiprehberger::StringKit.snake_case('Hello World')       # => "hello_world"
+Philiprehberger::StringKit.constant_case('hello world')    # => "HELLO_WORLD"
+```
+
+### Text Processing
+
+```ruby
+Philiprehberger::StringKit.strip_html('<p>hello</p>')          # => "hello"
+Philiprehberger::StringKit.normalize_whitespace('a   b')       # => "a b"
+Philiprehberger::StringKit.word_count('hello world foo')       # => 3
+Philiprehberger::StringKit.reading_time(long_text, wpm: 200)  # => 2
+```
+
+### Excerpt and Indentation
+
+```ruby
+Philiprehberger::StringKit.excerpt(text, 'fox', radius: 10)   # => "...brown fox jumps..."
+Philiprehberger::StringKit.squeeze('aaabbb')                   # => "ab"
+Philiprehberger::StringKit.indent("hello\nworld", 2)           # => "  hello\n  world"
+Philiprehberger::StringKit.dedent("    hello\n    world")      # => "hello\nworld"
+```
+
+## API
+
+| Method | Description |
+|--------|-------------|
+| `StringKit.titlecase(str)` | Convert string to Title Case |
+| `StringKit.kebab_case(str)` | Convert string to kebab-case |
+| `StringKit.camel_case(str)` | Convert string to camelCase |
+| `StringKit.pascal_case(str)` | Convert string to PascalCase |
+| `StringKit.snake_case(str)` | Convert string to snake_case |
+| `StringKit.constant_case(str)` | Convert string to CONSTANT_CASE |
+| `StringKit.strip_html(str)` | Remove HTML tags from string |
+| `StringKit.normalize_whitespace(str)` | Collapse whitespace to single spaces |
+| `StringKit.word_count(str)` | Count words in string |
+| `StringKit.reading_time(str, wpm:)` | Estimate reading time in minutes |
+| `StringKit.excerpt(str, phrase, radius:)` | Extract text around a phrase |
+| `StringKit.squeeze(str)` | Remove consecutive duplicate characters |
+| `StringKit.indent(str, n)` | Indent each line by n spaces |
+| `StringKit.dedent(str)` | Remove common leading whitespace |
+
+## Development
+
+```bash
+bundle install
+bundle exec rspec      # Run tests
+bundle exec rubocop    # Check code style
+```
+
+## License
+
+MIT

data/lib/philiprehberger/string_kit/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module Philiprehberger
+  module StringKit
+    VERSION = '0.1.0'
+  end
+end

data/lib/philiprehberger/string_kit.rb

@@ -0,0 +1,177 @@
+# frozen_string_literal: true
+
+require_relative 'string_kit/version'
+
+module Philiprehberger
+  module StringKit
+    class Error < StandardError; end
+
+    WORD_BOUNDARY = /[^a-zA-Z0-9\u00C0-\u024F]+/
+
+    # Convert string to Title Case
+    #
+    # @param str [String]
+    # @return [String]
+    def self.titlecase(str)
+      validate!(str)
+      str.gsub(/\b(\w)/) { ::Regexp.last_match(1).upcase }
+    end
+
+    # Convert string to kebab-case
+    #
+    # @param str [String]
+    # @return [String]
+    def self.kebab_case(str)
+      validate!(str)
+      separate_words(str).join('-')
+    end
+
+    # Convert string to camelCase
+    #
+    # @param str [String]
+    # @return [String]
+    def self.camel_case(str)
+      validate!(str)
+      words = separate_words(str)
+      return '' if words.empty?
+
+      words.first + words[1..].map(&:capitalize).join
+    end
+
+    # Convert string to PascalCase
+    #
+    # @param str [String]
+    # @return [String]
+    def self.pascal_case(str)
+      validate!(str)
+      separate_words(str).map(&:capitalize).join
+    end
+
+    # Convert string to snake_case
+    #
+    # @param str [String]
+    # @return [String]
+    def self.snake_case(str)
+      validate!(str)
+      separate_words(str).join('_')
+    end
+
+    # Convert string to CONSTANT_CASE
+    #
+    # @param str [String]
+    # @return [String]
+    def self.constant_case(str)
+      validate!(str)
+      separate_words(str).join('_').upcase
+    end
+
+    # Strip HTML tags from string
+    #
+    # @param str [String]
+    # @return [String]
+    def self.strip_html(str)
+      validate!(str)
+      str.gsub(/<[^>]*>/, '')
+    end
+
+    # Normalize whitespace to single spaces
+    #
+    # @param str [String]
+    # @return [String]
+    def self.normalize_whitespace(str)
+      validate!(str)
+      str.gsub(/\s+/, ' ').strip
+    end
+
+    # Count words in string
+    #
+    # @param str [String]
+    # @return [Integer]
+    def self.word_count(str)
+      validate!(str)
+      str.split(/\s+/).reject(&:empty?).length
+    end
+
+    # Estimate reading time in minutes
+    #
+    # @param str [String]
+    # @param wpm [Integer] words per minute
+    # @return [Float]
+    def self.reading_time(str, wpm: 200)
+      validate!(str)
+      count = word_count(str)
+      (count.to_f / wpm).ceil
+    end
+
+    # Extract excerpt around a phrase
+    #
+    # @param str [String]
+    # @param phrase [String]
+    # @param radius [Integer] number of characters around the phrase
+    # @return [String]
+    def self.excerpt(str, phrase, radius: 32)
+      validate!(str)
+      index = str.downcase.index(phrase.downcase)
+      return '' if index.nil?
+
+      start_pos = [index - radius, 0].max
+      end_pos = [index + phrase.length + radius, str.length].min
+
+      result = str[start_pos...end_pos]
+      result = "...#{result}" if start_pos.positive?
+      result = "#{result}..." if end_pos < str.length
+      result
+    end
+
+    # Remove consecutive duplicate characters
+    #
+    # @param str [String]
+    # @return [String]
+    def self.squeeze(str)
+      validate!(str)
+      str.squeeze
+    end
+
+    # Indent each line by n spaces
+    #
+    # @param str [String]
+    # @param n [Integer]
+    # @return [String]
+    def self.indent(str, n)
+      validate!(str)
+      prefix = ' ' * n
+      str.gsub(/^/, prefix)
+    end
+
+    # Remove common leading whitespace from all lines
+    #
+    # @param str [String]
+    # @return [String]
+    def self.dedent(str)
+      validate!(str)
+      lines = str.lines
+      non_empty = lines.reject { |line| line.strip.empty? }
+      return str if non_empty.empty?
+
+      min_indent = non_empty.map { |line| line[/\A\s*/].length }.min
+      lines.map { |line| line.length > min_indent ? line[min_indent..] : line.lstrip }.join
+    end
+
+    class << self
+      private
+
+      def validate!(str)
+        raise Error, 'input must be a String' unless str.is_a?(String)
+      end
+
+      def separate_words(str)
+        str
+          .gsub(/([a-z])([A-Z])/, '\1 \2')
+          .gsub(/[^a-zA-Z0-9]+/, ' ')
+          .strip
+          .downcase
+          .split
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: philiprehberger-string_kit
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Philip Rehberger
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2026-03-22 00:00:00.000000000 Z
+dependencies: []
+description: String case conversion, HTML stripping, whitespace normalization, word
+  counting, reading time estimation, excerpt extraction, indentation, and more.
+email:
+- me@philiprehberger.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- lib/philiprehberger/string_kit.rb
+- lib/philiprehberger/string_kit/version.rb
+homepage: https://github.com/philiprehberger/rb-string-kit
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/philiprehberger/rb-string-kit
+  source_code_uri: https://github.com/philiprehberger/rb-string-kit
+  changelog_uri: https://github.com/philiprehberger/rb-string-kit/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/philiprehberger/rb-string-kit/issues
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.22
+signing_key:
+specification_version: 4
+summary: Comprehensive string utilities without ActiveSupport dependency
+test_files: []