spoonerize 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e49c4789b8b72e510696f5488826a844aaa3c56be7f00b334de009949f4c4359
-  data.tar.gz: b945049341316cd9f126d16989dbbbdf6745a16e1fb33fc71ff8c506ccf3f1ba
+  metadata.gz: bb11ac34b545af8dd6a68950c95de9617c0b54995e5fb9b0ae55f3613d18be22
+  data.tar.gz: 5b60db2501c97458406205884f985e2b07a93a5e7a78b891daedcda45c687d33
 SHA512:
-  metadata.gz: 854f6e483ca545e7fbfb770566d2ef1b2bc9126acb4ae73326ab70f92309ea1d86c9aadb6abf2bb278bca1240898ca849e388d17588e5db0647bec35b03e0a56
-  data.tar.gz: c6d17b2f4ed3d01f4d9cf72b3255782a92a8d896700274d77e06c56af8255e211127b9f6536d97ef4daf576b5db0360f82704b63f0e51b729055d65c417f8035
+  metadata.gz: 1b9c899c14a35ae01d4aaa857f174427acaf91dbdad28a913c57b8e542e7fa33756f5e991c76cf5c978334280b2cd3217c32ef4749e52b2acfc5ed5f9de65cf6
+  data.tar.gz: 0e6c20e84abfb81cd4098f42ee9e5f1907e11c5e62827340885106cce38717dc770acdf21df087da9fcc81235e78bee60f4da05cffbdb3ee07a0b5395f4b7e9a

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.0.7)
+    spoonerize (0.1.3)
+      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/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

@@ -2,7 +2,6 @@ module Spoonerize
   ##
   # Class that handles bumping an index.
   class Bumper
-
     ##
     # The number after being bumped.
     #
@@ -55,7 +54,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'
+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
+      File.expand_path(File.join(ENV["HOME"], ".spoonerize.yml")).freeze
 
     ##
     # Creates an instance of +Spoonerism+ and runs what the user requested.
@@ -25,7 +24,7 @@ module Spoonerize
         return
       end
 
-      puts exe.spoonerism.to_s
+      puts exe.spoonerism
       exe.print_mappings if exe.map?
 
       if exe.save?
@@ -53,10 +52,10 @@ module Spoonerize
     #
     # @return [self]
     def initialize(options)
-      @map         = false
-      @save        = false
-      @print       = false
-      @options     = options
+      @map = false
+      @save = false
+      @print = false
+      @options = options
       @preferences = get_preferences
     end
 
@@ -68,7 +67,7 @@ module Spoonerize
     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) }
+        preferences.each { |k, v| s.send(:"#{k}=", v) }
       end
     end
 
@@ -111,7 +110,7 @@ module Spoonerize
     # @return [nil]
     def print_log
       s = Spoonerize::Log.new(spoonerism.logfile_name)
-      s.each { |row| print row.join(' | ') + "\n" }
+      s.each { |row| print row.join(" | ") + "\n" }
     end
 
     ##
@@ -120,7 +119,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}s => %s\n", k, v)
       end
     end
 
@@ -132,23 +131,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|
+            prefs["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|
+            prefs["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|
+          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|
+          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|
+            prefs["exclude"] = v
           end
         end.parse!(options)
       end

data/lib/spoonerize/log.rb

@@ -1,11 +1,10 @@
-require 'csv'
-require 'fileutils'
+require "csv"
+require "fileutils"
 
 module Spoonerize
   ##
   # Class that handles reading/writing logs.
   class Log
-
     ##
     # The file name to use.
     #
@@ -46,7 +45,7 @@ module Spoonerize
     #
     # @return [Array]
     def write(row)
-      ::CSV.open(file, 'a') { |csv| csv << row }
+      ::CSV.open(file, "a") { |csv| csv << row }
     end
 
     ##

data/lib/spoonerize/spoonerism.rb

@@ -2,7 +2,6 @@ module Spoonerize
   ##
   # The main word-flipper.
   class Spoonerism
-
     ##
     # The words originally passed at initialization.
     #
@@ -85,7 +84,7 @@ module Spoonerize
       @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')
+        File.join(ENV["HOME"], ".cache", "spoonerize", "spoonerize.csv")
       )
 
       load_config_file if config_file
@@ -97,7 +96,7 @@ module Spoonerize
     # 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?
+      raise JakPibError, "Not enough words to flip" unless enough_flippable_words?
 
       words.map.with_index { |word, idx| flip_words(word, idx) }
     end
@@ -105,13 +104,13 @@ module Spoonerize
     ##
     # Returns spoonerize array as a joined string.
     def to_s
-      spoonerize.join(' ')
+      spoonerize.join(" ")
     end
 
     ##
     # Returns hash of the original words mapped to their flipped counterparts.
     def to_h
-      Hash[words.zip(spoonerize)]
+      words.zip(spoonerize).to_h
     end
 
     ##
@@ -149,7 +148,7 @@ module Spoonerize
     ##
     # Saves the flipped words to the log file, along with the options
     def save
-      log.write([words.join(' '), to_s, options.join(', ')])
+      log.write([words.join(" "), to_s, options.join(", ")])
     end
 
     ##
@@ -177,11 +176,11 @@ module Spoonerize
     #
     # @return [Hash] The config options
     def load_config_file
-      raise 'No config file set' if config_file.nil?
+      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 = YAML.load_file(config_file)
       @config_file_loaded = true
-      @config.each { |k, v| send("#{k}=", v) }
+      @config.each { |k, v| send(:"#{k}=", v) }
     end
 
     private
@@ -193,7 +192,7 @@ module Spoonerize
     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.bump while excluded?(bumper.value)
       words[bumper.value].match(consonants).to_s + word.match(vowels).to_s
     end
 
@@ -225,10 +224,10 @@ module Spoonerize
     # the options 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 lazy?
+        o << "Reverse" if reverse?
+        o << "Exclude [#{all_excluded_words.join(", ")}]" if excluded_words.any?
+        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.
+    #
+    # @return [Integer]
     MINOR = 1
 
     ##
     # Patch version.
-    PATCH = 1
+    #
+    # @return [Integer]
+    PATCH = 3
+
+    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,9 +1,9 @@
-require 'yaml'
-require_relative 'spoonerize/spoonerism'
-require_relative 'spoonerize/bumper'
-require_relative 'spoonerize/version'
-require_relative 'spoonerize/log'
-require_relative 'spoonerize/cli'
+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.
@@ -15,7 +15,6 @@ module Spoonerize
   ##
   # Excluded words from config files.
   LAZY_WORDS = YAML.load_file(
-    File.join(File.dirname(__FILE__), 'config', 'lazy_words.yml')
+    File.join(File.dirname(__FILE__), "config", "lazy_words.yml")
   ).freeze
 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.1
+  version: 0.1.3
 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
@@ -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: []