gamefic-tty 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: e51cc73835e18a0910192ab0bcbf4e63ba0430018d7cfa73038acd7d1ab379c8
+  data.tar.gz: f85f4950731e1b5f04df53c4d566d0b8c88d6ed173e13b74adb36262c747913e
+SHA512:
+  metadata.gz: 7b79e9be2c5060ee9c6300f8c4fb41be29bc92f3753472885d76a39cb425a6305734ff8c6054b2c62bf0299065fa9c7ab7dbc49b5868fb4d922c7ff5e144399d
+  data.tar.gz: cb0cb202fcc7598ef0af0ddd2fe10485dd8178d5701ff4908745240f54318e9c9cd8e76310d24de4ba99bfd0df534d3360061e704917b67f946b48e55ffa9a56

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+Gemfile.lock

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 2.0.1

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in gamefic-tty.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Fred Snyder
+
+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,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).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "gamefic/tty"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/gamefic-tty.gemspec

@@ -0,0 +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 "rspec", "~> 3.0"
+  spec.add_development_dependency "simplecov", "~> 0.14"
+end

data/lib/gamefic-tty.rb

@@ -0,0 +1,5 @@
+require 'gamefic'
+require 'gamefic-tty/version'
+require 'gamefic-tty/text'
+require 'gamefic-tty/engine'
+require 'gamefic-tty/user'

data/lib/gamefic-tty/engine.rb

@@ -0,0 +1,43 @@
+module Gamefic
+  module Tty
+    class Engine
+      attr_reader :plot
+      attr_reader :user
+      attr_reader :character
+
+      def initialize(plot: Gamefic::Plot.new, user: Gamefic::Tty::User.new)
+        @plot = plot
+        @user = user
+        @character = @plot.get_player_character
+        @plot.introduce @character
+        @plot.ready
+      end
+
+      def run
+        turn until @character.concluded?
+        @user.update @character.output
+      end
+
+      def self.run **args
+        engine = new(**args)
+        engine.run
+        engine
+      end
+
+      def turn
+        send_and_receive
+        @plot.update
+        @plot.ready
+      end
+
+      private
+
+      def send_and_receive
+        @user.update @character.state
+        return if @character.concluded?
+        input = @user.query("#{@character.state[:prompt]} ")
+        @character.queue.push input unless input.nil?
+      end
+    end
+  end
+end

data/lib/gamefic-tty/text.rb

@@ -0,0 +1,8 @@
+module Gamefic
+  module Tty
+    module Text
+      autoload :Ansi, 'gamefic-tty/text/ansi'
+      autoload :Html, 'gamefic-tty/text/html'
+    end
+  end
+end

data/lib/gamefic-tty/user.rb

@@ -0,0 +1,61 @@
+require 'json'
+require 'html_to_ansi'
+
+module Gamefic
+  module Tty
+    class User
+      attr_reader :input
+      attr_reader :output
+
+      # @param input [IO] The stream that receives input
+      # @param output [IO] The stream that sends output
+      def initialize input: STDIN, output: STDOUT
+        @input = input
+        @output = output
+      end
+
+      # Update the user with a hash of data representing the current game state.
+      #
+      # @param data [Hash]
+      # @return [void]
+      def update state
+        @output.write state_to_text(state)
+      end
+
+      def state_to_text state
+        output = state[:messages].to_s
+        unless state[:options].nil?
+          list = '<ol class="multiple_choice">'
+          state[:options].each { |o|
+            list += "<li><a href=\"#\" rel=\"gamefic\" data-command=\"#{o}\">#{o}</a></li>"
+          }
+          list += "</ol>"
+          output += list
+        end
+        HtmlToAnsi.convert output
+      end
+
+      # Get input from the user.
+      #
+      # @return [String, nil]
+      def query prompt = '> '
+        @output.print prompt
+        @input.gets
+      end
+
+      # @todo Save and restore aren't ready yet
+
+      # def save filename, snapshot
+      #   File.open(filename, 'w') do |file|
+      #     file << snapshot.to_json
+      #   end
+      # end
+
+      # def restore filename
+      #   json = File.read(filename)
+      #   snapshot = JSON.parse(json, symbolize_names: true)
+      #   engine.restore snapshot
+      # end
+    end
+  end
+end

data/lib/gamefic-tty/version.rb

@@ -0,0 +1,5 @@
+module Gamefic
+  module Tty
+    VERSION = '2.0.0'
+  end
+end

metadata

@@ -0,0 +1,142 @@
+--- !ruby/object:Gem::Specification
+name: gamefic-tty
+version: !ruby/object:Gem::Version
+  version: 2.0.0
+platform: ruby
+authors:
+- Fred Snyder
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-24 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: gamefic
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: html_to_ansi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.14'
+description: Components for running Gamefic om a terminal
+email:
+- fsnyder@castwide.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- gamefic-tty.gemspec
+- lib/gamefic-tty.rb
+- lib/gamefic-tty/engine.rb
+- lib/gamefic-tty/text.rb
+- lib/gamefic-tty/user.rb
+- lib/gamefic-tty/version.rb
+homepage: 
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Gamefic TTY engine
+test_files: []