shoes-dsl 4.0.0.pre2

data/lib/shoes/download.rb

@@ -0,0 +1,121 @@
+class Shoes
+  class HttpResponse
+    # Struct might be better?
+    attr_accessor :headers, :body, :status
+    def initalize
+      @headers = {}
+      @body = ''
+      @status = []
+    end
+  end
+
+  class Download
+
+    attr_reader :progress, :response, :content_length, :gui, :transferred
+    UPDATE_STEPS = 100
+
+    def initialize(app, parent, url, opts = {}, &blk)
+      @url = url
+      @opts = opts
+      @blk = blk
+      @gui = Shoes.configuration.backend_for(self)
+
+      @response = HttpResponse.new
+      @finished = false
+      @transferred = 0
+      @content_length = 1 # non zero initialized to avoid Zero Div Errors
+    end
+
+    def start
+      start_download
+    end
+
+    def started?
+      @started
+    end
+
+    def finished?
+      @finished
+    end
+
+    # needed for the specs (jay multi threading and specs)
+    def join_thread
+      @thread.join unless @thread.nil?
+    end
+
+    def percent
+      @transferred * 100 / @content_length
+    end
+
+    def abort
+      @thread.exit if @thread
+    end
+
+    # shoes 3 compatibility
+    def length
+      @content_length
+    end
+
+    private
+    def start_download
+      require 'open-uri'
+      @thread = Thread.new do
+        uri_opts = {}
+        uri_opts[:content_length_proc] = content_length_proc
+        uri_opts[:progress_proc] = progress_proc if @opts[:progress]
+
+        open @url, uri_opts do |download_data|
+          @response.body = download_data.read
+          @response.status = download_data.status
+          @response.headers = download_data.meta
+          save_to_file(@opts[:save]) if @opts[:save]
+          finish_download download_data
+        end
+      end
+    end
+
+    def content_length_proc
+      lambda do |content_length|
+        download_started(content_length)
+        eval_block(@opts[:progress], self) if @opts[:progress]
+      end
+    end
+
+    def progress_proc
+      lambda do |size|
+        if !content_length.nil? &&
+          (size - self.transferred) > (content_length / UPDATE_STEPS) &&
+          !@gui.busy?
+            @gui.busy = true
+            eval_block(@opts[:progress], self)
+            @transferred = size
+        end
+      end
+    end
+
+    def finish_download(download_data)
+      @finished = true
+
+      #In case backend didn't catch the 100%
+      @transferred = @content_length
+      eval_block(@opts[:progress], self) if @opts[:progress]
+
+      #:finish and block are the same
+      eval_block(@blk, self) if @blk
+      eval_block(@opts[:finish], self) if @opts[:finish]
+    end
+
+    def eval_block(blk, result)
+      @gui.eval_block(blk, result)
+    end
+
+    def save_to_file(file_path)
+      open(file_path, 'wb') { |fw| fw.print @response.body }
+    end
+
+    def download_started(content_length)
+      @content_length = content_length
+      @started        = true
+    end
+  end
+end

data/lib/shoes/dsl.rb

@@ -0,0 +1,591 @@
+require 'forwardable'
+require 'pathname'
+require 'shoes/common/registration'
+
+class Shoes
+  PI                  = Math::PI
+  TWO_PI              = 2 * PI
+  HALF_PI             = 0.5 * PI
+  DIR                 = Pathname.new(__FILE__).parent.parent.parent.to_s
+  LOG                 = []
+  LEFT_MOUSE_BUTTON   = 1
+  MIDDLE_MOUSE_BUTTON = 2
+  RIGHT_MOUSE_BUTTON  = 3
+
+  extend Common::Registration
+
+  class << self
+
+    def logger
+      Shoes.configuration.logger_instance
+    end
+
+    # To ease the upgrade path from Shoes 3 we warn users they need to install
+    # and require gems themselves.
+    #
+    # @example
+    #   Shoes.setup do
+    #     gem 'bluecloth =2.0.6'
+    #     gem 'metaid'
+    #   end
+    #
+    # @param block [Proc] The block that describes the gems that are needed
+    # @deprecated
+    def setup(&block)
+      $stderr.puts "WARN: The Shoes.setup method is deprecated, you need to install gems yourself." +
+                   "You can do this using the 'gem install' command or bundler and a Gemfile."
+      DeprecatedShoesGemSetup.new.instance_eval(&block)
+    end
+
+    # Load the backend in memory. This does not set any configuration.
+    #
+    # @param name [String|Symbol] The name, such as :swt or :mock
+    # @return The backend
+    def load_backend(name)
+      begin
+        require "shoes/#{name.to_s.downcase}"
+        Shoes.const_get(name.to_s.capitalize)
+      rescue LoadError => e
+        raise LoadError, "Couldn't load backend Shoes::#{name.capitalize}'. Error: #{e.message}\n#{e.backtrace.join("\n")}"
+      end
+    end
+  end
+
+  class DeprecatedShoesGemSetup
+    def gem(name)
+      name, version = name.split()
+      install_cmd = 'gem install ' + name
+      install_cmd += " --version \"#{version}\"" if version
+      $stderr.puts "WARN: To use the '#{name}' gem, install it with '#{install_cmd}', and put 'require \"#{name}\"' at the top of your Shoes program."
+    end
+  end
+end
+
+require 'shoes/version'
+require 'shoes/renamed_delegate'
+require 'shoes/common/inspect'
+require 'shoes/dimension'
+require 'shoes/dimensions'
+require 'shoes/not_implemented_error'
+require 'shoes/text_block_dimensions'
+
+require 'shoes/color'
+
+require 'shoes/common/background_element'
+require 'shoes/common/changeable'
+require 'shoes/common/clickable'
+require 'shoes/common/positioning'
+require 'shoes/common/remove'
+require 'shoes/common/state'
+require 'shoes/common/style'
+require 'shoes/common/style_normalizer'
+require 'shoes/common/visibility'
+
+require 'shoes/common/ui_element'
+
+require 'shoes/builtin_methods'
+require 'shoes/check_button'
+require 'shoes/text'
+require 'shoes/span'
+require 'shoes/input_box'
+
+# please keep this list tidy and alphabetically sorted
+require 'shoes/animation'
+require 'shoes/arc'
+require 'shoes/background'
+require 'shoes/border'
+require 'shoes/button'
+require 'shoes/configuration'
+require 'shoes/color'
+require 'shoes/dialog'
+require 'shoes/download'
+require 'shoes/font'
+require 'shoes/gradient'
+require 'shoes/image'
+require 'shoes/image_pattern'
+require 'shoes/key_event'
+require 'shoes/line'
+require 'shoes/link'
+require 'shoes/link_hover'
+require 'shoes/list_box'
+require 'shoes/logger'
+require 'shoes/oval'
+require 'shoes/point'
+require 'shoes/progress'
+require 'shoes/radio'
+require 'shoes/rect'
+require 'shoes/shape'
+require 'shoes/slot_contents'
+require 'shoes/slot'
+require 'shoes/star'
+require 'shoes/sound'
+require 'shoes/text_block'
+require 'shoes/timer'
+
+class Shoes
+  # Methods for creating and manipulating Shoes elements
+  #
+  # Requirements
+  #
+  # Including classes must provide:
+  #
+  #   @__app__
+  #
+  #   which provides
+  #     #style:          a hash of styles
+  #     #element_styles: a hash of {Class => styles}, where styles is
+  #                      a hash of default styles for elements of Class,
+  module DSL
+    include Common::Style
+    include Color::DSLHelpers
+
+    # Set default style for elements of a particular class, or for all
+    # elements, or return the current defaults for all elements
+    #
+    # @overload style(klass, styles)
+    #   Set default style for elements of a particular class
+    #   @param [Class] klass a Shoes element class
+    #   @param [Hash] styles default styles for elements of klass
+    #   @example
+    #     style Para, :text_size => 42, :stroke => green
+    #
+    # @overload style(styles)
+    # Set default style for all elements
+    #   @param [Hash] styles default style for all elements
+    #   @example
+    #     style :stroke => alicewhite, :fill => black
+    #
+    # @overload style()
+    #   @return [Hash] the default style for all elements
+    def style(klass_or_styles = nil, styles = {})
+      if klass_or_styles.kind_of? Class
+        klass = klass_or_styles
+        @__app__.element_styles[klass] = styles
+      else
+        @__app__.style(klass_or_styles)
+      end
+    end
+
+    private
+
+    def style_normalizer
+      @style_normalizer ||= Common::StyleNormalizer.new
+    end
+
+    def pop_style(opts)
+      opts.last.class == Hash ? opts.pop : {}
+    end
+
+    # Default styles for elements of klass
+    def style_for_element(klass, styles = {})
+      @__app__.element_styles.fetch(klass, {}).merge(styles)
+    end
+
+    def normalize_style_for_element(clazz, texts)
+      style = style_normalizer.normalize(pop_style(texts))
+      style_for_element(clazz, style)
+    end
+
+    def create(element, *args, &blk)
+      element.new(@__app__, @__app__.current_slot, *args, &blk)
+    end
+
+    public
+
+    def image(path, styles = {}, &blk)
+      create Shoes::Image, path, styles, blk
+    end
+
+    def border(color, styles = {})
+      create Shoes::Border, pattern(color), styles
+    end
+
+    def background(color, styles = {})
+      create Shoes::Background, pattern(color), style_normalizer.normalize(styles)
+    end
+
+    def edit_line(*args, &blk)
+      style = pop_style(args)
+      text  = args.first || ''
+      create Shoes::EditLine, text, style, blk
+    end
+
+    def edit_box(*args, &blk)
+      style = pop_style(args)
+      text  = args.first || ''
+      create Shoes::EditBox, text, style, blk
+    end
+
+    def progress(opts = {}, &blk)
+      create Shoes::Progress, opts, blk
+    end
+
+    def check(opts = {}, &blk)
+      create Shoes::Check, opts, blk
+    end
+
+    def radio(*args, &blk)
+      style = pop_style(args)
+      group = args.first
+      create Shoes::Radio, group, style, blk
+    end
+
+    def list_box(opts = {}, &blk)
+      create Shoes::ListBox, opts, blk
+    end
+
+    def flow(opts = {}, &blk)
+      create Shoes::Flow, opts, blk
+    end
+
+    def stack(opts = {}, &blk)
+      create Shoes::Stack, opts, blk
+    end
+
+    def button(text = 'Button', opts={}, &blk)
+      create Shoes::Button, text, opts, blk
+    end
+
+    # Creates an animation that runs the given block of code.
+    #
+    # @overload animate &blk
+    #   @param [Proc] blk Code to run for each animation frame
+    #   @return [Shoes::Animation]
+    #   Defaults to framerate of 24 frames per second
+    #   @example
+    #     # 24 frames per second
+    #     animate do
+    #       # animation code
+    #     end
+    # @overload animate(framerate, &blk)
+    #   @param [Integer] framerate Frames per second
+    #   @param [Proc] blk Code to run for each animation frame
+    #   @return [Shoes::Animation]
+    #   @example
+    #     # 10 frames per second
+    #     animate 10 do
+    #       # animation code
+    #     end
+    # @overload animate(opts = {}, &blk)
+    #   @param [Hash] opts Animation options
+    #   @param [Proc] blk Code to run for each animation frame
+    #   @option opts [Integer] :framerate Frames per second
+    #   @return [Shoes::Animation]
+    #   @example
+    #     # 10 frames per second
+    #     animate :framerate => 10 do
+    #       # animation code
+    #     end
+    #
+    def animate(opts = {}, &blk)
+      opts = {:framerate => opts} unless opts.is_a? Hash
+      Shoes::Animation.new @__app__, opts, blk
+    end
+
+    def every(n=1, &blk)
+      animate 1.0/n, &blk
+    end
+
+    def timer(n=1, &blk)
+      n *= 1000
+      Timer.new @__app__, n, &blk
+    end
+
+    # similar controls as Shoes::Video (#video)
+    def sound(soundfile, opts = {}, &blk)
+      Shoes::Sound.new @__app__, soundfile, opts, &blk
+    end
+
+    # Creates an arc at (left, top)
+    #
+    # @param [Integer] left the x-coordinate of the top-left corner
+    # @param [Integer] top the y-coordinate of the top-left corner
+    # @param [Integer] width width of the arc's ellipse
+    # @param [Integer] height height of the arc's ellipse
+    # @param [Float] angle1 angle in radians marking the beginning of the arc segment
+    # @param [Float] angle2 angle in radians marking the end of the arc segment
+    # @param [Hash] opts Arc style options
+    # @option opts [Boolean] wedge (false)
+    # @option opts [Boolean] center (false) is (left, top) the center of the rectangle?
+    def arc(left, top, width, height, angle1, angle2, styles = {}, &blk)
+      create Shoes::Arc, left, top, width, height, angle1, angle2, styles, blk
+    end
+
+    # Draws a line from point A (x1,y1) to point B (x2,y2)
+    #
+    # @param [Integer] x1 The x-value of point A
+    # @param [Integer] y1 The y-value of point A
+    # @param [Integer] x2 The x-value of point B
+    # @param [Integer] y2 The y-value of point B
+    # @param [Hash] opts Style options
+    def line(x1, y1, x2, y2, styles = {}, &blk)
+      create Shoes::Line, Shoes::Point.new(x1, y1), Shoes::Point.new(x2, y2), styles, blk
+    end
+
+    # Creates an oval at (left, top)
+    #
+    # @overload oval(left, top, diameter)
+    #   Creates a circle at (left, top), with the given diameter
+    #   @param [Integer] left the x-coordinate of the top-left corner
+    #   @param [Integer] top the y-coordinate of the top-left corner
+    #   @param [Integer] diameter the diameter
+    # @overload oval(left, top, width, height)
+    #   Creates an oval at (left, top), with the given width and height
+    #   @param [Integer] left the x-coordinate of the top-left corner
+    #   @param [Integer] top the y-coordinate of the top-left corner
+    #   @param [Integer] width the width
+    #   @param [Integer] height the height
+    # @overload oval(styles)
+    #   Creates an oval using values from the styles Hash.
+    #   @param [Hash] styles
+    #   @option styles [Integer] left (0) the x-coordinate of the top-left corner
+    #   @option styles [Integer] top (0) the y-coordinate of the top-left corner
+    #   @option styles [Integer] width (0) the width
+    #   @option styles [Integer] height (0) the height
+    #   @option styles [Integer] top (0) the y-coordinate of the top-left corner
+    #   @option styles [Boolean] center (false) is (left, top) the center of the oval
+    def oval(*opts, &blk)
+      oval_style = pop_style(opts)
+      oval_style = style_normalizer.normalize(oval_style)
+      case opts.length
+        when 3
+          left, top, width = opts
+          height = width
+        when 4
+          left, top, width, height = opts
+        when 0
+          left = oval_style[:left] || 0
+          top = oval_style[:top] || 0
+          width = oval_style[:diameter] || oval_style[:width] ||
+                  (oval_style[:radius] || 0) * 2
+          height = oval_style[:height] || width
+        else
+          message = <<EOS
+Wrong number of arguments. Must be one of:
+  - oval(left, top, diameter, [opts])
+  - oval(left, top, width, height, [opts])
+  - oval(styles)
+EOS
+          raise ArgumentError, message
+      end
+      create Shoes::Oval, left, top, width, height, oval_style, blk
+    end
+
+    # Creates a rectangle
+    #
+    # @overload rect(left, top, side, styles)
+    #   Creates a square at (left, top), with sides of the given length
+    #   @param [Integer] left the x-coordinate of the top-left corner
+    #   @param [Integer] top the y-coordinate of the top-left corner
+    #   @param [Integer] side the length of a side
+    # @overload rect(left, top, width, height, rounded = 0, styles)
+    #   Creates a rectangle at (left, top), with the given width and height
+    #   @param [Integer] left the x-coordinate of the top-left corner
+    #   @param [Integer] top the y-coordinate of the top-left corner
+    #   @param [Integer] width the width
+    #   @param [Integer] height the height
+    # @overload rect(styles)
+    #   Creates a rectangle using values from the styles Hash.
+    #   @param [Hash] styles
+    #   @option styles [Integer] left (0) the x-coordinate of the top-left corner
+    #   @option styles [Integer] top (0) the y-coordinate of the top-left corner
+    #   @option styles [Integer] width (0) the width
+    #   @option styles [Integer] height (0) the height
+    #   @option styles [Integer] top (0) the y-coordinate of the top-left corner
+    #   @option styles [Boolean] center (false) is (left, top) the center of the rectangle?
+    def rect(*args, &blk)
+      opts = style_normalizer.normalize pop_style(args)
+      case args.length
+      when 3
+        left, top, width = args
+        height = width
+        opts[:curve] ||= 0
+      when 4
+        left, top, width, height = args
+        opts[:curve] ||= 0
+      when 5
+        left, top, width, height, opts[:curve] = args
+      when 0
+        left = opts[:left] || 0
+        top = opts[:top] || 0
+        width = opts[:width] || 0
+        height = opts[:height] || width
+        opts[:curve] ||= 0
+      else
+        message = <<EOS
+Wrong number of arguments. Must be one of:
+  - rect(left, top, side, [opts])
+  - rect(left, top, width, height, [opts])
+  - rect(left, top, width, height, curve, [opts])
+  - rect(styles)
+EOS
+        raise ArgumentError, message
+      end
+      create Shoes::Rect, left, top, width, height, style.merge(opts), blk
+    end
+
+    def star(left, top, points = 10, outer = 100.0, inner = 50.0, styles = {}, &blk)
+      styles = style_normalizer.normalize styles
+      create Shoes::Star, left, top, points, outer, inner, styles, blk
+    end
+
+    # Creates a new Shoes::Shape object
+    def shape(styles = {}, &blk)
+      create Shoes::Shape, styles, blk
+    end
+
+    # Define app-level setter methods
+    PATTERN_APP_STYLES = [:fill, :stroke]
+    OTHER_APP_STYLES = [:cap, :rotate, :strokewidth, :transform, :translate]
+
+    PATTERN_APP_STYLES.each do |style|
+      define_method style.to_s do |val|
+        @__app__.style[style] = pattern(val)
+      end
+    end
+
+    OTHER_APP_STYLES.each do |style|
+      define_method style.to_s do |val|
+        @__app__.style[style] = val
+      end
+    end
+
+    def nostroke
+      @__app__.style[:stroke] = nil
+    end
+
+    def nofill
+      @__app__.style[:fill] = nil
+    end
+
+    %w[banner title subtitle tagline caption para inscription].each do |method|
+      define_method method do |*texts|
+        styles = pop_style(texts)
+        klass = Shoes.const_get(method.capitalize)
+        create klass, texts, styles
+      end
+    end
+
+    TEXT_STYLES = {
+      code: { font: "Lucida Console" },
+      del: { strikethrough: true },
+      em: { emphasis: true },
+      ins: { underline: true },
+      sub: { rise: -10, size_modifier: 0.8 },
+      sup: { rise: 10, size_modifier: 0.8 },
+      strong: { weight: true },
+    }
+
+    TEXT_STYLES.keys.each do |method|
+      define_method method do |*texts|
+        styles = style_normalizer.normalize(pop_style(texts))
+        styles = TEXT_STYLES[method].merge(styles)
+        Shoes::Span.new texts, styles
+      end
+    end
+
+    def fg(*texts, color)
+      Shoes::Span.new texts, { stroke: pattern(color) }
+    end
+
+    def bg(*texts, color)
+      Shoes::Span.new texts, { fill: pattern(color) }
+    end
+
+    def link(*texts, &blk)
+      opts = normalize_style_for_element(Shoes::Link, texts)
+      create Shoes::Link, texts, opts, blk
+    end
+
+    def span(*texts)
+      opts = normalize_style_for_element(Shoes::Span, texts)
+      Shoes::Span.new texts, opts
+    end
+
+    def mouse
+      [@__app__.mouse_button, @__app__.mouse_pos[0], @__app__.mouse_pos[1]]
+    end
+
+    def motion(&blk)
+      @__app__.mouse_motion << blk
+    end
+
+    def resize(&blk)
+      @__app__.add_resize_callback blk
+    end
+
+    # hover and leave just delegate to the current slot as hover and leave
+    # are just defined for slots but self is always the app.
+    def hover(&blk)
+      @__app__.current_slot.hover(blk)
+    end
+
+    def leave(&blk)
+      @__app__.current_slot.leave(blk)
+    end
+
+    def keypress(&blk)
+      Shoes::Keypress.new @__app__, &blk
+    end
+
+    def keyrelease(&blk)
+      Shoes::Keyrelease.new @__app__, &blk
+    end
+
+    def append(&blk)
+      blk.call if blk
+    end
+
+    def visit(url)
+      match_data = nil
+      url_data = Shoes::URL.urls.find {|page, _| match_data = page.match url}
+      if url_data
+        action_proc = url_data[1]
+        url_argument = match_data[1]
+        clear do
+          @__app__.location = url
+          action_proc.call self, url_argument
+        end
+      end
+    end
+
+    def scroll_top
+      @__app__.scroll_top
+    end
+
+    def scroll_top=(n)
+      @__app__.scroll_top = n
+    end
+
+    def clipboard
+      @__app__.clipboard
+    end
+
+    def clipboard=(str)
+      @__app__.clipboard = str
+    end
+
+    def download(name, args={}, &blk)
+      create(Shoes::Download, name, args, &blk).tap do |download|
+        download.start
+      end
+    end
+
+    def gutter
+      @__app__.gutter
+    end
+
+    def video(*args)
+      raise Shoes::NotImplementedError,
+            'Sorry video support has been cut from shoes 4!' +
+            ' Check out github issue #113 for any changes/updates or if you' +
+            ' want to help :)'
+    end
+
+  end
+end
+
+require 'shoes/internal_app'
+require 'shoes/app'
+require 'shoes/widget'
+require 'shoes/url'