spoonerize 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bb11ac34b545af8dd6a68950c95de9617c0b54995e5fb9b0ae55f3613d18be22
-  data.tar.gz: 5b60db2501c97458406205884f985e2b07a93a5e7a78b891daedcda45c687d33
+  metadata.gz: 932ce6e7e6441c787ded513aebed0b3e0b83fa6afa83790abe8da66c9314e96b
+  data.tar.gz: 6a5dedc04324853f1bfbc63e6317b17737eab6fb10b89ae11136b598438a4f08
 SHA512:
-  metadata.gz: 1b9c899c14a35ae01d4aaa857f174427acaf91dbdad28a913c57b8e542e7fa33756f5e991c76cf5c978334280b2cd3217c32ef4749e52b2acfc5ed5f9de65cf6
-  data.tar.gz: 0e6c20e84abfb81cd4098f42ee9e5f1907e11c5e62827340885106cce38717dc770acdf21df087da9fcc81235e78bee60f4da05cffbdb3ee07a0b5395f4b7e9a
+  metadata.gz: b579d2925471dca724865574a82a827a5f0d31229991d1746db4890a0d4c250141daa536bbc932c829fd9d7e8f5af63e89b85846a788d23eca766219c2a60681
+  data.tar.gz: 1531172c418c2cf00e155ca5e56c888218888af9c8b6694ff7a9b3195dbda173c122058e7ac46c4705c311d7951a8c6f773aa09d4571a447da7f4781ca425168

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    spoonerize (0.1.3)
+    spoonerize (0.2.0)
       csv
 
 GEM

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/lib/spoonerize/bumper.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spoonerize
   ##
   # Class that handles bumping an index.

data/lib/spoonerize/cli.rb

@@ -1,16 +1,16 @@
+# frozen_string_literal: true
+
 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.
+    # 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.
@@ -19,7 +19,7 @@ module Spoonerize
     def self.execute(options = [])
       exe = new(options)
 
-      if exe.print?
+      if exe.print_log?
         exe.print_log
         return
       end
@@ -52,23 +52,20 @@ module Spoonerize
     #
     # @return [self]
     def initialize(options)
+      Spoonerize.load_config_file(CONFIG_FILE) if File.file?(CONFIG_FILE)
       @map = false
       @save = false
-      @print = 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
 
     ##
@@ -91,8 +88,8 @@ module Spoonerize
     # Should we print to the command line?
     #
     # @return [Boolean]
-    def print?
-      @print
+    def print_log?
+      @print_log
     end
 
     ##
@@ -100,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
 
     ##
@@ -109,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
 
     ##
@@ -119,7 +116,7 @@ module Spoonerize
     # @return [nil]
     def print_mappings
       spoonerism.to_h.each do |k, v|
-        printf("%-#{longest_word_length}s => %s\n", k, v)
+        printf("%-#{longest_word_length + 1}s => %s\n", k, v)
       end
     end
 
@@ -132,22 +129,22 @@ module Spoonerize
         OptionParser.new do |o|
           o.version = ::Spoonerize::Version.to_s
           o.on("-r", "--[no-]reverse", "Reverse flipping") do |v|
-            prefs["reverse"] = v
+            Spoonerize.config.reverse = v
           end
           o.on("-l", "--[no-]lazy", "Skip small words") do |v|
-            prefs["lazy"] = v
+            Spoonerize.config.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
+          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|
             @save = v
           end
           o.on("--exclude=WORD", Array, "Words to skip") do |v|
-            prefs["exclude"] = 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,9 +1,11 @@
+# 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.
@@ -51,7 +53,7 @@ module Spoonerize
     ##
     # 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,3 +1,5 @@
+# frozen_string_literal: true
+
 module Spoonerize
   ##
   # The main word-flipper.
@@ -9,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(" ")
     end
 
     ##
-    # Returns hash of the original words mapped to their flipped counterparts.
+    # Spoonerized results as a joined hash.
+    #
+    # @return [Hash]
     def to_h
       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
+    #
+    # @return [Array]
     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
+    # 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 [String]
-    def config_file=(config_file)
-      @config_file = File.expand_path(config_file)
-    end
-
-    ##
-    # Loads the config file
-    #
-    # @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
@@ -191,7 +91,7 @@ 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 = 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
@@ -217,16 +117,18 @@ 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 << "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

data/lib/spoonerize/version.rb

@@ -15,13 +15,13 @@ module Spoonerize
     # Minor version.
     #
     # @return [Integer]
-    MINOR = 1
+    MINOR = 2
 
     ##
     # Patch version.
     #
     # @return [Integer]
-    PATCH = 3
+    PATCH = 0
 
     module_function
 

data/lib/spoonerize.rb

@@ -1,4 +1,6 @@
-require "yaml"
+# frozen_string_literal: true
+
+require_relative "spoonerize/config"
 require_relative "spoonerize/spoonerism"
 require_relative "spoonerize/bumper"
 require_relative "spoonerize/version"
@@ -9,12 +11,57 @@ 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
+
+  ##
+  # 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
 
   ##
-  # Excluded words from config files.
-  LAZY_WORDS = YAML.load_file(
-    File.join(File.dirname(__FILE__), "config", "lazy_words.yml")
-  ).freeze
+  # 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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoonerize
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan Gray
@@ -93,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

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