wads 0.1.2 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2652d96c92be67ffd117365e2eb1ed93c21fd6f6c83cae037c6761f3f70754d5
-  data.tar.gz: e1680952ab2bdd333bc518ae7d97bca0a8bfc4033e2b0b9f8bf062e689ee22e9
+  metadata.gz: 51b79bd0bfafd0b02a32240f3410d4d5fcfdef5938f1a9fe23e4d89914f778d0
+  data.tar.gz: 8ab8279ec6ed32b2c64b5f637d9c6db13e5fd7f157d24ea6c8d59ee4818649d5
 SHA512:
-  metadata.gz: 2e07cd62b59ca7d4e73176a94f3396f37f2981b6d448ebdd9490f9b6d5c0a69e0cd531805fed3e5512435b2d9a669521b1a047e0d022dd9ee0fb1ffb9ddd1941
-  data.tar.gz: 9189a546fe8c0f74fa0e18abbca8de17eacd70b63b7092e09374b4315f832ed359f62add905a3ce9c82641728b569846fc44f04007b2e14bcdb28e0608f35e3d
+  metadata.gz: 9f0e2d5d176468c106c290845767d27dc520bcd5009e4d30d4caa5c0e4bb93c4dfe861084660d0dd6ddd2f401f3fe274fc3816e1febc5a64808b4291199ef1a8
+  data.tar.gz: 14120137ff1e6a7398b3ae1a858127bfd37a072df1485777c36aab4888e3e7fd412a8f43e949efbdd766c24d51d23d0de93b82ae92cc88b2f6a32aa5c9a33619

data/CHANGELOG.md

@@ -10,3 +10,10 @@
 
 - Fixed bugs with data structures. Added convenience methods to manage child widgets
 
+## [0.1.3] - 2021-09-30
+
+- Improvements to graph display including user ability to change focus node
+
+## [0.2.0] - 2021-10-05
+
+- Breaking change in order to refactor, including standardizing order of widget constructor args

data/README.md

@@ -2,6 +2,17 @@
 
 A number of Ruby Gosu-based (W)idgets (a)nd (D)ata (S)tructures for your applications.
 
+The user guide and examples can be found at https://www.rubydoesitagain.com
+
+Wads (Widgets and Data Structures) is intended to help you quickly build native Ruby applications using the Gosu gem.
+GUI widgets, such as tables and buttons, are provided to simplify building graphical applications.
+Widgets in wads can be used independently within your Gosu app, or you can use wads as a holistic GUI framework.
+Wads includes basic features found in many GUI toolkits including The use of themes and a layout manager.
+
+One of the motivations for creating wads is to making data analysis, games, and productivity applications using Ruby easier to do.
+Data structures are included that can be used for statistical analysis or graph-based applications.
+The samples provided illustrate both use cases (Stocks - stats) and Star Wars character interactions (graphs).
+
 ![alt Screenshot](https://github.com/dbroemme/ruby-wads/blob/main/media/WadsScreenshot.png?raw=true)
 ## Installation
 
@@ -27,6 +38,9 @@ cd ruby-wads
 This will run the sample NASDAQ stocks analysis that features the use of the 
 Stats class, and a table Gosu widget used to display the results of the analysis.
 
+![alt Screenshot](https://github.com/dbroemme/ruby-wads/blob/main/media/StocksSample.png?raw=true)
+
+
 You can also see the graph capabilities by running the Star Wars analysis example.
 This uses a data set that captures all character interactions within Episode 4.
 
@@ -38,6 +52,34 @@ There is also a sample Graph display using the following command.
 ```
 ./run-sample-app -g
 ```
+Note that you can construct graphs in one of two ways. The first approach uses Nodes directly.
+```
+root = Node.new("a")
+b = root.add("b")
+b.add("d")
+b.add("e").add("f")
+root.add("c")
+Graph.new(root)
+```
+The second approach uses an overarching Graph object. 
+```
+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")
+```
+
+Currently, the Graph object is used by the Graph Widget for display. For the code above, this appears by default as follows:
+
+![alt Screenshot](https://github.com/dbroemme/ruby-wads/blob/main/media/SampleGraph.png?raw=true)
 
 ## References
 

data/data/sample_graph.csv

@@ -0,0 +1,11 @@
+N,A,color=COLOR_YELLOW
+N,B,color=COLOR_GREEN
+N,C,color=COLOR_BLUE
+N,D,color=COLOR_RED
+N,E,color=COLOR_PURPLE
+N,F,color=COLOR_GRAY
+C,A,B
+C,A,C
+C,B,D
+C,B,E
+C,E,F

data/lib/wads/app.rb

@@ -1,340 +1,73 @@
 require 'gosu'
-require 'json'
-require_relative 'data_structures'
 require_relative 'widgets'
-require_relative 'version'
 
-include Wads
-
-class WadsSampleApp < Gosu::Window
-    
-    STOCKS_DATA_FILE = "./data/NASDAQ.csv"
-    LOTTERY_DATA_FILE = "./data/Pick4_12_21_2020.txt"
-    STAR_WARS_DATA_FILE = "./data/starwars-episode-4-interactions.json"
-
-    def initialize
-        super(800, 600)
-        self.caption = "Wads Sample App"
-        @font = Gosu::Font.new(32)
-        @title_font = Gosu::Font.new(38)
-        @version_font = Gosu::Font.new(22)
-        @small_font = Gosu::Font.new(22)
-        @banner_image = Gosu::Image.new("./media/Banner.png")
-        @display_widget = nil
-        @update_count = 0
-    end 
+module Wads
+    #
+    # The WadsApp class provides a simple starting point to quickly build a native
+    # Ruby application using Gosu as an underlying library. It provides all the necessary
+    # hooks to get started. All you need to do is supply the parent Wads widget using
+    # the set_display(widget) method. See one of the Wads samples for example usage.
+    #
+    class WadsApp < Gosu::Window
+        def initialize(width, height, caption, widget)
+            super(width, height)
+            self.caption = caption
+            @update_count = 0
+            WadsConfig.instance.set_window(self)
+            set_display(widget) 
+            WadsConfig.instance.set_log_level("info")
+            @registered_hold_down_buttons = []
+        end 
 
-    def parse_opts_and_run 
-        # Make help the default output if no args are specified
-        if ARGV.length == 0
-            ARGV[0] = "-h"
+        #
+        # This method must be invoked with any Wads::Widget instance. It then handles
+        # delegating all events and drawing all child widgets.
+        #
+        def set_display(widget) 
+            @main_widget = widget 
         end
 
-        opts = SampleAppCommand.new.parse.run
-        if opts[:stocks]
-            stats = process_stock_data
-            if opts[:text]
-                stats.report(Date::DAYNAMES[1..5])
-            else 
-                @display_widget = SampleStocksDisplay.new(@small_font, stats)
-                show
-            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 "-g   Run sample graph display"
-            puts " "
-            exit
+        def get_display
+            @main_widget
         end
 
-    end
-
-    def update 
-        @display_widget.update(@update_count, mouse_x, mouse_y)
-        @update_count = @update_count + 1
-    end 
-    
-    def draw
-        draw_banner
-        @display_widget.draw
-    end 
-
-    def draw_banner 
-        @banner_image.draw(1,1,1,0.9,0.9)
-        @title_font.draw_text("Wads Sample App", 10, 20, 2, 1, 1, Gosu::Color::WHITE)
-        @version_font.draw_text("Version #{Wads::VERSION}", 13, 54, 2, 1, 1, Gosu::Color::WHITE)
-    end
-
-    def button_down id
-        close if id == Gosu::KbEscape
-        # Delegate button events to the primary display widget
-        result = @display_widget.button_down id, mouse_x, mouse_y
-        if not result.nil? and result.is_a? WidgetResult
-            if result.close_widget
-                close
-            end
+        # Register a key (identified by the Gosu id) to check if it is being held down.
+        # If so, the handle_key_held_down callback will be invoked on widgets
+        # For example, register_hold_down_key(Gosu::KbLeft)
+        def register_hold_down_key(id)
+            @registered_hold_down_buttons << id 
         end
-    end
-
-    def button_up id
-        @display_widget.button_up id, mouse_x, mouse_y
-    end
-
-    def process_stock_data 
-        # The data file comes from https://finance.yahoo.com
-        # The format of this file is as follows:
-        #
-        # Date,Open,High,Low,Close,Adj Close,Volume
-        # 2000-01-03,4186.189941,4192.189941,3989.709961,4131.149902,4131.149902,1510070000
-        # 2000-01-04,4020.000000,4073.250000,3898.229980,3901.689941,3901.689941,1511840000
-        # ...
-        # 2020-12-30,12906.509766,12924.929688,12857.759766,12870.000000,12870.000000,5292210000
-        # 2020-12-31,12877.089844,12902.070313,12821.230469,12888.280273,12888.280273,4771390000
-        
-        stats = Stats.new("NASDAQ")
-        previous_close = nil
-        
-        puts "Read the data file #{STOCKS_DATA_FILE}"
-        File.readlines(STOCKS_DATA_FILE).each do |line|
-            line = line.chomp  # remove the carriage return
 
-            # Ignore header and any empty lines, process numeric data lines
-            if line.length > 0 and line[0].match(/[0-9]/)
-                values = line.split(",")
-                date = Date.strptime(values[0], "%Y-%m-%d")
-                weekday = Date::DAYNAMES[date.wday]
+        def update
+            @main_widget.update(@update_count, mouse_x, mouse_y)
 
-                open_value = values[1].to_f
-                close_value = values[4].to_f
-
-                if previous_close.nil?
-                    # Just use the first day to set the baseline
-                    previous_close = close_value
-                else 
-                    change_from_previous_close = close_value - previous_close
-                    change_intraday = close_value - open_value
-                    change_overnight = open_value - previous_close
-                    
-                    change_percent = change_from_previous_close / previous_close
-
-                    stats.add(weekday, change_percent)
-                    stats.add("#{weekday} prev close", change_from_previous_close)
-                    stats.add("#{weekday} intraday", change_intraday)
-                    stats.add("#{weekday} overnight", change_overnight)
-
-                    previous_close = close_value
+            # Look for keys that are held down and delegate those events
+            @registered_hold_down_buttons.each do |id|
+                if button_down?(id)
+                    @main_widget.handle_key_held_down id, mouse_x, mouse_y 
                 end
             end
-        end
 
-        stats
-    end
-
-    def process_lottery_data
-        puts "The lottery example has not been implemented yet"
-        puts "however the data is available in the data directory,"
-        puts "and the same pattern used in the stocks example can"
-        puts "be applied here."
-    end
-
-    def process_star_wars_data 
-        star_wars_json = File.read(STAR_WARS_DATA_FILE)
-        data_hash = JSON.parse(star_wars_json)
-        characters = data_hash['nodes']
-        interactions = data_hash['links']
-
-        # The interactions in the data set reference the characters by their
-        # zero based index, so we keep a reference in our graph by index.
-        # The character's value is the number of scenes in which they appear.
-        graph = Graph.new
-        characters.each do |character|
-            node_tags = {}
-            node_color_str = character['colour']
-            # This is a bit of a hack, but our background is black so black text
-            # will not show up. Change this to white
-            if node_color_str == "#000000"
-                node_color_str = "#FFFFFF"
-            end
-            # Convert hex string (ex. "#EE00AA") into int hex representation
-            # understood by Gosu color (ex. 0xFFEE00AA)
-            node_color = "0xFF#{node_color_str[1..-1]}".to_i(16)
-            node_tags['color'] = node_color
-            graph.add_node(Node.new(character['name'], character['value'], node_tags))
-        end
-        interactions.each do |interaction| 
-            character_one = graph.node_by_index(interaction['source'])
-            character_two = graph.node_by_index(interaction['target'])
-            number_of_scenes_together = interaction['value']
-            edge_tags = {}
-            edge_tags["scenes"] = number_of_scenes_together
-            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
-    attr_accessor :stats
-
-    def initialize(font, stats)
-        super(10, 100, COLOR_HEADER_BRIGHT_BLUE)
-        set_dimensions(780, 500)
-        set_font(font)
-        add_document(sample_content, 5, 5, @width, @height)
-        add_button("Exit", 380, @height - 30) do
-            WidgetResult.new(true)
-        end
-
-        @stats = stats
-        @data_table = add_single_select_table(5, 100,             # top left corner
-                                              770, 200,           # width, height
-            ["Day", "Min", "Avg", "StdDev", "Max", "p10", "p90"], # column headers
-                                              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))
-            avg = format_percent(@stats.average(day))
-            std = format_percent(@stats.std_dev(day))
-            max = format_percent(@stats.max(day))
-            p10 = format_percent(@stats.percentile(day, 0.1))
-            p90 = format_percent(@stats.percentile(day, 0.90))
-            @data_table.add_row([day, min, avg, std, max, p10, p90], COLOR_HEADER_BRIGHT_BLUE)
-        end
-
-        @selection_text = nil
-    end 
-
-    def format_percent(val)
-        "#{(val * 100).round(3)}%"
-    end
-
-    def sample_content
-        <<~HEREDOC
-          This sample stock analysis uses NASDAQ data from https://finance.yahoo.com looking
-          at closing data through the years 2000 to 2020. The percent gain or loss is broken
-          down per day, as shown in the table below.
-        HEREDOC
-    end
-
-    def render 
-        if @selection_text
-            @selection_text.draw 
-        end
-    end 
-
-    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    
+            @update_count = @update_count + 1
+        end 
+    
+        def draw
+            @main_widget.draw
         end
-        nil
-    end 
-end
 
-class SampleStarWarsDisplay < Widget
-    attr_accessor :graph
-
-    def initialize(font, graph)
-        super(10, 100, COLOR_HEADER_BRIGHT_BLUE)
-        set_dimensions(780, 500)
-        set_font(font)
-        @graph = graph
-
-        add_document(sample_content, 5, 5, @width, @height)
-        add_button("Exit", 370, @height - 30) do
-            WidgetResult.new(true)
+        def button_down id
+            close if id == Gosu::KbEscape
+            # Delegate button events to the primary display widget
+            result = @main_widget.button_down id, mouse_x, mouse_y
+            if not result.nil? and result.is_a? WidgetResult
+                if result.close_widget
+                    close
+                end
+            end
         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"))
+    
+        def button_up id
+            @main_widget.button_up id, mouse_x, mouse_y
         end
-        @graph_display = add_graph_display(5, 260, 770, 200, @graph)
     end 
-
-    def sample_content
-        <<~HEREDOC
-          This sample analysis shows the interactions between characters in the Star Wars
-          Episode 4: A New Hope. Click on a character to see more detail.
-        HEREDOC
-    end
-
-    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 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