spoonerize 0.1.2 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13edc030a624f0a4d426b0e0580130e4e1c50dc3ad6b4c6c845309616f572582
-  data.tar.gz: 925608680204984f5f51043186256d31999f717951dd461015a3e1ab6a6e6d4a
+  metadata.gz: 932ce6e7e6441c787ded513aebed0b3e0b83fa6afa83790abe8da66c9314e96b
+  data.tar.gz: 6a5dedc04324853f1bfbc63e6317b17737eab6fb10b89ae11136b598438a4f08
 SHA512:
-  metadata.gz: baa74aac8e1e9751f983673be2654de72f9341bb9e6ca39a31ca95809194bbd618cdaa2b209c2c1c5dbd51242a19801b56a5aaa72e60287087ca7814e5af201c
-  data.tar.gz: 9ca5c6ef469659fa70618daa0108f4bb5d0c57f1aa7c7f87fcac1302cafbcc17a425da4d78cb932db23d3d20e1d48c14c80a2396af03ac9bf2f0e1ad795f3ca7
+  metadata.gz: b579d2925471dca724865574a82a827a5f0d31229991d1746db4890a0d4c250141daa536bbc932c829fd9d7e8f5af63e89b85846a788d23eca766219c2a60681
+  data.tar.gz: 1531172c418c2cf00e155ca5e56c888218888af9c8b6694ff7a9b3195dbda173c122058e7ac46c4705c311d7951a8c6f773aa09d4571a447da7f4781ca425168

data/.github/workflows/ruby.yml

@@ -1,4 +1,5 @@
-name: Ruby
+# .github/workflows/ruby.yml
+name: Ruby CI
 
 on:
   push:
@@ -8,17 +9,31 @@ on:
 
 jobs:
   test:
+    runs-on: ubuntu-22.04
 
-    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version: ['3.2', '3.3', '4.0']
 
     steps:
-    - uses: actions/checkout@v2
-    - name: Set up Ruby 2.6
-      uses: actions/setup-ruby@v1
-      with:
-        ruby-version: 2.6.x
-    - name: Build and test with Rake
-      run: |
-        gem install bundler
-        bundle install
-        bundle exec rake test
+      - uses: actions/checkout@v3
+
+      # Set up Ruby and Bundler
+      - name: Set up Ruby ${{ matrix.ruby-version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler: ${{ matrix.ruby-version == '4.0' && '4.0.9' || '2.4.13' }}
+          bundler-cache: true
+
+      - name: Print Ruby and Bundler versions
+        run: |
+          ruby -v
+          bundle -v
+
+      - name: Install dependencies
+        run: bundle install --jobs 4 --retry 3
+
+      - name: Run tests
+        run: bundle exec rake

data/Gemfile.lock

@@ -1,23 +1,39 @@
 PATH
   remote: .
   specs:
-    spoonerize (0.1.2)
+    spoonerize (0.2.0)
+      csv
 
 GEM
   remote: https://rubygems.org/
   specs:
-    power_assert (2.0.0)
-    rake (13.0.3)
-    test-unit (3.4.1)
+    csv (3.3.5)
+    date (3.5.1)
+    erb (6.0.4)
+    power_assert (3.0.1)
+    psych (5.4.0)
+      date
+      stringio
+    rake (13.4.2)
+    rdoc (7.2.0)
+      erb
+      psych (>= 4.0.0)
+      tsort
+    stringio (3.2.0)
+    test-unit (3.7.8)
       power_assert
+    tsort (0.2.0)
 
 PLATFORMS
+  arm64-darwin-25
   x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
   rake (~> 13.0, >= 13.0.1)
+  rdoc
   spoonerize!
   test-unit (~> 3.3, >= 3.3.5)
 
 BUNDLED WITH
-   2.2.16
+  4.0.10

data/README.md

@@ -104,19 +104,20 @@ Here is a list of all available options:
 ```
 
 ### Config File
-You can create a config file called `~/.spoonerize.yml`. In this file, you can
-change default options at runtime. Available settings are:
-
-```yaml
-# Setting       Default
-excluded_words: []
-lazy:           false
-reverse:        false
-logfile_name:   '~/.cache/spoonerize/spoonerize.csv'
+You can create a Ruby config file called `~/.spoonerizerc`. The CLI loads this
+file automatically before it parses command-line options, so options set in the
+file can still be overridden at runtime by executable flags.
+
+```ruby
+Spoonerize.configure do |config|
+  config.excluded_words = []
+  config.lazy = false
+  config.reverse = false
+  config.logfile_name = File.expand_path("~/.cache/spoonerize/spoonerize.csv")
+end
 ```
 
-Options set by this file can be overridden at runtime by the use of the
-executable's flags.
+Because the file is Ruby, you can set only the values you want to change.
 
 ## API
 The API is [fully
@@ -126,39 +127,41 @@ 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]) do |s|
-  s.reverse = true
+spoonerism = Spoonerize::Spoonerism.new(%w[not too shabby])
+
+spoonerism.to_s
+# => tot shoo nabby
+
+Spoonerize.configure do |config|
+  config.reverse = true
 end
 
-spoonerism.spoonerize
+spoonerism.to_s
 # => shot noo tabby
 
-spoonerism.reverse = false
-spoonerism.spoonerize
-# => tot shoo nabby
-
-spoonerism.logfile_name = '~/.cache/spoonerize/spoonerize.csv'
+Spoonerize.configure do |config|
+  config.logfile_name = File.expand_path("~/.cache/spoonerize/spoonerize.csv")
+end
 spoonerism.save
 ```
 
-You can also use the [config file](#config-file), either by passing it at
-initialization, or via the setter. The config file will be automatically loaded
-if passed at initialization, before the instance is yielded so you can still
-change the values via the block. If set via the setter, you must call
-`#load_config_file`.
+You can also configure Spoonerize in Ruby before creating a spoonerism:
 
 ```ruby
-# Config file would be automatically loaded before block is executed.
-s = Spoonerise::Spoonerism.new(%w[not too shabby], '~/.spoonerize.yml') do |sp|
-  sp.reverse = true
+Spoonerize.configure do |config|
+  config.reverse = true
 end
 
-# Config file would need to be manually loaded.
-s = Spoonerise::Spoonerism.new(%w[not too shabby]) do |sp|
-  sp.config_file = '~/.spoonerize.yml'
-end
+s = Spoonerize::Spoonerism.new(%w[not too shabby])
+s.spoonerize
+# => shot noo tabby
+```
+
+Or load a config file manually:
 
-s.load_config_file
+```ruby
+Spoonerize.load_config_file("~/.spoonerizerc")
+s = Spoonerize::Spoonerism.new(%w[not too shabby])
 ```
 
 ## Self Promotion

data/Rakefile

@@ -1,19 +1,67 @@
-require_relative 'lib/spoonerize'
-require 'bundler/gem_tasks'
-require 'rdoc/task'
-require 'rake/testtask'
+# frozen_string_literal: true
+
+require_relative "lib/spoonerize"
+require "bundler/gem_tasks"
+require "rdoc/task"
+require "rake/testtask"
 
 Rake::TestTask.new do |t|
-  t.libs = ['lib']
+  t.libs = ["lib"]
   t.warning = true
   t.verbose = true
-  t.test_files = FileList['test/**/*_test.rb']
+  t.test_files = FileList["test/**/*_test.rb"]
 end
 
 RDoc::Task.new do |rdoc|
-  rdoc.main = 'README.md'
-  rdoc.rdoc_dir = 'docs'
-  rdoc.rdoc_files.include('README.md', 'lib/**/*.rb')
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = "docs"
+  rdoc.rdoc_files.include("README.md", "lib/**/*.rb")
+end
+
+task default: :test
+
+namespace :version do
+  desc "Print the current version from the version.rb file"
+  task :current do
+    puts Spoonerize::VERSION
+  end
+
+  namespace :increment do
+    desc "Increment the version's PATCH level"
+    task :patch do
+      File.join(__dir__, "lib", "spoonerize", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file).sub(/(PATCH\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MINOR level"
+    task :minor do
+      File.join(__dir__, "lib", "spoonerize", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+    desc "Increment the version's MAJOR level"
+    task :major do
+      File.join(__dir__, "lib", "spoonerize", "version.rb").then do |version_file|
+        File.write(
+          version_file,
+          File.read(version_file)
+            .sub(/(PATCH\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MINOR\s=\s)(\d+)/) { "#{$1}0" }
+            .sub(/(MAJOR\s=\s)(\d+)/) { "#{$1}#{$2.next}" }
+        )
+      end
+      system("bundle lock")
+    end
+  end
 end
 
-task :default => :test

data/lib/spoonerize/bumper.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Spoonerize
   ##
   # Class that handles bumping an index.
   class Bumper
-
     ##
     # The number after being bumped.
     #
@@ -55,7 +56,7 @@ module Spoonerize
 
     def bump_value(val) # :nodoc:
       return val - 1 if @reverse
-      val + 1 == @max_value ? 0 : val + 1
+      (val + 1 == @max_value) ? 0 : val + 1
     end
   end
 end

data/lib/spoonerize/cli.rb

@@ -1,17 +1,16 @@
-require 'optparse'
-require 'yaml'
+# frozen_string_literal: true
+
+require "optparse"
 
 module Spoonerize
   ##
   # The class for handling the command-line interface.
   class Cli
-
     ##
-    # The preferences file the user can create to change runtime options.
+    # The config file the user can create to change default runtime options.
     #
     # @return [String]
-    PREFERENCE_FILE =
-      File.expand_path(File.join(ENV['HOME'], '.spoonerize.yml')).freeze
+    CONFIG_FILE = File.expand_path(File.join(ENV["HOME"], ".spoonerizerc"))
 
     ##
     # Creates an instance of +Spoonerism+ and runs what the user requested.
@@ -20,12 +19,12 @@ module Spoonerize
     def self.execute(options = [])
       exe = new(options)
 
-      if exe.print?
+      if exe.print_log?
         exe.print_log
         return
       end
 
-      puts exe.spoonerism.to_s
+      puts exe.spoonerism
       exe.print_mappings if exe.map?
 
       if exe.save?
@@ -53,23 +52,20 @@ module Spoonerize
     #
     # @return [self]
     def initialize(options)
-      @map         = false
-      @save        = false
-      @print       = false
-      @options     = options
+      Spoonerize.load_config_file(CONFIG_FILE) if File.file?(CONFIG_FILE)
+      @map = false
+      @save = false
+      @print_log = false
+      @options = options
       @preferences = get_preferences
     end
 
     ##
-    # Sets up an instance of +Spoonerize::Spoonerism+ and passes all user
-    # preferences.
+    # Sets up an instance of +Spoonerize::Spoonerism+
     #
     # @return [Spoonerize::Spoonerism]
     def spoonerism
-      pf = File.file?(PREFERENCE_FILE) ? PREFERENCE_FILE : nil
-      @spoonerism ||= Spoonerism.new(options, pf) do |s|
-        preferences.each { |k, v| s.send("#{k}=", v) }
-      end
+      @spoonerism ||= Spoonerism.new(options)
     end
 
     ##
@@ -92,8 +88,8 @@ module Spoonerize
     # Should we print to the command line?
     #
     # @return [Boolean]
-    def print?
-      @print
+    def print_log?
+      @print_log
     end
 
     ##
@@ -101,8 +97,7 @@ module Spoonerize
     #
     # @return [Integer]
     def longest_word_length
-      @longest_word_length ||=
-        spoonerism.spoonerize.group_by(&:size).max.first.size
+      @longest_word_length ||= spoonerism.spoonerize.max_by(&:size).size
     end
 
     ##
@@ -110,8 +105,9 @@ module Spoonerize
     #
     # @return [nil]
     def print_log
-      s = Spoonerize::Log.new(spoonerism.logfile_name)
-      s.each { |row| print row.join(' | ') + "\n" }
+      Spoonerize::Log.new(Spoonerize.config.logfile_name).each do |row|
+        puts row.join(" | ")
+      end
     end
 
     ##
@@ -120,7 +116,7 @@ module Spoonerize
     # @return [nil]
     def print_mappings
       spoonerism.to_h.each do |k, v|
-        puts "%-#{longest_word_length}s => %s" % [k, v]
+        printf("%-#{longest_word_length + 1}s => %s\n", k, v)
       end
     end
 
@@ -132,23 +128,23 @@ module Spoonerize
       {}.tap do |prefs|
         OptionParser.new do |o|
           o.version = ::Spoonerize::Version.to_s
-          o.on('-r', '--[no-]reverse', 'Reverse flipping') do |v|
-            prefs['reverse'] = v
+          o.on("-r", "--[no-]reverse", "Reverse flipping") do |v|
+            Spoonerize.config.reverse = v
           end
-          o.on('-l', '--[no-]lazy', 'Skip small words') do |v|
-            prefs['lazy'] = v
+          o.on("-l", "--[no-]lazy", "Skip small words") do |v|
+            Spoonerize.config.lazy = v
           end
-          o.on('-m', '--[no-]map', 'Print words mapping') do |v|
+          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
+          o.on("-p", "--[no-]print-log", "Print all entries in the log") do |v|
+            @print_log = v
           end
-          o.on('-s', '--[no-]save', 'Save results in log') do |v|
+          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
+          o.on("--exclude=WORD", Array, "Words to skip") do |v|
+            Spoonerize.config.excluded_words = v
           end
         end.parse!(options)
       end

data/lib/spoonerize/config.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Spoonerize
+  class Config
+    ##
+    # Lazy mode. If true, words in +lazy_words+ will not be altered.
+    #
+    # @return [Boolean]
+    attr_accessor :lazy
+
+    ##
+    # Words to skip when +lazy+ is true.
+    #
+    # @return [Array]
+    attr_accessor :lazy_words
+
+    ##
+    # Words that should not be altered.
+    #
+    # @return [Array]
+    attr_accessor :excluded_words
+
+    ##
+    # When true, reverse the order of the flipping. Only makes a difference
+    # when there are more than two flip-able words.
+    #
+    # @return [Boolean]
+    attr_accessor :reverse
+
+    ##
+    # Name of the log file. Should be a fully-qualified file path.
+    #
+    # @return [String]
+    attr_accessor :logfile_name
+
+    ##
+    # Create instance of Config.
+    #
+    # @return [Spoonerize::Config]
+    def initialize
+      @lazy = false
+      @lazy_words = %w[i a an and in of the my your his her him hers to is]
+      @excluded_words = []
+      @reverse = false
+      @logfile_name = File.expand_path(
+        File.join(ENV["HOME"], ".cache", "spoonerize", "spoonerize.csv")
+      )
+    end
+  end
+end

data/lib/spoonerize/log.rb

@@ -1,11 +1,12 @@
-require 'csv'
-require 'fileutils'
+# frozen_string_literal: true
+
+require "csv"
+require "fileutils"
 
 module Spoonerize
   ##
-  # Class that handles reading/writing logs.
+  # Class that handles reading/writing logs. Log file is stored as a simple CSV.
   class Log
-
     ##
     # The file name to use.
     #
@@ -46,13 +47,13 @@ module Spoonerize
     #
     # @return [Array]
     def write(row)
-      ::CSV.open(file, 'a') { |csv| csv << row }
+      ::CSV.open(file, "a") { |csv| csv << row }
     end
 
     ##
     # Iterate through each line of the file.
     #
-    # @return [Array]
+    # @return [Enumerable]
     def each
       contents.each { |row| yield row }
     end

data/lib/spoonerize/spoonerism.rb

@@ -1,8 +1,9 @@
+# frozen_string_literal: true
+
 module Spoonerize
   ##
   # The main word-flipper.
   class Spoonerism
-
     ##
     # The words originally passed at initialization.
     #
@@ -10,178 +11,76 @@ module Spoonerize
     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.
+    # Initialize instance.
     #
     # @param [Array] words
     #
-    # @return [Array]
-    attr_accessor :excluded_words
-
-    ##
-    # The configuration file. Default is +nil+. If set to a string, and the file
-    # exists, it is used to set options.
-    #
-    # @return [String] file path
-    attr_reader :config_file
-
-    ##
-    # The options from +config_file+ as a hash.
-    #
-    # @return [Hash] Options from +config_file+
-    attr_reader :config
-
-    ##
-    # Initialize instance. You can also use the +config_file+ either by passing
-    # it at initialization, or via the setter. The config file will be
-    # automatically loaded if passed at initialization, before the instance is
-    # yielded so you can still change the values via the block. If set via the
-    # setter, you must call `#load_config_file`.
-    #
-    # @param [Array] words
-    #
-    # @param [String] config_file
-    #
-    # @example
-    #  # Config file would be automatically loaded before block is executed.
-    #  s = Spoonerise::Spoonerism.new(%w[not too shabby], '~/.spoonerize.yml') do |sp|
-    #    sp.reverse = true # Would override setting from config file
-    #  end
-    #  # Config file would need to be manually loaded.
-    #  s = Spoonerise::Spoonerism.new(%w[not too shabby]) do |sp|
-    #    sp.config_file = '~/.spoonerize.yml'
-    #    sp.reverse = true
-    #  end
-    #  s.load_config_file # Would override setting from initialization
-    def initialize(words, config_file = nil)
-      @config = {}
-      @excluded_words = []
+    # @return [Spoonerize::Spoonerism]
+    def initialize(words)
       @words = words.map(&:downcase)
-      @lazy = false
-      @reverse = false
-      @config_file = config_file && File.expand_path(config_file)
-      @config_file_loaded = false
-      @logfile_name = File.expand_path(
-        File.join(ENV['HOME'], '.cache', 'spoonerize', 'spoonerize.csv')
-      )
-
-      load_config_file if config_file
-
-      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.
+    # flip_words.
+    #
+    # @return [Array]
     def spoonerize
-      raise JakPibError, 'Not enough words to flip' unless enough_flippable_words?
+      raise "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.
+    # Spoonerized results as a joined string.
+    #
+    # @return [String]
     def to_s
-      spoonerize.join(' ')
+      spoonerize.join(" ")
     end
 
     ##
-    # Returns hash of the original words mapped to their flipped counterparts.
+    # Spoonerized results as a joined hash.
+    #
+    # @return [Hash]
     def to_h
-      Hash[words.zip(spoonerize)]
+      words.zip(spoonerize).to_h
     end
 
     ##
     # Same as to_h, but as json.
+    #
+    # @return [String]
     def to_json
       to_h.to_json
     end
 
     ##
-    # Has a config file been loaded?
+    # True if there are more than one non-excluded word to flip
     #
     # @return [Boolean]
-    def config_file_loaded?
-      @config_file_loaded
-    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
-
-    ##
-    # Setter for +config_file+. Must be expanded in case the user uses `~` for
-    # home.
-    #
-    # @param [String] file
     #
-    # @return [String]
-    def config_file=(config_file)
-      @config_file = File.expand_path(config_file)
+    # @return [Array]
+    def save
+      log.write([words.join(" "), to_s, options.join(", ")])
     end
 
     ##
-    # Loads the config file
+    # Array of words to exclude by combining two arrays:
+    # * Any user-passed words, stored in +Spoonerize.config.excluded_words+
+    # * Any lazy words, if lazy mode is true
     #
-    # @return [Hash] The config options
-    def load_config_file
-      raise 'No config file set' if config_file.nil?
-      raise "File #{config_file} does not exist" unless File.file?(config_file)
-      @config = YAML::load_file(config_file)
-      @config_file_loaded = true
-      @config.each { |k, v| send("#{k}=", v) }
+    # @return [Array]
+    def all_excluded_words
+      (Spoonerize.config.excluded_words + (
+        Spoonerize.config.lazy ? Spoonerize.config.lazy_words : []
+      )).map(&:downcase)
     end
 
     private
@@ -192,8 +91,8 @@ module Spoonerize
     # 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)
+      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
     end
 
@@ -218,17 +117,19 @@ module Spoonerize
     ##
     # Creates and memoizes instance of the log file.
     def log # :nodoc:
-      @log ||= Spoonerize::Log.new(logfile_name)
+      @log ||= Spoonerize::Log.new(Spoonerize.config.logfile_name)
     end
 
     ##
-    # the options as a string
+    # The options that were passed at runtime as a string
     def options # :nodoc:
       [].tap do |o|
-        o << 'Lazy' if lazy?
-        o << 'Reverse' if reverse?
-        o << "Exclude [#{all_excluded_words.join(', ')}]" if excluded_words.any?
-        o << 'No Options' if o.empty?
+        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(", ")}]"
+        end
+        o << "No Options" if o.empty?
       end
     end
   end

data/lib/spoonerize/version.rb

@@ -5,23 +5,54 @@ module Spoonerize
   # Module that contains all gem version information. Follows semantic
   # versioning. Read: https://semver.org/
   module Version
-
     ##
     # Major version.
+    #
+    # @return [Integer]
     MAJOR = 0
 
     ##
     # Minor version.
-    MINOR = 1
+    #
+    # @return [Integer]
+    MINOR = 2
 
     ##
     # Patch version.
-    PATCH = 2
+    #
+    # @return [Integer]
+    PATCH = 0
+
+    module_function
+
+    ##
+    # Version as +[MAJOR, MINOR, PATCH]+
+    #
+    # @return [Array<Integer>]
+    def to_a
+      [MAJOR, MINOR, PATCH]
+    end
 
     ##
     # Version as +MAJOR.MINOR.PATCH+
-    def self.to_s
-      "#{MAJOR}.#{MINOR}.#{PATCH}"
+    #
+    # @return [String]
+    def to_s
+      to_a.join(".")
+    end
+
+    ##
+    # Version as +{major: MAJOR, minor: MINOR, patch: PATCH}+
+    #
+    # @return [Hash]
+    def to_h
+      %i[major minor patch].zip(to_a).to_h
     end
   end
+
+  ##
+  # The version, as a string.
+  #
+  # @return [String]
+  VERSION = Version.to_s
 end

data/lib/spoonerize.rb

@@ -1,21 +1,67 @@
-require 'yaml'
-require_relative 'spoonerize/spoonerism'
-require_relative 'spoonerize/bumper'
-require_relative 'spoonerize/version'
-require_relative 'spoonerize/log'
-require_relative 'spoonerize/cli'
+# frozen_string_literal: true
+
+require_relative "spoonerize/config"
+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)
+  # Has the config file been loaded?
+  @config_file_loaded = false
+
+  module_function
 
   ##
-  # Excluded words from config files.
-  LAZY_WORDS = YAML.load_file(
-    File.join(File.dirname(__FILE__), 'config', 'lazy_words.yml')
-  ).freeze
-end
+  # Method for accessing the configuration.
+  #
+  # @return [Spoonerize::Config]
+  def config
+    @config || reset_config
+  end
+
+  ##
+  # Reset all configuration values to their defaults.
+  #
+  # @return [Spoonerize::Config]
+  def reset_config
+    @config_file_loaded = false
+    @config = Spoonerize::Config.new
+  end
+
+  ##
+  # Allows for configuration via a block. Useful when making config files.
+  #
+  # @example
+  #   Spoonerize.configure { |s| s.lazy = true }
+  def configure
+    yield config
+  end
+
+  ##
+  # Has a config file been loaded?
+  #
+  # @return [Boolean]
+  def config_file_loaded?
+    @config_file_loaded
+  end
 
+  ##
+  # Loads a config file.
+  #
+  # @param [String] file
+  #
+  # @return [String] file
+  def load_config_file(config_file)
+    ::File.expand_path(config_file).tap do |file|
+      raise "File #{file} does not exist." unless ::File.file?(file)
+
+      @config_file_loaded = true
+      load file
+    end
+  end
+end

data/spoonerize.gemspec

@@ -1,38 +1,35 @@
-require_relative 'lib/spoonerize/version'
+require_relative "lib/spoonerize/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'spoonerize'
-  spec.version       = Spoonerize::Version.to_s
-  spec.authors       = ['Evan Gray']
-  spec.email         = 'evanthegrayt@vivaldi.net'
-  spec.license       = 'MIT'
-  spec.date          = Time.now.strftime('%Y-%m-%d')
+  spec.name = "spoonerize"
+  spec.version = Spoonerize::VERSION
+  spec.authors = ["Evan Gray"]
+  spec.email = "evanthegrayt@vivaldi.net"
+  spec.license = "MIT"
 
-  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/'
+  spec.summary = %(Spoonerize phrases from the command line.)
+  spec.description = %(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["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/'
+    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/"
   else
-    raise 'RubyGems 2.0 or newer is required to protect against public gem pushes.'
+    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'
+  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_dependency "csv"
+  spec.add_development_dependency "rdoc"
+  spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
+  spec.add_development_dependency "test-unit", "~> 3.3", ">= 3.3.5"
 end

metadata

@@ -1,15 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: spoonerize
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Gray
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-05-22 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -66,10 +93,10 @@ files:
 - Rakefile
 - _config.yml
 - bin/spoonerize
-- lib/config/lazy_words.yml
 - lib/spoonerize.rb
 - lib/spoonerize/bumper.rb
 - lib/spoonerize/cli.rb
+- lib/spoonerize/config.rb
 - lib/spoonerize/log.rb
 - lib/spoonerize/spoonerism.rb
 - lib/spoonerize/version.rb
@@ -82,7 +109,6 @@ metadata:
   homepage_uri: https://evanthegrayt.github.io/spoonerize/
   source_code_uri: https://github.com/evanthegrayt/spoonerize
   documentation_uri: https://evanthegrayt.github.io/spoonerize/
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -97,8 +123,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.3
-signing_key:
+rubygems_version: 4.0.10
 specification_version: 4
 summary: Spoonerize phrases from the command line.
 test_files: []

data/lib/config/lazy_words.yml

@@ -1,22 +0,0 @@
-#=================================================================#
-#         File: lazy_words.yml                                    #
-#  Description: Words to be excluded when "lazy" mode is enabled  #
-#                                                                 #
-#       Author: Evan Gray                                         #
-#=================================================================#
-
-- i
-- a
-- an
-- and
-- in
-- of
-- the
-- my
-- your
-- his
-- her
-- him
-- hers
-- to
-- is