fxruby-enhancement 0.1.0 → 0.2.0

data/lib/fxruby-enhancement/color-mapper.rb.erb

@@ -0,0 +1,23 @@
+# coding: utf-8
+=begin rdoc
+This is a color map for Enhancement to make it
+easier to deal with colors in FXRuby.
+
+To use, just do:
+  include RGB
+== List of available colors
+<% for @fxcolor, @fxstring in @fxc  %>
+  * <%= @fxcolor.snake %>
+<% end %>
+
+== NOTE WELL
+  This file is generated by fxruby-enhancement.
+  Do NOT modify this file. Modify the ERB template
+  file instead, and run 'rake scrape'.
+=end
+
+module RGB
+<% for @fxcolor, @fxstring in @fxc  %>
+  def <%= @fxcolor.snake %>; <%= @fxstring %>; end
+<% end %>
+end

data/lib/fxruby-enhancement/enhancement.rb

@@ -1,4 +1,3 @@
-# coding: utf-8
 module Fox 
 
   # Include this in your top class objects.
@@ -9,10 +8,12 @@ module Fox
     @stack = []
     @base = nil
     @components = {}
+    @kinder_parents = {}
     SPECIAL = [:FXApp,
                :FXColorItem,
                :FXRegion,
                :FXRectangle,
+               :FXPoint,
                :FXGradient,
                :FXEvent,
                :FXDataTarget,
@@ -23,6 +24,7 @@ module Fox
     # Module-level    
     class << self
       attr_accessor :stack,
+                    :kinder_parents, # this is to make 'as' delecrations work intuitively.
                     :base, # the very first component declared, usually the app.
                     :components,
                     :deferred_setups,
@@ -97,6 +99,9 @@ module Fox
         end
         return inst
       end
+
+      def rgb
+      end
       
       # Find the referenced component's wrapper object
       def refc sym, &block
@@ -128,6 +133,31 @@ module Fox
       end
       alias_method :fxi, :fox_instance
 
+      # To allow for adding new components at
+      # other places other than the immediate
+      # parental nesting.
+      def as tag, kpos: Enhancement.stack.last, &block
+        Enhancement.stack << (@os = os = refc(tag))
+
+        # We must add our actual parent to the kinder parent
+        # registry, and remove it before we're done here.
+        kstacklvl = Enhancement.stack.size + 1
+        Enhancement.kinder_parents[kstacklvl] = kpos
+        
+        def instance a=nil, &block
+          @os.instance_name = a
+          @os.instance_block ||= []
+          @os.instance_block << [a, block]
+        end
+        
+        self.instance_eval &block
+
+        Enhancement.kinder_parents.delete kstacklvl
+        Enhancement.stack.pop                                                  
+        @os = Enhancement.stack.last
+        return os
+      end
+      
       # Handles incomming external messages of type given
       # block, written by user, is called with |type, message|.
       # Zero or more symbols may be given,
@@ -148,7 +178,16 @@ module Fox
       # TODO: Not sure we need this. This may go away.
       def deferred_setup &block
         Enhancement.deferred_setups << block
-      end      
+      end
+
+      # This simplifies creating the FXDCWindow object.
+      def fx_dc tag, event=nil, &block
+        unless event.nil?
+          FXDCWindow.new(ref(tag), event) { |dc| block.(dc) }
+        else
+          FXDCWindow.new(ref(tag)) { |dc| block.(dc) }
+        end
+      end
     end
   end
 end

data/lib/fxruby-enhancement/ostruct-monkey.rb

@@ -16,6 +16,7 @@ class OpenStruct
   def create_fox_components use_as_base = nil
     if use_as_base.nil?
       self.inst = fx.() if self.inst.nil?
+      self.as_tasks.map{ |a| a.() } unless self.as_tasks.nil?
       self.kinder.each{ |os|
         os.create_fox_components unless os.reusable?
       }
@@ -38,13 +39,27 @@ class OpenStruct
     }
     self.inst = nil
   end
-  
+
+  # We can have as many instances as we like.
   def instance_final_activate
-    self.instance_result = self.instance_block.(self.inst) unless self.instance_block.nil?
-    self.kinder.each{ |os| os.instance_final_activate unless os.reusable? }
+    self.instance_result =
+      self.instance_block.map{ |name, inst|
+      inst.(self.inst)
+    } unless self.instance_block.nil?
+    self.kinder
+      .each{ |os|
+      os.instance_final_activate unless os.reusable?
+    }
     self
   end
 
+  # We must insure that instance actually is something
+  # other than nil.
+  def instance
+    raise "Instance is not set for #{self.klass}" if self.inst.nil?
+    self.inst
+  end
+
   # launch the application
   def launch ingress: false
     create_fox_components

data/lib/fxruby-enhancement/rgb-monkey.rb

@@ -0,0 +1,54 @@
+# coding: utf-8
+=begin rdoc
+color = RGB::Color.from_rgb_hex("#333333")
+color = RGB::Color.from_rgb_hex(0xFF0000)
+color = RGB::Color.from_rgb(115, 38, 38)
+color = RGB::Color.from_fractions(0, 1.0, 0.5) # HSL
+
+# Supported color manipulations:
+color.darken(20)
+color.darken_percent(10)
+color.darken!(20)
+color.darken_percent!(10)
+color.lighten(20)
+color.lighten_percent(20)
+color.lighten!(20)
+color.lighten_percent!(20)
+color.saturate(20)
+color.saturate_percent(20)
+color.saturate!(20)
+color.saturate_percent!(20)
+color.desaturate(20)
+color.desaturate_percent(20)
+color.desaturate!(20)
+color.desaturate_percent!(20)
+
+color.invert!
+
+# Mixing colors:
+color.mix(other_color, 20) # Mix 20% of other color into current one
+color.mix(other_color) # 50% by default
+color.mix!(other_color, 20)
+color.mix!(other_color)
+
+# Also you can adjust color HSL (hue, saturation, and lightness values) manually:
+color.hue = 0.1
+color.saturation = 0.2
+color.lightness = 0.3
+
+# Supported output formats:
+color.to_rgb_hex
+=> "#732626"
+color.to_hsl
+=> [0, 1.0, 0.5]
+color.to_rgb
+=> [115, 38, 38]
+
+=end
+
+module RGB
+  class Color
+    def to_fx
+    end
+  end
+end

data/lib/fxruby-enhancement/xtras.rb

@@ -0,0 +1 @@
+require_relative 'xtras/charting.rb'

data/lib/fxruby-enhancement/xtras/charting-boxes.rb

@@ -0,0 +1,247 @@
+# coding: utf-8
+module Fox
+  module Enhancement
+    module Xtras
+      # Charting constructs. Note that the
+      # rulers have built-in their own labeling, with orientation.
+      module Charting        
+        # Box area of drawing interest. This is
+        # more virtual than actual, i.e. no clipping
+        # is performed.
+        class Box
+          include RGB
+          MAX_DOMINANCE = 3
+          NÄHE = [:top_box, :bottom_box, :left_box, :right_box]
+
+          # Name of this box -- we use this in some cases to avoid class polution
+          attr_reader :name
+          
+          # coordinate and dimensions of the box
+          attr_accessor :x, :y, :width, :height
+
+          # hints on width and heigt, if meaningful, otherwise nil
+          attr_accessor :hint_width, :hint_height
+          
+          # textual / apperance orientation :horizontal, :vertical, :none
+          # placement :top, :bottom, :left, :right
+          attr_accessor :orientation, :placement
+
+          # adjoining boxes 
+          attr_accessor :top_box, :bottom_box
+          attr_accessor :left_box, :right_box
+
+          # margins
+          attr_accessor :top_margin, :bottom_margin, :left_margin, :right_margin
+
+          attr_accessor :enabled, :floating
+
+          # dominance rating (must be supplied)
+          attr_accessor :dominance
+
+          # always overide this the default simply renders a box
+          def render dc
+            raise "layout error in #{self.class}" if x.nil? or y.nil? or width.nil? or height.nil?
+            dc.setClipRectangle FXRectangle.new(x,y,width,height)
+            dc.foreground = black
+            dc.drawRectangle x, y, width-1, height-1
+          end
+
+          def enabled? ; enabled ; end
+          def floating? ; floating ; end
+
+          # calc the width and height of this box. Override!
+          def calculate_dimensions
+            self.width  ||= (hint_width || 20) #TODO: remove the cheats
+            self.height ||= (hint_height || 10)
+          end
+          
+          def initialize chart,
+                         name: self.class,
+                         float: false,
+                         enabled: true,
+                         dom: 1,
+                         orient: :none,
+                         placement: :unspecified
+            @chart = chart
+            @name = name
+            @dominance = dom
+            @floating = float
+            @top_margin = @bottom_margin = @left_margin = @right_margin = 0
+            @orientation = orient
+            @enabled = enabled
+            @placement = placement
+          end
+
+          def to_s
+            sprintf "<%50s dom=%s xywh=%-17s LRTB=%-14s %s>" % [name,
+                                                                "#{dominance}",
+                                                                "[#{x||'NIL'},#{y||'NIL'},#{width||'NIL'},#{height||'NIL'}]",
+                                                                "[#{left_margin},#{right_margin},#{top_margin},#{bottom_margin}]",
+                                                                "#{floating? ? 'floater' : ''}"
+                                                               ]
+          end
+        end
+
+        # The null box represents the side of the container -- the
+        # canvas -- and will simplify layout.
+        class NullBox < Box
+          def initialize chart, **kv
+            super(chart, **kv)
+            @dominance = 0
+          end
+
+          # null box is never rendered.
+          def render dc ; end
+        end              
+        
+        class Ruler < Box
+          def render dc
+            super
+            # coord is normalized, 0 .. 1
+            Ticks.new(0, 1000) do |t|
+              dc.foreground = black
+              
+              t.tick_lambda = ->(coord, value, major) {
+                tick_length = (orientation == :horizontal ? height : width) / (major ? 2 : 4)
+                
+                x1 = if orientation == :horizontal
+                       x + width * coord  
+                     elsif orientation == :vertical
+                       if placement == :left
+                         x + width
+                       elsif placement == :right
+                         x
+                       else
+                         raise "unknown placement :#{placement}"
+                       end
+                     else
+                       raise "unknown orientation :#{orientation}"
+                     end
+                
+                y1 = if orientation == :horizontal
+                       if placement == :top
+                         y + height
+                       elsif placement == :bottom
+                         y
+                       else
+                         raise "unknown placement :#{placement}"
+                       end
+                     elsif orientation == :vertical
+                       y + height * coord
+                     else
+                       raise "unknown orientation :#{orientation}"                       
+                     end
+                
+                x2 = if orientation == :horizontal
+                       x1
+                     elsif orientation == :vertical
+                       if placement == :left
+                         x1 - tick_length
+                       elsif placement == :right
+                         x1 + tick_length
+                       else
+                         raise "unknown placement :#{placement}"
+                       end
+                     else
+                       raise "unknown orientation :#{orientation}"                       
+                     end
+
+                y2 = if orientation == :horizontal
+                       if placement == :top
+                         y1 - tick_length
+                       elsif placement == :bottom
+                         y1 + tick_length
+                       else
+                         raise "unknown placement :#{placement}"
+                       end
+                     elsif orientation == :vertical
+                       y1
+                     else
+                       raise "unknown orientation :#{orientation}"                       
+                     end
+                dc.drawLine x1, y1, x2, y2
+              }
+              
+              t.tick_label_lambda = ->(coord, label) {}
+            end.compute_ticks
+            
+          end
+          
+          def initialize chart, **kv
+            super
+            @dominance = 2
+          end
+        end
+        
+        # For now, we assume that the placement
+        # of PureText boxes shall be above and
+        # below the GraphBox.
+        class PureText < Box
+          def calculate_wh
+          end
+          
+          def calculate_dimensions
+            super
+            calculate_wh
+            begin
+              self.x = [top_box.width, bottom_box.width].max / 2 - self.width / 2
+            rescue ArgumentError, NoMethodError, TypeError => e
+              #puts "-->PureText unresolved: #{e}"
+            end
+          end
+        end
+
+        class Title < PureText
+        end
+
+        class Caption < PureText
+        end
+
+        class Legend < Box
+          # We calculate this on the basis
+          # of our actual content.
+          def calculate_wh
+            self.width = 50 # TODO: we're cheating again.
+            self.height = 30
+          end
+          
+          def calculate_dimensions
+            super
+            calculate_wh
+            
+            # This is a nasty hard-coding, which will not
+            # allow us to change the location of this box.
+            # Later, we'll want to add that flexibility.
+            self.y = right_box.height / 2 - self.height / 2
+          end
+        end
+
+        # main charting area.
+        class Graph < Box
+          def calculate_dimensions
+            super
+            begin
+              self.width = right_box.x \
+                           - right_box.left_margin \
+                           - left_box.x \
+                           - left_box.width \
+                           + left_box.right_margin
+              self.height = bottom_box.y \
+                            - bottom_box.top_margin \
+                            - top_box.y \
+                            - top_box.height \
+                            + top_box.bottom_margin
+            rescue NoMethodError, TypeError => e
+              #puts "-->Graph: unresolved: #{e}"
+            end
+          end
+          
+          def initialize chart, **kv
+            super
+            @dominance = 3
+          end
+        end
+      end
+    end
+  end
+end