twisty 0.0.2b

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 973c95d14cceffd3e604a89a4d3e13aa78668c79
+  data.tar.gz: 2890e7f27a04df943e73b0052b4bafeae65ef3a7
+SHA512:
+  metadata.gz: fcfbb0a47cc2baf7acb9e6c78999a96ed4e0b5ed50d0684ba0786faba2e7d529bbd500501db262eac72533483951c66be4c69593b67639669f5d553758f9f1ff
+  data.tar.gz: 91cef32321c07af3e9c27f0d6a31f625703de54ca1a8a4b706ff0a0e443a29a9619dd2b96c96533461d82aa3fc6bb049c8aea456bf6934fb6f330e1616fbfebd

data/lib/twisty/command.rb

@@ -0,0 +1,24 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require 'rtype'
+
+module Twisty
+
+class Command
+	rtype_accessor :help1, :help2, String
+	rtype_accessor :func, Proc
+	def initialize(help1, help2, func)
+		@help1 = help1
+		@help2 = help2
+		@func = func
+	end
+end
+
+end

data/lib/twisty/engine.rb

@@ -0,0 +1,359 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require 'singleton'
+require 'rtype'
+
+require_relative 'error.rb'
+require_relative 'command.rb'
+require_relative 'item.rb'
+require_relative 'room.rb'
+
+module Twisty
+
+class Engine
+	include Singleton
+
+	attr_reader :items, :rooms, :inventory
+
+	def initialize
+		@items = {}
+		@rooms = {}
+
+		@current_room = nil
+		@inventory = []
+
+		@playing = nil
+
+		@commands = {} #Filled in lib/twisty.rb
+	end
+
+	################################
+	#   Game definition commands   #
+	################################
+
+	# TODO: Make private "defining" method
+
+	rtype [Symbol, String, String, Hash] => nil
+	def define_item(id, name, desc, options={})
+		options = {fixed: false, storage: 0}.merge(options)
+
+		fixed = options[:fixed] || false
+		storage = options[:storage] || 0
+
+		if @items[id] == nil
+			@items[id] = Twisty::Item.new(id, name, desc, fixed, storage)
+		else
+			raise GameError.new "Item #{id} has already been defined"
+		end
+
+		return nil
+	end
+
+	rtype [Symbol, String, String] => nil
+	def define_room(id, name, desc)
+		room = Twisty::Room.new(id, name, desc)
+
+		if @rooms[id] == nil
+			@rooms[id] = room
+		else
+			raise GameError.new "Room #{id} has already been defined"
+		end
+
+		#First defined room is default starting point
+		if @rooms.size == 1
+			@current_room = id
+		end
+
+		return nil
+	end
+
+	rtype [Symbol, Symbol, String] => nil
+	def add_door(from, to, name)
+		if @rooms.has_key?(from)
+			if @rooms.has_key?(to)
+				@rooms[from].add_door(to, name)
+			else
+				raise GameError.new "Invalid room name: #{to}"
+			end
+		else
+			raise GameError.new "Invalid room name: #{from}"
+		end
+
+		return nil
+	end
+
+	rtype [Symbol] => nil
+	def current_room=(id)
+		if @rooms.has_key? id
+			@current_room = id
+		else
+			raise GameError.new "Room #{id} has not been defined"
+		end
+
+		return nil
+	end
+
+	rtype [] => nil
+	def give(id)
+		if @items.include? id
+			@inventory << id
+		else
+			raise GameError.new "Invalid item: #{id}"
+		end
+
+		return nil
+	end
+
+	rtype [Regexp, String, String, Proc] => nil
+	def define_command(pattern, help1, help2, &func)
+		@commands[pattern] = Command.new(help1, help2, func)
+		return nil
+	end
+
+	#########################
+	#   Utility functions   #
+	#########################
+
+	rtype [] => Room
+	def current_room
+		@rooms[@current_room]
+	end
+
+	rtype [] => Hash.of(Symbol, String)
+	def current_doors
+		@rooms[@current_room].doors
+	end
+	
+	rtype [] => Array.of(Symbol)
+	def current_items
+		@rooms[@current_room].items
+	end
+
+	rtype [] => Array.of(Symbol)
+	def inventory
+		@inventory
+	end
+
+	##########################
+	#   Game play commands   #
+	##########################
+	rtype [String] => nil
+	def take_item_by_name(name)
+		current_items.each do |id|
+			if @items.has_key? id
+				if @items[id].name.downcase == name.downcase
+					take_item_by_id(id)
+					return nil
+				end
+			else
+				raise GameError.new "Invalid Item #{id} in #{@current_room}"
+			end
+		end
+
+		#Implicit error condition
+		raise PlayError.new "There is no #{name} here"
+		return nil
+	end
+
+	rtype [Symbol] => nil
+	def take_item_by_id(id)
+		if @items.has_key? id
+			if current_items.include? id
+				if @items[id].fixed
+					raise PlayError.new "You can not move that"
+				else
+					if @items[id].take_event
+						current_room.items.delete id
+						@inventory << id
+					end
+
+					return nil
+				end
+			else
+				raise GameError.new "There is no #{id} in #{@current_room}"
+			end
+		else
+			raise GameError.new "Invalid Item #{id} in #{@current_room}"
+		end
+
+		return nil
+	end
+
+	rtype [String, String] => nil
+	def take_from_by_name_name(item, container)
+		current_items.each do |id|
+			if @items[id].name.downcase == container
+				return take_from_by_name_id(item, id)
+			end
+		end
+
+		#Implicit error
+		raise PlayError.new "I can not see any #{container} here"
+		return nil
+	end
+
+	rtype [String, Symbol] => nil
+	def take_from_by_name_id(item, container)
+		@items[container].contents.each do |id|
+			if @items[id].name.downcase == item
+				if @items[id].take_event
+					@items[container].del_item id
+					@inventory << id
+				end
+
+				return nil
+			end
+		end
+
+		#Implicit Error
+		raise PlayError.new "I see no #{item} in the #{@items[container].name}"
+		return nil
+	end
+
+	rtype [String, String] => nil
+	def put_item_by_name_name(item, container)
+		@inventory.each do |id|
+			if @items[id].name.downcase == item
+				return put_item_by_id_name(id, container)
+			end
+		end
+
+		#Implicit Error
+		raise PlayError.new "You have no #{item}"
+		return nil
+	end
+
+	rtype [Symbol, String] => nil
+	def put_item_by_id_name(item, container)
+		current_items.each do |id|
+			if @items[id].name.downcase == container
+				if @items[id].storage == 0
+					raise PlayError.new "It won't fit in there"
+				end
+
+				if @items[item].drop_event
+					@items[id].add_item(item)
+					@inventory.delete item
+				end
+
+				return nil
+			end
+		end
+
+		#Implicit Error
+		raise PlayError.new "I see no #{item}"
+		return nil
+	end
+
+	rtype [String] => nil
+	def drop_item_by_name(name)
+		@inventory.each do |id|
+			if @items.has_key? id
+				if @items[id].name.downcase == name
+					drop_item_by_id(id)
+
+					return nil
+				end
+			else
+				raise GameError.new "Invalid Item: #{id}"
+			end
+		end
+
+		#Implicit error condition
+		raise PlayError.new "You are not carrying that"
+		return nil
+	end
+
+	rtype [Symbol] => nil
+	def drop_item_by_id(id)
+		if @items.has_key? id
+			if @items[id].drop_event
+				current_room.items << id
+				@inventory.delete id
+			end
+
+			return nil
+		else
+			raise GameError.new "Invalid item: #{id} in inventory"
+		end
+	end
+
+	rtype [Symbol] => nil
+	def goto(to)
+		if @rooms.has_key? to
+			if current_room.exit_event and @rooms[to].enter_event
+				@current_room = to
+			end
+			puts current_room.name
+		else
+			raise TwistyError.new "Room #{to} has not been defined"
+		end
+
+		return nil
+	end
+
+	#######################
+	#   Loop and Parser   #
+	#######################
+
+	rtype [] => nil
+	def start_loop
+		@playing = true
+
+		puts current_room.name
+		puts
+		current_room.look
+
+		while @playing == true
+			printf "> "
+			begin
+				line = gets
+				if line.class == NilClass
+					@playing = false
+					return nil
+				end
+				parse(line)
+			rescue PlayError => e
+				puts e.message
+			end
+		end
+
+		return nil
+	end
+
+	rtype [] => nil
+	def end_loop
+		@playing = false
+		return nil
+	end
+
+	rtype [] => nil
+	def parse(line)
+		#Strip double spaces and downcase
+		tokens = line.downcase.split
+		line = tokens.join(' ')
+
+		@commands.each do |pattern, command|
+			if line =~ pattern
+				#Execute as if a member function
+				instance_exec(tokens, &command.func)
+				return nil
+			end
+		end
+
+		#Implicit error
+		raise PlayError.new "I don't know how to #{line}"
+
+		#Never reached
+		return nil
+	end
+end
+
+end

data/lib/twisty/entity.rb

@@ -0,0 +1,34 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require 'rtype'
+
+module Twisty
+
+class Entity
+	attr_reader :id
+
+	rtype [Entity] => Boolean
+	def ==(other)
+		if other.class == self.class
+			return other.id == @id
+		elsif other.class == Symbol
+			return other == @id
+		else
+			return false
+		end
+	end
+
+	protected
+	def engine
+		return Engine.instance()
+	end
+end
+
+end

data/lib/twisty/error.rb

@@ -0,0 +1,25 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+module Twisty
+
+class TwistyError < RuntimeError
+	attr_reader :message
+
+	def initialize(s)
+		@message = s
+	end
+end
+
+class GameError < TwistyError
+end
+class PlayError < TwistyError
+end
+
+end

data/lib/twisty/item.rb

@@ -0,0 +1,99 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require_relative 'entity'
+
+require 'rtype'
+
+
+module Twisty
+
+class Item < Entity
+	attr_reader :name, :desc, :fixed, :storage, :contents
+
+	def initialize(id, name, desc, fixed, storage)
+		@id = id
+		@name = name
+		@desc = desc
+		@fixed = fixed
+		@storage = storage
+		@contents = []
+	end
+
+	rtype [] => Boolean
+	def take_event
+		return true
+	end
+
+	rtype [] => Boolean
+	def drop_event
+		return true
+	end
+
+	rtype [] => nil
+	def look
+		puts @desc
+
+		if @storage > 0
+			puts "Contents:"
+
+			if @contents.length == 0
+				puts "Nothing"
+			else
+				@contents.each{|id| puts engine.items[id].name}
+			end
+		end
+
+		return nil
+	end
+
+	rtype [Symbol] => Boolean
+	def contains_item?(item)
+		return @contents.include?(item) if @storage > 0
+		return false
+	end
+
+	rtype [Symbol] => nil
+	def add_item(item)
+		if @storage == 0
+			raise GameError.new "#{@id} is not a container"
+		else
+			#Skip if already contained
+			if contains_item?(item) == false
+				@contents << item
+			end
+		end
+
+		return nil
+	end
+
+	rtype [Symbol] => nil
+	def del_item(item)
+		#Skip if already contained
+		if contains_item?(item)
+			@contents.delete item
+		end
+
+		return nil
+	end
+
+	rtype [Proc] => nil
+	def on_take(&block)
+		self.define_singleton_method(:take_event, &block)
+		return nil
+	end
+
+	rtype [Proc] => nil
+	def on_drop(&block)
+		self.define_singleton_method(:drop_event, &block)
+		return nil
+	end
+end
+
+end

data/lib/twisty/room.rb

@@ -0,0 +1,106 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require_relative 'entity.rb'
+
+require 'rtype'
+
+module Twisty
+
+	class Room < Entity
+		attr_reader :name, :desc, :doors
+		attr_accessor :items
+
+		rtype [Symbol, String, String] => Array
+		def initialize(id, name, desc)
+			@id = id
+			@name = name
+			@desc = desc
+			@doors = {}
+			@items = []
+		end
+
+		rtype [] => Boolean
+		def enter_event
+			return true
+		end
+
+		rtype [] => Boolean
+		def exit_event
+			return true
+		end
+
+		rtype [Symbol, String] => nil
+		def add_door(to, name)
+			if name.split().length != 1
+				raise GameError.new "Door name must be one word"
+			elsif @doors.has_key? name
+				raise GameError.new "Door with name #{name} already exist in #{@id}"
+			else
+				@doors[to] = name
+			end
+
+			return nil
+		end
+
+		rtype [Symbol] => Array.of(Symbol)
+		def add_item(id)
+			if @items.include? id
+				raise GameError.new "Duplicate item in room #{@id}"
+			else
+				@items << id
+			end
+		end
+
+		rtype [Proc] => nil
+		def on_enter(&block)
+			self.define_singleton_method(:enter_event, &block)
+			return nil
+		end
+
+		rtype [Proc] => nil
+		def on_exit(&block)
+			self.define_singleton_method(:exit_event, &block)
+			return nil
+		end
+
+		rtype [] => nil
+		def look
+			puts @desc
+
+			if @items.length == 0
+				puts "Nothing is located here"
+			elsif @items.length == 1
+				puts
+
+				puts "Located here is:"
+				puts engine.items[@items[0]].name
+			else
+				puts
+
+				puts "Located here are:"
+				@items.each{ |id| puts engine.items[id].name }
+			end
+
+				puts
+
+			if doors.length == 0
+				puts "There is no exit"
+			elsif doors.length == 1
+				puts "The only exit is: #{@doors.values[0]}"
+			else
+				puts "The exits are:"
+				@doors.values.each{|name| puts name}
+			end
+
+			return nil
+		end
+	end
+
+end

data/lib/twisty.rb

@@ -0,0 +1,106 @@
+#############################################################################
+#                                                                           #
+#   Copyright (c) 2017, Ryan McCoskrie <work@ryanmccoskrie.me>              #
+#                                                                           #
+#   This software is distributed under the MIT License which can be found   #
+#   in the root directory.                                                  #
+#                                                                           #
+#############################################################################
+
+require_relative 'twisty/error.rb'
+require_relative 'twisty/engine.rb'
+require_relative 'twisty/command.rb'
+require_relative 'twisty/entity.rb'
+require_relative 'twisty/room.rb'
+require_relative 'twisty/item.rb'
+
+
+module Twisty
+
+Engine.instance.define_command(
+	/^help$/,
+	"help",
+	"Write out the list of commands you are reading now") do |x|
+		@commands.values.each do |command|
+			puts "#{command.help1}:"
+			puts "#{command.help2}"
+			puts
+		end
+	end
+Engine.instance.define_command(
+	/^look$/,
+	"look",
+	"Look at the current room") {|x| current_room.look()}
+
+Engine.instance.define_command(
+	/^look at \w+$/,
+	"look at object",
+	"Look at a specific object") do |tokens|
+		found = false
+		current_items.each do |id|
+			if @items[id].name.downcase == tokens[2]
+				@items[id].look
+				found = true
+				break
+			end
+		end
+
+		#Error condidtion
+		raise PlayError.new "I see no #{tokens[2]}" unless found
+	end
+Engine.instance.define_command(
+	/^inventory$/,
+	"inventory",
+	"Get a list of things you are carrying") do |x|
+		if @inventory.size == 0
+			puts "You are currently carrying nothing"
+		else
+			puts "You are currently carring: "
+			@inventory.each{|id| puts @items[id].name}
+		end
+	end
+Engine.instance.define_command(
+	/^take \w+$/,
+	"take object",
+	"Take an object and carry it in your inventory") do |tokens|
+		take_item_by_name(tokens[1])
+	end
+Engine.instance.define_command(
+	/^take \w+ from \w+$/,
+	"take object from container",
+	"Take an object out of a container and carry it your inventory") do |tokens|
+		take_from_by_name_name(tokens[1], tokens[3])
+	end
+Engine.instance.define_command(
+	/^drop \w+$/,
+	"drop object",
+	"Remove an object from your inventory and leave it in the room") do |tokens|
+		drop_item_by_name(tokens[1])
+	end
+Engine.instance.define_command(
+	/^put \w+ in \w+$/,
+	"put item in container",
+	"Remove an object from your inventory and leave it in a container") do |tokens|
+		put_item_by_name_name(tokens[1], tokens[3])
+	end
+Engine.instance.define_command(
+	/^walk \w+$/,
+	"walk exit",
+	"Walk out of the room through an exit") do |tokens|
+		found = false
+		current_doors.each_pair do |to, name|
+			if name.downcase == tokens[1]
+				goto to
+				found = true
+				break
+			end
+		end
+
+		#Error condition
+		raise PlayError.new "Where is #{tokens[1]}?" unless found
+	end
+Engine.instance.define_command(
+	/^quit$/,
+	"quit",
+	"Stop playing the game") {|x| @playing = false}
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: twisty
+version: !ruby/object:Gem::Version
+  version: 0.0.2b
+platform: ruby
+authors:
+- Ryan McCoskrie
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-02-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rtype-native
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+description: Adventure game library
+email: work@ryanmccoskrie.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/twisty.rb
+- lib/twisty/command.rb
+- lib/twisty/engine.rb
+- lib/twisty/entity.rb
+- lib/twisty/error.rb
+- lib/twisty/item.rb
+- lib/twisty/room.rb
+homepage: http://rubygems.org/gems/twisty
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: Twisty
+test_files: []