vedeu 0.4.59 → 0.4.60

data/lib/vedeu/bindings/drb.rb

@@ -69,6 +69,7 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_drb_restart_)
+      #   Vedeu.drb_restart
       #
       # @return [void]
       def drb_restart!
@@ -79,6 +80,7 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_drb_start_)
+      #   Vedeu.drb_start
       #
       # @return [void]
       def drb_start!
@@ -89,6 +91,7 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_drb_status_)
+      #   Vedeu.drb_status
       #
       # @return [void]
       def drb_status!
@@ -99,6 +102,7 @@ module Vedeu
       #
       # @example
       #   Vedeu.trigger(:_drb_stop_)
+      #   Vedeu.drb_stop
       #
       # @return [void]
       def drb_stop!

data/lib/vedeu/bindings/menus.rb

@@ -35,7 +35,9 @@ module Vedeu
       #
       # @return [void]
       def menu_bottom!
-        Vedeu.bind(:_menu_bottom_) { |name| Vedeu.menus.find(name).bottom_item }
+        Vedeu.bind(:_menu_bottom_) do |name|
+          Vedeu.menus.by_name(name).bottom_item
+        end
       end
 
       # Returns the current menu item.
@@ -46,7 +48,7 @@ module Vedeu
       # @return [void]
       def menu_current!
         Vedeu.bind(:_menu_current_) do |name|
-          Vedeu.menus.find(name).current_item
+          Vedeu.menus.by_name(name).current_item
         end
       end
 
@@ -58,7 +60,7 @@ module Vedeu
       # @return [void]
       def menu_deselect!
         Vedeu.bind(:_menu_deselect_) do |name|
-          Vedeu.menus.find(name).deselect_item
+          Vedeu.menus.by_name(name).deselect_item
         end
       end
 
@@ -70,7 +72,7 @@ module Vedeu
       #
       # @return [void]
       def menu_items!
-        Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.find(name).items }
+        Vedeu.bind(:_menu_items_) { |name| Vedeu.menus.by_name(name).items }
       end
 
       # Makes the next menu item the current menu item, until it reaches the
@@ -81,7 +83,7 @@ module Vedeu
       #
       # @return [void]
       def menu_next!
-        Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.find(name).next_item }
+        Vedeu.bind(:_menu_next_) { |name| Vedeu.menus.by_name(name).next_item }
       end
 
       # Makes the previous menu item the current menu item, until it reaches the
@@ -92,7 +94,7 @@ module Vedeu
       #
       # @return [void]
       def menu_prev!
-        Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.find(name).prev_item }
+        Vedeu.bind(:_menu_prev_) { |name| Vedeu.menus.by_name(name).prev_item }
       end
 
       # Returns the selected menu item.
@@ -103,7 +105,7 @@ module Vedeu
       # @return [void]
       def menu_selected!
         Vedeu.bind(:_menu_selected_) do |name|
-          Vedeu.menus.find(name).selected_item
+          Vedeu.menus.by_name(name).selected_item
         end
       end
 
@@ -114,7 +116,9 @@ module Vedeu
       #
       # @return [void]
       def menu_select!
-        Vedeu.bind(:_menu_select_) { |name| Vedeu.menus.find(name).select_item }
+        Vedeu.bind(:_menu_select_) do |name|
+          Vedeu.menus.by_name(name).select_item
+        end
       end
 
       # Makes the first menu item the current menu item.
@@ -124,7 +128,7 @@ module Vedeu
       #
       # @return [void]
       def menu_top!
-        Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.find(name).top_item }
+        Vedeu.bind(:_menu_top_) { |name| Vedeu.menus.by_name(name).top_item }
       end
 
       # Returns a subset of the menu items; starting at the current item to the
@@ -135,7 +139,7 @@ module Vedeu
       #
       # @return [void]
       def menu_view!
-        Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.find(name).view }
+        Vedeu.bind(:_menu_view_) { |name| Vedeu.menus.by_name(name).view }
       end
 
     end # Menus

data/lib/vedeu/bootstrap.rb

@@ -29,26 +29,13 @@ module Vedeu
     #
     # @return [void]
     def start
-      unless Vedeu::Configuration.log?
-        Vedeu.configure { log('/tmp/vedeu_bootstrap.log') }
-      end
+      configure_log!
 
-      # config/configuration.rb is already loaded so don't load it twice
-      Dir[File.join(Vedeu::Configuration.base_path, 'config/**/*')].each do |f|
-        next if f =~ %r{config/configuration\.rb}
-        load f
-      end
+      client_configuration!
 
-      [
-        'app/views/templates/**/*',
-        'app/views/interfaces/**/*',
-        'app/controllers/**/*',
-        'app/helpers/**/*',
-        'app/views/**/*',
-        'app/models/keymaps/**/*',
-      ].each { |path| load(File.join(Vedeu::Configuration.base_path, path)) }
+      client_application!
 
-      entry_point || eval(Vedeu::Configuration.root)
+      client_initialize!
 
       Vedeu::Launcher.execute!(argv)
     end
@@ -65,6 +52,39 @@ module Vedeu
 
     private
 
+    # @return [String]
+    def base_path
+      Vedeu::Configuration.base_path
+    end
+
+    # @note
+    #   config/configuration.rb is already loaded so don't load it twice
+    # @return [void]
+    def client_configuration!
+      Dir[File.join(base_path, 'config/**/*')].each do |path|
+        next if path =~ %r{config/configuration\.rb}
+
+        load(path)
+      end
+    end
+
+    # @return [void]
+    def client_application!
+      [
+        'app/views/templates/**/*',
+        'app/views/interfaces/**/*',
+        'app/controllers/**/*',
+        'app/helpers/**/*',
+        'app/views/**/*',
+        'app/models/keymaps/**/*',
+      ].each { |path| load(File.join(base_path, path)) }
+    end
+
+    # @return [void]
+    def client_initialize!
+      entry_point || eval(Vedeu::Configuration.root)
+    end
+
     # Load each of the loadable files.
     #
     # @param path [String]
@@ -86,6 +106,13 @@ module Vedeu
       end
     end
 
+    # @return [void]
+    def configure_log!
+      Vedeu.configure do
+        log('/tmp/vedeu_bootstrap.log')
+      end unless Vedeu::Configuration.log?
+    end
+
   end # Bootstrap
 
 end # Vedeu

data/lib/vedeu/colours/escape_sequences.rb

@@ -0,0 +1,125 @@
+module Vedeu
+
+  # Provides escape sequence strings for terminal colours and some actions.
+  #
+  module EscapeSequences
+
+    extend self
+
+    # @return [Hash<Symbol => String>]
+    def actions
+      {
+        hide_cursor:     "\e[?25l",
+        show_cursor:     "\e[?25h",
+        cursor_position: "\e[6n",
+        bg_reset:        "\e[49m",
+        blink:           "\e[5m",
+        blink_off:       "\e[25m",
+        bold:            "\e[1m",
+        bold_off:        "\e[22m",
+        border_on:       "\e(0",
+        border_off:      "\e(B",
+        dim:             "\e[2m",
+        fg_reset:        "\e[39m",
+        negative:        "\e[7m",
+        positive:        "\e[27m",
+        reset:           "\e[0m",
+        underline:       "\e[4m",
+        underline_off:   "\e[24m",
+      }
+    end
+
+    # Produces the background named colour escape sequence hash from the
+    # foreground escape sequence hash.
+    #
+    # @return [Hash<Symbol => Fixnum>]
+    def background_codes
+      hash = {}
+      Vedeu::EscapeSequences.foreground_codes.inject(hash) do |h, (k, v)|
+        h.merge!(k => v + 10)
+      end
+    end
+
+    # Produces the foreground named colour escape sequence hash. The background
+    # escape sequences are also generated from this by adding 10 to the values.
+    # This hash gives rise to methods you can call directly on `Esc` to produce
+    # the desired colours:
+    #
+    # @example
+    #   Esc.red                     # => "\e[31m"
+    #
+    #   Esc.red { 'some text' }     # => "\e[31msome text\e[39m"
+    #
+    #   Esc.on_blue                 # => "\e[44m"
+    #
+    #   Esc.on_blue { 'some text' } # => "\e[44msome text\e[49m"
+    #
+    #   # Valid names:
+    #   :black, :red, :green, :yellow, :blue, :magenta, :cyan, :light_grey,
+    #   :default, :dark_grey, :light_red, :light_green, :light_yellow,
+    #   :light_blue, :light_magenta, :light_cyan, :white
+    #
+    # @return [Hash<Symbol => Fixnum>]
+    def foreground_codes
+      {
+        black:         30,
+        red:           31,
+        green:         32,
+        yellow:        33,
+        blue:          34,
+        magenta:       35,
+        cyan:          36,
+        light_grey:    37,
+        default:       39,
+        dark_grey:     90,
+        light_red:     91,
+        light_green:   92,
+        light_yellow:  93,
+        light_blue:    94,
+        light_magenta: 95,
+        light_cyan:    96,
+        white:         97,
+      }
+    end
+    alias_method :codes, :foreground_codes
+
+    # @return [void]
+    def setup!
+      define_actions!
+      define_backgrounds!
+      define_foregrounds!
+    end
+
+    private
+
+    # @return [void]
+    def define_actions!
+      actions.each { |key, code| define_method(key) { code } }
+    end
+
+    # @return [void]
+    def define_backgrounds!
+      background_codes.each do |key, code|
+        define_method('on_' + key.to_s) do |&blk|
+          "\e[#{code}m" + (blk ? blk.call + "\e[49m" : '')
+        end
+      end
+    end
+
+    # Dynamically creates methods for each terminal named colour. When a block
+    # is given, then the colour is reset to 'default' once the block is called.
+    #
+    # @return [void]
+    def define_foregrounds!
+      foreground_codes.each do |key, code|
+        define_method(key) do |&blk|
+          "\e[#{code}m" + (blk ? blk.call + "\e[39m" : '')
+        end
+      end
+    end
+
+  end # EscapeSequences
+
+end # Vedeu
+
+Vedeu::EscapeSequences.setup!

data/lib/vedeu/distributed/server.rb

@@ -11,47 +11,55 @@ module Vedeu
 
       include Singleton
 
-      # @param (see #input)
-      # @see #input
-      def self.input(data, type = :key)
-        instance.input(data, type)
-      end
+      class << self
 
-      # @return [void]
-      # @see #output
-      def self.output
-        instance.output
-      end
+        # @param (see #input)
+        # @see #input
+        def input(data, type = :key)
+          instance.input(data, type)
+        end
 
-      # @return [void]
-      # @see #restart
-      def self.restart
-        instance.restart
-      end
+        # @return [void]
+        # @see #output
+        def output
+          instance.output
+        end
 
-      # @return [void]
-      # @see #shutdown
-      def self.shutdown
-        instance.shutdown
-      end
+        # @return [void]
+        # @see #restart
+        def restart
+          instance.restart
+        end
+        alias_method :drb_restart, :restart
 
-      # @return [void]
-      # @see #start
-      def self.start
-        instance.start
-      end
+        # @return [void]
+        # @see #shutdown
+        def shutdown
+          instance.shutdown
+        end
 
-      # @return [Symbol]
-      # @see #status
-      def self.status
-        instance.status
-      end
+        # @return [void]
+        # @see #start
+        def start
+          instance.start
+        end
+        alias_method :drb_start, :start
 
-      # @return [void]
-      # @see #stop
-      def self.stop
-        instance.stop
-      end
+        # @return [Symbol]
+        # @see #status
+        def status
+          instance.status
+        end
+        alias_method :drb_status, :status
+
+        # @return [void]
+        # @see #stop
+        def stop
+          instance.stop
+        end
+        alias_method :drb_stop, :stop
+
+      end # Eigenclass
 
       # @param data [String|Symbol]
       # @param type [Symbol] Either :keypress or :command.

data/lib/vedeu/dsl/view.rb

@@ -2,7 +2,80 @@ module Vedeu
 
   module DSL
 
-    # DSL for creating views.
+    # There are two ways to construct views with Vedeu. You would like to draw
+    # the view to the screen immediately (immediate render) or you want to save
+    # a view to be drawn when you trigger a refresh event later (deferred view).
+    #
+    # Both of these approaches require that you have defined an interface (or
+    # 'visible area') first. You can find out how to define an interface with
+    # Vedeu here. The examples in 'Immediate Render' and 'Deferred View' use
+    # these interface definitions: (Note: if you use these examples, ensure your
+    # terminal is at least 70 characters in width and 5 lines in height.)
+    #
+    #   Vedeu.interface 'main' do
+    #     geometry do
+    #       centred!
+    #       height 4
+    #       width  50
+    #     end
+    #   end
+    #
+    #   Vedeu.interface 'title' do
+    #     geometry do
+    #       height 1
+    #       width  50
+    #       x      use('main').left
+    #       y      use('main').north
+    #     end
+    #   end
+    #
+    # Both of these approaches use a concept of Buffers in Vedeu. There are
+    # three buffers for any defined interface. These are imaginatively called:
+    # 'back', 'front' and 'previous'.
+    #
+    # The 'back' buffer is the content for an interface which will be shown next
+    # time a refresh event is fired globally or for that interface. So, 'back'
+    # becomes 'front'.
+    #
+    # The 'front' buffer is the content for an interface which is currently
+    # showing. When a refresh event is fired, again, globally or for that
+    # interface specifically, the content of this 'front' buffer is first copied
+    # to the 'previous' buffer, and then the current 'back' buffer overwrites
+    # this 'front' buffer.
+    #
+    # The 'previous' buffer contains what was shown on the 'front' before the
+    # current 'front'.
+    #
+    # You can only write to either the 'front' (you want the content to be drawn
+    # immediately (immediate render)) or the 'back' (you would like the content
+    # to be drawn on the next refresh (deferred view)).
+    #
+    # The basic view DSL methods look like this:
+    #
+    #   renders/views
+    #     |- view
+    #         |- lines
+    #         |   |- line
+    #         |       |- streams
+    #         |       |   |- stream
+    #         |       |       |- char
+    #         |       |
+    #         |       |- stream
+    #         |           |- char
+    #         |
+    #         |- line
+    #             |- streams
+    #             |   |- stream
+    #             |       |- char
+    #             |
+    #             |- stream
+    #                 |- char
+    #
+    #   renders/views
+    #     |- view
+    #         |- lines/line
+    #             |- streams/stream
+    #                 |- char
     #
     class View
 
@@ -41,9 +114,24 @@ module Vedeu
         # the views, though can be later triggered if needed.
         #
         #   Vedeu.renders do
-        #     view 'my_interface' do
-        #       # ... some code
+        #     view 'some_interface' do
+        #       line do
+        #         stream do
+        #           left 'Title goes here', width: 35
+        #         end
+        #         stream do
+        #           right Time.now.strftime('%H:%m'), width: 7
+        #         end
+        #       end
         #     end
+        #     view 'other_interface' do
+        #       lines do
+        #         line 'This is content for the main interface.'
+        #         line ''
+        #         line 'Pretty easy eh?'
+        #       end
+        #     end
+        #     # ... some code
         #   end
         #
         #   # or...
@@ -67,6 +155,10 @@ module Vedeu
 
         # Define a view (content) for an interface.
         #
+        # As you can see by comparing the examples above to these below, the
+        # immediate render simply wraps what is already here in the deferred
+        # view.
+        #
         # The views declared within this block are stored in their respective
         # interface back buffers until a refresh event occurs. When the refresh
         # event is triggered, the back buffers are swapped into the front
@@ -74,11 +166,22 @@ module Vedeu
         # {Vedeu::Terminal.output}.
         #
         #   Vedeu.views do
-        #     view 'my_interface' do
-        #       # ... some attributes ...
+        #     view 'some_interface' do
+        #       line do
+        #         stream do
+        #           left 'Title goes here', width: 35
+        #         end
+        #         stream do
+        #           right Time.now.strftime('%H:%m'), width: 7
+        #         end
+        #       end
         #     end
-        #     view 'my_other_interface' do
-        #       # ... some other attributes ...
+        #     view 'other_interface' do
+        #       lines do
+        #         line 'This is content for the main interface.'
+        #         line ''
+        #         line 'Pretty easy eh?'
+        #       end
         #     end
         #     # ... some code
         #   end