spoonerize 0.2.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 932ce6e7e6441c787ded513aebed0b3e0b83fa6afa83790abe8da66c9314e96b
-  data.tar.gz: 6a5dedc04324853f1bfbc63e6317b17737eab6fb10b89ae11136b598438a4f08
+  metadata.gz: 1b4c993b75b971449d8795c0666e4645bee48ff903afaea84463025da44ffdbf
+  data.tar.gz: b57070d3e1dc670ef4cdf17f9657c8759828e86a039571d305a6d6716aaa5b65
 SHA512:
-  metadata.gz: b579d2925471dca724865574a82a827a5f0d31229991d1746db4890a0d4c250141daa536bbc932c829fd9d7e8f5af63e89b85846a788d23eca766219c2a60681
-  data.tar.gz: 1531172c418c2cf00e155ca5e56c888218888af9c8b6694ff7a9b3195dbda173c122058e7ac46c4705c311d7951a8c6f773aa09d4571a447da7f4781ca425168
+  metadata.gz: ccf19838d1a10609dddbd2da4cfe8286c548b9bc91e2b957ee592120225305c93a166da7ae10c34ead80a402f8cb767fbb192162fade18afc046298ff3d5dd1c
+  data.tar.gz: 3420c7dc81ea682e3388b9f9097a6c538199cbb38e2f5179e3a5f68f8200b278674da04397df05e14a259ad6ba5878daf3b63390f244a3988c3678f08e8b85a3

data/Gemfile.lock

@@ -1,28 +1,74 @@
 PATH
   remote: .
   specs:
-    spoonerize (0.2.0)
+    spoonerize (1.0.0)
       csv
 
 GEM
   remote: https://rubygems.org/
   specs:
+    ast (2.4.3)
     csv (3.3.5)
     date (3.5.1)
     erb (6.0.4)
+    json (2.20.0)
+    language_server-protocol (3.17.0.5)
+    lint_roller (1.1.0)
+    parallel (1.28.0)
+    parser (3.3.11.1)
+      ast (~> 2.4.1)
+      racc
     power_assert (3.0.1)
+    prism (1.9.0)
     psych (5.4.0)
       date
       stringio
+    racc (1.8.1)
+    rainbow (3.1.1)
     rake (13.4.2)
     rdoc (7.2.0)
       erb
       psych (>= 4.0.0)
       tsort
+    regexp_parser (2.12.0)
+    rubocop (1.84.2)
+      json (~> 2.3)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.1.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 2.9.3, < 3.0)
+      rubocop-ast (>= 1.49.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 4.0)
+    rubocop-ast (1.49.1)
+      parser (>= 3.3.7.2)
+      prism (~> 1.7)
+    rubocop-performance (1.26.1)
+      lint_roller (~> 1.1)
+      rubocop (>= 1.75.0, < 2.0)
+      rubocop-ast (>= 1.47.1, < 2.0)
+    ruby-progressbar (1.13.0)
+    standard (1.54.0)
+      language_server-protocol (~> 3.17.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.84.0)
+      standard-custom (~> 1.0.0)
+      standard-performance (~> 1.8)
+    standard-custom (1.0.2)
+      lint_roller (~> 1.0)
+      rubocop (~> 1.50)
+    standard-performance (1.9.0)
+      lint_roller (~> 1.1)
+      rubocop-performance (~> 1.26.0)
     stringio (3.2.0)
     test-unit (3.7.8)
       power_assert
     tsort (0.2.0)
+    unicode-display_width (3.2.0)
+      unicode-emoji (~> 4.1)
+    unicode-emoji (4.2.0)
 
 PLATFORMS
   arm64-darwin-25
@@ -33,6 +79,7 @@ DEPENDENCIES
   rake (~> 13.0, >= 13.0.1)
   rdoc
   spoonerize!
+  standard (= 1.54.0)
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH

data/README.md

@@ -26,6 +26,8 @@ consonants, but will still lose its own if it has any.
 - If the word to pull from is excluded, that word is skipped, and you pull the
 leading consonants from the next non-excluded word.
 - "Q" and "U" should stay together (like "queen").
+- "Y" is treated like a leading consonant by itself or before a vowel sound
+(like "yellow"), but like a leading vowel before a consonant (like "yttrium").
 - A lot of the time, the words won't look how they're supposed to sound, as you
 go by how the word *used* to sound, not how it's spelled. For instance,
 `$ spoonerize two new cuties` becomes "no cew twuties", but it would be
@@ -40,7 +42,7 @@ Just install the gem!
 gem install spoonerize
 ```
 
-If you don't have permission on your system to install ruby or gems, I recommend
+If you don't have permission on your system to install Ruby or gems, I recommend
 using
 [rbenv](http://www.rubyinside.com/rbenv-a-simple-new-ruby-version-management-tool-5302.html),
 or you can try the manual methods below.
@@ -82,10 +84,12 @@ get the results. For example:
 
 ```
 $ spoonerize -s not too shabby
-Saving [tot shoo nabby] to ~/.cache/spoonerize/spoonerize.csv
+tot shoo nabby
+Saving...
 
 $ spoonerize -rs not too shabby
-Saving [shot noo tabby] to ~/.cache/spoonerize/spoonerize.csv
+shot noo tabby
+Saving...
 
 $ spoonerize -p
 not too shabby | tot shoo nabby | No Options
@@ -97,10 +101,11 @@ Here is a list of all available options:
 ```
 -r, --[no-]reverse               Reverse flipping
 -l, --[no-]lazy                  Skip small words
+-c, --[no-]consonants-only       Only flip consonant-starting words
 -m, --[no-]map                   Print words mapping
--p, --[no-]print                 Print all entries in the log
+-p, --[no-]print-log             Print all entries in the log
 -s, --[no-]save                  Save results in log
-    --exclude=WORDS              Words to skip
+    --exclude=WORD               Words to skip
 ```
 
 ### Config File
@@ -112,6 +117,7 @@ file can still be overridden at runtime by executable flags.
 Spoonerize.configure do |config|
   config.excluded_words = []
   config.lazy = false
+  config.consonants_only = false
   config.reverse = false
   config.logfile_name = File.expand_path("~/.cache/spoonerize/spoonerize.csv")
 end
@@ -122,50 +128,63 @@ Because the file is Ruby, you can set only the values you want to change.
 ## API
 The API is [fully
 documented](https://evanthegrayt.github.io/spoonerize/), but below
-are some quick examples of how you could use this in your ruby code.
+are some quick examples of how you could use this in your Ruby code.
 
 ```ruby
 require 'spoonerize'
 
-spoonerism = Spoonerize::Spoonerism.new(%w[not too shabby])
+spoonerism = Spoonerize::Spoonerism.new("not", "too", "shabby")
 
 spoonerism.to_s
 # => tot shoo nabby
 
-Spoonerize.configure do |config|
-  config.reverse = true
-end
-
-spoonerism.to_s
+reversed = Spoonerize::Spoonerism.new("not", "too", "shabby", reverse: true)
+reversed.to_s
 # => shot noo tabby
 
 Spoonerize.configure do |config|
   config.logfile_name = File.expand_path("~/.cache/spoonerize/spoonerize.csv")
 end
-spoonerism.save
+Spoonerize::Spoonerism.new("not", "too", "shabby").save
+```
+
+To leave vowel-starting words alone, enable consonants-only mode:
+
+```ruby
+Spoonerize::Spoonerism.new("turn", "up", "son", consonants_only: true).to_s
+# => surn up ton
 ```
 
-You can also configure Spoonerize in Ruby before creating a spoonerism:
+You can also configure global defaults before creating a spoonerism:
 
 ```ruby
 Spoonerize.configure do |config|
   config.reverse = true
 end
 
-s = Spoonerize::Spoonerism.new(%w[not too shabby])
+s = Spoonerize::Spoonerism.new("not", "too", "shabby")
 s.spoonerize
 # => shot noo tabby
 ```
 
+Options passed directly to `Spoonerize::Spoonerism.new` only apply to that
+instance.
+
+Passing words as an array is deprecated and will be removed in Spoonerize 1.0:
+
+```ruby
+Spoonerize::Spoonerism.new(%w[not too shabby])
+```
+
 Or load a config file manually:
 
 ```ruby
 Spoonerize.load_config_file("~/.spoonerizerc")
-s = Spoonerize::Spoonerism.new(%w[not too shabby])
+s = Spoonerize::Spoonerism.new("not", "too", "shabby")
 ```
 
 ## Self Promotion
 I do these projects for fun, and I enjoy knowing that they're helpful to people.
 Consider starring [the repository](https://github.com/evanthegrayt/spoonerize)
 if you like it! If you love it, follow me [on
-github](https://github.com/evanthegrayt)!
+GitHub](https://github.com/evanthegrayt)!

data/Rakefile

@@ -4,6 +4,7 @@ require_relative "lib/spoonerize"
 require "bundler/gem_tasks"
 require "rdoc/task"
 require "rake/testtask"
+require "standard/rake"
 
 Rake::TestTask.new do |t|
   t.libs = ["lib"]
@@ -64,4 +65,3 @@ namespace :version do
     end
   end
 end
-

data/lib/spoonerize/cli.rb

@@ -40,10 +40,10 @@ module Spoonerize
     attr_reader :options
 
     ##
-    # Preferences after reading config file and parsing ARGV.
+    # Overrides after reading config file and parsing ARGV.
     #
-    # @return [Array]
-    attr_reader :preferences
+    # @return [Hash]
+    attr_reader :overrides
 
     ##
     # Create instance of +Cli+
@@ -57,7 +57,7 @@ module Spoonerize
       @save = false
       @print_log = false
       @options = options
-      @preferences = get_preferences
+      @overrides = get_overrides
     end
 
     ##
@@ -65,7 +65,7 @@ module Spoonerize
     #
     # @return [Spoonerize::Spoonerism]
     def spoonerism
-      @spoonerism ||= Spoonerism.new(options)
+      @spoonerism ||= Spoonerism.new(*options, **overrides)
     end
 
     ##
@@ -124,15 +124,18 @@ module Spoonerize
 
     ##
     # Read in args and set options
-    def get_preferences # :nodoc:
+    def get_overrides # :nodoc:
       {}.tap do |prefs|
         OptionParser.new do |o|
           o.version = ::Spoonerize::Version.to_s
           o.on("-r", "--[no-]reverse", "Reverse flipping") do |v|
-            Spoonerize.config.reverse = v
+            prefs[:reverse] = v
           end
           o.on("-l", "--[no-]lazy", "Skip small words") do |v|
-            Spoonerize.config.lazy = v
+            prefs[:lazy] = v
+          end
+          o.on("-c", "--[no-]consonants-only", "Only flip consonant-starting words") do |v|
+            prefs[:consonants_only] = v
           end
           o.on("-m", "--[no-]map", "Print words mapping") do |v|
             @map = v
@@ -144,7 +147,7 @@ module Spoonerize
             @save = v
           end
           o.on("--exclude=WORD", Array, "Words to skip") do |v|
-            Spoonerize.config.excluded_words = v
+            prefs[:excluded_words] = v
           end
         end.parse!(options)
       end

data/lib/spoonerize/config.rb

@@ -20,6 +20,12 @@ module Spoonerize
     # @return [Array]
     attr_accessor :excluded_words
 
+    ##
+    # When true, only consonant-starting words are eligible to be flipped.
+    #
+    # @return [Boolean]
+    attr_accessor :consonants_only
+
     ##
     # When true, reverse the order of the flipping. Only makes a difference
     # when there are more than two flip-able words.
@@ -41,10 +47,36 @@ module Spoonerize
       @lazy = false
       @lazy_words = %w[i a an and in of the my your his her him hers to is]
       @excluded_words = []
+      @consonants_only = false
       @reverse = false
       @logfile_name = File.expand_path(
         File.join(ENV["HOME"], ".cache", "spoonerize", "spoonerize.csv")
       )
     end
+
+    ##
+    # Create a copy of the current config with optional overrides.
+    #
+    # @return [Spoonerize::Config]
+    def with(**overrides)
+      self.class.new.tap do |config|
+        config.lazy = lazy
+        config.lazy_words = lazy_words.dup
+        config.excluded_words = excluded_words.dup
+        config.consonants_only = consonants_only
+        config.reverse = reverse
+        config.logfile_name = logfile_name
+
+        overrides.each do |key, value|
+          config.public_send(:"#{key}=", copy_value(value))
+        end
+      end
+    end
+
+    private
+
+    def copy_value(value)
+      value.is_a?(Array) ? value.dup : value
+    end
   end
 end

data/lib/spoonerize/spoonerism.rb

@@ -4,20 +4,55 @@ module Spoonerize
   ##
   # The main word-flipper.
   class Spoonerism
+    VOWEL_LETTERS = "aeio"
+    CONSONANT_LETTERS = "bcdfghjklmnprstvwxz"
+    Y_FOLLOWING_CONSONANTS = "bcdfghjklmnpqrstvwxz"
+
     ##
     # The words originally passed at initialization.
     #
     # @return [Array]
     attr_reader :words
 
+    ##
+    # Configuration values for this spoonerism.
+    #
+    # @return [Spoonerize::Config]
+    attr_reader :config
+
     ##
     # Initialize instance.
     #
-    # @param [Array] words
+    # @param [Array<String>] words Words to spoonerize. Passing a single array
+    #   is deprecated and will be removed in Spoonerize 1.0.
+    # @param [Spoonerize::Config] config Base config to copy.
+    # @param [Boolean, nil] lazy Override lazy mode for this instance.
+    # @param [Array<String>, nil] lazy_words Override lazy words for this instance.
+    # @param [Array<String>, nil] excluded_words Override excluded words for this instance.
+    # @param [Boolean, nil] consonants_only Override consonants-only mode for this instance.
+    # @param [Boolean, nil] reverse Override reverse mode for this instance.
+    # @param [String, nil] logfile_name Override the log file path for this instance.
     #
     # @return [Spoonerize::Spoonerism]
-    def initialize(words)
-      @words = words.map(&:downcase)
+    def initialize(
+      *words,
+      config: Spoonerize.config,
+      lazy: nil,
+      lazy_words: nil,
+      excluded_words: nil,
+      consonants_only: nil,
+      reverse: nil,
+      logfile_name: nil
+    )
+      @words = normalize_words(words).map(&:downcase)
+      @config = config.with(**{
+        lazy: lazy,
+        lazy_words: lazy_words,
+        excluded_words: excluded_words,
+        consonants_only: consonants_only,
+        reverse: reverse,
+        logfile_name: logfile_name
+      }.reject { |_, value| value.nil? })
     end
 
     ##
@@ -60,7 +95,7 @@ module Spoonerize
     #
     # @return [Boolean]
     def enough_flippable_words?
-      (words - all_excluded_words).size > 1
+      words.each_index.count { |index| flippable?(index) } > 1
     end
 
     ##
@@ -73,27 +108,44 @@ module Spoonerize
 
     ##
     # Array of words to exclude by combining two arrays:
-    # * Any user-passed words, stored in +Spoonerize.config.excluded_words+
+    # * Any user-passed words, stored in +config.excluded_words+
     # * Any lazy words, if lazy mode is true
     #
     # @return [Array]
     def all_excluded_words
-      (Spoonerize.config.excluded_words + (
-        Spoonerize.config.lazy ? Spoonerize.config.lazy_words : []
+      (config.excluded_words + (
+        config.lazy ? config.lazy_words : []
       )).map(&:downcase)
     end
 
     private
 
+    def normalize_words(words)
+      if words.size == 1 && words.first.is_a?(Array)
+        warn(
+          "Passing words as an array is deprecated and will be removed in Spoonerize 1.0. " \
+          "Pass words as positional arguments instead."
+        )
+        words = words.first
+      end
+
+      unless words.all? { |word| word.is_a?(String) }
+        raise ArgumentError, "Words must be strings"
+      end
+
+      words
+    end
+
     ##
     # Main flipping method. Creates the replacement word from the next
-    # non-excluded word's leading syllables, and the current word's first vowels
-    # through the end of the word.
+    # non-excluded word's leading consonants, and the current word's first
+    # vowel sound through the end of the word.
     def flip_words(word, idx) # :nodoc:
-      return word if excluded?(idx)
-      bumper = Bumper.new(idx, words.size, Spoonerize.config.reverse)
-      bumper.bump while excluded?(bumper.value)
-      words[bumper.value].match(consonants).to_s + word.match(vowels).to_s
+      return word unless flippable?(idx)
+
+      bumper = Bumper.new(idx, words.size, config.reverse)
+      bumper.bump until flippable?(bumper.value)
+      leading_consonants(words[bumper.value]) + retained_suffix(word)
     end
 
     ##
@@ -103,31 +155,94 @@ module Spoonerize
     end
 
     ##
-    # Returns regex to match first vowels through the rest of the word
-    def vowels # :nodoc:
-      /((?<!q)u|[aeio]|(?<=[bcdfghjklmnprstvwxz])y).*$/
+    # Returns true if word[index] can participate in a spoonerism.
+    def flippable?(index) # :nodoc:
+      return false if excluded?(index)
+
+      !config.consonants_only || consonant_sound_start?(words[index])
+    end
+
+    ##
+    # Returns true when a word starts with a consonant sound.
+    def consonant_sound_start?(word) # :nodoc:
+      return false if word.empty?
+
+      !vowel_sound_at?(word, 0)
+    end
+
+    ##
+    # Returns the consonant group a word contributes to another word.
+    def leading_consonants(word) # :nodoc:
+      return "qu" if word.start_with?("qu")
+      return "y" if initial_y_consonant?(word)
+
+      index = word.length.times.find do |letter_index|
+        !CONSONANT_LETTERS.include?(word[letter_index])
+      end
+
+      index ? word[0...index] : word
+    end
+
+    ##
+    # Returns the part of a word kept after dropping its leading consonants.
+    def retained_suffix(word) # :nodoc:
+      index = first_vowel_sound_index(word)
+
+      index ? word[index..] : ""
+    end
+
+    ##
+    # Returns the first index where a word starts sounding vowel-like.
+    def first_vowel_sound_index(word) # :nodoc:
+      word.length.times.find { |index| vowel_sound_at?(word, index) }
+    end
+
+    ##
+    # Returns true when the letter at index starts a vowel sound.
+    def vowel_sound_at?(word, index) # :nodoc:
+      letter = word[index]
+
+      VOWEL_LETTERS.include?(letter) ||
+        (letter == "u" && word[index - 1] != "q") ||
+        y_vowel_sound_at?(word, index)
+    end
+
+    ##
+    # Initial y is vowel-like before a consonant; later y is vowel-like after a
+    # consonant.
+    def y_vowel_sound_at?(word, index) # :nodoc:
+      return false unless word[index] == "y"
+
+      if index.zero?
+        next_letter = word[index + 1]
+
+        next_letter && Y_FOLLOWING_CONSONANTS.include?(next_letter)
+      else
+        CONSONANT_LETTERS.include?(word[index - 1])
+      end
     end
 
     ##
-    # Returns regex to match leading consonants
-    def consonants # :nodoc:
-      /^(y|[bcdfghjklmnprstvwxz]+|qu)/
+    # Initial y is consonant-like by itself or before a vowel sound.
+    def initial_y_consonant?(word) # :nodoc:
+      word == "y" || (word.start_with?("y") && vowel_sound_at?(word, 1))
     end
 
     ##
     # Creates and memoizes instance of the log file.
     def log # :nodoc:
-      @log ||= Spoonerize::Log.new(Spoonerize.config.logfile_name)
+      @log ||= Spoonerize::Log.new(config.logfile_name)
     end
 
     ##
     # The options that were passed at runtime as a string
     def options # :nodoc:
       [].tap do |o|
-        o << "Lazy" if Spoonerize.config.lazy
-        o << "Reverse" if Spoonerize.config.reverse
-        if Spoonerize.config.excluded_words.any?
-          o << "Exclude [#{Spoonerize.config.excluded_words.join(", ")}]"
+        o << "Lazy" if config.lazy
+        o << "Consonants Only" if config.consonants_only
+        o << "Reverse" if config.reverse
+        if config.excluded_words.any?
+          o << "Exclude [#{config.excluded_words.join(", ")}]"
         end
         o << "No Options" if o.empty?
       end

data/lib/spoonerize/version.rb

@@ -9,13 +9,13 @@ module Spoonerize
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 0
+    MAJOR = 1
 
     ##
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 2
+    MINOR = 0
 
     ##
     # Patch version.

data/lib/spoonerize.rb

@@ -53,7 +53,7 @@ module Spoonerize
   ##
   # Loads a config file.
   #
-  # @param [String] file
+  # @param [String] config_file
   #
   # @return [String] file
   def load_config_file(config_file)

data/spoonerize.gemspec

@@ -31,5 +31,6 @@ Gem::Specification.new do |spec|
   spec.add_dependency "csv"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  spec.add_development_dependency "standard", "= 1.54.0"
   spec.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.5"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoonerize
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Evan Gray
@@ -57,6 +57,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.54.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.54.0
 - !ruby/object:Gem::Dependency
   name: test-unit
   requirement: !ruby/object:Gem::Requirement