change_case 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d7817cff406767caf9479dd80308f1550788f2abea2172791268278ddb54c418
-  data.tar.gz: 8e75f7d079a02c7b35ff91dcbfa59cc6735271e20279dd5e4035ed25786283a4
+  metadata.gz: 3cc32b4cba960d81ff1c275a32d3184fa6bba468fa38dc020eebb86d95ced60d
+  data.tar.gz: a98036290d52e34276bbbc74f64326fff3056e65135311130c27d58a1e88ae56
 SHA512:
-  metadata.gz: d8a15b3fba0b0aaa52ffcfaf3e5096c3dcfd8b3ec70b09a9b5e6b1665ee6aafd524896ee7ab22220127211dcf44de97e55b2e22b9bc127c2551c200b61407bec
-  data.tar.gz: 947b624ad58fed2de66f16ee3d387f529e9eb8f8a4d8e1a34f1c160446360a47ed187a561d73427ff3b056e6b77c36469e1ecd3ea2795d9caa44f2bae46fc86f
+  metadata.gz: de7d6787223100cd5d4efe747b72e100258c551e828e0bdb9896608a4c4774bc39324ae82349eeb3caf899e1bb51ff1604ed871a0b3d82383e91705934b730fb
+  data.tar.gz: fe3cbe4baab5e60ddbfdb82ac927d1d08dfd42be08d7ea8173f929e2f03a5d5a3fed3b26f83121fabcd0ec35ca30981ca3455cab42f83949c5a157f466e38d55

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+## [0.3.0] - 2025-01-16
+
+- Include case methods to String class
+
+## [0.2.0] - 2025-01-12
+
+- All case methods and refactor code
+
+## [0.1.0] - 2025-01-10
+
+- Initial release

data/README.md

@@ -0,0 +1,64 @@
+# ChangeCase
+
+Transform a string between `camelCase`, `PascalCase`, `Capital Case`, `snake_case`, `kebab-case`, `CONSTANT_CASE` and others.
+
+[![Build Status](https://github.com/javoeria/change_case/actions/workflows/main.yml/badge.svg)](https://github.com/javoeria/change_case/actions/workflows/main.yml)
+[![Gem Version](https://badge.fury.io/rb/change_case.svg)](https://rubygems.org/gems/change_case)
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+```bash
+bundle add change_case
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install change_case
+```
+
+## Usage
+
+```ruby
+require "change_case"
+
+ChangeCase.camel("TEST_VALUE") #=> "testValue"
+# OR
+"TEST_VALUE".camelcase #=> "testValue"
+```
+
+Included case methods:
+
+| ChangeCase     | String         | Result      |
+| -------------- | -------------- | ----------- |
+| `camel`        | `camelcase`    | `twoWords`  |
+| `capital`      | `capitalcase`  | `Two Words` |
+| `constant`     | `constantcase` | `TWO_WORDS` |
+| `dot`          | `dotcase`      | `two.words` |
+| `kebab`        | `kebabcae`     | `two-words` |
+| `no`           | `nocase`       | `two words` |
+| `pascal`       | `pascalcase`   | `TwoWords`  |
+| `pascal_snake` | `pascalcase`   | `Two_Words` |
+| `path`         | `pathcase`     | `two/words` |
+| `sentence`     | `sentencecase` | `Two words` |
+| `snake`        | `snakecase`    | `two_words` |
+| `train`        | `traincase`    | `Two-Words` |
+| `title`        | `titlecase`    | `Two Words` |
+| `swap`         | `swapcase`     | `tWO wORDS` |
+| `sponge`       | `spongecase`   | `TwO wORdS` |
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` 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
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/javoeria/change_case.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/change_case/string.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+# Add ChangeCase methods on the String class by monkey patching.
+class String
+  # Converts the string to camel case.
+  def camelcase
+    ChangeCase.camel(self)
+  end
+
+  # Converts the string to capital case.
+  def capitalcase
+    ChangeCase.capital(self)
+  end
+
+  # Converts the string to constant case.
+  def constantcase
+    ChangeCase.constant(self)
+  end
+
+  # Converts the string to dot case.
+  def dotcase
+    ChangeCase.dot(self)
+  end
+
+  # Converts the string to kebab/param case.
+  def kebabcase
+    ChangeCase.kebab(self)
+  end
+
+  # Converts the string to space separated lowercase.
+  def nocase
+    ChangeCase.no(self)
+  end
+
+  # Converts the string to pascal case.
+  def pascalcase(snake: false)
+    snake ? ChangeCase.pascal_snake(self) : ChangeCase.pascal(self)
+  end
+
+  # Converts the string to path case.
+  def pathcase
+    ChangeCase.path(self)
+  end
+
+  # Converts the string to sentence case.
+  def sentencecase
+    ChangeCase.sentence(self)
+  end
+
+  # Converts the string to snake case.
+  def snakecase
+    ChangeCase.snake(self)
+  end
+
+  # Converts the string to train/header case.
+  def traincase
+    ChangeCase.train(self)
+  end
+
+  # Converts the string to title case.
+  def titlecase
+    ChangeCase.title(self)
+  end
+
+  # Converts the string with random capitalization applied.
+  def spongecase
+    ChangeCase.sponge(self)
+  end
+end

data/lib/change_case/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ChangeCase
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/change_case.rb

@@ -1,81 +1,102 @@
 # frozen_string_literal: true
 
 require_relative "change_case/version"
+require_relative "change_case/string"
 
+# Module used for converting strings to any case.
 module ChangeCase
+  # Converts the string to camel case.
   def self.camel(input)
     split_string(input).map.with_index { |word, i| i.zero? ? word : word.capitalize }.join
   end
 
+  # Converts the string to capital case.
   def self.capital(input)
     split_string(input).map(&:capitalize).join(" ")
   end
 
+  # Converts the string to constant case.
   def self.constant(input)
     split_string(input).join("_").upcase
   end
 
+  # Converts the string to dot case.
   def self.dot(input)
     split_string(input).join(".")
   end
 
+  # Converts the string to kebab/param case.
   def self.kebab(input)
     split_string(input).join("-")
   end
 
+  # Converts the string to space separated lowercase.
   def self.no(input)
     split_string(input).join(" ")
   end
 
+  # Converts the string to pascal case.
   def self.pascal(input)
     split_string(input).map(&:capitalize).join
   end
 
+  # Converts the string to pascal snake case.
   def self.pascal_snake(input)
     split_string(input).map(&:capitalize).join("_")
   end
 
+  # Converts the string to path case.
   def self.path(input)
     split_string(input).join("/")
   end
 
+  # Converts the string to sentence case.
   def self.sentence(input)
     split_string(input).join(" ").capitalize
   end
 
+  # Converts the string to snake case.
   def self.snake(input)
     split_string(input).join("_")
   end
 
+  # Converts the string to train/header case.
   def self.train(input)
     split_string(input).map(&:capitalize).join("-")
   end
 
+  # Converts the string to title case.
   def self.title(input)
     small_words = %w[a an and as at because but by en for if in neither nor of on or only over per so some that than the to up upon vs versus via when with without yet]
     split_string(input).map.with_index { |word, i| small_words.include?(word) && i.positive? ? word : word.capitalize }.join(" ")
   end
 
+  # Converts the string with uppercase characters to lowercase and vice versa.
   def self.swap(input)
     input.swapcase
   end
 
+  # Converts the string with random capitalization applied.
   def self.sponge(input)
     input.chars.map { |char| rand(2).zero? ? char.downcase : char.upcase }.join
   end
 
+  # Converts the first character in the string to uppercase.
   def self.upper_first(input)
     input.empty? ? "" : input[0].upcase.concat(input[1..])
   end
 
+  # Converts the first character in the string to lowercase.
   def self.lower_first(input)
     input.empty? ? "" : input[0].downcase.concat(input[1..])
   end
 
+  # Returns +true+ if the string is uppercase only.
   def self.upper?(input)
     input == input.upcase
   end
 
+  # Returns +true+ if the string is lowercase only.
   def self.lower?(input)
     input == input.downcase
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: change_case
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Javier Rosales
 bindir: bin
 cert_chain: []
-date: 2025-01-12 00:00:00.000000000 Z
+date: 2025-01-16 00:00:00.000000000 Z
 dependencies: []
 email:
 - javier.rb_96@hotmail.com
@@ -15,7 +15,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- CHANGELOG.md
+- README.md
 - lib/change_case.rb
+- lib/change_case/string.rb
 - lib/change_case/version.rb
 homepage: https://github.com/javoeria/change_case
 licenses: