mr_holmes 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 42150cd33b1cbe622295a226cbbd24fbcb1dd450
+  data.tar.gz: 53dadcfae8249d4a9a64fb7effcb3b517af014bb
+SHA512:
+  metadata.gz: ee82e6e37d9fe17f6f3c4e70f8a949e836e949cb8780cecea82d95fd051a3bfad4c511542bd77c84c9eb9e41134892a11520056412191ad7b37f04bfcca412fb
+  data.tar.gz: f9481b4d092f3ca88c461ae9431ee803264937132cc0c433dbea4f1d58ee03f80547a1eda51760d68f03f5c409a70131ba8dce3b63881477bb1e8610b301dfb1

data/.autotest

@@ -0,0 +1,25 @@
+# -*- ruby -*-
+
+require "autotest/restart"
+
+# Autotest.add_hook :initialize do |at|
+#   at.testlib = "minitest/unit"
+#
+#   at.extra_files << "../some/external/dependency.rb"
+#
+#   at.libs << ":../some/external"
+#
+#   at.add_exception "vendor"
+#
+#   at.add_mapping(/dependency.rb/) do |f, _|
+#     at.files_matching(/test_.*rb$/)
+#   end
+#
+#   %w(TestA TestB).each do |klass|
+#     at.extra_class_map[klass] = "test/test_misc.rb"
+#   end
+# end
+
+# Autotest.add_hook :run_command do |at|
+#   system "rake build"
+# end

data/Changelog.md

@@ -0,0 +1,7 @@
+__CHANGELOG__  
+
+__0.0.0__ */ 13-10-2013*  
+Initial project file structure generated using the [Hoe](http://docs.seattlerb.org/hoe/) gem. The default `.txt` files where renamed to `.md` for the use of [Markdown](http://daringfireball.net/projects/markdown/). The `LICENSE.md` file was added, and `git` was initialized.
+
+__0.0.1__ */ 13-10-2013*  
+Basic storyline and implemented logic for the most important functions of the game engine. /bin now contains an executable. Gem was renamed to mr_holmes. 

data/LICENSE.md

@@ -0,0 +1,61 @@
+__CREATIVE COMMONS ATTRIBUTION-NONCOMMERCIAL__
+
+License
+
+THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.
+
+BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. TO THE EXTENT THIS LICENSE MAY BE CONSIDERED TO BE A CONTRACT, THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.
+
+1. Definitions
+
+__Adaptation__ means a work based upon the Work, or upon the Work and other pre-existing works, such as a translation, adaptation, derivative work, arrangement of music or other alterations of a literary or artistic work, or phonogram or performance and includes cinematographic adaptations or any other form in which the Work may be recast, transformed, or adapted including in any form recognizably derived from the original, except that a work that constitutes a Collection will not be considered an Adaptation for the purpose of this License. For the avoidance of doubt, where the Work is a musical work, performance or phonogram, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered an Adaptation for the purpose of this License.
+__Collection__ means a collection of literary or artistic works, such as encyclopedias and anthologies, or performances, phonograms or broadcasts, or other works or subject matter other than works listed in Section 1(f) below, which, by reason of the selection and arrangement of their contents, constitute intellectual creations, in which the Work is included in its entirety in unmodified form along with one or more other contributions, each constituting separate and independent works in themselves, which together are assembled into a collective whole. A work that constitutes a Collection will not be considered an Adaptation (as defined above) for the purposes of this License.
+__Distribute__ means to make available to the public the original and copies of the Work or Adaptation, as appropriate, through sale or other transfer of ownership.
+__Licensor__ means the individual, individuals, entity or entities that offer(s) the Work under the terms of this License.
+__Original Author__ means, in the case of a literary or artistic work, the individual, individuals, entity or entities who created the Work or if no individual or entity can be identified, the publisher; and in addition (i) in the case of a performance the actors, singers, musicians, dancers, and other persons who act, sing, deliver, declaim, play in, interpret or otherwise perform literary or artistic works or expressions of folklore; (ii) in the case of a phonogram the producer being the person or legal entity who first fixes the sounds of a performance or other sounds; and, (iii) in the case of broadcasts, the organization that transmits the broadcast.
+__Work__ means the literary and/or artistic work offered under the terms of this License including without limitation any production in the literary, scientific and artistic domain, whatever may be the mode or form of its expression including digital form, such as a book, pamphlet and other writing; a lecture, address, sermon or other work of the same nature; a dramatic or dramatico-musical work; a choreographic work or entertainment in dumb show; a musical composition with or without words; a cinematographic work to which are assimilated works expressed by a process analogous to cinematography; a work of drawing, painting, architecture, sculpture, engraving or lithography; a photographic work to which are assimilated works expressed by a process analogous to photography; a work of applied art; an illustration, map, plan, sketch or three-dimensional work relative to geography, topography, architecture or science; a performance; a broadcast; a phonogram; a compilation of data to the extent it is protected as a copyrightable work; or a work performed by a variety or circus performer to the extent it is not otherwise considered a literary or artistic work.
+__You__ means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
+__Publicly Perform__ means to perform public recitations of the Work and to communicate to the public those public recitations, by any means or process, including by wire or wireless means or public digital performances; to make available to the public Works in such a way that members of the public may access these Works from a place and at a place individually chosen by them; to perform the Work to the public by any means or process and the communication to the public of the performances of the Work, including by public digital performance; to broadcast and rebroadcast the Work by any means including signs, sounds or images.
+__Reproduce__ means to make copies of the Work by any means including without limitation by sound or visual recordings and the right of fixation and reproducing fixations of the Work, including storage of a protected performance or phonogram in digital form or other electronic medium.
+
+2. Fair Dealing Rights. Nothing in this License is intended to reduce, limit, or restrict any uses free from copyright or rights arising from limitations or exceptions that are provided for in connection with the copyright protection under copyright law or other applicable laws.
+
+3. License Grant. Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:
+
+to Reproduce the Work, to incorporate the Work into one or more Collections, and to Reproduce the Work as incorporated in the Collections;
+to create and Reproduce Adaptations provided that any such Adaptation, including any translation in any medium, takes reasonable steps to clearly label, demarcate or otherwise identify that changes were made to the original Work. For example, a translation could be marked "The original work was translated from English to Spanish," or a modification could indicate "The original work has been modified.";
+to Distribute and Publicly Perform the Work including as incorporated in Collections; and,
+to Distribute and Publicly Perform Adaptations.
+The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. Subject to Section 8(f), all rights not expressly granted by Licensor are hereby reserved, including but not limited to the rights set forth in Section 4(d).
+
+4. Restrictions. The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:
+
+You may Distribute or Publicly Perform the Work only under the terms of this License. You must include a copy of, or the Uniform Resource Identifier (URI) for, this License with every copy of the Work You Distribute or Publicly Perform. You may not offer or impose any terms on the Work that restrict the terms of this License or the ability of the recipient of the Work to exercise the rights granted to that recipient under the terms of the License. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties with every copy of the Work You Distribute or Publicly Perform. When You Distribute or Publicly Perform the Work, You may not impose any effective technological measures on the Work that restrict the ability of a recipient of the Work from You to exercise the rights granted to that recipient under the terms of the License. This Section 4(a) applies to the Work as incorporated in a Collection, but this does not require the Collection apart from the Work itself to be made subject to the terms of this License. If You create a Collection, upon notice from any Licensor You must, to the extent practicable, remove from the Collection any credit as required by Section 4(c), as requested. If You create an Adaptation, upon notice from any Licensor You must, to the extent practicable, remove from the Adaptation any credit as required by Section 4(c), as requested.
+You may not exercise any of the rights granted to You in Section 3 above in any manner that is primarily intended for or directed toward commercial advantage or private monetary compensation. The exchange of the Work for other copyrighted works by means of digital file-sharing or otherwise shall not be considered to be intended for or directed toward commercial advantage or private monetary compensation, provided there is no payment of any monetary compensation in connection with the exchange of copyrighted works.
+If You Distribute, or Publicly Perform the Work or any Adaptations or Collections, You must, unless a request has been made pursuant to Section 4(a), keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or if the Original Author and/or Licensor designate another party or parties (e.g., a sponsor institute, publishing entity, journal) for attribution ("Attribution Parties") in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; (ii) the title of the Work if supplied; (iii) to the extent reasonably practicable, the URI, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and, (iv) consistent with Section 3(b), in the case of an Adaptation, a credit identifying the use of the Work in the Adaptation (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). The credit required by this Section 4(c) may be implemented in any reasonable manner; provided, however, that in the case of a Adaptation or Collection, at a minimum such credit will appear, if a credit for all contributing authors of the Adaptation or Collection appears, then as part of these credits and in a manner at least as prominent as the credits for the other contributing authors. For the avoidance of doubt, You may only use the credit required by this Section for the purpose of attribution in the manner set out above and, by exercising Your rights under this License, You may not implicitly or explicitly assert or imply any connection with, sponsorship or endorsement by the Original Author, Licensor and/or Attribution Parties, as appropriate, of You or Your use of the Work, without the separate, express prior written permission of the Original Author, Licensor and/or Attribution Parties.
+For the avoidance of doubt:
+
+Non-waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme cannot be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License;
+Waivable Compulsory License Schemes. In those jurisdictions in which the right to collect royalties through any statutory or compulsory licensing scheme can be waived, the Licensor reserves the exclusive right to collect such royalties for any exercise by You of the rights granted under this License if Your exercise of such rights is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(b) and otherwise waives the right to collect royalties through any statutory or compulsory licensing scheme; and,
+Voluntary License Schemes. The Licensor reserves the right to collect royalties, whether individually or, in the event that the Licensor is a member of a collecting society that administers voluntary licensing schemes, via that society, from any exercise by You of the rights granted under this License that is for a purpose or use which is otherwise than noncommercial as permitted under Section 4(c).
+Except as otherwise agreed in writing by the Licensor or as may be otherwise permitted by applicable law, if You Reproduce, Distribute or Publicly Perform the Work either by itself or as part of any Adaptations or Collections, You must not distort, mutilate, modify or take other derogatory action in relation to the Work which would be prejudicial to the Original Author's honor or reputation. Licensor agrees that in those jurisdictions (e.g. Japan), in which any exercise of the right granted in Section 3(b) of this License (the right to make Adaptations) would be deemed to be a distortion, mutilation, modification or other derogatory action prejudicial to the Original Author's honor and reputation, the Licensor will waive or not assert, as appropriate, this Section, to the fullest extent permitted by the applicable national law, to enable You to reasonably exercise Your right under Section 3(b) of this License (right to make Adaptations) but not otherwise.
+
+5. Representations, Warranties and Disclaimer
+
+UNLESS OTHERWISE MUTUALLY AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE WORK, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.
+
+6. Limitation on Liability. EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
+
+7. Termination
+
+This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Adaptations or Collections from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
+Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.
+
+8. Miscellaneous
+
+Each time You Distribute or Publicly Perform the Work or a Collection, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
+Each time You Distribute or Publicly Perform an Adaptation, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
+If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
+No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
+This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.
+The rights granted under, and the subject matter referenced, in this License were drafted utilizing the terminology of the Berne Convention for the Protection of Literary and Artistic Works (as amended on September 28, 1979), the Rome Convention of 1961, the WIPO Copyright Treaty of 1996, the WIPO Performances and Phonograms Treaty of 1996 and the Universal Copyright Convention (as revised on July 24, 1971). These rights and subject matter take effect in the relevant jurisdiction in which the License terms are sought to be enforced according to the corresponding provisions of the implementation of those treaty provisions in the applicable national law. If the standard suite of rights granted under applicable copyright law includes additional rights not granted under this License, such additional rights are deemed to be included in the License; this License is not intended to restrict the license of any rights under applicable law.

data/Manifest.md

@@ -0,0 +1,13 @@
+__MANIFEST__  
+
+The manifest file lists all the files existing in the current version of the project.
+
++ bin/mr_holmes
++ lib/mr_holmes.rb
++ test/test_mr_holmes.rb
++ .autotest
++ Changelog.md
++ LICENSE.md
++ Manifest.md
++ Rakefile
++ README.md

data/README.md

@@ -0,0 +1,6 @@
+__Mr Holmes__  
+
+*__Mr Holmes__ is a text-based game based on the magnificent works of Sir Arthur Conan Doyle. Release your inner sleuth as you work your way through a wide variaty of criminal mysteries. With the help of your loyal friend Dr. Watson, you'll have to solve complex puzzles whilst playing a dangerous game of chess with your arch-enemy: Moriarty.*
+
+> __Note:__ This project is still in the early stages of development.  
+> The first working version (1.0.0) is yet to be released.

data/bin/mr_holmes

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require_relative  '../lib/mr_holmes'

data/lib/locations/baker_street.rb

@@ -0,0 +1,131 @@
+@root.location(:baker_street) do
+  self.desc = <<-DESC
+    Your current location is Baker Street, London. It's the street that you call home, and where your chambers are. You share your
+    rooms with dr. Watson, on the first and second floor of 221B. The landlady is a kind, older woman called Mrs. Hudson.
+  DESC
+
+  self.short_desc = <<-DESC
+    LOCATION: Baker Street
+  DESC
+
+  scene(:side_walk) do
+    self.exit_west = :hall_way_ground_floor
+    self.desc = <<-DESC
+      You are standing on the sidewalk in front of 221B Baker Str. You are facing north, with the front door of your chambers to your west.
+    DESC
+    self.short_desc = <<-DESC
+      SCENE: Sidewalk in front of 221B Baker Str.
+    DESC
+
+    player do
+
+      item(:pipe, 'pipe', 'clay', 'empty') do
+        self.open = true
+        self.desc = <<-DESC
+          A clay pipe for times when extraordinary concentration of thought is needed. Used with tobacco and matches.
+        DESC
+        self.short_desc = <<-DESC
+          A clay pipe.
+        DESC
+        self.script_accept = <<-SCRIPT 
+          if [:tobacco].include?(args[0].tag) && children.empty?
+            return true
+          elsif !children.empty?
+            puts "The pipe is already filled with tobacco..."
+            return false
+          else
+            puts "You can't put that in the pipe..."
+            return false
+          end
+        SCRIPT
+      end
+      item(:tobacco, 'tobacco', 'strong', 'dry') do
+        self.desc = <<-DESC
+          Dry tobacco used to fill a pipe.
+        DESC
+        self.short_desc = <<-DESC
+          Dry tobacco.
+        DESC
+      end
+      item(:matches, 'matches', 'dry') do
+        self.desc = <<-DESC
+          These matches can be used on multiple items, when a flame is needed.
+        DESC
+        self.short_desc = <<-DESC
+          Box of matches.
+        DESC
+        self.script_use = <<-SCRIPT
+          if args[0].tag == :pipe
+            if !args[0].children.empty?
+              puts "You lit your pipe"
+              return
+            else
+              puts "Put tobacco in your pipe before lighting it"
+            end
+          else
+            puts "You can't use matches on that"
+            return
+          end
+        SCRIPT
+      end
+
+    end # End Of Player
+
+  end # End Of Scene 'Sidewalk'
+
+  scene(:hall_way_ground_floor) do
+    self.exit_east = :side_walk
+    self.exit_up = :hall_way_first_floor
+    self.desc = <<-DESC
+      You are in the hallway on the ground floor of 221B Baker Str. Your chambers are up the stairs, on the first and
+      second floor. The front door leading to the sidewalk outside is east of you.
+    DESC
+    self.short_desc = <<-DESC
+      SCENE: Ground floor hallway of 221B Baker Str.
+    DESC
+    item(:table, 'table') do
+      self.desc = <<-DESC
+        A small table in the hallway on the ground floor. Any mail or telegrams recieved when you are not at home is usually
+        put on this table.
+      DESC
+      self.short_desc = <<-DESC
+        A small table.
+      DESC
+      self.presence = <<-PRES
+        You see a small table placed against the wall.
+      PRES
+      item(:telegram_1, 'telegram_1') do
+        self.desc = <<-DESC
+          TELEGRAM: Mysterious case - stop - Lauriston Gardens nr. 3 - stop - come as soon as possible - stop - Lestrade
+        DESC
+        self.short_desc = <<-DESC
+          A Telegram from detective inspector Lestrade.
+        DESC
+      end
+    end
+  end # End Of Scene 'Hallway Grd. Floor'
+
+  scene(:hall_way_first_floor) do
+    self.exit_north = :sitting_room_first_floor
+    self.exit_down = :hall_way_ground_floor
+    self.desc = <<-DESC
+      You find yourself in the hallway on the first floor of 221B Baker Str. North of you is the door to your sitting room. Down the stairs
+      you will find the ground floor hallway.
+    DESC
+    self.short_desc = <<-DESC
+      SCENE: First floor hallway of 221B Baker Str.
+    DESC
+  end # End of Scene 'Hallway First Floor'
+
+  scene(:sitting_room_first_floor) do
+    self.exit_south = :hall_way_first_floor
+    self.desc = <<-DESC
+      You are in your sitting room on the first floor of 221B Baker Str. The windows to your east provide a view
+      of Baker Str. itself, and to your south is the door to the first floor stairwell.
+    DESC
+    self.short_desc = <<-DESC
+      SCENE: Sitting room at 221B Baker Str.
+    DESC
+  end # End Of Scene 'Sitting Room First Floor'
+
+end # End of Location 'Baker Street'

data/lib/mr_holmes/node.rb

@@ -0,0 +1,325 @@
+require "yaml"
+require "ostruct"
+require "mr_holmes/string"
+
+class Node < OpenStruct
+
+  # Method to fix YAML conversions and handling
+  def init_with(c)
+    c.map.keys.each do|k|
+      instance_variable_set("@#{k}", c.map[k])
+    end
+
+    @table.keys.each do|k|
+      new_ostruct_member(k)
+    end
+  end
+
+  # Save node structure to YAML
+  def self.save(node, file='save.yaml')
+    File.open(file, 'w+') do|f|
+      f.puts node.to_yaml
+    end
+  end
+
+  # Load node structure from YAML file
+  def self.load(file='save.yaml')
+    yaml = YAML::load_file(file)
+  end
+
+  # Override 'puts' method for scene descriptions
+  def puts(*s)
+    STDOUT.puts( s.join(' ').word_wrap )
+  end
+
+  # Define possible node types
+  DEFAULTS = {
+    :root => { :open => true },
+    :location => { :open => true },
+    :scene => { :open => true },
+    :item => { :open => false, },
+    :player => { :open => true }
+  }
+
+  # Initialize node
+  def initialize(parent=nil, tag=nil, defaults={}, &block)
+    super()
+    defaults.each { |k,v| send("#{k}=", v) }
+    self.parent = parent
+    self.parent.children << self unless parent.nil?
+    self.tag = tag
+    self.children = []
+    instance_eval(&block) unless block.nil?
+  end
+
+  # Create root
+  def self.root(&block)
+    Node.new(nil, :root, &block)
+  end
+
+  # Create location
+  def location(tag, &block)
+    Node.new(self, tag, DEFAULTS[:location], &block)
+  end
+
+  # Create scene
+  def scene(tag, &block)
+    Node.new(self, tag, DEFAULTS[:scene], &block)
+  end
+
+  # Create item
+  def item(tag, name, *words, &block)
+    i = Node.new(self, tag, DEFAULTS[:item])
+    i.name = name
+    i.words = words
+    i.instance_eval(&block) if block_given?
+  end
+
+  # Create player
+  def player(&block)
+    Player.new(self, :player, DEFAULTS[:player], &block)
+  end
+
+  # ----------------------------------------------------------------- Finding Nodes
+
+  # Method to find node
+  def find(node_data)
+    case node_data
+    when Symbol
+      find_by_tag(node_data)
+    when String
+      find_by_string(node_data)
+    when Array 
+      find_by_string(node_data)
+    when Node 
+      node_data
+    end
+  end
+
+  # Find node by tag
+  def find_by_tag(tag)
+    return self if self.tag == tag
+    children.each do |c|
+      result = c.find_by_tag(tag)
+      return result unless result.nil?
+    end
+    return nil
+  end
+
+  # Find node by name
+  def find_by_name(words, nodes=[])
+    words = words.split unless words.is_a?(Array)
+    nodes << self if words.include?(name)
+    children.each do |c|
+      c.find_by_name(words, nodes)
+    end
+    return nodes
+  end
+
+  # Find node by string
+  def find_by_string(words)
+    words = words.split unless words.is_a?(Array)
+    nodes = find_by_name(words)
+    if nodes.empty?
+      puts "I don't see that here"
+      return nil
+    end
+    # Score nodes by number of matching adjectives
+    nodes.each do |i|
+      i.search_score = (words & i.words).length
+    end
+    # Sort highest scoring nodes to beginning of list
+    nodes.sort! do |a,b|
+      a.search_score <=> b.search_score
+    end
+    # Remove nodes with a lower score than the first node in the list
+    nodes.delete_if do |i|
+      i.search_score < nodes.first.search_score
+    end
+    # Interpret the results
+    if nodes.length == 1
+      return nodes.first
+    else
+      puts "Which item do you mean?"
+      nodes.each do |i|
+        puts " * #{i.name} (#{i.words.join(', ')})"
+      end
+      return nil
+    end
+  end
+
+  # ----------------------------------------------------------------- Traversing Upwards
+
+  # Get scene
+  def get_scene
+    if parent.parent.tag == :root
+      return self
+    else
+      return parent.get_scene
+    end
+  end
+
+  # Get location
+  def get_location
+    if parent.tag == :root
+      return self
+    else
+      return parent.get_location
+    end
+  end
+
+  # Get root
+  def get_root
+    if tag == :root || parent.nil?
+      return self
+    else
+      return parent.get_root
+    end
+  end
+
+  def ancestors(list=[])
+    if parent.nil?
+      return list
+    else
+      list << parent
+      return parent.ancestors(list)
+    end
+  end
+
+  # ----------------------------------------------------------------- Hidden Nodes
+
+  # Check if node is hidden
+  def hidden?
+    if parent.tag == :root || parent.tag == :location
+      return false
+    elsif parent.open == false
+      return true
+    else
+      return parent.hidden?
+    end
+  end
+
+  # ----------------------------------------------------------------- Moving Nodes
+
+  # Move node
+  def move(object, to, check=true)
+    item = find(object)
+    dest = find(to)
+    return if item.nil?
+    if check && item.hidden?
+      puts "You can't get to that right now"
+      return
+    end
+    return if dest.nil?
+    if check && dest.hidden? || dest.open == false
+      puts "You can't put that there"
+      return
+    end
+    if dest.ancestors.include?(item)
+      puts "Are you trying to destroy the universe?"
+      return
+    end
+    item.parent.children.delete(item)
+    dest.children << item
+    item.parent = dest
+  end
+
+  # ----------------------------------------------------------------- Executing Script
+
+  def script(key, *args)
+    if respond_to?("script_#{key}")
+      return eval(self.send("script_#{key}"))
+    else
+      return true
+    end
+  end
+
+  # ----------------------------------------------------------------- Descriptions
+
+  def described?
+    if respond_to?(:described)
+      self.described
+    else 
+      false
+    end
+  end
+
+  def describe
+    base = ""
+    if !described? && respond_to?(:desc)
+      self.described = true
+      base << desc
+    elsif respond_to?(:short_desc)
+      base << short_desc
+    else
+      base << "You are in #{tag}"
+    end
+
+    # Append presence of children nodes if open
+    if open
+      children.each do|c|
+        base << (c.presence || '')
+      end
+    end
+
+    puts
+    puts base
+
+  end
+
+  def short_description
+    if respond_to?(:short_desc)
+      short_desc
+    else
+      tag.to_s
+    end
+  end
+
+  def long_description
+    if respond_to?(:desc)
+      desc
+    else
+      tag.to_s
+    end
+  end
+
+  # ----------------------------------------------------------------- Rendering Nodes
+
+  # Render node structure
+  def to_s(verbose=false, indent='')
+    bullet = if parent && parent.tag == :root
+               '#'
+             elsif parent && parent.parent.tag == :root
+               '*'
+             elsif tag == :player
+               '@'
+             elsif tag == :root
+               '>'
+             elsif open == true
+               'O'
+             else
+               '-'
+             end
+
+    str = "#{indent}#{bullet} #{tag}\n"
+
+    if verbose
+      self.table.each do|k,v|
+        if k == :children
+          str << "#{indent+'  '}#{k}=#{v.map(&:tag)}\n"
+        elsif v.is_a?(Node)
+          str << "#{indent+'  '}#{k}=#{v.tag}\n"
+        else
+          str << "#{indent+'  '}#{k}=#{v}\n"
+        end
+      end
+    end
+
+    children.each do|c|
+      str << c.to_s(verbose, indent + '  ')
+    end
+
+    return str
+  end
+
+end

data/lib/mr_holmes/player.rb

@@ -0,0 +1,168 @@
+require "yaml"
+
+class Player < Node
+
+  # ----------------------------------------------------------------- Basics
+
+  # Main command interpreter
+  def command(words)
+    verb, *words = words.split(" ")
+    verb = "do_#{verb}"
+    if respond_to?(verb)
+      send(verb, *words)
+      puts
+    else
+      puts "I don't know how to do that."
+    end
+  end
+
+  # Provide command shortcuts
+  %w{ north south east west up down }.each do|dir|
+    define_method("do_#{dir}") do
+      do_go(dir)
+    end
+
+    define_method("do_#{dir[0]}") do
+      do_go(dir)
+    end
+  end
+
+  # ----------------------------------------------------------------- Actions
+
+  # Move the player around between scenes
+  def do_go(direction, *a)
+    dest = get_scene.send("exit_#{direction}")
+    if dest.nil?
+      puts "You can't go that way."
+    else
+      dest = get_location.find(dest)
+      if dest.script("enter", direction)
+        get_location.move(self, dest)
+      end
+      get_location.describe
+      get_scene.describe
+    end
+  end
+
+  # Display current scene information
+  def do_look(*a)
+    puts
+    puts get_scene.long_description
+  end
+
+  # Display the items currently in the player's inventory
+  def do_inventory(*a)
+    if children.empty?
+      puts
+      puts "INVENTORY"
+      puts
+      puts "You have nothing in your inventory..."
+    else
+      puts
+      puts "INVENTORY"
+      puts
+      children.each do |c|
+        puts " - #{c.name}"
+      end
+    end
+  end
+
+  # Move an item from the current scene to your inventory
+  def do_take(*thing)
+    thing = get_scene.find(thing)
+    return if thing.nil?
+    if thing.script("take")
+      puts "Taken. " if get_location.move(thing, self)
+    end
+  end
+
+  # Move an item from your inventory to the current scene 
+  def do_drop(*thing)
+    move(thing.join(" "), get_scene)
+  end
+
+  # Set the value of an item's "open" attribute
+  def open_close(thing, state)
+    container = get_scene.find(thing)
+    return if container.nil?
+    if container.open == state
+      puts "It's already #{state ? 'open' : 'closed'}"
+    else
+      container.open = state
+    end
+  end
+
+  # Open an item in the current scene
+  def do_open(*thing)
+    open_close(thing, true)
+  end
+
+  # Close an item in the current scene
+  def do_close(*thing)
+    open_close(thing, false)
+  end
+
+  # Put an item in or on another item
+  def do_put(*words)
+    prepositions = [' in ', ' on ']
+    prep_regex = Regexp.new("(#{prepositions.join('|')})")
+    item_words, _, cont_words = words.join(' ').split(prep_regex)
+    if cont_words.nil?
+      puts "You want to put what where?"
+      return
+    end
+    item = get_scene.find(item_words)
+    container = get_scene.find(cont_words)
+    return if item.nil? || container.nil?
+    if container.script("accept", item)
+      get_scene.move(item, container)
+    end
+  end
+
+  # Use an item on another item
+  def do_use(*words)
+    prepositions = %w{ in on with }
+    prepositions.map!{|p| " #{p} " }
+    prep_regex = Regexp.new("(#{prepositions.join('|')})")
+    item1_words, _, item2_words = words.join(' ').split(prep_regex)
+    if item2_words.nil?
+      puts "I don't quite understand you."
+      return
+    end
+    item1 = get_scene.find(item1_words)
+    item2 = get_scene.find(item2_words)
+    return if item1.nil? || item2.nil?
+    item1.script('use', item2)
+  end
+
+  # Examine an item closely
+  def do_examine(*thing)
+    item = get_scene.find(thing)
+    return if item.nil?
+    item.described = false
+    item.describe
+  end
+
+  # ----------------------------------------------------------------- Alias methods
+
+  alias_method :do_get, :do_take
+  alias_method :do_i, :do_inventory
+  alias_method :do_inv, :do_inventory
+
+  # ----------------------------------------------------------------- Debugging
+
+  def do_root(*a)
+    STDOUT.puts get_root
+  end
+
+  # Display the complete node structure
+  def do_map(*a)
+    STDOUT.puts get_root
+  end
+
+  # Display the complete node structure in detail
+  def do_map_detailed(*a)
+    STDOUT.puts get_root.to_s(true)
+  end
+
+end

data/lib/mr_holmes/string.rb

@@ -0,0 +1,29 @@
+class String
+  def word_wrap(width=80)
+    # Replace newlines with spaces
+    gsub(/\n/, ' ').   
+    
+    # Replace more than one space with a single space
+    gsub(/\s+/, ' ').
+
+    # Replace spaces at the beginning of the
+    # string with nothing
+    gsub(/^\s+/, '').
+
+    # This one is hard to read.  Replace with any amount
+    # of space after it with that punctuation and two
+    # spaces
+    gsub(/([\.\!\?]+)(\s+)?/, '\1  ').
+
+    # Similar to the call above, except replace commas
+    # with a comma and one space
+    gsub(/\,(\s+)?/, ', ').
+
+    # The meat of the method, replace between 1 and width
+    # characters followed by whitespace or the end of the
+    # line with that string and a newline.  This works
+    # because regular expression engines are greedy,
+    # they'll take as many characters as they can.
+    gsub(%r[(.{1,#{width}})(?:\s|\z)], "\\1\n")
+  end
+end

data/lib/mr_holmes.rb

@@ -0,0 +1,43 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+require 'mr_holmes/node'
+require 'mr_holmes/player'
+
+require 'yaml'
+
+class Sherlock
+
+  VERSION = "0.0.1"
+
+end # End Of Class
+
+@root = Node.root
+
+require 'locations/baker_street'
+
+@root.find(:player).get_location.describe
+@root.find(:player).get_scene.describe
+puts
+
+loop do
+  player = @root.find(:player)
+
+  print "What now? "
+
+  input = gets.chomp
+  verb = input.split(' ').first
+
+  case verb
+  when "load"
+    @root = Node.load
+    puts "Loaded"
+  when "save"
+    Node.save(@root)
+    puts "Saved current game progression... "
+  when "quit"
+    puts "Goodbye! "
+    exit
+  else
+    player.command(input)
+  end
+end

data/mr_holmes.gemspec

@@ -0,0 +1,13 @@
+Gem::Specification.new do |s|
+  s.name        = 'mr_holmes'
+  s.version     = '0.0.1'
+  s.date        = '2014-11-26'
+  s.summary     = "Mr Holmes is a text-based game based on the magnificent works of Sir Arthur Conan Doyle."
+  s.description = "Mr Holmes is a text-based game based on the magnificent works of Sir Arthur Conan Doyle. Release your inner sleuth as you work your way through a wide variaty of criminal mysteries. With the help of your loyal friend Dr. Watson, you'll have to solve complex puzzles whilst playing a dangerous game of chess with your arch-enemy: Moriarty."
+  s.authors     = ["Stefan Hagen"]
+  s.email       = 'stefan@stefanhagen.nl'
+  s.files       = `git ls-files`.split("\n")
+  s.executables << 'mr_holmes'
+  s.homepage    = 'https://github.com/StefanHagen/mr_holmes'
+  s.license     = 'Creative Commons Attribution-NonCommercial'
+end

data/save.yaml

@@ -0,0 +1,176 @@
+--- &1 !ruby/object:Node
+table:
+  :parent: 
+  :tag: :root
+  :children:
+  - &2 !ruby/object:Node
+    table:
+      :open: true
+      :parent: *1
+      :tag: :baker_street
+      :children:
+      - !ruby/object:Node
+        table:
+          :open: true
+          :parent: *2
+          :tag: :side_walk
+          :children: []
+          :exit_west: :hall_way_ground_floor
+          :desc: |2
+                  You are standing on the sidewalk in front of 221B Baker Str. You are facing north, with the front door of your chambers to your west.
+          :short_desc: |2
+                  SCENE: Sidewalk in front of 221B Baker Str.
+          :described: true
+        modifiable: true
+      - &3 !ruby/object:Node
+        table:
+          :open: true
+          :parent: *2
+          :tag: :hall_way_ground_floor
+          :children:
+          - &4 !ruby/object:Node
+            table:
+              :open: false
+              :parent: *3
+              :tag: :table
+              :children:
+              - !ruby/object:Node
+                table:
+                  :open: false
+                  :parent: *4
+                  :tag: :telegram_1
+                  :children: []
+                  :name: telegram_1
+                  :words: []
+                  :desc: |2
+                              TELEGRAM: Mysterious case - stop - Lauriston Gardens nr. 3 - stop - come as soon as possible - stop - Lestrade
+                  :short_desc: |2
+                              A Telegram from detective inspector Lestrade.
+                modifiable: true
+              :name: table
+              :words: []
+              :desc: |2
+                        A small table in the hallway on the ground floor. Any mail or telegrams recieved when you are not at home is usually
+                        put on this table.
+              :short_desc: |2
+                        A small table.
+              :presence: |2
+                        You see a small table placed against the wall.
+            modifiable: true
+          - &5 !ruby/object:Player
+            table:
+              :open: true
+              :parent: *3
+              :tag: :player
+              :children:
+              - !ruby/object:Node
+                table:
+                  :open: true
+                  :parent: *5
+                  :tag: :pipe
+                  :children: []
+                  :name: pipe
+                  :words:
+                  - clay
+                  - empty
+                  :desc: |2
+                              A clay pipe for times when extraordinary concentration of thought is needed. Used with tobacco and matches.
+                  :short_desc: |2
+                              A clay pipe.
+                  :script_accept: |2
+                              if [:tobacco].include?(args[0].tag) && children.empty?
+                                return true
+                              elsif !children.empty?
+                                puts "The pipe is already filled with tobacco..."
+                                return false
+                              else
+                                puts "You can't put that in the pipe..."
+                                return false
+                              end
+                modifiable: true
+              - !ruby/object:Node
+                table:
+                  :open: false
+                  :parent: *5
+                  :tag: :tobacco
+                  :children: []
+                  :name: tobacco
+                  :words:
+                  - strong
+                  - dry
+                  :desc: |2
+                              Dry tobacco used to fill a pipe.
+                  :short_desc: |2
+                              Dry tobacco.
+                modifiable: true
+              - !ruby/object:Node
+                table:
+                  :open: false
+                  :parent: *5
+                  :tag: :matches
+                  :children: []
+                  :name: matches
+                  :words:
+                  - dry
+                  :desc: |2
+                              These matches can be used on multiple items, when a flame is needed.
+                  :short_desc: |2
+                              Box of matches.
+                  :script_use: |2
+                              if args[0].tag == :pipe
+                                if !args[0].children.empty?
+                                  puts "You lit your pipe"
+                                  return
+                                else
+                                  puts "Put tobacco in your pipe before lighting it"
+                                end
+                              else
+                                puts "You can't use matches on that"
+                                return
+                              end
+                modifiable: true
+            modifiable: true
+          :exit_east: :side_walk
+          :exit_up: :hall_way_first_floor
+          :desc: |2
+                  You are in the hallway on the ground floor of 221B Baker Str. Your chambers are up the stairs, on the first and
+                  second floor. The front door leading to the sidewalk outside is east of you.
+          :short_desc: |2
+                  SCENE: Ground floor hallway of 221B Baker Str.
+          :described: true
+        modifiable: true
+      - !ruby/object:Node
+        table:
+          :open: true
+          :parent: *2
+          :tag: :hall_way_first_floor
+          :children: []
+          :exit_north: :sitting_room_first_floor
+          :exit_down: :hall_way_ground_floor
+          :desc: |2
+                  You find yourself in the hallway on the first floor of 221B Baker Str. North of you is the door to your sitting room. Down the stairs
+                  you will find the ground floor hallway.
+          :short_desc: |2
+                  SCENE: First floor hallway of 221B Baker Str.
+        modifiable: true
+      - !ruby/object:Node
+        table:
+          :open: true
+          :parent: *2
+          :tag: :sitting_room_first_floor
+          :children: []
+          :exit_south: :hall_way_first_floor
+          :desc: |2
+                  You are in your sitting room on the first floor of 221B Baker Str. The windows to your east provide a view
+                  of Baker Str. itself, and to your south is the door to the first floor stairwell.
+          :short_desc: |2
+                  SCENE: Sitting room at 221B Baker Str.
+        modifiable: true
+      :desc: |2
+            Your current location is Baker Street, London. It's the street that you call home, and where your chambers are. You share your
+            rooms with dr. Watson, on the first and second floor of 221B. The landlady is a kind, older woman called Mrs. Hudson.
+      :short_desc: |2
+            LOCATION: Baker Street
+      :described: true
+    modifiable: true
+modifiable: true

data/test/test_mr_holmes.rb

@@ -0,0 +1,6 @@
+require "minitest/autorun"
+require "sherlock"
+
+class TestSherlock < MiniTest::Unit::TestCase
+  
+end

metadata

@@ -0,0 +1,66 @@
+--- !ruby/object:Gem::Specification
+name: mr_holmes
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Stefan Hagen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-26 00:00:00.000000000 Z
+dependencies: []
+description: 'Mr Holmes is a text-based game based on the magnificent works of Sir
+  Arthur Conan Doyle. Release your inner sleuth as you work your way through a wide
+  variaty of criminal mysteries. With the help of your loyal friend Dr. Watson, you''ll
+  have to solve complex puzzles whilst playing a dangerous game of chess with your
+  arch-enemy: Moriarty.'
+email: stefan@stefanhagen.nl
+executables:
+- mr_holmes
+extensions: []
+extra_rdoc_files: []
+files:
+- ".DS_Store"
+- ".autotest"
+- Changelog.md
+- LICENSE.md
+- Manifest.md
+- README.md
+- bin/mr_holmes
+- lib/.DS_Store
+- lib/locations/.DS_Store
+- lib/locations/baker_street.rb
+- lib/mr_holmes.rb
+- lib/mr_holmes/node.rb
+- lib/mr_holmes/player.rb
+- lib/mr_holmes/string.rb
+- mr_holmes.gemspec
+- save.yaml
+- test/test_mr_holmes.rb
+homepage: https://github.com/StefanHagen/mr_holmes
+licenses:
+- Creative Commons Attribution-NonCommercial
+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: Mr Holmes is a text-based game based on the magnificent works of Sir Arthur
+  Conan Doyle.
+test_files: []