whimsy_str 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1007c18e93f374c7f55721290cee57cf80efff09dc0874a77253c8a607418584
+  data.tar.gz: 726737088736c96d840e26bf17581bb376af97a9d4f808353eb109871c3328fd
+SHA512:
+  metadata.gz: 49725d1c482c7c1cf31c2f7dff8cf36b8dc34a9bc9334ee6bb26471daeac208c3738596364614ff743dd16f479f5e5dcae2fa9298342b354706cbc9dd298c735
+  data.tar.gz: 8ab461aba6c32865749c8bf9af834d56718510d8fd25a446c81b2369bc3d5f71db266a03ff61cd4e29aedfead1330b1d3d541da9a35d0102ac079bb310e2bbcc

data/LICENSE

@@ -0,0 +1,24 @@
+This is free and unencumbered software released into the public domain.
+
+Anyone is free to copy, modify, publish, use, compile, sell, or
+distribute this software, either in source code form or as a compiled
+binary, for any purpose, commercial or non-commercial, and by any
+means.
+
+In jurisdictions that recognize copyright laws, the author or authors
+of this software dedicate any and all copyright interest in the
+software to the public domain. We make this dedication for the benefit
+of the public at large and to the detriment of our heirs and
+successors. We intend this dedication to be an overt act of
+relinquishment in perpetuity of all present and future rights to this
+software under copyright law.
+
+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 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.
+
+For more information, please refer to <https://unlicense.org>

data/README.md

@@ -0,0 +1,49 @@
+# whimsy_str
+A simple rubygem to inject some whimsicality into your strings.
+
+## Motivations
+I've had a couple of command-line utilities for these floating around on my
+personal machines for a while, and figured it would be great to put them out
+there in an easily-consumable format.
+
+## Installation
+
+```sh
+gem install whimsy_str
+```
+
+## Usage
+`whimsy_str` provides some extensions to the built-in `String` class, allowing
+easy transformations into popular meme formats.
+
+#### Code Sample
+
+```ruby
+require 'whimsy_str'
+puts "Sounds like a lot of \n#{'hooplah'.wavify}\nover one small krabby patty"
+puts "Nobody wants to work anymore".spongify
+```
+
+Console output:
+```
+Sounds like a lot of
+h o o p l a h
+over one small krabby patty
+NOBOdY WAnTS To wORK AnYmOrE
+```
+
+#### Executables
+`whimsy_str` provides command-line executables for these functionalities, as
+well. For example:
+
+```sh
+$ wavy incredible
+i n c r e d i b l e
+$ sponge 'wow this is so cool'
+wow thiS is sO coOl
+$
+```
+
+## Development
+### Requirements
+- Ruby >= 2.7

data/bin/sponge

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'whimsy_str'
+
+string = ARGV[0]
+
+puts string.spongify

data/bin/wavy

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'whimsy_str'
+
+string, count = ARGV
+
+puts string.wavify(count.nil? ? 1 : count)

data/lib/whimsy_str/core_ext.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require_relative '../whimsy_str/wavy'
+require_relative '../whimsy_str/sponge'
+
+class String
+  include WhimsyStr::Sponge
+  include WhimsyStr::Wavy
+end

data/lib/whimsy_str/sponge.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'byebug'
+
+module WhimsyStr
+  module Sponge
+    # Transform a string by randomly upcasing/downcasing each character in it.
+    # @param chance_of_upcase [Float] - value between 0 and 1 indicating how
+    # @param block [Proc] - Optional block to pass, which will execute for each
+    # character. The block should return a boolean where `true` means the
+    # yielded character will be upcased, and `false` means it will be downcased.
+    #
+    # @return [String] - a modified string in the style of the Spongbob 'mocking
+    #         text' meme format.
+    def spongify(chance_of_upcase = 0.5)
+      return self unless chance_of_upcase.positive?
+
+      random = Random.new(Float(chance_of_upcase))
+      chars.map.with_index do |char, index|
+        will_upcase = if block_given?
+                        yield char, index
+                      else
+                        random.rand > chance_of_upcase
+                      end
+        will_upcase ? char.upcase : char.downcase
+      end.join
+    end
+  end
+end

data/lib/whimsy_str/version.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+VERSION = '1.0.0'

data/lib/whimsy_str/wavy.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module WhimsyStr
+  module Wavy
+    # Transforms a string by inserting the specified number of spaces between
+    # each character in the original.
+    # @param num_spaces [Integer] - the number of spaces to insert between each
+    # character of the original string.
+    # @return [String] - a modified string in the 'vaporwave' aesthetic.
+    def wavify(num_spaces = 1)
+      return self unless num_spaces.positive?
+
+      chars.join(' ' * Integer(num_spaces))
+    end
+  end
+end

data/lib/whimsy_str.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+require_relative 'whimsy_str/version'
+require_relative 'whimsy_str/core_ext'
+
+module WhimsyStr; end # rubocop:disable Style/Documentation

data/whimsy_str.gemspec

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require_relative 'lib/whimsy_str/version'
+
+Gem::Specification.new do |gem|
+  gem.name = 'whimsy_str'
+  gem.version = VERSION
+  gem.summary = 'Whimsical string transformations.'
+  gem.description = <<~DESC
+    A collection of whimsical methods for modifying strings.
+  DESC
+  gem.authors = ['Tony Von Wolfe']
+  gem.email = ['tonyvonwolfe@gmail.com']
+  gem.files = %w[whimsy_str.gemspec README.md LICENSE] + `git ls-files | grep -E '^(bin|lib)'`.split("\n")
+  gem.executables = %w[sponge wavy]
+  gem.homepage = 'https://github.com/tvonwolfe/whimsy_str'
+  gem.license = 'Unlicense'
+  gem.required_ruby_version = '>= 2.7.0'
+end

metadata

@@ -0,0 +1,57 @@
+--- !ruby/object:Gem::Specification
+name: whimsy_str
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Tony Von Wolfe
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-01-01 00:00:00.000000000 Z
+dependencies: []
+description: 'A collection of whimsical methods for modifying strings.
+
+  '
+email:
+- tonyvonwolfe@gmail.com
+executables:
+- sponge
+- wavy
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- bin/sponge
+- bin/wavy
+- lib/whimsy_str.rb
+- lib/whimsy_str/core_ext.rb
+- lib/whimsy_str/sponge.rb
+- lib/whimsy_str/version.rb
+- lib/whimsy_str/wavy.rb
+- whimsy_str.gemspec
+homepage: https://github.com/tvonwolfe/whimsy_str
+licenses:
+- Unlicense
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.7.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Whimsical string transformations.
+test_files: []