sirens 0.0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cf56c70a10adabf89009041d21ca90c692fd6a6c81e1fb4c69ba3e4a47a24dbd
-  data.tar.gz: d287ee12c0382bf83b2e26d747875e74b4307b4a346638b2f5b412d97f978984
+  metadata.gz: 997719a31c64b52ed18fdc3b35f6dd03faec3486dfc9a25a26df39c769ef63b7
+  data.tar.gz: ab26f2627e38e683e16c3dcb86ea911056da4b72069933da3812126321ee1ebd
 SHA512:
-  metadata.gz: 47c7e60f0d3667ec1631ac89a10e0ab4d39643e9d6249d03f943e5c134398bd942449c89ecd1430a23c2a58ef2d9e89c611d477e658bf0e2ea1b62fef0dff48c
-  data.tar.gz: 8bee3cb065fbe8b7039bc8d8abf7d3bc7eacd31ea406f68b065ebe5f004c40b27302d83d1b8519747f1caebf77a77b8f7a159e3e8da3922a7003ac9d48093b55
+  metadata.gz: f9a647ae5352f583165108ec15cbea29e097db20e67425d008b9dd7e19e90e8da048a123b4f94416a82ddf07ce7f97955a0d91f0b9f6b93e473e8f5acca48c2a
+  data.tar.gz: b2804ce2f735a7be3ccf0f64bbccc8346e3778a03913355cbc8a38001d41ba2073d0ea1c7ef178e5ce230a088c0b329724c8dce3637903bea668a66e9d3f17e5

data/lib/components/{component_behaviour.rb → abstract_component.rb}

@@ -1,19 +1,14 @@
 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
+    class AbstractComponent
+        # Opening
 
-        def self.included(base)
-            base.extend(ClassMethods)
+        ##
+        # Todo: Opens a new window with this component. Currently only works for actual Windows.
+        #
+        def self.open(props = Hash[])
+            self.new(props).tap { |window|
+                window.open
+            }
         end
 
         # Initializing
@@ -25,9 +20,18 @@ module Sirens
             super()
 
             @props = Hash[]
-            @components = []
+            @child_components = []
+            @props = props
 
-            set_props(props)
+            @view = create_view
+        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
@@ -50,15 +54,8 @@ module Sirens
         ##
         # Returns the child components of this component.
         #
-        def components()
-            @components
-        end
-
-        ##
-        # Returns the main child component.
-        #
-        def main_component()
-            @components.first
+        def child_components()
+            @child_components
         end
 
         ##
@@ -86,7 +83,11 @@ module Sirens
             on_model_changed(new_model: new_model, old_model: old_model)
         end
 
-        def on_model_changed(new_model:, old_model:)
+        ##
+        # Returns this component View.
+        #
+        def view()
+            @view
         end
 
         # Child components
@@ -95,7 +96,7 @@ module Sirens
         # Adds the child_component to this component.
         #
         def add_component(child_component)
-            components << child_component
+            @child_components << child_component
 
             on_component_added(child_component)
 
@@ -117,16 +118,16 @@ module Sirens
         # Removes the last child component and returns it.
         #
         def remove_last_component()
-            remove_component_at(index: components.size - 1)
+            remove_component_at(index: @child_components.size - 1)
         end
 
         ##
         # Removes the component at the index-th position.
         #
         def remove_component_at(index:)
-            component = components.delete_at(index)
+            component = @child_components.delete_at(index)
 
-            main_view.remove_view(component.main_view)
+            @view.remove_view(component.view)
 
             component
         end
@@ -138,23 +139,7 @@ module Sirens
         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
+        def on_model_changed(new_model:, old_model:)
         end
-
     end
 end

data/lib/components/component.rb

@@ -1,7 +1,5 @@
 module Sirens
-    class Component
-        include ComponentBehaviour
-
+    class Component < AbstractComponent
 
         # Initializing
 
@@ -14,6 +12,10 @@ module Sirens
             build
         end
 
+        def create_view()
+            ComponentView.new
+        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.
@@ -24,23 +26,36 @@ module Sirens
         def build()
             set_model( props.key?(:model) ? props[:model] : default_model )
 
-            renderWith(LayoutBuilder.new(main_component: self))
+            render_with(LayoutBuilder.new(root_component: self))
 
             self
         end
 
+
+        # Accessing
+    
+        def main_child_component()
+            @child_components.first
+        end
+
+        # Rendering
+
         ##
         # 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.")
+        def render_with(layout)
+            raise RuntimeError.new("Class #{self.class.name} must implement a ::render_with(layout) method.")
         end
 
         ##
-        # Returns the top most view of this component.
+        # Adds the child_component to this component.
         #
-        def main_view()
-            main_component.main_view
+        def on_component_added(child_component)
+            @view.add_view(child_component.view)
+        end
+
+        def open()
+            main_child_component.open
         end
     end
 end

data/lib/components/containers/splitter.rb

@@ -20,79 +20,27 @@ module Sirens
             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)
-                }
-            )
+        def on_component_added(child_component)
+            splitter_proportion = child_component.props.fetch(:splitter_proportion)
+
+            child_component.view.set_attribute(:splitter_proportion, splitter_proportion)
+
+            super(child_component)
         end
 
         ##
-        # Adds the child_component to this component.
+        # Returns a SplitterView.
         #
-        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)
+        def create_view()
+            SplitterView.new(
+                orientation: orientation
+            )
         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
+            props.fetch(:orientation)
         end
     end
 end

data/lib/components/containers/stack.rb

@@ -32,7 +32,7 @@ module Sirens
         #
         def on_component_added(child_component)
             view.add_view(
-                child_component.main_view,
+                child_component.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)

data/lib/components/containers/tabs.rb

@@ -1,13 +1,13 @@
 module Sirens
     ##
-    # Component that wraps a NotebookView.
+    # Component that wraps a TabsView.
     #
     class Tabs < PrimitiveComponent
         ##
         # Returns a StackView.
         #
         def create_view()
-            NotebookView.new
+            TabsView.new
         end
 
         ##
@@ -18,7 +18,7 @@ module Sirens
 
             tab_label_text = child_component.props[:tab_label]
 
-            view.set_tab_label_at(index: components.size - 1, text: tab_label_text)
+            view.set_tab_label_at(index: @child_components.size - 1, text: tab_label_text)
         end
     end
 end

data/lib/components/containers/window.rb

@@ -16,5 +16,9 @@ module Sirens
         def show()
             view.show
         end
+
+        def open()
+            show()
+        end
     end
 end

data/lib/components/primitive_component.rb

@@ -4,8 +4,7 @@ module Sirens
     # 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
+    class PrimitiveComponent < AbstractComponent
 
         # Initializing
 
@@ -15,10 +14,6 @@ module Sirens
         def initialize(props = Hash[])
             super(props)
 
-            @view = create_view
-
-            @updating_view = false
-
             apply_props
 
             sync_ui_from_model
@@ -28,23 +23,13 @@ module Sirens
         # Applies the props to the view.
         #
         def apply_props()
-            if ! view.nil?
-                @view.apply_props(props)
+            @view.apply_props(props)
 
-                @view.populate_popup_menu_block = proc { |menu:| populate_popup_menu(menu: menu) }
-            end
+            @view.populate_popup_menu_block = proc { |menu:| populate_popup_menu(menu: menu) }
 
             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
 
         ##
@@ -55,22 +40,6 @@ module Sirens
             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
@@ -79,7 +48,7 @@ module Sirens
         # Adds the child_component to this component.
         #
         def on_component_added(child_component)
-            view.add_view(child_component.main_view)
+            @view.add_view(child_component.view)
         end
 
         # Events
@@ -129,27 +98,5 @@ module Sirens
         #
         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