wads 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dffb479b6d7bdc47ff103db3f88b1acece5d0ec672361070aec604eb25aa6e9b
-  data.tar.gz: b9fd53c1345bc7f5ab18cd0b5ab2eb74cc0b3276cd538cdae6dad414523f9529
+  metadata.gz: 2652d96c92be67ffd117365e2eb1ed93c21fd6f6c83cae037c6761f3f70754d5
+  data.tar.gz: e1680952ab2bdd333bc518ae7d97bca0a8bfc4033e2b0b9f8bf062e689ee22e9
 SHA512:
-  metadata.gz: dbeb4a1dd4f5918d047954b6336219e3dd9429db3de755f56f12f34cf60c4e187d92a967a3cbde88ad02dc35952257da492729f1da762f8b49035775462b4b1b
-  data.tar.gz: 6c28345cfc8658cd25c1243469ff0fa308aa8278597b48e42f9cdd71b1a4d7e285e3df989d19504ea2f3137a36e593ee6a46116a360d4ed92d627c2b9b334619
+  metadata.gz: 2e07cd62b59ca7d4e73176a94f3396f37f2981b6d448ebdd9490f9b6d5c0a69e0cd531805fed3e5512435b2d9a669521b1a047e0d022dd9ee0fb1ffb9ddd1941
+  data.tar.gz: 9189a546fe8c0f74fa0e18abbca8de17eacd70b63b7092e09374b4315f832ed359f62add905a3ce9c82641728b569846fc44f04007b2e14bcdb28e0608f35e3d

data/CHANGELOG.md

@@ -6,3 +6,7 @@
 
 - Added graph data structure and corresponding display widgets
 
+## [0.1.2] - 2021-08-30
+
+- Fixed bugs with data structures. Added convenience methods to manage child widgets
+

data/README.md

@@ -2,6 +2,7 @@
 
 A number of Ruby Gosu-based (W)idgets (a)nd (D)ata (S)tructures for your applications.
 
+![alt Screenshot](https://github.com/dbroemme/ruby-wads/blob/main/media/WadsScreenshot.png?raw=true)
 ## Installation
 
 Add this line to your application’s Gemfile:
@@ -9,7 +10,7 @@ Add this line to your application’s Gemfile:
 ```
 gem 'wads'
 ```
-And the run bundle install.
+And then run bundle install.
 
 ## Sample Application
 
@@ -20,7 +21,7 @@ git clone https://github.com/dbroemme/ruby-wads.git
 cd ruby-wads
 ./bin/setup
 ./run
-./run-sample-app -s -g
+./run-sample-app -s
 ```
 
 This will run the sample NASDAQ stocks analysis that features the use of the 
@@ -30,7 +31,12 @@ You can also see the graph capabilities by running the Star Wars analysis exampl
 This uses a data set that captures all character interactions within Episode 4.
 
 ```
-./run-sample-app -j -g
+./run-sample-app -j
+```
+
+There is also a sample Graph display using the following command.
+```
+./run-sample-app -g
 ```
 
 ## References

data/lib/wads/app.rb

@@ -33,25 +33,33 @@ class WadsSampleApp < Gosu::Window
         opts = SampleAppCommand.new.parse.run
         if opts[:stocks]
             stats = process_stock_data
-            if opts[:gui]
+            if opts[:text]
+                stats.report(Date::DAYNAMES[1..5])
+            else 
                 @display_widget = SampleStocksDisplay.new(@small_font, stats)
                 show
-            else 
-                stats.report(Date::DAYNAMES[1..5])
             end
 
         elsif opts[:jedi] 
             graph = process_star_wars_data
             @display_widget = SampleStarWarsDisplay.new(@small_font, graph)
             show
+
         elsif opts[:lottery] 
             process_lottery_data
+
+        elsif opts[:graph] 
+            graph = create_test_graph
+            if not opts[:text]
+                @display_widget = SampleGraphDisplay.new(@small_font, graph)
+                show
+            end
         else
             puts " "
             puts "Select one of the following sample analysis options"
             puts "-s   Run sample stocks analysis"
             puts "-j   Run sample Star Wars character analysis"
-            puts "-l   Run sample analysis of lottery numbers"
+            puts "-g   Run sample graph display"
             puts " "
             exit
         end
@@ -78,8 +86,10 @@ class WadsSampleApp < Gosu::Window
         close if id == Gosu::KbEscape
         # Delegate button events to the primary display widget
         result = @display_widget.button_down id, mouse_x, mouse_y
-        if result.close_widget
-            close
+        if not result.nil? and result.is_a? WidgetResult
+            if result.close_widget
+                close
+            end
         end
     end
 
@@ -174,10 +184,26 @@ class WadsSampleApp < Gosu::Window
             number_of_scenes_together = interaction['value']
             edge_tags = {}
             edge_tags["scenes"] = number_of_scenes_together
-            character_one.add_output_edge(character_two, edge_tags)
+            graph.add_edge(character_one, character_two, edge_tags)
         end
         graph
     end
+
+    def create_test_graph
+        g = Graph.new 
+        g.add("a")
+        g.add("b")
+        g.add("c")
+        g.add("d")
+        g.add("e")
+        g.add("f")
+        g.connect("a", "b")
+        g.connect("a", "c")
+        g.connect("b", "d")
+        g.connect("b", "e")
+        g.connect("e", "f")
+        g
+    end
 end
 
 class SampleStocksDisplay < Widget
@@ -187,15 +213,16 @@ class SampleStocksDisplay < Widget
         super(10, 100, COLOR_HEADER_BRIGHT_BLUE)
         set_dimensions(780, 500)
         set_font(font)
-        add_child(Document.new(sample_content, x + 5, y + 5, @width, @height, @font))
-        @exit_button = Button.new("Exit", 380, bottom_edge - 30, @font)
-        add_child(@exit_button)
+        add_document(sample_content, 5, 5, @width, @height)
+        add_button("Exit", 380, @height - 30) do
+            WidgetResult.new(true)
+        end
 
         @stats = stats
-        @data_table = SingleSelectTable.new(@x + 5, @y + 100,    # top left corner
-                                            770, 200,            # width, height
+        @data_table = add_single_select_table(5, 100,             # top left corner
+                                              770, 200,           # width, height
             ["Day", "Min", "Avg", "StdDev", "Max", "p10", "p90"], # column headers
-                                            @font, COLOR_WHITE)   # font and text color
+                                              COLOR_WHITE)        # font and text color
         @data_table.selected_color = COLOR_LIGHT_GRAY
         Date::DAYNAMES[1..5].each do |day|
             min = format_percent(@stats.min(day))
@@ -206,7 +233,7 @@ class SampleStocksDisplay < Widget
             p90 = format_percent(@stats.percentile(day, 0.90))
             @data_table.add_row([day, min, avg, std, max, p10, p90], COLOR_HEADER_BRIGHT_BLUE)
         end
-        add_child(@data_table)
+
         @selection_text = nil
     end 
 
@@ -228,21 +255,15 @@ class SampleStocksDisplay < Widget
         end
     end 
 
-    def button_down id, mouse_x, mouse_y
-        if id == Gosu::MsLeft
-            if @exit_button.contains_click(mouse_x, mouse_y)
-                return WidgetResult.new(true)
-            elsif @data_table.contains_click(mouse_x, mouse_y)
-                val = @data_table.set_selected_row(mouse_y, 0)
-                if val.nil?
-                    # nothing to do
-                else
-                    @selection_text = Text.new("You selected #{val}, a great day!",
-                                               x + 5, y + 400, @font)
-                end    
-            end 
-        end 
-        WidgetResult.new(false)
+    def handle_mouse_down mouse_x, mouse_y
+        if @data_table.contains_click(mouse_x, mouse_y)
+            val = @data_table.set_selected_row(mouse_y, 0)
+            if not val.nil?
+                @selection_text = Text.new("You selected #{val}, a great day!",
+                                           x + 5, y + 400, @font)
+            end    
+        end
+        nil
     end 
 end
 
@@ -253,22 +274,24 @@ class SampleStarWarsDisplay < Widget
         super(10, 100, COLOR_HEADER_BRIGHT_BLUE)
         set_dimensions(780, 500)
         set_font(font)
-        add_child(Document.new(sample_content, x + 5, y + 5, @width, @height, @font))
-        @exit_button = Button.new("Exit", 380, bottom_edge - 30, @font)
-        add_child(@exit_button)
-
         @graph = graph
-        @data_table = SingleSelectTable.new(@x + 5, @y + 70,     # top left corner
-                                            770, 180,            # width, height
-                                            ["Character", "Number of Scenes"], # column headers
-                                            @font, COLOR_WHITE,  # font and text color
-                                            5)                   # max visible rows
+
+        add_document(sample_content, 5, 5, @width, @height)
+        add_button("Exit", 370, @height - 30) do
+            WidgetResult.new(true)
+        end
+
+        @data_table = add_single_select_table(5, 70,                             # top left corner
+                                              770, 180,                          # width, height
+                                              ["Character", "Number of Scenes"], # column headers
+                                              COLOR_WHITE,                       # font and text color
+                                              5)                                 # max visible rows
         @data_table.selected_color = COLOR_LIGHT_GRAY
+
         @graph.node_list.each do |character|
             @data_table.add_row([character.name, character.value], character.get_tag("color"))
         end
-        add_child(@data_table)
-        @graph_display = GraphWidget.new(x + 5, y + 260, 770, 200, @font, @color, @graph) 
+        @graph_display = add_graph_display(5, 260, 770, 200, @graph)
     end 
 
     def sample_content
@@ -278,38 +301,40 @@ class SampleStarWarsDisplay < Widget
         HEREDOC
     end
 
-    def render 
-        @graph_display.draw 
-    end 
-
-    def button_down id, mouse_x, mouse_y
-        if id == Gosu::MsLeft
-            if @exit_button.contains_click(mouse_x, mouse_y)
-                return WidgetResult.new(true)
-            elsif @data_table.contains_click(mouse_x, mouse_y)
-                val = @data_table.set_selected_row(mouse_y, 0)
-                if val.nil?
-                    # nothing to do
-                else
-                    node = @graph.find_node(val)
-                    @graph_display.set_display(node, 2)
-                end  
-            elsif @graph_display.contains_click(mouse_x, mouse_y)
-                @graph_display.button_down id, mouse_x, mouse_y
-            end 
-        elsif id == Gosu::KbUp
+    def handle_key_press id, mouse_x, mouse_y
+        if id == Gosu::KbUp
             @data_table.scroll_up
         elsif id == Gosu::KbDown
             @data_table.scroll_down
         end 
         WidgetResult.new(false)
-    end 
-
-    def button_up id, mouse_x, mouse_y
-        @graph_display.button_up id, mouse_x, mouse_y
     end
 
-    def update update_count, mouse_x, mouse_y
-        @graph_display.update update_count, mouse_x, mouse_y
+    def handle_mouse_down mouse_x, mouse_y
+        if @data_table.contains_click(mouse_x, mouse_y)
+            val = @data_table.set_selected_row(mouse_y, 0)
+            if not val.nil?
+                node = @graph.find_node(val)
+                @graph_display.set_center_node(node, 2)
+            end  
+        end
+        nil
     end
+end
+
+class SampleGraphDisplay < Widget
+    attr_accessor :graph
+
+    def initialize(font, graph)
+        super(10, 100, COLOR_CYAN)
+        set_dimensions(780, 500)
+        set_font(font)
+        @graph = graph
+        exit_button = add_button("Exit", 370, @height - 30) do
+            WidgetResult.new(true)
+        end
+        exit_button.text_color = COLOR_CYAN
+        @graph_display = add_graph_display(5, 60, 770, 400, @graph)
+        @graph_display.set_tree_display
+    end 
 end

data/lib/wads/data_structures.rb

@@ -32,21 +32,29 @@ module Wads
         end
 
         def set(data_set_name, x, y)
-            data_set = @data[x]
+            data_set = @data[data_set_name]
             if data_set.nil? 
                 data_set = {}
-                @data[x] = data_set
+                @data[data_set_name] = data_set
             end
             data_set[x] = y
         end
 
         def get(data_set_name, x)
-            data_set = @data[x]
+            data_set = @data[data_set_name]
             if data_set.nil? 
                 return nil
             end
             data_set[x]
         end
+
+        def keys(data_set_name)
+            data_set = @data[data_set_name]
+            if data_set.nil? 
+                return nil
+            end
+            data_set.keys
+        end
     end 
 
     class Stats
@@ -250,6 +258,11 @@ module Wads
         attr_accessor :visited
         attr_accessor :tags
 
+        def id 
+            # id is an alias for name
+            @name 
+        end 
+
         def initialize(name, value = nil, tags = {})
             @name = name 
             @value = value
@@ -281,6 +294,35 @@ module Wads
             edge
         end
 
+        def remove_output(name)
+            output_to_delete = nil
+            @outputs.each do |output|
+                if output.is_a? Edge 
+                    output_node = output.destination 
+                    if output_node.id == name 
+                        output_to_delete = output
+                    end 
+                elsif output.id == name
+                    output_to_delete = output
+                end 
+            end 
+            if output_to_delete
+                @outputs.delete(output_to_delete)
+            end
+        end 
+
+        def remove_backlink(name)
+            backlink_to_delete = nil
+            @backlinks.each do |backlink|
+                if backlink.id == name
+                    backlink_to_delete = backlink
+                end 
+            end 
+            if backlink_to_delete
+                @backlinks.delete(backlink_to_delete)
+            end
+        end 
+
         def add_tag(key, value)
             @tags[key] = value 
         end
@@ -313,8 +355,8 @@ module Wads
                 node = node_queue.shift
                 yield node
                 node.outputs.each do |c|
-                    if child.is_a? Edge 
-                        child = child.destination 
+                    if c.is_a? Edge 
+                        c = c.destination 
                     end 
                     node_queue << c
                 end
@@ -363,18 +405,49 @@ module Wads
             @node_map = {}
         end
 
+        def add(name, value = nil, tags = {}) 
+            add_node(Node.new(name, value, tags))
+        end 
+
+        def connect(source, destination, tags = {})
+            add_edge(source, destination)
+        end
+
+        def delete(node) 
+            if node.is_a? String 
+                node = find_node(node)
+            end 
+            node.backlinks.each do |backlink| 
+                backlink.remove_output(node.name)
+            end
+            @node_list.delete(node)
+            @node_map.delete(node.name)
+        end 
+
+        def disconnect(source, target)
+            if source.is_a? String 
+                source = find_node(source)
+            end 
+            if target.is_a? String 
+                target = find_node(target)
+            end 
+            source.remove_output(target.name)
+            target.remove_backlink(source.name)
+        end
+
         def add_node(node) 
             @node_list << node 
             @node_map[node.name] = node 
         end 
 
-        def add_edge(source, target, tags)
+        def add_edge(source, target, tags = {})
             if source.is_a? String 
                 source = find_node(source)
             end 
             if target.is_a? String 
                 target = find_node(target)
             end 
+            source.add_output_edge(target, tags)
         end
 
         def find_node(name) 
@@ -401,6 +474,16 @@ module Wads
             list 
         end 
 
+        def leaf_nodes 
+            list = []
+            @node_list.each do |node|
+                if node.outputs.empty? 
+                    list << node 
+                end  
+            end 
+            list 
+        end 
+
         def is_cycle(node)
             reset_visited
             node.visit do |n|
@@ -413,14 +496,21 @@ module Wads
             false
         end
 
-        def fan_out(node, max_depth, current_depth = 1)
-            if current_depth > max_depth 
-                return {}
+        def traverse_and_collect_nodes(node, max_depth, current_depth = 1)
+            if max_depth > 0
+                if current_depth > max_depth 
+                    return {}
+                end
             end
             map = {}
-            map[node.name] = node
+            if node.visited 
+                return {} 
+            else
+                map[node.name] = node
+                node.visited = true
+            end
             node.backlinks.each do |child|
-                map_from_child = fan_out(child, max_depth, current_depth + 1)
+                map_from_child = traverse_and_collect_nodes(child, max_depth, current_depth + 1)
                 map_from_child.each do |key, value|
                     map[key] = value 
                 end
@@ -429,7 +519,7 @@ module Wads
                 if child.is_a? Edge 
                     child = child.destination 
                 end
-                map_from_child = fan_out(child, max_depth, current_depth + 1)
+                map_from_child = traverse_and_collect_nodes(child, max_depth, current_depth + 1)
                 map_from_child.each do |key, value|
                     map[key] = value 
                 end
@@ -437,4 +527,183 @@ module Wads
             map
         end
     end
+
+    class GraphReverseIterator
+        attr_accessor :output
+        def initialize(graph) 
+            @output = []
+            graph.root_nodes.each do |root|
+                partial_list = process_node(root)
+                @output.push(*partial_list)
+            end 
+        end 
+    
+        def process_node(node)
+            list = []
+            node.outputs.each do |child_node|
+                if child_node.is_a? Edge 
+                    child_node = child_node.destination 
+                end
+                child_list = process_node(child_node)
+                list.push(*child_list)
+            end 
+    
+            list << node
+            list
+        end    
+    end 
+
+    class VisibleRange
+        attr_accessor :left_x
+        attr_accessor :right_x
+        attr_accessor :bottom_y
+        attr_accessor :top_y
+        attr_accessor :x_range
+        attr_accessor :y_range
+        attr_accessor :is_time_based
+
+        def initialize(l, r, b, t, is_time_based = false)
+            if l < r
+                @left_x = l 
+                @right_x = r 
+            else 
+                @left_x = r 
+                @right_x = l 
+            end
+            if b < t
+                @bottom_y = b 
+                @top_y = t 
+            else 
+                @bottom_y = t  
+                @top_y = b 
+            end
+            @x_range = @right_x - @left_x
+            @y_range = @top_y - @bottom_y
+            @is_time_based = is_time_based
+
+            @orig_left_x = @left_x
+            @orig_right_x = @right_x
+            @orig_bottom_y = @bottom_y
+            @orig_top_y = @top_y
+            @orig_range_x = @x_range
+            @orig_range_y = @y_range
+        end
+
+        def plus(other_range)
+            l = @left_x < other_range.left_x ? @left_x : other_range.left_x
+            r = @right_x > other_range.right_x ? @right_x : other_range.right_x
+            b = @bottom_y < other_range.bottom_y ? @bottom_y : other_range.bottom_y
+            t = @top_y > other_range.top_y ? @top_y : other_range.top_y
+            VisibleRange.new(l, r, b, t, (@is_time_based or other_range.is_time_based))
+        end
+
+        def x_ten_percent 
+            @x_range.to_f / 10
+        end 
+
+        def y_ten_percent 
+            @y_range.to_f / 10
+        end 
+
+        def scale(zoom_level)
+            x_mid_point = @orig_left_x + (@orig_range_x.to_f / 2)
+            x_extension = (@orig_range_x.to_f * zoom_level) / 2
+            @left_x = x_mid_point - x_extension
+            @right_x = x_mid_point + x_extension
+
+            y_mid_point = @orig_bottom_y + (@orig_range_y.to_f / 2)
+            y_extension = (@orig_range_y.to_f * zoom_level) / 2
+            @bottom_y = y_mid_point - y_extension
+            @top_y = y_mid_point + y_extension
+
+            @x_range = @right_x - @left_x
+            @y_range = @top_y - @bottom_y
+        end 
+
+        def scroll_up 
+            @bottom_y = @bottom_y + y_ten_percent
+            @top_y = @top_y + y_ten_percent
+            @y_range = @top_y - @bottom_y
+        end
+
+        def scroll_down
+            @bottom_y = @bottom_y - y_ten_percent
+            @top_y = @top_y - y_ten_percent
+            @y_range = @top_y - @bottom_y
+        end
+
+        def scroll_right
+            @left_x = @left_x + x_ten_percent
+            @right_x = @right_x + x_ten_percent
+            @x_range = @right_x - @left_x
+        end
+
+        def scroll_left
+            @left_x = @left_x - x_ten_percent
+            @right_x = @right_x - x_ten_percent
+            @x_range = @right_x - @left_x
+        end
+
+        def grid_line_x_values
+            if @cached_grid_line_x_values
+                return @cached_grid_line_x_values 
+            end
+            @cached_grid_line_x_values = divide_range_into_values(@x_range, @left_x, @right_x, false)
+            @cached_grid_line_x_values
+        end
+
+        def grid_line_y_values
+            if @cached_grid_line_y_values
+                return @cached_grid_line_y_values 
+            end
+            @cached_grid_line_y_values = divide_range_into_values(@y_range, @bottom_y, @top_y, false)
+            @cached_grid_line_y_values
+        end
+
+        def calc_x_values
+            if @cached_calc_x_values
+                return @cached_calc_x_values 
+            end
+            @cached_calc_x_values = divide_range_into_values(@x_range, @left_x, @right_x)
+            #puts "The x_axis value to calculate are: #{@cached_calc_x_values}"
+            @cached_calc_x_values
+        end
+
+        def clear_cache
+            @cached_grid_line_x_values = nil
+            @cached_grid_line_y_values = nil
+            @cached_calc_x_values = nil
+        end
+
+        # This method determines what are equidistant points along
+        # the x-axis that we can use to draw gridlines and calculate
+        # derived values from functions
+        def divide_range_into_values(range_size, start_value, end_value, is_derived_values = true)
+            values = []
+            # How big is x-range? What should the step size be?
+            # Generally we want a hundred display points. Let's start there.
+            if range_size < 1.1
+                step_size = is_derived_values ? 0.01 : 0.1
+            elsif range_size < 11
+                step_size = is_derived_values ? 0.1 : 1
+            elsif range_size < 111
+                step_size = is_derived_values ? 1 : 10
+            elsif range_size < 1111
+                step_size = is_derived_values ? 10 : 100
+            elsif range_size < 11111
+                step_size = is_derived_values ? 100 : 1000
+            elsif range_size < 111111
+                step_size = is_derived_values ? 1000 : 10000
+            else 
+                step_size = is_derived_values ? 10000 : 100000
+            end
+            grid_x = start_value
+            while grid_x < end_value
+                values << grid_x
+                grid_x = grid_x + step_size
+            end
+            values
+        end
+    end
+
 end