spoonerize 1.0.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b4c993b75b971449d8795c0666e4645bee48ff903afaea84463025da44ffdbf
-  data.tar.gz: b57070d3e1dc670ef4cdf17f9657c8759828e86a039571d305a6d6716aaa5b65
+  metadata.gz: 9ad82a22fd996a0e5af1653a6ed66f27863da252331b4fa58865980d6a27b063
+  data.tar.gz: d206494ce8cc6e9dabbda3ab86389d080e57d1baf0a003800ba6edd3fe3c3b13
 SHA512:
-  metadata.gz: ccf19838d1a10609dddbd2da4cfe8286c548b9bc91e2b957ee592120225305c93a166da7ae10c34ead80a402f8cb767fbb192162fade18afc046298ff3d5dd1c
-  data.tar.gz: 3420c7dc81ea682e3388b9f9097a6c538199cbb38e2f5179e3a5f68f8200b278674da04397df05e14a259ad6ba5878daf3b63390f244a3988c3678f08e8b85a3
+  metadata.gz: f8b89f4ea9ca38fb0ee9773ca55e6fb654e94d4135f4b4748abc91c90fe014e3c1bd90e6f0c9c4f9d74f2efcf64b7bfd8b488ebcf3cf92dc40d9c2616089d30e
+  data.tar.gz: 1c81200ffd8922cc1384c11b9a8a8766eae3d59f3301c544dbf9a6928617c85d231f931cec768d4ad4c7c8fcbc697ca94d666c182340974c7d406411c11dab34

data/Gemfile.lock

@@ -1,19 +1,26 @@
 PATH
   remote: .
   specs:
-    spoonerize (1.0.0)
+    spoonerize (2.0.0)
       csv
+      puma (~> 8.0)
+      rackup (~> 2.3)
+      sinatra (~> 4.2)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.3)
+    base64 (0.3.0)
     csv (3.3.5)
     date (3.5.1)
     erb (6.0.4)
     json (2.20.0)
     language_server-protocol (3.17.0.5)
     lint_roller (1.1.0)
+    logger (1.7.0)
+    mustermann (3.1.1)
+    nio4r (2.7.5)
     parallel (1.28.0)
     parser (3.3.11.1)
       ast (~> 2.4.1)
@@ -23,7 +30,19 @@ GEM
     psych (5.4.0)
       date
       stringio
+    puma (8.0.2)
+      nio4r (~> 2.0)
     racc (1.8.1)
+    rack (3.2.6)
+    rack-protection (4.2.1)
+      base64 (>= 0.1.0)
+      logger (>= 1.6.0)
+      rack (>= 3.0.0, < 4)
+    rack-session (2.1.2)
+      base64 (>= 0.1.0)
+      rack (>= 3.0.0)
+    rackup (2.3.1)
+      rack (>= 3)
     rainbow (3.1.1)
     rake (13.4.2)
     rdoc (7.2.0)
@@ -50,6 +69,13 @@ GEM
       rubocop (>= 1.75.0, < 2.0)
       rubocop-ast (>= 1.47.1, < 2.0)
     ruby-progressbar (1.13.0)
+    sinatra (4.2.1)
+      logger (>= 1.6.0)
+      mustermann (~> 3.0)
+      rack (>= 3.0.0, < 4)
+      rack-protection (= 4.2.1)
+      rack-session (>= 2.0.0, < 3)
+      tilt (~> 2.0)
     standard (1.54.0)
       language_server-protocol (~> 3.17.0.2)
       lint_roller (~> 1.0)
@@ -65,6 +91,7 @@ GEM
     stringio (3.2.0)
     test-unit (3.7.8)
       power_assert
+    tilt (2.7.0)
     tsort (0.2.0)
     unicode-display_width (3.2.0)
       unicode-emoji (~> 4.1)

data/README.md

@@ -100,7 +100,7 @@ Here is a list of all available options:
 
 ```
 -r, --[no-]reverse               Reverse flipping
--l, --[no-]lazy                  Skip small words
+-l, --[no-]lazy                  Skip common words
 -c, --[no-]consonants-only       Only flip consonant-starting words
 -m, --[no-]map                   Print words mapping
 -p, --[no-]print-log             Print all entries in the log
@@ -108,10 +108,34 @@ Here is a list of all available options:
     --exclude=WORD               Words to skip
 ```
 
+## Web Usage
+The gem also installs a small Sinatra app:
+
+```sh
+spoonerize-web
+```
+
+By default, Sinatra starts on its normal local development address. You can
+choose a host or port when you need to:
+
+```sh
+spoonerize-web --host 127.0.0.1 --port 9292
+```
+
+Open the printed local URL in your browser, enter a phrase, choose any options,
+and submit the form. The page reloads with the spoonerized result and keeps
+your phrase and options in the form. Check "Save result" to write a successful
+result to the configured log file.
+
+The web app ships with the main gem for now, so `gem install spoonerize`
+installs both `spoonerize` and `spoonerize-web`.
+
 ### Config File
 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.
+file can still be overridden at runtime by executable flags. The web app loads
+the same file when it starts, and uses those values for the initial form
+defaults.
 
 ```ruby
 Spoonerize.configure do |config|

data/bin/spoonerize-web

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require_relative "../lib/spoonerize/web/cli"
+
+Spoonerize::Web::Cli.execute(ARGV)

data/lib/spoonerize/cli.rb

@@ -7,10 +7,10 @@ module Spoonerize
   # The class for handling the command-line interface.
   class Cli
     ##
-    # The config file the user can create to change default runtime options.
+    # The config file the CLI loads before parsing runtime options.
     #
     # @return [String]
-    CONFIG_FILE = File.expand_path(File.join(ENV["HOME"], ".spoonerizerc"))
+    CONFIG_FILE = Spoonerize::CONFIG_FILE
 
     ##
     # Creates an instance of +Spoonerism+ and runs what the user requested.
@@ -131,7 +131,7 @@ module Spoonerize
           o.on("-r", "--[no-]reverse", "Reverse flipping") do |v|
             prefs[:reverse] = v
           end
-          o.on("-l", "--[no-]lazy", "Skip small words") do |v|
+          o.on("-l", "--[no-]lazy", "Skip common words") do |v|
             prefs[:lazy] = v
           end
           o.on("-c", "--[no-]consonants-only", "Only flip consonant-starting words") do |v|

data/lib/spoonerize/config.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 module Spoonerize
+  ##
+  # Runtime options used by the CLI and Spoonerism instances.
   class Config
     ##
     # Lazy mode. If true, words in +lazy_words+ will not be altered.

data/lib/spoonerize/spoonerism.rb

@@ -4,8 +4,22 @@ module Spoonerize
   ##
   # The main word-flipper.
   class Spoonerism
+    ##
+    # Letters that always represent vowel sounds.
+    #
+    # @return [String]
     VOWEL_LETTERS = "aeio"
+
+    ##
+    # Letters that always represent consonant sounds.
+    #
+    # @return [String]
     CONSONANT_LETTERS = "bcdfghjklmnprstvwxz"
+
+    ##
+    # Letters that make an initial "y" act like a vowel sound.
+    #
+    # @return [String]
     Y_FOLLOWING_CONSONANTS = "bcdfghjklmnpqrstvwxz"
 
     ##

data/lib/spoonerize/version.rb

@@ -9,7 +9,7 @@ module Spoonerize
     # Major version.
     #
     # @return [Integer]
-    MAJOR = 1
+    MAJOR = 2
 
     ##
     # Minor version.

data/lib/spoonerize/web/cli.rb

@@ -0,0 +1,72 @@
+# frozen_string_literal: true
+
+require "optparse"
+
+require_relative "../web"
+
+module Spoonerize
+  class Web
+    ##
+    # Command-line launcher for the web app.
+    class Cli
+      ##
+      # Server options used when no command-line overrides are passed.
+      #
+      # @return [Hash]
+      DEFAULT_OPTIONS = {
+        host: Web.bind,
+        port: Web.port
+      }.freeze
+
+      ##
+      # Starts the web app from command-line arguments.
+      #
+      # @param [Array] options
+      #
+      # @return [nil]
+      def self.execute(options = [])
+        new(options).execute
+      end
+
+      ##
+      # Parsed server options.
+      #
+      # @return [Hash]
+      attr_reader :options
+
+      ##
+      # Create a web CLI launcher.
+      #
+      # @param [Array] options Command-line arguments.
+      #
+      # @return [self]
+      def initialize(options)
+        @options = DEFAULT_OPTIONS.merge(parse(options))
+      end
+
+      ##
+      # Starts the Sinatra web app.
+      #
+      # @return [nil]
+      def execute
+        Web.run!(bind: options[:host], port: options[:port])
+      end
+
+      private
+
+      def parse(options)
+        {}.tap do |prefs|
+          OptionParser.new do |o|
+            o.version = ::Spoonerize::Version.to_s
+            o.on("--host=HOST", "Host to bind") do |value|
+              prefs[:host] = value
+            end
+            o.on("--port=PORT", Integer, "Port to bind") do |value|
+              prefs[:port] = value
+            end
+          end.parse!(options)
+        end
+      end
+    end
+  end
+end

data/lib/spoonerize/web/public/styles.css

@@ -0,0 +1,178 @@
+:root {
+  color-scheme: light;
+  --bg: #f7f7f4;
+  --ink: #24211f;
+  --muted: #6c655f;
+  --line: #d7d2c9;
+  --panel: #fffdfa;
+  --accent: #1d6f78;
+  --accent-dark: #145059;
+  --notice-bg: #fff0dc;
+  --notice-line: #e1a853;
+}
+
+* {
+  box-sizing: border-box;
+}
+
+body {
+  margin: 0;
+  min-height: 100vh;
+  background: var(--bg);
+  color: var(--ink);
+  font-family: ui-serif, Georgia, "Times New Roman", serif;
+  line-height: 1.5;
+}
+
+.page {
+  min-height: 100vh;
+  display: grid;
+  place-items: start center;
+  padding: 4rem 1rem;
+}
+
+.shell {
+  width: min(100%, 46rem);
+}
+
+.masthead {
+  margin-bottom: 2rem;
+  border-bottom: 1px solid var(--line);
+  padding-bottom: 1.25rem;
+}
+
+h1 {
+  margin: 0;
+  font-size: clamp(2.2rem, 7vw, 4rem);
+  line-height: 1;
+}
+
+.result {
+  margin: 0 0 1.75rem;
+  font-size: clamp(2rem, 6vw, 3.6rem);
+  font-weight: 800;
+  line-height: 1.05;
+}
+
+.notice {
+  margin: 0 0 1.5rem;
+  border: 1px solid var(--notice-line);
+  background: var(--notice-bg);
+  padding: 0.8rem 1rem;
+  font-family: ui-sans-serif, system-ui, sans-serif;
+  font-weight: 650;
+}
+
+.spoonerize-form {
+  display: grid;
+  gap: 1rem;
+}
+
+.field,
+fieldset {
+  display: grid;
+  gap: 0.45rem;
+}
+
+.field span,
+legend {
+  color: var(--muted);
+  font-family: ui-sans-serif, system-ui, sans-serif;
+  font-size: 0.85rem;
+  font-weight: 700;
+}
+
+input[type="text"] {
+  width: 100%;
+  border: 1px solid var(--line);
+  border-radius: 4px;
+  background: var(--panel);
+  color: var(--ink);
+  font: inherit;
+  font-size: 1.1rem;
+  padding: 0.75rem 0.85rem;
+}
+
+input[type="text"]:focus {
+  border-color: var(--accent);
+  outline: 3px solid color-mix(in srgb, var(--accent) 22%, transparent);
+}
+
+fieldset {
+  margin: 0;
+  border: 1px solid var(--line);
+  border-radius: 4px;
+  background: var(--panel);
+  padding: 0.9rem 1rem 1rem;
+}
+
+legend {
+  padding: 0 0.35rem;
+}
+
+.check {
+  display: flex;
+  align-items: center;
+  gap: 0.55rem;
+  font-family: ui-sans-serif, system-ui, sans-serif;
+}
+
+.check input {
+  width: 1rem;
+  height: 1rem;
+  accent-color: var(--accent);
+}
+
+button {
+  width: fit-content;
+  border: 0;
+  border-radius: 4px;
+  background: var(--accent);
+  color: #fff;
+  cursor: pointer;
+  font-family: ui-sans-serif, system-ui, sans-serif;
+  font-size: 1rem;
+  font-weight: 750;
+  padding: 0.72rem 1rem;
+}
+
+button:hover,
+button:focus {
+  background: var(--accent-dark);
+}
+
+.footer {
+  width: min(100%, 46rem);
+  margin-top: 2.5rem;
+  border-top: 1px solid var(--line);
+  padding-top: 1rem;
+  color: var(--muted);
+  font-family: ui-sans-serif, system-ui, sans-serif;
+  font-size: 0.82rem;
+}
+
+.footer a {
+  color: inherit;
+  text-decoration-color: color-mix(in srgb, var(--muted) 45%, transparent);
+  text-underline-offset: 0.16em;
+}
+
+.footer a:hover,
+.footer a:focus {
+  color: var(--accent-dark);
+  text-decoration-color: currentcolor;
+}
+
+.footer span {
+  margin: 0 0.35rem;
+}
+
+@media (max-width: 40rem) {
+  .page {
+    padding-top: 2rem;
+  }
+
+  button {
+    width: 100%;
+  }
+}

data/lib/spoonerize/web/views/index.erb

@@ -0,0 +1,61 @@
+<section class="shell">
+  <header class="masthead">
+    <h1>Flip a phrase</h1>
+  </header>
+
+  <% if @result %>
+    <p class="result"><%= h @result %></p>
+    <% if @saved %>
+      <p class="notice">Saved.</p>
+    <% end %>
+  <% elsif @error %>
+    <p class="notice"><%= h @error %></p>
+  <% end %>
+
+  <form action="/" method="post" class="spoonerize-form">
+    <label class="field">
+      <span>Phrase</span>
+      <input
+        type="text"
+        name="phrase"
+        value="<%= h @phrase %>"
+        placeholder="Enter phrase to spoonerize..."
+        autofocus>
+    </label>
+
+    <fieldset>
+      <legend>Options</legend>
+
+      <label class="check">
+        <input type="checkbox" name="reverse" value="1" <%= checked?("reverse") %>>
+        <span>Reverse flipping</span>
+      </label>
+
+      <label class="check">
+        <input type="checkbox" name="lazy" value="1" <%= checked?("lazy") %>>
+        <span>Skip common words</span>
+      </label>
+
+      <label class="check">
+        <input type="checkbox" name="consonants_only" value="1" <%= checked?("consonants_only") %>>
+        <span>Only flip consonant-starting words</span>
+      </label>
+
+      <label class="check">
+        <input type="checkbox" name="save" value="1" <%= @save ? "checked" : nil %>>
+        <span>Save result</span>
+      </label>
+    </fieldset>
+
+    <label class="field">
+      <span>Excluded words</span>
+      <input
+        type="text"
+        name="excluded_words"
+        value="<%= h @excluded_words_value %>"
+        placeholder="word another">
+    </label>
+
+    <button type="submit">Spoonerize</button>
+  </form>
+</section>

data/lib/spoonerize/web/views/layout.erb

@@ -0,0 +1,20 @@
+<!doctype html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1">
+    <title>Spoonerize</title>
+    <link rel="stylesheet" href="/styles.css">
+  </head>
+  <body>
+    <main class="page">
+      <%= yield %>
+
+      <footer class="footer">
+        <a href="https://github.com/evanthegrayt">evanthegrayt</a>
+        <span>/</span>
+        <a href="https://github.com/evanthegrayt/spoonerize">spoonerize</a>
+      </footer>
+    </main>
+  </body>
+</html>

data/lib/spoonerize/web.rb

@@ -0,0 +1,121 @@
+# frozen_string_literal: true
+
+require "sinatra/base"
+
+require_relative "../spoonerize"
+
+module Spoonerize
+  ##
+  # Sinatra app for spoonerizing phrases in the browser.
+  class Web < Sinatra::Base
+    ##
+    # Boolean Spoonerism options exposed by the web form.
+    #
+    # @return [Array<String>]
+    OPTION_NAMES = %w[reverse lazy consonants_only].freeze
+
+    set :root, File.expand_path(File.join(__dir__, "..", ".."))
+    set :public_folder, File.expand_path(File.join(__dir__, "web", "public"))
+    set :views, File.expand_path(File.join(__dir__, "web", "views"))
+    set :static, true
+    set :show_exceptions, false
+
+    configure do
+      Spoonerize.load_config_file(Spoonerize::CONFIG_FILE) if File.file?(Spoonerize::CONFIG_FILE)
+    end
+
+    helpers do
+      ##
+      # HTML checkbox attribute for a truthy option value.
+      #
+      # @param [String] name The option name.
+      #
+      # @return [String, nil]
+      def checked?(name)
+        option_value(name) ? "checked" : nil
+      end
+
+      ##
+      # Current boolean value for a web form option.
+      #
+      # @param [String] name The option name.
+      #
+      # @return [Boolean]
+      def option_value(name)
+        @options.fetch(name.to_sym)
+      end
+
+      ##
+      # Escapes a value for safe HTML output.
+      #
+      # @param [Object] value The value to escape.
+      #
+      # @return [String]
+      def h(value)
+        Rack::Utils.escape_html(value)
+      end
+    end
+
+    get "/" do
+      prepare_request(false)
+      erb :index
+    end
+
+    post "/" do
+      prepare_request(true)
+      @result = spoonerize_phrase if @submitted && !@phrase.strip.empty?
+
+      erb :index
+    end
+
+    private
+
+    def options_from_params
+      OPTION_NAMES.to_h do |name|
+        value = @submitted ? params.key?(name) : Spoonerize.config.public_send(name)
+        [name.to_sym, value]
+      end
+    end
+
+    def excluded_words_from(value)
+      value.split(/[,\s]+/).reject(&:empty?)
+    end
+
+    def excluded_words_from_params
+      return excluded_words_from(params["excluded_words"].to_s) if @submitted
+
+      Spoonerize.config.excluded_words
+    end
+
+    def prepare_request(submitted)
+      @submitted = submitted
+      @phrase = params["phrase"].to_s
+      @options = options_from_params
+      @excluded_words = excluded_words_from_params
+      @excluded_words_value = @excluded_words.join(" ")
+      @save = @submitted && params.key?("save")
+    end
+
+    def spoonerize_phrase
+      spoonerism = Spoonerism.new(
+        *@phrase.split,
+        **@options,
+        excluded_words: @excluded_words
+      )
+      result = spoonerism.to_s
+      spoonerism.save if @save
+      @saved = @save
+
+      result
+    rescue => error
+      @error = friendly_error(error)
+      nil
+    end
+
+    def friendly_error(error)
+      return "Not enough words to flip." if error.message == "Not enough words to flip"
+
+      error.message
+    end
+  end
+end

data/lib/spoonerize.rb

@@ -1,5 +1,15 @@
 # frozen_string_literal: true
 
+##
+# The main namespace for the gem.
+module Spoonerize
+  ##
+  # The config file the user can create to change default runtime options.
+  #
+  # @return [String]
+  CONFIG_FILE = File.expand_path(File.join(ENV["HOME"], ".spoonerizerc"))
+end
+
 require_relative "spoonerize/config"
 require_relative "spoonerize/spoonerism"
 require_relative "spoonerize/bumper"

data/spoonerize.gemspec

@@ -10,6 +10,7 @@ Gem::Specification.new do |spec|
   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/"
+  spec.required_ruby_version = ">= 3.2"
 
   # 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.
@@ -29,6 +30,9 @@ Gem::Specification.new do |spec|
   spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
   spec.add_dependency "csv"
+  spec.add_dependency "puma", "~> 8.0"
+  spec.add_dependency "rackup", "~> 2.3"
+  spec.add_dependency "sinatra", "~> 4.2"
   spec.add_development_dependency "rdoc"
   spec.add_development_dependency "rake", "~> 13.0", ">= 13.0.1"
   spec.add_development_dependency "standard", "= 1.54.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: spoonerize
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 2.0.0
 platform: ruby
 authors:
 - Evan Gray
@@ -23,6 +23,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: puma
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: rackup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: sinatra
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
 - !ruby/object:Gem::Dependency
   name: rdoc
   requirement: !ruby/object:Gem::Requirement
@@ -95,6 +137,7 @@ description: Spoonerize phrases from the command line. Comes with an API
 email: evanthegrayt@vivaldi.net
 executables:
 - spoonerize
+- spoonerize-web
 extensions: []
 extra_rdoc_files: []
 files:
@@ -107,6 +150,7 @@ files:
 - Rakefile
 - _config.yml
 - bin/spoonerize
+- bin/spoonerize-web
 - lib/spoonerize.rb
 - lib/spoonerize/bumper.rb
 - lib/spoonerize/cli.rb
@@ -114,6 +158,11 @@ files:
 - lib/spoonerize/log.rb
 - lib/spoonerize/spoonerism.rb
 - lib/spoonerize/version.rb
+- lib/spoonerize/web.rb
+- lib/spoonerize/web/cli.rb
+- lib/spoonerize/web/public/styles.css
+- lib/spoonerize/web/views/index.erb
+- lib/spoonerize/web/views/layout.erb
 - spoonerize.gemspec
 homepage: https://evanthegrayt.github.io/spoonerize/
 licenses:
@@ -130,7 +179,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: '3.2'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="