fidgit 0.1.10 → 0.2.0

data/CHANGELOG.md

@@ -0,0 +1,11 @@
+Fidgit changelog
+================
+
+v0.2.0
+------
+
+* Added editable attribute to TextArea (Allows selection, but not alteration).
+* Added Element#font= and :font option.
+* Added Gosu::Color#colorize to use when using in-line text styling.
+* Managed layout of entities and XML tags (Used by Gosu) in TextArea text better (tags still don't like newlines inside them).
+* Changed license from LGPL to MIT.

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2012 Bil Bas (Spooner)
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.textile

@@ -21,7 +21,7 @@ or for options screens and menus within a regular Gosu game.
 
 h2. License
 
-GPL v3 (see COPYING.txt)
+MIT (see COPYING.txt)
 
 h2. Requirements
 

data/examples/text_area_example.rb

@@ -4,22 +4,27 @@ class ExampleState < Fidgit::GuiState
   def initialize
     super
 
+    Gosu.register_entity(:entity, Gosu::Image["head_icon.png"])
+
+    string = "<c=3333ff>Hello, my name</c> is <c=ff0000>Brian</c> the&entity;&entity;snail<c=00ff00>!\nHi\nHello!</c>"
     horizontal do
       vertical do
-        label 'editable'
-        text_area(width: 200)
+        label 'disabled'
+        text_area(text: "Can't even select this text", width: 200, enabled: false)
       end
 
       vertical do
         label 'mirrors to right'
-        text_area(width: 200, text: "Hello, my name in brian the snail!") do |sender, text|
+        text_area(width: 200, text: string) do |_, text|
           @mirror.text = text
         end
       end
 
       vertical do
-        label 'not editable'
-        @mirror = text_area(width: 200, enabled: false)
+        my_label = label 'not editable'
+        font = Gosu::Font.new($window, "", my_label.font.height)
+        font["a"] = Gosu::Image["head_icon.png"]
+        @mirror = text_area(text: string, width: 200, editable: false, font: font)
       end
     end
   end

data/fidgit.gemspec

@@ -20,12 +20,13 @@ Gem::Specification.new do |s|
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
+  s.license       = "MIT"
 
-  s.add_dependency('gosu', '~> 0.7.33')
+  s.add_dependency('gosu', '~> 0.7.41')
   s.add_dependency('chingu', '~> 0.9rc7')
   s.add_dependency('clipboard', '~> 0.9.9')
   s.add_dependency('ffi', '= 1.0.9') # 1.0.10 is borked :(
-  s.add_development_dependency('rspec', '~> 2.1.0')
+  s.add_development_dependency('rspec', '~> 2.8.0')
   s.add_development_dependency('texplay', '~> 0.3.5')
   s.add_development_dependency('rake')
   s.add_development_dependency('yard')

data/lib/fidgit/elements/element.rb

@@ -121,6 +121,7 @@ module Fidgit
     # @option options [String] :tip ('') Tool-tip text
     # @option options [String, :default] :font_name (:default, which resolves as the default Gosu font)
     # @option options [String] :font_height (30)
+    # @option options [Gosu::Font] :font Use this instead of :font_name and :font_height
     #
     # @option options [Gosu::Color] :background_color (transparent)
     # @option options [Gosu::Color] :border_color (transparent)
@@ -191,11 +192,18 @@ module Fidgit
                      options[:font_name].dup
                    end
 
-      @font = Gosu::Font[font_name, options[:font_height]]
+      @font = options[:font] || Gosu::Font[font_name, options[:font_height]]
 
       @rect = Chingu::Rect.new(options[:x], options[:y], options[:width] || 0, options[:height] || 0)
     end
 
+    def font=(font)
+      raise TypeError unless font.is_a? Gosu::Font
+      @font = font
+      recalc
+      font
+    end
+
     def recalc
       old_width, old_height = width, height
       layout

data/lib/fidgit/elements/text_area.rb

@@ -2,6 +2,8 @@
 
 module Fidgit
   class TextArea < Element
+    ENTITY_PLACEHOLDER = "*"
+
     # @return [Number]
     attr_reader :min_height
     # @return [Number]
@@ -14,13 +16,16 @@ module Fidgit
     # @return [Boolean]
     attr_writer :editable
 
+    # @return [String] Text, but stripped of tags.
+    attr_reader :stripped_text
+
     event :changed
     event :focus
     event :blur
 
-    # Is the area editable?
+    # Is the area editable? This will always be false if the Element is disabled.
     def editable?
-      enabled?
+      enabled? and @editable
     end
 
     # Text within the element.
@@ -43,7 +48,7 @@ module Fidgit
     #
     # @return [String]
     def selection_text
-      text[selection_range]
+      stripped_text[selection_range]
     end
 
     # Sets the text within the selection. The caret will be placed at the end of the inserted text.
@@ -52,10 +57,14 @@ module Fidgit
     # @return [String] The new selection text.
     def selection_text=(str)
       from = [@text_input.selection_start, @text_input.caret_pos].min
+      to = [@text_input.selection_start, @text_input.caret_pos].max
       new_length = str.length
 
       full_text = text
-      full_text[selection_range] = str.encode('UTF-8', undef: :replace)
+      tags_length_before = (0...from).inject(0) {|m, i| m + @tags[i].length }
+      tags_length_inside = (from...to).inject(0) {|m, i| m + @tags[i].length }
+      range = (selection_range.first + tags_length_before)...(selection_range.last + tags_length_before + tags_length_inside)
+      full_text[range] = str.encode('UTF-8', undef: :replace)
       @text_input.text = full_text
 
       @text_input.selection_start = @text_input.caret_pos = from + new_length
@@ -79,7 +88,7 @@ module Fidgit
     # @param [Integer] pos Position of caret in the text.
     # @return [Integer] New position of caret.
     def caret_position=(position)
-      raise ArgumentError, "Caret position must be in the range 0 to the length of the text (inclusive)" unless position.between?(0, text.length)
+      raise ArgumentError, "Caret position must be in the range 0 to the length of the text (inclusive)" unless position.between?(0, stripped_text.length)
       @text_input.caret_pos = position
 
       position
@@ -105,6 +114,7 @@ module Fidgit
     # @option options [Integer] :min_height
     # @option options [Integer] :max_height (Infinite)
     # @option options [Number] :line_spacing (0)
+    # @option options [Boolean] :editable (true)
     def initialize(options = {}, &block)
       options = {
         text: '',
@@ -116,6 +126,7 @@ module Fidgit
         caret_period: default(:caret_period),
         focused_border_color: default(:focused, :border_color),
         selection_color: default(:selection_color),
+        editable: true,
       }.merge! options
 
       @line_spacing = options[:line_spacing]
@@ -123,6 +134,7 @@ module Fidgit
       @caret_period = options[:caret_period]
       @focused_border_color = options[:focused_border_color].dup
       @selection_color = options[:selection_color].dup
+      @editable = options[:editable]
 
       @lines = [''] # List of lines of wrapped text.
       @caret_positions = [[0, 0]] # [x, y] of each position the caret can be in.
@@ -131,8 +143,10 @@ module Fidgit
       @old_text = ''
       @old_caret_position = 0
       @old_selection_start = 0
+      @tags = Hash.new("") # Hash of tags embedded in the text.
 
       @text_input.text = options[:text].dup
+      @stripped_text = '' # Text stripped of xml tags.
 
       super(options)
 
@@ -195,14 +209,20 @@ module Fidgit
     # @return [nil]
     def draw_foreground
       # Always roll back changes made by the user unless the text is editable.
-      if not editable? and text != @old_text
-        @text_input.text = @old_text
-        @text_input.selection_start = @old_selection_start
-        self.caret_position = @old_caret_position
-      else
+      if editable? or text == @old_text
         recalc if focused? # Workaround for Windows draw/update bug.
         @old_caret_position = caret_position
         @old_selection_start = @text_input.selection_start
+      else
+        roll_back
+      end
+
+      if caret_position > stripped_text.length
+        self.caret_position = stripped_text.length
+      end
+
+      if @text_input.selection_start >= stripped_text.length
+        @text_input.selection_start = stripped_text.length
       end
 
       # Draw the selection.
@@ -236,7 +256,8 @@ module Fidgit
     # Helper for #recalc
     # @return [Integer]
     def position_letters_in_word(word, line_width)
-      word.each_char do |c|
+      # Strip tags before measuring word.
+      word.gsub(/<[^>]*>|&[^;];/, '').each_char do |c|
         char_width = font.text_width(c)
         line_width += char_width
         @caret_positions.push [line_width, y_at_line(@lines.size)]
@@ -271,8 +292,23 @@ module Fidgit
       word = ''
       word_width = 0
 
-      text.each_char do |char|
-        char_width = (char == "\n") ? 0 : font.text_width(char)
+      strip_tags
+
+      stripped_text.each_char.with_index do |char, i|
+        tag = @tags[i]
+
+        # \x0 is just a place-holder for an entity: &entity;
+        if char == ENTITY_PLACEHOLDER
+          char = tag
+          tag = ""
+        end
+
+        case char
+          when "\n"
+            char_width = 0
+          else
+            char_width = font.text_width char
+        end
 
         overall_width = line_width + (line_width == 0 ? 0 : space_width) + word_width + char_width
         if overall_width > max_width and not (char == ' ' and not word.empty?)
@@ -282,7 +318,7 @@ module Fidgit
             position_letters_in_word(word, line_width)
 
             # Push as much of the current word as possible as a complete line.
-            @lines.push word + (char == ' ' ? '' : '-')
+            @lines.push word + tag + (char == ' ' ? '' : '-')
             line_width = font.text_width(word)
 
             word = ''
@@ -294,18 +330,18 @@ module Fidgit
             line = ''
           end
 
-          @char_widths[-1] += (width - line_width - padding_left - padding_right) unless @char_widths.empty?
+          widen_last_character line_width
           line_width = 0
         end
 
         case char
           when "\n"
             # A new-line ends the word and puts it on the line.
-            line += word
+            line += word + tag
             line_width = position_letters_in_word(word, line_width)
             @caret_positions.push [line_width, y_at_line(@lines.size)]
-            @char_widths[-1] += (width - line_width - (padding_left + padding_right)) unless @char_widths.empty?
             @char_widths.push 0
+            widen_last_character line_width
             @lines.push line
             word = ''
             word_width = 0
@@ -314,7 +350,7 @@ module Fidgit
 
           when ' '
             # A space ends a word and puts it on the line.
-            line += word + char
+            line += word + tag + char
             line_width = position_letters_in_word(word, line_width)
             line_width += space_width
             @caret_positions.push [line_width, y_at_line(@lines.size)]
@@ -330,14 +366,15 @@ module Fidgit
             end
 
             # Start building up a new word.
-            word += char
+            word += tag + char
             word_width += char_width
         end
       end
 
       # Add any remaining word on the last line.
       unless word.empty?
-        position_letters_in_word(word, line_width)
+        line_width = position_letters_in_word(word, line_width)
+        @char_widths << width - line_width - padding_left - padding_right
         line += word
       end
 
@@ -351,25 +388,32 @@ module Fidgit
         @old_caret_position = caret_position
         @old_selection_start = @text_input.selection_start
       else
-        # Roll back!
-        @lines = old_lines
-        @caret_positions = old_caret_positions
-        @char_widths = old_char_widths
-        @text_input.text = @old_text
-        self.caret_position = @old_caret_position
-        @text_input.selection_start = @old_selection_start
+        roll_back
       end
 
       nil
     end
 
+    protected
+    def roll_back
+      @text_input.text = @old_text
+      self.caret_position = @old_caret_position
+      @text_input.selection_start = @old_selection_start
+      recalc
+    end
+
+    protected
+    def widen_last_character(line_width)
+      @char_widths[-1] += (width - line_width - padding_left - padding_right) unless @char_widths.empty?
+    end
+
     public
     # Cut the selection and copy it to the clipboard.
     def cut
       str = selection_text
-      unless selection_text.empty?
+      unless str.empty?
         Clipboard.copy str
-        self.selection_text = ''
+        self.selection_text = '' if editable?
       end
     end
 
@@ -377,9 +421,7 @@ module Fidgit
     # Copy the selection to the clipboard.
     def copy
       str = selection_text
-      unless selection_text.empty?
-        Clipboard.copy str
-      end
+      Clipboard.copy str unless str.empty?
     end
 
     public
@@ -393,5 +435,28 @@ module Fidgit
     def post_init_block(&block)
       subscribe :changed, &block
     end
+
+    protected
+    # Strip XML tags and entities ("<c=000000></c>" and "&entity;")
+    # @note Entities will mess up the system because we don't know how wide they are.
+    def strip_tags
+      tags_length = 0
+      @tags = Hash.new('')
+
+      @stripped_text = text.gsub(%r[(<[^>]*?>|&[^;]+;)]) do |tag|
+        pos = $`.length - tags_length
+        tags_length += tag.length
+        @tags[pos] += tag
+
+        # Entities need to have a non-printing character that can represent them.
+        # Still not right, but does mean there are the right number of characters.
+        if tag[0] == '&'
+          tags_length -= 1
+          ENTITY_PLACEHOLDER # Will be expanded later.
+        else
+          '' # Tags don't use up space, so ignore them.
+        end
+      end
+    end
   end
 end

data/lib/fidgit/event.rb

@@ -23,23 +23,87 @@ module Fidgit
   #   # JumpingBean jumped 4 metres up
   #
   module Event
-    # @overload subscribe(event, method)
-    #   Add an event handler for an event, using a method.
-    #   @return [nil]
-    #
-    # @overload subscribe(event, &block)
-    #   Add an event handler for an event, using a block.
-    #   @return [nil]
+    # Created and returned by {Event#subscribe} and can be used to unsubscribe from the event.
+    class Subscription
+      attr_reader :publisher, :event, :handler
+
+      def initialize(publisher, event, handler)
+        raise TypeError unless publisher.is_a? Event
+        raise TypeError unless event.is_a? Symbol
+        raise TypeError unless handler.is_a? Proc or handler.is_a? Method
+
+        @publisher, @event, @handler = publisher, event, handler
+      end
+
+      def unsubscribe
+        @publisher.unsubscribe self
+      end
+    end
+
+    class << self
+      def new_event_handlers
+        # Don't use Set, since it is not guaranteed to be ordered.
+        Hash.new {|h, k| h[k] = [] }
+      end
+    end
+
+    # @return [Subscription] Definition of this the handler created by this subscription, to be used with {#unsubscribe}
     def subscribe(event, method = nil, &block)
       raise ArgumentError, "Expected method or block for event handler" unless !block.nil? ^ !method.nil?
       raise ArgumentError, "#{self.class} does not handle #{event.inspect}" unless events.include? event
 
-      @_event_handlers ||= Hash.new() { |hash, key| hash[key] = [] }
-      @_event_handlers[event].push(method ? method : block)
+      @_event_handlers ||= Event.new_event_handlers
+      handler = method || block
+      @_event_handlers[event] << handler
 
-      nil
+      Subscription.new self, event, handler
     end
 
+    # @overload unsubscribe(subscription)
+    #   Unsubscribe from a #{Subscription}, as returned from {#subscribe}
+    #   @param subscription [Subscription]
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    # @overload unsubscribe(handler)
+    #   Unsubscribe from first event this handler has been used to subscribe to..
+    #   @param handler [Block, Method] Event handler used.
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    # @overload unsubscribe(event, handler)
+    #   Unsubscribe from specific handler on particular event.
+    #   @param event [Symbol] Name of event originally subscribed to.
+    #   @param handler [Block, Method] Event handler used.
+    #   @return [Boolean] true if the handler was able to be deleted.
+    #
+    def unsubscribe(*args)
+      @_event_handlers ||= Event.new_event_handlers
+
+      case args.size
+        when 1
+          case args.first
+            when Subscription
+              # Delete specific event handler.
+              subscription = args.first
+              raise ArgumentError, "Incorrect publisher for #{Subscription}: #{subscription.publisher}" unless subscription.publisher == self
+              unsubscribe subscription.event, subscription.handler
+            when Proc, Method
+              # Delete first events that use the handler.
+              handler = args.first
+              !!@_event_handlers.find {|_, handlers| handlers.delete handler }
+            else
+              raise TypeError, "handler must be a #{Subscription}, Block or Method: #{args.first}"
+          end
+        when 2
+          event, handler = args
+          raise TypeError, "event name must be a Symbol: #{event}" unless event.is_a? Symbol
+          raise TypeError, "handler name must be a Proc/Method: #{handler}" unless handler.is_a? Proc or handler.is_a? Method
+          !!@_event_handlers[event].delete(handler)
+        else
+          raise ArgumentError, "Requires 1..2 arguments, but received #{args.size} arguments"
+      end
+    end
+
+
     # Publish an event to all previously added handlers in the order they were added.
     # It will automatically call the publishing object with the method named after the event if it is defined
     # (this will be done before the manually added handlers are called).
@@ -78,15 +142,11 @@ module Fidgit
       class << base
         def events
           # Copy the events already set up for your parent.
-          unless defined? @events
-            @events = if superclass.respond_to? :events
-              superclass.events.dup
-            else
-              []
-            end
-          end
-
-          @events
+          @events ||= if superclass.respond_to? :events
+                        superclass.events.dup
+                      else
+                        []
+                      end
         end
 
         def event(event)