sirens 0.0.1

data/lib/components/widgets/list.rb

@@ -0,0 +1,68 @@
+module Sirens
+    class List < PrimitiveComponent
+        ##
+        # Returns a ListView.
+        #
+        def create_view()
+            ListView.new
+                .on_selection_changed_block { |selection_items:, selection_indices:|
+                        on_selection_changed(selection_items: selection_items, selection_indices: selection_indices)
+                    }
+                .get_item_block { |index| model.item_at(index: index) }
+        end
+
+        ##
+        # Defines the columns in the list with the given columns_props.
+        # column_props is an Array of props Hashes, one Hash for each column to define.
+        #
+        def define_columns(columns_props_array)
+            view.define_columns(columns_props_array)
+
+            # Sync again after adding the columns.
+            sync_ui_from_model
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            ListModel.new
+        end
+
+        ##
+        # Hook method called when the model value changes.
+        #
+        def on_value_changed(announcement)
+            if announcement.kind_of?(ListChanged)
+                sync_ui_from_model
+            elsif announcement.kind_of?(ItemsAdded)
+                view.add_items(items: announcement.items, index: announcement.index)
+            elsif announcement.kind_of?(ItemsUpdated)
+                view.update_items(items: announcement.items, indices: announcement.indices)
+            elsif announcement.kind_of?(ItemsRemoved)
+                view.remove_items(items: announcement.items, indices: announcement.indices)
+            else
+                raise RuntimeError.new("Unknown announcement #{announcement.class.name}.")
+            end
+        end
+
+        def sync_ui_from_model()
+            return if view.nil?
+
+            view.clear_items
+            view.add_items(items: model.list, index: 0)
+        end
+
+        # Events
+
+        def on_selection_changed(selection_items:, selection_indices:)
+            return if props[:on_selection_changed].nil?
+
+            props[:on_selection_changed].call(
+                selection: selection_items,
+                indices: selection_indices,
+                list: self
+            )
+        end
+    end
+end

data/lib/components/widgets/list_choice.rb

@@ -0,0 +1,89 @@
+module Sirens
+    class ListChoice < PrimitiveComponent
+        ##
+        # Returns a WindowView.
+        #
+        def create_view()
+            ListView.new
+                .on_selection_changed_block { |selection_items:, selection_indices:|
+                        on_selection_changed(selection_items: selection_items, selection_indices: selection_indices)
+                    }
+                .get_item_block { |index| model.item_at(index: index) }
+        end
+
+        ##
+        # Defines the columns in the list with the given columns_props.
+        # column_props is an Array of props Hashes, one Hash for each column to define.
+        #
+        def define_columns(columns_props_array)
+            view.define_columns(columns_props_array)
+
+            # Sync again after adding the columns.
+            sync_ui_from_model
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            ChoiceModel.new
+        end
+
+        ##
+        # Returns the choices list
+        #
+        def choices()
+            model.choices
+        end
+
+        ##
+        # Subscribes this component to the model events
+        #
+        def subscribe_to_model_events()
+            model.choices.add_observer(self, :on_choices_changed)
+            model.selection.add_observer(self, :on_selected_value_changed)
+        end
+
+        ##
+        # Method called when the choices list changes in the model.
+        #
+        def on_choices_changed(announcement)
+            if announcement.kind_of?(ListChanged)
+                sync_ui_from_model
+            elsif announcement.kind_of?(ItemsAdded)
+                view.add_items(items: announcement.items, index: announcement.index)
+            elsif announcement.kind_of?(ItemsUpdated)
+                view.update_items(items: announcement.items, indices: announcement.indices)
+            elsif announcement.kind_of?(ItemsRemoved)
+                view.remove_items(items: announcement.items, indices: announcement.indices)
+            else
+                raise RuntimeError.new("Unknown announcement #{announcement.class.name}.")
+            end
+        end
+
+        ##
+        # Method called when the selected choice changes in the model.
+        #
+        def on_selected_value_changed(announcement)
+            selected_value = announcement.new_value
+
+            selection = choices.list.index(selected_value)
+
+            selection.nil? ?
+                view.set_selection_indices([]) : view.set_selection_indices([selection])
+        end
+
+        def sync_ui_from_model()
+            return if view.nil?
+
+            view.clear_items
+            view.add_items(items: choices.list, index: 0)
+        end
+
+        # Events
+
+        def on_selection_changed(selection_items:, selection_indices:)
+            model.set_selection(selection_items.first) unless model.nil?
+        end
+    end
+end

data/lib/components/widgets/radio_button.rb

@@ -0,0 +1,33 @@
+module Sirens
+    class RadioButton < PrimitiveComponent
+        ##
+        # Returns a ButtonView.
+        #
+        def create_view()
+            previous_button = props[:previous_button].nil? ? nil : props[:previous_button].view
+
+            RadioButtonView.new(
+                previous_button: previous_button,
+                on_toggled: proc{ |state:| on_toggled(state: state) }
+            )
+        end
+
+        # Actions
+
+        def click()
+            view.click
+        end
+
+        # Events
+
+        def on_value_changed(announcement)
+            view.set_value(announcement.new_value)
+        end
+
+        def on_toggled(state:)
+            return if model.nil?
+
+            model.set_selection(props[:id]) if state == true
+        end
+    end
+end

data/lib/components/widgets/text.rb

@@ -0,0 +1,31 @@
+module Sirens
+    class Text < PrimitiveComponent
+        ##
+        # Returns a TextView.
+        #
+        def create_view()
+            TextView.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
+
+        def selected_text()
+            view.selected_text
+        end
+
+        # Events
+
+        def on_value_changed(announcement)
+            view.set_text(announcement.new_value)
+        end
+    end
+end

data/lib/components/widgets/tree_choice.rb

@@ -0,0 +1,82 @@
+module Sirens
+    class TreeChoice < PrimitiveComponent
+        ##
+        # Returns a WindowView.
+        #
+        def create_view()
+            TreeView.new
+                .on_selection_changed_block { |selection_items:, selection_paths:|
+                        on_selection_changed(selection_items: selection_items, selection_paths: selection_paths)
+                    }
+                .get_item_block { |path:| model.item_at(path: path) }
+                .get_children_block { |path:| model.children_at(path: path) }
+        end
+
+        ##
+        # Defines the columns in the list with the given columns_props.
+        # column_props is an Array of props Hashes, one Hash for each column to define.
+        #
+        def define_columns(columns_props_array)
+            raise RuntimeError.new("The #{self.class.name} must have at least one column.") if columns_props_array.empty?
+
+            view.define_columns(columns_props_array)
+
+            # Sync again after adding the columns.
+            sync_ui_from_model
+        end
+
+        ##
+        # Returns a default model if none is given during the initialization of this component.
+        #
+        def default_model()
+            TreeChoiceModel.new(roots: [], get_children_block: nil)
+        end
+
+        ##
+        # Returns the root items of the tree.
+        #
+        def root_items()
+            model.tree.roots
+        end
+
+        ##
+        # Syncs the ui from the model.
+        #
+       def sync_ui_from_model()
+            return if view.nil?
+
+            view.clear_items
+            view.add_items(parent_iter: nil, items: model.tree.roots, index: 0)
+        end
+
+        # Events
+
+        ##
+        # Subscribes this component to the model events
+        #
+        def subscribe_to_model_events()
+            model.tree.add_observer(self, :on_tree_changed)
+            model.selection.add_observer(self, :on_selected_value_changed)
+        end
+
+        def on_tree_changed(announcement)
+            sync_ui_from_model
+        end
+
+        def on_selected_value_changed(announcement)
+            selection_hierarchy = announcement.new_value
+
+            indices_path = model.path_of(selection_hierarchy)
+
+            while_updating_view do
+                view.set_selection_indices(indices_path)
+            end
+        end
+
+        def on_selection_changed(selection_items:, selection_paths:)
+            return if is_updating_view?
+
+            model.set_selection_from_path(path: selection_paths.first) unless model.nil?
+        end
+    end
+end

data/lib/layouts/columns_builder.rb

@@ -0,0 +1,63 @@
+module Sirens
+    class ColumnsBuilder
+        # Initializing
+
+        def initialize()
+            @props = Hash[]
+            @columns = []
+            @popup_menu = nil
+        end
+
+        def columns()
+            @columns
+        end
+
+        def get_popup_menu()
+            @popup_menu
+        end
+
+        # Evaluating
+
+        def render(props, &block)
+            @props = props
+            @columns = []
+            @popup_menu = nil
+
+            instance_exec(self, &block)
+
+            self
+        end
+
+        # Current component model
+
+        def model(object)
+            @props[:model] = object
+        end
+
+        # Current component props
+
+        def styles(props)
+            @props.merge!(props)
+        end
+
+        def props(props)
+            @props.merge!(props)
+        end
+
+        def handlers(props)
+            @props.merge!(props)
+        end
+
+        # List columns
+
+        def column(props = Hash[])
+            @columns << ColumnProps.new(props)
+        end
+
+        # Popup menu
+
+        def popup_menu(&block)
+            @popup_menu = block
+        end
+    end
+end

data/lib/layouts/layout_builder.rb

@@ -0,0 +1,203 @@
+module Sirens
+    class LayoutBuilder
+
+        # Initializing
+
+        def initialize(main_component:)
+            @main_component = main_component
+
+            @props = Hash[]
+            @components = []
+        end
+
+        # Evaluating
+
+        def render(props = Hash[], &build_block)
+            instance_exec(@main_component, &build_block)
+
+            @main_component.add_all_components(@components)
+        end
+
+        # Accessing
+
+        def merge_to_current_props(props)
+            @props.merge!(props)
+        end
+
+        # Current component model
+
+        def model(object)
+            merge_to_current_props(model: object)
+        end
+
+        # Current component props
+
+        def styles(props)
+            merge_to_current_props(props)
+        end
+
+        def props(props)
+            merge_to_current_props(props)
+        end
+
+        def handlers(props)
+            merge_to_current_props(props)
+        end
+
+        # Components
+
+        def component(component, &build_block)
+            build_component_from(Hash[], build_block) { |props, child_components|
+                component.set_props(props)
+
+                component.add_all_components(child_components)
+            }
+        end
+
+        # Containers
+
+        def window(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Window.new(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        def horizontal_stack(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Stack.horizontal(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        def vertical_stack(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Stack.vertical(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        def horizontal_splitter(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Splitter.horizontal(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        def vertical_splitter(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Splitter.vertical(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        def tabs(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Tabs.new(props)
+                    .add_all_components(child_components)
+            }
+        end
+
+        # Widgets
+
+        def button(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Button.new(props)
+            }
+        end
+
+        def checkbox(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Checkbox.new(props)
+            }
+        end
+
+        def radio_button(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                RadioButton.new(props)
+            }
+        end
+
+        def radio_buttons_group(props = Hash[], &build_block)
+            buttons = RadioButtonGroupBuilder.new.render(&build_block)
+
+            @components.concat(buttons)
+        end
+
+        def list(props = Hash[], &build_block)
+            columns_builder = ColumnsBuilder.new.render(props, &build_block)
+
+            props[:popup_menu] = columns_builder.popup_menu unless columns_builder.popup_menu.nil?
+
+            List.new(props).tap { |list|
+                list.define_columns(columns_builder.columns)
+
+                @components << list
+            }
+        end
+
+        def choices_list(props = Hash[], &build_block)
+            columns_builder = ColumnsBuilder.new.render(props, &build_block)
+
+            props[:popup_menu] = columns_builder.popup_menu unless columns_builder.popup_menu.nil?
+
+            ListChoice.new(props).tap { |list|
+                list.define_columns(columns_builder.columns)
+
+                @components << list
+            }
+        end
+
+        def input_text(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                InputText.new(props)
+            }
+        end
+
+        def text(props = Hash[], &build_block)
+            build_component_from(props, build_block) { |props, child_components|
+                Text.new(props)
+            }
+        end
+
+        def choices_tree(props = Hash[], &build_block)
+            columns_builder = ColumnsBuilder.new.render(props, &build_block)
+
+            props[:popup_menu] = columns_builder.get_popup_menu unless columns_builder.get_popup_menu.nil?
+
+            TreeChoice.new(props).tap { |tree|
+                tree.define_columns(columns_builder.columns)
+
+                @components << tree
+            }
+        end
+
+        def popup_menu(&block)
+            merge_to_current_props(popup_menu: block)
+        end
+
+        # Utility methods
+
+        def build_component_from(props = Hash[], build_block, &after_build_block)
+            current_props = @props
+            current_components = @components
+
+            built_component = nil
+
+            begin
+                @props = props.clone
+                @components = []
+
+                build_block.call unless build_block.nil?
+
+                built_component = after_build_block.call(@props, @components)
+            ensure
+                @props = current_props
+                @components = current_components
+            end
+
+            @components << built_component unless built_component.nil?
+        end
+
+    end
+end

data/lib/layouts/radio_button_group_builder.rb

@@ -0,0 +1,28 @@
+module Sirens
+    class RadioButtonGroupBuilder
+
+        # Initializing
+
+        def initialize()
+            @buttons = []
+        end
+
+        # Evaluating
+
+        def render(&block)
+            @buttons = []
+
+            instance_exec(self, &block)
+
+            @buttons
+        end
+
+        # List columns
+
+        def radio_button(props = Hash[])
+            props[:previous_button] = @buttons.last
+
+            @buttons << RadioButton.new(props)
+        end
+    end
+end

data/lib/models/choice_model.rb

@@ -0,0 +1,41 @@
+module Sirens
+    class ChoiceModel
+
+        # Initializing
+
+        def initialize(selection: nil, choices: [])
+            super()
+
+            @selection = ValueModel.on(selection)
+            @choices = ListModel.on(choices)
+        end
+
+        # Accessing
+
+        def selection()
+            @selection
+        end
+
+        def set_selection(new_value)
+            @selection.set_value(new_value)
+        end
+
+        def choices()
+            @choices
+        end
+
+        def set_choices(list)
+            @choices.set_list(list)
+        end
+
+        def item_at(index:)
+            @choices[index]
+        end
+
+        # Asking
+
+        def has_selection()
+            ! @selection.value.nil?
+        end
+    end
+end