sirens 0.0.1 → 0.1.1

data/lib/views/widget_view.rb

@@ -0,0 +1,96 @@
+require 'set'
+
+module Sirens
+    ##
+    # A View is the library binding to a GUI interface handle.
+    # It is not a Component but is wrapped by a PrimitiveComponent.
+    # a View takes care of handling the internals of the GUI objects such as handles, events, default initialization,
+    # etc.
+    #
+    # By separating the View from the PrimitiveComponent that wraps it makes the PrimitiveComponents responsibilities
+    # more consistent with regular Components and it makes it easier to switch between GUI libraries
+    # (say, from Gtk to Qt).
+    #
+    class WidgetView < AbstractView
+
+        # Initializing
+
+        ##
+        # Initializes this View handles
+        #
+        def initialize()
+            super()
+
+            @event_handles = Hash[]
+
+            @main_handle = nil
+
+            initialize_handles
+
+            subscribe_to_ui_events
+        end
+
+        ## Instantiates this view handles.
+        # A View usually has a single handle to the GUI library, but in same cases it may have more than one.
+        # For instance when adding a Scroll decorator to the actual widget.
+        #
+        def initialize_handles()
+            raise RuntimeError.new("Subclass #{self.class.name} must implement the method ::initialize_handles().")
+        end
+
+        ##
+        # Subscribes this View to the events/signals emitted by the GUI handle(s) of interest.
+        # When an event/signal is received calls the proper event_handler provided by the PrimitiveComponent,
+        # if one was given.
+        #
+        # This mechanism of event handler callbacks is more simple and lightweight than making this View to announce
+        # events using the Observer pattern, and since there is only one PrimitiveComponent wrapping each View
+        # using the Observer pattern would be unnecessary complex.
+        #
+        def subscribe_to_ui_events()
+            raise RuntimeError.new("Subclass #{self.class.name} must implement the method ::subscribe_to_ui_events().")
+        end
+
+        # Accessing
+
+        ##
+        # Returns the main handle of this View.
+        # The main handle is the one that this View parent add as its child.
+        # Also, it is the handle that receives the style props and events by default.
+        #
+        def main_handle()
+            @main_handle
+        end
+
+        # Styling
+
+        ##
+        # Applies each prop in props to the actual GUI object.
+        #
+        def apply_props(props)
+            accepted_styles = self.accepted_styles
+
+            props.each_pair { |prop, value|
+                apply_prop(prop, value) if accepted_styles.include?(prop)
+            }
+        end
+
+        ##
+        # Apply the prop to the actual GUI object.
+        #
+        def apply_prop(prop, value)
+            setter = prop.to_s + '='
+
+            send(setter, value)
+        end
+
+        ##
+        # Adds a child_view.
+        #
+        def add_view(child_view)
+            super(child_view)
+
+            main_handle.add(child_view.main_handle)
+        end
+    end
+end

data/lib/views/window_view.rb

@@ -1,5 +1,5 @@
 module Sirens
-    class WindowView < View
+    class WindowView < WidgetView
 
         # Class methods
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sirens
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.1
 platform: ruby
 authors:
 - Haijin Development
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-05-22 00:00:00.000000000 Z
+date: 2019-07-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: gtk3
@@ -25,14 +25,28 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
-description: Interactive tools to develop in Ruby, implemented in Ruby and GTK3.
+- !ruby/object:Gem::Dependency
+  name: method_source
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+description: Interactive utilities to develop in Ruby, implemented in Ruby and GTK3.
 email: haijin.development@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/components/abstract_component.rb
 - lib/components/component.rb
-- lib/components/component_behaviour.rb
 - lib/components/containers/splitter.rb
 - lib/components/containers/stack.rb
 - lib/components/containers/tabs.rb
@@ -40,16 +54,16 @@ files:
 - lib/components/primitive_component.rb
 - lib/components/widgets/button.rb
 - lib/components/widgets/checkbox.rb
-- lib/components/widgets/column_props.rb
 - lib/components/widgets/input_text.rb
 - lib/components/widgets/list.rb
 - lib/components/widgets/list_choice.rb
 - lib/components/widgets/radio_button.rb
 - lib/components/widgets/text.rb
 - lib/components/widgets/tree_choice.rb
-- lib/layouts/columns_builder.rb
-- lib/layouts/layout_builder.rb
-- lib/layouts/radio_button_group_builder.rb
+- lib/components_builder/column_props.rb
+- lib/components_builder/columns_builder.rb
+- lib/components_builder/layout_builder.rb
+- lib/components_builder/radio_button_group_builder.rb
 - lib/models/choice_model.rb
 - lib/models/list_model.rb
 - lib/models/tree_choice_model.rb
@@ -66,22 +80,39 @@ files:
 - lib/sirens/components/modules_list.rb
 - lib/sirens/components/namespaces_list.rb
 - lib/sirens/models/constant_model.rb
+- lib/sirens/models/icons.rb
+- lib/sirens/models/method.rb
 - lib/sirens/models/method_model.rb
 - lib/sirens/models/module_browser_model.rb
 - lib/sirens/models/object_browser_model.rb
+- lib/views/abstract_view.rb
 - lib/views/button_view.rb
-- lib/views/check_button_view.rb
-- lib/views/entry_view.rb
+- lib/views/checkbox_view.rb
+- lib/views/component_view.rb
+- lib/views/input_text_view.rb
 - lib/views/list_view.rb
 - lib/views/menu_view.rb
-- lib/views/notebook_view.rb
-- lib/views/paned_view.rb
 - lib/views/radio_button_view.rb
+- lib/views/splitter_view.rb
 - lib/views/stack_view.rb
+- lib/views/tabs_view.rb
 - lib/views/text_view.rb
 - lib/views/tree_view.rb
-- lib/views/view.rb
+- lib/views/widget_view.rb
 - lib/views/window_view.rb
+- resources/icons/array.png
+- resources/icons/class.png
+- resources/icons/false.png
+- resources/icons/hash.png
+- resources/icons/method.png
+- resources/icons/module.png
+- resources/icons/number.png
+- resources/icons/object.png
+- resources/icons/private-method.png
+- resources/icons/protected-method.png
+- resources/icons/public-method.png
+- resources/icons/string.png
+- resources/icons/true.png
 homepage: https://rubygems.org/gems/sirens
 licenses:
 - MIT
@@ -102,9 +133,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements:
-- gtk3 gobject-introspection
+- gtk3 gobject-introspection method_source
 rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Some simple development tools for Ruby.
+summary: Development utilities for Ruby.
 test_files: []

data/lib/layouts/layout_builder.rb

@@ -1,203 +0,0 @@
-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