ifrb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f165e1c66438091ed255557f44eed72ca9eaf219
+  data.tar.gz: 6f433a81afa77053b2b054b85bc166f42e8496b8
+SHA512:
+  metadata.gz: 8d727149c338ec392fb376fba3fdef7ad32202df0506b30852e15e654b27e90cb73146423a0c314ecf0a22e59e2c7feb05d04850e46ed29b82a0a5a4550aba49
+  data.tar.gz: 9941d5b139b9c3e09a4927518de2251b6bbf41459d310cbda65293d8b86797894703beb8bd59ce096995085158256eb46e6e1a70b73778d78a79b726fc292323

data/README.md

@@ -0,0 +1,74 @@
+# ifrb
+
+Interactive fiction (IF), for interactive Ruby (IRB). Play interactive fiction games from within the cozy familiarity of irb! Write stories that incorporate actual, executable Ruby code in the dialog!
+
+## Installation
+
+RubyGems is your friend:
+
+    $ gem install ifrb
+
+## Usage
+
+Try it with one of the examples:
+
+    $ ifrb basil
+
+Or, if you want to do it from within IRB directly:
+
+    $ irb
+    irb> require 'ifrb'
+    irb> ifrb "basil"
+
+## Writing Your Own Adventures
+
+Just create a new ruby file. You need at least one method, called `start`, which will be called when your adventure loads.
+
+    def start
+      # ...
+    end
+
+Define methods inside that method to add actions that are available for players. At the very least, you should add a method called `look`, which will be called when the room loads. The `look` method should describe the room:
+
+    def start
+      def look
+        _format <<-DESC
+          You see a big room. Not much else in here.
+        DESC
+      end
+
+      # ...
+    end
+
+Other rooms are defined as top-level methods:
+
+    def start
+      #...
+    end
+
+    def monster
+      def look
+        _format "Yuck! A monster!"
+      end
+      # ...
+    end
+
+Transition to rooms using the `_load_room` method:
+
+    def start
+      def north
+        _load_room :monster
+      end
+    end
+
+    def monster
+      # ...
+    end
+
+See the examples for more information about writing your own adventures. Good luck!
+
+## License
+
+Creative Commons Attribution 4.0 International License -- (c) Jamis Buck <jamis@jamisbuck.org>
+
+<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br /><span xmlns:dct="http://purl.org/dc/terms/" property="dct:title">IFRB</span> by <a xmlns:cc="http://creativecommons.org/ns#" href="http://github.com/jamis/ifrb" property="cc:attributionName" rel="cc:attributionURL">Jamis Buck</a> is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.<br />Based on a work at <a xmlns:dct="http://purl.org/dc/terms/" href="http://github.com/jamis/ifrb" rel="dct:source">http://github.com/jamis/ifrb</a>.

data/Rakefile

@@ -0,0 +1,7 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+Bundler::GemHelper.install_tasks

data/bin/ifrb

@@ -0,0 +1,29 @@
+#!/bin/sh ruby
+
+require "irb"
+
+game = ARGV.pop or abort "please specify the game you'd like to play"
+game = game.gsub(/\.rb$/, "")
+
+if !File.exists?("#{game}.rb")
+  ex_path = File.join(File.dirname(__FILE__), "..", "examples", game)
+  if File.exists?("#{ex_path}.rb")
+    game = ex_path
+  else
+    abort "no such game `#{game}'"
+  end
+end
+
+old_setup = IRB.method(:setup)
+IRB.singleton_class.send(:define_method, :setup) do |*args|
+  old_setup.call(*args)
+  old_rc = IRB.conf[:IRB_RC]
+  IRB.conf[:IRB_RC] = ->(context) do
+    old_rc[context] if old_rc
+    command = "ifrb #{game.inspect}\n"
+    command.reverse.chars.each { |c| context.irb.scanner.ungetc(c) }
+  end
+end
+
+ARGV.push "-rifrb"
+IRB.start(__FILE__)

data/examples/basil.rb

@@ -0,0 +1,305 @@
+WORDS = %w(wonky insipid squeak babushka cantilever intrepid flipper
+  periwinkle ewok munch gorgonzola ogle)
+
+def start
+  _format <<-DESC
+    "Confound that blasted..."
+
+    The dust swirles and settles to the gentle swearing of your master, Basil Smockwhitener (wizard and gentleman). Coughing, you push your way through to him, and find him trapped beneath a large fallen beam.
+
+    Try as you might, thought, it's too much for you to lift. Basil appears to be injured, but he shoos you away.
+
+    "Stop, Fabian," he says. "Just--stop. It's too heavy. Go on ahead and find the Magic Doohickie. We can use it to get this beam off me. It's the only way, now. No arguing! Just go!"
+
+    You shrug, recognizing that tone of voice, and resigned as usual. "Yes, sir. I'll see what I can find."
+
+  DESC
+
+  armor = Class.new { def ticklish?; false; end }
+
+  doohickie = Class.new do
+    attr_reader :magic_a, :magic_b, :magic_c
+
+    def initialize(a, b, c)
+      @magic_a = a
+      @magic_b = b
+      @magic_c = c
+    end
+
+    def ==(h)
+      magic_a == h.magic_a &&
+        magic_b == h.magic_b &&
+        magic_c == h.magic_c
+    end
+
+    def dup
+      puts "Yeah, you kinda wish it were that easy, eh?"
+      nil
+    end
+
+    alias clone dup
+  end
+
+  @__basil_freed = false
+  @__locked = true
+  @__armor = armor.new
+  @__armory_blocked = true
+  @__looted = false
+  @__doohickie = doohickie.new(rand(100), rand(100), rand(100))
+  @__setting_goal = rand(100)+1
+
+  undef start
+  basil
+end
+
+def basil
+  def look
+    if @__basil_freed
+      _format <<-DESC
+        Basil is free! You've done it! He's limping a bit, but he insists that it's nothing that a few cookies and a good night's rest won't cure. He gestures anxious to the south. "Let's go, Fabian!"
+      DESC
+    elsif @__looted
+      _format <<-DESC
+        You show Basil the Magic Doohickie and he breathes a sigh of relief. "You've done it, Fabian! Jolly good, old man! Now, just [adjust] the thing to the correct setting and get this beam off me. What? How should I know what the correct setting is? Just experiment. It's something between 1 and 100."
+      DESC
+    else
+      _format <<-DESC
+        What was formerly the ceiling now lies mostly on the floor, much of it unfortunately on your master, Basil. He gestures angrily at you to get moving. "Find the Doohickie!"
+
+        The passage goes south (to the exit), and north (towards the treasure chamber). Presumably, Basil wants you to go north.
+      DESC
+    end
+  end
+
+  def adjust(setting=0)
+    if !@__basil_freed && @__looted
+      if setting < @__setting_goal
+        _format "The doohickie grows cooler momentarily."
+      elsif setting > @__setting_goal
+        _format "The doohickie grows warmer momentarily."
+      else
+        @__basil_freed = true
+        _format <<-DESC
+          With a satisfying *thunk*, the beam that had trapped Basil disappears! He stands up, dusts himself off, and shakes your hand a bit more vigorously than you think the situation calls for. "Well done, man! You did it! Now, let's get out of here. To the south!"
+        DESC
+      end
+    else
+      _format "Adjust what? You're funny."
+    end
+  end
+
+  def south
+    if @__basil_freed
+      _load_room :escape
+    else
+      _format <<-DESC
+        Basil shouts angrily at you. "Not that way, you oaf! North! North! Get the Doohickie!" His mustaches are practically bristling.
+      DESC
+    end
+  end
+
+  def north
+    if @__basil_freed
+      _format <<-DESC
+        "What are you, a glutton for punishment?" Basil shakes his head in disbelief. "Come along, Fabian. South, man! Let's get out of here."
+      DESC
+    else
+      _load_room :lock
+    end
+  end
+end
+
+def lock
+  def look
+    if @__locked
+      _format <<-DESC
+        Not that you have much experience with looting abandoned treasure chambers or anything, but the pattern on the far wall looks a lot like a magical lock. Your hunch is borne out by a large sign above it that reads:
+
+        "This is a magical lock. You'll never figure it out. Only a real magician, one able to [invoke] a spell that takes a string and reverses it, will ever manage to unlock it."
+
+        Better get busy. The alternative is to go south again and tell Basil you failed. (Whew. That gives you chills just thinking about it.)
+      DESC
+    else
+      _format <<-DESC
+        There is a passage going north. This is because you successfully invoked the spell that unlocked it. Good for you! Basil would be so proud. Assuming he noticed.
+
+        Oh, speaking of that. You can also go south, back to Basil.
+      DESC
+    end
+  end
+
+  def south
+    _load_room :basil
+  end
+
+  def north
+    if @__locked
+      _format <<-DESC
+        What, through a magically locked door? You might try opening it first. Although, you'll need to unlock it before you can open it. Have you tried [invoke] yet?
+      DESC
+    else
+      _load_room :armory
+    end
+  end
+
+  def invoke(spell=nil, &block)
+    if spell.nil? && !block
+      _format <<-DESC
+        Nothing happens, and it does so in a surprisingly uninspiring way. (Maybe you should provide the spell you want to cast? Perhaps as a lambda, or a block? But I'm just the narrator. What would I know about magic?)
+      DESC
+    elsif spell && !spell.respond_to?(:call)
+      _format "Um. I'm no expert, mind, but that doesn't look like a spell."
+    else
+      spell ||= block
+      words = WORDS.shuffle[0,5]
+
+      _format "Right. Let's see if this cantrip works. I'll just plug in a few words here..."
+      success = words.all? do |word|
+          result = spell[word]
+          puts "    - `#{word}' becomes `#{result}'..."
+          word.reverse == result
+        end
+
+      if success
+        @__locked = false
+        _format "What the..?! You did it! A passage opens to the north!"
+      else
+        _format "Hmm. That's not quite right. Maybe you should have another go?"
+      end
+    end
+  end
+end
+
+def armory
+  def look
+    if @__armory_blocked
+      _format <<-DESC
+        The walls of this room are covered with exotic (and ancient-looking) weapons. Suits of armor are arranged haphazardly on stands, with one particularly imposing specimen standing--eerily life-like--right in front a door to the north. On its tabard is written the words:
+
+        "Tickle me. I dare you."
+
+        The only other exit is to the south.
+      DESC
+    else
+      _format <<-DESC
+        Aside from all the weapons and armor arranged around the walls, a large suit of armor lies prone on the floor.
+
+        One passage lies open to the north, and another to the south.
+      DESC
+    end
+  end
+
+  def south
+    _load_room :lock
+  end
+
+  def north
+    if @__armory_blocked
+      _format <<-DESC
+        You think so, do you? Even with that big suit of armor daring you to tickle it?
+      DESC
+    else
+      _load_room :treasury
+    end
+  end
+
+  def tickle(what=:armor)
+    if what == :armor
+      if @__armor.ticklish?
+        @__armory_blocked = false
+
+        def tickle(what=:armor)
+          _format "No need for more tickling. The armor is defunct!"
+        end
+
+        _format <<-DESC
+          You boldly start scratching the suit along its sides, viciously making baby noises while watching the suit's arms. Hollowly, from deep within the armor, a tinny-sounding giggling begins. It grows in volume like the Doppler effect with poor AM reception until the suit's arms start flailing helplessly and the armor falls to the floor.
+
+          As you back away, the giggling slowly fades, leaving nothing but rather unsettling echoes.
+
+          The passage to the north is unblocked!
+        DESC
+      else
+        _format <<-DESC
+          You reach out hesitantly and poke the suit of armor about where its belly button ought to be. Feeling faintly ridiculous, you add, "goochie goochie goo."
+
+          One of the suit's arms suddenly holds up a sign that reads, "Sorry. #ticklish? == false," before the other blindsides you and knocks you to the floor. By the time you stand up again, the armor has reset.
+
+          Hmm. Maybe you ought to try to [enhance] the armor with a module that makes it [ticklish?]
+        DESC
+      end
+    else
+      _format "That's a rather odd thing to tickle."
+    end
+  end
+
+  def enhance(mod)
+    if @__armory_blocked
+      @__armor.extend(mod)
+      _format "Your enhancement settles experimentally onto the armor. Maybe try tickling it now?"
+    else
+      _format "The armor is nonfunctional, now. Enhancing it won't do anything."
+    end
+  end
+end
+
+def treasury
+  def look
+    if @__looted
+      _format <<-DESC
+        The fake Magic Doohickie looks pretty convincing there on its pedestal. Perhaps you should go rescue Basil now that yo uhave the real one. Go south!
+      DESC
+    else
+      _format <<-DESC
+        This is it! The treasury, containing the ancient and mysterious Magic Doohickie of Hank Doolickie! Its rumored powers are many, and its rumored guardians are...well...many, also. Somehow, you need to [swap] it with an identical [doohickie], so that the guards won't realize it's been taken.
+
+        Or, you can give up and go south. Quitter.
+      DESC
+    end
+  end
+
+  def doohickie
+    @__doohickie
+  end
+
+  def south
+    _load_room :armory
+  end
+
+  def swap(a, b)
+    if @__looted
+      _format "Wait, don't do that! You've already pulled off the heist!"
+    elsif a.equal?(b)
+      _format "What are you trying to pull? You can't swap a thing with itself!"
+    else
+      a, b = b, a if b == @__doohickie
+      if a == @__doohickie
+        if a == b
+          @__looted = true
+          @__my_doohickie, @__doohickie = a, b
+          _format <<-DESC
+            Whoa! That was tricky! You totally swapped your fake for the real deal! This means...wait. This means you can go free Basil, now! Quickly, head south!
+          DESC
+        else
+          _format <<-DESC
+            Hmm...those don't quite look equivalent. I suspect something really, really, really, really, really, really, really bad would happen if you actually tried swapping them. Can you make your fake one look anything more like the real [doohickie]?
+          DESC
+        end
+      else
+        _format "That's...odd. Try that again, this time with the [doohickie]."
+      end
+    end
+  end
+end
+
+def escape
+  def look
+    _format <<-DESC
+      You've done it! You recovered the Magic Doohickie, rescued Basil, and capped it all of with a daring escape. Well, maybe not *daring*. But an escape, nonetheless.
+
+      Well done!
+    DESC
+
+    quit
+  end
+end

data/lib/ifrb.rb

@@ -0,0 +1,66 @@
+if !defined? IRB
+  abort "ifrb will only work within an IRB session"
+end
+
+IRB.conf[:PROMPT][:IFRB] = {
+  :PROMPT_I => "%N> ",  # "initial" prompt
+  :PROMPT_C => "..",    # continued command
+  :PROMPT_S => "..",    # continued string
+  :PROMPT_N => "..",    # nested command
+  :RETURN => ""         # formatting for return values
+}
+
+def ifrb(game)
+  context.prompt_mode = :IFRB
+
+  class <<self
+    def method_missing(sym, *args)
+      if args.empty?
+        sym
+      else
+        super
+      end
+    end
+  end
+
+  def _load_room(name)
+    context.irb_name = name
+
+    (methods - @_baseline).each do |method|
+      eval "undef #{method}"
+    end
+
+    send(name)
+
+    look if respond_to?(:look)
+  end
+
+  def _format(text, length:60, indent:2)
+    indent = " " * indent
+
+    text.each_line do |line|
+      line.strip!
+
+      if line.empty?
+        puts
+      else
+        while line.length > length
+          break_at = length
+          break_at -= 1 while break_at > 0 && line[break_at] != " "
+          break_at = length if break_at == 0
+          puts indent + line[0, break_at]
+          line = line[break_at+1..-1]
+        end
+
+        puts indent + line if line.length > 0
+      end
+    end
+
+    nil
+  end
+
+  load "#{game}.rb"
+  @_baseline = methods
+
+  _load_room :start
+end

data/lib/ifrb/version.rb

@@ -0,0 +1,9 @@
+module IFRB
+  module Version
+    MAJOR = 1
+    MINOR = 0
+    TINY  = 0
+
+    STRING = [MAJOR, MINOR, TINY].join(".")
+  end
+end

metadata

@@ -0,0 +1,52 @@
+--- !ruby/object:Gem::Specification
+name: ifrb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Jamis Buck
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-10-17 00:00:00.000000000 Z
+dependencies: []
+description: We spend much of our professional lives in IRB. Why not make a game of
+  it?
+email:
+- jamis@jamisbuck.org
+executables:
+- ifrb
+extensions: []
+extra_rdoc_files: []
+files:
+- README.md
+- Rakefile
+- bin/ifrb
+- examples/basil.rb
+- lib/ifrb.rb
+- lib/ifrb/version.rb
+homepage: http://github.com/jamis/ifrb
+licenses:
+- CC4.0
+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.4.5
+signing_key: 
+specification_version: 4
+summary: A system for running interactive fiction games within IRB.
+test_files: []