fortune_teller 0.0.5 → 0.0.6

data/README.txt

@@ -1,5 +1,13 @@
-Total hack of a commandline Ruby version of an origami fortune teller:
-  http://en.wikipedia.org/wiki/Paper_fortune_teller
+What?
+  A total hack
+  A Ruby-based commandline version of an origami fortune-teller:
+    http://en.wikipedia.org/wiki/Paper_fortune_teller
+
+Why?
+ Cuz my kids were making paper fortune-tellers and I thought I'd
+ inspire them with a little computer-science
+ (so far they just like that I can change my fortune-teller faster than
+they can)
 
 To use it simply...
   install it:
@@ -27,6 +35,22 @@ At which point, you type your selection, followed by pressing the
 enter-key
 ...it's that easy.
 
+To integrate with your own code...
+  require 'fortune_teller'
+  
+  And have fun (see FortuneTeller::Game.run):
+
+   # array of array of strings
+   selection_groups = FortuneTeller::Game::DEFAULT_SELECTION_GROUPS.map(&:call)
+
+   # array of strings
+   fortunes = FortuneTeller::Game::DEFAULT_FORTUNES
+
+   # options include the :ui to use, default is CliUi
+
+   game = FortuneTeller::Game.new( selection_groups, fortunes, options )
+
+   game.run
+
 TODO:
-  custom fortune-teller
-  graphics
+  confirm (i.e. create proof-of-concept) that modularized & injected dependencies (i.e. :ui) work w/ Commandline, Ruby, Rubygame, etc...

data/bin/fortune_teller

@@ -8,4 +8,4 @@ rescue LoadError
   require_relative "../lib/fortune_teller"
 end
 
-FortuneTeller::Game.new.run
+FortuneTeller::Game.run

data/lib/fortune_teller.rb

@@ -1,62 +1,3 @@
-require_relative "fortune_teller/chooser"
+require_relative "fortune_teller/game"
 module FortuneTeller
-  class Game
-    def jail_reveal
-      Reveal.new( "Oops, you're in Jail!" )
-    end
-
-    def mud_reveal
-      Reveal.new( "Oops, you're in the mud!" )
-    end
-
-    def cookie_reveal
-      Reveal.new( "Wow, you get a cookie!" )
-    end
-
-    def final_choices
-      @final_choices ||= [
-        Panel.new( "blue", choice([jail_reveal, mud_reveal, cookie_reveal]) ),
-        Panel.new( "green", choice([jail_reveal, mud_reveal, cookie_reveal]) ),
-        Panel.new( "pink",  choice([jail_reveal, mud_reveal, cookie_reveal]) ),
-      ]
-    end
-
-    def final_choice_1
-      @final_choice_1 ||= choice(final_choices)
-    end
-
-    def final_choice_2
-      @final_choice_2 ||= choice(final_choices - [ final_choice_1 ])
-    end
-
-    def choice(choices)
-      choices[rand(choices.size)]
-    end
-
-    def level_three_chooser
-      Chooser.new( final_choice_1, final_choice_2 )
-    end
-
-    def level_two_chooser
-      Chooser.new(
-        Panel.new( "9", level_three_chooser ),
-        Panel.new( "7", level_three_chooser ),
-        Panel.new( "3", level_three_chooser ),
-        Panel.new( "5", level_three_chooser ),
-      )
-    end
-
-    def level_one_chooser
-      Chooser.new(
-        Panel.new( "bird", level_two_chooser ),
-        Panel.new( "dog", level_two_chooser ),
-        Panel.new( "chicken", level_two_chooser ),
-        Panel.new( "mouse", level_two_chooser )
-      )
-    end
-
-    def run
-      level_one_chooser.choose
-    end
-  end
 end

data/lib/fortune_teller/chooser.rb

@@ -3,16 +3,34 @@ require_relative "logger"
 module FortuneTeller
   class Chooser
     LOCATIONS = [ :tl, :tr, :bl, :br ]
+
+    def self.subset(list, num=list.size)
+      Logger.log("got list: #{list.inspect}, num: #{num.inspect}")
+      choices = list.dup
+      num.times.collect {|num|
+        reduce_choices!(choices)
+      }
+    end
+
+    def self.reduce_choices!( choices, by=random_choice(choices) )
+      choices.delete(by)
+    end
+
+    def self.random_choice(choices)
+      choices[rand(choices.size)]
+    end
+
     attr_reader :tl_panel, :tr_panel, :bl_panel, :br_panel
-    attr_reader :list_renderer
-    def initialize(_tl_panel, _tr_panel, _bl_panel = nil, _br_panel = nil, options = {})
+    attr_reader :list_renderer, :ui
+    def initialize(_tl_panel, _tr_panel, options = {})
+      @ui = options[:ui]
       @tl_panel = _tl_panel
       Logger.log "tl_panel: #{@tl_panel}"
       @tr_panel = _tr_panel
       Logger.log "tr_panel: #{@tr_panel}"
-      @bl_panel = _bl_panel || NilPanel.new
+      @bl_panel = options[:bl_panel] || NilPanel.new(@ui)
       Logger.log "bl_panel: #{@bl_panel}"
-      @br_panel = _br_panel || NilPanel.new
+      @br_panel = options[:br_panel] || NilPanel.new(@ui)
       Logger.log "br_panel: #{@br_panel}"
       @list_renderer = options[:list_renderer] || ListRenderer.new
       define_selection_aliases
@@ -52,32 +70,23 @@ module FortuneTeller
     def choose
       choice = nil
       begin
-        self.class.clear_screen
-        choice = self.class.prompt( list_renderer.render( selections | [:exit] ) )
+        ui.clear_screen
+        choice = ui.prompt( list_renderer.render( selections | [:exit] ) )
         Logger.log("got: #{choice.inspect}")
       end until( valid?( choice ) )
       Logger.log("trying it...")
-      self.class.clear_screen(1)
+      ui.clear_screen(1)
+      # need to unalias methods...
       send( choice )
     end
 
-    def self.clear_screen( after = 0 )
-      sleep( after )
-      puts "\e[H\e[2J"
-    end
-
     LOCATIONS.each do |location|
       define_method(location) {
-        send( "#{location}_panel" ).pick
+        send( "#{location}_panel" ).tap do |panel|
+          panel.pick
+        end
       }
     end
-
-    def self.prompt(text)
-      print text
-      gets.chomp.tap do |result|
-        puts
-      end
-    end
   end
 end
 require_relative "panel"

data/lib/fortune_teller/cli_ui.rb

@@ -0,0 +1,51 @@
+module FortuneTeller
+  class CliUi
+    DEFAULT_SOUND_FILE = 'flick_flick.ogg'.freeze
+    attr_reader :game, :sound_file
+    def initialize( options = {} )
+      @game = options[ :game ]
+      @sound_file = options[ :sound_file ] || DEFAULT_SOUND_FILE
+    end
+
+    def prompt(text)
+      print text
+      gets.chomp.tap do |result|
+        display
+      end
+    end
+
+    def exit( message = nil )
+      display( message )
+      Kernel.exit
+    end
+
+    def display( text = nil )
+      puts text
+    end
+
+    def interstitial( text )
+      display text
+      play
+      sleep(1.2)
+    end
+
+    def clear_screen( after = 0 )
+      sleep( after )
+      display "\e[H\e[2J"
+    end
+
+    def play
+      sound.play
+    end
+
+    def sound
+      @sound ||= begin
+                   require "rubygame"
+                   if defined?(Rubygame::Sound)
+                     Rubygame::Sound.load(sound_file)
+                   end
+                 rescue
+                 end
+    end
+  end
+end

data/lib/fortune_teller/game.rb

@@ -0,0 +1,101 @@
+require_relative "chooser"
+require_relative "cli_ui"
+module FortuneTeller
+  class Game
+    DEFAULT_SELECTION_GROUPS = [
+      lambda { Chooser.subset([ "dog", "chicken", "mouse", "cat", "dragon", "turtle", "tiger", "snake", "monkey" ], 4) },
+      lambda { Chooser.subset([ "3", "9", "5", "7", "10", "27", "100" ], 4) },
+      lambda { Chooser.subset([ "pink", "green", "blue", "yellow" ], 2) },
+    ].freeze
+
+    DEFAULT_FORTUNES = [
+      "Oops, you're in Jail!",
+      "Yuck, you're in the mud!",
+      "Wow, you get a cookie!",
+      "Ouch, you got bit!",
+      "Hey, you get a hug!",
+    ].freeze
+
+    def self.run( options = {} )
+      options[:selection_groups] ||= DEFAULT_SELECTION_GROUPS.map(&:call)
+      options[:fortunes] ||= DEFAULT_FORTUNES
+      new( options.delete(:selection_groups), options.delete(:fortunes), options ).run
+    end
+
+    attr_reader :selection_groups, :fortunes
+    attr_reader :chooser_class, :reveal_class, :panel_class
+    attr_reader :chooser_options
+    attr_reader :ui
+    def initialize( selection_groups, fortunes, options = {} )
+      @original_selection_groups = selection_groups
+      @original_fortunes = fortunes
+      
+      @ui = options[:ui] || CliUi.new(:game => self)
+
+      @chooser_class = options[:choose_class] || Chooser
+      @reveal_class = options[:reveal_class] || Reveal
+      @panel_class = options[:panel_class] || Panel
+      @chooser_options = options[:chooser_options] || {}
+      @chooser_options[:ui] ||= ui
+
+      reset
+    end
+
+    def restart
+      reset
+      run
+    end
+
+    def reset
+      @fortunes = @original_fortunes.dup
+      @selection_groups = @original_selection_groups.dup
+    end
+
+    def run
+      chooser_tree.choose
+    end
+
+
+    private
+
+    def fortune_reveals
+      @fortune_reveals ||= fortunes.map { |fortune|
+        reveal_class.new( fortune, :ui => ui )
+      }
+    end
+
+    def final_choices
+      @final_choices ||= selection_groups.pop.map { |selection|
+        Logger.log("fc-selection: #{selection.inspect}")
+        panel_class.new( selection, :reveal => chooser_class.reduce_choices!(fortune_reveals), :ui => ui )
+      }
+    end
+
+    def final_chooser
+      @final_chooser ||= chooser_class.new( chooser_class.reduce_choices!(final_choices), chooser_class.reduce_choices!(final_choices), chooser_options )
+    end
+
+    def chooser_tree
+      @chooser_tree ||= generate_choosers
+    end
+
+
+    def generate_choosers
+      choosers = [ final_chooser ]
+      begin
+        panels = []
+        if selection_group = selection_groups.pop
+          selection_group.each do |selection|
+            panels << panel_class.new( selection, :reveal => choosers.first, :ui => ui )
+          end
+        end
+        chooser_params = panels.pop, panels.pop
+        chooser_options[:bl_panel] = panels.pop if panels.first
+        chooser_options[:br_panel] = panels.pop if panels.first
+        chooser_params << chooser_options
+        choosers.unshift chooser_class.new( *chooser_params )
+      end until [] == selection_groups
+      return choosers.first
+    end
+  end
+end

data/lib/fortune_teller/nil_panel.rb

@@ -1,5 +1,9 @@
 module FortuneTeller
   class NilPanel
+    attr_reader :ui
+    def initialize(ui)
+      @ui = ui
+    end
     def to_s
       ""
     end
@@ -9,11 +13,11 @@ module FortuneTeller
     end
 
     def pick
-      Kernel.exit
+      ui.exit
     end
 
     def choose
-      Kernel.exit
+      ui.exit
     end
   end
 end

data/lib/fortune_teller/panel.rb

@@ -3,9 +3,11 @@ module FortuneTeller
   class Panel
     attr_reader :label
     attr_accessor :reveal
-    def initialize(_label, _reveal = nil )
-      @label = _label
-      @reveal = _reveal ||= NilPanel.new
+    attr_accessor :ui
+    def initialize(label, options = {} )
+      @label = label
+      @ui = options[:ui]
+      @reveal = options[:reveal] || NilPanel.new(@ui)
     end
     alias_method :to_s, :label
 
@@ -14,23 +16,10 @@ module FortuneTeller
     end
 
     def pick
-      puts "Flick, flick, flick, flick...\n"
-      sound.play
-      sleep(1.2)
+      ui.interstitial( "Flick, flick, flick, flick..." )
       reveal.choose
     end
 
-    private
-
-    def sound
-      @sound ||= begin
-                   require "rubygame"
-                   if defined?(Rubygame::Sound)
-                     Rubygame::Sound.load('flick_flick.ogg')
-                   end
-                 rescue
-                 end
-    end
   end
 end
 require_relative "reveal"

data/lib/fortune_teller/reveal.rb

@@ -1,8 +1,7 @@
 module FortuneTeller
   class Reveal < Panel
     def choose
-      puts self
-      exit
+      ui.exit( self.to_s )
     end
   end
 end

data/lib/fortune_teller/version.rb

@@ -1,3 +1,3 @@
 module FortuneTeller
-  VERSION = "0.0.5"
+  VERSION = "0.0.6"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fortune_teller
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-26 00:00:00.000000000 Z
+date: 2012-08-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rubygame
@@ -61,6 +61,8 @@ files:
 - fortune_teller.gemspec
 - lib/fortune_teller.rb
 - lib/fortune_teller/chooser.rb
+- lib/fortune_teller/cli_ui.rb
+- lib/fortune_teller/game.rb
 - lib/fortune_teller/list_renderer.rb
 - lib/fortune_teller/logger.rb
 - lib/fortune_teller/nil_panel.rb
@@ -82,7 +84,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3644824976486714964
+      hash: 3561951047884625826
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -91,7 +93,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3644824976486714964
+      hash: 3561951047884625826
 requirements: []
 rubyforge_project: fortune_teller
 rubygems_version: 1.8.24