t-bag 0.0.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cf302fa7c2f18d90737044c46ba9ec78e06fd45d
+  data.tar.gz: eb61e19872f242cd77f6a0043c252ff4ddde4e1d
+SHA512:
+  metadata.gz: de4cd7eb3eda6c6d8eeeda67b219b428d00169957fd849dbfb4217bc097486056565b41fb9efef113d8f52cad1414da4ca163147fca9d1ece96e4a3a62687dfc
+  data.tar.gz: 8586e0060c3fc2a5f3eebda88dc9c3987aaa21806d7b0e8252531c3efa84bea507e6775234cfef95deac16e16975286c5926b660b852bcf9d2e239aa8391db9f

data/examples/sample.rb

@@ -0,0 +1,71 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+require_relative '../lib/tbag'
+include T_BAG
+
+game 'Zork', 'Infocom' do
+  start :scene1
+  scene :scene1, 'West of House' do
+    text 'You are standing in an open field west of a white house, with a boarded front door.'
+    pause
+    text 'There is a small mailbox here.'
+    pause
+    prompt 'What would you like to do?', String, 'I don\'t know that word.' do
+      choice 'open' do
+        puts 'The door cannot be opened.'
+      end
+      choice 'open mailbox' do
+        puts 'Opening the small mailbox reveals a leaflet.'
+      end
+    end
+    prompt 'What would you like to do?', String, 'I don\'t know that word.' do
+      choice 'read leaflet' do
+        scene_change :scene2
+      end
+    end
+  end
+  scene :scene2, 'WELCOME TO ZORK!' do
+    text 'WELCOME TO ZORK!'
+    pause
+    text 'ZORK is a game of adventure, danger, and low cunning.'
+    text 'In it you will explore some of the most amazing territory ever seen by mortals.'
+    text 'No computer should be without one!'
+    pause
+    scene_change :endgame
+  end
+  game_over do
+    text 'You were eaten by a grue.'
+    pause
+    prompt 'Would you like to start over?', String, 'I\'m afraid I don\'t like that answer...' do
+      choice 'yes' do
+        $game.reset
+      end
+      choice 'no' do
+        $game.quit
+      end
+    end
+  end
+end
+
+run

data/lib/tbag.rb

@@ -0,0 +1,53 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+require_relative 'tbag/game'
+require_relative 'tbag/prompt'
+require_relative 'tbag/scene'
+require_relative 'tbag/game_over'
+require_relative 'tbag/main_menu'
+
+require 'docile'
+
+# A framework for writing text-based adventure games.
+# @author Benjamin S. Meyers
+module T_BAG
+  # The version number.
+  VERSION = '0.0.4'
+
+  # @param [String] title the game title
+  # @param [String] author the game author
+  # @param [Block] block
+  def game(title, author, &block)
+    $game = T_BAG::Game.new(title, author)
+
+    Docile.dsl_eval($game, &block)
+  end
+
+  # Run the game.
+  # @return [Void]
+  def run
+    $game.run
+  end
+end

data/lib/tbag/game.rb

@@ -0,0 +1,175 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+require_relative '../tbag'
+
+require 'docile'
+
+module T_BAG
+  # Defines a game and its run behavior.
+  class Game
+    # @param [String] title the game title
+    # @param [String] author the game author
+    def initialize(title, author)
+      @title = title
+      @author = author
+      @scenes = {}
+      @current_scene = nil
+      @start_scene = nil
+      @next_scene = nil
+      @menu_scene = nil
+      @called = false
+    end
+
+    # Add a scene to the scene queue.
+    # @param [String] name the name of the scene
+    # @param [String] title the title of the scene
+    # @param [Block] block
+    # @return [Void]
+    def scene(name, title, &block)
+      scene = T_BAG::Scene.new(name, title)
+      @scenes[name] = scene
+      Docile.dsl_eval(scene, &block)
+    end
+
+    # Add a game over scene to the scene queue.
+    # @param [Block] block
+    # @return [Void]
+    def game_over(&block)
+      game_over = T_BAG::Game_Over.new
+      @scenes[:endgame] = game_over
+      Docile.dsl_eval(game_over, &block)
+    end
+
+    # Add a main menu scene to the scene queue.
+    # @param [Block] block
+    # @return [Void]
+    def main_menu(&block)
+      main_menu = T_BAG::Main_Menu.new
+      @scenes[:menu] = main_menu
+      Docile.dsl_eval(main_menu, &block)
+    end
+
+    # Save the given scene as the starting scene and start the scene.
+    # @param [Symbol] scene a scene
+    # @return [Void]
+    def start(scene)
+      if @called == false
+        @current_scene = scene
+        @start_scene = scene
+        @called = true
+      else
+        @start_scene = scene
+      end
+    end
+
+    # Save the given scene as the menu scene.
+    # @param [Symbol] scene a scene
+    # @return [Void]
+    def menu(scene)
+      @menu_scene = scene
+    end
+
+    # Run the scenes in chronological order until it finds a nil scene.
+    # @return [Void]
+    def run
+      until @current_scene.nil?
+        scene = @scenes[@current_scene]
+        if scene.nil?
+          $stderr.puts "[GAME] Scene '#{@current_scene}' does not exist"
+        end
+        scene.run
+        @current_scene = @next_scene
+      end
+    end
+
+    # Set the given scene to the next scene in the game.
+    # @param [Symbol] scene a scene
+    # @return [Void]
+    def next_scene(scene)
+      @next_scene = scene
+    end
+
+    # Reset the game by going back to the starting scene.
+    # @return [Void]
+    def reset
+      @next_scene = @start_scene
+    end
+
+    # Reset the game by going back to the menu scene.
+    # @return [Void]
+    def tomenu
+      @next_scene = @menu_scene
+    end
+
+    # Quit the game.
+    # @return [Void]
+    def quit
+      puts 'Goodbye!'
+      exit
+    end
+
+    # Save the current game state as outfile.
+    # @param [String] outfile the name of the file to save to
+    # @return [Void]
+    def save_game(outfile)
+      begin
+      if File.exist? outfile
+        out_file = File.open(outfile, 'r+')
+        out_file.puts @current_scene
+        out_file.close
+        puts 'Save Successful!'
+      else
+        out_file = File.new(outfile, 'w')
+        puts 'Created New Save File...'
+        out_file.puts @current_scene
+        out_file.close
+        puts 'Save Successful!'
+      end
+      rescue Exception => ex
+        puts 'Save Failed!'
+      end
+    end
+
+    # Load a game state from infile.
+    # @param [String] infile the name of the file to load from
+    # @return [Void]
+    def load_game(infile)
+      begin
+        if File.exist? infile
+          in_file = File.open(infile, 'r+')
+          state = in_file.gets.chomp.intern
+          #print state
+          next_scene state
+          puts 'Load Successful!'
+        else
+          puts 'File ' + String(infile) + ' not found.'
+          reset
+        end
+      rescue
+        puts 'Load Failed!'
+      end
+    end
+  end
+end

data/lib/tbag/game_over.rb

@@ -0,0 +1,43 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+require_relative '../tbag'
+
+require 'docile'
+
+module T_BAG
+  # Defines a special Game Over scene and its run behavior.
+  class Game_Over < T_BAG::Scene
+    # Returns an instance of a special Game Over scene.
+    def initialize
+      super(:endgame, 'Game Over')
+    end
+
+    # Run with the same behavior as a scene.
+    # @return [Void]
+    def run
+      super
+    end
+  end
+end

data/lib/tbag/main_menu.rb

@@ -0,0 +1,42 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+require_relative '../tbag'
+
+require 'docile'
+
+module T_BAG
+  # Defines a special Main Menu scene and its run behavior.
+  class Main_Menu < T_BAG::Scene
+    # Returns an instance of a special Main Menu scene.
+    def initialize
+      super(:menu, 'Main Menu')
+    end
+
+    # Run with the same behavior as a scene.
+    def run
+      super
+    end
+  end
+end

data/lib/tbag/prompt.rb

@@ -0,0 +1,79 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+require_relative '../tbag'
+
+require 'docile'
+
+module T_BAG
+  # Defines a prompt and its run behavior.
+  class Prompt
+    # @param [String] question the prompt for the User
+    # @param [ANY] type the type of the expected User input
+    # @param [String] error the error to display if User input is invalid
+    def initialize(question, type, error)
+      @question = question
+      @type = type
+      @choices = {}
+      @error = error
+    end
+
+    # Capture the User's answer to a prompt
+    # @param [String] value the User input
+    # @param [Block] block
+    def choice(value, &block)
+      if value.is_a? String
+        value.downcase!
+      end
+      @choices[value] = Proc.new &block
+    end
+
+    # Define how to interpret prompt input.
+    def run
+      puts @question
+      done = false
+      until done
+        answer = gets.strip
+
+        if @type == Integer
+          unless answer.to_i == 0
+            answer = answer.to_i
+          end
+        elsif @type == String
+          answer.downcase!
+        end
+        if answer.is_a? @type and (@choices[answer] or @choices[:any])
+          if @choices[answer]
+            @choices[answer].call(answer)
+          else
+            @choices[:any].call(answer)
+          end
+          done = true
+        else
+          puts @error
+        end
+      end
+    end
+  end
+end

data/lib/tbag/scene.rb

@@ -0,0 +1,114 @@
+=begin
+The MIT License (MIT)
+
+Copyright (c) 2015 Benjamin Meyers as Lion Logic <lion.logic.org@gmail.com>
+
+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.
+=end
+
+module T_BAG
+  # Defines a scene and its run behavior.
+  class Scene
+    # @param [String] name the name of the scene
+    # @param [String] title the title of the scene
+    def initialize(name, title)
+      @name = name
+      @title = title
+      @actions = []
+    end
+
+    # Add a pause to the action queue.
+    def pause
+      @actions << {type: :pause}
+    end
+
+    # Add a scene change to the action queue.
+    # @param [Symbol] scene a scene
+    def scene_change( scene )
+      @actions << {type: :scene_change, scene: scene}
+    end
+
+    # Add a set of text to the action queue.
+    # @param [String] dialog the text to be output to the User
+    def text(dialog)
+      @actions << {type: :text, dialog: dialog}
+    end
+
+    # Add a prompt to the action queue.
+    # @param [String] question the prompt for the User
+    # @param [ANY] type the type of the expected User input
+    # @param [String] error the error to display if User input is invalid
+    # @param [Block] block
+    def prompt(question, type, error, &block)
+      prompt = T_BAG::Prompt.new(question, type, error)
+      @actions << {type: :prompt, prompt: prompt}
+      Docile.dsl_eval(prompt, &block)
+    end
+
+    # Add a save to the action queue.
+    # @param [String] outfile the name of the file to save to
+    def save_game(outfile)
+      @actions << {type: :save, filename: outfile}
+    end
+
+    # Add a load to the action queue.
+    # @param [String] infile the name of the file to load from
+    def load_game(infile)
+      @actions << {type: :load, filename: infile}
+    end
+
+    # Create a scene change for the game over scene.
+    def game_over
+      scene_change :endgame
+    end
+
+    # Create a scene change for the main menu scene.
+    def main_menu
+      scene_change :menu
+    end
+
+    # Define how a scene runs.
+    def run
+      @actions.each do |a|
+        case a[:type]
+          when :pause
+            print 'Continue...'
+            gets
+            puts
+          when :scene_change
+            $game.next_scene a[:scene]
+          when :text
+            a[:dialog].bytes.each do |c|
+              putc c
+              sleep(0.05)
+            end
+            putc "\n"
+          when :prompt
+            a[:prompt].run
+          when :save
+            $game.save_game a[:filename]
+          when :load
+            $game.load_game a[:filename]
+          else
+            $stderr.puts '[SCENE] Action not allowed'
+        end
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: t-bag
+version: !ruby/object:Gem::Version
+  version: 0.0.4
+platform: ruby
+authors:
+- Benjamin S. Meyers
+- Bryan T. Meyers
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: docile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.1.5
+description: A framework for implementing domain-specific languages for text-based
+  adventure games.
+email:
+- lion.logic.org@gmail.com
+- bmeyers@datadrake.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- examples/sample.rb
+- lib/tbag.rb
+- lib/tbag/game.rb
+- lib/tbag/game_over.rb
+- lib/tbag/main_menu.rb
+- lib/tbag/prompt.rb
+- lib/tbag/scene.rb
+homepage: https://github.com/meyersbs/t-bag
+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: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Text-Based Adventure Game Framework
+test_files: []
+has_rdoc: