iprog_string_utils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e468b12c337ea75a95a1aadf0046e6495f6982254fd192ca10afdfb7ecadee50
+  data.tar.gz: 58b3f0e5e203c0d1e297c6a53709983b93ed6aa550d4bd6275ec73c58c2878ca
+SHA512:
+  metadata.gz: b53e8ff2f0c6275361bddbcee8d3116252469dba920b1d0dcedb46a4e50068429ec7726e35b65ddc2512af1f5cb2098a8314b4704b37ff703690a9ad6ff716a4
+  data.tar.gz: e30846c690c2afa9c4f9a24aab912ccb4333d2cea87d6905a98fc7da2c6c09fd6af8b3017ef4515decc2551bba23a3beae41917343476a03733a1bb4e7d1ad15

data/.rubocop.yml

@@ -0,0 +1,35 @@
+AllCops:
+  TargetRubyVersion: 3.0
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Lint/MissingSuper:
+  Enabled: false
+
+Metrics/AbcSize:
+ Enabled: false
+
+Metrics/MethodLength:
+ Enabled: false
+
+Metrics/CyclomaticComplexity:
+ Enabled: false
+
+Metrics/PerceivedComplexity:
+  Enabled: false
+
+Metrics/BlockLength:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2024-08-10
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,35 @@
+
+### Usage Section Breakdown
+
+1. **Convert to `camelCase`:**
+   - Demonstrates how to convert a regular string or a PascalCase string to camelCase.
+
+2. **Convert to `snake_case`:**
+   - Shows how to convert different strings to snake_case, handling spaces and mixed cases.
+
+3. **Convert to `kebab-case`:**
+   - Demonstrates converting strings to kebab-case, including those with mixed cases.
+
+4. **Truncate a String with Ellipsis:**
+   - Examples of truncating strings with a default ellipsis or a custom string.
+
+5. **Reverse the Order of Words:**
+   - Shows how to reverse the order of words in a string.
+
+6. **Strip HTML Tags:**
+   - Demonstrates removing HTML tags from a string, leaving just the text content.
+
+7. **Check if a String is a Palindrome:**
+   - Examples of checking if strings are palindromes, including phrases with spaces and punctuation.
+
+8. **Convert to Boolean:**
+   - Demonstrates converting common boolean string values to actual boolean values, with handling for invalid inputs.
+
+9. **Trim Custom Characters:**
+   - Shows how to remove specific characters from the start and end of a string.
+
+### Customization
+
+Feel free to customize the `README.md` further by adding more examples, refining the explanations, or including any additional information relevant to your gem.
+
+Let me know if there's anything else you'd like to add or adjust!

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Jayson Presto
+
+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,128 @@
+# Iprog String Utils
+
+IprogStringUtils is a Ruby gem that extends the `String` class with a set of useful string manipulation utilities. It includes methods for converting strings to various cases, truncating strings, reversing words, stripping HTML tags, and more.
+
+ <img src="https://github.com/iprog21/iprog_export_model_to_xlsx/blob/main/iprog-logo.png" width="150" alt="IPROG TECH" align="right" />
+
+ This gem is provided by [**IPROG TECH**](https://www.iprog.tech/), an information technology company specializing in web development services using Ruby on Rails. IPROG TECH also offers free programming tutorials.
+
+**Providing Good Quality Web Services:**
+- Startup
+- Maintenance
+- Upgrading & Conversion
+
+# Getting Started
+
+## Installation
+To install the gem and add it to your application's Gemfile, run on your terminal:
+
+```bash
+bundle add iprog_string_utils
+```
+
+If you're not using Bundler to manage dependencies, install the gem by running:
+
+```bash
+gem install iprog_string_utils
+```
+
+## Features
+
+- Convert strings to `camelCase`, `snake_case`, and `kebab-case`
+- Truncate strings with an ellipsis
+- Reverse the order of words in a string
+- Strip HTML tags from strings
+- Check if a string is a palindrome
+- Convert strings to boolean values
+- And more!
+
+## Usage
+ ### camel case
+ ```ruby
+ "hello world".camel_case
+ => "helloWorld"
+
+ "Hello World Example".camel_case
+ => "helloWorldExample"
+ ```
+
+### snake case
+```ruby
+"ThisIsATest".snake_case
+=> "this_is_a_test"
+
+"Hello World Example".snake_case
+=> "hello_world_example"
+```
+
+### kebab case
+```ruby
+"Hello World!".kebab_case
+=> "hello-world"
+
+"ThisIsAnotherTest".kebab_case
+=> "this-is-another-test"
+```
+
+## truncate a string with ellipsis or custom
+```ruby
+"This is a very long string".truncate(10)
+=> "This is a..."
+
+"This is a long string".truncate(15, '--')
+=> "This is a lon--"
+```
+
+## reverse the order of words
+```ruby
+"hello world".reverse_words
+=> "world hello"
+
+"one two three".reverse_words
+=> "three two one"
+```
+
+## strip html tags
+```ruby
+"<p>Hello <strong>world</strong>!</p>".strip_html
+=> "Hello world!"
+
+"<div>Some <em>text</em></div>".strip_html
+=> "Some text"
+```
+
+## check if a string is a palindrome
+```ruby
+"madam".palindrome?
+=> true
+
+"racecar".palindrome?
+=> true
+
+"hello".palindrome?
+=> false
+
+"A man, a plan, a canal, Panama".palindrome?
+=> true
+```
+
+## trim custom characters
+```ruby
+"...hello...".trim_custom('.')
+=> "hello"
+
+"$$$money$$$".trim_custom('$')
+=> "money"
+
+"###header###".trim_custom('#')
+=> "header"
+```
+
+## Contributing
+Bug reports and pull requests are welcome on GitHub at https://github.com/iprog21/iprog_string_utils.
+
+## License
+This gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+This project has adopted the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md). By participating, you are expected to uphold this code. Please report unacceptable behavior to iprog.tech@gmail.com.

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: :rubocop

data/lib/iprog_string_utils/version.rb

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

data/lib/iprog_string_utils.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "iprog_string_utils/version"
+
+module IprogStringUtils
+  def camel_case
+    split(/[^a-zA-Z0-9]/).map.with_index do |word, index|
+      index.zero? ? word.downcase : word.capitalize
+    end.join
+  end
+
+  def snake_case
+    gsub(/([a-z\d])([A-Z])/, '\1_\2') # Insert underscore between a lowercase/digit and an uppercase letter
+      .gsub(/([A-Z]+)([A-Z][a-z\d]+)/, '\1_\2') # Handle cases like "ATest" by inserting an underscore between uppercase letters followed by a lowercase or digit
+      .gsub(/\W/, "_")                    # Replace non-word characters with underscores
+      .downcase                           # Convert the entire string to lowercase
+      .gsub(/__+/, "_")                   # Collapse multiple underscores into a single underscore
+      .gsub(/^_|_$/, "")                  # Remove leading and trailing underscores
+  end
+
+  def kebab_case
+    gsub(/([a-z\d])([A-Z])/, '\1-\2') # Insert hyphen between a lowercase/digit and an uppercase letter
+      .gsub(/([A-Z]+)([A-Z][a-z\d]+)/, '\1-\2') # Handle cases like "ATest" by inserting a hyphen between uppercase letters followed by a lowercase or digit
+      .gsub(/\W/, "-")                    # Replace non-word characters with hyphens
+      .downcase                           # Convert the entire string to lowercase
+      .gsub(/--+/, "-")                   # Collapse multiple hyphens into a single hyphen
+      .gsub(/^-|-$/, "")                  # Remove leading and trailing hyphens
+  end
+
+  def title_case
+    split.map(&:capitalize).join(" ")
+  end
+
+  def reverse_words
+    split.reverse.join(" ")
+  end
+
+  def count_words
+    split.size
+  end
+
+  def truncate(max_length, ellipsis = "...")
+    return self if length <= max_length
+
+    truncated_string = self[0, max_length]
+
+    "#{truncated_string.rstrip}#{ellipsis}"
+  end
+
+  def strip_html
+    gsub(%r{</?[^>]*>}, "")
+  end
+
+  def to_bool
+    return true if downcase == "true"
+    return false if downcase == "false"
+
+    nil
+  end
+
+  def palindrome?
+    cleaned = gsub(/\W/, "").downcase
+    cleaned == cleaned.reverse
+  end
+
+  def trim_custom(char = " ")
+    gsub(/^#{Regexp.escape(char)}+|#{Regexp.escape(char)}+$/, "")
+  end
+end
+
+class String
+  include IprogStringUtils
+end

data/sig/iprog_string_utils.rbs

@@ -0,0 +1,4 @@
+module IprogStringUtils
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: iprog_string_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jayson Presto
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-08-11 00:00:00.000000000 Z
+dependencies: []
+description: IprogStringUtils is a Ruby gem that provides a set of string manipulation
+  utilities. These utilities include methods for converting strings to different cases
+  such as camelCase, snake_case, and kebab-case, truncating strings with an ellipsis,
+  reversing the order of words, stripping HTML tags, and more. This gem is designed
+  to enhance the functionality of the Ruby String class with common string operations.
+email:
+- iprog21@jaysonpresto.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- iprog-logo.png
+- lib/iprog_string_utils.rb
+- lib/iprog_string_utils/version.rb
+- sig/iprog_string_utils.rbs
+homepage: https://github.com/iprog21/iprog_string_utils.git
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/iprog21/iprog_string_utils.git
+  source_code_uri: https://github.com/iprog21/iprog_string_utils.git
+  changelog_uri: https://github.com/iprog21/iprog_string_utils/blob/master/CHANGELOG.md
+  code_of_conduct_uri: https://github.com/iprog21/iprog_string_utils/blob/main/CODE_OF_CONDUCT.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.14
+signing_key:
+specification_version: 4
+summary: A collection of string manipulation utilities for Ruby.
+test_files: []