gamefic 1.3.2 → 1.4.0

data/lib/gamefic/html.rb

@@ -1,20 +1,20 @@
 require 'rexml/document'
 
-module Gamefic
-
+module Gamefic
+
   module Html
     # Convert ampersands to &
     #
     # @param text [String]
-    # @return [String]
-    def self.fix_ampersands(text)
-      codes = []
-      ENTITIES.keys.each { |e|
-        codes.push e[1..-1]
-      }
-      piped = codes.join('|')
-      re = Regexp.new("&(?!(#{piped}))")
-      text.gsub(re, '&\1')
+    # @return [String]
+    def self.fix_ampersands(text)
+      codes = []
+      ENTITIES.keys.each { |e|
+        codes.push e[1..-1]
+      }
+      piped = codes.join('|')
+      re = Regexp.new("&(?!(#{piped}))")
+      text.gsub(re, '&\1')
     end
     
     # Encode a String with HTML entities
@@ -22,10 +22,11 @@ module Gamefic
     # @param text [String]
     # @return [String]
     def self.encode(text)
+      encoded = text
       Gamefic::Html::ENTITIES.each { |k, v|
-        text = text.gsub(v, k)
+        encoded = encoded.gsub(v, k)
       }
-      text
+      encoded
     end
     
     # Decode a String's HTML entities
@@ -58,10 +59,10 @@ module Gamefic
         raise e
       end
     end
-  end
-
-  module Html
-    ENTITIES = { "&quot;" => "\"", "&amp;" => "&", "&lt;" => "<", "&gt;" => ">", "&nbsp;" => " ", "&iexcl;" => "¡", "&cent;" => "¢", "&pound;" => "£", "&curren;" => "¤", "&yen;" => "¥", "&brvbar;" => "¦", "&sect;" => "§", "&uml;" => "¨", "&copy;" => "©", "&ordf;" => "ª", "&laquo;" => "«", "&not;" => "¬", "&shy;" => "­", "&reg;" => "®", "&macr;" => "¯", "&deg;" => "°", "&plusmn;" => "±", "&sup2;" => "²", "&sup3;" => "³", "&acute;" => "´", "&micro;" => "µ", "&para;" => "¶", "&middot;" => "·", "&cedil;" => "¸", "&sup1;" => "¹", "&ordm;" => "º", "&raquo;" => "»", "&frac14;" => "¼", "&frac12;" => "½", "&frac34;" => "¾", "&iquest;" => "¿", "&Agrave;" => "À", "&Aacute;" => "Á", "&Acirc;" => "Â", "&Atilde;" => "Ã", "&Auml;" => "Ä", "&Aring;" => "Å", "&AElig;" => "Æ", "&Ccedil;" => "Ç", "&Egrave;" => "È", "&Eacute;" => "É", "&Ecirc;" => "Ê", "&Euml;" => "Ë", "&Igrave;" => "Ì", "&Iacute;" => "Í", "&Icirc;" => "Î", "&Iuml;" => "Ï", "&ETH;" => "Ð", "&Ntilde;" => "Ñ", "&Ograve;" => "Ò", "&Oacute;" => "Ó", "&Ocirc;" => "Ô", "&Otilde;" => "Õ", "&Ouml;" => "Ö", "&times;" => "×", "&Oslash;" => "Ø", "&Ugrave;" => "Ù", "&Uacute;" => "Ú", "&Ucirc;" => "Û", "&Uuml;" => "Ü", "&Yacute;" => "Ý", "&THORN;" => "Þ", "&szlig;" => "ß", "&agrave;" => "à", "&aacute;" => "á", "&acirc;" => "â", "&atilde;" => "ã", "&auml;" => "ä", "&aring;" => "å", "&aelig;" => "æ", "&ccedil;" => "ç", "&egrave;" => "è", "&eacute;" => "é", "&ecirc;" => "ê", "&euml;" => "ë", "&igrave;" => "ì", "&iacute;" => "í", "&icirc;" => "î", "&iuml;" => "ï", "&eth;" => "ð", "&ntilde;" => "ñ", "&ograve;" => "ò", "&oacute;" => "ó", "&ocirc;" => "ô", "&otilde;" => "õ", "&ouml;" => "ö", "&divide;" => "÷", "&oslash;" => "ø", "&ugrave;" => "ù", "&uacute;" => "ú", "&ucirc;" => "û", "&uuml;" => "ü", "&yacute;" => "ý", "&thorn;" => "þ", "&yuml;" => "ÿ", "&OElig;" => "Œ", "&oelig;" => "œ", "&Scaron;" => "Š", "&scaron;" => "š", "&Yuml;" => "Ÿ", "&fnof;" => "ƒ", "&circ;" => "ˆ", "&tilde;" => "˜", "&Alpha;" => "Α", "&Beta;" => "Β", "&Gamma;" => "Γ", "&Delta;" => "Δ", "&Epsilon;" => "Ε", "&Zeta;" => "Ζ", "&Eta;" => "Η", "&Theta;" => "Θ", "&Iota;" => "Ι", "&Kappa;" => "Κ", "&Lambda;" => "Λ", "&Mu;" => "Μ", "&Nu;" => "Ν", "&Xi;" => "Ξ", "&Omicron;" => "Ο", "&Pi;" => "Π", "&Rho;" => "Ρ", "&Sigma;" => "Σ", "&Tau;" => "Τ", "&Upsilon;" => "Υ", "&Phi;" => "Φ", "&Chi;" => "Χ", "&Psi;" => "Ψ", "&Omega;" => "Ω", "&alpha;" => "α", "&beta;" => "β", "&gamma;" => "γ", "&delta;" => "δ", "&epsilon;" => "ε", "&zeta;" => "ζ", "&eta;" => "η", "&theta;" => "θ", "&iota;" => "ι", "&kappa;" => "κ", "&lambda;" => "λ", "&mu;" => "μ", "&nu;" => "ν", "&xi;" => "ξ", "&omicron;" => "ο", "&pi;" => "π", "&rho;" => "ρ", "&sigmaf;" => "ς", "&sigma;" => "σ", "&tau;" => "τ", "&upsilon;" => "υ", "&phi;" => "φ", "&chi;" => "χ", "&psi;" => "ψ", "&omega;" => "ω", "&thetasym;" => "ϑ", "&upsih;" => "ϒ", "&piv;" => "ϖ", "&ensp;" => " ", "&emsp;" => " ", "&thinsp;" => " ", "&zwnj;" => "‌", "&zwj;" => "‍", "&lrm;" => "‎", "&rlm;" => "‏", "&ndash;" => "–", "&mdash;" => "—", "&lsquo;" => "‘", "&rsquo;" => "’", "&sbquo;" => "‚", "&ldquo;" => "“", "&rdquo;" => "”", "&bdquo;" => "„", "&dagger;" => "†", "&Dagger;" => "‡", "&bull;" => "•", "&hellip;" => "…", "&permil;" => "‰", "&prime;" => "′", "&Prime;" => "″", "&lsaquo;" => "‹", "&rsaquo;" => "›", "&oline;" => "‾", "&frasl;" => "⁄", "&euro;" => "€", "&image;" => "ℑ", "&weierp;" => "℘", "&real;" => "ℜ", "&trade;" => "™", "&alefsym;" => "ℵ", "&larr;" => "←", "&uarr;" => "↑", "&rarr;" => "→", "&darr;" => "↓", "&harr;" => "↔", "&crarr;" => "↵", "&lArr;" => "⇐", "&uArr;" => "⇑", "&rArr;" => "⇒", "&dArr;" => "⇓", "&hArr;" => "⇔", "&forall;" => "∀", "&part;" => "∂", "&exist;" => "∃", "&empty;" => "∅", "&nabla;" => "∇", "&isin;" => "∈", "&notin;" => "∉", "&ni;" => "∋", "&prod;" => "∏", "&sum;" => "∑", "&minus;" => "−", "&lowast;" => "∗", "&radic;" => "√", "&prop;" => "∝", "&infin;" => "∞", "&ang;" => "∠", "&and;" => "∧", "&or;" => "∨", "&cap;" => "∩", "&cup;" => "∪", "&int;" => "∫", "&there4;" => "∴", "&sim;" => "∼", "&cong;" => "≅", "&asymp;" => "≈", "&ne;" => "≠", "&equiv;" => "≡", "&le;" => "≤", "&ge;" => "≥", "&sub;" => "⊂", "&sup;" => "⊃", "&nsub;" => "⊄", "&sube;" => "⊆", "&supe;" => "⊇", "&oplus;" => "⊕", "&otimes;" => "⊗", "&perp;" => "⊥", "&sdot;" => "⋅", "&lceil;" => "⌈", "&rceil;" => "⌉", "&lfloor;" => "⌊", "&rfloor;" => "⌋", "&lang;" => "〈", "&rang;" => "〉", "&loz;" => "◊", "&spades;" => "♠", "&clubs;" => "♣", "&hearts;" => "♥", "&diams;" => "♦" }
   end
-
-end
+
+  module Html
+    ENTITIES = { "&quot;" => "\"", "&amp;" => "&", "&lt;" => "<", "&gt;" => ">", "&nbsp;" => " ", "&iexcl;" => "¡", "&cent;" => "¢", "&pound;" => "£", "&curren;" => "¤", "&yen;" => "¥", "&brvbar;" => "¦", "&sect;" => "§", "&uml;" => "¨", "&copy;" => "©", "&ordf;" => "ª", "&laquo;" => "«", "&not;" => "¬", "&shy;" => "­", "&reg;" => "®", "&macr;" => "¯", "&deg;" => "°", "&plusmn;" => "±", "&sup2;" => "²", "&sup3;" => "³", "&acute;" => "´", "&micro;" => "µ", "&para;" => "¶", "&middot;" => "·", "&cedil;" => "¸", "&sup1;" => "¹", "&ordm;" => "º", "&raquo;" => "»", "&frac14;" => "¼", "&frac12;" => "½", "&frac34;" => "¾", "&iquest;" => "¿", "&Agrave;" => "À", "&Aacute;" => "Á", "&Acirc;" => "Â", "&Atilde;" => "Ã", "&Auml;" => "Ä", "&Aring;" => "Å", "&AElig;" => "Æ", "&Ccedil;" => "Ç", "&Egrave;" => "È", "&Eacute;" => "É", "&Ecirc;" => "Ê", "&Euml;" => "Ë", "&Igrave;" => "Ì", "&Iacute;" => "Í", "&Icirc;" => "Î", "&Iuml;" => "Ï", "&ETH;" => "Ð", "&Ntilde;" => "Ñ", "&Ograve;" => "Ò", "&Oacute;" => "Ó", "&Ocirc;" => "Ô", "&Otilde;" => "Õ", "&Ouml;" => "Ö", "&times;" => "×", "&Oslash;" => "Ø", "&Ugrave;" => "Ù", "&Uacute;" => "Ú", "&Ucirc;" => "Û", "&Uuml;" => "Ü", "&Yacute;" => "Ý", "&THORN;" => "Þ", "&szlig;" => "ß", "&agrave;" => "à", "&aacute;" => "á", "&acirc;" => "â", "&atilde;" => "ã", "&auml;" => "ä", "&aring;" => "å", "&aelig;" => "æ", "&ccedil;" => "ç", "&egrave;" => "è", "&eacute;" => "é", "&ecirc;" => "ê", "&euml;" => "ë", "&igrave;" => "ì", "&iacute;" => "í", "&icirc;" => "î", "&iuml;" => "ï", "&eth;" => "ð", "&ntilde;" => "ñ", "&ograve;" => "ò", "&oacute;" => "ó", "&ocirc;" => "ô", "&otilde;" => "õ", "&ouml;" => "ö", "&divide;" => "÷", "&oslash;" => "ø", "&ugrave;" => "ù", "&uacute;" => "ú", "&ucirc;" => "û", "&uuml;" => "ü", "&yacute;" => "ý", "&thorn;" => "þ", "&yuml;" => "ÿ", "&OElig;" => "Œ", "&oelig;" => "œ", "&Scaron;" => "Š", "&scaron;" => "š", "&Yuml;" => "Ÿ", "&fnof;" => "ƒ", "&circ;" => "ˆ", "&tilde;" => "˜", "&Alpha;" => "Α", "&Beta;" => "Β", "&Gamma;" => "Γ", "&Delta;" => "Δ", "&Epsilon;" => "Ε", "&Zeta;" => "Ζ", "&Eta;" => "Η", "&Theta;" => "Θ", "&Iota;" => "Ι", "&Kappa;" => "Κ", "&Lambda;" => "Λ", "&Mu;" => "Μ", "&Nu;" => "Ν", "&Xi;" => "Ξ", "&Omicron;" => "Ο", "&Pi;" => "Π", "&Rho;" => "Ρ", "&Sigma;" => "Σ", "&Tau;" => "Τ", "&Upsilon;" => "Υ", "&Phi;" => "Φ", "&Chi;" => "Χ", "&Psi;" => "Ψ", "&Omega;" => "Ω", "&alpha;" => "α", "&beta;" => "β", "&gamma;" => "γ", "&delta;" => "δ", "&epsilon;" => "ε", "&zeta;" => "ζ", "&eta;" => "η", "&theta;" => "θ", "&iota;" => "ι", "&kappa;" => "κ", "&lambda;" => "λ", "&mu;" => "μ", "&nu;" => "ν", "&xi;" => "ξ", "&omicron;" => "ο", "&pi;" => "π", "&rho;" => "ρ", "&sigmaf;" => "ς", "&sigma;" => "σ", "&tau;" => "τ", "&upsilon;" => "υ", "&phi;" => "φ", "&chi;" => "χ", "&psi;" => "ψ", "&omega;" => "ω", "&thetasym;" => "ϑ", "&upsih;" => "ϒ", "&piv;" => "ϖ", "&ensp;" => " ", "&emsp;" => " ", "&thinsp;" => " ", "&zwnj;" => "‌", "&zwj;" => "‍", "&lrm;" => "‎", "&rlm;" => "‏", "&ndash;" => "–", "&mdash;" => "—", "&lsquo;" => "‘", "&rsquo;" => "’", "&sbquo;" => "‚", "&ldquo;" => "“", "&rdquo;" => "”", "&bdquo;" => "„", "&dagger;" => "†", "&Dagger;" => "‡", "&bull;" => "•", "&hellip;" => "…", "&permil;" => "‰", "&prime;" => "′", "&Prime;" => "″", "&lsaquo;" => "‹", "&rsaquo;" => "›", "&oline;" => "‾", "&frasl;" => "⁄", "&euro;" => "€", "&image;" => "ℑ", "&weierp;" => "℘", "&real;" => "ℜ", "&trade;" => "™", "&alefsym;" => "ℵ", "&larr;" => "←", "&uarr;" => "↑", "&rarr;" => "→", "&darr;" => "↓", "&harr;" => "↔", "&crarr;" => "↵", "&lArr;" => "⇐", "&uArr;" => "⇑", "&rArr;" => "⇒", "&dArr;" => "⇓", "&hArr;" => "⇔", "&forall;" => "∀", "&part;" => "∂", "&exist;" => "∃", "&empty;" => "∅", "&nabla;" => "∇", "&isin;" => "∈", "&notin;" => "∉", "&ni;" => "∋", "&prod;" => "∏", "&sum;" => "∑", "&minus;" => "−", "&lowast;" => "∗", "&radic;" => "√", "&prop;" => "∝", "&infin;" => "∞", "&ang;" => "∠", "&and;" => "∧", "&or;" => "∨", "&cap;" => "∩", "&cup;" => "∪", "&int;" => "∫", "&there4;" => "∴", "&sim;" => "∼", "&cong;" => "≅", "&asymp;" => "≈", "&ne;" => "≠", "&equiv;" => "≡", "&le;" => "≤", "&ge;" => "≥", "&sub;" => "⊂", "&sup;" => "⊃", "&nsub;" => "⊄", "&sube;" => "⊆", "&supe;" => "⊇", "&oplus;" => "⊕", "&otimes;" => "⊗", "&perp;" => "⊥", "&sdot;" => "⋅", "&lceil;" => "⌈", "&rceil;" => "⌉", "&lfloor;" => "⌊", "&rfloor;" => "⌋", "&lang;" => "〈", "&rang;" => "〉", "&loz;" => "◊", "&spades;" => "♠", "&clubs;" => "♣", "&hearts;" => "♥", "&diams;" => "♦" }
+  end
+
+end

data/lib/gamefic/html_to_ansi.rb

@@ -0,0 +1,185 @@
+require 'gamefic/ansi'
+require 'gamefic/html'
+require 'io/console'
+
+module Gamefic
+
+  module HtmlToAnsi
+    include Ansi
+    include Ansi::Code
+
+    def html_to_ansi text, wrap: true, width: nil
+      return '' if text.strip == ''
+      output = ''
+      begin
+        doc = Html.parse("<body>#{text.strip}</body>")
+        format_recursively doc
+        texts = REXML::XPath.match(doc, './/text()')
+        output = texts.join('').gsub(/&apos;/, "'").gsub(/&quot;/, '"').gsub(/&lt;/, '<').gsub(/&gt;/, '>')
+        output += Ansi.graphics_mode(Attribute::NORMAL)
+        output = Html.decode(output)
+      rescue REXML::ParseException => e
+        output = Html.encode(text) + "\n\n"
+        #output = data
+      end
+      output.gsub!(/(\n\n)+/, "\n\n")
+      calc_width = size[0] || width
+      if calc_width.nil? or !wrap
+        output
+      else
+        terminalize(output, calc_width - 1)
+      end
+      output
+    end
+
+    private
+    
+    def format_recursively(top, stack = nil)
+      ol_index = 1
+      stack ||= [Attribute::NORMAL]
+      top.elements.each { |element|
+        formats = [Attribute::NORMAL]
+        classes = element.attribute('class').to_s.split(' ')
+        if classes.include?('hint')
+          formats.push Foreground::YELLOW
+        end
+        case element.name
+          when 'strong', 'b'
+            formats.push Attribute::BOLD
+          when 'em', 'i', 'u'
+            formats.push Attribute::UNDERSCORE
+          when 'a'
+            if element.attributes['rel'].to_s == 'gamefic'
+              element.attributes['href'] = element.attributes['href'][5..-1]
+              formats.push [Attribute::UNDERSCORE, Extra::COMMAND]
+            else
+              formats.push [Attribute::UNDERSCORE, Extra::HREF]
+            end
+          when 'li'
+            if top.name == 'ol'
+              element.text = "#{ol_index}. #{element.text}"
+              ol_index += 1
+            else
+              element.text = "* #{element.text}"
+            end
+            formats.push [Extra::LINE]
+          when 'img'
+            formats.push [Extra::IGNORED]
+          when 'body', 'p', 'ol', 'ul'
+            formats.push Extra::BLOCK
+          when 'pre'
+            formats.push [Extra::BLOCK, Extra::PRE]
+          when 'nav'
+            formats.push Extra::BLOCK
+          when 'h1', 'h2', 'h3', 'h4', 'h5'
+            formats.push [Attribute::BOLD, Extra::BLOCK, Extra::UPPERCASE]
+          when 'kbd'
+            formats.push [Foreground::GREEN]
+        end
+        if has_code?(stack, Extra::IGNORED)
+          element.parent.delete_element(element)
+        end
+        stack.push formats
+        if has_code?(stack, Extra::UPPERCASE)
+          element.texts.each { |text|
+            text.value.upcase!
+          }
+        end
+        element.texts.each { |text|
+          text.value = "#{Ansi.graphics_mode(*stack)}#{text.value}"
+        }
+        if has_code?(stack.last, Extra::IMAGE)
+          element.text = "#{element.attribute('alt') ? element.attribute('alt') : '[Image]'}"
+        end
+        format_recursively element, stack
+        if has_code?(stack.last, Extra::COMMAND)
+          if element.attribute('data-command').to_s != ''
+            tmp = stack.pop
+            element.add_text "#{Ansi.graphics_mode(*stack)}"
+            element.add_text " [#{element.attribute('data-command')}]"
+            stack.push tmp
+            element.add_text "#{Ansi.graphics_mode(*stack)}"
+          end
+        end
+        if has_code?(stack.last, Extra::BLOCK) and !has_code?(stack.last, Extra::PRE)
+          element.texts.first.value.lstrip! unless element.texts.first.nil?
+          element.texts.last.value.rstrip! unless element.texts.last.nil?
+          element.texts.each { |t|
+            t.value = t.value.gsub(/ +/, ' ').strip
+          }
+        end
+        if has_code?(stack.last, Extra::BLOCK)
+          element.add_text("\n\n")
+        elsif has_code?(stack.last, Extra::LINE)
+          if !has_code?(stack[-2], Extra::BLOCK) || element != top.elements.to_a.last
+            element.add_text("\n")
+          end
+        end
+        if has_code?(stack.last, Extra::HREF)
+          if element.attribute('href').to_s != "#"
+            tmp = stack.pop
+            element.add_text "#{Ansi.graphics_mode(*stack)}"
+            element.add_text(" [#{element.attribute('href')}]")
+            stack.push tmp
+            element.add_text "#{Ansi.graphics_mode(*stack)}"
+          end
+        end
+        if has_code?(stack.last, Extra::IMAGE)
+          element.add_text(" [#{element.attribute('src')}]")
+          if !has_code?(stack, Extra::BLOCK)
+            element.add_text("\n\n")
+          end
+        end
+        stack.pop
+      }
+    end
+    
+    def terminalize string, max_length
+      i = 0
+      output = ''
+      line_length = 0
+      while i < string.length
+        line_length += 1
+        char = string[i,1]
+        if char == "\e"
+          # Right now, graphics modes are the only supported ANSI sequences.
+          end_of_seq = string.index("m", i)
+          output += string[i..end_of_seq]
+          i = end_of_seq + 1
+        elsif char == " "
+          next_space = string.index(/[\s]/, i + 1)
+          if !next_space.nil? and line_length + (next_space - i) > max_length
+            output += "\n"
+            line_length = 0
+          else
+            output += char
+          end
+          i += 1
+        else
+          if char == "\n"
+            line_length = 0
+          end
+          output += char
+          i += 1
+        end
+      end
+      output #output.strip
+    end
+
+    def has_code?(fmt, code)
+      if fmt.kind_of?(Array)
+        return fmt.flatten.include?(code)
+      end
+      return fmt == code
+    end
+
+    def size
+      begin
+        return STDOUT.winsize.reverse
+      rescue
+        return [nil,nil]
+      end
+    end
+  end
+
+end

data/lib/gamefic/plot.rb

@@ -67,7 +67,7 @@ module Gamefic
     
     # Get an Array of all Actions defined in the Plot.
     #
-    # @return Array[Action]
+    # @return [Array<Action>]
     def actions
       @commands.values.flatten
     end
@@ -75,7 +75,7 @@ module Gamefic
     # Get an Array of all Actions associated with the specified verb.
     #
     # @param verb [Symbol] The Symbol for the verb (e.g., :go or :look)
-    # @return Array<Action> The verb's associated Actions
+    # @return [Array<Action>] The verb's associated Actions
     def actions_with_verb(verb)
       @commands[verb].clone || []
     end
@@ -202,30 +202,20 @@ module Gamefic
     # Update the Plot's current turn of gameplay.
     # This method is typically called by the Engine that manages game execution.
     def update
-      # Update the plot.
       @players.each { |player|
-        # TODO: This really doesn't belong here. We need a before_update in the plot.
-        @before_player_update_procs.each { |p|
-          p.call player
-        }
-	      this_scene = player.next_scene || player.scene
-	      player.prepare nil
-	      if this_scene != player.scene
-	        player.cue this_scene
-	        player.queue.shift
-	      else
+        @before_player_update_procs.each { |p| p.call player }
+        this_scene = player.next_scene || player.scene
+        player.prepare nil
+        if this_scene != player.scene
+          player.cue this_scene
+          player.queue.shift
+        else
           process_input player
         end
       }
-      @entities.each { |e|
-        e.update
-      }
-      @players.each { |player|
-        update_player player
-      }
-      @update_procs.each { |p|
-        p.call
-      }
+      @entities.each { |e| e.update }
+      @players.each { |player| update_player player }
+      @update_procs.each { |p| p.call }
     end
 
     def tell entities, message, refresh = false
@@ -294,13 +284,14 @@ module Gamefic
     end
     def rem_entity(entity)
       @entities.delete(entity)
+      @players.delete(entity)
     end
     def recursive_update(entity)
       entity.update
       entity.children.each { |e|
         recursive_update e
       }
-    end  
+    end
     def add_syntax syntax
       if @commands[syntax.verb] == nil
         raise "Action \"#{syntax.verb}\" does not exist."
@@ -317,12 +308,10 @@ module Gamefic
         else
           b.token_count <=> a.token_count
         end
-      }      
+      }
     end
     def add_action(action)
-      if (@commands[action.verb] == nil)
-        @commands[action.verb] = Array.new
-      end
+      @commands[action.verb] ||= []
       @commands[action.verb].unshift action
       @commands[action.verb].sort! { |a, b|
         if a.specificity == b.specificity
@@ -333,9 +322,12 @@ module Gamefic
           b.specificity <=> a.specificity
         end
       }
+      generate_default_syntax action
+    end
+    def generate_default_syntax action
       user_friendly = action.verb.to_s.gsub(/_/, ' ')
-      args = Array.new
-      used_names = Array.new
+      args = []
+      used_names = []
       action.queries.each { |c|
         num = 1
         new_name = ":var"

data/lib/gamefic/plot/scene_mount.rb

@@ -5,15 +5,19 @@ module Gamefic
 
   module Plot::SceneMount
     # Create a multiple-choice scene.
-    # The user will be required to make a valid choice to continue
+    # The user will be required to make a valid choice to continue.
     #
     # @yieldparam [Character]
-    # @yieldparam [String]
-    def multiple_choice key, options, &block
-      scenes[key] = Scene::MultipleChoice.new(
-        options: options,
-        finish: block
-      )
+    # @yieldparam [Scene::Data::MultipleChoice]
+    def multiple_choice key, *choices, &block
+      scenes[key] = Scene::MultipleChoice.new
+      scenes[key].on_start do |actor, data|
+        data.options.push *choices
+      end
+      scenes[key].on_finish do |actor, data|
+        block.call actor, data unless block.nil?
+        actor.cue :active if actor.scene == key and actor.next_scene.nil?
+      end
     end
     
     # Create a yes-or-no scene.
@@ -22,50 +26,113 @@ module Gamefic
     # @yieldparam [Character]
     # @yieldparam [String] "yes" or "no"
     def yes_or_no key, prompt = nil, &block
-      scenes[key] = Scene::YesOrNo.new(prompt, &block)
+      scenes[key] = Scene::YesOrNo.new
+      unless prompt.nil?
+        scenes[key].on_start do |actor, data|
+          data.prompt = prompt
+        end
+      end
+      scenes[key].on_finish &block
     end
     
-    # Create a scene with a prompt.
-    # This scene will use the provided block to process arbitrary input
-    # from the user.
-    #
-    # @param key [Symbol] A unique name for the scene.
-    # @param prompt [String] The input prompt to display to the user.
-    # @yieldparam [Character]
-    # @yieldparam [String]
-    def question key, prompt, &block
-      scenes[key] = Scene::Question.new prompt, &block
+    def question key, prompt = 'What is your answer?', &block
+      scenes[key] = Scene::Custom.new
+      scenes[key].on_start do |actor, data|
+        data.prompt = prompt
+      end
+      scenes[key].on_finish do |actor, data|
+        block.call actor, data unless block.nil?
+        actor.cue :active if actor.scene == key and actor.next_scene.nil?
+      end
     end
-    
+
     # Create a scene that pauses the game.
-    # This scene will execute the specified block and wait for input
-    # from the user (e.g., pressing Enter) to continue.
+    # This scene will execute the specified block and wait for input from the
+    # the user (e.g., pressing Enter) to continue.
     #
     # @param key [Symbol] A unique name for the scene.
+    # @param prompt [String] The text to display when prompting the user to continue.
     # @yieldparam [Character]
-    def pause key, &block
-      scenes[key] = Scene::Pause.new &block
+    # @yieldparam [Scene::Data::Base]
+    def pause key, prompt = nil, &block
+      scenes[key] = Scene::Pause.new
+      scenes[key].on_start do |actor, data|
+        data.prompt = prompt unless prompt.nil?
+        block.call actor, data unless block.nil?
+      end
+      scenes[key].on_finish do |actor, data|
+        actor.cue :active if actor.scene == key and actor.next_scene.nil?
+      end
     end
     
     # Create a conclusion.
-    # The game will end after this scene is complete.
+    # The game (or the character's participation in it) will end after this
+    # scene is complete.
     #
     # @param key [Symbol] A unique name for the scene.
     # @yieldparam [Character]
+    # @yieldparam [Scene::Data::Base]
     def conclusion key, &block
-      scenes[key] = Scene::Conclusion.new &block
+      scenes[key] = Scene::Conclusion.new
+      scenes[key].on_start &block
     end
     
-    # Create a generic scene.
-    # After the scene is complete, it will automatically start the next
-    # prepared scene, or the :active scene if none is prepared.
+    # Create a passive scene.
+    # Passive scenes will cue the active scene if another scene
+    # has not been prepared or cued.
     #
     # @param [Symbol] A unique name for the scene.
     # @yieldparam [Character]
-    def scene key, &block
-      scenes[key] = Scene::Passive.new &block
+    # @yieldparam [Scene::Data::Base]
+    def passive key, &block
+      scenes[key] = Scene::Custom.new
+      scenes[key].on_start do |actor, data|
+        block.call actor, data
+        actor.cue :active if actor.scene == key and actor.next_scene.nil?
+      end
     end
-    
+
+    # Create a custom scene.
+    #
+    # Custom scenes should always specify the next scene to be cued or
+    # prepared. If not, the scene will get repeated on the next turn.
+    #
+    # This method creates a Scene::Custom by default. You can customize other
+    # scene types by specifying the class to create.
+    #
+    # @example Ask the user for a name
+    #   scene :ask_for_name do |scene|
+    #     scene.on_start do |actor, data|
+    #       data.prompt = "What's your name?"
+    #     end
+    #     scene.on_finish do |actor, data|
+    #       actor.name = data.input
+    #       actor.tell "Hello, #{actor.name}!"
+    #       actor.cue :active
+    #     end
+    #   end
+    #
+    # @example Customize the prompt for a MultipleChoice scene
+    #   scene :ask_for_choice, Scene::MultipleChoice do |scene|
+    #     scene.on_start do |actor, data|
+    #       data.options.push 'red', 'green', 'blue'
+    #       data.prompt = "Which color?"
+    #     end
+    #     scene.on_finish do |actor, data|
+    #       actor.tell "You chose #{data.selection}"
+    #       actor.cue :active
+    #     end
+    #   end
+    #
+    # @param key [Symbol] A unique name for the scene.
+    # @param key [cls] The class of scene to be instantiated.
+    # @yieldparam [Scene::Custom] The instantiated scene.
+    def scene key, cls = Scene::Custom, &block
+      scenes[key] = cls.new
+      #block.call scenes[key]
+      yield scenes[key] if block_given?
+    end
+
     # Choose a new scene based on a list of options.
     # This is a specialized type of multiple-choice scene that determines
     # which scene to cue based on a Hash of choices and scene keys.
@@ -85,12 +152,12 @@ module Gamefic
     # @param key [Symbol] A unique name for the scene.
     # @param map [Hash] A Hash of options and associated scene keys.
     def multiple_scene key, map
-      scenes[key] = Scene::MultipleChoice.new(
-        options: map.keys,
-        finish: proc { |actor, input|
-          actor.cue map[input.choice]
+      scenes[key] = Scene::MultipleChoice.new
+      scenes[key].on_start do |actor, data|
+        map.each { |k, v|
+          data.map k, v
         }
-      )
+      end
     end
 
   end