pity 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31855341d9385c227f53a75e464e54997ed5a6007bdce26751a5f95f1553e358
+  data.tar.gz: 2b7764c620016208543810afe1c64f9eb450af94b21b9642029fbce6e5858e89
+SHA512:
+  metadata.gz: 88526af673a2229fb4553821a650f06805a3a683478a1d81adcad9df6327dd57e731b1311a741f32b51d86441d93a13900ea61ed086565244454749d56822f78
+  data.tar.gz: d1ac3045660039003b1966bc3d7037279ded40cca9e70eb533d10c89c8961bc5a5918810086190a20e6b653d6cdb85596602e3487e37f19fc8716044bbb72891

data/.rspec

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

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2025 Brad Gessler
+
+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,49 @@
+# Pity
+
+Pity is a gem that helps test command-line interfaces, terminal apps, REPLs, or whatever you want to call them. It uses the `PTY` gem and `IO#select` to interact with the gem and a core DSL that looks like this:
+
+```ruby
+REPL.new do |it|
+  it.puts "ls"
+  it.gets
+
+  it.puts "trmnl login"
+  it.expect "Email: "
+  it.puts "nobody@example.com"
+
+  it.expect "Password: "
+  it.puts "superdude"
+  it.gets
+end
+```
+
+## Installation
+
+
+```bash
+bundle add pity
+```
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+```bash
+gem install pity
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/terminalwire/pity. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/terminalwire/pity/blob/main/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Pity project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/terminalwire/pity/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/lib/pity/version.rb

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

data/lib/pity.rb

@@ -0,0 +1,106 @@
+# frozen_string_literal: true
+
+require_relative "pity/version"
+require 'pty'
+require 'io/console'
+require 'logger'
+
+module Pity
+  class Error < StandardError; end
+
+  class REPL
+    attr_reader :stdout, :stdin, :logger
+
+    # Number of bytes to read at a time.
+    READ_CHUNK_SIZE = 512
+
+    # Seconds to wait in IO.select before retrying.
+    SELECT_TIMEOUT = 0.01
+
+    # How long to wait before giving up on a read.
+    TIMEOUT = 5
+
+    # How long to wait before giving up on a prompt capture.
+    PROMPT_CAPTURE_TIMEOUT = 1
+
+    def initialize(command = "bash", prompt: nil, logger: self.class.logger)
+      @logger = logger
+      @stdout, @stdin, @pid = PTY.spawn(command)
+      @stdout.sync = true
+      @stdin.sync = true
+      logger.debug "Spawned process with PID #{@pid} using command: #{command}"
+
+      captured = prompt || capture_initial_prompt
+      @prompt = Regexp.new(Regexp.escape(captured) + '\z')
+      logger.debug "Captured prompt: #{captured.inspect}"
+
+      begin
+        yield self
+      ensure
+        cleanup
+      end
+    end
+
+    def puts(input)
+      @stdin.puts(input)
+      logger.debug "Sent: #{input}"
+    end
+
+    def gets(**)
+      expect(@prompt, **)
+    end
+
+    def expect(expectation, **)
+      read_until(**) { |buf| buf.match(expectation) }
+    end
+
+    private
+
+    def read_until(timeout: TIMEOUT)
+      buffer = +""
+      start_time = Time.now
+
+      loop do
+        break if (Time.now - start_time) > timeout
+        begin
+          char = @stdout.read_nonblock(READ_CHUNK_SIZE)
+          buffer << char
+          break if yield(buffer)
+        rescue IO::WaitReadable
+          IO.select([@stdout], nil, nil, SELECT_TIMEOUT) and retry
+        rescue EOFError
+          break
+        end
+      end
+
+      logger.info buffer
+      logger.debug "Read: #{buffer.inspect}"
+      buffer
+    end
+
+    def capture_initial_prompt(timeout: PROMPT_CAPTURE_TIMEOUT, **)
+      read_until(timeout:, **) { |buf| buf.include?("\n") }.chomp
+    end
+
+    def cleanup
+      Process.kill('TERM', @pid)
+      logger.debug "Terminated process with PID #{@pid}"
+    rescue Errno::ESRCH
+      logger.debug "Process #{@pid} was already terminated."
+    end
+
+    def self.logger
+      Logger.new(STDOUT).tap do |log|
+        log.level = Logger::INFO
+        log.formatter = proc do |severity, _datetime, _progname, msg|
+          case severity
+          when "INFO"
+            msg
+          else
+            "#{msg}\n"
+          end
+        end
+      end
+    end
+  end
+end

data/sig/pity.rbs

@@ -0,0 +1,4 @@
+module Pity
+  VERSION: String
+  # See the writing guide of rbs: https://github.com/ruby/rbs#guides
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: pity
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brad Gessler
+bindir: exe
+cert_chain: []
+date: 2025-02-24 00:00:00.000000000 Z
+dependencies: []
+description: Test command-line interfaces by simulating user input and capturing output
+  via Ruby's PTY library.
+email:
+- brad@terminalwire.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/pity.rb
+- lib/pity/version.rb
+- sig/pity.rbs
+homepage: https://github.com/terminalwire/pity
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/terminalwire/pity
+  source_code_uri: https://github.com/terminalwire/pity
+  changelog_uri: https://github.com/terminalwire/pity
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.1.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.2
+specification_version: 4
+summary: A library for testing interactive command-line interfaces.
+test_files: []