Class: Spoonerize::Spoonerism

Inherits:
Object
  • Object
show all
Defined in:
lib/spoonerize/spoonerism.rb

Overview

The main word-flipper.

Constant Summary collapse

VOWEL_LETTERS =

Letters that always represent vowel sounds.

Returns:

  • (String) 
"aeio"
CONSONANT_LETTERS =

Letters that always represent consonant sounds.

Returns:

  • (String) 
"bcdfghjklmnprstvwxz"
Y_FOLLOWING_CONSONANTS =

Letters that make an initial “y” act like a vowel sound.

Returns:

  • (String) 
"bcdfghjklmnpqrstvwxz"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*words, config: Spoonerize.config, lazy: nil, lazy_words: nil, excluded_words: nil, consonants_only: nil, reverse: nil, logfile_name: nil) ⇒ Spoonerize::Spoonerism

Initialize instance.

Parameters:

  • words (Array<String>) —

    Words to spoonerize. Passing a single array is deprecated and will be removed in Spoonerize 1.0.

  • config (Spoonerize::Config) (defaults to: Spoonerize.config) —

    Base config to copy.

  • lazy (Boolean, nil) (defaults to: nil) —

    Override lazy mode for this instance.

  • lazy_words (Array<String>, nil) (defaults to: nil) —

    Override lazy words for this instance.

  • excluded_words (Array<String>, nil) (defaults to: nil) —

    Override excluded words for this instance.

  • consonants_only (Boolean, nil) (defaults to: nil) —

    Override consonants-only mode for this instance.

  • reverse (Boolean, nil) (defaults to: nil) —

    Override reverse mode for this instance.

  • logfile_name (String, nil) (defaults to: nil) —

    Override the log file path for this instance.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/spoonerize/spoonerism.rb', line 51

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

Instance Attribute Details

#config ⇒ Spoonerize::Config (readonly)

Configuration values for this spoonerism.

Returns:



35
36
37
 
# File 'lib/spoonerize/spoonerism.rb', line 35

def config
  @config
end

#words ⇒ Array (readonly)

The words originally passed at initialization.

Returns:

  • (Array) 


29
30
31
 
# File 'lib/spoonerize/spoonerism.rb', line 29

def words
  @words
end

Instance Method Details

#all_excluded_words ⇒ Array

Array of words to exclude by combining two arrays:

  • Any user-passed words, stored in config.excluded_words

  • Any lazy words, if lazy mode is true

Returns:

  • (Array) 


129
130
131
132
133
 
# File 'lib/spoonerize/spoonerism.rb', line 129

def all_excluded_words
  (config.excluded_words + (
    config.lazy ? config.lazy_words : []
  )).map(&:downcase)
end

#enough_flippable_words? ⇒ Boolean

True if there are more than one non-excluded word to flip

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/spoonerize/spoonerism.rb', line 111

def enough_flippable_words?
  words.each_index.count { |index| flippable?(index) } > 1
end

#save ⇒ Array

Saves the flipped words to the log file, along with the options

Returns:

  • (Array) 


119
120
121
 
# File 'lib/spoonerize/spoonerism.rb', line 119

def save
  log.write([words.join(" "), to_s, options.join(", ")])
end

#spoonerize ⇒ Array

Iterates through words array, and maps its elements to the output of flip_words.

Returns:

  • (Array) 


77
78
79
80
81
 
# File 'lib/spoonerize/spoonerism.rb', line 77

def spoonerize
  raise "Not enough words to flip" unless enough_flippable_words?

  words.map.with_index { |word, idx| flip_words(word, idx) }
end

#to_h ⇒ Hash

Spoonerized results as a joined hash.

Returns:

  • (Hash) 


95
96
97
 
# File 'lib/spoonerize/spoonerism.rb', line 95

def to_h
  words.zip(spoonerize).to_h
end

#to_json ⇒ String

Same as to_h, but as json.

Returns:

  • (String) 


103
104
105
 
# File 'lib/spoonerize/spoonerism.rb', line 103

def to_json
  to_h.to_json
end

#to_s ⇒ String

Spoonerized results as a joined string.

Returns:

  • (String) 


87
88
89
 
# File 'lib/spoonerize/spoonerism.rb', line 87

def to_s
  spoonerize.join(" ")
end