typewrite 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efa86fb7cf794c1ea05096594de6f93085685516349f1b6f5e858cccf5c09e84
-  data.tar.gz: e808a5d20615b4fc265486ab7cd09e8d74d717235557c1521b68ac1e68538670
+  metadata.gz: 1ee853e9212af73f1b12a6518946393a40beccc0cbe5df5e7b12dee147337d50
+  data.tar.gz: 7c3d96dcde6fbd358ceb4a05ac6769da6aba5a5bdc08e007618ec0a59cc64dae
 SHA512:
-  metadata.gz: 361c42d76a638ea30e048af83371de0d8f45b7ca57085cfb93904b7a1cc1c0830e052b29736783b29433f229728e2dac32428f583e0aae3093954f47536cf8f1
-  data.tar.gz: 80aeecf5215198c8fd787afe40f3460549a6553adde9a42e7f442bdb51263c83dbcc2d45808bf823d1dffd9a93dd4206ff51c241a5843ad66aeb2396c5f1b6c4
+  metadata.gz: 4d05e589cf61fc51a40dd96272045680c873474a5cf64327aecc224986c4d4b863873bbdf70ca500ceb8cc56ab5e51c84d06c8dce5e3f1d6fdb356f2b3f1b9cc
+  data.tar.gz: '09bad21d5cf41ad3d1b2bf756a9b6f65af663dce54abfdae984d4fc82485a84d7d7ab198d2318224d773374d4e1d667cb2ffc9c0b8ee0c0c45419fef796377ce'

data/.github/workflows/ci.yml

@@ -0,0 +1,48 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: '3.4'
+          bundler-cache: true
+
+      - name: Run RuboCop
+        run: bundle exec rubocop
+
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby-version:
+          - '3.0'
+          - '3.1'
+          - '3.2'
+          - '3.3'
+          - '3.4'
+
+    name: Ruby ${{ matrix.ruby-version }}
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby-version }}
+          bundler-cache: true
+
+      - name: Run tests
+        run: bundle exec rspec

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,36 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 3.0
+  Exclude:
+    - "vendor/**/*"
+    - "pkg/**/*"
+
+# Gem-specific relaxations
+Style/Documentation:
+  Enabled: false  # Small gem, README is sufficient
+
+Metrics/BlockLength:
+  Exclude:
+    - "spec/**/*"
+    - "*.gemspec"
+
+Metrics/AbcSize:
+  Max: 18  # Allow slightly higher for interrupt logic
+
+Metrics/MethodLength:
+  Max: 20  # Allow slightly higher for interrupt logic
+
+# Prefer double quotes (common in gems)
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  EnforcedStyle: double_quotes
+
+# Frozen string literal is good practice
+Style/FrozenStringLiteralComment:
+  EnforcedStyle: always
+
+# Allow boolean parameters for backwards compatibility
+Style/OptionalBooleanParameter:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,48 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [1.2.0] - 2026-02-02
+
+### Added
+- Keyboard interrupt support to skip typewriter animation
+  - `interrupt: true` or `interrupt: :enter` - Skip with Enter key
+  - `interrupt: :any` - Skip with any key press
+  - `interrupt: ["q", "x", " "]` - Skip with specific keys
+- When interrupted, remaining text prints immediately
+- Non-blocking keyboard input detection using `io/console`
+
+### Changed
+- Updated README with interrupt mode documentation and examples
+- Adjusted RuboCop metrics configuration for interrupt logic
+- **Note:** Undocumented keyword argument syntax (e.g., `type_rate: 0.05`) is no longer supported due to Ruby 3.0+ keyword argument separation. All documented positional argument usage remains fully compatible.
+
+### Technical
+- Added `write_interruptible` and `key_matches?` private methods
+- Uses `IO.select` for non-blocking input polling (Ruby 3.0+ compatible)
+- 100% backwards compatible for all documented usage patterns
+
+## [1.1.0] - 2025-01-XX
+
+### Changed
+- Modernized codebase to idiomatic Ruby gem standards
+- Added RuboCop linting to development workflow
+
+### Added
+- RSpec testing infrastructure
+- GitHub Actions CI workflow
+- Comprehensive test coverage for timing and output behavior
+
+## [1.0.0] - Earlier
+
+### Added
+- Initial typewriter effect implementation
+- Basic timing controls (type_rate, punc_rate)
+- Line break control
+
+[1.2.0]: https://github.com/CJGlitter/typewrite/compare/v1.1.0...v1.2.0
+[1.1.0]: https://github.com/CJGlitter/typewrite/compare/v1.0.0...v1.1.0
+[1.0.0]: https://github.com/CJGlitter/typewrite/releases/tag/v1.0.0

data/Gemfile

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+gemspec
+
+group :development, :test do
+  gem "rake", "~> 13.0"
+  gem "rspec", "~> 3.12"
+  gem "rubocop", "~> 1.60", require: false
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2023 Cory Davis
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,85 @@
+## Typewrite ##
+
+[![Gem Version](https://badge.fury.io/rb/typewrite.svg)](https://badge.fury.io/rb/typewrite)
+
+Typewrite is a Ruby library that prints console messages "typewriter" style, or letter-by-letter.
+
+### Installation ###
+    #Installing as Ruby gem
+    $gem install typewrite
+
+    #Cloning the repsository
+    $git clone git@github.com:CJGlitter/typewrite.git
+### Usage ###
+
+```ruby
+require "typewrite"
+Typewrite.write("Your message here!")
+```
+
+### Options ###
+
+The variable options include type rate, pause length, line breaks, and interrupt behavior. By default, the type rate is one character per 0.1 second with a 1.5 second pause after each punctuation character `['.','?','!']` with a new line after each message.
+
+#### Basic Options
+
+You can adjust the type rate and pause length with numbers and turn off the newlines with a boolean:
+
+```ruby
+message = "Here's your message"
+Typewrite.write(message, 0.05, 0, false)
+```
+
+That would result in a message that types a character every 0.05 seconds with no punctuation pauses and no newlines after each message.
+
+#### Interrupt Mode
+
+You can allow users to skip the typewriter animation by pressing keys during output:
+
+```ruby
+# Allow interruption with Enter key (default interrupt behavior)
+Typewrite.write("Press ENTER to skip...", interrupt: true)
+Typewrite.write("Press ENTER to skip...", interrupt: :enter)
+
+# Allow interruption with any key
+Typewrite.write("Press ANY key to skip...", interrupt: :any)
+
+# Allow interruption with specific keys
+Typewrite.write("Press Q, X, or SPACE to skip...", interrupt: ["q", "x", " "])
+```
+
+When interrupted, the remaining text prints immediately so users see the complete message.
+
+## Development
+
+### Running Tests
+
+```bash
+bundle install
+bundle exec rake        # Run tests + linting
+bundle exec rspec       # Run tests only
+bundle exec rubocop     # Run linting only
+```
+
+### Code Quality
+
+This project uses RuboCop for linting. Please ensure your code passes linting before submitting a PR:
+
+```bash
+bundle exec rubocop -A  # Auto-fix issues
+```
+
+## Versioning
+
+Typewrite follows the [Semantic Versioning](http://semver.org/) standard.
+
+### Contributing ###
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CJGlitter/typewrite
+
+### License ###
+Copywrite ©Cory Davis 2023
+
+https://cjglitter.com
+
+Released under the MIT license. See LICENSE file for details.

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+RuboCop::RakeTask.new(:rubocop)
+
+task default: %i[spec rubocop]

data/lib/typewrite/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Typewrite
+  VERSION = "1.2.0"
+end

data/lib/typewrite.rb

@@ -1,12 +1,101 @@
-class Typewrite
-  def self.write(input, type_rate = 0.1, punc_rate = 1.5, line_break = true)
-    input_array = input.split('')
-    input_array.each do |char|
+# frozen_string_literal: true
+
+require_relative "typewrite/version"
+require "io/console"
+
+# Prints console messages with a typewriter effect (letter-by-letter).
+#
+# @example Basic usage
+#   Typewrite.write("Hello, World!")
+#
+# @example Custom timing
+#   Typewrite.write("Fast typing", 0.05, 0.5, false)
+#
+module Typewrite
+  # Characters that trigger an extra pause
+  PUNCTUATION = [".", "?", "!"].freeze
+
+  # Prints a message with typewriter effect.
+  #
+  # @param input [String] the message to display
+  # @param type_rate [Float] seconds between each character (default: 0.1)
+  # @param punc_rate [Float] extra pause after punctuation (default: 1.5)
+  # @param line_break [Boolean] add newline at end (default: true)
+  # @param interrupt [Boolean, Symbol, Array] enable interrupt mode (default: false)
+  #   - false: no interrupt (default)
+  #   - true or :enter: interrupt on Enter key
+  #   - :any: interrupt on any key
+  #   - Array: interrupt on specific keys (e.g., ["q", "x", " "])
+  # @return [void]
+  def self.write(input, type_rate = 0.1, punc_rate = 1.5, line_break = true, interrupt: false)
+    return write_simple(input, type_rate, punc_rate, line_break) unless interrupt
+
+    write_interruptible(input, type_rate, punc_rate, line_break, interrupt)
+  end
+
+  # Simple non-interruptible write (original behavior)
+  #
+  # @param input [String] the message to display
+  # @param type_rate [Float] seconds between each character
+  # @param punc_rate [Float] extra pause after punctuation
+  # @param line_break [Boolean] add newline at end
+  # @return [void]
+  private_class_method def self.write_simple(input, type_rate, punc_rate, line_break)
+    input.each_char do |char|
       print char
-      puncs = ['.','?','!',]
-      sleep(punc_rate) if puncs.include?(char)
+      sleep(punc_rate) if PUNCTUATION.include?(char)
       sleep(type_rate)
     end
     print "\n" if line_break
   end
+
+  # Interruptible write with keyboard input detection
+  #
+  # @param input [String] the message to display
+  # @param type_rate [Float] seconds between each character
+  # @param punc_rate [Float] extra pause after punctuation
+  # @param line_break [Boolean] add newline at end
+  # @param interrupt_config [Boolean, Symbol, Array] interrupt configuration
+  # @return [void]
+  private_class_method def self.write_interruptible(input, type_rate, punc_rate, line_break, interrupt_config)
+    chars = input.chars
+    index = 0
+
+    $stdin.raw do |io|
+      while index < chars.length
+        # Check for keypress (non-blocking)
+        # rubocop:disable Lint/IncompatibleIoSelectWithFiberScheduler
+        if IO.select([io], nil, nil, 0)
+          # rubocop:enable Lint/IncompatibleIoSelectWithFiberScheduler
+          pressed = io.getc
+          if key_matches?(pressed, interrupt_config)
+            # Print remaining text immediately
+            print chars[index..].join
+            break
+          end
+        end
+
+        print chars[index]
+        sleep(punc_rate) if PUNCTUATION.include?(chars[index])
+        sleep(type_rate)
+        index += 1
+      end
+    end
+
+    print "\n" if line_break
+  end
+
+  # Checks if a pressed key matches the interrupt configuration
+  #
+  # @param char [String] the pressed character
+  # @param config [Boolean, Symbol, Array] interrupt configuration
+  # @return [Boolean] true if the key should trigger an interrupt
+  private_class_method def self.key_matches?(char, config)
+    case config
+    when true, :enter then ["\r", "\n"].include?(char)
+    when :any then true
+    when Array then config.include?(char)
+    else false
+    end
+  end
 end

data/typewrite.gemspec

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require_relative "lib/typewrite/version"
+
+Gem::Specification.new do |spec|
+  spec.name        = "typewrite"
+  spec.version     = Typewrite::VERSION
+  spec.authors     = ["Cory Davis"]
+  spec.email       = ["CSDavisMusic@gmail.com"]
+
+  spec.summary     = "Typewriter effect for console output"
+  spec.description = "A simple gem to add a typewriter effect to console output."
+  spec.homepage    = "https://github.com/CJGlitter/typewrite"
+  spec.license     = "MIT"
+
+  spec.required_ruby_version = ">= 3.0.0"
+
+  spec.metadata = {
+    "homepage_uri" => spec.homepage,
+    "source_code_uri" => spec.homepage,
+    "changelog_uri" => "#{spec.homepage}/blob/main/CHANGELOG.md",
+    "bug_tracker_uri" => "#{spec.homepage}/issues",
+    "rubygems_mfa_required" => "true"
+  }
+
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      f.match(%r{\A(?:test|spec|features)/})
+    end
+  end
+  spec.require_paths = ["lib"]
+end

metadata

@@ -1,28 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: typewrite
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Cory Davis
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-03 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies: []
 description: A simple gem to add a typewriter effect to console output.
-email: CSDavisMusic@gmail.com
+email:
+- CSDavisMusic@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
 - lib/typewrite.rb
-homepage: https://rubygems.org/gems/typewrite
+- lib/typewrite/version.rb
+- typewrite.gemspec
+homepage: https://github.com/CJGlitter/typewrite
 licenses:
 - MIT
 metadata:
+  homepage_uri: https://github.com/CJGlitter/typewrite
   source_code_uri: https://github.com/CJGlitter/typewrite
-post_install_message:
+  changelog_uri: https://github.com/CJGlitter/typewrite/blob/main/CHANGELOG.md
+  bug_tracker_uri: https://github.com/CJGlitter/typewrite/issues
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -30,15 +43,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
-summary: Typewriter Effect!
+summary: Typewriter effect for console output
 test_files: []