sirens 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cf56c70a10adabf89009041d21ca90c692fd6a6c81e1fb4c69ba3e4a47a24dbd
+  data.tar.gz: d287ee12c0382bf83b2e26d747875e74b4307b4a346638b2f5b412d97f978984
+SHA512:
+  metadata.gz: 47c7e60f0d3667ec1631ac89a10e0ab4d39643e9d6249d03f943e5c134398bd942449c89ecd1430a23c2a58ef2d9e89c611d477e658bf0e2ea1b62fef0dff48c
+  data.tar.gz: 8bee3cb065fbe8b7039bc8d8abf7d3bc7eacd31ea406f68b065ebe5f004c40b27302d83d1b8519747f1caebf77a77b8f7a159e3e8da3922a7003ac9d48093b55

data/lib/components/component.rb

@@ -0,0 +1,46 @@
+module Sirens
+    class Component
+        include ComponentBehaviour
+
+
+        # Initializing
+
+        ##
+        # Initializes this component
+        #
+        def initialize(props = Hash[])
+            super(props)
+
+            build
+        end
+
+        ##
+        # Configures the widget with its model, styles and child widgets but does not apply the styles yet.
+        # This method is called when opening a widget with ::open and after calling ::initialize_handles.
+        # The building of the widget includes defining its model, its style props and its event blocks,
+        # but does no apply those styles yet. The wiring and synchronization of the component to the
+        # widget is done in the ::post_build method.
+        #
+        def build()
+            set_model( props.key?(:model) ? props[:model] : default_model )
+
+            renderWith(LayoutBuilder.new(main_component: self))
+
+            self
+        end
+
+        ##
+        # Hook method to allow each Component subclass to define its default styles and compose its child components.
+        # Subclasses are expected to implement this method.
+        def renderWith(layout)
+            raise RuntimeError.new("Class #{self.class.name} must implement a ::renderWith(layout) method.")
+        end
+
+        ##
+        # Returns the top most view of this component.
+        #
+        def main_view()
+            main_component.main_view
+        end
+    end
+end

data/lib/components/component_behaviour.rb

@@ -0,0 +1,160 @@
+module Sirens
+    module ComponentBehaviour
+        module ClassMethods
+            # Opening
+
+            ##
+            # Todo: Opens a new window with this component. Currently only works for actual Windows.
+            #
+            def open(props = Hash[])
+                self.new(props)
+                    .open
+            end
+        end
+
+        def self.included(base)
+            base.extend(ClassMethods)
+        end
+
+        # Initializing
+
+        ##
+        # Initializes this component.
+        #
+        def initialize(props = Hash[])
+            super()
+
+            @props = Hash[]
+            @components = []
+
+            set_props(props)
+        end
+
+        # Accessing
+
+        ##
+        # Returns this component props.
+        #
+        def props()
+            @props
+        end
+
+        ##
+        # Applies the given props to the current component.props.
+        # The component.props that are not included in given props remain untouched.
+        #
+        def set_props(props)
+            @props.merge!(props)
+        end
+
+        ##
+        # Returns the child components of this component.
+        #
+        def components()
+            @components
+        end
+
+        ##
+        # Returns the main child component.
+        #
+        def main_component()
+            @components.first
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            nil
+        end
+
+        ##
+        # Returns the current model of this component.
+        #
+        def model()
+            @props[:model]
+        end
+
+        ##
+        # Sets the current model of this component.
+        #
+        def set_model(new_model)
+            old_model = model
+
+            @props[:model] = new_model
+
+            on_model_changed(new_model: new_model, old_model: old_model)
+        end
+
+        def on_model_changed(new_model:, old_model:)
+        end
+
+        # Child components
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def add_component(child_component)
+            components << child_component
+
+            on_component_added(child_component)
+
+            child_component
+        end
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def add_all_components(components)
+            components.each do |child_component|
+                add_component(child_component)
+            end
+
+            self
+        end
+
+        ##
+        # Removes the last child component and returns it.
+        #
+        def remove_last_component()
+            remove_component_at(index: components.size - 1)
+        end
+
+        ##
+        # Removes the component at the index-th position.
+        #
+        def remove_component_at(index:)
+            component = components.delete_at(index)
+
+            main_view.remove_view(component.main_view)
+
+            component
+        end
+
+        ##
+        # This method is called right after adding a child component.
+        # Subclasses may use it to perform further configuration on this component or its children.
+        #
+        def on_component_added(child_component)
+        end
+
+        ##
+        # Returns the top most view of this component.
+        # This method is required to assemble parent and child views.
+        #
+        def main_view()
+            raise RuntimeError.new("Class #{self.class.name} must implement a ::main_view() method.")
+        end
+
+        ##
+        # Todo: Opens this component in a Window.
+        # At this moment only works if the main_component is a window.
+        #
+        def open()
+            main_component.show
+
+            self
+        end
+
+    end
+end

data/lib/components/containers/splitter.rb

@@ -0,0 +1,98 @@
+module Sirens
+    ##
+    # Component that wraps a StackView.
+    #
+    class Splitter < PrimitiveComponent
+
+        # Class methods
+
+        class << self
+            def horizontal(props = Hash[])
+                props[:orientation] = :horizontal
+
+                self.new(props)
+            end
+
+            def vertical(props = Hash[])
+                props[:orientation] = :vertical
+
+                self.new(props)
+            end
+        end
+
+        ##
+        # Returns a PanedView.
+        #
+        def create_view()
+            PanedView.new(
+                orientation: props.fetch(:orientation),
+                on_size_allocation: proc{ |width:, height:|
+                    on_size_allocation(width: width, height: height)
+                }
+            )
+        end
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def add_component(child_component)
+            if components.size < 2
+                components << child_component
+
+                on_component_added(child_component)
+
+                return
+            end
+
+            last_child = remove_last_component
+
+            new_splitter_proportion = 1.0 - components.first.props[:splitter_proportion]
+
+            new_splitter = self.class.new(orientation: orientation)
+
+            last_child.props[:splitter_proportion] = last_child.props[:splitter_proportion] / new_splitter_proportion
+            new_splitter.add_component(last_child)
+
+            child_component.props[:splitter_proportion] = child_component.props[:splitter_proportion] / new_splitter_proportion
+            new_splitter.add_component(child_component)
+
+            components << new_splitter
+            on_component_added(new_splitter)
+        end
+
+        # Asking
+
+        def orientation()
+            props[:orientation]
+        end
+
+        # Events
+
+        def on_size_allocation(width:, height:)
+            components.each do |child_component|
+                size_proportion = child_component.props[:splitter_proportion]
+
+                next if size_proportion.nil?
+
+                if orientation == :vertical
+                    proportional_height = height * size_proportion
+
+                    if child_component.props.key?(:height)
+                        proportional_height = [proportional_height, child_component.props[:height]].max
+                    end
+
+                    child_component.main_view.height = proportional_height
+
+                else
+                    proportional_width = width * size_proportion
+
+                    if child_component.props.key?(:width)
+                        proportional_width = [proportional_width, child_component.props[:width]].max
+                    end
+
+                    child_component.main_view.width = proportional_width
+                end
+            end
+        end
+    end
+end

data/lib/components/containers/stack.rb

@@ -0,0 +1,42 @@
+module Sirens
+    ##
+    # Component that wraps a StackView.
+    #
+    class Stack < PrimitiveComponent
+
+        # Class methods
+
+        class << self
+            def horizontal(props = Hash[])
+                props[:orientation] = :horizontal
+
+                self.new(props)
+            end
+
+            def vertical(props = Hash[])
+                props[:orientation] = :vertical
+
+                self.new(props)
+            end
+        end
+
+        ##
+        # Returns a StackView.
+        #
+        def create_view()
+            StackView.new(props.fetch(:orientation))
+        end
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def on_component_added(child_component)
+            view.add_view(
+                child_component.main_view,
+                expand: child_component.props.fetch(:stack_expand, true),
+                fill: child_component.props.fetch(:stack_fill, true),
+                padding: child_component.props.fetch(:stack_padding, 0)
+            )
+        end
+    end
+end

data/lib/components/containers/tabs.rb

@@ -0,0 +1,24 @@
+module Sirens
+    ##
+    # Component that wraps a NotebookView.
+    #
+    class Tabs < PrimitiveComponent
+        ##
+        # Returns a StackView.
+        #
+        def create_view()
+            NotebookView.new
+        end
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def on_component_added(child_component)
+            super(child_component)
+
+            tab_label_text = child_component.props[:tab_label]
+
+            view.set_tab_label_at(index: components.size - 1, text: tab_label_text)
+        end
+    end
+end

data/lib/components/containers/window.rb

@@ -0,0 +1,20 @@
+module Sirens
+    ##
+    # Component that wraps a WindowView.
+    #
+    class Window < PrimitiveComponent
+        ##
+        # Returns a WindowView.
+        #
+        def create_view()
+            WindowView.new
+        end
+
+        ##
+        # Makes this component visible.
+        #
+        def show()
+            view.show
+        end
+    end
+end

data/lib/components/primitive_component.rb

@@ -0,0 +1,155 @@
+module Sirens
+    ##
+    # PrimitiveComponent is a component wrapping a PrimitiveView.
+    # A PrimitiveView implements the actual GUI binding to a Widget (a Gtk widget, for instance).
+    # Besides acting as a regular Component, PrimitiveComponent also takes care of handling the PrimitiveView.
+    #
+    class PrimitiveComponent
+        include ComponentBehaviour
+
+        # Initializing
+
+        ##
+        # Initializes this component
+        #
+        def initialize(props = Hash[])
+            super(props)
+
+            @view = create_view
+
+            @updating_view = false
+
+            apply_props
+
+            sync_ui_from_model
+        end
+
+        ##
+        # Applies the props to the view.
+        #
+        def apply_props()
+            if ! view.nil?
+                @view.apply_props(props)
+
+                @view.populate_popup_menu_block = proc { |menu:| populate_popup_menu(menu: menu) }
+            end
+
+            set_model( props.key?(:model) ? props[:model] : default_model )
+        end
+
+        ##
+        # Creates the PrimitiveView that this component wraps.
+        # This method must be implemented by each subclass.
+        #
+        def create_view()
+            raise RuntimeError.new("Class #{self.class.name} must implement a ::create_view() method.")
+        end
+
+        # Accessing
+
+        ##
+        # Applies the given props to the current component.props.
+        # The component.props that are not included in given props remain untouched.
+        #
+        def set_props(props)
+            super(props)
+
+            apply_props
+
+            sync_ui_from_model if props.key?(:model)
+        end
+
+        ##
+        # Returns this component View.
+        #
+        def view()
+            @view
+        end
+
+        ##
+        # Returns the top most view of this component.
+        #
+        def main_view()
+            view
+        end
+
+        # Child components
+
+        ##
+        # Adds the child_component to this component.
+        #
+        def on_component_added(child_component)
+            view.add_view(child_component.main_view)
+        end
+
+        # Events
+
+        ##
+        # Method called when this component model changes.
+        # Unsubscribes this component from the current model events, subscribes this component to the
+        # new model events and syncs the widget with the new model.
+        #
+        def on_model_changed(old_model:, new_model:)
+            old_model.delete_observer(self) if old_model.respond_to?(:delete_observer)
+
+            subscribe_to_model_events
+
+            sync_ui_from_model
+        end
+
+        ##
+        # Subscribes this component to the model events
+        #
+        def subscribe_to_model_events()
+            model.add_observer(self, :on_value_changed) if model.respond_to?(:add_observer)
+        end
+
+        ##
+        # Hook method called when the model value changes.
+        # Note that the model remains the same, what changed is the value the model holds.
+        # Subclasses may use this method to update other aspects of its model or perform actions.
+        #
+        def on_value_changed(announcement)
+            sync_ui_from_model
+        end
+
+        ##
+        # Populate the popup menu.
+        #
+        def populate_popup_menu(menu:)
+            return if props[:popup_menu].nil?
+
+            props[:popup_menu].call(menu: menu, menu_owner: self)
+        end
+
+        # Actions
+
+        ##
+        # Synchronizes the view to the models current state.
+        #
+        def sync_ui_from_model()
+        end
+
+        ##
+        # Returns true if this component is currently updating the view.
+        #
+        def is_updating_view?()
+            @updating_view
+        end
+
+        ##
+        # Flags that this component is updating the view during the evaluation of the given &block.
+        #
+        def while_updating_view(&block)
+            updating = is_updating_view?
+
+            @updating_view = true
+
+            begin
+                block.call
+            ensure
+                @updating_view = updating
+            end
+         end
+    end
+end

data/lib/components/widgets/button.rb

@@ -0,0 +1,16 @@
+module Sirens
+    class Button < PrimitiveComponent
+        ##
+        # Returns a ButtonView.
+        #
+        def create_view()
+            ButtonView.new
+        end
+
+        # Actions
+
+        def click()
+            view.click
+        end
+    end
+end

data/lib/components/widgets/checkbox.rb

@@ -0,0 +1,39 @@
+module Sirens
+    class Checkbox < PrimitiveComponent
+        ##
+        # Returns a CheckButtonView.
+        #
+        def create_view()
+            CheckButtonView.new(on_toggled: proc{ |state:| on_toggled(state: state) })
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            ValueModel.on(false)
+        end
+
+        # Actions
+
+        def click()
+            view.click
+        end
+
+        def sync_ui_from_model()
+            view.set_value(model.value) unless view.nil?
+        end
+
+        # Events
+
+        def on_value_changed(announcement)
+            view.set_value(announcement.new_value)
+        end
+
+        def on_toggled(state:)
+            return if model.nil?
+
+            model.set_value(state)
+        end
+    end
+end

data/lib/components/widgets/column_props.rb

@@ -0,0 +1,23 @@
+module Sirens
+    class ColumnProps
+        def initialize(props = Hash[])
+            @props = props
+        end
+
+         attr_reader :props
+
+        def fetch(key, absent_value)
+            @props.fetch(key, absent_value)
+        end
+
+        def [](key)
+            @props[key]
+        end
+
+        def display_text_of(item)
+            return item.to_s if ! @props.key?(:get_text_block)
+
+            @props[:get_text_block].call(item)
+        end
+    end
+end

data/lib/components/widgets/input_text.rb

@@ -0,0 +1,27 @@
+module Sirens
+    class InputText < PrimitiveComponent
+        ##
+        # Returns a TextView.
+        #
+        def create_view()
+            EntryView.new
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            ValueModel.on('')
+        end
+
+        def sync_ui_from_model()
+            view.set_text(model.value) unless view.nil?
+        end
+
+        # Events
+
+        def on_value_changed(announcement)
+            view.set_text(announcement.new_value)
+        end
+    end
+end