shoes 3.0.1 → 4.0.0.pre1

data/lib/shoes/timer.rb

@@ -0,0 +1,10 @@
+class Shoes
+  class Timer
+    def initialize app, n=1000, &blk
+      @app, @n, @blk = app, n, blk
+      @gui = Shoes.configuration.backend_for(self, @app.gui, @blk)
+    end
+    
+    attr_reader :n, :gui
+  end
+end

data/lib/shoes/url.rb

@@ -0,0 +1,47 @@
+class Shoes
+
+  # Backwards compatibility, kind of likely to be removed
+  def self.inherited(base_class)
+    base_class.send :include, URL #include is private, therefore send
+  end
+
+  module URL
+    extend Forwardable
+
+    def_delegators :app, *(Shoes::App::DELEGATE_METHODS)
+
+    attr_accessor :app
+
+    def self.included(base_class)
+      base_class.extend URLDefiner
+    end
+
+    def self.urls
+      @urls ||= {}
+    end
+
+  end
+
+  module URLDefiner
+    def url(page, method)
+      page = convert_page_to_regex(page)
+      url_class = self
+
+      Shoes::URL.urls[page] = proc do |app, arg|
+        new_url_instance = url_class.new
+        new_url_instance.app = app
+
+        if arg
+          new_url_instance.send(method, arg)
+        else
+          new_url_instance.send method
+        end
+      end
+    end
+
+    private
+    def convert_page_to_regex(page)
+      /^#{page}$/
+    end
+  end
+end

data/lib/shoes/version.rb

@@ -1,3 +1,3 @@
 class Shoes
-  VERSION="3.0.1"
+  VERSION = "4.0.0.pre1"
 end

data/lib/shoes/widget.rb

@@ -0,0 +1,73 @@
+class Shoes
+  # This is the superclass for creating custom Shoes widgets.
+  #
+  # To use, inherit from {Shoes::Widget}. You get a few magical effects:
+  #
+  # * When you inherit from {Shoes::Widget}, you get a method in your Apps to
+  #   create your widgets. The method is lower- and snake-cased. It returns
+  #   an instance of your widget class.
+  # * Your widgets delegate missing methods to their app object. This
+  #   allows you to use the Shoes DSL within your widgets.
+  #
+  # @example
+  #   class SayHello < Shoes::Widget
+  #     def initialize word
+  #       para "Hello #{word}", stroke: green, size: 80
+  #     end
+  #   end
+  #
+  #   Shoes.app do
+  #     say_hello 'Shoes'
+  #   end
+  #
+  class Widget
+    extend Forwardable
+
+    # Delegate missing methods to app, so you can use the Shoes DSL
+    # inside the widget.
+    def_delegators :app, *Shoes::App::DELEGATE_METHODS
+
+    attr_accessor :parent
+    attr_writer   :app
+
+    class << self
+      attr_accessor :app
+    end
+
+    # lookup a bit more complicated as during initialize we do
+    # not have @app yet...
+    def app
+      @app || self.class.app
+    end
+
+    def self.inherited(klass, &blk)
+      dsl_method = dsl_method_name(klass)
+      Shoes::App.class_eval do
+        define_method(dsl_method) do |*args, &blk|
+          # we set app 2 times because widgets execute most of their code
+          # straight in initialize. I dunno if there is a good way of setting
+          # an @app instance variable before initialize is executed. We could
+          # hand it over in #initialize but that would break the interface
+          # and people would have to set it themselves or make sure to call
+          # super so for not it's like this.
+          # Setting the ref on the instance is important as we might have
+          # instances of the same widget in different Shoes::Apps so each one
+          # needs to save the reference to the one it was started with
+          klass.app              = self
+          widget_instance        = klass.new(*args, &blk)
+          widget_instance.app    = self
+          widget_instance.parent = @__app__.current_slot
+          widget_instance
+        end
+      end
+    end
+
+
+    private
+    def self.dsl_method_name(klass)
+      klass.to_s[/(^|::)(\w+)$/, 2].
+        gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').
+        gsub(/([a-z\d])([A-Z])/,'\1_\2').downcase
+    end
+  end
+end

data/samples/README

@@ -0,0 +1,86 @@
+  # Here's a list of the samples in this directory that work. Please
+# add to this list as you implement features!
+#
+# NOTE: Comment out anything that isn't a filename, so we can execute this list.
+#       See the `rake samples` task
+
+simple-anim-shapes.rb
+simple-animate.rb
+simple-arc.rb
+simple-bounce.rb
+simple-brightness-transitions.rb
+simple-button-animate.rb
+simple-calc.rb
+simple-calc-2.rb
+simple-color-selector.rb
+simple-color-transitions.rb
+simple-curve.rb
+simple-dialogs.rb
+simple-dialogs-outside.rb
+simple-displace.rb
+simple-downloader.rb
+simple-draw.rb
+simple-editor.rb
+simple-face.rb
+simple-flow-wrap.rb
+simple-font.rb
+simple-fullscreen.rb
+simple-guess-game.rb
+simple-keypress.rb
+simple-manual.rb
+simple-mouse-follow.rb
+simple-move.rb # (works but looks a bit weird on Linux, see issue #59)
+simple-oval.rb
+simple-sample-executor.rb
+simple-shoes-intro.rb
+simple-sound.rb
+simple-stripes.rb
+simple-timer.rb
+
+good-arc.rb
+good-clock.rb
+good-clock-adjusted.rb
+good-follow.rb
+good-potato-chopping.rb
+good-reminder.rb
+# good-vjot.rb see #255
+
+expert-definr.rb
+expert-game-of-life-adjusted.rb
+# expert-irb-adjusted.rb
+expert-minesweeper-adjusted.rb
+# expert-othello-adjusted.rb
+expert-pong.rb
+expert-snake.rb
+expert-tankspank.rb
+
+# examples from the nobody knows shoes book
+nks_poem.rb
+
+
+class-book-adjusted.rb
+
+sample1.rb
+sample2.rb
+sample3.rb
+sample4.rb
+sample6.rb
+sample7.rb
+sample8.rb
+sample9.rb
+sample12.rb
+sample13.rb
+sample14.rb
+sample15.rb
+sample16.rb
+sample17.rb
+sample21.rb
+sample23.rb
+sample24.rb
+sample27.rb
+sample31.rb
+sample34.rb
+sample35.rb
+sample37.rb
+sample42.rb
+sample45.rb

data/samples/class-book-adjusted.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+
+class Book < Shoes
+  url '/', :index
+  url '/incidents/(\d+)', :incident
+
+  def index
+    incident 0
+  end
+
+  INCIDENTS = YAML.load_file File.join(Shoes::DIR, 'samples/class-book.yaml')
+
+  def table_of_contents
+    toc = []
+    INCIDENTS.each_with_index do |(title, story), i|
+      toc.push "(#{i + 1}) ",
+        link(title){visit "/incidents/#{i}"},
+        " / "
+    end
+    toc[0...-1] << "\n"*5
+  end
+
+  def incident num
+    self.scroll_top = 0
+    num = num.to_i
+    stack  margin_left: 200 do
+      banner "Incident", margin: [0, 10, 0, 30]
+      para strong("No. #{num + 1}: #{INCIDENTS[num][0]}"), margin_bottom: 5
+    end
+
+    flow do
+      flow width: 180, margin_left: 10 do
+        para  *table_of_contents, size: 8
+      end
+
+      stack width: width-180, margin: [20, 0, 10, 0] do
+        INCIDENTS[num][1].split(/\n\n+/).each do |p|
+          para p
+        end
+      end
+    end
+  end
+end
+
+Shoes.app width: 640, height: 700, title: "Incidents, a Book"

data/samples/class-book.rb

@@ -8,13 +8,13 @@ class Book < Shoes
     incident(0)
   end
 
-  INCIDENTS = YAML.load_file('class-book.yaml')
+  INCIDENTS = YAML.load_file('samples/class-book.yaml')
 
   def table_of_contents
     toc = []
     INCIDENTS.each_with_index do |(title, story), i|
       toc.push "(#{i + 1}) ",
-        link(title, :click => "/incidents/#{i}"),
+        link(title, click: "/incidents/#{i}"),
         " / "
     end
     toc.pop
@@ -24,14 +24,14 @@ class Book < Shoes
   def incident(num)
     num = num.to_i
     background white
-    stack :margin => 10, :margin_left => 190, :margin_top => 20 do
-      banner "Incident", :margin => 4
-      para strong("No. #{num + 1}: #{INCIDENTS[num][0]}"), :margin => 4
+    stack margin: 10, margin_left: 190, margin_top: 20 do
+      banner "Incident", margin: 4
+      para strong("No. #{num + 1}: #{INCIDENTS[num][0]}"), margin: 4
     end
-    flow :width => 180, :margin_left => 10, :margin_top => 0 do
-      para table_of_contents, :size => 8
+    flow width: 180, margin_left: 10, margin_top: 0 do
+      para table_of_contents, size: 8
     end
-    stack :width => -190, :margin => 10, :margin_top => 0 do
+    stack margin: 10, margin_top: 0 do
       INCIDENTS[num][1].split(/\n\n+/).each do |p|
         para p
       end
@@ -39,5 +39,5 @@ class Book < Shoes
   end
 end
 
-Shoes.app :width => 640, :height => 700,
-  :title => "Incidents, a Book"
+Shoes.app width: 640, height: 700,
+  title: "Incidents, a Book"

data/samples/expert-definr.rb

@@ -1,8 +1,8 @@
-Shoes.app :title => "Dictionary, powered by Definr", :width => 370, :height => 320 do
+Shoes.app title: "Dictionary, powered by Definr", width: 370, height: 320 do
   stack do
-    background red, :height => 60
-    flow :margin => 20 do
-      caption "Define: ", :stroke => white
+    background red, height: 60
+    flow margin: 20 do
+      caption "Define: ", stroke: white
       @lookup = edit_line
       button "Go" do
         download "http://definr.com/definr/show/#{@lookup.text}" do |dl|
@@ -15,8 +15,8 @@ Shoes.app :title => "Dictionary, powered by Definr", :width => 370, :height => 3
         end
       end
     end
-    stack :margin => 20 do
-      @deft = subtitle "", :margin => 10
+    stack margin: 20 do
+      @deft = subtitle "", margin: 10
       @defn = para ""
     end
   end

data/samples/expert-funnies.rb

@@ -1,10 +1,16 @@
-require 'hpricot'
+# This example tries Nokogiri (used in Shoes 4), but falls back to
+# Hpricot for Shoes 3 compatibility
+begin
+  require 'nokogiri'
+rescue Exception => e
+  require 'hpricot'
+end
 
 class Comic
   attr_reader :rss, :title
 
   def initialize(body)
-    @rss = Hpricot.XML(body)
+    @rss = defined?(Nokogiri) ? Nokogiri::XML(body) : Hpricot(body)
     @title = @rss.at("//channel/title").inner_text
   end
 
@@ -17,33 +23,36 @@ class Comic
   end
 end
 
-Shoes.app :width => 800, :height => 600 do
+Shoes.app width: 800, height: 600 do
   background "#555"
 
   @title = "Web Funnies"
   @feeds = [
     "http://xkcd.com/rss.xml",
-    "http://feedproxy.google.com/DilbertDailyStrip?format=xml",
+    # No longer contains images
+    #"http://feedproxy.google.com/DilbertDailyStrip?format=xml",
     "http://www.smbc-comics.com/rss.php",
     "http://www.daybydaycartoon.com/index.xml",
     "http://www.questionablecontent.net/QCRSS.xml",
     "http://indexed.blogspot.com/feeds/posts/default?alt=rss"
     ]
 
-  stack :margin => 10 do
-    title strong(@title), :align => "center", :stroke => "#DFA", :margin => 0
-    para "(loaded from RSS feeds)", :align => "center", :stroke => "#DFA",
-      :margin => 0
+  stack margin: 10 do
+    title strong(@title), align: "center", stroke: "#DFA", margin: 0
+    para "(loaded from RSS feeds)", align: "center", stroke: "#DFA",
+      margin: 0
 
     @feeds.each do |feed|
       download feed do |dl|
-        stack :width => "100%", :margin => 10, :border => 1 do
-          c = Comic.new dl.response.body
-          stack :margin_right => gutter do
-            background "#333", :curve => 4
-            caption c.title, :stroke => "#CD9", :margin => 4
+        stack width: "100%", margin: 10, border: 1 do
+          # Fall back to Shoes 3 syntax if necessary
+          body = dl.respond_to?(:read) ? dl.read : dl.response.body
+          c = Comic.new body
+          stack margin_right: gutter do
+            background "#333", curve: 4
+            caption c.title, stroke: "#CD9", margin: 4
           end
-          image c.latest_image.first, :margin => 8
+          image c.latest_image.first, margin: 8
         end
       end
     end

data/samples/expert-game-of-life-adjusted.rb

@@ -0,0 +1,249 @@
+# Simple Game of Life with Shoes
+# by fuksito
+# vitaliy@yanchuk.me
+
+
+class Cell
+  WIDTH = 15
+  attr_accessor :live, :next_state, :y, :x, :neighbours, :live_neighbours, :app, :shoes_cell
+
+  def initialize(y, x, app, world)
+    @live = false
+    @next_state = false
+    @y = y
+    @x = x
+    @app = app
+    @world = world
+    @shoes_cell = @app.rect(left: WIDTH * y, top: WIDTH * x, width: WIDTH)
+    @shoes_cell.click{ toggle_state }
+  end
+
+  def live?
+    @live
+  end
+
+  def dead?
+    !@live
+  end
+
+  def die!
+    @next_state = false
+    @world.changed_cells.push(self)
+  end
+
+  def alive!
+    @next_state = true
+    @world.changed_cells.push(self)
+  end
+
+  def toggle_state
+    @next_state = !@live
+    set_next_state
+    draw
+  end
+
+  def set_next_state
+    if @live = @next_state
+      @world.live_cells.push(self)
+    else
+      cell_index = @world.live_cells.index(self)
+      if cell_index
+        @world.live_cells.delete_at(cell_index)
+      end
+    end
+  end
+
+  def draw
+    fill = live? ? '#000000' : '#ffffff'
+
+    # TODO: Stop needing to be so cautious once #651 resolves our perf woes
+    if @shoes_cell.fill.hex != fill
+      @shoes_cell.style(fill: fill)
+    end
+  end
+
+  def iterate
+    live_cells_count = @neighbours.count{|c| c.live? }
+    if live?
+      if live_cells_count < 2 || live_cells_count > 3
+        die!
+      end
+    else
+      if live_cells_count == 3
+        alive!
+      end
+    end
+  end
+end
+
+class World
+  attr_accessor :board, :width, :height, :live_cells, :changed_cells
+
+  def initialize(width, height, app)
+    @board = []
+    @width = width
+    @height = height
+    @app = app
+    @live_cells = []
+    @changed_cells = []
+    create_board
+  end
+
+  def create_board
+    @height.times do |y|
+      @board[y] = []
+      @width.times do |x|
+        @board[y][x] = Cell.new(y, x, @app, self)
+      end
+    end
+    cells.each do |cell|
+      cell.neighbours = cell_neighbours(cell.y, cell.x)
+    end
+    draw
+  end
+
+  def cells
+    @cells ||= @board.flatten
+  end
+
+  def actual_cells
+    (@live_cells.map(&:neighbours).flatten + @live_cells).uniq
+  end
+
+  def draw
+    cells.each{|c| c.draw }
+  end
+
+  def tick
+    @changed_cells = []
+    actual_cells.each{|c| c.iterate }.each{|c| c.set_next_state }
+    @changed_cells.each{|c| c.draw }
+  end
+
+  def clear
+    live_cells.each do |cell|
+      cell.live = false
+      cell.next_state = false
+      cell.draw
+    end
+  end
+
+  def cell_neighbours(y,x)
+    result = []
+    top_row = y - 1
+    left_col = x - 1
+    right_col = x + 1
+    bottom_row = y + 1
+
+    if top_row >= 0 && left_col >= 0
+      result << @board[y-1][x-1]
+    end
+
+    if top_row >= 0
+      result << @board[y-1][x]
+    end
+
+    if top_row >= 0 && right_col < @width
+      result << @board[y-1][x+1]
+    end
+
+    if left_col >= 0
+      result << @board[y][x-1]
+    end
+
+    if right_col < @width
+      result << @board[y][x+1]
+    end
+
+    if bottom_row < @height && left_col >= 0
+      result << @board[y+1][x-1]
+    end
+
+    if bottom_row < @height
+      result << @board[y+1][x]
+    end
+
+    if bottom_row < @height && right_col < @width
+      result << @board[y+1][x+1]
+    end
+
+    result.compact
+  end
+
+  def add_specie(*cells)
+    cells.each do |y,x|
+      @board[y][x].toggle_state
+    end
+  end
+
+  def add_glinder
+    add_specie [4,2], [4,3], [4,4], [3,4], [2,3]
+  end
+
+  def add_spaceship
+    add_specie [12,3], [12,6], [13,7], [14,3], [14,7], [15,4], [15,5], [15,6], [15,7]
+  end
+
+  def add_diehard
+    add_specie [18,12], [12,13], [13,13], [13,14], [17,14], [18,14], [19,14]
+  end
+end
+
+Shoes.app(title: "The Game of Life", width: 800, height: 620, resizable: false) do
+  background white
+  @animate = false
+  stack(margin: 10) do |board_holder|
+    @new_world = World.new(40, 40, self)
+    animate(10) do |frame|
+      if @animate
+        @new_world.tick
+      end
+    end
+  end
+
+  def play
+    @animate = true
+    @run_button.hide
+    @stop_button.show
+  end
+
+  def stop
+    @animate = false
+    @stop_button.hide
+    @run_button.show
+  end
+
+  def clear
+    stop
+    @new_world.clear
+  end
+
+  stack(displace_left: 650) do
+    @run_button  = button('Run',  width: 100){ play }
+    @stop_button = button('Stop', width: 100){ stop }
+    @stop_button.hide
+  end
+
+  stack(displace_left: 650) do
+    button('Clear', width: 100) do
+      clear
+    end
+
+    para "Species"
+    button('Glinder', width: 100) do
+      clear
+      @new_world.add_glinder
+    end
+
+    button('Spaceship', width: 100) do
+      clear
+      @new_world.add_spaceship
+    end
+
+    button('Diehard', width: 100) do
+      clear
+      @new_world.add_diehard
+    end
+  end
+
+end