titlecaser 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 60a6c2ed4a614a61dd007694b6cd0126dfa7072936c624fc04514445d42c109c
+  data.tar.gz: f76fdbff55626512d3b6ae935b72f05c6304451d973b4f4c05c6df3b2eab1eb0
+SHA512:
+  metadata.gz: 2bec1fbdeea30e2ed6fac919fd51adcf1953d91864bcd80585895fef2355f627fe95572a50b262acfedbbc8982f95c9cb38378c350db0d44bb6dbb7eaaaa82a3
+  data.tar.gz: 9f8b3d68de8ec7af2a39b8a172d5f6e36dd0da4908cb9aaffe9a734d95cea3658404ed5a93a7d84d20c9e2ec8b2509018797126272dd48bb928d10de270b33bc

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Peter Cooper
+
+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,37 @@
+# Titlecaser
+
+
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add titlecaser
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install titlecaser
+
+## Usage
+
+Convenience method:
+
+```ruby
+Titlecaser.titlecase("this is a test") # => "This is a Test"
+```
+
+Or in a more longwinded way:
+
+```ruby
+Titlecaser::TitleCase.new("this is a test").convert
+```
+
+Currently, we don't monkeypatch `String` but that could be an option later.
+
+## Tests
+
+Note that there are tests in `/test` and a `titles.txt` file that's used to test a variety of title scenarios. These tests can be extended.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/peterc/titlecaser. However, please note this library has been developed to fit our particular style guide, so changes to specific title-casing choices may be rejected or questioned. We could extend the library to support multiple approaches in future, by way of non-default options, however.

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+task default: %i[]
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+task :default => :test

data/lib/titlecaser/version.rb

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

data/lib/titlecaser.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require_relative "titlecaser/version"
+
+module Titlecaser  
+  class TitleCase
+    def initialize(string)
+      @string = string
+    end
+  
+    def convert
+      words = @string.split(' ')
+      previous_word = nil
+      converted_words = words.map.with_index do |word, index|
+        # Take any initial punctuation character (e.g. quotes) and store it to rejoin later
+        starting_punctuation = word[/\A[^\p{L}0-9]/].to_s
+
+        # Take the rest of the word
+        word = word[starting_punctuation.length..-1]
+
+        # If it's already capitalized and NOT a minor word, leave everything as-is
+        if already_capitalized?(word) && !minor_word?(word)
+          word = starting_punctuation + word
+        else
+          # Otherwise, determine if it's a major word and handle appropriately
+          if major_word?(word, index, previous_word)
+            word = starting_punctuation + capitalize_word(word)
+          else
+            # Force a downcase if need be
+            word = starting_punctuation + word.downcase
+          end
+        end
+
+        # Store the word for the next iteration, as it may have useful trailing punctuation
+        previous_word = word
+      end
+
+      # Put it all back together
+      converted_words.join(' ')
+    end
+  
+    private
+  
+    def already_capitalized?(word)
+      word[0] == word[0].upcase
+    end
+  
+    def major_word?(word, index, previous_word)
+      return true if index.zero? || word.length > 4
+
+      # Also return true if the word follows a colon,
+      # full stop, or question mark, ignoring any whitespace,
+      # as these essentially 'restart' the sentence.
+      # e.g. "blah: blah" should become "Blah: Blah"
+      return true if previous_word && previous_word.match?(/[:.?!]\z/)
+  
+      !minor_word?(word)
+    end
+  
+    def minor_word?(word)
+      %w[and as but for if nor or so yet a an the at by for in is of off on per to up via with].include?(word.downcase)
+    end
+  
+    def capitalize_word(word)
+      word.capitalize
+    end
+  end
+
+  def self.titlecase(string)
+    TitleCase.new(string).convert
+  end
+end

data/sig/titlecaser.rbs

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

metadata

@@ -0,0 +1,50 @@
+--- !ruby/object:Gem::Specification
+name: titlecaser
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Peter Cooper
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2024-04-05 00:00:00.000000000 Z
+dependencies: []
+description: Uses standard title casing rules to titleize strings
+email:
+- git@peterc.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- Rakefile
+- lib/titlecaser.rb
+- lib/titlecaser/version.rb
+- sig/titlecaser.rbs
+homepage: https://github.com/peterc/titlecaser
+licenses: []
+metadata:
+  homepage_uri: https://github.com/peterc/titlecaser
+  source_code_uri: https://github.com/peterc/titlecaser
+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.3
+signing_key:
+specification_version: 4
+summary: Uses standard title casing rules to titleize strings
+test_files: []