vedeu 0.4.43 → 0.4.44

data/lib/vedeu/bindings/movement.rb

@@ -0,0 +1,76 @@
+module Vedeu
+
+  module Bindings
+
+    # System events relating to movement of cursors or interfaces.
+    #
+    # @api public
+    module Movement
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_down_) do |name|
+        Vedeu::Move.by_name(Vedeu::Cursor, :down, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_left_) do |name|
+        Vedeu::Move.by_name(Vedeu::Cursor, :left, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_origin_) do |name|
+        Vedeu::Move.by_name(Vedeu::Cursor, :origin, name)
+      end
+
+      # Move the cursor to a relative position inside the interface.
+      #
+      # @todo
+      #   - The content of the interface needs to be a consideration.
+      #   - If the screen size changes, what should happen to the cursor.
+      #   - How do we represent cursors which are deliberately positioned
+      #     outside of the viewable area?
+      #
+      Vedeu.bind(:_cursor_reposition_) do |name, y, x|
+        Vedeu::Reposition.to(Vedeu::Cursor, name, y, x)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_reset_) do |name|
+        Vedeu.trigger(:_cursor_origin_, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_right_) do |name|
+        Vedeu::Move.by_name(Vedeu::Cursor, :right, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_cursor_up_) do |name|
+        Vedeu::Move.by_name(Vedeu::Cursor, :up, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_geometry_down_) do |name|
+        Vedeu::Move.by_name(Vedeu::Geometry, :down, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_geometry_left_) do |name|
+        Vedeu::Move.by_name(Vedeu::Geometry, :left, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_geometry_right_) do |name|
+        Vedeu::Move.by_name(Vedeu::Geometry, :right, name)
+      end
+
+      # @see {Vedeu::Move}
+      Vedeu.bind(:_geometry_up_) do |name|
+        Vedeu::Move.by_name(Vedeu::Geometry, :up, name)
+      end
+
+    end # Movement
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/bindings/visibility.rb

@@ -0,0 +1,53 @@
+module Vedeu
+
+  module Bindings
+
+    # System events relating to the visibility of cursors or interfaces.
+    #
+    # @api public
+    module Visibility
+
+      # Hide the cursor of the named interface or interface currently in focus.
+      Vedeu.bind(:_hide_cursor_) do |name|
+        Vedeu::Visibility.for_cursor(name).hide
+      end
+      Vedeu.bind(:_cursor_hide_) { |name| Vedeu.trigger(:_hide_cursor_, name) }
+
+      # Will hide all of the interfaces belonging to the named group. Useful for
+      # hiding part of that which is currently displaying in the terminal.
+      #
+      # @note
+      #   This may be rarely used, since the action of showing a group using
+      #   `Vedeu.trigger(:_show_group_, group_name)` will effectively clear the
+      #   terminal and show the new group.}
+      Vedeu.bind(:_hide_group_) { |name| Vedeu.trigger(:_clear_group_, name) }
+
+      # @see Vedeu::Buffer#hide
+      Vedeu.bind(:_hide_interface_) { |name| Vedeu.buffers.by_name(name).hide }
+
+      # Show the cursor of the named interface or interface currently in focus.
+      Vedeu.bind(:_show_cursor_) do |name|
+        Vedeu::Visibility.for_cursor(name).show
+      end
+      Vedeu.bind(:_cursor_show_) { |name| Vedeu.trigger(:_show_cursor_, name) }
+
+      # Will clear the terminal and then show all of the interfaces belonging to
+      # the named group.
+      Vedeu.bind(:_show_group_) do |name|
+        Vedeu.trigger(:_clear_)
+        Vedeu.trigger(:_refresh_group_, name)
+      end
+
+      # @see Vedeu::Buffer#show
+      Vedeu.bind(:_show_interface_) { |name| Vedeu.buffers.by_name(name).show }
+
+      # @see Vedeu::Buffer#toggle
+      Vedeu.bind(:_toggle_interface_) do |name|
+        Vedeu.buffers.by_name(name).toggle
+      end
+
+    end # Visibility
+
+  end # Bindings
+
+end # Vedeu

data/lib/vedeu/buffers/buffer.rb

@@ -120,6 +120,7 @@ module Vedeu
       return nil unless visible?
 
       Vedeu::Visibility.hide(interface)
+
       clear
     end
 
@@ -156,6 +157,7 @@ module Vedeu
       return nil if visible?
 
       Vedeu::Visibility.show(interface)
+
       render
     end
 

data/lib/vedeu/cli/generator/templates/application/app/controllers/name.erb

@@ -5,10 +5,10 @@ module <%= object.app_name %>
 
   class <%= object.name_as_class %>Controller < <%= object.app_name -%>::ApplicationController
 
-    controller_name <%= object.app_name -%>
+    controller_name :<%= object.name %>
 
     def initialize
-      <%= object.app_name %>::<%= object.name_as_class %>View.render(object)
+      <%= object.app_name %>::<%= object.name_as_class %>View.render(*args)
     end
 
     private

data/lib/vedeu/cli/generator/templates/application/app/helpers/name.erb

@@ -1,3 +1,5 @@
+require_relative 'application_helper'
+
 module <%= object.app_name %>
 
   module <%= object.name_as_class %>Helper

data/lib/vedeu/cli/generator/templates/application/config/configuration.erb

@@ -1,5 +1,8 @@
 Vedeu.configure do
   log         "/tmp/<%= object.name %>.log"
+
+  colour_mode 16_777_216
+
   # debug!
   # drb!
   # drb_host    'localhost'

data/lib/vedeu/cli/generator/view.rb

@@ -32,15 +32,10 @@ module Vedeu
       # @return [void]
       def generate
         make_controller_file
-
         make_helper_file
-
         make_keymap_file
-
         make_interface_file
-
         make_template_file
-
         make_view_class_file
       end
 

data/lib/vedeu/cli/main.rb

@@ -1,23 +1,35 @@
 module Vedeu
 
+  # Provide a command line interface to Vedeu.
+  #
+  # @api public
   module CLI
 
+    # The main command line interface commands.
+    #
+    # @api public
     class Main < Thor
 
       desc 'new <name>', 'Create a skeleton Vedeu client application.'
+      # @param name [String]
+      # @return [String]
       def new(name)
         say Vedeu::Generator::Application.generate(name)
       end
 
       # 'Specify the interface name lowercase snakecase; e.g. main_interface'
+
       desc 'view <name>',
            'Create a new interface within the client application.'
+      # @param name [String]
+      # @return [String]
       def view(name)
         Vedeu::Generator::View.generate(name)
       end
 
       desc 'version',
            'Print the version.'
+      # @return [String]
       def version
         say "vedeu #{Vedeu::VERSION}"
       end

data/lib/vedeu/cursor/reposition.rb

@@ -28,10 +28,10 @@ module Vedeu
     # @return [Vedeu::Cursor]
     def to
       result = entity.new(name: name,
-                           y:    y_position,
-                           x:    x_position,
-                           oy:   y,
-                           ox:   x).store
+                          y:    y_position,
+                          x:    x_position,
+                          oy:   y,
+                          ox:   x).store
 
       Vedeu.trigger(:_clear_, name)
       Vedeu.trigger(:_refresh_, name)

data/lib/vedeu/dsl/interface.rb

@@ -308,33 +308,6 @@ module Vedeu
       alias_method :z_index, :zindex
       alias_method :z,       :zindex
 
-      # @param label [String]
-      # @param name [String|Symbol]
-      # @param value [Boolean|void]
-      # @return [void]
-      def button(label, name, value = true)
-        button_name   = "button_#{model.name}_#{name}"
-        button_label  = " #{label} "
-        button_height = 3
-        button_width  = button_label.size + 2
-
-        Vedeu.interface button_name do
-          border {}
-          cursor
-          geometry do
-            height(button_height)
-            width(button_width)
-          end
-        end
-        Vedeu.renders do
-          view button_name do
-            lines do
-              line button_label
-            end
-          end
-        end
-      end
-
       protected
 
       # @!attribute [r] client

data/lib/vedeu/exceptions.rb

@@ -0,0 +1,65 @@
+module Vedeu
+
+  # Raised with Vedeu attempts to access a named model that does not exist.
+  #
+  # @api private
+  class ModelNotFound < StandardError
+
+  end # ModeSwitch
+
+  # Raised when Vedeu attempts to parse a {Vedeu.view} or {Vedeu.interface} and
+  # encounters a problem.
+  #
+  # @api private
+  class InvalidSyntax < StandardError
+
+  end # InvalidSyntax
+
+  # Raised when a name is not provided for a model when attempting to store it
+  # in a repository.
+  #
+  # @api private
+  class MissingRequired < StandardError
+
+  end # MissingRequired
+
+  # Raised intentionally when the client application wishes to switch between
+  # cooked and raw (or vice versa) terminal modes.
+  #
+  # @see Vedeu::Application
+  #
+  # @api private
+  class ModeSwitch < StandardError
+
+  end # ModeSwitch
+
+  # Raised to remind me (or client application developers) that the subclass
+  # implements the functionality sought.
+  #
+  # @see Vedeu::Translator
+  #
+  # @api private
+  class NotImplemented < StandardError
+
+  end # NotImplemented
+
+  # Raised when trying to access an interface column less than 1 or greater
+  # than 12. Vedeu is hard-wired to a 12-column layout for the time being.
+  #
+  # @see Vedeu::Grid
+  #
+  # @api private
+  class OutOfRange < StandardError
+
+  end # OutOfRange
+
+  # Raised when Vedeu wishes to exit.
+  #
+  # @see Vedeu::MainLoop
+  #
+  # @api private
+  class VedeuInterrupt < StandardError
+
+  end # VedeuInterrupt
+
+end # Vedeu

data/lib/vedeu/geometry/geometry.rb

@@ -153,11 +153,11 @@ module Vedeu
         y:         _y,
         yn:        _yn,
         y_yn:      @height,
-        y_default: Vedeu::Terminal.height,
+        y_default: Vedeu.height,
         x:         _x,
         xn:        _xn,
         x_xn:      @width,
-        x_default: Vedeu::Terminal.width,
+        x_default: Vedeu.width,
         options:   dimension_options,
       )
     end

data/lib/vedeu/geometry/grid.rb

@@ -93,12 +93,12 @@ module Vedeu
 
     # @return [Fixnum]
     def actual_height
-      Vedeu::Terminal.height
+      Vedeu.height
     end
 
     # @return [Fixnum]
     def actual_width
-      Vedeu::Terminal.width
+      Vedeu.width
     end
 
     # @return [Boolean]

data/lib/vedeu/input/input.rb

@@ -82,34 +82,6 @@ module Vedeu
         "\e[3~"   => :delete,
         "\e[F"    => :end,
         "\e[Z"    => :shift_tab,
-        "\eOP"    => :f1,
-        "\eOQ"    => :f2,
-        "\eOR"    => :f3,
-        "\eOS"    => :f4,
-        "\e[15~"    => :f5,
-        "\e[15;2~"  => :shift_f5,
-        "\e[15;5~"  => :ctrl_f5,
-        "\e[17~"    => :f6,
-        "\e[17;2~"  => :shift_f6,
-        "\e[17;5~"  => :ctrl_f6,
-        "\e[18~"    => :f7,
-        "\e[18;2~"  => :shift_f7,
-        "\e[18;5~"  => :ctrl_f6,
-        "\e[19~"    => :f8,
-        "\e[19;2~"  => :shift_f8,
-        "\e[19;5~"  => :ctrl_f6,
-        "\e[20~"    => :f9,
-        "\e[20;2~"  => :shift_f9,
-        "\e[20;5~"  => :ctrl_f6,
-        "\e[21~"    => :f10,
-        "\e[21;2~"  => :shift_f10,
-        "\e[21;5~"  => :ctrl_f6,
-        "\e[23~"    => :f11,
-        "\e[23;2~"  => :shift_f11,
-        "\e[23;5~"  => :ctrl_f6,
-        "\e[24~"    => :f12,
-        "\e[24;2~"  => :shift_f12,
-        "\e[24;5~"  => :ctrl_f6,
         "\e[1;2P" => :print_screen,
         "\e[1;2Q" => :scroll_lock,
         "\e[1;2R" => :pause_break,
@@ -140,6 +112,40 @@ module Vedeu
         "\u0024"  => :ctrl_x,
         "\u0025"  => :ctrl_y,
         "\u0026"  => :ctrl_z,
+      }.merge(f_keys)
+    end
+
+    # @return [Hash<String => Symbol]
+    def f_keys
+      {
+        "\eOP"      => :f1,
+        "\eOQ"      => :f2,
+        "\eOR"      => :f3,
+        "\eOS"      => :f4,
+        "\e[15~"    => :f5,
+        "\e[15;2~"  => :shift_f5,
+        "\e[15;5~"  => :ctrl_f5,
+        "\e[17~"    => :f6,
+        "\e[17;2~"  => :shift_f6,
+        "\e[17;5~"  => :ctrl_f6,
+        "\e[18~"    => :f7,
+        "\e[18;2~"  => :shift_f7,
+        "\e[18;5~"  => :ctrl_f7,
+        "\e[19~"    => :f8,
+        "\e[19;2~"  => :shift_f8,
+        "\e[19;5~"  => :ctrl_f8,
+        "\e[20~"    => :f9,
+        "\e[20;2~"  => :shift_f9,
+        "\e[20;5~"  => :ctrl_f9,
+        "\e[21~"    => :f10,
+        "\e[21;2~"  => :shift_f10,
+        "\e[21;5~"  => :ctrl_f10,
+        "\e[23~"    => :f11,
+        "\e[23;2~"  => :shift_f11,
+        "\e[23;5~"  => :ctrl_f11,
+        "\e[24~"    => :f12,
+        "\e[24;2~"  => :shift_f12,
+        "\e[24;5~"  => :ctrl_f12,
       }
     end