gamefic-tty 2.0.3 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b2a931bad1826a68d5ea3c05cb14bc94c09ca413b78b5f1cec1828701378b21
-  data.tar.gz: ef18db71f5cf27a8b4ed5bb8fdbd0f915908778e1ffc09a26100ed30d1a62223
+  metadata.gz: 7727ff76e6d99f185d104a500d1da91868062c852ae8fc340026ac0829b5d4a9
+  data.tar.gz: 718beb405d92d0b45bf551f3dca48ae54538c35afa2873e97fda9c559a4909e0
 SHA512:
-  metadata.gz: b9ba54220845810c548151bf7ef97e49998ba659bb3dede18acce84d80d65ef35dd5569b2fc7641e6162eeb1b335d9f0f246c27982f9049bfb5d1b0c2b874af8
-  data.tar.gz: b3b49ef2cdee7e17f073de39315cc4f36204078c479dae64fa4654040fbd63c35e854b62e2faffc4b43bc160c70e30f7cef883eb2f2fb74f338907e2f6c31fee
+  metadata.gz: 55ecfab661beff414d0bf7a06178ef23802206e03b0cf85fc2fb109342d4a6c45ea674807a5e912422fe9e9b412bcd5ab54081b6b49b114f3867bc0574588206
+  data.tar.gz: bae7168adddd34eb26291aeb1f64ec450ca5be09007c57ec1c3e6d08243874e7101bc3d645c079a4607a2c1e777711635040be5159d70497475f330f433f322a

data/.github/workflows/rspec.yml

@@ -0,0 +1,37 @@
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+# This workflow will download a prebuilt Ruby version, install dependencies and run tests with rspec.
+# For more information see: https://github.com/marketplace/actions/setup-ruby-jruby-and-truffleruby
+
+name: RSpec
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.7', '3.0', '3.1']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: false
+    - name: Install dependencies
+      run: bundle install
+    - name: Run Ruby tests
+      run: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,6 @@
+## 3.0.0 - January 27, 2024
+- Updates for Gamefic 3.0
+
 ## 2.0.3 - December 26, 2022
 - Dependency update
 

data/README.md

@@ -1,55 +1,55 @@
-# Gamefic TTY
-
-A Gamefic engine for games that run on IO.
-
-**Features:**
-
-* Works with the `gamefic-standard` library
-* Converts Gamefic's default HTML output to ANSI text
-
-**Common uses:**
-
-* Run a game on the command line.
-* Attach IO streams to run the game over other processes.
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'gamefic-tty'
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install gamefic-tty
-
-## Usage
-
-The easiest way to get started with Gamefic TTY is with the Gamefic SDK. See the [SDK README](https://github.com/castwide/gamefic-sdk) for more information.
-
-An example script that runs a game on the command line:
-
-```ruby
-require 'gamefic-tty'
-
-Gamefic.script do
-  introduction do |actor|
-    actor.tell "Hello, world!"
-  end
-end
-
-Gamefic::Tty::Engine.run
-```
-
-## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-tty.
-
-## License
-
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+# Gamefic TTY
+
+A Gamefic engine for games that run on IO.
+
+**Features:**
+
+* Works with the `gamefic-standard` library
+* Converts Gamefic's default HTML output to ANSI text
+
+**Common uses:**
+
+* Run a game on the command line.
+* Attach IO streams to run the game over other processes.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'gamefic-tty'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gamefic-tty
+
+## Usage
+
+The easiest way to get started with Gamefic TTY is with the Gamefic SDK. See the [SDK README](https://github.com/castwide/gamefic-sdk) for more information.
+
+An example script that runs a game on the command line:
+
+```ruby
+require 'gamefic-tty'
+
+class Example < Gamefic::Plot
+  introduction do |actor|
+    actor.tell "Hello, world!"
+  end
+end
+
+Gamefic::Tty::Engine.run(plot: Example.new)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/castwide/gamefic-tty.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/gamefic-tty.gemspec

@@ -1,47 +1,46 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "gamefic-tty/version"
-
-Gem::Specification.new do |spec|
-  spec.name          = "gamefic-tty"
-  spec.version       = Gamefic::Tty::VERSION
-  spec.authors       = ["Fred Snyder"]
-  spec.email         = ["fsnyder@castwide.com"]
-
-  spec.summary       = %q{Gamefic TTY engine}
-  spec.description   = %q{Components for running Gamefic om a terminal}
-  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
-  spec.license       = "MIT"
-
-  # 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"] = "TODO: Set to 'http://mygemserver.com'"
-
-  #   spec.metadata["homepage_uri"] = spec.homepage
-  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
-  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
-  # else
-  #   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.bindir        = "exe"
-  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ['lib']
-
-  spec.add_runtime_dependency 'gamefic', '~> 2.0'
-  spec.add_runtime_dependency 'html_to_ansi', '~> 0.1.0'
-
-  spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rexml', '~> 3.2'
-  spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_development_dependency 'simplecov', '~> 0.14'
-end
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "gamefic-tty/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "gamefic-tty"
+  spec.version       = Gamefic::Tty::VERSION
+  spec.authors       = ["Fred Snyder"]
+  spec.email         = ["fsnyder@castwide.com"]
+
+  spec.summary       = %q{Gamefic TTY engine}
+  spec.description   = %q{Components for running Gamefic om a terminal}
+  # spec.homepage      = "TODO: Put your gem's website or public repo URL here."
+  spec.license       = "MIT"
+
+  # 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"] = "TODO: Set to 'http://mygemserver.com'"
+
+  #   spec.metadata["homepage_uri"] = spec.homepage
+  #   spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  #   spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  # else
+  #   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.bindir        = "exe"
+  # spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'gamefic', '~> 3.0'
+  spec.add_runtime_dependency 'html_to_ansi', '~> 0.2.0'
+
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'simplecov', '~> 0.14'
+end

data/lib/gamefic-tty/engine.rb

@@ -1,29 +1,46 @@
 module Gamefic
   module Tty
+    # A simple engine for running turn-based, single-character Gamefic plots.
+    #
     class Engine
+      # @return [Plot]
       attr_reader :plot
+
+      # @return [User]
       attr_reader :user
+
+      # @return [Character]
       attr_reader :character
 
+      # @param plot [Plot]
+      # @param user [User]
       def initialize(plot: Gamefic::Plot.new, user: Gamefic::Tty::User.new)
         @plot = plot
         @user = user
-        @character = @plot.get_player_character
-        @plot.introduce @character
+        @character = @plot.introduce
         @plot.ready
       end
 
+      # Run the plot to its conclusion.
+      #
       def run
-        turn until @character.concluded?
+        turn until @plot.concluding?
         @user.update @character.output
       end
 
-      def self.run **args
-        engine = new(**args)
+      # Create an engine and run the plot.
+      #
+      # @param plot [Plot]
+      # @param user [User]
+      # @return [Engine]
+      def self.run(plot: Gamefic::Plot.new, user: Gamefic::Tty::User.new)
+        engine = new(plot: plot, user: user)
         engine.run
         engine
       end
 
+      # Run a single turn.
+      #
       def turn
         send_and_receive
         @plot.update
@@ -34,14 +51,9 @@ module Gamefic
 
       def send_and_receive
         @user.update @character.output
-        until @character.queue.empty? || @character.concluded?
-          @plot.update
-          @plot.ready
-          @user.update @character.output
-        end
-        return if @character.concluded?
-        input = @user.query("#{@character.output[:prompt]} ")
-        @character.queue.push input unless input.nil?
+        return unless @character.queue.empty?
+
+        @character.queue.push @user.query("#{@character.output[:prompt]} ")
       end
     end
   end

data/lib/gamefic-tty/user.rb

@@ -3,8 +3,13 @@ require 'html_to_ansi'
 
 module Gamefic
   module Tty
+    # An interface for passing IO between an engine and a client.
+    #
     class User
+      # @return [IO]
       attr_reader :input
+
+      # @return [IO]
       attr_reader :output
 
       # @param input [IO] The stream that receives input

data/lib/gamefic-tty/version.rb

@@ -1,5 +1,5 @@
 module Gamefic
   module Tty
-    VERSION = '2.0.3'.freeze
+    VERSION = '3.0.0'.freeze
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gamefic-tty
 version: !ruby/object:Gem::Version
-  version: 2.0.3
+  version: 3.0.0
 platform: ruby
 authors:
 - Fred Snyder
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-12-26 00:00:00.000000000 Z
+date: 2024-01-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gamefic
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
   name: html_to_ansi
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.0
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -66,20 +66,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
-- !ruby/object:Gem::Dependency
-  name: rexml
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +101,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/rspec.yml"
 - ".gitignore"
 - ".rspec"
 - ".travis.yml"