cura 0.0.2 → 0.0.3

data/examples/todo_list/lib/todo_list/component/lists.rb

@@ -2,88 +2,88 @@ require "todo_list/component/list"
 
 module TodoList
   module Component
-    
+
     class Lists < Cura::Component::Pack
-      
+
       attr_reader :create_list_textbox
       attr_reader :listbox
-      
-      
+
+
       def initialize(attributes={})
         attributes = { fill: true, padding: { top: 1, bottom: 1 } }.merge(attributes)
-        
+
         super(attributes)
-        
+
         create_form_pack = Cura::Component::Pack.new(orientation: :horizontal)
         add_child(create_form_pack)
-        
+
         @create_list_textbox = Cura::Component::Textbox.new(width: width - 16, margin: { right: 1 })
         @create_list_textbox.on_event(:key_down, self) { |event, model_list| model_list.create_list if event.name == :enter }
         create_form_pack.add_child(@create_list_textbox)
-        
+
         @create_list_button = Cura::Component::Button.new(text: "Create List", padding: { left: 1, right: 1 })
         @create_list_button.on_event(:click, self) { |_, model_list| model_list.create_list }
         create_form_pack.add_child(@create_list_button)
-        
+
         @listbox_header_label = Cura::Component::Label.new(text: "Lists" + " " * (width - 5), bold: true, underline: true, margin: { top: 1 })
         add_child(@listbox_header_label)
-        
+
         @listbox = Cura::Component::Listbox.new(width: @width)
-        
+
         @listbox.on_event(:selected) do
           application.list_items.list = selected_object unless selected_object.nil?
         end
-        
+
         @listbox.on_event(:key_down, self) do |event, model_list|
           if event.target == self
             if event.control? && event.name == :D && !selected_object.nil?
               selected_object.list_items.each(&:destroy)
               selected_object.destroy
-              
+
               application.list_items.list = nil
 
               previous_selected_index = @selected_index
               model_list.fill_listbox
               self.selected_index = [previous_selected_index, count - 1].min
             end
-            
+
             if event.control? && event.name == :E
               selected_child.focus
             end
-            
+
             if event.name == :enter
               application.list_items.listbox.focus
             end
           end
         end
-        
+
         add_child(@listbox)
-        
+
         fill_listbox
       end
-      
+
       def create_list
         Model::List.create(text: @create_list_textbox.text)
-        
+
         fill_listbox
-        
+
         @create_list_textbox.clear
         @create_list_textbox.focus
-        
+
         application.list_items.list = @listbox.selected_object unless @listbox.selected_object.nil?
       end
-      
+
       def fill_listbox
         @listbox.delete_children
-        
+
         Model::List.all.each do |list|
           list_component = Component::List.new(listbox: @listbox, model: list, width: @listbox.width)
-          
-          @listbox.add_child(list_component, list)
+
+          @listbox.add_child(list_component, object: list)
         end
       end
-      
+
     end
-    
+
   end
 end

data/lib/cura/application.rb

@@ -207,6 +207,9 @@ module Cura
       end
 
       # TODO: If a class is given, run .new on it first
+      # TODO: Adapter.name(*arguments) which defaults to an underscore'd version of the class constant
+      # TODO: Adapter.find_by_name
+      # TODO: Use Adapter.find_by_name here to allow passing of a Symbol to #adapter=
 
       @adapter.setup
     end

data/lib/cura/attributes/has_children.rb

@@ -1,6 +1,5 @@
 if Kernel.respond_to?(:require)
   require "cura/component/base"
-
   require "cura/error/invalid_component"
 end
 
@@ -38,10 +37,32 @@ module Cura
 
       # Add a child to this group.
       #
-      # @param [Component] component
+      # If a Hash-like object is given, it must have the `:type` key which will be used to
+      # determine which class to initialize. The rest of the Hash will be used to set the
+      # attributes of the instance.
+      #
+      # @param [#to_sym, Component] component_or_type
+      #   A Symbol representing the child component type or a {Component::Base} instance.
+      #   When a Symbol is given, a new child component will be initialized of that type. See {Component::Base.type}.
+      # @param [#to_h] attributes
+      #   When component_or_type is a Symbol, then these attributes will be used to initialize the child component.
+      #   When component_or_type is a {Component::Base}, then these attributes will be used to update the child component.
       # @return [Component]
-      def add_child(component)
-        raise TypeError, "component must be a Cura::Component" unless component.is_a?(Component::Base)
+      def add_child(component_or_type, attributes={})
+        component = if component_or_type.respond_to?(:to_sym)
+          type = component_or_type.to_sym
+          component_class = Component.find_by_type(type)
+
+          raise Error::InvalidComponent if component_class.nil?
+
+          component_class.new
+        else
+          raise Error::InvalidComponent unless component_or_type.is_a?(Component::Base)
+
+          component_or_type
+        end
+
+        component.update_attributes(attributes)
 
         @children << component
 

data/lib/cura/attributes/has_colors.rb

@@ -28,7 +28,7 @@ module Cura
       # @method foreground=(value)
       # Set the foreground color of this object.
       #
-      # @param [Color] value
+      # @param [Color, #to_sym] value
       # @return [Color]
 
       attribute(:foreground) { |value| validate_color_attribute(value) }
@@ -41,7 +41,7 @@ module Cura
       # @method background=(value)
       # Set the background color of this object.
       #
-      # @param [Color] value
+      # @param [Color, #to_sym] value
       # @return [Color]
 
       attribute(:background) { |value| validate_color_attribute(value) }
@@ -52,7 +52,11 @@ module Cura
         unless value.is_a?(Cura::Color)
           value = value.to_sym
 
-          raise Error::InvalidColor unless value == :inherit
+          if [:black, :white, :red, :green, :blue].include?(value)
+            value = Cura::Color.send(value)
+          else
+            raise Error::InvalidColor unless value == :inherit
+          end
         end
 
         value

data/lib/cura/attributes/has_dimensions.rb

@@ -16,12 +16,12 @@ module Cura
       # @method width
       # Get the width dimension of this object.
       #
-      # @param [#to_i] value
       # @return [Integer]
 
       # @method width=(value)
       # Set the width dimension of this object.
       #
+      # @param [#to_i] value
       # @return [Integer]
 
       attribute(:width) { |value| validate_size_attribute(value) }

data/lib/cura/attributes/has_events.rb

@@ -56,7 +56,7 @@ module Cura
       # Get the event handler for this object.
       #
       # @return [Event::Handler]
-      attr_reader :event_handler
+      attr_reader :event_handler # TODO: Rename to #events ?
 
       # Register a callback for an event to this instance.
       #

data/lib/cura/attributes/has_root.rb

@@ -40,10 +40,15 @@ module Cura
 
       # Add a child to this object's root component.
       #
-      # @param [Component] component
+      # @param [#to_sym, Component] component_or_type
+      #   A Symbol representing the child component type or a {Component::Base} instance.
+      #   When a Symbol is given, a new child component will be initialized of that type. See {Component::Base.type}.
+      # @param [#to_h] attributes
+      #   When component_or_type is a Symbol, then these attributes will be used to initialize the child component.
+      #   When component_or_type is a {Component::Base}, then these attributes will be used to update the child component.
       # @return [Component]
-      def add_child(component)
-        @root.add_child(component)
+      def add_child(component_or_type, attributes={})
+        @root.add_child(component_or_type, attributes)
       end
 
       # Add multiple children to this object's root component.

data/lib/cura/attributes/has_visibility.rb

@@ -0,0 +1,28 @@
+require "cura/attributes/has_attributes" if Kernel.respond_to?(:require)
+
+module Cura
+  module Attributes
+    # Adds the `#visible?`, `visible=` methods.
+    module HasVisibility
+      include HasAttributes
+
+      def initialize(attributes={})
+        @visible = true
+
+        super
+      end
+
+      # @method visible?
+      # Get the visibility.
+      #
+      # @return [Boolean]
+
+      # @method visible=
+      # Set the visibility.
+      #
+      # @return [Boolean]
+
+      attribute(:visible, query: true)
+    end
+  end
+end

data/lib/cura/color.rb

@@ -10,6 +10,8 @@ module Cura
     include Attributes::HasAttributes
 
     class << self
+      # TODO: All standard color names
+
       # The default color to be overidden by adapters.
       # Usually, for TUI's to use the terminal theme's colors.
       # TODO: Remove.

data/lib/cura/component/base.rb

@@ -6,6 +6,8 @@ if Kernel.respond_to?(:require)
   require "cura/attributes/has_events"
   require "cura/attributes/has_offsets"
   require "cura/attributes/has_relative_coordinates"
+  require "cura/attributes/has_visibility"
+  require "cura/component"
 end
 
 module Cura
@@ -15,14 +17,35 @@ module Cura
     # All components use a box model similar to CSS.
     # Margins, borders, paddings, then content.
     class Base
+      class << self
+        # On subclass hook.
+        def inherited(subclass)
+          Component.all << subclass
+        end
+
+        # The type of this component class.
+        #
+        # @example
+        #   Cura::Component::XMLTools::AttributeLabel.type # => :xml_tools_attribute_label
+        # @return [Symbol]
+        def type # TODO: Helper method for this sort of thing
+          @type ||= to_s.gsub(/^Cura::Component::/, "")
+                        .gsub(/([A-Z][A-Za-z]*)([A-Z][A-Za-z0-9_]*)/, "\\1_\\2")
+                        .gsub(/::/, "_").downcase.to_sym
+        end
+      end
+
       include Attributes::HasInitialize
       include Attributes::HasAttributes
+
+      include Attributes::HasAncestry
       include Attributes::HasDimensions
       include Attributes::HasEvents
       include Attributes::HasFocusability
       include Attributes::HasColors
       include Attributes::HasOffsets
       include Attributes::HasRelativeCoordinates
+      include Attributes::HasVisibility
 
       # Get the cursor for this application.
       # TODO: Delegate something like: def_delegate(:cursor) { application }
@@ -89,13 +112,6 @@ module Cura
         get_or_inherit_color(:background, Color.white)
       end
 
-      # Instance inspection.
-      #
-      # @return [String]
-      def inspect
-        "#<#{self.class}:0x#{__id__.to_s(16)} x=#{x} y=#{y} absolute_x=#{absolute_x} absolute_y=#{absolute_y} w=#{width} h=#{height} parent=#{@parent.class}:0x#{@parent.__id__.to_s(16)}>"
-      end
-
       # Update this component.
       #
       # @return [Component]
@@ -107,12 +123,21 @@ module Cura
       #
       # @return [Component]
       def draw
-        draw_background
-        draw_border
+        if @visible
+          draw_background
+          draw_border
+        end
 
         self
       end
 
+      # Instance inspection.
+      #
+      # @return [String]
+      def inspect
+        "#<#{self.class}:0x#{__id__.to_s(16)} x=#{x} y=#{y} absolute_x=#{absolute_x} absolute_y=#{absolute_y} w=#{width} h=#{height} parent=#{@parent.class}:0x#{@parent.__id__.to_s(16)}>"
+      end
+
       protected
 
       # Draw a point.

data/lib/cura/component/group.rb

@@ -30,11 +30,28 @@ module Cura
         children.collect { |child| child.y + child.height + child.offsets.height }.max
       end
 
+      # # Set the parent of this object.
+      # # It's not recommended to set this directly as it may break the ancestory chain.
+      # #
+      # # @param [Object] value
+      # # @return [Object]
+      # def parent=(value)
+      #   @parent = value
+      #   @children.each
+      #
+      #   @parent
+      # end
+
       # Add a child to this group and set it's parent to this Group.
       #
-      # @param [Component] component
+      # @param [#to_sym, Component] component_or_type
+      #   A Symbol representing the child component type or a {Component::Base} instance.
+      #   When a Symbol is given, a new child component will be initialized of that type. See {Component::Base.type}.
+      # @param [#to_h] attributes
+      #   When component_or_type is a Symbol, then these attributes will be used to initialize the child component.
+      #   When component_or_type is a {Component::Base}, then these attributes will be used to update the child component.
       # @return [Component]
-      def add_child(component)
+      def add_child(component_or_type, attributes={})
         component = super
 
         component.parent = self

data/lib/cura/component/listbox.rb

@@ -83,11 +83,17 @@ module Cura
 
       # Add a child to this group.
       #
-      # @param [Component] component
-      # @param [Object] object An arbitrary object to associate with the added child in this listbox.
+      # @param [#to_sym, Component] component_or_type
+      #   A Symbol representing the child component type or a {Component::Base} instance.
+      #   When a Symbol is given, a new child component will be initialized of that type. See {Component::Base.type}.
+      # @param [#to_h] attributes
+      #   When component_or_type is a Symbol, then these attributes will be used to initialize the child component.
+      #   When component_or_type is a {Component::Base}, then these attributes will be used to update the child component.
+      # @option attributes [Object] :object An arbitrary object to associate with the added child in this listbox.
       # @return [Component]
-      def add_child(component, object=nil)
-        child = super(component)
+      def add_child(component_or_type, attributes={})
+        object = attributes.delete(:object)
+        child = super
 
         @objects << object
 
@@ -107,6 +113,11 @@ module Cura
         deleted_child
       end
 
+      # Get the objects stored.
+      #
+      # @return [Array]
+      attr_reader :objects
+
       # Get the associated object with the child at the given index.
       #
       # @param [#to_i] index

data/lib/cura/component/pack.rb

@@ -15,7 +15,6 @@ module Cura
         @fill = false
         @spacing = 0
 
-        # @child_modifiers
         super
       end
 
@@ -39,15 +38,20 @@ module Cura
 
       # Add a child to this group.
       #
-      # @param [Component] component
-      # @param [#to_hash, #to_h] options
+      # @param [#to_sym, Component] component_or_type
+      #   A Symbol representing the child component type or a {Component::Base} instance.
+      #   When a Symbol is given, a new child component will be initialized of that type. See {Component::Base.type}.
+      # @param [#to_h] attributes
+      #   When component_or_type is a Symbol, then these attributes will be used to initialize the child component.
+      #   When component_or_type is a {Component::Base}, then these attributes will be used to update the child component.
       # @option options [#to_i] :expand
       #   The new child is to be given extra space. The extra space will be divided evenly between all children that use this option.
       # @option options [#to_i] :fill
       #   The space given to child by the expand option is actually allocated to child, rather than just padding it.
       #   This parameter has no effect if expand is set to false.
       # @return [Component]
-      def add_child(component)
+      def add_child(component_or_type, attributes={})
+        # TODO: :expand and :fill attributes?
         child = super
 
         pack_children

data/lib/cura/component.rb

@@ -0,0 +1,23 @@
+module Cura
+  # The container module for components.
+  module Component
+    class << self
+      # All {Component::Base} subclasses.
+      #
+      # @return [<Class>]
+      def all
+        @all ||= []
+      end
+
+      # Find a {Component::Base} subclass by it's type.
+      #
+      # @param [#to_sym] value
+      # @return [nil, Class]
+      def find_by_type(value)
+        value = value.to_sym
+
+        all.find { |component_class| component_class.type == value }
+      end
+    end
+  end
+end

data/lib/cura/error/invalid_component.rb

@@ -5,7 +5,7 @@ module Cura
     # Raised when a component is invalid.
     class InvalidComponent < Base
       def to_s
-        "must be a Cura::Component::Base"
+        "invalid component"
       end
     end
   end

data/lib/cura/event/dispatcher.rb

@@ -96,7 +96,7 @@ module Cura
         @application.adapter.peek_event(milliseconds.to_i)
       end
 
-      # Dispatch an event to the target or application, if the target is nil.
+      # Send the event through the middleware stack and dispatch all events on the queue.
       #
       # @param [#to_sym] event The name of the event class to create an instance of or an event instance.
       # @param [#to_hash, #to_h] options The options to pass through the middleware.

data/lib/cura/event/middleware/aimer/target_option.rb

@@ -6,15 +6,13 @@ module Cura
       module Aimer
         # Sets the event's target to the component passed by an optional :target option.
         class TargetOption < Base
+          # @method call
           # Call this middleware.
           #
           # @param [#to_h] options
           # @option options [Event::Dispatcher] :dispatcher
           # @option options [Event::Base] :event
           # @option options [Attributes::HasEvents] :target The optional target of the event.
-          def call(options={})
-            super # Only here for documentation
-          end
 
           protected
 

data/lib/cura/event/middleware/dispatch.rb

@@ -1,9 +1,10 @@
 module Cura
   module Event
     module Middleware
-      # Dispatches the event.
+      # Adds the event to the dispatch queue.
+      # Should be the very last middleware in the chain.
       class Dispatch < Base
-        # Dispatch the event.
+        # Add the event to the dispatch queue.
         #
         # @param [#to_h] options
         # @option options [Event::Base] :event

data/lib/cura/event/middleware/translator/mouse_click.rb

@@ -10,7 +10,7 @@ module Cura
         # Translates MouseDown and MouseUp events into a MouseClick event.
         class MouseClick < Base
           def initialize
-            @last_mouse_down_at = Time.now
+            @last_mouse_down_at = Time.now # TODO: This is not a great solution. If/when events are threaded, this will be bad.
           end
 
           # Call this middleware.

data/lib/cura/key.rb

@@ -197,18 +197,18 @@ module Cura
       mute: nil,
       non_us_backslash: nil,
       non_us_hash: nil,
-      "0": "0",
-      "00": "00",
-      "000": "000",
-      "1": "1",
-      "2": "2",
-      "3": "3",
-      "4": "4",
-      "5": "5",
-      "6": "6",
-      "7": "7",
-      "8": "8",
-      "9": "9",
+      "0".to_sym => "0",
+      "00".to_sym => "00",
+      "000".to_sym => "000",
+      "1".to_sym => "1",
+      "2".to_sym => "2",
+      "3".to_sym => "3",
+      "4".to_sym => "4",
+      "5".to_sym => "5",
+      "6".to_sym => "6",
+      "7".to_sym => "7",
+      "8".to_sym => "8",
+      "9".to_sym => "9",
       numlock_clear: nil,
       numpad_0: "0",
       numpad_1: "1",

data/lib/cura/version.rb

@@ -1,4 +1,4 @@
 # An adaptable component library for creating graphical and text-based user interfaces.
 module Cura
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/spec_helper.rb

@@ -1,5 +1,4 @@
 require "simplecov"
-SimpleCov.start
 
 RSpec.configure do |config|
   config.expect_with :rspec do |expectations|