spoonerize 0.0.5

data/lib/spoonerize/cli.rb

@@ -0,0 +1,158 @@
+require 'optparse'
+require 'yaml'
+
+module Spoonerize
+  ##
+  # The class for handling the command-line interface.
+  class Cli
+
+    ##
+    # The preferences file the user can create to change runtime options.
+    #
+    # @return [String]
+    PREFERENCE_FILE =
+      File.expand_path(File.join(ENV['HOME'], '.spoonerize.yml')).freeze
+
+    ##
+    # Creates an instance of +StandupMD+ and runs what the user requested.
+    #
+    # @param [Array] options
+    def self.execute(options = [])
+      exe = new(options)
+
+      if exe.print?
+        exe.print_log
+        return
+      end
+
+      puts exe.spoonerism.to_s
+      exe.print_mappings if exe.map?
+
+      if exe.save?
+        puts "Saving..."
+        exe.spoonerism.save
+      end
+    end
+
+    ##
+    # Arguments passed at runtime.
+    #
+    # @return [Array] ARGV
+    attr_reader :options
+
+    ##
+    # Preferences after reading config file and parsing ARGV.
+    #
+    # @return [Array]
+    attr_reader :preferences
+
+    ##
+    # Create instance of +Cli+
+    #
+    # @param [Array] options
+    #
+    # @return [self]
+    def initialize(options)
+      @map         = false
+      @save        = false
+      @print       = false
+      @options     = options
+      @preferences = get_preferences
+    end
+
+    ##
+    # Sets up an instance of +Spoonerize::Spoonerism+ and passes all user
+    # preferences.
+    #
+    # @return [Spoonerize::Spoonerism]
+    def spoonerism
+      @spoonerism ||= ::Spoonerize::Spoonerism.new(options) do |s|
+        preferences.each { |k, v| s.send("#{k}=", v) }
+      end
+    end
+
+    ##
+    # Should we save to the log file?
+    #
+    # @return [Boolean]
+    def save?
+      @save
+    end
+
+    ##
+    # Should we print the mappings to the command line?
+    #
+    # @return [Boolean]
+    def map?
+      @map
+    end
+
+    ##
+    # Should we print to the command line?
+    #
+    # @return [Boolean]
+    def print?
+      @print
+    end
+
+    ##
+    # The length of the longest word in the phrase.
+    #
+    # @return [Integer]
+    def longest_word_length
+      @longest_word_length ||=
+        spoonerism.spoonerize.group_by(&:size).max.first.size
+    end
+
+    ##
+    # Print the log file contents to the command line.
+    #
+    # @return [nil]
+    def print_log
+      s = Spoonerize::Log.new(spoonerism.logfile_name)
+      s.each { |row| print row.join(' | ') + "\n" }
+    end
+
+    ##
+    # Print the hash of mappings to the command line.
+    #
+    # @return [nil]
+    def print_mappings
+      spoonerism.to_h.each do |k, v|
+        puts "%-#{longest_word_length}s => %s" % [k, v]
+      end
+    end
+
+    private
+
+    ##
+    # Read in args and set options
+    def get_preferences # :nodoc:
+      prefs = {}
+      OptionParser.new do |o|
+        o.version = ::Spoonerize::VERSION
+        o.on('-r', '--[no-]reverse', 'Reverse flipping') do |v|
+          prefs['reverse'] = v
+        end
+        o.on('-l', '--[no-]lazy', 'Skip small words') do |v|
+          prefs['lazy'] = v
+        end
+        o.on('-m', '--[no-]map', 'Print words mapping') do |v|
+          @map = v
+        end
+        o.on('-p', '--[no-]print', 'Print all entries in the log') do |v|
+          @print = v
+        end
+        o.on('-s', '--[no-]save', 'Save results in log') do |v|
+          @save = v
+        end
+        o.on('--exclude=WORDS', Array, 'Words to skip') do |v|
+          prefs['exclude'] = v
+        end
+      end.parse!(options)
+
+      (File.file?(PREFERENCE_FILE) ? YAML.load_file(PREFERENCE_FILE) : {})
+        .merge(prefs)
+    end
+  end
+end

data/lib/spoonerize/log.rb

@@ -0,0 +1,68 @@
+require 'csv'
+require 'fileutils'
+
+module Spoonerize
+  ##
+  # Class that handles reading/writing logs.
+  class Log
+
+    ##
+    # The file name to use.
+    #
+    # @return [String]
+    attr_reader :file
+
+    ##
+    # The directory the file is located.
+    #
+    # @return [String]
+    attr_reader :directory
+
+    ##
+    # Constructor for Log.
+    #
+    # @param [String] file
+    #
+    # @return [Spoonerize::Log]
+    def initialize(file)
+      @file = File.expand_path(file)
+      @directory = File.dirname(file)
+      FileUtils.mkdir_p(directory) unless File.directory?(directory)
+      FileUtils.touch(file) unless File.file?(file)
+    end
+
+    ##
+    # The contents of the log file.
+    #
+    # @return [Array]
+    def contents
+      ::CSV.read(file)
+    end
+
+    ##
+    # Writes a line to the log.
+    #
+    # @param [Array] row
+    #
+    # @return [Array]
+    def write(row)
+      ::CSV.open(file, 'a') { |csv| csv << row }
+    end
+
+    ##
+    # Iterate through each line of the file.
+    #
+    # @return [Array]
+    def each
+      contents.each { |row| yield row }
+    end
+
+    ##
+    # Number of entries in the file.
+    #
+    # @return [Integer]
+    def size
+      contents.size
+    end
+  end
+end

data/lib/spoonerize/spoonerism.rb

@@ -0,0 +1,166 @@
+module Spoonerize
+##
+# The main word-flipper.
+class Spoonerism
+
+  ##
+  # The words originally passed at initialization.
+  #
+  # @return [Array]
+  attr_reader :words
+
+  ##
+  # This boolean determines if flipping should be performed lazily.
+  #
+  # @param [Boolean] true if should be lazy.
+  #
+  # @return [Boolean]
+  attr_writer :lazy
+
+  ##
+  # This boolean determines if flipping should be reversed.
+  #
+  # @param [Boolean] true if should be reversed.
+  #
+  # @return [Boolean]
+  attr_writer :reverse
+
+  ##
+  # The full path to the log file.
+  #
+  # @param [String] file
+  #
+  # @return [String]
+  attr_accessor :logfile_name
+
+  ##
+  # The words that are to be excluded.
+  #
+  # @param [Array] words
+  #
+  # @return [Array]
+  attr_accessor :excluded_words
+
+  ##
+  # Initialize instance and raise if there aren't enough words to flip.
+  #
+  # @param [Array] words
+  def initialize(words)
+    @excluded_words = []
+    @words = words.map(&:downcase)
+    @lazy = false
+    @reverse = false
+    @logfile_name = File.expand_path(
+      File.join(ENV['HOME'], '.cache', 'spoonerize', 'spoonerize.csv')
+    )
+    yield self if block_given?
+  end
+
+  ##
+  # Iterates through words array, and maps its elements to the output of
+  # flip_words. Returns results as an array.
+  def spoonerize
+    raise JakPibError, 'Not enough words to flip' unless enough_flippable_words?
+    words.map.with_index { |word, idx| flip_words(word, idx) }
+  end
+
+  ##
+  # Returns spoonerize array as a joined string.
+  def to_s
+    spoonerize.join(' ')
+  end
+
+  ##
+  # Returns hash of the original words mapped to their flipped counterparts.
+  def to_h
+    Hash[words.zip(spoonerize)]
+  end
+
+  ##
+  # Same as to_h, but as json.
+  def to_json
+    to_h.to_json
+  end
+
+  ##
+  # Returns true if there are more than one non-excluded word to flip
+  def enough_flippable_words?
+    (words - all_excluded_words).size > 1
+  end
+
+  ##
+  # Should the lazy words be excluded?
+  def lazy?
+    @lazy
+  end
+
+  ##
+  # Should the words flip the other direction?
+  def reverse?
+    @reverse
+  end
+
+  ##
+  # Saves the flipped words to the log file, along with the options
+  def save
+    log.write([words.join(' '), to_s, options.join(', ')])
+  end
+
+  ##
+  # Returns an array of words to exclude by combining three arrays:
+  # * Any word in the passed arguments that's only one character
+  # * Any user-passed words, stored in +excluded_words+
+  # * If lazy-mode, the LAZY_WORDS from yaml file are added
+  def all_excluded_words
+    (excluded_words + (lazy? ? LAZY_WORDS : [])).map(&:downcase)
+  end
+
+  private
+
+  ##
+  # 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.
+  def flip_words(word, idx) # :nodoc:
+    return word if excluded?(idx)
+    bumper = Bumper.new(idx, words.size, reverse?)
+    bumper.bump until !excluded?(bumper.value)
+    words[bumper.value].match(consonants).to_s + word.match(vowels).to_s
+  end
+
+  ##
+  # Returns true if word[index] is in the excluded_words array
+  def excluded?(index) # :nodoc:
+    all_excluded_words.include?(words[index])
+  end
+
+  ##
+  # Returns regex to match first vowels through the rest of the word
+  def vowels # :nodoc:
+    /((?<!q)u|[aeio]|(?<=[bcdfghjklmnprstvwxz])y).*$/
+  end
+
+  ##
+  # Returns regex to match leading consonants
+  def consonants # :nodoc:
+    /^(y|[bcdfghjklmnprstvwxz]+|qu)/
+  end
+
+  ##
+  # Creates and memoizes instance of the log file.
+  def log # :nodoc:
+    @log ||= Spoonerize::Log.new(logfile_name)
+  end
+
+  ##
+  # the options as a string
+  def options # :nodoc:
+    o = []
+    o << 'Lazy' if lazy?
+    o << 'Reverse' if reverse?
+    o << 'Exclude [%s]' % [all_excluded_words.join(', ')] if excluded_words.any?
+    o << 'No Options' if o.empty?
+    o
+  end
+end
+end

data/lib/spoonerize/version.rb

@@ -0,0 +1,5 @@
+module Spoonerize
+  ##
+  # The version of the gem.
+  VERSION = '0.0.5'
+end

data/lib/spoonerize.rb

@@ -0,0 +1,21 @@
+require 'yaml'
+require_relative 'spoonerize/spoonerism'
+require_relative 'spoonerize/bumper'
+require_relative 'spoonerize/version'
+require_relative 'spoonerize/log'
+require_relative 'spoonerize/cli'
+
+##
+# The main namespace for the gem.
+module Spoonerize
+  ##
+  # The error exception raised when there are not enough flippable words.
+  JakPibError = Class.new(StandardError)
+
+  ##
+  # Excluded words from config files.
+  LAZY_WORDS = YAML.load_file(
+    File.join(File.dirname(__FILE__), 'config', 'lazy_words.yml')
+  ).freeze
+end
+

data/spoonerize.gemspec

@@ -0,0 +1,38 @@
+require_relative 'lib/spoonerize/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'spoonerize'
+  spec.version       = Spoonerize::VERSION
+  spec.authors       = ['Evan Gray']
+  spec.email         = 'evanthegrayt@vivaldi.net'
+  spec.license       = 'MIT'
+  spec.date          = Time.now.strftime('%Y-%m-%d')
+
+  spec.summary       = %q{Spoonerize phrases from the command line.}
+  spec.description   = %q{Spoonerize phrases from the command line. Comes with an API}
+  spec.homepage      = 'https://evanthegrayt.github.io/spoonerize/'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['allowed_push_host'] = 'https://rubygems.org'
+
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/evanthegrayt/spoonerize'
+    spec.metadata['documentation_uri'] = 'https://evanthegrayt.github.io/spoonerize/doc/index.html'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  # spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    # `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  # end
+  spec.files =       `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+  spec.add_development_dependency 'rake', '~> 13.0', '>= 13.0.1'
+  spec.add_development_dependency 'test-unit', '~> 3.3', '>= 3.3.5'
+end

metadata

@@ -0,0 +1,154 @@
+--- !ruby/object:Gem::Specification
+name: spoonerize
+version: !ruby/object:Gem::Version
+  version: 0.0.5
+platform: ruby
+authors:
+- Evan Gray
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 13.0.1
+- !ruby/object:Gem::Dependency
+  name: test-unit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.3.5
+description: Spoonerize phrases from the command line. Comes with an API
+email: evanthegrayt@vivaldi.net
+executables:
+- spoonerize
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- _config.yml
+- bin/spoonerize
+- doc/README_md.html
+- doc/Spoonerize.html
+- doc/Spoonerize/Bumper.html
+- doc/Spoonerize/Cli.html
+- doc/Spoonerize/Log.html
+- doc/Spoonerize/Spoonerism.html
+- doc/created.rid
+- doc/css/fonts.css
+- doc/css/rdoc.css
+- doc/fonts/Lato-Light.ttf
+- doc/fonts/Lato-LightItalic.ttf
+- doc/fonts/Lato-Regular.ttf
+- doc/fonts/Lato-RegularItalic.ttf
+- doc/fonts/SourceCodePro-Bold.ttf
+- doc/fonts/SourceCodePro-Regular.ttf
+- doc/images/add.png
+- doc/images/arrow_up.png
+- doc/images/brick.png
+- doc/images/brick_link.png
+- doc/images/bug.png
+- doc/images/bullet_black.png
+- doc/images/bullet_toggle_minus.png
+- doc/images/bullet_toggle_plus.png
+- doc/images/date.png
+- doc/images/delete.png
+- doc/images/find.png
+- doc/images/loadingAnimation.gif
+- doc/images/macFFBgHack.png
+- doc/images/package.png
+- doc/images/page_green.png
+- doc/images/page_white_text.png
+- doc/images/page_white_width.png
+- doc/images/plugin.png
+- doc/images/ruby.png
+- doc/images/tag_blue.png
+- doc/images/tag_green.png
+- doc/images/transparent.png
+- doc/images/wrench.png
+- doc/images/wrench_orange.png
+- doc/images/zoom.png
+- doc/index.html
+- doc/js/darkfish.js
+- doc/js/navigation.js
+- doc/js/navigation.js.gz
+- doc/js/search.js
+- doc/js/search_index.js
+- doc/js/search_index.js.gz
+- doc/js/searcher.js
+- doc/js/searcher.js.gz
+- doc/table_of_contents.html
+- lib/config/lazy_words.yml
+- lib/spoonerize.rb
+- lib/spoonerize/bumper.rb
+- lib/spoonerize/cli.rb
+- lib/spoonerize/log.rb
+- lib/spoonerize/spoonerism.rb
+- lib/spoonerize/version.rb
+- pkg/spoonerize-0.0.7.gem
+- spoonerize.gemspec
+homepage: https://evanthegrayt.github.io/spoonerize/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://evanthegrayt.github.io/spoonerize/
+  source_code_uri: https://github.com/evanthegrayt/spoonerize
+  documentation_uri: https://evanthegrayt.github.io/spoonerize/doc/index.html
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Spoonerize phrases from the command line.
+test_files: []